Zum Hauptinhalt springen

SpccOpts

SpccOpts = object

Properties​

connectorTaskEndpoint?​

optional connectorTaskEndpoint: string

Alternative endpoint of the SAP Public Cloud Connector task API.

Default​

"http://localhost:3000/task"

masterDataConfiguration​

masterDataConfiguration: object

tasks​

tasks: object[]

jiraReportConfig?​

optional jiraReportConfig: JiraReportConfig

skipPrintingReport?​

optional skipPrintingReport: boolean

skipSendingJiraReport?​

optional skipSendingJiraReport: boolean


masterDataByIdConfiguration​

masterDataByIdConfiguration: object

tasks​

tasks: object[]


getErpStateConfiguration​

getErpStateConfiguration: object

byId?​

optional byId: object

Optional. Looks up whether an invoice with a known erpInvoiceNumber already exists in SAP. If omitted, bookInvoice skips this check and proceeds without double-booking protection.

byId.configId​

configId: string

byId.buildConfigOverride()​

buildConfigOverride: (docFile) => DeepPartial<Config>

Parameters​
docFile​

ptpInvoice

Returns​

DeepPartial<Config>

byId.timeoutInSeconds?​

optional timeoutInSeconds: number

byId.getErpInvoiceNumber()​

getErpInvoiceNumber: (docFile, result?) => string | null

Parameters​
docFile​

ptpInvoice

result?​

string | null

Returns​

string | null

byFilter?​

optional byFilter: object

Optional. Looks up whether an invoice already exists in SAP by filtering on vendorId/invoiceNumber instead of a known erpInvoiceNumber. If omitted, bookInvoice skips this check and proceeds without double-booking protection.

byFilter.configId​

configId: string

byFilter.buildConfigOverride()​

buildConfigOverride: (docFile) => DeepPartial<Config>

Parameters​
docFile​

ptpInvoice

Returns​

DeepPartial<Config>

byFilter.timeoutInSeconds?​

optional timeoutInSeconds: number

byFilter.getErpInvoiceNumber()​

getErpInvoiceNumber: (docFile, result?) => string | null

Parameters​
docFile​

ptpInvoice

result?​

string | null

Returns​

string | null


bookInvoiceConfiguration​

bookInvoiceConfiguration: object

configId​

configId: string

timeoutInSeconds?​

optional timeoutInSeconds: number

buildConfigOverride()?​

optional buildConfigOverride: (docFile) => DeepPartial<Config>

Optional function to build a configOverride (e.g. request body/query params) from the docFile being booked.

Parameters​
docFile​

ptpInvoice

Returns​

DeepPartial<Config>

getErpInvoiceNumber()​

getErpInvoiceNumber: (docFile, result?) => string

Parameters​
docFile​

ptpInvoice

result?​

string | null

Returns​

string


paymentRunListConfiguration​

paymentRunListConfiguration: object

configId​

configId: string

timeoutInSeconds?​

optional timeoutInSeconds: number

buildConfigOverride()?​

optional buildConfigOverride: (recipient) => DeepPartial<Config>

Optional function to build a configOverride for the SPCC task that syncs payment/vendor-ledger data into the paymentProposal table.

Parameters​
recipient​

string

Returns​

DeepPartial<Config>