Diamant3Opts

Diamant3Opts = object

Properties

apiUrl

apiUrl: string

---

username

username: string

---

password

password: string

---

bookingConfiguration

bookingConfiguration: object

bookAsIncomingInvoice?

optional bookAsIncomingInvoice: boolean

Description

If true, invoices will be created in the "Rechnungseingangsbuch" rather than booked directly.

useBookingPeriod

useBookingPeriod: boolean

bookingPeriodFieldName?

optional bookingPeriodFieldName: string

Description

The field name in ptpInvoice where the booking period is stored, required if useBookingPeriod is true.

getTransactionType()

getTransactionType: (docFile) => string

Parameters

docFile

ptpInvoice

Returns

string

the transaction type as string, which will be used for the invoice booking.

Description

Optional function to determine the transaction type based on the invoice data (docType).

Default

- will be "ER" for ROB and "EG" for GOB

getLocalCurrency()

getLocalCurrency: (docFile) => string

Function to determine the local currency based on the recipient for the current file.

Parameters

docFile

ptpInvoice

Returns

string

the local currency code (e.g. "EUR")

getErpInvoiceNumber()?

optional getErpInvoiceNumber: (docFile) => string

Optional function to generate the ERP invoice number that will be assigned to the invoice in the ERP system.

Parameters

docFile

ptpInvoice

Returns

string

the ERP invoice number as string.

---

masterDataConfiguration

masterDataConfiguration: object

useAllRecipients

useAllRecipients: boolean

recipients?

optional recipients: string[]

Description

Optional list of recipients, only used if "useAllRecipients" is false

taskType

taskType: "masterDataUpdateErpService"

tasks

tasks: Diamant3MasterDataTask[]

waitForRunningTasksInMinutes?

optional waitForRunningTasksInMinutes: number

skipPrintingReport?

optional skipPrintingReport: boolean

jiraReportConfig?

optional jiraReportConfig: JiraReportConfig

skipSendingJiraReport?

optional skipSendingJiraReport: boolean