@apideck/node/dist/gen/models/Supplier.d.ts

Apideck Node.js SDK

/**
 * Apideck
 * The Apideck OpenAPI Spec: SDK Optimized
 *
 * The version of the OpenAPI document: 10.13.0
 * Contact: support@apideck.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { Address } from './Address';
import { BankAccount } from './BankAccount';
import { Currency } from './Currency';
import { CustomField } from './CustomField';
import { Email } from './Email';
import { LinkedLedgerAccount } from './LinkedLedgerAccount';
import { LinkedTaxRate } from './LinkedTaxRate';
import { PassThroughBody } from './PassThroughBody';
import { PhoneNumber } from './PhoneNumber';
import { Website } from './Website';
/**
 *
 * @export
 * @interface Supplier
 */
export interface Supplier {
    /**
     * A unique identifier for an object.
     * @type {string}
     * @memberof Supplier
     */
    readonly id: string;
    /**
     * The third-party API ID of original entity
     * @type {string}
     * @memberof Supplier
     */
    readonly downstream_id?: string | null;
    /**
     * Display ID
     * @type {string}
     * @memberof Supplier
     */
    display_id?: string | null;
    /**
     * Display name
     * @type {string}
     * @memberof Supplier
     */
    display_name?: string | null;
    /**
     * The name of the company.
     * @type {string}
     * @memberof Supplier
     */
    company_name?: string | null;
    /**
     * The company or subsidiary id the transaction belongs to
     * @type {string}
     * @memberof Supplier
     */
    company_id?: string | null;
    /**
     * The job title of the person.
     * @type {string}
     * @memberof Supplier
     */
    title?: string | null;
    /**
     * The first name of the person.
     * @type {string}
     * @memberof Supplier
     */
    first_name?: string | null;
    /**
     * Middle name of the person.
     * @type {string}
     * @memberof Supplier
     */
    middle_name?: string | null;
    /**
     * The last name of the person.
     * @type {string}
     * @memberof Supplier
     */
    last_name?: string | null;
    /**
     *
     * @type {string}
     * @memberof Supplier
     */
    suffix?: string | null;
    /**
     * Is this an individual or business supplier
     * @type {boolean}
     * @memberof Supplier
     */
    individual?: boolean | null;
    /**
     *
     * @type {Array<Address>}
     * @memberof Supplier
     */
    addresses?: Array<Address>;
    /**
     *
     * @type {Array<PhoneNumber>}
     * @memberof Supplier
     */
    phone_numbers?: Array<PhoneNumber>;
    /**
     *
     * @type {Array<Email>}
     * @memberof Supplier
     */
    emails?: Array<Email>;
    /**
     *
     * @type {Array<Website>}
     * @memberof Supplier
     */
    websites?: Array<Website>;
    /**
     *
     * @type {Array<BankAccount>}
     * @memberof Supplier
     */
    bank_accounts?: Array<BankAccount>;
    /**
     * Some notes about this supplier
     * @type {string}
     * @memberof Supplier
     */
    notes?: string | null;
    /**
     *
     * @type {LinkedTaxRate}
     * @memberof Supplier
     */
    tax_rate?: LinkedTaxRate;
    /**
     *
     * @type {string}
     * @memberof Supplier
     */
    tax_number?: string | null;
    /**
     *
     * @type {Currency}
     * @memberof Supplier
     */
    currency?: Currency | null;
    /**
     *
     * @type {LinkedLedgerAccount}
     * @memberof Supplier
     */
    account?: LinkedLedgerAccount | null;
    /**
     * Supplier status
     * @type {string}
     * @memberof Supplier
     */
    status?: SupplierStatus;
    /**
     * Payment method used for the transaction, such as cash, credit card, bank transfer, or check
     * @type {string}
     * @memberof Supplier
     */
    payment_method?: string | null;
    /**
     * The channel through which the transaction is processed.
     * @type {string}
     * @memberof Supplier
     */
    channel?: string | null;
    /**
     * When custom mappings are configured on the resource, the result is included here.
     * @type {object}
     * @memberof Supplier
     */
    readonly custom_mappings?: object | null;
    /**
     *
     * @type {Array<CustomField>}
     * @memberof Supplier
     */
    custom_fields?: Array<CustomField>;
    /**
     * The user who last updated the object.
     * @type {string}
     * @memberof Supplier
     */
    readonly updated_by?: string | null;
    /**
     * The user who created the object.
     * @type {string}
     * @memberof Supplier
     */
    readonly created_by?: string | null;
    /**
     * The date and time when the object was last updated.
     * @type {Date}
     * @memberof Supplier
     */
    readonly updated_at?: Date | null;
    /**
     * The date and time when the object was created.
     * @type {Date}
     * @memberof Supplier
     */
    readonly created_at?: Date | null;
    /**
     * A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
     * @type {string}
     * @memberof Supplier
     */
    row_version?: string | null;
    /**
     *
     * @type {PassThroughBody}
     * @memberof Supplier
     */
    pass_through?: PassThroughBody;
    /**
     * The subsidiary the supplier belongs to.
     * @type {string}
     * @memberof Supplier
     */
    subsidiary_id?: string;
}
/**
 * @export
 * @enum {string}
 */
export declare enum SupplierStatus {
    active = "active",
    inactive = "inactive",
    archived = "archived",
    gdpr_erasure_request = "gdpr-erasure-request",
    unknown = "unknown"
}
export declare function SupplierFromJSON(json: any): Supplier;
export declare function SupplierFromJSONTyped(json: any, ignoreDiscriminator: boolean): Supplier;
export declare function SupplierToJSON(value?: Supplier | null): any;