Download the PHP package innobrain/onoffice-cli without Composer
On this page you can find all versions of the php package innobrain/onoffice-cli. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download innobrain/onoffice-cli
More information about innobrain/onoffice-cli
Files in innobrain/onoffice-cli
Package onoffice-cli
Short Description Use onOffice from your CLI
License MIT
Homepage https://github.com/innobraingmbh/onoffice-cli
Informations about the package onoffice-cli
onOffice CLI
CLI commands for interacting with onOffice (real estate CRM) from the command line. Designed for AI agent integration with structured JSON output.
Built on top of laravel-onoffice-adapter.
Installation
You can install the package via composer:
This package requires laravel-onoffice-adapter to be configured with your onOffice API credentials.
You can publish the config file with:
This is the contents of the published config file:
Usage
Search Records
Get Single Record
List Available Fields
Fields command options:
--filter=pattern- Search by name (substring or wildcard like*preis*)--field=name- Get single field with full details including permitted values--full- Show all field details (length, default, permittedValues)
Supported Entities
estate - Real Estate Listings
Properties/real estate records. Common fields include:
| Field | Description |
|---|---|
Id |
Estate ID |
status |
Status (1 = active) |
objektnr_extern |
External property number |
objekttitel |
Property title |
objekttyp |
Property type (singleselect) |
objektart |
Property category |
kaufpreis |
Purchase price |
warmmiete |
Warm rent |
kaltmiete |
Cold rent |
wohnflaeche |
Living area (m²) |
grundstuecksflaeche |
Plot area (m²) |
anzahl_zimmer |
Number of rooms |
Ort |
City |
Plz |
Postal code |
Strasse |
Street |
land |
Country |
breitengrad, laengengrad |
Coordinates |
verkauft |
Sold (1) / Rented (1) |
reserviert |
Reserved (1) |
veroeffentlichen |
Published on homepage |
geaendert_am |
Last modified date |
Marketing status: Combine verkauft and reserviert fields:
verkauft=0, reserviert=0→ Openverkauft=0, reserviert=1→ Reservedverkauft=1→ Sold/Rented
address - Contacts and Addresses
Contact records (clients, owners, prospects). Common fields include:
| Field | Description |
|---|---|
Id |
Address ID (Datensatznummer) |
KdNr |
Customer number (external) |
Anrede |
Salutation |
Vorname |
First name |
Name |
Last name |
Firma |
Company |
Strasse |
Street |
Plz |
Postal code |
Ort |
City |
Land |
Country |
Email |
Primary email |
Telefon1 |
Primary phone |
phone |
All phone numbers |
mobile |
Mobile numbers |
fax |
Fax numbers |
email |
All email addresses |
defaultemail |
Default email only |
imageUrl |
Profile photo URL |
Aenderung |
Last modified date |
Note: Record number (Id) and customer number (KdNr) are different fields. Use Id for API calls.
activity - Agents Log / Activities
Activity records linked to estates and addresses. Common fields include:
| Field | Description |
|---|---|
Nr |
Activity ID |
Objekt_nr |
Linked estate IDs |
Adress_nr |
Linked address IDs |
Aktionsart |
Kind of action (Email, Telefonat, etc.) |
Aktionstyp |
Type of action (Eingang, Ausgang) |
Datum |
Date/time |
created |
Creation date |
Benutzer |
User name |
Benutzer_nr |
User ID |
Bemerkung |
Comment/notes |
Kosten |
Costs |
HerkunftKontakt |
Contact origin |
Beratungsebene |
Advisory level (A-G) |
Absagegrund |
Reason for cancellation |
Advisory levels: A (contract signed) through G (cancellation)
searchcriteria - Search Criteria
Saved property search profiles for contacts. Fields include property preferences (price ranges, locations, property types) linked to addresses.
Other Entities
file- File attachmentsfield- Field configurationfilter- Saved filtersrelation- Links between records (buyer, owner, tenant relationships)link- URLs for detail viewslastseen- Recently viewed recordssetting- System settingslog- Log entriesmacro- Text macrosmarketplace- Marketplace data
Where Clause Operators
Supported operators for --where filters:
| Operator | Description | Example |
|---|---|---|
= |
Equals | --where="status=1" |
!= or <> |
Not equals | --where="status!=0" |
< |
Less than | --where="kaufpreis<300000" |
> |
Greater than | --where="wohnflaeche>80" |
<= |
Less than or equal | --where="anzahl_zimmer<=3" |
>= |
Greater than or equal | --where="kaufpreis>=100000" |
like |
Pattern match (% wildcard) | --where="Ort like %Berlin%" |
not like |
Negative pattern match | --where="Name not like %Test%" |
Multiple --where clauses are combined with AND logic.
Output Format
With --json flag, output is structured for easy parsing:
Without --json, output is displayed as a human-readable table.
Development
This is a Laravel package. To run commands locally during development:
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Konstantin Auffinger
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of onoffice-cli with dependencies
illuminate/contracts Version ^11.0||^12.0
innobrain/laravel-onoffice-adapter Version ^1.11
spatie/laravel-package-tools Version ^1.16