@emilgroup/billing-sdk-node 1.28.0 → 1.28.2-beta.0

package/models/invoice-item-class.ts

@@ -0,0 +1,162 @@
+/* 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 InvoiceItemClass
+ */
+export interface InvoiceItemClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'id': number;
+    /**
+     * Unique identifier referencing the premium formula.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'premiumFormulaId': number;
+    /**
+     * Product name.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'name': string;
+    /**
+     * Unique identifier of the tax that this object belongs to.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'taxCode': string;
+    /**
+     * Unit of Premium..Premium units are determined based on time or distance.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'unit': InvoiceItemClassUnitEnum;
+    /**
+     * Invoice group.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'group': string;
+    /**
+     * Item quantity. this property determines number of days during the billing interval.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'quantity': number;
+    /**
+     * Item price per unit.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'pricePerUnit': number;
+    /**
+     * Item tax rate.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'taxRate': number;
+    /**
+     * Net amount is in cents. It is calculated by multiplying the quantity and the price Per unit.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'netAmount': number;
+    /**
+     * Tax amount is in cents.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'taxAmount': number;
+    /**
+     * Gross amount. This property is sum of taxAmount and netAmount.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'grossAmount': number;
+    /**
+     * Credit amount.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'creditAmount': number;
+    /**
+     * This is the date from which the invoice item interval starts.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'billingIntervalFrom': string;
+    /**
+     * This is the date that the invoice item interval ends.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'billingIntervalTo': string;
+    /**
+     * Type of Premium item.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'itemType'?: string;
+    /**
+     * Visibility of Premium item.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'visibility'?: string;
+    /**
+     * Invoice item quantity per day.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'quantityPerDays': number;
+    /**
+     * Invoice item price per day.
+     * @type {number}
+     * @memberof InvoiceItemClass
+     */
+    'pricePerDay': number;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof InvoiceItemClass
+     */
+    'updatedBy': 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-payment-class.ts

@@ -0,0 +1,114 @@
+/* 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 InvoicePaymentClass
+ */
+export interface InvoicePaymentClass {
+    /**
+     * Internal unique identifier for the object. You should not have to use this, use code instead.
+     * @type {number}
+     * @memberof InvoicePaymentClass
+     */
+    'id': number;
+    /**
+     * Unique identifier referencing the invoice.
+     * @type {number}
+     * @memberof InvoicePaymentClass
+     */
+    'invoiceId': number;
+    /**
+     * Payment amount is in cents.
+     * @type {number}
+     * @memberof InvoicePaymentClass
+     */
+    'transactionAmount': number;
+    /**
+     * This is the date when the payment was made.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'transactionDate': string;
+    /**
+     * Transaction reference.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'transactionReference': string;
+    /**
+     * Payment comment.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'comment': string;
+    /**
+     * Invoice gross amount is in cents.
+     * @type {number}
+     * @memberof InvoicePaymentClass
+     */
+    'invoiceGrossAmount': number;
+    /**
+     * Invoice paid amount before payment. The amount is in cents.
+     * @type {number}
+     * @memberof InvoicePaymentClass
+     */
+    'oldInvoicePaidAmount': number;
+    /**
+     * Invoice paid amount after payment. The amount is in cents.
+     * @type {number}
+     * @memberof InvoicePaymentClass
+     */
+    'newInvoicePaidAmount': number;
+    /**
+     * Invoice status before payment.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'oldInvoiceStatus': string;
+    /**
+     * Invoice status after payment.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'newInvoiceStatus': string;
+    /**
+     * Unique identifier referencing the payment.
+     * @type {number}
+     * @memberof InvoicePaymentClass
+     */
+    'paymentId': number;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'createdAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof InvoicePaymentClass
+     */
+    'updatedBy': string;
+}
+

package/models/invoice-payments-class.ts

@@ -0,0 +1,31 @@
+/* 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 { InvoicePaymentClass } from './invoice-payment-class';
+
+/**
+ * 
+ * @export
+ * @interface InvoicePaymentsClass
+ */
+export interface InvoicePaymentsClass {
+    /**
+     * Invoice payments.
+     * @type {Array<InvoicePaymentClass>}
+     * @memberof InvoicePaymentsClass
+     */
+    'payments': Array<InvoicePaymentClass>;
+}
+

package/models/invoice-status-class.ts

@@ -0,0 +1,70 @@
+/* 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;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof InvoiceStatusClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof InvoiceStatusClass
+     */
+    'updatedBy': string;
+}
+
+export const InvoiceStatusClassStatusEnum = {
+    Open: 'open',
+    Paid: 'paid',
+    PartiallyPaid: 'partially-paid',
+    Refunded: 'refunded'
+} as const;
+
+export type InvoiceStatusClassStatusEnum = typeof InvoiceStatusClassStatusEnum[keyof typeof InvoiceStatusClassStatusEnum];
+
+

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

@@ -0,0 +1,37 @@
+/* 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 { InvoiceClass } from './invoice-class';
+
+/**
+ * 
+ * @export
+ * @interface ListInvoicesResponseClass
+ */
+export interface ListInvoicesResponseClass {
+    /**
+     * Invoices list items.
+     * @type {Array<InvoiceClass>}
+     * @memberof ListInvoicesResponseClass
+     */
+    'items': Array<InvoiceClass>;
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListInvoicesResponseClass
+     */
+    'nextPageToken': string;
+}
+

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

@@ -0,0 +1,37 @@
+/* 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 { PolicyBillingDateClass } from './policy-billing-date-class';
+
+/**
+ * 
+ * @export
+ * @interface ListPoliciesBillingDatesResponseClass
+ */
+export interface ListPoliciesBillingDatesResponseClass {
+    /**
+     * Invoices list items.
+     * @type {Array<PolicyBillingDateClass>}
+     * @memberof ListPoliciesBillingDatesResponseClass
+     */
+    'items': Array<PolicyBillingDateClass>;
+    /**
+     * Next page token.
+     * @type {string}
+     * @memberof ListPoliciesBillingDatesResponseClass
+     */
+    'nextPageToken': string;
+}
+

package/models/list-request-dto.ts

@@ -56,5 +56,11 @@ export interface ListRequestDto {
      * @memberof ListRequestDto
      */
     'expand'?: string;
+    /**
+     * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
+     * @type {string}
+     * @memberof ListRequestDto
+     */
+    'filters'?: string;
 }
 

package/models/omit-type-class.ts

@@ -0,0 +1,186 @@
+/* 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 { InvoiceItemClass } from './invoice-item-class';
+import { InvoicePaymentsClass } from './invoice-payments-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;
+    /**
+     * Policy number.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'policyNumber': 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;
+    /**
+     * Paid amount. This property is amount paid by this invoice. The amount corresponds to the sum (positives and negatives) of all payments relating to that invoice.
+     * @type {number}
+     * @memberof OmitTypeClass
+     */
+    'paidAmount': 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 {string}
+     * @memberof OmitTypeClass
+     */
+    'currency': string;
+    /**
+     * Invoice payments.
+     * @type {InvoicePaymentsClass}
+     * @memberof OmitTypeClass
+     */
+    'payments': InvoicePaymentsClass;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof OmitTypeClass
+     */
+    'updatedBy': string;
+}
+
+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',
+    PartiallyPaid: 'partially-paid',
+    Refunded: 'refunded'
+} as const;
+
+export type OmitTypeClassStatusEnum = typeof OmitTypeClassStatusEnum[keyof typeof OmitTypeClassStatusEnum];
+
+

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

@@ -0,0 +1,60 @@
+/* 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;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof PolicyBillingDateClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof PolicyBillingDateClass
+     */
+    'updatedBy': string;
+}
+