wallee/dist/models/DebtCollectionCase.d.ts

TypeScript/JavaScript client for wallee

import type { DebtCollectionCaseState } from './DebtCollectionCaseState';
import type { Address } from './Address';
import type { FailureReason } from './FailureReason';
import type { DebtCollectionCaseSource } from './DebtCollectionCaseSource';
import type { Label } from './Label';
import type { DebtCollectorConfiguration } from './DebtCollectorConfiguration';
import type { LineItem } from './LineItem';
import type { DebtCollectionEnvironment } from './DebtCollectionEnvironment';
/**
 * The debt collection case represents a try to collect the money from the debtor.
 * @export
 * @interface DebtCollectionCase
 */
export interface DebtCollectionCase {
    /**
     * The date and time when the contract with the debtor was signed.
     * @type {Date}
     * @memberof DebtCollectionCase
     */
    readonly contractDate?: Date;
    /**
     * The date and time when the claim was due.
     * @type {Date}
     * @memberof DebtCollectionCase
     */
    readonly dueDate?: Date;
    /**
     * The date and time when the case was closed.
     * @type {Date}
     * @memberof DebtCollectionCase
     */
    readonly closedOn?: Date;
    /**
     * The language that is linked to the object.
     * @type {string}
     * @memberof DebtCollectionCase
     */
    readonly language?: string;
    /**
     *
     * @type {DebtCollectionCaseSource}
     * @memberof DebtCollectionCase
     */
    source?: DebtCollectionCaseSource;
    /**
     * The date and time when the object was created.
     * @type {Date}
     * @memberof DebtCollectionCase
     */
    readonly createdOn?: Date;
    /**
     * The line items that are subject of this debt collection case.
     * @type {Array<LineItem>}
     * @memberof DebtCollectionCase
     */
    readonly lineItems?: Array<LineItem>;
    /**
     * A unique reference to identify the debt collection case in communication with the debtor.
     * @type {string}
     * @memberof DebtCollectionCase
     */
    readonly reference?: string;
    /**
     * The three-letter code (ISO 4217 format) of the case's currency.
     * @type {string}
     * @memberof DebtCollectionCase
     */
    readonly currency?: string;
    /**
     * A unique identifier for the object.
     * @type {number}
     * @memberof DebtCollectionCase
     */
    readonly id?: number;
    /**
     *
     * @type {DebtCollectionCaseState}
     * @memberof DebtCollectionCase
     */
    state?: DebtCollectionCaseState;
    /**
     * The date and time when the processing of the case times out.
     * @type {Date}
     * @memberof DebtCollectionCase
     */
    readonly processingTimeoutOn?: Date;
    /**
     * The sum of all unpaid item prices in the case's currency. The amount can no longer be changed once the case has been reviewed.
     * @type {number}
     * @memberof DebtCollectionCase
     */
    readonly amount?: number;
    /**
     * The ID of the user the case was created by.
     * @type {number}
     * @memberof DebtCollectionCase
     */
    readonly creator?: number;
    /**
     * The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.
     * @type {Date}
     * @memberof DebtCollectionCase
     */
    readonly plannedPurgeDate?: Date;
    /**
     * A client-generated nonce which uniquely identifies some action to be executed. Subsequent requests with the same external ID do not execute the action again, but return the original result.
     * @type {string}
     * @memberof DebtCollectionCase
     */
    readonly externalId?: string;
    /**
     *
     * @type {DebtCollectorConfiguration}
     * @memberof DebtCollectionCase
     */
    collectorConfiguration?: DebtCollectorConfiguration;
    /**
     * The ID of the user the case was reviewed by.
     * @type {number}
     * @memberof DebtCollectionCase
     */
    readonly reviewer?: number;
    /**
     * The ID of the space view this object is linked to.
     * @type {number}
     * @memberof DebtCollectionCase
     */
    readonly spaceViewId?: number;
    /**
     * The date and time when the review of the case was started.
     * @type {Date}
     * @memberof DebtCollectionCase
     */
    readonly reviewStartedOn?: Date;
    /**
     * The version is used for optimistic locking and incremented whenever the object is updated.
     * @type {number}
     * @memberof DebtCollectionCase
     */
    readonly version?: number;
    /**
     * The labels providing additional information about the object.
     * @type {Set<Label>}
     * @memberof DebtCollectionCase
     */
    readonly labels?: Set<Label>;
    /**
     * The date and time when the processing of the case was started.
     * @type {Date}
     * @memberof DebtCollectionCase
     */
    readonly processingStartedOn?: Date;
    /**
     * The ID of the space this object belongs to.
     * @type {number}
     * @memberof DebtCollectionCase
     */
    readonly linkedSpaceId?: number;
    /**
     *
     * @type {DebtCollectionEnvironment}
     * @memberof DebtCollectionCase
     */
    environment?: DebtCollectionEnvironment;
    /**
     * The date and time when the case was reviewed.
     * @type {Date}
     * @memberof DebtCollectionCase
     */
    readonly reviewedOn?: Date;
    /**
     * The ID of the object that is the source of the case. Only defined if the case was created by an internal process.
     * @type {number}
     * @memberof DebtCollectionCase
     */
    readonly sourceEntityId?: number;
    /**
     *
     * @type {FailureReason}
     * @memberof DebtCollectionCase
     */
    failureReason?: FailureReason;
    /**
     *
     * @type {Address}
     * @memberof DebtCollectionCase
     */
    billingAddress?: Address;
    /**
     * The date and time when the case failed.
     * @type {Date}
     * @memberof DebtCollectionCase
     */
    readonly failedOn?: Date;
    /**
     * The date and time when the next attempt at processing the case will be made.
     * @type {Date}
     * @memberof DebtCollectionCase
     */
    readonly nextAttemptOn?: Date;
}
/**
 * Check if a given object implements the DebtCollectionCase interface.
 */
export declare function instanceOfDebtCollectionCase(value: object): value is DebtCollectionCase;
export declare function DebtCollectionCaseFromJSON(json: any): DebtCollectionCase;
export declare function DebtCollectionCaseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DebtCollectionCase;
export declare function DebtCollectionCaseToJSON(json: any): DebtCollectionCase;
export declare function DebtCollectionCaseToJSONTyped(value?: Omit<DebtCollectionCase, 'contractDate' | 'dueDate' | 'closedOn' | 'language' | 'createdOn' | 'lineItems' | 'reference' | 'currency' | 'id' | 'processingTimeoutOn' | 'amount' | 'creator' | 'plannedPurgeDate' | 'externalId' | 'reviewer' | 'spaceViewId' | 'reviewStartedOn' | 'version' | 'labels' | 'processingStartedOn' | 'linkedSpaceId' | 'reviewedOn' | 'sourceEntityId' | 'failedOn' | 'nextAttemptOn'> | null, ignoreDiscriminator?: boolean): any;