@emilgroup/billing-sdk-node 1.3.0 → 1.4.1

package/models/invoice-class.ts

@@ -5,7 +5,7 @@
  * The EMIL BillingService API description
  *
  * The version of the OpenAPI document: 1.0
- * 
+ * Contact: kontakt@emil.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -13,7 +13,9 @@
  */
 
 
+import { CurrencyClass } from './currency-class';
 import { InvoiceItemClass } from './invoice-item-class';
+import { InvoiceStatusClass } from './invoice-status-class';
 
 /**
  * 
@@ -22,106 +24,138 @@ import { InvoiceItemClass } from './invoice-item-class';
  */
 export interface InvoiceClass {
     /**
-     * Invoice id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof InvoiceClass
      */
     'id': number;
     /**
-     * policy code
+     * Unique identifier of the policy that this object belongs to.
      * @type {string}
      * @memberof InvoiceClass
      */
     'policyCode': string;
     /**
-     * Account number
+     * Account number.
      * @type {string}
      * @memberof InvoiceClass
      */
     'accountNumber': string;
     /**
-     * Invoice code
+     * Unique identifier for the object.
      * @type {string}
      * @memberof InvoiceClass
      */
     'code': string;
     /**
-     * Invoice type
+     * Invoice type.
      * @type {string}
      * @memberof InvoiceClass
      */
-    'type': string;
+    'type': InvoiceClassTypeEnum;
     /**
-     * Invoice number
+     * Invoice number.
      * @type {string}
      * @memberof InvoiceClass
      */
     'invoiceNumber': string;
     /**
-     * Net amount
+     * Net amount is in cents.
      * @type {number}
      * @memberof InvoiceClass
      */
     'netAmount': number;
     /**
-     * Tax amount
+     * Tax amount is in cents.
      * @type {number}
      * @memberof InvoiceClass
      */
     'taxAmount': number;
     /**
-     * Credit amount
+     * Credit amount.
      * @type {number}
      * @memberof InvoiceClass
      */
     'creditAmount': number;
     /**
-     * Gross amount
+     * Gross amount. This property is sum of taxAmount and netAmount.
      * @type {number}
      * @memberof InvoiceClass
      */
     'grossAmount': number;
     /**
-     * Invoice status
+     * Invoice status.
      * @type {string}
      * @memberof InvoiceClass
      */
-    'status': string;
+    'status': InvoiceClassStatusEnum;
     /**
-     * Invoice due date
+     * Invoice due date.
      * @type {string}
      * @memberof InvoiceClass
      */
     'dueDate': string;
     /**
-     * Invoice metadata
+     * Metadata contains extra information that the object would need for specific cases.
      * @type {object}
      * @memberof InvoiceClass
      */
     'metadata': object;
     /**
-     * Invoice billing interval from
+     * Start date of billing interval.
      * @type {string}
      * @memberof InvoiceClass
      */
     'billingIntervalFrom': string;
     /**
-     * Invoice billing interval to
+     * End date of billing interval.
      * @type {string}
      * @memberof InvoiceClass
      */
     'billingIntervalTo': string;
     /**
-     * Invoice created at
+     * Time at which the object was created.
      * @type {string}
      * @memberof InvoiceClass
      */
     'createdAt': string;
     /**
-     * Invoice items
+     * Invoice items.
      * @type {Array<InvoiceItemClass>}
      * @memberof InvoiceClass
      */
     'invoiceItems': Array<InvoiceItemClass>;
+    /**
+     * Invoice statuses.
+     * @type {Array<InvoiceStatusClass>}
+     * @memberof InvoiceClass
+     */
+    'statuses': Array<InvoiceStatusClass>;
+    /**
+     * Invoice currency. EUR is used by default.
+     * @type {CurrencyClass}
+     * @memberof InvoiceClass
+     */
+    'currency': CurrencyClass;
 }
 
+export const InvoiceClassTypeEnum = {
+    Initial: 'initial',
+    Recurring: 'recurring',
+    Correction: 'correction',
+    Estimated: 'estimated',
+    Penalty: 'penalty',
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
+} as const;
+
+export type InvoiceClassTypeEnum = typeof InvoiceClassTypeEnum[keyof typeof InvoiceClassTypeEnum];
+export const InvoiceClassStatusEnum = {
+    Open: 'open',
+    Paid: 'paid'
+} as const;
+
+export type InvoiceClassStatusEnum = typeof InvoiceClassStatusEnum[keyof typeof InvoiceClassStatusEnum];
+
+

package/models/invoice-item-class.ts

@@ -5,7 +5,7 @@
  * The EMIL BillingService API description
  *
  * The version of the OpenAPI document: 1.0
- * 
+ * Contact: kontakt@emil.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -21,94 +21,106 @@
  */
 export interface InvoiceItemClass {
     /**
-     * Invoice item id
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'id': number;
     /**
-     * Premium formula id
+     * Unique identifier referencing the premium formula.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'premiumFormulaId': number;
     /**
-     * product name
+     * Product name.
      * @type {string}
      * @memberof InvoiceItemClass
      */
     'name': string;
     /**
-     * tax code
+     * Unique identifier of the tax that this object belongs to.
      * @type {string}
      * @memberof InvoiceItemClass
      */
     'taxCode': string;
     /**
-     * Invoice type
+     * Unit of Premium..Premium units are determined based on time or distance.
      * @type {string}
      * @memberof InvoiceItemClass
      */
-    'unit': string;
+    'unit': InvoiceItemClassUnitEnum;
     /**
-     * group
+     * Invoice group.
      * @type {string}
      * @memberof InvoiceItemClass
      */
     'group': string;
     /**
-     * Item quantity
+     * Item quantity. this property determines number of days during the billing interval.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'quantity': number;
     /**
-     * Item price per unit
+     * Item price per unit.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'pricePerUnit': number;
     /**
-     * Item tax rate
+     * Item tax rate.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'taxRate': number;
     /**
-     * Net amount
+     * Net amount is in cents. It is calculated by multiplying the quantity and the price Per unit.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'netAmount': number;
     /**
-     * Net tax amount
+     * Tax amount is in cents.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'taxAmount': number;
     /**
-     * Gross amount
+     * Gross amount. This property is sum of taxAmount and netAmount.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'grossAmount': number;
     /**
-     * Credit amount
+     * Credit amount.
      * @type {number}
      * @memberof InvoiceItemClass
      */
     'creditAmount': number;
     /**
-     * Invoice item interval from
+     * This is the date from which the invoice item interval starts.
      * @type {string}
      * @memberof InvoiceItemClass
      */
     'billingIntervalFrom': string;
     /**
-     * Invoice item interval to
+     * This is the date that the invoice item interval ends.
      * @type {string}
      * @memberof InvoiceItemClass
      */
     'billingIntervalTo': string;
 }
 
+export const InvoiceItemClassUnitEnum = {
+    Day: 'day',
+    Week: 'week',
+    Month: 'month',
+    Quarter: 'quarter',
+    Year: 'year',
+    OneTimePayment: 'oneTimePayment'
+} as const;
+
+export type InvoiceItemClassUnitEnum = typeof InvoiceItemClassUnitEnum[keyof typeof InvoiceItemClassUnitEnum];
+
+

package/models/invoice-status-class.ts

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL BillingService
+ * The EMIL BillingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface InvoiceStatusClass
+ */
+export interface InvoiceStatusClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof InvoiceStatusClass
+     */
+    'id': number;
+    /**
+     * Unique identifier referencing the invoice.
+     * @type {number}
+     * @memberof InvoiceStatusClass
+     */
+    'invoiceId': number;
+    /**
+     * Invoice type.
+     * @type {string}
+     * @memberof InvoiceStatusClass
+     */
+    'status': InvoiceStatusClassStatusEnum;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof InvoiceStatusClass
+     */
+    'createdAt': string;
+}
+
+export const InvoiceStatusClassStatusEnum = {
+    Open: 'open',
+    Paid: 'paid'
+} as const;
+
+export type InvoiceStatusClassStatusEnum = typeof InvoiceStatusClassStatusEnum[keyof typeof InvoiceStatusClassStatusEnum];
+
+

package/models/list-invoices-response-class.ts

@@ -5,7 +5,7 @@
  * The EMIL BillingService API description
  *
  * The version of the OpenAPI document: 1.0
- * 
+ * Contact: kontakt@emil.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -22,13 +22,13 @@ import { InvoiceClass } from './invoice-class';
  */
 export interface ListInvoicesResponseClass {
     /**
-     * Invoices list items
+     * Invoices list items.
      * @type {Array<InvoiceClass>}
      * @memberof ListInvoicesResponseClass
      */
     'items': Array<InvoiceClass>;
     /**
-     * Next page token
+     * Next page token.
      * @type {string}
      * @memberof ListInvoicesResponseClass
      */

package/models/list-policies-billing-dates-response-class.ts

@@ -5,7 +5,7 @@
  * The EMIL BillingService API description
  *
  * The version of the OpenAPI document: 1.0
- * 
+ * Contact: kontakt@emil.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -13,6 +13,7 @@
  */
 
 
+import { PolicyBillingDateClass } from './policy-billing-date-class';
 
 /**
  * 
@@ -21,13 +22,13 @@
  */
 export interface ListPoliciesBillingDatesResponseClass {
     /**
-     * Invoices list items
-     * @type {Array<string>}
+     * Invoices list items.
+     * @type {Array<PolicyBillingDateClass>}
      * @memberof ListPoliciesBillingDatesResponseClass
      */
-    'items': Array<string>;
+    'items': Array<PolicyBillingDateClass>;
     /**
-     * Next page token
+     * Next page token.
      * @type {string}
      * @memberof ListPoliciesBillingDatesResponseClass
      */

package/models/list-request-dto.ts

@@ -5,7 +5,7 @@
  * The EMIL BillingService API description
  *
  * The version of the OpenAPI document: 1.0
- * 
+ * Contact: kontakt@emil.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech

package/models/omit-type-class.ts

@@ -0,0 +1,154 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL BillingService
+ * The EMIL BillingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { CurrencyClass } from './currency-class';
+import { InvoiceItemClass } from './invoice-item-class';
+
+/**
+ * 
+ * @export
+ * @interface OmitTypeClass
+ */
+export interface OmitTypeClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'id': number;
+    /**
+     * Unique identifier of the policy that this object belongs to.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'policyCode': string;
+    /**
+     * Account number.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'accountNumber': string;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'code': string;
+    /**
+     * Invoice type.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'type': OmitTypeClassTypeEnum;
+    /**
+     * Invoice number.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'invoiceNumber': string;
+    /**
+     * Net amount is in cents.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'netAmount': number;
+    /**
+     * Tax amount is in cents.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'taxAmount': number;
+    /**
+     * Credit amount.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'creditAmount': number;
+    /**
+     * Gross amount. This property is sum of taxAmount and netAmount.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'grossAmount': number;
+    /**
+     * Invoice status.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'status': OmitTypeClassStatusEnum;
+    /**
+     * Invoice due date.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'dueDate': string;
+    /**
+     * Metadata contains extra information that the object would need for specific cases.
+     * @type {object}
+     * @memberof OmitTypeClass
+     */
+    'metadata': object;
+    /**
+     * Start date of billing interval.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'billingIntervalFrom': string;
+    /**
+     * End date of billing interval.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'billingIntervalTo': string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'createdAt': string;
+    /**
+     * Invoice items.
+     * @type {Array<InvoiceItemClass>}
+     * @memberof OmitTypeClass
+     */
+    'invoiceItems': Array<InvoiceItemClass>;
+    /**
+     * Invoice currency. EUR is used by default.
+     * @type {CurrencyClass}
+     * @memberof OmitTypeClass
+     */
+    'currency': CurrencyClass;
+}
+
+export const OmitTypeClassTypeEnum = {
+    Initial: 'initial',
+    Recurring: 'recurring',
+    Correction: 'correction',
+    Estimated: 'estimated',
+    Penalty: 'penalty',
+    Other: 'other',
+    Withdraw: 'withdraw',
+    Final: 'final'
+} as const;
+
+export type OmitTypeClassTypeEnum = typeof OmitTypeClassTypeEnum[keyof typeof OmitTypeClassTypeEnum];
+export const OmitTypeClassStatusEnum = {
+    Open: 'open',
+    Paid: 'paid'
+} as const;
+
+export type OmitTypeClassStatusEnum = typeof OmitTypeClassStatusEnum[keyof typeof OmitTypeClassStatusEnum];
+
+

package/models/policy-billing-date-class.ts

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL BillingService
+ * The EMIL BillingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface PolicyBillingDateClass
+ */
+export interface PolicyBillingDateClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof PolicyBillingDateClass
+     */
+    'id': number;
+    /**
+     * Unique identifier of the policy that this object belongs to.
+     * @type {string}
+     * @memberof PolicyBillingDateClass
+     */
+    'policyCode': string;
+    /**
+     * The next billing date this policy will be invoiced.
+     * @type {string}
+     * @memberof PolicyBillingDateClass
+     */
+    'nextBillingDate': string;
+    /**
+     * This field will be set to true once an invoice has been created on this specific billing date.     It is there to avoid a policy being invoiced multiple times in case of retry.
+     * @type {boolean}
+     * @memberof PolicyBillingDateClass
+     */
+    'isInvoiced': boolean;
+}
+