0.3.0 Added Sales orders method

Author: henripero

.gitignore

@@ -103,4 +103,5 @@ dist
 # TernJS port file
 .tern-port
 
+nodemon.json
 test.js

README.md

@@ -44,6 +44,7 @@ const fivaldi = new FivaldiApiClient({
   timeout: 120000
 });
 ```
+
 ## Usage
 
 To make API requests to certain company, the API client needs id for the company, which is called `cuid`.
@@ -53,21 +54,23 @@ Fivaldi API client has few general root methods that you can use without cuid. T
 ### Root methods
 
 If you don't know the cuid of the company you want to access to with the API, you can fetch it with root methods. Easiest way is to search the company's info by `businessId` (y-tunnus):
+
 ```ts
 const companyInfo = await fivaldi.getCompanies({ businessId: '1234567-0' });
 const cuid = companyInfo.cuid;
 fivaldi.setCuid(cuid);
 ```
-If you don't know the business id of the company or you want to see all the customers your partner id has access to, you can use `getCustomers()` method.
 
+If you don't know the business id of the company or you want to see all the customers your partner id has access to, you can use `getCustomers()` method.
 
-:heavy_exclamation_mark: **_NOTE:_**  One partner id can have access to multiple customers. One customer can have access to multiple companies.
-
+:heavy*exclamation_mark: \*\*\_NOTE:*\*\* One partner id can have access to multiple customers. One customer can have access to multiple companies.
 
 ```ts
 const customers = await fivaldi.getCustomers();
 ```
+
 Then you can use `getCompanies()` again to search all the companies that certain customer has access to.
+
 ```ts
 // See all the companies chosen customer has access to
 const customers = await fivaldi.getCompanies({ customerId: 'CUSTOMER_ID' });
@@ -76,10 +79,13 @@ const customers = await fivaldi.getCompanies({ customerId: 'CUSTOMER_ID' });
 // You can then use the business id of the company you want access to and use it to get that company's cuid
 const companyInfo = await fivaldi.getCompanies({ businessId: '1234567-0' });
 ```
+
 After you've gotten the CUID of the company you want to access to, use `setCuid()` method to set the cuid.
+
 ```ts
 const cuid = fivaldi.setCuid('CUID_OF_THE_COMPANY');
 ```
+
 After this, you can use all the methods available.
 
 ## Implemented methods
@@ -91,6 +97,7 @@ The following API methods have been implemented:
 - `purchaseInvoices` Purchase invoices
 - `chartOfAccounts` Chart of Accounts
 - `archive` Archive of files
+- `sales` Sales orders
 
 ### Bookkeeping examples
 
@@ -101,27 +108,27 @@ const vouchers = await fivaldi.bookkeeping.getVouchers({ startDate: '2021-01-01'
 // Get a single voucher with voucher number
 const voucher = await fivaldi.bookkeeping.getVoucherById({ voucherNumber: '802206001' });
 
-// Create a new voucher and receive 
+// Create a new voucher and receive
 const voucher = {
-    voucherTypeId: 80,
-    originalVoucherNumber: '123',
-    voucherDate: '2022-06-15',
-    bookkeepingMonth: 202206,
-    vatType: 'CALCULATED',
-    validateEntrySum: true,
-    voucherEntries: [
-      {
-        amount: -120,
-        accountNumber: 3000,
-        description: 'Entry number 1'
-      },
-      {
-        amount: 120,
-        accountNumber: 1701,
-        description: 'Entry number 2'
-      }
-    ]
-  };
+  voucherTypeId: 80,
+  originalVoucherNumber: '123',
+  voucherDate: '2022-06-15',
+  bookkeepingMonth: 202206,
+  vatType: 'CALCULATED',
+  validateEntrySum: true,
+  voucherEntries: [
+    {
+      amount: -120,
+      accountNumber: 3000,
+      description: 'Entry number 1'
+    },
+    {
+      amount: 120,
+      accountNumber: 1701,
+      description: 'Entry number 2'
+    }
+  ]
+};
 
 const voucherNumber = await fivaldi.bookkeeping.createVoucher(voucher);
 ```
@@ -150,14 +157,13 @@ const product = await fivaldi.products.updateProductAllFields({
 });
 
 // Update only the product fields that are given
-const
- product = await fivaldi.products.updateProduct({ purchaseCostPrice: 155 });
+const product = await fivaldi.products.updateProduct({ purchaseCostPrice: 155 });
 
 // Create product language description (translation)
 const product = await fivaldi.products.createProductDescription(
   {
     description: 'Tegelstenar',
-    languageCode: 'SWE',
+    languageCode: 'SWE'
   },
   { productCode: '123' }
 );
@@ -198,31 +204,75 @@ const purchaseInvoiceComments = await fivaldi.purchaseInvoices.getPurchaseInvoic
 
 // Create a new comment to purchase invoice
 const purchaseInvoiceComment = await fivaldi.purchaseInvoices.createPurchaseInvoiceComment('123', purchaseInvoiceCommentObject);
-
 ```
 
 ### Chart of Accounts example
+
 ```ts
 // Get accounts and dimensions
 const chartOfAccounts = await fivaldi.chartOfAccounts.getChartOfAccounts();
 ```
 
 ### Archive of files example
+
 ```ts
 // Get download url for the file with file id
 const downloadUrl = await fivaldi.archive.getFileUrl('123');
 ```
 
+### Sales orders examples
+
+```ts
+// Get company's invoicing details
+const invoicingDetails = await fivaldi.sales.getInvoicingDetails();
+
+// Get sales orders by external batch id
+const ordersBatch = await fivaldi.sales.getOrdersByBatchId('123');
+
+// Get all sales orders
+const ordersAll = await fivaldi.sales.getAllOrders();
+
+// Get sales orders with filters
+const ordersFiltered = await fivaldi.sales.getAllOrders({ fromDate: '23.08.2022', status: 'DRAFT' });
+
+// Get sales order by id
+const order = await fivaldi.sales.getOrderById('63029cd00000000000000000');
+
+// Update sales order by id
+const updatedOrder = await fivaldi.sales.updateOrderById('63029cd00000000000000000', order);
+
+// Create one or multiple sales orders
+const { externalBatchId } = await fivaldi.sales.createOrders({
+  customerId: '1002',
+  languageCode: 'FIN',
+  currency: 'EUR',
+  currencyRate: 1,
+  paymentTermId: '1',
+  postingGroupId: '0000000001',
+  transmissionTypeId: '0000000003',
+  salesOrderRowDTOS: [
+    {
+      productCode: 'M1',
+      description: 'mallituote 2',
+      unitPriceExcludingTax: 10,
+      quantity: 5,
+      unitId: '2'
+    }
+  ]
+});
+```
+
 ## Resources
 
 - Fivaldi website: https://www.visma.fi/visma-fivaldi/
 - Fivaldi API Documentation: https://ohjeet.visma.fi/articles/#!visma-fivaldi/visma-fivaldi-api
 - Fivaldi API Documentation (swagger): https://manuals.fivaldi.net/customer/api/index.html
-- Fivaldi login page: https://api2.fivaldi.net/fivaldi-angular/
+- Fivaldi login page: https://asp.fivaldi.net/fvlogin/login/connect
 
 ## Changelog
 
 - 0.0.1 First release
 - 0.1.0 Added Chart of Accounts method and fixed error logic
 - 0.1.1 Updated dependencies
-- 0.2.0 Added Archive of files method
+- 0.2.0 Added Archive of files method
+- 0.3.0 Added Sales orders method

package-lock.json

@@ -1,10 +1,11 @@
 {
   "name": "@rantalainen/fivaldi-api-client",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Third party Fivaldi API client.",
   "main": "dist/index.js",
   "scripts": {
     "dev": "tsc --watch",
+    "test": "nodemon test.js",
     "build": "tsc"
   },
   "repository": {

package.json

@@ -5,6 +5,7 @@ import { BookkeepingMethods } from './methods/bookkeeping.methods';
 import { ChartOfAccountsMethods } from './methods/chart-of-accounts.methods';
 import { ProductMethods } from './methods/products.methods';
 import { PurchaseInvoicesMethods } from './methods/purchaseInvoices.methods';
+import { SalesMethods } from './methods/sales.methods';
 import { getHeaders } from './signature';
 
 export class FivaldiApiClient {
@@ -15,6 +16,7 @@ export class FivaldiApiClient {
   readonly purchaseInvoices: PurchaseInvoicesMethods;
   readonly chartOfAccounts: ChartOfAccountsMethods;
   readonly archive: ArchiveMethods;
+  readonly sales: SalesMethods;
 
   constructor(options: IFivaldiApiClientOptions) {
     options.apiBaseUrl = options.apiBaseUrl || 'https://api.fivaldi.net/customer/api';
@@ -35,6 +37,7 @@ export class FivaldiApiClient {
     this.purchaseInvoices = new PurchaseInvoicesMethods(this);
     this.chartOfAccounts = new ChartOfAccountsMethods(this);
     this.archive = new ArchiveMethods(this);
+    this.sales = new SalesMethods(this);
   }
 
   async request(method: Method, url: string, body?: any, params?: any): Promise<any> {
@@ -61,11 +64,10 @@ export class FivaldiApiClient {
 
     let response: any;
     // If there is a body, parse and return it
-    if (result.body) {
-      if (typeof result.body === 'object') response = JSON.parse(result.body);
-      else response = result.body;
-    } else {
-      // Else just return the empty body
+    try {
+      response = JSON.parse(result.body);
+    } catch (e) {
+      // Else just return the original body
       response = result.body;
     }
 
@@ -75,7 +77,7 @@ export class FivaldiApiClient {
     }
 
     // Else, throw error with error response included
-    throw new Error(`HTTP Error: ${result.statusCode} ${result.statusMessage}
+    throw new Error(`Fivaldi HTTP Error: ${result.statusCode} ${result.statusMessage}
     ${JSON.stringify(response)}`);
   }
 

src/index.ts

@@ -72,7 +72,7 @@ export interface IFetchVoucherResponse {
   voucherEntries: IVoucherEntryResponse[];
 }
 
-interface IVoucherEntryResponse {
+export interface IVoucherEntryResponse {
   /** Voucher entry number inside voucher. */
   entryNumber: number;
   /** Voucher description. */
@@ -92,7 +92,7 @@ interface IVoucherEntryResponse {
   vat: IVoucherEntryVat;
 }
 
-interface IVoucherEntryVat {
+export interface IVoucherEntryVat {
   /** Fivaldi vat code. */
   vatCode: string;
   vatAmount: number;
@@ -109,7 +109,7 @@ export interface IVatCodeResponse {
   vatPercentages: IVatPercentageResponse[];
 }
 
-interface IVatPercentageResponse {
+export interface IVatPercentageResponse {
   /** Vat code in Fivaldi. */
   vatPercentageCode: string;
   percentage: number;
@@ -159,7 +159,7 @@ export interface IVoucherAttachmentResponse {
   archiveObjects: IArchiveObjectResponse[];
 }
 
-interface IArchiveObjectResponse {
+export interface IArchiveObjectResponse {
   objectId: string;
   objectDescription: string;
   sizeBytes: number;
@@ -183,7 +183,7 @@ export interface IVoucherImportRequest {
   voucherEntries: IVoucherEntryRequest[];
 }
 
-interface IVoucherEntryRequest {
+export interface IVoucherEntryRequest {
   /** Amount of voucher entry. */
   amount: number;
   accountNumber: number;
@@ -196,7 +196,7 @@ interface IVoucherEntryRequest {
   vat?: IVoucherEntryVatRequest;
 }
 
-interface IVoucherEntryVatRequest {
+export interface IVoucherEntryVatRequest {
   /** Vat code in Fivaldi. */
   vatCode: string;
   /** Voucher entry vat amount. */