UNPKG

@salaxy/core

Version:

General plain JavaScript / TypeScript libraries for Salaxy API (Palkkaus.fi)

910 lines (874 loc) 1.2 MB
/** AbcSection enumeration */ export declare enum AbcSection { Undefined = "undefined", DoNotShow = "doNotShow", Employment = "employment", Insurance = "insurance", Salary = "salary", Examples = "examples", PalkkausGeneral = "palkkausGeneral", PalkkausInstructions = "palkkausInstructions", Blog = "blog", Press = "press", PersonEmployer = "personEmployer", HouseholdEmployer = "householdEmployer", Worker = "worker", Employee = "employee", Entrepreneur = "entrepreneur", Association = "association", BusinessOwner = "businessOwner", ProductLongDescription = "productLongDescription", DocumentTemplates = "documentTemplates", InstructionsAndExamples = "instructionsAndExamples" } /** AbsenceCauseCode enumeration */ export declare enum AbsenceCauseCode { Undefined = "undefined", UnpaidLeave = "unpaidLeave", PersonalReason = "personalReason", Illness = "illness", PartTimeSickLeave = "partTimeSickLeave", ParentalLeave = "parentalLeave", SpecialMaternityLeave = "specialMaternityLeave", Rehabilitation = "rehabilitation", ChildIllness = "childIllness", PartTimeChildCareLeave = "partTimeChildCareLeave", Training = "training", JobAlternationLeave = "jobAlternationLeave", StudyLeave = "studyLeave", IndustrialAction = "industrialAction", InterruptionInWorkProvision = "interruptionInWorkProvision", LeaveOfAbsence = "leaveOfAbsence", MilitaryRefresherTraining = "militaryRefresherTraining", MilitaryService = "militaryService", LayOff = "layOff", ChildCareLeave = "childCareLeave", MidWeekHoliday = "midWeekHoliday", AccruedHoliday = "accruedHoliday", OccupationalAccident = "occupationalAccident", AnnualLeave = "annualLeave", PartTimeAbsenceDueToRehabilitation = "partTimeAbsenceDueToRehabilitation", Other = "other" } /** Period of absence */ export declare interface AbsencePeriod { /** Identifies a single leave. */ id?: string | null; /** Period for the absance. */ period?: DateRange | null; /** Cause / type of the absence */ causeCode?: AbsenceCauseCode | null; /** If true, the absence is paid by the employer. */ isPaid?: boolean | null; /** If true, annual leaves are accrued from the absence. If false, these days are deducted from the accrual. By default, you may leave this null and it always follows the IsPaid. */ isHolidayAccrual?: boolean | null; /** Amount of salary that is paid for the absense. Currently not in use: Would be used in Incomes Register integration. */ amount?: number | null; /** Additional information as recorded by the Employer. */ notes?: string | null; /** Identifier in the source system is a key defined by a source system / partner system. This is a pass-through string that is passed to the result calculations. */ sourceId?: string | null; /** Number of Bonus days to be paid. This is applicable only for {Palkkaus.Model.Worktime.Absences.AbsenceCauseCode.AnnualLeave}AnnualLeave. */ bonusDaysCount?: number | null; } /** Absence row type. In addition to AbsenceCauseCode, the Kind supports format "paid-[code]" and "unpaid-[code]" where code is the Incomes Registry code. */ export declare interface AbsencePeriodUsecase { /** If true, the absence is paid by the employer. If null, uses the default value from the absence cause. */ isPaid?: boolean | null; /** If true, annual leaves are accrued from the absence. If false, these days are deducted from the accrual. By default, you may leave this null and it always follows the IsPaid. */ isHolidayAccrual?: boolean | null; /** If true, resolves the price for the absence day from the employee's pricing rows or holiday year */ applyPricing?: boolean | null; /** Number of Bonus days to be paid. This is applicable only for {Palkkaus.Model.Worktime.Absences.AbsenceCauseCode.AnnualLeave}AnnualLeave. */ bonusDaysCount?: number | null; /** Resolved runtime. Bonus percent for holiday bonus. */ bonus?: number | null; /** Resolved runtime. The deduction for the standard salary will be added. */ hasDeductionRow?: boolean | null; /** Resolved runtime. Deduction row type. */ deductionRowType?: CalculationRowType | null; /** Resolved runtime. Deduction type. */ deductionType?: string | null; /** Resolved runtime. Deduction kind. */ deductionKind?: string | null; /** Resolved runtime. Wage basis. */ wageBasis?: WageBasis | null; /** Primary subtyping of the usecase. */ kind?: AbsenceCauseCode | null; } /** Client-side logic for Absence period as UserDefined row (in calculation). */ export declare class AbsencePeriodUsecaseLogic extends BaseUsecaseLogic { /** * Updates the usecase values based on user input without going to the server. * @param row Row to update. */ updateUsecase(row: UsecaseRow<CalculationRowType.AbsencePeriod, AbsencePeriodUsecase>): void; /** Gets validation message for AbsencePeriodUsecaseLogic */ getUcValidation(row: UserDefinedRow): UsecaseValidationMessage; /** * Updates the IsHolidayAccrual * @param row Current row that is being edited. */ updateIsHolidayAccrual(row: UsecaseRow<CalculationRowType.AbsencePeriod, AbsencePeriodUsecase>): void; /** * Returns true if the select component should be shown for absence isPaid. * @param row Current row that is being edited. */ canSelectIsPaid(row: UsecaseRow<CalculationRowType.AbsencePeriod, AbsencePeriodUsecase>): boolean; /** * Updates the IsPaid according to absence type. * @param row Current row that is being edited. * @param isKindChange Indicates if the change is due to kind change. */ updateIsPaid(row: UsecaseRow<CalculationRowType.AbsencePeriod, AbsencePeriodUsecase>, isKindChange?: boolean): void; /** * Updates the workdays count * @param row Current row that is being edited. */ updatePeriodDays(row: UsecaseRow<CalculationRowType.AbsencePeriod, AbsencePeriodUsecase>): void; /** * Sets the days array in period to enable days selection UI. * @param row Current row that is being edited. */ setDaysSelection(row: UsecaseRow<CalculationRowType.AbsencePeriod, AbsencePeriodUsecase>): void; } /** * Provides CRUD access for Absences of a Worker */ export declare class Absences extends CrudApiBase<WorkerAbsences, ApiListItem> { /** * For NG1-dependency injection * @ignore */ static $inject: string[]; /** Base URL for details etc. */ protected baseUrl: string; constructor(ajax: Ajax); /** Client-side (synchronous) method for getting a new blank item as bases for UI binding. */ getBlank(employmentId?: string, workerId?: string): WorkerAbsences; /** * Gets all the Worker absences objects of specified year. * @returns A Promise with result data: The full absences objects. */ getLatest(): Promise<WorkerAbsences[]>; /** * Gets the Absences for a specific employment relation. * @param employmentId Identifier for the Employment relation. * @returns A Promise with Absences. */ getForEmployment(employmentId: string): Promise<WorkerAbsences>; /** * Gets the Absences for the given employment relations. * @param employmentIds Identifiers for the Employment relations. * @returns A Promise with result data array. */ getForEmployments(employmentIds: string[]): Promise<WorkerAbsences[]>; } /** Represents a bank account in the Visma BankConnect system. */ export declare interface Account { /** Gets or sets a value indicating whether the account is a web service account. */ webServiceAccount?: boolean | null; /** Gets or sets the web service payment ID associated with the account. */ webServicePaymentId?: string | null; /** Gets or sets the name of the bank associated with the account. */ bank?: AccountBank | null; /** Gets or sets the International Bank Account Number (IBAN) of the account. */ iban?: string | null; /** Gets or sets the name of the account. */ name?: string | null; /** Gets or sets the owner of the account. */ owner?: string | null; /** Gets or sets the product type of the account. */ product?: string | null; /** Gets or sets the currency of the account. */ currency?: AccountCurrency | null; /** Gets or sets the Bank Identifier Code (BIC) of the account. */ bic?: string | null; /** Gets or sets the account authorizations. */ authorizations?: AccountAuthorizations | null; /** Gets or sets the creation date of the entity. */ created?: string | null; /** Gets or sets the last updated date of the entity. */ updated?: string | null; /** Gets or sets the unique identifier of the entity. */ id?: string | null; } /** Accountant details. */ export declare interface AccountantInfo { /** Avatar for the account */ avatar?: Avatar | null; /** Official id of the person or company. */ officialId?: string | null; /** Email address. */ email?: string | null; /** Telephone number. */ telephone?: string | null; /** Bank account number (IBAN) */ ibanNumber?: string | null; } /** AccountantType enumeration */ export declare enum AccountantType { Unknown = "unknown", UnlinkedPrimaryPartner = "unlinkedPrimaryPartner", UnlinkedAccountingOnly = "unlinkedAccountingOnly", PendingPrimaryPartner = "pendingPrimaryPartner", PrimaryPartner = "primaryPartner", None = "none" } export declare interface AccountAuthorizations { accounts?: Authorization | null; payments?: Authorization | null; } export declare enum AccountBank { OSUUSPANKKI = "oSUUSPANKKI", NORDEA = "nORDEA", NORDEA_PERSONAL = "nORDEA_PERSONAL", HOLVI = "hOLVI", POPPANKKI = "pOPPANKKI", OMASÄÄSTÖPANKKI = "oMAS\u00C4\u00C4ST\u00D6PANKKI", SÄÄSTÖPANKKI = "s\u00C4\u00C4ST\u00D6PANKKI", AKTIA = "aKTIA", ÅLANDSBANKEN = "\u00E5LANDSBANKEN", SPANKKI = "sPANKKI", OSUUSPANKKI_TEST = "oSUUSPANKKI_TEST", NORDEA_TEST = "nORDEA_TEST", NORDEA_PERSONAL_TEST = "nORDEA_PERSONAL_TEST", POPPANKKI_TEST = "pOPPANKKI_TEST", OMASÄÄSTÖPANKKI_TEST = "oMAS\u00C4\u00C4ST\u00D6PANKKI_TEST", SÄÄSTÖPANKKI_TEST = "s\u00C4\u00C4ST\u00D6PANKKI_TEST", AKTIA_TEST = "aKTIA_TEST", ÅLANDSBANKEN_TEST = "\u00E5LANDSBANKEN_TEST", SPANKKI_TEST = "sPANKKI_TEST", OSUUSPANKKI_MOCK = "oSUUSPANKKI_MOCK", NORDEA_MOCK = "nORDEA_MOCK", NORDEA_PERSONAL_MOCK = "nORDEA_PERSONAL_MOCK", HOLVI_MOCK = "hOLVI_MOCK", POPPANKKI_MOCK = "pOPPANKKI_MOCK", OMASÄÄSTÖPANKKI_MOCK = "oMAS\u00C4\u00C4ST\u00D6PANKKI_MOCK", SÄÄSTÖPANKKI_MOCK = "s\u00C4\u00C4ST\u00D6PANKKI_MOCK", AKTIA_MOCK = "aKTIA_MOCK", ÅLANDSBANKEN_MOCK = "\u00E5LANDSBANKEN_MOCK", SPANKKI_MOCK = "sPANKKI_MOCK", SALAXY_TEST = "sALAXY_TEST" } /** Account - either Person or Company - is a juridical entity Paying or receiving salaries, making contracts etc. It may be related to zero, one or multiple UserAccounts/Credentials. */ export declare interface AccountBase { /** Entity type of the account. Type PersonCreatedByEmployer means that the Worker has not yet signed into the system and there may be multiple instances of the same logical person (Official ID) - one for each employer. */ entityType?: LegalEntityType | null; /** If true the object Account is and Employer account - it has the EmployerInfo object */ isEmployer?: boolean | null; /** If true the object Account is and Worker account - it has the WorkerInfo object */ isWorker?: boolean | null; /** If true, the account has been verified. Typically this means a digitally signed contract. This means that the account also has an Identity object. However, as the Identity object contains confidential information, it is not necessarily present in all method calls. */ isVerified?: boolean | null; /** Avatar is the visual representation of the Account. */ avatar?: Avatar | null; /** Contact information for the Account. */ contact?: Contact | null; /** Language of the person/company. */ language?: Language | null; /** Service model for the account. */ serviceModelId?: string | null; /** Workflow data, which is exposed to API. */ workflowData?: WorkflowData | null; /** Identifier of the object. */ id?: string | null; /** The date when the object was created. */ createdAt?: string | null; /** The time when the object was last updated. Typically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates. */ updatedAt?: string | null; /** Owner ID for this data */ owner?: string | null; /** Indication that for the currently logged-in account, the data is generally read-only. */ isReadOnly?: boolean | null; /** Primary partner information. Automatically updated from the storage container Partner. */ partner?: string | null; } export declare enum AccountCurrency { EUR = "eUR" } /** AccountingChannel enumeration */ export declare enum AccountingChannel { Undefined = "undefined", Procountor = "procountor", VismaNetvisor = "vismaNetvisor", VismaFivaldi = "vismaFivaldi" } /** Accounting data for reports. */ export declare interface AccountingData { /** All ledgers. */ ledgerAccounts?: LedgerAccount[] | null; /** Basic information and visualization for the accounting target. Avatar provides the visualization and the name for the target. E-mail may be used in sending of the material and telephone in contacting the accounting target. IBAN number has no use. */ target?: AccountInIndex | null; /** The default export format for tabular (csv, excel) data. */ format?: string | null; /** Finnish Business Identifier (Y-tunnus) for the company. */ officialId?: string | null; /** Employer avatar */ employer?: Avatar | null; /** Contact information for the report. Typically the employer, but may be something else. */ contact?: Contact | null; /** Period for the report. */ period?: DateRange | null; /** Summary containing relevant numbers for the report. For example, number of calculations, gross and net amounts, payment amounts and Palkkaus fee. */ summary?: AccountingDataSummary | null; } /** Summary of the accounting data. Contains main figures: totals and workers and employer total figures. */ export declare interface AccountingDataSummary { /** The total number of calculations included in the report. */ calculationCount?: number | null; /** The total number of distinct workers included in the report. */ workerCount?: number | null; /** Total gross salary of the calculations included in the report. */ readonly totalGrossSalary?: number | null; /** Total payment of the calculations included in the report. */ readonly totalPayment?: number | null; /** Calculation totals that are common to both Worker and Employer. */ totals?: TotalCalculationDTO | null; /** The calculation from the Employer point-of-view */ employerCalc?: EmployerCalculationDTO | null; /** The calculation from the Worker point-of-view */ workerCalc?: WorkerCalculationDTO | null; /** Calculation totals of accrued total holiday pay and related sidecosts. */ holidayCalc?: HolidayCalculationDTO | null; /** Validation messages for the accounting data. */ validation?: ApiValidation | null; } /** The holiday pay debt data report based on given holiday years. */ export declare interface AccountingHolidayPayDebtReportData { /** Finnish Business Identifier (Y-tunnus) for the company. */ officialId?: string | null; /** Employer avatar */ employer?: Avatar | null; /** Contact information for the report. Typically the employer, but may be something else. */ contact?: Contact | null; /** Period for the report. */ period?: DateRange | null; /** Calculated totals of accrued total holiday pay and related sidecosts. */ holidayCalc?: HolidayCalculationDTO | null; /** Individual holiday years and their debt data included in the report. */ holidayYears?: AccountingHolidayPayDebtReportDataYear[] | null; } /** Individual holiday year with the debt data. */ export declare interface AccountingHolidayPayDebtReportDataYear { /** Holiday year for which the debt is calculated. */ holidayYear?: HolidayYear | null; /** Calculation totals of accrued total holiday pay and related sidecosts. */ holidayCalc?: HolidayCalculationDTO | null; } /** AccountingPeriodClosingOption enumeration */ export declare enum AccountingPeriodClosingOption { Default = "default", Accounting = "accounting", PeriodicInvoices = "periodicInvoices", AccountingAndPeriodicInvoices = "accountingAndPeriodicInvoices", IrReports = "irReports", AccountingAndIrReports = "accountingAndIrReports", PeriodicInvoicesAndIrReports = "periodicInvoicesAndIrReports", AccountingAndPeriodicInvoicesAndIrReports = "accountingAndPeriodicInvoicesAndIrReports" } /** First version of the product that integrates the Palkkaus.fi-salary payments to employers accounting. */ export declare interface AccountingProduct { readonly status?: string | null; accountantName?: string | null; accountantEmail?: string | null; accountantPhone?: string | null; /** Enabled property set automatically by AccountantName, AccountantEmail and AccountantPhone. */ enabled?: boolean | null; /** Identifier for the product */ readonly id?: string | null; /** The main short title for the product / service */ readonly title?: string | null; /** One paragraph description text */ readonly description?: string | null; /** The logo image for the product. */ readonly img?: string | null; /** Identifier for the main product desription article in the Palkkaus.fi CMS */ readonly articleId?: string | null; /** If false, it is not bossible to enable this product for the current account / environment. Typically, this means that the UI should not show this product. */ visible?: boolean | null; /** Indicates (true-value) if the end user has confirmed the product options. If false, the end user has not confirmed the option. */ visited?: boolean | null; } /** Settings for Accounting report delivery. */ export declare interface AccountingReportDelivery { /** If true, the delivery is active. */ isEnabled?: boolean | null; /** Address for delivery. Currently only email supported. */ address?: string | null; } /** Accounting report table row. */ export declare interface AccountingReportRow { /** Row type. Default is the Booking. */ rowType?: AccountingReportRowType | null; /** Amount for the row: May be positive or negative(depending on the depet/credit and account type). */ amount?: number | null; /** Percentage of the value added tax that is included in the amount. */ vatPercent?: number | null; /** Proposed account number for the row. */ accountNumber?: string | null; /** Proposed account text for the row. */ accountText?: string | null; /** Returns product code. */ productCode?: string | null; /** Returns product name. (Code or ResultCode in this order). */ productName?: string | null; /** Text for the booking entry / header. */ text?: string | null; /** Space separated set of class names for CSS styling purposes. */ styles?: string | null; /** Count of units. Default is 1. */ count?: number | null; /** Price for the unit. */ price?: number | null; /** Unit identifier; */ unit?: string | null; /** Additional information for the row. */ additionalInformation?: string | null; } /** AccountingReportRowType enumeration */ export declare enum AccountingReportRowType { Debit = "debit", Credit = "credit", Total = "total", GroupHeader = "groupHeader", GroupTotal = "groupTotal", ChildRow = "childRow" } /** Contains accounting rows for one or many calculations. */ export declare interface AccountingReportTable { /** All rows in the report table. */ rows?: AccountingReportRow[] | null; /** Accounting report table type. */ tableType?: AccountingReportTableType | null; /** Finnish Business Identifier (Y-tunnus) for the company. */ businessId?: string | null; /** Employer avatar */ employer?: Avatar | null; /** Contact information for the report. Typically the employer, but may be something else. */ contact?: Contact | null; /** Period for the report. */ period?: DateRange | null; /** Summary containing relevant numbers for the report. For example, number of calculations, gross and net amounts, payment amounts and Palkkaus fee. */ summary?: AccountingReportTableSummary | null; } /** Summary of the accounting report. Contains main figures: totals and workers and employer total figures. */ export declare interface AccountingReportTableSummary { /** The total number of calculations included in the report. */ count?: number | null; /** Calculation totals that are common to both Worker and Employer. */ totals?: TotalCalculationDTO | null; /** The calculation from the Employer point-of-view */ employerCalc?: EmployerCalculationDTO | null; /** The calculation from the Worker point-of-view */ workerCalc?: WorkerCalculationDTO | null; } /** AccountingReportTableType enumeration */ export declare enum AccountingReportTableType { Classic = "classic", Simple = "simple", Mapped = "mapped" } /** Container for accounting based report data. */ export declare interface AccountingRowReportData { /** Report row created from accounting base rows. */ rows?: AccountingRowReportDataRow[] | null; /** Finnish Business Identifier (Y-tunnus) for the company. */ officialId?: string | null; /** Employer avatar */ employer?: Avatar | null; /** Contact information for the report. Typically the employer, but may be something else. */ contact?: Contact | null; /** Period for the report. */ period?: DateRange | null; /** Summary containing relevant numbers for the report. For example, number of calculations, gross and net amounts, payment amounts and Palkkaus fee. */ summary?: AccountingDataSummary | null; } /** Report row created from accounting base row data. */ export declare interface AccountingRowReportDataRow { /** Entry group: income type or total type */ entryCodeGroup?: string | null; /** A single code in the code group: single income type code or total row. */ entryCode?: string | null; /** Entry date. */ entryDate?: string | null; /** Entry description. */ message?: string | null; /** Posted amount. Includes VAT. */ amount?: number | null; /** VAT percent. */ vatPercent?: number | null; /** VAT amount of specific VAT rate. */ vatAmount?: number | null; /** Applied VAT rate. This is always mandatory. */ vatRate?: VatRate | null; /** Dimension data. */ dimension?: { [key: string]: any; } | null; /** Additional flags for directing the logic for creating accounting entry based on given entries. */ flags?: string[] | null; } /** Ruleset containing required tabular logic (rules) and accounts for creating accounting entries. */ export declare interface AccountingRuleSet { /** Template to which this ruleset is based on. */ templateId?: string | null; /** Accounts which are used in the tabular logic for creating accounting entries. */ accounts?: AccountingRuleSetAccount[] | null; /** Optional target Chart of Accounts: All the accounts in the target system, not just the ones in use. */ targetCoA?: AccountingRuleSetAccount[] | null; /** Tabular logic for creating accounting entries. */ rows?: AccountingRuleSetRow[] | null; } /** Single account with number, grouping and default text. */ export declare interface AccountingRuleSetAccount { /** Id for the account. */ id?: string | null; /** Boolean indicating if the account is non-removable template. */ isReadOnly?: boolean | null; /** Account number. */ account?: string | null; /** Text for the account. */ text?: string | null; } /** Contains a single row of the tabular logic for creating accounting entries. */ export declare interface AccountingRuleSetRow { /** Id for the row. */ id?: string | null; /** Entry group: income type or total type. */ entryCodeGroup?: string | null; /** A single code in the code group: single income type code or total row type. */ entryCode?: string | null; /** Boolean indicating if the row is non-removable template. */ isReadOnly?: boolean | null; /** Boolean indicating if the row is in use. */ enabled?: boolean | null; /** Boolean indicating whether the system should make an accounting entry based on this row. */ isIncluded?: boolean | null; /** Id of the debit account. */ debitId?: string | null; /** Grouping text for the account. If the account has a grouping defined, it will be listed as a separate row group. */ debitGrouping?: string | null; /** Id of the credit account. */ creditId?: string | null; /** Grouping text for the account. If the account has a grouping defined, it will be listed as a separate row group. */ creditGrouping?: string | null; /** Additional flags for directing the logic for creating accounting entry based on given entries. */ flags?: string[] | null; } /** Settings related to Accounting */ export declare interface AccountingSettings { /** If true, the service model is not applied to this feature. */ denyServiceModel?: boolean | null; /** Default accounting target. */ defaultTargetId?: string | null; /** Accounting target systems and the rulesets assigned to them. */ targets?: AccountingTargetSettings[] | null; /** Default period selection method: PaidAt date (paid by employer), Salary date (paid to worker) or Work date (work done). The default is PaidAt date. */ defaultPeriodDateKind?: PeriodDateKind | null; /** Options for accounting report delivery for the company. These are not affected by the service model. */ reportDelivery?: AccountingReportDelivery | null; /** Options for accounting report delivery for the Accountant. These are not affected by the service model. */ accountantReportDelivery?: AccountingReportDelivery | null; } /** Defines an accounting target (system), CoA and ruleset that maps the calculation to the CoA (Chart of Accounts). */ export declare interface AccountingTarget { /** Information and configuration related to the system where the accounting data is to be sent. */ info?: AccountingTargetInfo | null; /** The rule set that defines the Chart of Accounts and the mapping of salary payment to it. */ ruleSet?: AccountingRuleSet | null; /** Readonly workflow data, which is exposed to API. */ workflowData?: WorkflowData | null; /** Identifier of the object. */ id?: string | null; /** The date when the object was created. */ createdAt?: string | null; /** The time when the object was last updated. Typically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates. */ updatedAt?: string | null; /** Owner ID for this data */ owner?: string | null; /** Indication that for the currently logged-in account, the data is generally read-only. */ isReadOnly?: boolean | null; /** Primary partner information. Automatically updated from the storage container Partner. */ partner?: string | null; } /** Accounting Target specific business data for index. */ export declare interface AccountingTargetData { /** Contains the email or id of the responsible for the partner workflow event. */ partnerMessageAssignedTo?: string | null; /** Channel is the technical transport mechanism to accounting software */ channel?: AccountingChannel | null; /** The default export method for exports: whether automatic or manual. */ method?: ExportMethod | null; /** Available methods in manual exports (comma separated string). */ availableMethods?: string | null; /** The default export format for tabular (csv, excel) data. */ format?: string | null; /** Template to which this is based on. */ templateId?: string | null; } /** Specifies the general information of the behavior of Accounting target: Especially the channel and the related properties. */ export declare interface AccountingTargetInfo { /** Basic information and visualization for the accounting target. Avatar provides the visualization and the name for the target. E-mail may be used in sending of the material and telephone in contacting the accounting target. IBAN number has no use. */ target?: AccountInIndex | null; /** Channel is the technical transport mechanism to accounting software */ channel?: AccountingChannel | null; /** The default export method for exports: whether automatic or manual. */ method?: ExportMethod | null; /** If specified, defines the available methods in manual exports. */ availableMethods?: ExportMethod[] | null; /** The default export format for tabular (csv, excel) data. */ format?: string | null; /** Accounting channel specific data (default settings) for the accounting target setup. */ data?: { [key: string]: any; } | null; } /** Represents a single item in a list of Accounting targets. */ export declare interface AccountingTargetListItem { /** The date when the object was created. */ createdAt?: string | null; /** The time when the object was last updated. Typically this should be a logical update by user (UserUpdatedAt in DTO), not technical updates. */ updatedAt?: string | null; /** Last date of modification of the object. The modification can be produced by the end user or by the system. */ timestamp?: string | null; /** Person GUID for the owner of the object. */ ownerId?: string | null; /** Metadata for the owner */ ownerInfo?: AccountInIndex | null; /** The main status depending on the type of the object. */ status?: AccountingTargetStatus | null; /** The back office status depending on the type of the object. */ backOfficeStatus?: string | null; /** When the event started. Typically, this is the CreatedAt date, but it may be something else. */ startAt?: string | null; /** This is the end date of the event. Typically, it is the UserUpdatedAt date, but it may be something else - e.g PaidAt for the calculation. */ endAt?: string | null; /** Gross salary if that is relevant to the transaction. */ grossSalary?: number | null; /** This is the payment from the Owner point-of-view: Total payment for the Employer and Net salary for the Worker in the case of a calculation. Only add here the payment, if the payment is really made. */ payment?: number | null; /** Estimated fee of the transaction to Palkkaus.fi. */ fee?: number | null; /** The GUID for the other party. Currently, this is always the PersonID. */ otherId?: string | null; /** The other party (usually a Person) that is involved in the event (e.g Worker if this is a Salary payment by Employer). */ otherPartyInfo?: AccountInIndex | null; /** A very short description describing the object as an event. E.g. "Paid salary" */ shortText?: string | null; /** Business object ids related to this object. E.g. calculations and payrolls in the payment. */ businessObjects?: string[] | null; /** This is valid for calculations only. The estimated date of salary in worker. */ salaryDate?: string | null; /** Business data to include further information of the object. */ data?: AccountingTargetData | null; /** Version number. May be used in conflicts */ versionNumber?: number | null; /** Salaxy uri of the resource. */ uri?: string | null; /** Workflow flags for the object. Only workflow events with API supported message types are listed. */ flags?: string[] | null; /** Workflow messages for the object. Only workflow events with API supported message types are listed. Shown in format "[MessageType]:[Message] ([User] at [UTC-time])" */ messages?: string[] | null; /** Sub category for the payload. E.g. Payment Category, MoneyTransfer Source. */ entityType?: string | null; /** The date for the actual period for which this object is done. */ logicalDate?: string | null; /** Reference information. E.g. Payment or MoneyTransfer reference number. */ reference?: string | null; /** External id for the object in 3rd party system. */ externalId?: string | null; /** Identifier of the object. */ id?: string | null; /** Owner ID for this data */ owner?: string | null; /** Indication that for the currently logged-in account, the data is generally read-only. */ isReadOnly?: boolean | null; /** Primary partner information. Automatically updated from the storage container Partner. */ partner?: string | null; } /** * Provides business logic to AccountingReportTools */ export declare class AccountingTargetLogic { /** * Get supported TargetOptions * @returns All supported export TargetOptions */ static getSupportedTargets(): TargetOptions; private static getPalkkausExportData; /** Data exports for targets */ private static getPalkkausDefaultExportData; private static getPalkkausExtendedExportData; /** * https://procountor.finago.com/hc/fi/articles/360000254997-Tallennusty%C3%B6kalu-uusi-#LIIT%C3%84VIENTEJ%C3%84-TOIMINTO */ private static getProcountorExportData; /** * Merit aktiva format */ private static getPasseliMeritExportData; /** * https://asteri.fi/aineistojen-tuonti-asteri-kirjanpitoon/ */ private static getAsteriExportData; /** * Maestro * +----------+--------------+-----------------------------------------+ * | Otsikko | Muoto | Selite | * +----------+--------------+-----------------------------------------+ * | TOSITE | VVVV/L/NNNNN | Tositenumero | * | PAIVAYS | PP.KK.VVVV | Kirjauspäivä | * | ERN | NUM | Erityisraporttinro | * | KAAVA | NUM | Tulos/Tasekaavanumero | * | TNRO | NUM | Tilinumero | * | RNRO | | Raporttinumero | * | TILINIMI | AN | Tilin Nimi | * | TUPA | NUM | Tulospaikkanumero | * | ATP | | Aputulospaikkanumero | * | SELITE | AN | Vientiselite | * | VARA1 | | Varalla/1 | * | VARA2 | | Varalla/2 | * | VARA3 | | Varalla/3 | * | VARA4 | | Varalla/4 | * | SUMMA | | Summa (2-desimaalisena erotin on piste) | * +----------+--------------+-----------------------------------------+ */ private static getMaestroExportData; /** * https://support.netvisor.fi/hc/fi/articles/235300547-Kirjanpitotietojen-tuonti */ private static getVismaNetvisorExportData; /** * Fennoa export data format. * Tuetut sarakkeet: * * - PVM - Tositepäivä. Ensimmäiseltä riviltä otetaan Fennoan tositteelle päivämäärä. * - TILI - Kirjanpidon tili * - SELITE - Vientirivin selite * - SUMMA (Debet +, Kredit -) * - ALV-KOODI * - tyhjä tarkoittaa tilikartasta tilin takaa haetaan oletus alv-koodi * - viiva ”-” tarkoittaa ei alv-koodia * - 1 = 24 * - 2 = 14 * - 3 = 10 * - numero on vientiriville halutun alv-koodin id numero, jotka löytyvät ohjekannastamme ALV-kooditaulukosta (3.9.5 ALV-koodit / Arvonlisäverokoodit Fennoassa). * - LK1 - Laskentakohde 1 * - LK2 - Laskentakohde 2 * - LK… jne */ private static getFennoaExportData; /** * Domus export data format. * Tuetut sarakkeet: * - Y-TUNNUS - Yrityksen y-tunnus * - PVM - Tositepäivä. Ensimmäiseltä riviltä otetaan Domus tositteelle päivämäärä. * - TILI - Kirjanpidon tili * - SELITE - Vientirivin selite * - SUMMA (Debet +, Kredit -) */ private static getDomusExportData; /** * Oscar Software * Aineisto on oltava Excel taulukosta muodossa "Tabuloinnilla erotettu teksti (*.txt)" tallennettu tiedosto. Excel taulukon on noudatettava seuraavia sääntöjä: * Yhdessä taulukossa on aina yhden tositteen viennit. Vientien lukumäärä ei ole rajoitettu. Viennit ovat jokainen omalla rivillään ja vientejä edeltää sarakeotsikot sisältävä rivi. * Ennen tätä riviä tiedostossa saa olla mitä tahansa tietoa, jota ohjelma ei mitenkään käsittele. Sarakeotsikoilla voidaan kertoa tiedoston sisältävän seuraavia tietoja: * +--------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ * | Sarakeotsikko | Kuvaus | * +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ * | Tositelaji |Oltava perustettuna kirjanpitoon, annetaan ensimmäisellä vientirivillä. Jos tietoa ei ole, ohjelma käyttää oletustositelajia. Tositenumero määräytyy tositelajin perusteella kuten tositteita käsin syötettäessä.| | * | Pvm tai Pv | Tositteen päiväys, annetaan ensimmäisellä vientirivillä. Päivämäärä anneteen muodossa ppkkvv. Pakollinen tieto. | * | Selite tai Vientiselite | Viennin selite. Tositekohtainen selite voidaan antaa rivillä, jolla ei anneta lainkaan tilinumeroa. | * | Tili | Tilinumero, pakollinen tieto (lukuun ottamatta tositeselitettä). | * | Kp, Kust.paikka tai Kustannuspaikka | Kustannuspaikka | * | Tunniste tai Projekti | Tunniste/projekti | * | Alv-menetelmä tai Alv-men | Alv-menetelmä (käytössä vain tietyillä Tisma-käyttäjillä). | * | Debet, Debetvienti tai Debetsumma | Debet viennin summa | * | Kredit, Kreditvienti tai Kreditsumma | Kredit viennin summa. Yhdellä rivillä ei voi olla sekä debet että kredit -vientiä. Jompi kumpi kuitenkin pitää olla. | * +--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ * Sarakeotsikoiden kirjoitusasu isojen ja pienten kirjainten suhteen on vapaa. Jos yllä on esitetty useampi kuin yksi kirjoitusasu, mikä tahansa näistä kelpaa. * Vähintään sarakkeet "Pvm", "Tili", "Debet" ja "Kredit"on aineistosta löydyttävä. Sarakkeiden keskinäinen järjestys on vapaa. * Jos tiedosto sisältää muitakin kuin kuvatut sarakkeet, ohjelma ei käsittele näitä mitenkään. Ohjelman käsittelemät tiedot täytyy sijaita 12 ensimmäisen sarakkeen joukossa. * Selitteiden merkistö pitää olla ISO-Latin merkistöä */ private static getOscarSoftwareExportData; /** * Lemonsoft * https://doc.lemonsoft.eu/lemonnethelp/default.htm#!Documents/excelcsv.htm * +----------+--------------+---------------------------------------------------+ * | Otsikko | Muoto | Selite | * +----------+--------------+---------------------------------------------------+ * | Tosite | 0 | Vakio = 0 | * | Tlaji | NUM | Tositelaji | * | Tnro | NUM | Tositenumero | * | Pvm | VVVV-KK-PP | Päivämäärä muodossa VVVV-KK-PP (esim. 2009-10-20) | * | Selite | AN(60) | Vientiselite | * | Kpaikka | AN(40) | Kustannuspaikka | * | LTA | AN(40) | Liiketoiminta-alue | * | Tunniste | AN(30) | Tunniste | * | Projekti | NUM | Projektinumero | * | Tili | AN(10) | Kirjanpitotili | * | Debet | NUM | Debet | * | Kredit | NUM | Kredit | * | Vero | NUM | Veron määrä | * +----------+--------------+---------------------------------------------------+ */ private static getLemonsoftExportData; /** * | Nimi | Tositepäivä | Tositelaji | Tositenumero | Tili | Alv-Koodi | Summa | Kustannuspaikka | Laskentakohde1 | Laskentakohde2 | Laskentakohde3 | Laskentakohde4 | Laskentakohde5 | Laskentakohde6 | Laskentakohde7 | Laskentakohde8 | Laskentakohde9 | Laskentakohde10 | Laskentakohde11 | Laskentakohde12 | Laskunumero | Vientiselite | * |------------------|-------------------------|------------|--------------|---------|-----------|--------------------|-----------------|----------------|----------------|----------------|----------------|----------------|----------------|----------------|----------------|----------------|-----------------|-----------------|-----------------|-------------|--------------| * | Tyyppi | Date | varchar | biginit | varchar | varchar | desimal | varchar | varchar | varchar | varchar | varchar | varchar | varchar | varchar | varchar | varchar | varchar | varchar | varchar | varchar | varchar | * | | Päivämäärä | Teksti | Kokonaisluku | | | Luku, 2 desimaalia | | | | | | | | | | | | | | | | * | Pituus | | 10 | 20 | 6 | 10 | 13,2 | 30 | 30 | 30 | 30 | 30 | 30 | 30 | 30 | 30 | 30 | 30 | 30 | 30 | 30 | 100 | * | Muoto | pp.kk.vvvv tai p.k.vvvv | | | | | | | | | | | | | | | | | | | | | * | Pakollisuus | V | V | V | P | V | P | V | V | V | V | V | V | V | V | V | V | V | V | V | V | V | * | Järjestys | 1.00 | 2.00 | 3.00 | 4.00 | 5.00 | 6.00 | 7.00 | 8.00 | 9.00 | 10.00 | 11.00 | 12.00 | 13.00 | 14.00 | 15.00 | 16.00 | 17.00 | 18.00 | 19.00 | 20.00 | 21.00 | * | Sarake Excelissä | A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | */ private static getHeerosExportData; private static getVismaFivaldiExportData; /** * Tampuuri * https://eteinen.tampuuri.fi/s/artikkelit?article=Tuonti-Excelista * +--------------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ * | Sarakeotsikko | Pakollinen | Kuvaus | * +---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ * | Tositenro | Ei | Mikäli tositenumeroa ei anna, järjestelmä generoi sen tositelajin laskurin mukaan. | * | Pvm | Kyllä | Tositepäivä. | * | Tositeselite | Kyllä | Tositeotsikon selite | * | Tili | Kyllä | Kirjanpidon tili | * | Alvluokka | Ei | Arvolisäverokoodi, esim 024 | * | Alvvähennysoikeus pros | Ei | Mikäli tositerivillä olevasta arvolisäverosta voidaan vain osa vähentää, tässä annetaan vähennysoikeusprosentti