import MDocument from 'spaceinvoices-js-sdk/src/models/document.js'

public class | source

MDocument

Extends:

BaseModel → MDocument

Constructor Summary

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

Member Summary

Public Members
public	clientId: string ID reference to Organization's Client. If provided _documentClient object gets populated using referenced Client.
public	currencyId: string ISO 4217 currency code.
public	date: string Javascript date, date of Document.
public	dateDue: string Javascript date, date invoice is due.
public	dateService: string Javascript date, date service was started or conducted.
public	dateServiceTo: string Javascript date, date service period ends.
public	decimalPlaces: string Number of decimal places the Document items are trimmed and rounded to in calculations.
public	draft: string Boolean, if invoice a draft.
public	footer: string Text footer for Document.
public	module: *
public	note: string Text note for Document.
public	number: string String, unique (to Document type and Organization) Document number.
public	signature: string Text signature for Document.
public	type: string Type of document (invoice, estimate or advance).

Private Members
private	_documentClient: string Object containting client data.
private	_documentIssuer: string Object containting issuer data.
private	_documentItems: string Collection of objects containing document line items.

Method Summary

Public Methods
public	createPayment(data: *): Promise<MPayment>
public	createReccurence(data: *): Promise<MRecurrence>
public	listPayments(): Promise<MPayment[]>
public	listReccurences(): Promise<MRecurrence[]>

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 clientId: string source

ID reference to Organization's Client. If provided _documentClient object gets populated using referenced Client.

public currencyId: string source

ISO 4217 currency code. Wikipedia If not provided the Organization's default currency is used.

public date: string source

Javascript date, date of Document. Represents date the Document was issued. Time is trimmed.

public dateDue: string source

Javascript date, date invoice is due. Auto populated using Organization's default due days from today. Only present on type invoice. Time is trimmed.

public dateService: string source

Javascript date, date service was started or conducted. Only present on type invoice. Time is trimmed.

public dateServiceTo: string source

Javascript date, date service period ends. Only present on type invoice. Time is trimmed.

public decimalPlaces: string source

Number of decimal places the Document items are trimmed and rounded to in calculations. Should be 4 in most cases.

public draft: string source

Boolean, if invoice a draft. If set to true the property cannot go back to false. Only present if type is invoice.

public footer: string source

Text footer for Document. Populated with Organizaion default if not provided. May contain shortcode notations which get parsed to data on PDF or when parseForDisplay flag is provided.

public module: * source

Override:

BaseModel#module

public note: string source

Text note for Document. Populated with Organizaion default if not provided. May contain shortcode notations which get parsed to data on PDF or when parseForDisplay flag is provided.

public number: string source

String, unique (to Document type and Organization) Document number. Auto populated with next number based on document type.

public signature: string source

Text signature for Document. Populated with Organizaion default if not provided. May contain shortcode notations which get parsed to data on PDF or when parseForDisplay flag is provided.

public type: string source

Type of document (invoice, estimate or advance). Determines type of document, note that different document types contain different properties, rules and funcionalities. For example invoice can have Payments logged and contains dateService property. Document type cannot be switched once set to instance.

Private Members

private _documentClient: string source

Object containting client data. Property is optional if clientId is provided. Any key defined in object will be used instead of loaded client data. If clientId is not provided the data in object is saved to Organization's Clients and referenced in document ie. the clientId is auto populated. toggle definition

private _documentIssuer: string source

Object containting issuer data. Property is automatically populated with Organization data. Any key that is provided in object is used instead. toggle definition

private _documentItems: string source

Collection of objects containing document line items. toggle definition

Public Methods

public createPayment(data: *): Promise<MPayment> source

Params:

Name	Type	Attribute	Description
data	*

Return:

Promise<MPayment>

public createReccurence(data: *): Promise<MRecurrence> source

Params:

Name	Type	Attribute	Description
data	*

MDocument

Extends:

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(data: null | object) source

Override:

Params:

Public Members

public clientId: string source

public currencyId: string source

public date: string source

public dateDue: string source

public dateService: string source

public dateServiceTo: string source

public decimalPlaces: string source

public draft: string source

public footer: string source

public module: * source

Override:

public note: string source

public number: string source

public signature: string source

public type: string source

Private Members

private _documentClient: string source

private _documentIssuer: string source

private _documentItems: string source

Public Methods

public createPayment(data: *): Promise<MPayment> source

Params:

Return:

public createReccurence(data: *): Promise<MRecurrence> source

Params:

Return:

public listPayments(): Promise<MPayment[]> source

Return:

public listReccurences(): Promise<MRecurrence[]> source

Return: