Budget & Positionen

Die Budgetverwaltung in InLoox umfasst mehrere zusammenhängende Entitäten: Budget, LineItem (Positionen), BudgetGroup, BudgetState, BudgetPreset, FiscalPeriod und FiscalPeriodFunding. Über die OData-API können Sie die gesamte Finanzstruktur eines Projekts programmatisch verwalten.

Entitätsübersicht

Entität	Beschreibung
Budget	Das übergeordnete Budgetobjekt eines Projekts
LineItem	Einzelne Budgetpositionen (Einnahmen/Ausgaben)
BudgetGroup	Gruppierung von Positionen
BudgetState	Statusdefinitionen für Budgets
BudgetPreset	Budgetvorlagen
FiscalPeriod	Geschäftsperioden
FiscalPeriodFunding	Finanzierungsplanung pro Periode
LineItemTemplate	Vorlagen für Budgetpositionen

---

Budget

Datenmodell

Property	Type	Description
BudgetId	Guid (UUID)	Eindeutiger Bezeichner des Budgets (Primärschlüssel).
ProjectId	Guid	Zugehöriges Projekt.
BudgetType	int32	Budgettyp (z. B. Einnahmen, Ausgaben).
BudgetStateId	Guid	Aktueller Status des Budgets.
ConsecutiveNumber	int32	Fortlaufende Nummer.
Name	string?	Name des Budgets.
BudgetDate	DateTimeOffset	Datum des Budgets.
BudgetContactId	Guid?	Zuständiger Kontakt.
BudgetCreatedDate	DateTimeOffset	Erstellungsdatum.
BudgetChangedDate	DateTimeOffset?	Datum der letzten Änderung.
AmountAssets	double	Gesamtbetrag.

Endpunkte

GET/odata/Budget

Alle Budgets abrufen. Unterstützt OData-Abfrageparameter.

POST/odata/Budget

Neues Budget erstellen.

Parameter	Type	Required	Description
Body	Delta<ApiBudget>	✅	JSON-Objekt mit den Budgeteigenschaften.

GET/odata/Budget({key})

Ein einzelnes Budget abrufen.

Parameter	Type	Required	Description
key	Guid	✅	Die BudgetId.

PATCH/odata/Budget({key})

Budget teilweise aktualisieren.

Parameter	Type	Required	Description
key	Guid	✅	Die BudgetId.
Body	Delta<ApiBudget>	✅	JSON-Objekt mit den zu aktualisierenden Feldern.

DELETE/odata/Budget({key})

Budget löschen.

Parameter	Type	Required	Description
key	Guid	✅	Die BudgetId.

GET/odata/Budget/$count

Gesamtanzahl aller Budgets abrufen.

Rechnungserstellung

GET/odata/Budget({key})/GetUnbilledLineitemsCount()

Anzahl der noch nicht abgerechneten Positionen abrufen.

Parameter	Type	Required	Description
key	Guid	✅	Die BudgetId.

GET/odata/Budget({key})/CreateInvoiceForAllLineitems()

Eine Rechnung für alle Positionen des Budgets erstellen.

Parameter	Type	Required	Description
key	Guid	✅	Die BudgetId.

POST/odata/Budget({key})/CreateInvoiceForSelectedLineitems

Eine Rechnung für ausgewählte Positionen erstellen.

Parameter	Type	Required	Description
key	Guid	✅	Die BudgetId.
lineItemIds	Guid[]	✅	Array der LineItem-IDs (als Query-Parameter).
Body	object	✅	JSON-Objekt mit weiteren Rechnungsdetails.

Dokumente & Verknüpfungen

POST/odata/Budget({key})/AddDocumentToBudget

Ein Dokument mit dem Budget verknüpfen.

POST/odata/Budget({key})/RemoveDocumentFromBudget

Ein Dokument vom Budget entfernen.

POST/odata/Budget({key})/AddRelation

Eine Verknüpfung zum Budget hinzufügen.

POST/odata/Budget({key})/RemoveRelation

Eine Verknüpfung vom Budget entfernen.

Vorlagen

POST/odata/Budget({key})/AddLineItemFromTemplate

Eine Position aus einer Vorlage zum Budget hinzufügen.

Parameter	Type	Required	Description
key	Guid	✅	Die BudgetId.
Body	object	✅	JSON-Objekt mit der Vorlagen-ID.

---

LineItem (Positionen)

Datenmodell

Property	Type	Description
LineItemId	Guid (UUID)	Eindeutiger Bezeichner der Position (Primärschlüssel).
BudgetId	Guid	Zugehöriges Budget.
GroupId	Guid	Zugehörige Budgetgruppe.
PerformedByContactId	Guid?	Ausführender Kontakt.
OrdinalPosition	int32	Reihenfolgeposition.
ConsecutiveNumber	int32	Fortlaufende Nummer.
ShortDescription	string?	Kurzbeschreibung der Position.
Quantity	double	Menge.
Unit	string?	Einheit (z. B. "Stunden", "Stück").
PricePerUnit	double	Preis pro Einheit.
SecondaryPricePerUnit	double	Sekundärer Preis pro Einheit (Einkaufspreis).
IsCustomPricePerUnit	boolean	Benutzerdefinierter Preis aktiviert.
IsBilled	boolean	Position ist abgerechnet.
IsBillable	boolean	Position ist abrechenbar.
CreatedByContactId	Guid	Ersteller der Position.
CreatedDate	DateTimeOffset	Erstellungsdatum.
ChangedByContactId	Guid?	Letzter Bearbeiter.
ChangedDate	DateTimeOffset?	Datum der letzten Änderung.
ProvisionDate	DateTimeOffset?	Leistungsdatum.
DescriptionText	string?	Beschreibung als Klartext.
DescriptionHTML	string?	Beschreibung als HTML.
ProjectId	Guid	Zugehöriges Projekt.
LineItemType	LineItemType	Typ der Position (Enum: 0, 1, 2).

Endpunkte

GET/odata/LineItem

Alle Positionen abrufen.

POST/odata/LineItem

Neue Position erstellen.

Parameter	Type	Required	Description
Body	Delta<ApiLineItem>	✅	JSON-Objekt mit den Positionseigenschaften.

GET/odata/LineItem({key})

Eine einzelne Position abrufen.

PATCH/odata/LineItem({key})

Position teilweise aktualisieren.

DELETE/odata/LineItem({key})

Position löschen.

GET/odata/LineItem/$count

Gesamtanzahl aller Positionen abrufen.

POST/odata/LineItem({key})/Copy

Position kopieren.

POST/odata/LineItem({key})/AddDocumentToLineItem

Dokument mit der Position verknüpfen.

POST/odata/LineItem({key})/RemoveDocumentFromLineItem

Dokument von der Position entfernen.

POST/odata/LineItem({key})/AddRelation

Verknüpfung zur Position hinzufügen.

POST/odata/LineItem({key})/RemoveRelation

Verknüpfung von der Position entfernen.

---

BudgetGroup

Datenmodell

Property	Type	Description
BudgetGroupId	Guid (UUID)	Eindeutiger Bezeichner der Gruppe.
Name	string?	Name der Budgetgruppe.
OrdinalPosition	int32	Sortierposition.
PurchasePrice	double	Einkaufspreis.
DispositionPrice	double	Verkaufspreis.
Visible	boolean?	Sichtbarkeit der Gruppe.

Endpunkte

GET/odata/BudgetGroup

Alle Budgetgruppen abrufen.

POST/odata/BudgetGroup

Neue Budgetgruppe erstellen.

GET/odata/BudgetGroup({key})

Eine einzelne Budgetgruppe abrufen.

PATCH/odata/BudgetGroup({key})

Budgetgruppe aktualisieren.

DELETE/odata/BudgetGroup({key})

Budgetgruppe löschen.

GET/odata/BudgetGroup/$count

Gesamtanzahl der Budgetgruppen abrufen.

---

BudgetState

Datenmodell

Property	Type	Description
BudgetStateId	Guid (UUID)	Eindeutiger Bezeichner des Budgetstatus.
Name	string?	Name des Status.
IsHidden	boolean	Gibt an, ob der Status ausgeblendet ist.

Endpunkte

GET/odata/BudgetState

Alle Budgetstatus-Definitionen abrufen.

POST/odata/BudgetState

Neuen Budgetstatus erstellen.

GET/odata/BudgetState({key})

Einen einzelnen Budgetstatus abrufen.

PATCH/odata/BudgetState({key})

Budgetstatus aktualisieren.

DELETE/odata/BudgetState({key})

Budgetstatus löschen.

GET/odata/BudgetState/$count

Gesamtanzahl der Budgetstatus-Definitionen abrufen.

---

BudgetPreset (Budgetvorlagen)

Datenmodell

Property	Type	Description
PresetId	Guid (UUID)	Eindeutiger Bezeichner der Vorlage.
PresetType	int32	Typ der Vorlage.
Name	string?	Name der Vorlage.
PresetDate	DateTimeOffset	Datum der Vorlage.
AmountAssets	double	Gesamtbetrag.
IsGlobal	boolean	Gibt an, ob die Vorlage global verfügbar ist.

Endpunkte

GET/odata/BudgetPreset

Alle Budgetvorlagen abrufen.

POST/odata/BudgetPreset

Neue Budgetvorlage erstellen.

GET/odata/BudgetPreset({key})

Eine einzelne Vorlage abrufen.

PATCH/odata/BudgetPreset({key})

Vorlage aktualisieren.

DELETE/odata/BudgetPreset({key})

Vorlage löschen.

GET/odata/BudgetPreset/$count

Gesamtanzahl der Vorlagen abrufen.

POST/odata/BudgetPreset({key})/LoadTemplateForProject

Budgetvorlage in ein Projekt laden.

Parameter	Type	Required	Description
key	Guid	✅	Die PresetId.
Body	object	✅	JSON-Objekt mit der Projekt-ID.

POST/odata/BudgetPreset/SaveTemplateForBudget

Ein Budget als Vorlage speichern.

Parameter	Type	Required	Description
Body	object	✅	JSON-Objekt mit der Budget-ID und dem Vorlagennamen.

---

FiscalPeriod (Geschäftsperioden)

Datenmodell

Property	Type	Description
FiscalPeriodId	Guid (UUID)	Eindeutiger Bezeichner der Geschäftsperiode.
Name	string?	Name der Periode.
PeriodType	int32	Periodentyp (z. B. Monat, Quartal, Jahr).
PeriodStart	DateTimeOffset	Startdatum der Periode.
PeriodEnd	DateTimeOffset	Enddatum der Periode.

Endpunkte

Nur lesender Zugriff

Geschäftsperioden können nur gelesen, aber nicht über die API erstellt, geändert oder gelöscht werden. Die Verwaltung erfolgt über die InLoox-Administrationseinstellungen.

GET/odata/FiscalPeriod

Alle Geschäftsperioden abrufen.

GET/odata/FiscalPeriod({key})

Eine einzelne Geschäftsperiode abrufen.

GET/odata/FiscalPeriod/$count

Gesamtanzahl der Geschäftsperioden abrufen.

---

FiscalPeriodFunding (Periodenfinanzierung)

Datenmodell

Property	Type	Description
FiscalPeriodFundingId	Guid (UUID)	Eindeutiger Bezeichner.
FiscalPeriodId	Guid	Zugehörige Geschäftsperiode.
FiscalPeriodName	string?	Name der Geschäftsperiode (schreibgeschützt).
ProjectId	Guid	Zugehöriges Projekt.
Description	string?	Beschreibung.
BudgetOpex	double?	Budgetierter OPEX-Betrag.
BudgetCapex	double?	Budgetierter CAPEX-Betrag.
BudgetTotal	double?	Budgetierter Gesamtbetrag.
PlannedOpex	double	Geplanter OPEX-Betrag.
PlannedCapex	double	Geplanter CAPEX-Betrag.
PlannedTotal	double	Geplanter Gesamtbetrag.
ActualOpex	double	Tatsächlicher OPEX-Betrag.
ActualCapex	double	Tatsächlicher CAPEX-Betrag.
ActualTotal	double	Tatsächlicher Gesamtbetrag.
EstimatedOpex	double	Geschätzter OPEX-Betrag.
EstimatedCapex	double	Geschätzter CAPEX-Betrag.
EstimatedTotal	double	Geschätzter Gesamtbetrag.
ActualBenefit	double	Tatsächlicher Nutzen.
PlannedBenefit	double	Geplanter Nutzen.
PeriodType	int32	Periodentyp.
BudgetApprovalState	int32	Genehmigungsstatus des Budgets.

Endpunkte

GET/odata/FiscalPeriodFunding

Alle Periodenfinanzierungen abrufen.

POST/odata/FiscalPeriodFunding

Neue Periodenfinanzierung erstellen.

GET/odata/FiscalPeriodFunding({key})

Eine einzelne Periodenfinanzierung abrufen.

PATCH/odata/FiscalPeriodFunding({key})

Periodenfinanzierung aktualisieren.

DELETE/odata/FiscalPeriodFunding({key})

Periodenfinanzierung löschen.

GET/odata/FiscalPeriodFunding/$count

Gesamtanzahl der Periodenfinanzierungen abrufen.

POST/odata/FiscalPeriodFunding/CreateFundingPlanForProject

Finanzierungsplan für ein Projekt automatisch erstellen.

Parameter	Type	Required	Description
Body	object	✅	JSON-Objekt mit der Projekt-ID.

---

LineItemTemplate (Positionsvorlagen)

Datenmodell

Property	Type	Description
LineItemTemplateId	Guid (UUID)	Eindeutiger Bezeichner der Positionsvorlage.
Name	string?	Name der Vorlage.
ShortDescription	string?	Kurzbeschreibung.
LongDescription	string?	Ausführliche Beschreibung.
Quantity	double	Standardmenge.

Endpunkte

GET/odata/LineItemTemplate

Alle Positionsvorlagen abrufen.

POST/odata/LineItemTemplate

Neue Positionsvorlage erstellen.

GET/odata/LineItemTemplate({key})

Eine einzelne Positionsvorlage abrufen.

PATCH/odata/LineItemTemplate({key})

Positionsvorlage aktualisieren.

DELETE/odata/LineItemTemplate({key})

Positionsvorlage löschen.

GET/odata/LineItemTemplate/$count

Gesamtanzahl der Positionsvorlagen abrufen.

POST/odata/LineItemTemplate({key})/AddGroup

Eine Gruppe zur Positionsvorlage hinzufügen.

POST/odata/LineItemTemplate({key})/RemoveGroup

Eine Gruppe von der Positionsvorlage entfernen.

---

DynamicBudget & DynamicLineItem

Für Budgets und Positionen stehen jeweils abgeflachte, schreibgeschützte Ansichten zur Verfügung, die Daten aus mehreren Entitäten zusammenführen.

DynamicBudget

GET/odata/DynamicBudget

Abgeflachte Budgetliste mit Projekt-, Status- und Berechtigungsdaten.

GET/odata/DynamicBudget/$count

Gesamtanzahl der DynamicBudget-Einträge.

DynamicLineItem

GET/odata/DynamicLineItem

Abgeflachte Positionsliste mit Budget-, Projekt- und Gruppendaten.

GET/odata/DynamicLineItem/$count

Gesamtanzahl der DynamicLineItem-Einträge.

Nur lesender Zugriff

DynamicBudget und DynamicLineItem unterstützen ausschließlich GET-Anfragen. Zum Erstellen oder Bearbeiten verwenden Sie die regulären Endpunkte.

---

OData-Abfragebeispiele

Alle Budgets eines Projekts

GET /odata/Budget?$filter=ProjectId eq 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

Positionen eines Budgets abrufen

GET /odata/LineItem?$filter=BudgetId eq 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

Nur abrechenbare, nicht abgerechnete Positionen

GET /odata/LineItem?$filter=IsBillable eq true and IsBilled eq false

Position erstellen

POST /odata/LineItem
Content-Type: application/json

{
  "BudgetId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "GroupId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "ShortDescription": "Beratungsstunden",
  "Quantity": 8.0,
  "Unit": "Stunden",
  "PricePerUnit": 150.00,
  "IsBillable": true,
  "ProjectId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Finanzierungsplan für alle Perioden eines Projekts

GET /odata/FiscalPeriodFunding?$filter=ProjectId eq 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'&$orderby=FiscalPeriodName

Rechnungserstellung

Verwenden Sie CreateInvoiceForAllLineitems oder CreateInvoiceForSelectedLineitems, um aus Budgetpositionen direkt Rechnungen zu generieren. Prüfen Sie vorher mit GetUnbilledLineitemsCount, wie viele Positionen noch offen sind.