SudoSOS Back-end API / invoicing / InvoiceService

Class: InvoiceService

Extends

• WithManager

Constructors

Constructor

new InvoiceService(manager?): InvoiceService;

Parameters

Parameter	Type
manager?	EntityManager

Returns

InvoiceService

Inherited from

WithManager.constructor

Properties

Property	Modifier	Type	Inherited from
manager	protected	EntityManager	WithManager.manager

Methods

checkIfInvoiced()

checkIfInvoiced(transactions): Promise<void>;

Checks if any of the transactions are already invoiced

Parameters

Parameter	Type	Description
transactions	Transaction[]	The transactions to check

Returns

Promise<void>

---

createInvoice()

createInvoice(invoiceRequest): Promise<Invoice>;

Creates an Invoice from an CreateInvoiceRequest

Parameters

Parameter	Type	Description
invoiceRequest	CreateInvoiceParams	The Invoice request to create

Returns

Promise<Invoice>

---

createTransfer()

createTransfer(
   forId, 
   transactions, 
amount): Promise<Transfer>;

Creates a Transfer for an Invoice from TransactionResponses

Parameters

Parameter	Type	Description
forId	number	The user which receives the Invoice/Transfer
transactions	Transaction[]	The array of transactions which to create the Transfer for
amount	DineroObjectRequest	The amount to transfer

Returns

Promise<Transfer>

---

deleteInvoice()

deleteInvoice(invoiceId, byId): Promise<Invoice>;

Deletes the given invoice and makes an undo transfer

Parameters

Parameter	Type	Description
invoiceId	number	-
byId	number	-

Returns

Promise<Invoice>

---

getDefaultInvoiceParams()

getDefaultInvoiceParams(userId): Promise<InvoiceUserDefaults>;

Returns the default Invoice Params for an invoice user.

Parameters

Parameter	Type	Description
userId	number	-

Returns

Promise<InvoiceUserDefaults>

---

getEligibleTransactions()

getEligibleTransactions(params): Promise<
  | false
| TransactionResponse[]>;

Gets all uninvoiced transactions for a given user

Parameters

Parameter	Type	Description
params	InvoiceTransactionsRequest	-

Returns

Promise< | false | TransactionResponse[]>

---

getInvoices()

getInvoices(params?): Promise<Invoice[]>;

Returns database entities based on the given filter params.

Parameters

Parameter	Type	Description
params	InvoiceFilterParameters	The filter params to apply

Returns

Promise<Invoice[]>

---

getPaginatedInvoices()

getPaginatedInvoices(params?, pagination?): Promise<[Invoice[], number]>;

Function that returns all the invoices based on the given params.

Parameters

Parameter	Type	Description
params	InvoiceFilterParameters	The filter params to apply
pagination	PaginationParameters	The pagination params to apply

Returns

Promise<[Invoice[], number]>

---

getTransactionInvoices()

getTransactionInvoices(transactionId): Promise<Invoice[]>;

Get all invoices that contain any subtransaction rows from the given transaction

Parameters

Parameter	Type	Description
transactionId	number	The transaction ID

Returns

Promise<Invoice[]>

Array of invoices

---

removeSubTransactionInvoice()

removeSubTransactionInvoice(invoice): Promise<any[]>;

Removes the invoice reference from all sub transaction rows

Parameters

Parameter	Type	Description
invoice	Invoice	-

Returns

Promise<any[]>

---

setSubTransactionInvoice()

setSubTransactionInvoice(invoice, subTransactions): Promise<void>;

Set a reference to an Invoice for all given sub Transactions.

Parameters

Parameter	Type	Description
invoice	Invoice	-
subTransactions	SubTransaction[]	-

Returns

Promise<void>

---

updateInvoice()

updateInvoice(update): Promise<Invoice>;

Updates the Invoice

It is not possible to change the amount or details of the transfer itself.

Parameters

Parameter	Type	Description
update	UpdateInvoiceParams	-

Returns

Promise<Invoice>

---

asBaseInvoiceResponse()

static asBaseInvoiceResponse(invoice): BaseInvoiceResponse;

Parses an Invoice Object to a BaseInvoiceResponse

Parameters

Parameter	Type	Description
invoice	Invoice	The Invoice to parse

Returns

BaseInvoiceResponse

---

asInvoiceResponse()

static asInvoiceResponse(invoice): InvoiceResponse;

Parses an Invoice Object to a InvoiceResponse

Parameters

Parameter	Type	Description
invoice	Invoice	The Invoice to parse

Returns

InvoiceResponse

---

getLatestInvoiceStatus()

static getLatestInvoiceStatus(invoiceStatus): InvoiceStatus;

Parameters

Parameter	Type
invoiceStatus	InvoiceStatus[]

Returns

InvoiceStatus

---

getOptions()

static getOptions(params): FindManyOptions<Invoice>;

Parameters

Parameter	Type
params	InvoiceFilterParameters

Returns

FindManyOptions<Invoice>

---

isState()

static isState(invoice, state): boolean;

Parameters

Parameter	Type
invoice	Invoice
state	InvoiceState

Returns

boolean

---

stateSubQuery()

static stateSubQuery(): string;

Returns

string

---

toArrayResponse()

static toArrayResponse(invoices): InvoiceResponse[];

Parameters

Parameter	Type
invoices	Invoice[]

Returns

InvoiceResponse[]

---

toArrayWithoutEntriesResponse()

static toArrayWithoutEntriesResponse(invoices): BaseInvoiceResponse[];

Parameters

Parameter	Type
invoices	Invoice[]

Returns

BaseInvoiceResponse[]