Skip to content

Class.Document

github-actions[bot] edited this page Dec 9, 2024 · 6 revisions

einvoicing / Document

Class: Document

Extends

Constructors

new Document()

protected new Document(props, id?): Document

Parameters

props

IDocument

id?

string | DocumentId

Returns

Document

Inherited from

Entity.constructor

Defined in

base/Entity.ts:18

Properties

_documentType

protected _documentType: DocumentTypes

Defined in

entity/Document.ts:27


_id

protected readonly _id: DocumentId

Inherited from

Entity._id

Defined in

base/Entity.ts:15


_ruleset

protected _ruleset: AbstractRuleset

Defined in

entity/Document.ts:26


props

protected props: IDocument

Inherited from

Entity.props

Defined in

base/Entity.ts:16

Accessors

attachments

Get Signature

get attachments(): Attachment[]

Get the attachments.

Returns

Attachment[]

Set Signature

set attachments(value): void

Set the attachments.

Parameters
value

Attachment[]

Returns

void

Defined in

entity/Document.ts:239


buyer

Get Signature

get buyer(): Party

Get the buyer.

Returns

Party

Set Signature

set buyer(value): void

Set the buyer.

Parameters
value

Party

Returns

void

Defined in

entity/Document.ts:267


buyerAccountingReference

Get Signature

get buyerAccountingReference(): string

Get the buyer accounting reference.

Returns

string

Set Signature

set buyerAccountingReference(value): void

Set the buyer accounting reference.

Parameters
value

string

Returns

void

Defined in

entity/Document.ts:155


buyerReference

Get Signature

get buyerReference(): string

Get the buyer reference.

Returns

string

Set Signature

set buyerReference(value): void

Set the buyer reference.

Parameters
value

string

Returns

void

Defined in

entity/Document.ts:141


charges

Get Signature

get charges(): AllowanceCharge[]

Get the charges.

Returns

AllowanceCharge[]

Set Signature

set charges(value): void

Set the charges.

Parameters
value

AllowanceCharge[]

Returns

void

Defined in

entity/Document.ts:393


contractReference

Get Signature

get contractReference(): string

Get the contract reference.

Returns

string

Set Signature

set contractReference(value): void

Set the contract reference.

Parameters
value

string

Returns

void

Defined in

entity/Document.ts:211


currency

Get Signature

get currency(): CurrencyCode

Get the currency.

Returns

CurrencyCode

Set Signature

set currency(value): void

Set the currency.

Parameters
value

CurrencyCode

Returns

void

Defined in

entity/Document.ts:127


delivery

Get Signature

get delivery(): Delivery

Get the delivery.

Returns

Delivery

Set Signature

set delivery(value): void

Set the delivery.

Parameters
value

Delivery

Returns

void

Defined in

entity/Document.ts:295


documentType

Get Signature

get documentType(): DocumentTypes

Get the document type.

Returns

DocumentTypes

Defined in

entity/Document.ts:43


dueDate

Get Signature

get dueDate(): DateOnly

Get the due date.

Returns

DateOnly

Set Signature

set dueDate(value): void

Set the due date.

Parameters
value

DateOnly

Returns

void

Defined in

entity/Document.ts:85


id

Get Signature

get id(): DocumentId

Get the document ID.

Returns

DocumentId

Set Signature

set id(value): void

Set the document ID.

Parameters
value

DocumentId

Returns

void

Overrides

Entity.id

Defined in

entity/Document.ts:57


issueDate

Get Signature

get issueDate(): DateOnly

Get the issue date.

Returns

DateOnly

Set Signature

set issueDate(value): void

Set the issue date.

Parameters
value

DateOnly

Returns

void

Defined in

entity/Document.ts:71


lines

Get Signature

get lines(): DocumentLine[]

Get the document lines.

Returns

DocumentLine[]

Set Signature

set lines(value): void

Set the document lines.

Parameters
value

DocumentLine[]

Returns

void

Defined in

entity/Document.ts:365


notes

Get Signature

get notes(): string

Get the notes.

Returns

string

Set Signature

set notes(value): void

Set the notes.

Parameters
value

string

Returns

void

Defined in

entity/Document.ts:113


paidAmount

Get Signature

get paidAmount(): number

Get the paid amount.

Returns

number

Set Signature

set paidAmount(value): void

Set the paid amount.

Parameters
value

number

Returns

void

Defined in

entity/Document.ts:337


payee

Get Signature

get payee(): Payee

Get the payee.

Returns

Payee

Set Signature

set payee(value): void

Set the payee.

Parameters
value

Payee

Returns

void

Defined in

entity/Document.ts:281


payment

Get Signature

get payment(): Payment

Get the payment.

Returns

Payment

Set Signature

set payment(value): void

Set the payment.

Parameters
value

Payment

Returns

void

Defined in

entity/Document.ts:379


periodEnd

Get Signature

get periodEnd(): DateOnly

Get the period end date.

Returns

DateOnly

Set Signature

set periodEnd(value): void

Set the period end date.

Parameters
value

DateOnly

Returns

void

Defined in

entity/Document.ts:323


periodStart

Get Signature

get periodStart(): DateOnly

Get the period start date.

Returns

DateOnly

Set Signature

set periodStart(value): void

Set the period start date.

Parameters
value

DateOnly

Returns

void

Defined in

entity/Document.ts:309


precedingInvoiceReference

Get Signature

get precedingInvoiceReference(): InvoiceReference[]

Get the preceding invoice reference.

Returns

InvoiceReference[]

Set Signature

set precedingInvoiceReference(value): void

Set the preceding invoice reference.

Parameters
value

InvoiceReference[]

Returns

void

Defined in

entity/Document.ts:225


purchaseOrderReference

Get Signature

get purchaseOrderReference(): string

Get the purchase order reference.

Returns

string

Set Signature

set purchaseOrderReference(value): void

Set the purchase order reference.

Parameters
value

string

Returns

void

Defined in

entity/Document.ts:169


roundingAmount

Get Signature

get roundingAmount(): number

Get the rounding amount.

Returns

number

Set Signature

set roundingAmount(value): void

Set the rounding amount.

Parameters
value

number

Returns

void

Defined in

entity/Document.ts:351


ruleset

Get Signature

get ruleset(): AbstractRuleset

Get the ruleset.

Returns

AbstractRuleset

Defined in

entity/Document.ts:50


salesOrderReference

Get Signature

get salesOrderReference(): string

Get the sales order reference.

Returns

string

Set Signature

set salesOrderReference(value): void

Set the sales order reference.

Parameters
value

string

Returns

void

Defined in

entity/Document.ts:183


seller

Get Signature

get seller(): Party

Get the seller.

Returns

Party

Set Signature

set seller(value): void

Set the seller.

Parameters
value

Party

Returns

void

Defined in

entity/Document.ts:253


taxAmount

Get Signature

get taxAmount(): number

Get the tax amount.

Returns

number

Set Signature

set taxAmount(value): void

Set the tax amount.

Parameters
value

number

Returns

void

Defined in

entity/Document.ts:435


taxCurrency

Get Signature

get taxCurrency(): CurrencyCode

Get the tax currency.

Returns

CurrencyCode

Set Signature

set taxCurrency(value): void

Set the tax currency.

Parameters
value

CurrencyCode

Returns

void

Defined in

entity/Document.ts:449


taxes

Get Signature

get taxes(): Tax[]

Get the taxes.

Returns

Tax[]

Set Signature

set taxes(value): void

Set the taxes.

Parameters
value

Tax[]

Returns

void

Defined in

entity/Document.ts:421


taxPointDate

Get Signature

get taxPointDate(): DateOnly

Get the tax point date.

Returns

DateOnly

Set Signature

set taxPointDate(value): void

Set the tax point date.

Parameters
value

DateOnly

Returns

void

Defined in

entity/Document.ts:407


tenderOrLotReference

Get Signature

get tenderOrLotReference(): string

Get the tender or lot reference.

Returns

string

Set Signature

set tenderOrLotReference(value): void

Set the tender or lot reference.

Parameters
value

string

Returns

void

Defined in

entity/Document.ts:197


type

Get Signature

get type(): DocumentType

Get the document type.

Returns

DocumentType

Set Signature

set type(value): void

Set the document type.

Parameters
value

DocumentType

Returns

void

Defined in

entity/Document.ts:99

Methods

equals()

equals(object?): boolean

Parameters

object?

Entity<IDocument, string, DocumentId>

Returns

boolean

Inherited from

Entity.equals

Defined in

base/Entity.ts:27


toJSON()

toJSON(): IDocument

Returns

IDocument

Inherited from

Entity.toJSON

Defined in

base/Entity.ts:51


toPrimitive()

toPrimitive(): IDocument

Returns

IDocument

Overrides

Entity.toPrimitive

Defined in

entity/Document.ts:460


validate()

validate(): IValidationResult

Returns

IValidationResult

Defined in

entity/Document.ts:36


create()

static create(type, ruleset, props): Document

Parameters

type

DocumentTypes

ruleset

AbstractRuleset

props

IDocument

Returns

Document

Defined in

entity/Document.ts:29

Clone this wiki locally