papierkram_api_client 0.3.1 → 0.4.1

data/README.md

@@ -10,9 +10,8 @@ Der erste ~~illegale~~ inoffizielle API Client in [Ruby](https://www.ruby-lang.o
 
 ---
 
-**WERBUNG** (es ist ein Aufruf zur Mitarbeit 🫠)
-JETZT NEU! Ohne Lack und frei von Glamour!  
-Das Gleiche, nur in grün, also für [NodeJS](https://github.com/simonneutert/papierkram-api-client). Und als Mega-Baustelle 😬
+**Aufruf zur Mitarbeit für NodeJS/JavaScript 🫠**  
+Das Gleiche, nur in grün, also für [NodeJS ein Papierkram Api Client](https://github.com/simonneutert/papierkram-api-client) 😬
 
 ---
 
@@ -26,6 +25,9 @@ Schau in [UPGRADING.md](UPGRADING.md), 💃🕺!
 Hier geht es zu den [offiziellen API Docs](https://demo.papierkram.de/api/v1/api-docs/index.html).  
 Schau bitte dort um alle Rückgabefelder/-werte zu checken, bis ich (oder du mit deiner Zeit und Hingabe) die Dokumentation hier komplett habe.
 
+**WENN DU PROBLEME HAST,** bitte ich dich erstmal die [offiziellen API Docs](https://demo.papierkram.de/api/v1/api-docs/index.html) zu durchstöbern. Dann lohnt es sich hier die Beispiele (weiter unten) zu lesen und von dort sowohl mal in die Methoden im Code zu springen, oder noch besser in die Tests schauen.  
+Wenn du dann immer noch nicht weiterkommst, kannst du gerne einen Issue erstellen. Poste dabei so viele Informationen wie möglich, damit ich dir bestmöglich weiterhelfen kann. Achte dabei bitte darauf, dass du keine privaten Daten postest. 🙏
+
 ---
 
 ## Aktuell unterstützte Endpunkte der Papierkram API (V1)<!-- omit in toc -->
@@ -37,11 +39,14 @@ Schau bitte dort um alle Rückgabefelder/-werte zu checken, bis ich (oder du mit
 - [x] Expense::Voucher (Ausgabe Belege)
 - [x] Income::Estimate (Angebote)
 - [x] Income::Invoice (Rechnungen)
+- [x] Income::PaymentTerms (Zahlungsbedingungen)
 - [x] Income::Proposition (Waren / Dienstleistungen)
 - [x] Info
+- [ ] Settings::CustomAttribute (Datenfelder)
 - [x] Project (Projekte)
 - [x] Tracker::Task (Aufgaben)
 - [x] Tracker::TimeEntry (Zeiterfassung)
+- [ ] User
 
 ## Was, wie, warum?<!-- omit in toc -->
 
@@ -82,6 +87,16 @@ Ziele:
     - [alle Ausgabe Belege](#alle-ausgabe-belege)
     - [einen Ausgabe Beleg](#einen-ausgabe-beleg)
     - [einen Ausgabe Beleg als PDF](#einen-ausgabe-beleg-als-pdf)
+    - [einen Ausgabe Beleg erstellen](#einen-ausgabe-beleg-erstellen)
+    - [einen Ausgabe Beleg aktualisieren](#einen-ausgabe-beleg-aktualisieren)
+    - [einen Ausgabe Beleg löschen](#einen-ausgabe-beleg-löschen)
+    - [einen Ausgabe Beleg archivieren](#einen-ausgabe-beleg-archivieren)
+    - [einen Ausgabe Beleg unarchivieren](#einen-ausgabe-beleg-unarchivieren)
+    - [einen Ausgabe Beleg stornieren](#einen-ausgabe-beleg-stornieren)
+    - [einen Ausgabe Beleg rückwirkend stornieren](#einen-ausgabe-beleg-rückwirkend-stornieren)
+    - [einen Ausgabe Beleg als bezahlt markieren](#einen-ausgabe-beleg-als-bezahlt-markieren)
+    - [einem Ausgabe Beleg ein Dokument hinzufügen](#einem-ausgabe-beleg-ein-dokument-hinzufügen)
+    - [einem Ausgabe Beleg ein Dokument entfernen](#einem-ausgabe-beleg-ein-dokument-entfernen)
   - [Income::Estimate (Angebot)](#incomeestimate-angebot)
     - [alle Angebote](#alle-angebote)
     - [ein Angebot](#ein-angebot)
@@ -90,6 +105,16 @@ Ziele:
     - [alle Rechnungen](#alle-rechnungen)
     - [eine Rechnung](#eine-rechnung)
     - [eine Rechnung als PDF](#eine-rechnung-als-pdf)
+    - [eine Rechnung erstellen](#eine-rechnung-erstellen)
+    - [eine Rechnung aktualisieren](#eine-rechnung-aktualisieren)
+    - [eine Rechnung löschen](#eine-rechnung-löschen)
+    - [eine Rechnung archivieren](#eine-rechnung-archivieren)
+    - [eine Rechnung unarchivieren](#eine-rechnung-unarchivieren)
+    - [eine Rechnung stornieren](#eine-rechnung-stornieren)
+    - [eine Rechnung verschicken](#eine-rechnung-verschicken)
+  - [Income::PaymentTerms (Zahlungsbedingungen)](#incomepaymentterms-zahlungsbedingungen)
+    - [eine Zahlungsbedingung](#eine-zahlungsbedingung)
+    - [alle Zahlungsbedingungen](#alle-zahlungsbedingungen)
   - [Income::Proposition (Waren / Dienstleistungen)](#incomeproposition-waren--dienstleistungen)
     - [alle Waren / Dienstleistungen](#alle-waren--dienstleistungen)
     - [eine Ware / Dienstleistung](#eine-ware--dienstleistung)
@@ -110,9 +135,19 @@ Ziele:
   - [Tracker::Task (Aufgabe)](#trackertask-aufgabe)
     - [alle Aufgaben](#alle-aufgaben)
     - [eine Aufgabe](#eine-aufgabe)
+    - [erstelle eine Aufgabe](#erstelle-eine-aufgabe)
+    - [aktualisiere eine Aufgabe](#aktualisiere-eine-aufgabe)
+    - [lösche eine Aufgabe](#lösche-eine-aufgabe)
+    - [archiviere eine Aufgabe](#archiviere-eine-aufgabe)
+    - [unarchiviere eine Aufgabe](#unarchiviere-eine-aufgabe)
   - [Tracker::TimeEntry (Zeiteintrag)](#trackertimeentry-zeiteintrag)
     - [alle Zeiteinträge](#alle-zeiteinträge)
     - [einen Zeiteintrag](#einen-zeiteintrag)
+    - [erstelle einen Zeiteintrag](#erstelle-einen-zeiteintrag)
+    - [aktualisiere einen Zeiteintrag](#aktualisiere-einen-zeiteintrag)
+    - [lösche einen Zeiteintrag](#lösche-einen-zeiteintrag)
+    - [archiviere einen Zeiteintrag](#archiviere-einen-zeiteintrag)
+    - [unarchiviere einen Zeiteintrag](#unarchiviere-einen-zeiteintrag)
   - [Verbleibendes Quota](#verbleibendes-quota)
 - [Business Intelligence](#business-intelligence)
   - [Business::Intelligence (BI) ExpenseByCategory (Ausgaben nach Kategorie)](#businessintelligence-bi-expensebycategory-ausgaben-nach-kategorie)
@@ -120,7 +155,8 @@ Ziele:
     - [alle Ausgaben eines Monats nach Kategorie gefiltert nach Steuersatz](#alle-ausgaben-eines-monats-nach-kategorie-gefiltert-nach-steuersatz)
 - [Helpers](#helpers)
   - [Generiere ein PDF aus Response](#generiere-ein-pdf-aus-response)
-- [Development](#development)
+- [Development / Mitentwickeln](#development--mitentwickeln)
+  - [Localhost 3000! 🤫](#localhost-3000-)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -325,8 +361,10 @@ Siehe [Companies#create_customer](lib/papierkram_api/v1/endpoints/contact/compan
 #### aktualisiere ein Unternehmen
 
 ```ruby
-company = client.contact_companies
-                .update_by(id: 1, attributes: { name: 'Test GmbH' })
+company = client.contact_companies.update_by(
+  id: 1,
+  name: 'Test GmbH'
+)
 puts company.headers
 puts company.body
 ```
@@ -381,11 +419,9 @@ puts company.body
 
 ```ruby
 company = client.contact_companies_persons.create(
-  company_id: 1, 
-  attributes: { 
-    first_name: 'Max',
-    last_name: 'Mustermann'
-  }
+  company_id: 1,
+  first_name: 'Max',
+  last_name: 'Mustermann'
 )
 puts company.headers
 puts company.body
@@ -396,8 +432,11 @@ Siehe [CompaniesPersons#create](lib/papierkram_api/v1/endpoints/contact/companie
 #### aktualisiere eine Kontaktperson (eines Unternehmens)
 
 ```ruby
-company = client.contact_companies_persons
-                .update_by(company_id: 1, id: 1, attributes: { first_name: 'Moritz' })
+company = client.contact_companies_persons.update_by(
+  id: 1,
+  company_id: 1,
+  first_name: 'Moritz'
+)
 puts company.headers
 puts company.body
 ```
@@ -442,6 +481,142 @@ puts PapierkramApi::V1::Helpers::PdfFromResponse.new(voucher).to_pdf
 # => {response: Faraday::Response, path_to_pdf_file: 'path/to/tempfile_pdf.pdf'}
 ```
 
+#### einen Ausgabe Beleg erstellen
+
+Siehe [Vouchers#create](lib/papierkram_api/v1/endpoints/expense/vouchers.rb) für mögliche Parameter.
+
+```ruby
+voucher = client.expense_vouchers.create(
+  name: "Restaurant visit",
+  due_date: "2020-06-30",
+  document_date: "2020-06-14",
+  description: "Took customer for dinner.",
+  entertainment_reason: "sales meeting",
+  flagged: true,
+  provenance: "domestic",
+  entertainment_persons: [
+    "Carl Customer"
+  ],
+  creditor_id: 85,
+  line_items: [
+    {
+      amount: 150.8,
+      name: "restaurant bill",
+      vat_rate: "19%",
+      category: "Bewirtungskosten"
+    },
+    {
+      amount: 15,
+      name: "tip",
+      vat_rate: "19%",
+      category: "Bewirtungskosten"
+    }
+  ]
+)
+```
+
+#### einen Ausgabe Beleg aktualisieren
+
+Siehe [Vouchers#update_by](lib/papierkram_api/v1/endpoints/expense/vouchers.rb) für mögliche Parameter.
+
+```ruby
+voucher = client.expense_vouchers.update_by(
+  id: 1,
+  document_date: "2020-06-13",
+  creditor_id: 102,
+  line_items: [
+    {
+      amount: 170.8,
+      name: "restaurant bill",
+      vat_rate: "19%",
+      category: "Bewirtungskosten",
+      billing: null,
+      depreciation: null
+    },
+    {
+      amount: 15,
+      name: "tip",
+      vat_rate: "19%",
+      category: "Bewirtungskosten"
+    }
+  ]
+)
+```
+
+#### einen Ausgabe Beleg löschen
+
+```ruby
+voucher = client.expense_vouchers.delete_by(id: 1)
+```
+
+#### einen Ausgabe Beleg archivieren
+
+```ruby
+voucher = client.expense_vouchers.archive_by(id: 1)
+```
+
+#### einen Ausgabe Beleg unarchivieren
+
+```ruby
+voucher = client.expense_vouchers.unarchive_by(id: 1)
+```
+
+#### einen Ausgabe Beleg stornieren
+
+```ruby
+voucher = client.expense_vouchers.cancel_by(id: 1)
+```
+
+#### einen Ausgabe Beleg rückwirkend stornieren
+
+```ruby
+voucher = client.expense_vouchers.cancel_with_reverse_entry_by(id: 1)
+```
+
+#### einen Ausgabe Beleg als bezahlt markieren
+
+Siehe [Vouchers#mark_as_paid_by](lib/papierkram_api/v1/endpoints/expense/vouchers.rb) für mögliche Parameter.
+
+```ruby
+voucher = client.expense_vouchers.mark_as_paid_by(
+  id: 1,
+  value: 119.0
+)
+```
+
+#### einem Ausgabe Beleg ein Dokument hinzufügen
+
+Siehe [Vouchers#add_document_by](lib/papierkram_api/v1/endpoints/expense/vouchers.rb) für mögliche Parameter.
+
+Um ein PDF hinzuzufügen:
+
+```ruby
+voucher = client.expense_vouchers.add_document_by(
+  id: 1,
+  path_to_file: 'path/to/file.pdf',
+  file_type: 'application/pdf'
+)
+```
+
+oder mit einem Bild im jpeg Format
+
+```ruby
+voucher = client.expense_vouchers.add_document_by(
+  id: 1,
+  path_to_file: 'path/to/file.jpeg',
+  file_type: 'image/jpeg'
+)
+```
+
+#### einem Ausgabe Beleg ein Dokument entfernen
+
+```ruby
+voucher = client.expense_vouchers.delete_document_by(
+  id: 1,
+  document_id: 1
+)
+```
+
 ### Income::Estimate (Angebot)
 
 Der Endpunkt `/papierkram_api/v1/endpoints/income/estimates` liefert Informationen über die Angebote. Die Informationen werden als `Faraday::Response` zurückgegeben.
@@ -502,6 +677,163 @@ puts PapierkramApi::V1::Helpers::PdfFromResponse.new(invoice).to_pdf
 # => {response: Faraday::Response, path_to_pdf_file: 'path/to/tempfile_pdf.pdf'}
 ```
 
+#### eine Rechnung erstellen
+
+Siehe [Invoices#create](lib/papierkram_api/v1/endpoints/income/invoices.rb) für mögliche Parameter.
+
+```ruby
+invoice = client.income_invoices.create(
+  name: 'Neuausstattung des Büros',
+  supply_date: '01.01.2024 - 14.01.2024',
+  document_date: '2024-01-15',
+  payment_term_id: 46,
+  customer_id: 3,
+  project_id: 15,
+  line_items: [
+    {
+      name: 'Anlieferung',
+      description: 'Anlieferung der neuen Möbel',
+      quantity: 1.25,
+      unit: 'Stunden',
+      vat_rate: '19%',
+      price: 100
+    },
+    {
+      name: 'Bestuhlung',
+      description: 'Bestuhlung des Bürogebäudes',
+      quantity: 1.25,
+      unit: 'Arbeitstage',
+      vat_rate: '19%',
+      price: 800
+    },
+    {
+      name: 'Büroartikel',
+      description: 'Neue Bürostühle',
+      quantity: 200,
+      unit: 'Stühle',
+      vat_rate: '19%',
+      price: 125
+    }
+  ]
+)
+```
+
+#### eine Rechnung aktualisieren
+
+Siehe [Invoices#update_by](lib/papierkram_api/v1/endpoints/income/invoices.rb) für mögliche Parameter.
+
+```ruby
+response = client.income_invoices.update_by(
+  id: 9,
+  name: 'Neuausstattung eines Büros',
+  line_items: [
+    {
+      name: 'Anlieferung',
+      description: 'Anlieferung der neuen Möbel',
+      quantity: 1.5,
+      unit: 'Stunden',
+      vat_rate: '19%',
+      price: 100
+    },
+    {
+      name: 'Bestuhlung',
+      description: 'Bestuhlung des Bürogebäudes',
+      quantity: 1.5,
+      unit: 'Arbeitstage',
+      vat_rate: '19%',
+      price: 800
+    },
+    {
+      name: 'Büroartikel',
+      description: 'Neue Bürostühle',
+      quantity: 200,
+      unit: 'Stühle',
+      vat_rate: '19%',
+      price: 125
+    }
+  ]
+)
+```
+
+#### eine Rechnung löschen
+
+Siehe [Invoices#delete_by](lib/papierkram_api/v1/endpoints/income/invoices.rb) für mögliche Parameter.
+
+```ruby
+invoice = client.income_invoices.delete_by(id: 1)
+```
+
+#### eine Rechnung archivieren
+
+Siehe [Invoices#archive_by](lib/papierkram_api/v1/endpoints/income/invoices.rb) für mögliche Parameter.
+
+```ruby
+invoice = client.income_invoices.archive_by(id: 1)
+```
+
+#### eine Rechnung unarchivieren
+
+Siehe [Invoices#unarchive_by](lib/papierkram_api/v1/endpoints/income/invoices.rb) für mögliche Parameter.
+
+```ruby
+invoice = client.income_invoices.unarchive_by(id: 1)
+```
+
+#### eine Rechnung stornieren
+
+Siehe [Invoices#cancel_by](lib/papierkram_api/v1/endpoints/income/invoices.rb) für mögliche Parameter.
+
+```ruby
+invoice = client.income_invoices.cancel_by(id: 1)
+```
+
+#### eine Rechnung verschicken
+
+Siehe [Invoices#send_by](lib/papierkram_api/v1/endpoints/income/invoices.rb) für mögliche Parameter.
+
+Per E-Mail:
+
+```ruby
+invoice = client.income_invoices.deliver_by(
+  id: 1,
+  send_via: 'email',
+  email_recipient: "test@test.test",
+  email_subject: "Ich verkaufe was du brauchst",
+  email_body: "Sag einfach was du brauchst und ich verkaufe es dir.",
+)
+```
+
+Per PDF:
+
+```ruby
+invoice = client.income_invoices.deliver_by(
+  id: 1,
+  send_via: 'pdf'
+)
+```
+
+### Income::PaymentTerms (Zahlungsbedingungen)
+
+Der Endpunkt `/papierkram_api/v1/endpoints/income/payment_terms` liefert Informationen über die Zahlungsbedingungen. Die Informationen werden als `Faraday::Response` zurückgegeben.
+
+#### eine Zahlungsbedingung
+
+```ruby
+payment_term = client.income_payment_terms.find_by(id: 1)
+puts payment_term.headers
+puts payment_term.body
+```
+
+#### alle Zahlungsbedingungen
+
+Siehe [PaymentTerms](lib/papierkram_api/v1/endpoints/income/payment_terms.rb) für mögliche Parameter.
+
+```ruby
+payment_terms = client.income_payment_terms.all
+puts payment_terms.headers
+puts payment_terms.body
+```
+
 ### Income::Proposition (Waren / Dienstleistungen)
 
 Der Endpunkt `/papierkram_api/v1/endpoints/income/propositions` liefert Informationen über die Waren / Dienstleistungen. Die Informationen werden als `Faraday::Response` zurückgegeben.
@@ -547,10 +879,8 @@ Siehe [Propositions#create](lib/papierkram_api/v1/endpoints/income/propositions.
 ```ruby
 client.income_propositions.update_by(
   id: 1,
-  attributes: {
-    name: 'Software design',
-    vat_rate: '19%' # verpflichtend bei Änderung
-  }
+  name: 'Software design',
+  vat_rate: '19%' # verpflichtend bei Änderung
 )
 ```
 
@@ -621,7 +951,10 @@ Siehe [Projects](lib/papierkram_api/v1/endpoints/projects.rb) für mögliche Par
 #### aktualisiere ein Projekt
 
 ```ruby
-project = client.projects.update_by(id: 1, attributes: { name: 'Projekt 2' })
+project = client.projects.update_by(
+  id: 1,
+  name: 'Projekt 2'
+)
 puts project.headers
 puts project.body
 ```
@@ -674,6 +1007,50 @@ puts task.headers
 puts task.body
 ```
 
+#### erstelle eine Aufgabe
+
+Siehe [Tasks#create](lib/papierkram_api/v1/endpoints/tracker/tasks.rb) für mögliche Parameter.
+
+```ruby
+task = client.tracker_tasks.create(name: 'Aufgabe 1')
+puts task.headers
+puts task.body
+```
+
+#### aktualisiere eine Aufgabe
+
+Siehe [Tasks#update_by](lib/papierkram_api/v1/endpoints/tracker/tasks.rb) für mögliche Parameter.
+
+```ruby
+task = client.tracker_tasks.update_by(id: 1, name: 'Aufgabe 2' )
+puts task.headers
+puts task.body
+```
+
+#### lösche eine Aufgabe
+
+```ruby
+task = client.tracker_tasks.delete_by(id: 1)
+puts task.headers
+puts task.body
+```
+
+#### archiviere eine Aufgabe
+
+```ruby
+task = client.tracker_tasks.archive_by(id: 1)
+puts task.headers
+puts task.body
+```
+
+#### unarchiviere eine Aufgabe
+
+```ruby
+task = client.tracker_tasks.unarchive_by(id: 1)
+puts task.headers
+puts task.body
+```
+
 ### Tracker::TimeEntry (Zeiteintrag)
 
 Der Endpunkt `/papierkram_api/v1/tracker/time_entries` liefert Informationen über die Zeiteinträge. Die Informationen werden als `Faraday::Response` zurückgegeben.
@@ -682,6 +1059,8 @@ Der Endpunkt `/papierkram_api/v1/tracker/time_entries` liefert Informationen üb
 
 #### alle Zeiteinträge
 
+Siehe [TimeEntries](lib/papierkram_api/v1/endpoints/tracker/time_entries.rb) für mögliche Parameter.
+
 ```ruby
 time_entries = client.tracker_time_entries.all
 puts time_entries.headers
@@ -696,6 +1075,58 @@ puts time_entry.headers
 puts time_entry.body
 ```
 
+#### erstelle einen Zeiteintrag
+
+Siehe [TimeEntries](lib/papierkram_api/v1/endpoints/tracker/time_entries.rb) für mögliche Parameter.
+
+```ruby
+time_entry = client.tracker_time_entries.create(
+  task_id: 1,
+  date: '2020-01-01',
+  duration: 60,
+  description: 'Test'
+)
+puts time_entry.headers
+puts time_entry.body
+```
+
+#### aktualisiere einen Zeiteintrag
+
+Siehe [TimeEntries](lib/papierkram_api/v1/endpoints/tracker/time_entries.rb) für mögliche Parameter.
+
+```ruby
+time_entry = client.tracker_time_entries.update_by(
+  id: 1,
+ comments: 'Test'
+)
+puts time_entry.headers
+puts time_entry.body
+```
+
+#### lösche einen Zeiteintrag
+
+```ruby
+time_entry = client.tracker_time_entries.delete_by(id: 1)
+puts time_entry.headers
+puts time_entry.body
+```
+
+#### archiviere einen Zeiteintrag
+
+```ruby
+time_entry = client.tracker_time_entries.archive_by(id: 1)
+puts time_entry.headers
+puts time_entry.body
+```
+
+#### unarchiviere einen Zeiteintrag
+
+```ruby
+time_entry = client.tracker_time_entries.unarchive_by(id: 1)
+puts time_entry.headers
+puts time_entry.body
+```
+
 ### Verbleibendes Quota
 
 Jede API Anfrage "kostet" 1 Quota. Das Quota wird bei jedem Request aktualisiert. Um das verbleibende Quota zu erhalten, kann die Methode `remaining_quota` aufgerufen werden.
@@ -714,6 +1145,8 @@ quota = client.info.remaining_quota(response)
 
 ## Business Intelligence
 
+> **DEPRECATED** Bitte verwende dieses Modul nicht mehr, es wird in Zukunft entfernt werden.
+
 Ich lasse diesen ersten Ausflug in Auswertungen erstmal hier im Gem. Aber sollte ich die Zeit finden und weitere KPIs wichtig finden, dann gehören die Auswertungen eigentlich in ein eigenes Package.
 
 TODO ergänzen wie man `SmartQueries` erstellt und verwendet.  
@@ -722,6 +1155,8 @@ TODO ergänzen wie die Rückgabewerte von `SmartQueries` gestaltet werden sollte
 
 ### Business::Intelligence (BI) ExpenseByCategory (Ausgaben nach Kategorie)
 
+> **DEPRECATED** Bitte verwende dieses Modul nicht mehr, es wird in Zukunft entfernt werden.
+
 Der Endpunkt `/papierkram_api/v1/business_intelligence/expense_by_categories` liefert Informationen über die Ausgaben nach Kategorie. Die Informationen werden als `Hash` zurückgegeben.
 
 #### alle Ausgaben eines Monats nach Kategorie
@@ -819,12 +1254,20 @@ puts pdf
 }
 ```
 
-## Development
+## Development / Mitentwickeln
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Localhost 3000! 🤫
+
+`DEBUG_LOCALHOST=true bin/console`
+
+OR to make it stick:  
+- Set `export DEBUG_LOCALHOST=true` in your `.env` or `.envrc` file.  
+- Enjoy the magic: `bin/setup && bin/console` 🎉
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/simonneutert/papierkram_api_client.

data/UPGRADING.md

@@ -1,3 +1,13 @@
+## From 0.3 to 0.4
+
+Some endpoints are calling `update` have changed. Instead of `update_by(id: 123, attributes: { ... })` you now use keywords e.g. `update_by(id: 123, name: 'New name')`.
+
+Please check the [CHANGELOG](CHANGELOG.md) for more details.
+
+- Income::Propositions
+- Projects
+- Contact::Companies
+
 ## From 0.2 to 0.3
 
 Finding specific records has changed. Instead of `by(id: 123)` you now use `find_by(id: 123)`.

data/lib/papierkram_api/client.rb

@@ -23,8 +23,10 @@ module PapierkramApi
     def build_client!
       @client = Faraday.new(url: @base_url) do |config|
         config.request :authorization, 'Bearer', @api_key
+        config.request :multipart
         config.request :json
         config.response :json
+
         config.adapter :httpx
         yield(config) if block_given?
       end
@@ -70,6 +72,11 @@ module PapierkramApi
         PapierkramApi::V1::Endpoints::Income::Invoices.new(@client)
     end
 
+    def income_payment_terms
+      @income_payment_terms ||=
+        PapierkramApi::V1::Endpoints::Income::PaymentTerms.new(@client)
+    end
+
     def income_propositions
       @income_propositions ||=
         PapierkramApi::V1::Endpoints::Income::Propositions.new(@client)
@@ -98,6 +105,8 @@ module PapierkramApi
     private
 
     def base_url_env
+      return 'http://localhost:3000' if ENV.fetch('DEBUG_LOCALHOST', false).to_s == 'true'
+
       "https://#{@subdomain}.papierkram.de"
     end
   end

data/lib/papierkram_api/v1/business_intelligence/base.rb

@@ -15,6 +15,15 @@ module PapierkramApi
       #
       class Base
         def expenses_by_category
+          warning = <<~MSG
+            [DEPRECATION] `expenses_by_category` is deprecated. #{' '}
+            It will be removed in a version after 0.4.0, most probably in 0.5.0.
+
+            [DEPRECATION] Support for RUBY 2.7 will be dropped#{' '}
+            in a version after 0.4.0, most probably in 0.5.0.
+          MSG
+          warn(warning)
+
           @expenses_by_category ||= PapierkramApi::V1::BusinessIntelligence::ExpensesByCategory.new
         end
       end