@chift/chift-nodejs 1.0.1 → 1.0.2

package/CHANGELOG.md

@@ -1,9 +1,16 @@
 # Changelog
 
 ## 1.0.0 - 2023-09-14
-* First release with scopes of the 5 unified APIs (Accounting, POS, eCommerce, Invoicing & Payment) of Chift and the management of consumers, connections & webhooks.
-* Review of tests and CI-pipeline
+
+-   First release with scopes of the 5 unified APIs (Accounting, POS, eCommerce, Invoicing & Payment) of Chift and the management of consumers, connections & webhooks.
+-   Review of tests and CI-pipeline
 
 ## 1.0.1 - 2023-09-21
-* Update accounting model
-* add getOutstandings route
+
+-   Update accounting model
+-   add getOutstandings route
+
+## 1.0.2 - 2023-10-02
+
+-   add createFinancialEntry params
+-   add createJournalEntry route

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@chift/chift-nodejs",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "description": "The Chift NodeJS library provides convenient access to the Chift API from applications written in the NodeJS language (Javascript/Typescript).",
     "main": "dist/src/index.js",
     "types": "dist/src/index.d.ts",

package/src/modules/accounting.ts

@@ -358,14 +358,25 @@ const accountingFactory = {
         };
     },
     createFinancialEntry(
-        financial_entry: components['schemas']['FinancialEntryItemIn']
+        financial_entry: components['schemas']['FinancialEntryItemIn'],
+        params: operations['accounting_create_financial_entry']['parameters']['query']
     ): RequestData<components['schemas']['FinancialEntryItemOut']> {
         return {
+            params,
             method: 'post',
             url: '/consumers/{consumer_id}/accounting/financial-entry',
             body: financial_entry,
         };
     },
+    createJournalEntry(
+        journal_entry: components['schemas']['JournalEntryIn']
+    ): RequestData<components['schemas']['JournalEntryMultiAnalyticPlan']> {
+        return {
+            method: 'post',
+            url: '/consumers/{consumer_id}/accounting/journal/entries',
+            body: journal_entry,
+        };
+    },
 };
 
 export { accountingFactory };

package/src/types/public-api/schema.d.ts

@@ -64,6 +64,10 @@ export interface paths {
          */
         get: operations['integrations_get_integrations'];
     };
+    '/integrations/{integrationid}/{image_type}.json': {
+        /** Returns a logo/icon of an integration (as base64) */
+        get: operations['integrations_get_integration_logo_json'];
+    };
     '/webhooks/list': {
         /**
          * Get list of possible webhooks
@@ -1946,7 +1950,7 @@ export interface components {
             account_number: string;
             /**
              * Partner Id
-             * @description Must be filled in it is a 'customer_account' or 'supplier_account' line type.
+             * @description Must be filled in it is a 'customer_account', 'supplier_account' or 'employee_account' line type.
              */
             partner_id?: string;
             /**
@@ -1964,7 +1968,7 @@ export interface components {
             account_number: string;
             /**
              * Partner Id
-             * @description Must be filled in it is a 'customer_account' or 'supplier_account' line type.
+             * @description Must be filled in it is a 'customer_account', 'supplier_account' or 'employee_account' line type.
              */
             partner_id?: string;
             /**
@@ -2078,6 +2082,12 @@ export interface components {
             /** Url */
             url: string;
         };
+        /**
+         * ImageType
+         * @description An enumeration.
+         * @enum {unknown}
+         */
+        ImageType: 'icon' | 'logo';
         /** IntegrationItem */
         IntegrationItem: {
             /** Integrationid */
@@ -2086,6 +2096,10 @@ export interface components {
             name: string;
             status: components['schemas']['app__routers__integrations__Status'];
             api: components['schemas']['Api'];
+            /** Logo Url */
+            logo_url: string;
+            /** Icon Url */
+            icon_url: string;
             /**
              * Credentials
              * @description List of credentials that must be specified to create a connection. Can be used if you want to pass credentials on connection creation. Not compatible with oAuth2 routes.
@@ -3115,6 +3129,13 @@ export interface components {
             /** Url */
             url: string;
         };
+        /** LogoImage */
+        LogoImage: {
+            /** Integrationid */
+            integrationid: string;
+            /** Data */
+            data: string;
+        };
         /** MappingItem */
         MappingItem: {
             /** Source Id */
@@ -5817,6 +5838,35 @@ export interface operations {
             };
         };
     };
+    /** Returns a logo/icon of an integration (as base64) */
+    integrations_get_integration_logo_json: {
+        parameters: {
+            path: {
+                integrationid: number;
+                image_type: components['schemas']['ImageType'];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                content: {
+                    'application/json': components['schemas']['LogoImage'];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                content: {
+                    'application/json': components['schemas']['ChiftError'];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                content: {
+                    'application/json': components['schemas']['HTTPValidationError'];
+                };
+            };
+        };
+    };
     /**
      * Get list of possible webhooks
      * @description Returns a list of webhook that are available for your account
@@ -7944,6 +7994,10 @@ export interface operations {
      */
     accounting_create_financial_entry: {
         parameters: {
+            query?: {
+                /** @description Counterpart account number of the bank/cash journal. This will be retrieved from the accounting settings if left empty. */
+                financial_counterpart_account?: string;
+            };
             path: {
                 consumer_id: string;
             };

package/test/modules/accounting.test.ts

@@ -40,6 +40,19 @@ test('getJournals', async () => {
     expect(journals[0]).toHaveProperty('journal_type', expect.any(String));
 });
 
+let vatCodes: components['schemas']['app__routers__accounting__VatCode'][];
+test('getVatCodes', async () => {
+    vatCodes = await consumer.accounting.getVatCodes();
+    expect(vatCodes).toBeInstanceOf(Array);
+    expect(vatCodes.length).toBeGreaterThan(0);
+    expect(vatCodes[0]).toHaveProperty('id', expect.any(String));
+    expect(vatCodes[0]).toHaveProperty('code');
+    expect(vatCodes[0]).toHaveProperty('label', expect.any(String));
+    expect(vatCodes[0]).toHaveProperty('scope', expect.any(String));
+    expect(vatCodes[0]).toHaveProperty('rate', expect.any(Number));
+    expect(vatCodes[0]).toHaveProperty('type', expect.any(String));
+});
+
 test('createClient', async () => {
     const body: components['schemas']['ClientItemIn'] = {
         external_reference: 'sdk test',
@@ -164,6 +177,16 @@ test('updateSupplier', async () => {
 });
 
 test('createInvoice', async () => {
+    const journal = journals.find((journal) => journal.journal_type === 'customer_invoice');
+    if (!journal) {
+        throw new Error('No journal with type "customer_invoice" found to create invoice');
+    }
+
+    const vatCode = vatCodes.find((vatCode) => vatCode.type === 'sale' && vatCode.rate === 21);
+    if (!vatCode?.id) {
+        throw new Error('No vat code with type "sale" and rate 21 found to create invoice');
+    }
+
     const body: components['schemas']['InvoiceItemInMonoAnalyticPlan'] = {
         invoice_type: 'customer_invoice',
         invoice_date: '2022-12-01',
@@ -173,7 +196,7 @@ test('createInvoice', async () => {
         tax_amount: 21,
         total: 121,
         partner_id: clients[0]?.id as string,
-        journal_id: journals[0].id,
+        journal_id: journal.id,
         lines: [
             {
                 description: 'Test',
@@ -184,7 +207,7 @@ test('createInvoice', async () => {
                 tax_amount: 21,
                 total: 121,
                 account_number: '700000',
-                tax_code: '1',
+                tax_code: vatCode.id,
             },
         ],
     };
@@ -243,6 +266,18 @@ test('getInvoice', async () => {
 });
 
 test('createInvoiceWithMultiplePlans', async () => {
+    const journal = journals.find((journal) => journal.journal_type === 'customer_invoice');
+    if (!journal) {
+        throw new Error(
+            'No journal with type customer_invoice found to create Invoice With Multiple Plans'
+        );
+    }
+
+    const vatCode = vatCodes.find((vatCode) => vatCode.type === 'sale' && vatCode.rate === 21);
+    if (!vatCode?.id) {
+        throw new Error('No vat code with type "sale" and rate 21 found to create invoice');
+    }
+
     const body: components['schemas']['InvoiceItemInMonoAnalyticPlan'] = {
         invoice_type: 'customer_invoice',
         invoice_date: '2022-12-01',
@@ -252,7 +287,7 @@ test('createInvoiceWithMultiplePlans', async () => {
         tax_amount: 21,
         total: 121,
         partner_id: clients[0]?.id as string,
-        journal_id: journals[0].id,
+        journal_id: journal.id,
         lines: [
             {
                 description: 'Test',
@@ -263,7 +298,7 @@ test('createInvoiceWithMultiplePlans', async () => {
                 tax_amount: 21,
                 total: 121,
                 account_number: '700000',
-                tax_code: '1',
+                tax_code: vatCode.id,
             },
         ],
     };
@@ -374,6 +409,35 @@ test('getAnalyticLinesOfAccount', async () => {
     }
 });
 
+test('createJournalEntry', async () => {
+    const journal = journals.find((journal) => journal.journal_type === 'customer_invoice');
+    if (!journal) {
+        throw new Error('No journal with type "customer_invoice" found to create journal entry');
+    }
+    const journalEntry = await consumer.accounting.createJournalEntry({
+        journal_id: journal.id,
+        name: Date.now().toString(),
+        date: '2022-01-01',
+        items: [
+            {
+                account_number: clients[0].account_number,
+                credit: 0,
+                debit: 10,
+                partner_id: clients[0].id,
+                currency: 'EUR',
+            },
+            {
+                account_number: '700000',
+                credit: 10,
+                debit: 0,
+                currency: 'EUR',
+            },
+        ],
+    });
+    expect(journalEntry).toBeTruthy();
+    expect(journalEntry).toHaveProperty('journal_id', journal.id);
+});
+
 test('getJournalEntries', async () => {
     const journalEntries = await consumer.accounting.getJournalEntries({
         unposted_allowed: true,
@@ -399,18 +463,6 @@ test('getPaymentsByInvoiceId', async () => {
     expect(payments).toBeInstanceOf(Array);
 });
 
-test('getVatCodes', async () => {
-    const vatCodes = await consumer.accounting.getVatCodes();
-    expect(vatCodes).toBeInstanceOf(Array);
-    expect(vatCodes.length).toBeGreaterThan(0);
-    expect(vatCodes[0]).toHaveProperty('id', expect.any(String));
-    expect(vatCodes[0]).toHaveProperty('code');
-    expect(vatCodes[0]).toHaveProperty('label', expect.any(String));
-    expect(vatCodes[0]).toHaveProperty('scope', expect.any(String));
-    expect(vatCodes[0]).toHaveProperty('rate', expect.any(Number));
-    expect(vatCodes[0]).toHaveProperty('type', expect.any(String));
-});
-
 let miscOperations: components['schemas']['MiscellaneousOperationOut'][];
 test('getMiscOperations', async () => {
     miscOperations = await consumer.accounting.getMiscOperations();
@@ -485,13 +537,48 @@ test('getBalanceOfAccounts', async () => {
 test('getEmployees', async () => {
     const employees = await consumer.accounting.getEmployees();
     expect(employees).toBeTruthy();
-    expect(employees.items).toBeInstanceOf(Array);
 });
 
 test('getOutstandings', async () => {
-    const outstandings = await consumer.accounting.getOutstandings({
-        type: 'client',
+    expect.assertions(1);
+    try {
+        const outstandings = await consumer.accounting.getOutstandings({
+            type: 'client',
+            unposted_allowed: true,
+        });
+        expect(outstandings).toBeTruthy();
+        expect(outstandings.items).toBeInstanceOf(Array);
+    } catch (e: any) {
+        if (e?.error?.error_code) {
+            expect(e.error.error_code).toMatch('ERROR_API_RESOURCE_NOT_FOUND');
+            return;
+        }
+
+        throw e;
+    }
+});
+
+test('createFinancialEntry', async () => {
+    const journal = journals.find((journal) => journal.journal_type === 'financial_operation');
+    if (!journal) {
+        throw new Error(
+            'No journal with type "financial_operation" found to create financial entry'
+        );
+    }
+
+    const financialEntry = await consumer.accounting.createFinancialEntry({
+        date: '2022-01-01',
+        journal_id: journal.id,
+        currency: 'EUR',
+        items: [
+            {
+                type: 'customer_account',
+                account_number: clients[0].account_number,
+                partner_id: clients[0].id,
+                amount: 10,
+            },
+        ],
     });
-    expect(outstandings).toBeTruthy();
-    expect(outstandings.items).toBeInstanceOf(Array);
+    expect(financialEntry).toBeTruthy();
+    expect(financialEntry).toHaveProperty('journal_id', journal.id);
 });

package/test/modules/consumers.test.ts

@@ -51,7 +51,9 @@ test('getConsumers', async () => {
 test('getConsumersByName', async () => {
     const consumersWithName = await client.Consumers.getConsumersByName(consumerName);
     expect(consumersWithName).toBeInstanceOf(Array);
-    expect(consumersWithName[0]).toHaveProperty('name', consumerName);
+    expect(consumersWithName.some((consumer: any) => consumer.name.includes(consumerName))).toBe(
+        true
+    );
 });
 
 test('getConsumerById', async () => {