import MOrganization from 'spaceinvoices-js-sdk/src/models/organization.js'

public class | source

MOrganization

Extends:

BaseModel → MOrganization

Constructor Summary

Public Constructor
public	constructor(data: null \| object)

Member Summary

Public Members
public	IBAN: string Bank account number
public	address: string Street or similar address
public	address2: string Address line 2
public	brand: string Brand source identification for internal use
public	city: string City name
public	companyNumber: string registration or similar identification number
public	country: string ISO 3166 county.
public	locale: String=en ISO 639-1 locale code.
public	module: *
public	name: string Name of company or other type of organization
public	taxNumber: string VAT / GST / etc.
public	taxSubject: boolean=false Specify if the organization is subject to tax.
public	website: string Website address
public	zip: string Zip / post code

Method Summary

Public Methods
public	createClient(data: *): Promise<MClient>
public	createDocument(data: *): Promise<MDocument>
public	createItem(data: *): Promise<MItem>
public	createTax(data: *): Promise<MTax>
public	listClients(): Promise<MClient[]>
public	listDocuments(): Promise<MDocument[]>
public	listItems(): Promise<MItem[]>
public	listPayments(): Promise<MPayment[]>
public	listRecurrences(): Promise<MRecurrence[]>
public	listTaxes(): Promise<MTax[]>
public	searchClient(term: *): Promise<MClient>
public	searchItem(term: *): Promise<MItem>

Inherited Summary

From class BaseModel
public	data: *
public	id: *
public	module: *
public	delete(): Promise<object>
public	parseData()
public	setId()
public	update(): Promise<object>

Public Constructors

public constructor(data: null | object) source

Override:

BaseModel#constructor

Params:

Name	Type	Attribute	Description
data	null \| object

Public Members

public IBAN: string source

Bank account number

public address: string source

Street or similar address

public address2: string source

Address line 2

public brand: string source

Brand source identification for internal use

public city: string source

City name

public companyNumber: string source

registration or similar identification number

public country: string source

ISO 3166 county. Wikipedia The country parameter is used to apply some smart defaults to the organization being created including default tax rates and texts (both may be effected by taxSubject property in some cases)