SAP Business ByDesign connection for LinkyFlow

LinkyFlow brings SAP Business ByDesign ecommerce data into Excel so teams can browse, edit, validate, and publish from the spreadsheet.

Resources

Read requests

Write actions

Documented fields

146

Workflows you can move into Excel

Each resource below maps to a practical spreadsheet workflow. Read actions bring useful columns into Excel; create and edit actions show what can be reviewed in rows before sending changes.

Analytics reports

Report Fields

The fields of one report: dimensions to group by, measures to total (exact decimals), their texts and currencies, and the parameters the report is run with — mandatory ones flagged, with how each takes values and its format.

Read

Report Fields

Route: GET /reportFields

Excel formula: =LF.sapbyd.reportFields("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`reportId`	string	Yes	The report id, as the reports read answers it — e.g. FINGLAU01_Q0001 (trial balance).

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`role` default	string	—	-
`filterable` default	boolean	—	-
`mandatory` default	boolean	—	-
`selection` default	string	—	-
`format` default	string	—	-

Report Rows

Runs one report, read-only: the columns in select, grouped by the dimensions among them, filtered — mandatory parameters included — by filters. Measures are exact decimal strings, each with its currency; a dimension comes with its text.

Read

Report Rows

Route: GET /reportRows

Excel formula: =LF.sapbyd.reportRows("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`reportId`	string	Yes	The report id, as the reports read answers it — e.g. FINGLAU01_Q0001 (trial balance).
`select`	string	Yes	Comma-separated field ids from reportFields: the dimensions to group by and the measures to total, e.g. CGLACCT,KCENDING_BALANCE_CURRCOMP.
`filters`	string	No	One line of FIELD=value clauses separated by ";" — FIELD=a\|b for several values, FIELD=from..to for a range — e.g. "PARA_COMPANY=1000; PARA_...
`per_page`	number	No	Rows per page (max 1000) Default: 100
`page`	number	No	Page number, starting at 1

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Reports

The analytics reports this connection’s user may run — SAP’s standard reports and the tenant’s own, from the work centres the user is assigned. Search them, read one report’s fields with reportFields, run it with reportRows.

Read

Reports

Route: GET /reports

Excel formula: =LF.sapbyd.reports("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`search`	string	No	Words of the report id or name, e.g. "trial balance", "VAT", FINGLAU01. Every word must match.
`per_page`	number	No	Reports per page (max 200) Default: 50
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`name` default	string	—	-
`service`	string	—	-

Finance

Cancel Journal Entry

Reverses a posted journal entry: SAP posts the reversal on the date given, or on its own default date.

Create

Cancel Journal Entry

Route: POST /mutation/journalEntryCancel

Inputs you can set

Name	Type	Required	Description
`AccountingClosingStepCode`	string	No	-
`id`	id	Yes	-
`Note`	string	No	-
`Note_languageCode`	string	No	-
`PostingDate`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Journal Entries

Journal entry vouchers of the general ledger, newest first: company, posting date, document type, external reference and status. Their lines are journalEntryLines.

Used as filter by

Journal Entry Lines · journalEntryId

Read

Journal Entries

Journal entry vouchers of the general ledger, newest first: company, posting date, document type, external reference and status. Their lines are journalEntryLines.

Route: GET /journalEntries

Excel formula: =LF.sapbyd.journalEntries("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record by its ObjectID. Answers one row, or none.
`ID`	string	No	Exactly this journal entry ID, e.g. 403.
`ID1`	string	No	The company, by its ID, e.g. 1000.
`PostingStatusCode`	string	No	1 Not Posted, 2 Voided, 3 Posted, 4 Canceled, 5 Not Relevant, 6 Posting not relevant
`AccountingDocumentTypeCode`	string	No	A code of the AccountingEntryAccountingDocumentTypeCode code list.
`BusinessTransactionTypeCode`	string	No	A code of the AccountingEntryBusinessTransactionTypeCode code list.
`AccountingClosingStepCode`	string	No	A code of the AccountingEntryAccountingClosingStepCode code list.
`ExternalID`	string	No	Text contained in the external reference (case-sensitive).
`CompanyUUID`	string	No	-
`per_page`	number	No	Rows per page (max 200) Default: 50
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`AccountingDocumentTypeCodeText` default	string	—	-
`BusinessTransactionTypeCodeText` default	string	—	-
`ExternalID` default	string	—	-
`ID` default	string	—	-
`PostingDate` default	date	—	-
`PostingStatusCode` default	string	—	-
`PostingStatusCodeText` default	string	—	-
`ID1` default	string	—	-

Create

Create Journal Entry

Route: POST /mutation/journalEntries

Inputs you can set

Name	Type	Required	Description
`AccountingClosingStepCode`	string	No	-
`AccountingDocumentTypeCode`	string	No	-
`BusinessTransactionTypeCode`	string	No	-
`companyId`	string	No	-
`CompanyUUID`	string	No	-
`CurrencyConversionDate`	string	No	-
`EntryDate`	string	No	-
`ExternalID`	string	No	-
`items`	string	Yes	-
`PostingDate`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Journal Entry Lines

The lines of the journal entries: G/L account, debit or credit, and the signed amounts in the transaction and the company currency.

Read

Journal Entry Lines

The lines of the journal entries: G/L account, debit or credit, and the signed amounts in the transaction and the company currency.

Route: GET /journalEntryLines

Excel formula: =LF.sapbyd.journalEntryLines("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record by its ObjectID. Answers one row, or none.
`ParentObjectID`	string	No	The lines of this journal entry, by its ObjectID.
`ChartOfAccountsItemCode`	string	No	e.g. 613200.
`ChartOfAccountsCode`	string	No	A code of the AccountingEntryItemChartOfAccountsCode code list.
`DebitCreditCode`	string	No	1 debit, 2 credit.
`currencyCode1`	string	No	A code of the AccountingEntryItemcurrencyCode1 code list.
`journalEntryId`	string	No	The lines of this journal entry, by its ID (403) or its ObjectID.
`per_page`	number	No	Rows per page (max 200) Default: 50
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`ParentObjectID` default	string	→ journalEntries	-
`ChartOfAccountsItemCode` default	string	—	-
`ChartOfAccountsItemCodeText` default	string	—	-
`DebitCreditCodeText` default	string	—	-
`ID` default	string	—	-
`LocalCurrencyAmount` default	number	—	-
`currencyCode` default	string	—	-
`TransactionCurrencyAmount` default	number	—	-
`currencyCode1` default	string	—	-

Post Journal Entry

Posts a Not Posted journal entry to the general ledger. A posted entry is corrected by Cancel Journal Entry, which posts its reversal. Answers the entry read back.

Create

Post Journal Entry

Route: POST /mutation/journalEntryPost

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Simulate Journal Entry

Checks a Not Posted journal entry the way posting would — balance, accounts, open period — without posting it. SAP refuses it with the reason when the entry would not post.

Create

Simulate Journal Entry

Route: POST /mutation/journalEntrySimulate

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Projects

Projects of the tenant, newest first, with their status, manager, priority and planned dates.

Used as filter by

Tasks · projectId

Read

Projects

Projects of the tenant, newest first, with their status, manager, priority and planned dates.

Route: GET /projects

Excel formula: =LF.sapbyd.projects("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record by its ObjectID. Answers one row, or none.
`ProjectID`	string	No	Exactly this business id, e.g. CPMI5.
`ProjectName`	string	No	Text contained in the project name (case-sensitive).
`ProjectLifeCycleStatusCode`	string	No	1 In Planning, 2 Released, 3 Stopped, 4 Closed, 5 Started, 6 Completed
`ResponsibleEmployeeID`	string	No	Employee ID of the project manager.
`ProjectTypeCode`	string	No	A code of the ProjectProjectTypeCode code list.
`ResponsibleCostCentreID`	string	No	-
`per_page`	number	No	Rows per page (max 200) Default: 50
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`ProjectID` default	string	—	-
`ResponsibleCostCentreID` default	string	—	-
`PlannedStartDateTime` default	date	—	-
`PlannedEndDateTime` default	date	—	-
`ProjectLifeCycleStatusCode` default	string	—	-
`ProjectLifeCycleStatusCodeText` default	string	—	-
`ProjectName` default	string	—	-
`ResponsibleEmployeeID` default	string	—	-
`ResponsibleEmployeeFormattedName` default	string	—	-
`PriorityCodeText` default	string	—	-

Create

Create Project

Route: POST /mutation/projects

Inputs you can set

Name	Type	Required	Description
`EstimatedCompletionPercent`	number	No	-
`PlannedEndDateTime`	string	No	-
`PlannedStartDateTime`	string	No	-
`PriorityCode`	string	No	-
`ProjectID`	string	No	-
`ProjectLanguageCode`	string	No	-
`ProjectName`	string	Yes	-
`ProjectTypeCode`	string	No	-
`RequestingCostCentreID`	string	No	-
`ResponsibleCostCentreID`	string	Yes	-
`ResponsibleEmployeeID`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Project

Route: PATCH /mutation/projects

Inputs you can set

Name	Type	Required	Description
`EstimatedCompletionPercent`	number	No	-
`PlannedEndDateTime`	string	No	-
`PlannedStartDateTime`	string	No	-
`PriorityCode`	string	No	-
`ProjectID`	string	No	-
`ProjectLanguageCode`	string	No	-
`ProjectName`	string	Yes	-
`ProjectTypeCode`	string	No	-
`RequestingCostCentreID`	string	No	-
`ResponsibleCostCentreID`	string	Yes	-
`ResponsibleEmployeeID`	string	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Release Task

Releases a task that is In Planning. The project must be Started or Released; SAP refuses otherwise.

Create

Release Task

Route: POST /mutation/taskRelease

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Revoke Task Start

Revokes the start of a started task (TaskRevokeStartProcessing). Offered on every Released task, because the service does not show which are started; SAP refuses it on a task that is not. Answers the task read back.

Create

Revoke Task Start

Route: POST /mutation/taskRevokeStart

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Start Task

Starts a Released task (TaskStartProcessing). The service keeps the status at Released afterwards — it does not show whether a task is started — so SAP refuses a second start with "action is disabled". Answers the task read back.

Create

Start Task

Route: POST /mutation/taskStart

Inputs you can set

Name	Type	Required	Description
`id`	id	Yes	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Tasks

Tasks of the projects — a project’s root task included — with their status and the lifecycle actions each one allows.

Read

Tasks

Tasks of the projects — a project’s root task included — with their status and the lifecycle actions each one allows.

Route: GET /tasks

Excel formula: =LF.sapbyd.tasks("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`id`	id	No	Read exactly this record by its ObjectID. Answers one row, or none.
`TaskID`	string	No	Exactly this business id, e.g. CPMI5-1.
`LifeCycleStatusCode`	string	No	1 In Planning, 2 Released, 3 Stopped, 4 Closed, 5 Started, 6 Completed
`ResponsibleEmployeeID`	string	No	-
`ParentTaskID`	string	No	-
`MilestoneIndicator`	boolean	No	-
`projectId`	string	No	The project’s business id (CPMI5) or ObjectID: only its tasks.
`per_page`	number	No	Rows per page (max 200) Default: 50
`page`	number	No	Page number, starting at 1

Data returned in Excel

Field	Type	Relations	Description
`id` default	id	—	-
`TaskID` default	string	—	-
`TaskName` default	string	—	-
`ResponsibleEmployeeID` default	string	—	-
`LifeCycleStatusCode` default	string	—	-
`LifeCycleStatusCodeText` default	string	—	-
`ParentTaskID` default	string	—	-
`PlannedDuration` default	string	—	-

Create

Create Task

Route: POST /mutation/tasks

Inputs you can set

Name	Type	Required	Description
`ConstraintEndDateTime`	string	No	-
`ConstraintStartDateTime`	string	No	-
`MilestoneIndicator`	boolean	No	-
`ParentTaskID`	string	No	-
`PhaseIndicator`	boolean	No	-
`PlannedDuration`	string	No	-
`projectId`	string	Yes	-
`ResponsibleEmployeeID`	string	No	-
`ScheduleActivityEndDateTimeConstraintTypeCode`	string	No	-
`ScheduleActivityStartDateTimeConstraintTypeCode`	string	No	-
`TaskID`	string	No	-
`TaskName`	string	Yes	-
`WorkingDayCalendarCode`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Edit

Update Task

Route: PATCH /mutation/tasks

Inputs you can set

Name	Type	Required	Description
`ConstraintEndDateTime`	string	No	-
`ConstraintStartDateTime`	string	No	-
`MilestoneIndicator`	boolean	No	-
`ParentTaskID`	string	No	-
`PhaseIndicator`	boolean	No	-
`PlannedDuration`	string	No	-
`projectId`	string	Yes	-
`ResponsibleEmployeeID`	string	No	-
`ScheduleActivityEndDateTimeConstraintTypeCode`	string	No	-
`ScheduleActivityStartDateTimeConstraintTypeCode`	string	No	-
`TaskID`	string	No	-
`TaskName`	string	Yes	-
`WorkingDayCalendarCode`	string	No	-

Data returned in Excel

This action returns a confirmation rather than a selectable table.

Reference data

Code lists

The valid values of a code list — types, statuses, priorities, calendars, constraint types — so a code is never guessed.

Read

Code lists

The valid values of a code list — types, statuses, priorities, calendars, constraint types — so a code is never guessed.

Route: GET /accountingCodeLists

Excel formula: =LF.sapbyd.accountingCodeLists("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`codeList`	enum	Yes	Which list to read. Values: AccountingEntryAccountingClosingStepCode, AccountingEntryAccountingDocumentTypeCode, AccountingEntryBusinessTransactionTypeCode, AccountingEntryItemAccountingCodingBlockTypeCode, AccountingEntryItemChartOfAccountsCode

Data returned in Excel

Field	Type	Relations	Description
`Code` default	string	—	-
`Description` default	string	—	-

Code lists

The valid values of a code list — types, statuses, priorities, calendars, constraint types — so a code is never guessed.

Read

Code lists

The valid values of a code list — types, statuses, priorities, calendars, constraint types — so a code is never guessed.

Route: GET /codeLists

Excel formula: =LF.sapbyd.codeLists("selection", "fields")

Inputs you can set

Name	Type	Required	Description
`link`	string	Yes	-
`codeList`	enum	Yes	Which list to read. Values: ProjectBlockingStatusCode, ProjectClosureStatusCode, ProjectFulfilmentProcessingStatusCode, ProjectLifeCycleStatusCode, ProjectPlannedEndDateTimeTimeZoneCode

Data returned in Excel

Field	Type	Relations	Description
`Code` default	string	—	-
`Description` default	string	—	-