Added Customer register methods

Author: markus-peltola

README.md

@@ -93,11 +93,12 @@ After this, you can use all the methods available.
 The following API methods have been implemented:
 
 - `bookkeeping` Bookkeeping
-- `product` Product register
+- `products` Product register
 - `purchaseInvoices` Purchase invoices
 - `chartOfAccounts` Chart of Accounts
 - `archive` Archive of files
 - `sales` Sales orders
+- `customers` Customer register
 
 ### Bookkeeping examples
 
@@ -262,6 +263,64 @@ const { externalBatchId } = await fivaldi.sales.createOrders({
 });
 ```
 
+### Customer register examples
+
+```ts
+// Get customer register's basic details
+const basicDetails = await fivaldi.customers.getCustomerRegisterBasicDetails();
+
+// Get all customers with optional parameters
+const customerList = await fivaldi.customers.getAllCustomers({ searchWord: 'Bank' fromDate: '1.1.2020' });
+
+// Get more detailed customer info with customer id
+const customerDetails = await fivaldi.customers.getCustomer('1001');
+
+// Create a new customer
+const newCustomer = await fivaldi.customers.createCustomer(customerObject);
+
+// Update customer info giving all fields
+const updatedCustomer = await fivaldi.customers.updateCustomerAllFields('1001', customerObject);
+
+// Update customer info only giving updated fields
+const updatedCustomer = await fivaldi.customers.updateCustomer('1001', { instantMessagingType: '3' });
+
+// Create a new address to customer
+const newAddress = await fivaldi.customers.createAddress('1001', {
+  streetAddress: 'Mannerheimintie 63',
+  postalCode: '00250',
+  postalAddress: 'Helsinki',
+  countryCode: 'FI',
+  isMainAddress: true,
+  addressType: '01'
+});
+
+// Update customer's address giving all fields
+const updatedAddress = await fivaldi.customers.updateAddressAllFields('1001', '6', {
+  streetAddress: 'Mannerheimintie 63',
+  postalCode: '00250',
+  postalAddress: 'Helsinki',
+  countryCode: 'FI',
+  isMainAddress: true,
+  addressType: '03'
+});
+
+// Create a new bank account to customer
+const newBankAccount = await fivaldi.customers.createBankAccount('1001', {
+  bankName: 'Danske',
+  ibanNumber: 'FI0488888800009998',
+  countryId: 'FI',
+  swift: 'DABAFIHH'
+});
+
+// Update customer's bank account giving all fields
+const updatedBankAccount = await fivaldi.customers.updateBankAccountAllFields('1001', '00000005', {
+  bankName: 'Danske Bank',
+  ibanNumber: 'FI0488888800009998',
+  countryId: 'FI',
+  swift: 'DABAFIHH'
+});
+```
+
 ## Resources
 
 - Fivaldi website: https://www.visma.fi/visma-fivaldi/
@@ -276,3 +335,4 @@ const { externalBatchId } = await fivaldi.sales.createOrders({
 - 0.1.1 Updated dependencies
 - 0.2.0 Added Archive of files method
 - 0.3.0 Added Sales orders method
+- 0.4.0 Added Customer register method

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rantalainen/fivaldi-api-client",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Third party Fivaldi API client.",
   "main": "dist/index.js",
   "scripts": {

src/index.ts

@@ -3,6 +3,7 @@ import { IFivaldiApiClientOptions, IGetCompaniesParams, IGetCompaniesResponse }
 import { ArchiveMethods } from './methods/archive.methods';
 import { BookkeepingMethods } from './methods/bookkeeping.methods';
 import { ChartOfAccountsMethods } from './methods/chart-of-accounts.methods';
+import { CustomersMethods } from './methods/customers.methods';
 import { ProductMethods } from './methods/products.methods';
 import { PurchaseInvoicesMethods } from './methods/purchaseInvoices.methods';
 import { SalesMethods } from './methods/sales.methods';
@@ -17,6 +18,7 @@ export class FivaldiApiClient {
   readonly chartOfAccounts: ChartOfAccountsMethods;
   readonly archive: ArchiveMethods;
   readonly sales: SalesMethods;
+  readonly customers: CustomersMethods;
 
   constructor(options: IFivaldiApiClientOptions) {
     options.apiBaseUrl = options.apiBaseUrl || 'https://api.fivaldi.net/customer/api';
@@ -38,6 +40,7 @@ export class FivaldiApiClient {
     this.chartOfAccounts = new ChartOfAccountsMethods(this);
     this.archive = new ArchiveMethods(this);
     this.sales = new SalesMethods(this);
+    this.customers = new CustomersMethods(this);
   }
 
   async request(method: Method, url: string, body?: any, params?: any): Promise<any> {

src/interfaces/customers.interfaces.ts

@@ -0,0 +1,249 @@
+/// PARAMS INTERFACES ///
+
+export interface IGetAllCustomersParams {
+  /** Limit results with search word */
+  searchWord?: string;
+  /** Limit results with changed at date is given date or newer (dd.mm.yyyy) */
+  fromDate?: string;
+  /** Filter fields of the response objects, only ones provided will be included on response */
+  fields?: string;
+}
+
+/// RESPONSE & REQUEST INTERFACES ///
+
+export interface ICustomerEntityDetailsDTO {
+  /** Customer id is set by Fivaldi as next available customer number. */
+  customerId?: string;
+  businessId?: string;
+  customerName?: string;
+  customerName2?: string;
+  email?: string;
+  email2?: string;
+  phoneNumber?: string;
+  phoneNumber2?: string;
+  changeTime?: string;
+  changeUser?: string;
+  accountDimension1?: string;
+  accountDimension2?: string;
+  accountDimension3?: string;
+  accountDimension4?: string;
+  currency?: string;
+  customerSegment?: string;
+  customerInterestPercent?: number;
+  debtCollectionDisabled?: boolean;
+  deliveryMethod?: string;
+  externalId?: string;
+  /** Buyerpartyidentifier (Ostajan asiakastunnukseksi). selitteet (O = OVT, A = Yritystunnus, M = Verkkolaskuosoitteessa annettu muu tunnus, null = Y-tunnus) */
+  finvoiceBuyerPartyIdentifier?: 'O' | 'A' | 'M';
+  /** Finvoice dimensiontext mask for purchase invoice circulation (Seurantakohde-ehdotuksen tulkintasääntö) */
+  finvoiceDimensionTextMask?: string;
+  /** Don't handle incoming Finvoice postings (Älä tuo Finvoicen tiliöintirivejä) */
+  finvoiceNoPostingRows?: boolean;
+  /** Receivers MessageReceiverDetails ToIdentifier on Finvoice (Vastaanottajan verkkolaskuosoitteen tunnus) */
+  finvoiceOtherIdentifier?: string;
+  fivaldiBankAccountId?: string;
+  /** Customer language code (Asiakkaan kielikoodi). Selitteet (FIN = Suomi, ENG = Englanti, SWE = Ruotsi) */
+  languageCode?: 'FIN' | 'SWE' | 'ENG';
+  /** Purchase instant messaging type code (Pankkisiirto-Viestityyppi). Selitteet (1 = Viite, 2 = Viesti, 3 = Veroviesti) */
+  instantMessagingType?: '1' | '2' | '3';
+  interestDisabled?: boolean;
+  intermediatorCode?: string;
+  isCustomer?: boolean;
+  ovtIdentifier?: string;
+  /** Payment pririty for purchases (Ostojen maksuprioriteetti). Selitteet (1 = Kiireellinen, 2 = Tärkeä, 3 = Normaali, 4 = Ei niin tärkeä, 5 = Voi odottaa) */
+  paymentPriority?: 1 | 2 | 3 | 4 | 5;
+  purchasePaymentTerm?: string;
+  supplierCustomerId?: string;
+  purchasePostingGroup?: string;
+  additionalInformation?: string;
+  privateAdditionalInfo?: string;
+  purchaseDeliveryMethodId?: string;
+  purchasePostingCode?: string;
+  salesPostingGroup?: string;
+  purchaseDeliveryTermId?: string;
+  responsablePerson?: string;
+  /** Reference format (Viitenumeron muoto). Selitteet (LV = Laskunumero + vakio, VL = Vakio + laskunumero, VA = Vakioarvo) */
+  referenceFormat?: 'LV' | 'VL' | 'VA';
+  referenceDefaultValue?: string;
+  salesPersonId?: string;
+  salesPaymentTerm?: string;
+  isSupplier?: boolean;
+  salesDeliveryTermId?: string;
+  transmissionTypeId?: string;
+  website?: string;
+  /** SpecificationIdentifier element on Finvoice (EU-normin mukainen verkkolaskukoodi) */
+  specificationIdentifier?: string;
+  buyerCountrySubdivision?: string;
+  classificationCode?: string;
+  classificationText?: string;
+  agreementIdentifier?: string;
+  buyerReferenceIdentifier?: string;
+  accountDimensionText?: string;
+  tenderReference?: string;
+  isConsumer?: boolean;
+  einvoiceDirectPaymentprintingType?: string;
+  einvoiceDirectPayment?: boolean;
+  customerEntityAddressDTOS?: ICustomerEntityAddressDTO[];
+  customerEntityBankAccountDTOS?: ICustomerEntityBankAccountDTO[];
+}
+
+export interface ICustomerEntityAddressDTO {
+  /** Address type (Osoitetyyppi). Selitteet (01 = Postiosoite, 02 = Käyntiosoite, 03 = Laskutusosoite, 04 = Toimitusosoite) */
+  addressType?: '01' | '02' | '03' | '04';
+  /** Fivaldi will set this id to new address */
+  addressId?: number;
+  streetAddress?: string;
+  streetAddress2?: string;
+  postalCode?: string;
+  postalAddress?: string;
+  /** Country code with ISO 3166-1 standard (Osoitteen maakoodi) */
+  countryCode?: string;
+  isMainAddress?: boolean;
+  changeTime?: string;
+  changeUser?: string;
+}
+
+export interface ICustomerEntityBankAccountDTO {
+  /** Fivaldi will set this id to new bank accounts */
+  bankAccountId?: string;
+  /** Fivaldi will set this based on IBAN- number if FI bank account and IBAN is given (Tilinumero) */
+  bbanNumber?: string;
+  bankAddress?: string;
+  bankName?: string;
+  changeTime?: string;
+  changeUser?: string;
+  clearingCode?: string;
+  /** Country code of bank account with ISO 3166-1 standard (Pankkitilin maakoodi) */
+  countryId: string;
+  /** Foreign payment charge code (Valuuttamaksun palvelumaksut). Selitteet (J = Jaettu, T = Maksaja maksaa) */
+  foreignPaymentCharge?: 'J' | 'T';
+  /** Foreign payment type code (Valuuttamaksun maksutapa). Selitteet (M = Maksumääräys, P = Pikamääräys, Q = SWIFT- shekki, S = Shekki, T = Pankin sisäinen tilisiirto, K = Konsernimaksu, B = Eu-maksu OP) */
+  foreignPaymentType?: 'M' | 'P' | 'Q' | 'S' | 'T' | 'K' | 'B';
+  ibanNumber?: string;
+  swift?: string;
+}
+
+export interface IProductRegisterBasicDetails {
+  paymentTermDTOList: IPaymentTermDTO[];
+  deliveryMethodDTOList: IDeliveryMethodDTO[];
+  deliveryTermDTOList: IDeliveryTermDTO[];
+  currencyDTOList: ICurrencyDTO[];
+  salesPersonDTOList: ISalesPersonDTO[];
+  salesPostingGroupDTOList: ISalesPostingGroupDTO[];
+  purchasesPostingGroupDTOList: [];
+  customerGroupAndSegmentsDTOList: [];
+  fivaldiCompanyBankAccountDTOList: [];
+  accountDimension1ValueDTOList: IAccountDimensionValueDTO[];
+  accountDimension2ValueDTOList: IAccountDimensionValueDTO[];
+  accountDimension3ValueDTOList: IAccountDimensionValueDTO[];
+  accountDimension4ValueDTOList: IAccountDimensionValueDTO[];
+  purchasePostingCodeDTOList: IPurchasePostingCodeDTO[];
+  paymentPriorityDTOList: IPaymentPriorityDTO[];
+  referenceFormatDTOList: IReferenceFormatDTO[];
+  instantMessagingTypeDTOList: IInstantMessagingTypeDTO[];
+  transmissionTypeDTOList: ITransmissionTypeDTO[];
+  einvoiceDirectPaymentprintingTypeDTOList: ITransmissionTypeDTO[];
+  addressTypeDTOList: IAddressTypeDTO[];
+  foreignPaymentTypeDTOList: IForeignPaymentDTO[];
+  foreignPaymentChargeDTOList: IForeignPaymentDTO[];
+}
+
+interface IPaymentTermDTO {
+  paymentTermId: number;
+  discountDates: number;
+  discountPercent: number;
+  netDueDate: number;
+  defaultPaymentTerm: boolean;
+  description: string;
+}
+
+interface IDeliveryMethodDTO {
+  deliveryMethodId: string;
+  defaultDeliveryMethod: string;
+  description: string;
+}
+
+interface IDeliveryTermDTO {
+  deliveryTermId: string;
+  defaultDeliveryTerm: boolean;
+  description: string;
+  deliveryTermText: string;
+}
+
+interface ICurrencyDTO {
+  currency: string;
+  description: string;
+  currencyRate: number;
+}
+
+interface ISalesPersonDTO {}
+
+interface ISalesPostingGroupDTO {
+  postingGroupId: string;
+  description: string;
+  cashSales: boolean;
+  defaultPostingGroupForSales: boolean;
+  defaultPostingGroupForPurchases: boolean;
+  defaultPostingId: string;
+  accountsReceivableAccount: string;
+  defaultSk1: string;
+  defaultSk2: string;
+  defaultSk3: string;
+  defaultSk4: string;
+}
+
+interface IAccountDimensionValueDTO {
+  dimension: string;
+  accountId: string;
+  finAccountDescription: string;
+  engAccountDescription: string;
+  sweAccountDescription: string;
+}
+
+interface IPurchasePostingCodeDTO {
+  accountingCode: string;
+  accountingDescription: string;
+}
+
+interface IPaymentPriorityDTO {
+  id: string;
+  description: string;
+}
+
+interface IReferenceFormatDTO {
+  id: string;
+  description: string;
+}
+
+interface IInstantMessagingTypeDTO {
+  id: string;
+  description: string;
+}
+
+interface ITransmissionTypeDTO {
+  transmissionTypeId: string;
+  description: string;
+  type: string;
+}
+
+interface IAddressTypeDTO {
+  addressType: string;
+  description: string;
+}
+
+interface IForeignPaymentDTO {
+  type: string;
+  description: string;
+}
+
+export interface ICustomerEntityDTO {
+  customerId: string;
+  businessId: string;
+  customerName: string;
+  customerName2: string;
+  email: string;
+  email2: string;
+  phoneNumber: string;
+  phoneNumber2: string;
+  changeTime: string;
+}