Skip to main content
PATCH
/
partner
/
v1
/
companies
/
{id}
Update Company
curl --request PATCH \
  --url https://api.paywise.de/partner/v1/companies/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "address": {
    "street": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "country": "AF"
  },
  "phone": "<string>",
  "vat_number": "<string>",
  "users": [
    {
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "<string>",
      "notification_channels": [
        {
          "channel_type": "EMAIL",
          "value": "<string>",
          "notification_types": [
            "STATUS_UPDATE"
          ]
        }
      ],
      "skip_email_verification": false
    }
  ],
  "default_claim_type": "H05",
  "legal_form": "<string>",
  "legal_representatives": [
    {
      "type": "gesellschafter",
      "name": "<string>"
    }
  ],
  "tax_deduction_eligibility": "J",
  "notification_channels": [
    {
      "channel_type": "EMAIL",
      "value": "<string>",
      "notification_types": [
        "STATUS_UPDATE"
      ]
    }
  ],
  "iban": "<string>"
}
'
{
  "href": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "data_submission_completed": false,
  "id": "<string>",
  "address": {
    "street": "<string>",
    "zip": "<string>",
    "city": "<string>",
    "country": "AF"
  },
  "vat_number": "<string>",
  "users": [
    {
      "href": "<string>",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "email_verified": true,
      "id": "<string>",
      "notification_channels": [
        {
          "channel_type": "EMAIL",
          "value": "<string>",
          "notification_types": [
            "STATUS_UPDATE"
          ]
        }
      ]
    }
  ],
  "default_claim_type": "H05",
  "legal_form": "<string>",
  "legal_representatives": [
    {
      "type": "gesellschafter",
      "name": "<string>"
    }
  ],
  "tax_deduction_eligibility": "J",
  "notification_channels": [
    {
      "channel_type": "EMAIL",
      "value": "<string>",
      "notification_types": [
        "STATUS_UPDATE"
      ]
    }
  ],
  "iban": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Body

​
id
string
Minimum string length: 1
​
name
string

Name of the company

Minimum string length: 1
​
address
object

The company's postal address

​
phone
string

Phone number of the company (max 50 characters)

Minimum string length: 1
​
vat_number
string

VAT ID (Umsatzsteuer-Identifikationsnummer), must adhere to the german schema for VAT IDs

Minimum string length: 1
​
users
object[]

Users registered within this company (read only)

​
default_claim_type
enum<string>

The company's default claim type (Vertragsart/Forderungsart)

  • H05 - Dienstleistungsvertrag
  • H43 - Warenlieferung/-en
  • H22 - Mitgliedsbeitrag
  • H21 - Miete
  • H11 - Kaufvertrag
  • H44 - Werkvertrag/Werklieferungsvertrag
  • H08 - Handwerkerleistung
  • H41 - Versicherungsprämie/-beitrag
  • H16 - Lehrgangs-/Unterrichtskosten
  • H10 - Hotelkosten
  • H02 - Ärztliche oder zahnärztliche Leistung
  • H28 - Schadenersatz aus Vertrag
  • H26 - Reparaturleistung
  • H24 - Rechtsanwalts-/Rechtsbeistandshonorar
  • H06 - Frachtkosten
  • H18 - Miete für Kraftfahrzeug
  • H34 - Speditionskosten
  • H19 - Miete für Wohnraum einschl. Nebenkosten
  • H42 - Versorgungsleistung - Strom, Wasser, Gas, Wärme-
  • H17 - Miete für Geschäftsraum einschl. Nebenkosten
  • H45 - Zeitungs-/Zeitschriftenbezug
  • H37 - Ungerechtfertigte Bereicherung
  • H29 - Schadenersatz aus Unfall/Vorfall
  • H01 - Anzeigen in Zeitungen u.a.
  • H78 - Tierärztliche Leistung
  • H14 - Lagerkosten
  • H77 - Krankentransportkosten
  • H40 - Vermittlungs-/Maklerprovision
  • H15 - Leasing/Mietkauf
  • H23 - Pacht
  • H04 - Darlehensrückzahlung
  • H20 - Mietnebenkosten - auch Renovierungskosten-
  • H79 - Verpflegungskosten
  • H75 - Reisevertrag
  • H33 - Schuldanerkenntnis
  • H39 - Vergleich, außergerichtlicher
  • H70 - Kindertagesstättenbeitrag
  • H90 - Wohngeld/Hausgeld für Wohnungseigentümergemeinschaft
  • H09 - Heimunterbringung
  • H03 - Bürgschaft
  • H07 - Geschäftsbesorgung durch Selbständige
  • H12 - Kontokorrentabrechnung
  • H13 - Krankenhauskosten-Pflege/Behandlung
  • H36 - Überziehung des Bankkontos
  • H61 - Wahlleistungen bei stationärer Behandlung
  • H76 - Telekommunikationsleistungen
Available options:
H05,
H43,
H22,
H21,
H11,
H44,
H08,
H41,
H16,
H10,
H02,
H28,
H26,
H24,
H06,
H18,
H34,
H19,
H42,
H17,
H45,
H37,
H29,
H01,
H78,
H14,
H77,
H40,
H15,
H23,
H04,
H20,
H79,
H75,
H33,
H39,
H70,
H90,
H09,
H03,
H07,
H12,
H13,
H36,
H61,
H76
​
legal_form
string

Legal Form of the company

Minimum string length: 1
​
legal_representatives
object[]

The company's legal representatives (if required)

​
tax_deduction_eligibility
enum<string>

The company's input tax deduction eligibility (Vorsteuerabzugsberechtigung)

  • J - Vorsteuerabzugsberechtigt
  • N - Nicht vorsteuerabzugsberechtigt
  • K - Reverse-Charge-Verfahren
  • A - Nicht steuerbare Umsätze - Drittlandunternehmer
Available options:
J,
N,
K,
A
​
notification_channels
object[]

Notification settings for the company

​
iban
string

The company's payout account to which collected funds will be transferred.

Required string length: 1 - 32

Response

​
href
string<uri>
required
​
name
string
required

Name of the company

​
phone
string
required

Phone number of the company (max 50 characters)

​
data_submission_completed
boolean
default:false
required

Indicates whether the data for the company was completely submitted, either through API or provided by a user. You can only start creating claims once this is completed.

​
id
string
​
address
object

The company's postal address

​
vat_number
string

VAT ID (Umsatzsteuer-Identifikationsnummer), must adhere to the german schema for VAT IDs

​
users
object[]

Users registered within this company (read only)

​
default_claim_type
enum<string>

The company's default claim type (Vertragsart/Forderungsart)

  • H05 - Dienstleistungsvertrag
  • H43 - Warenlieferung/-en
  • H22 - Mitgliedsbeitrag
  • H21 - Miete
  • H11 - Kaufvertrag
  • H44 - Werkvertrag/Werklieferungsvertrag
  • H08 - Handwerkerleistung
  • H41 - Versicherungsprämie/-beitrag
  • H16 - Lehrgangs-/Unterrichtskosten
  • H10 - Hotelkosten
  • H02 - Ärztliche oder zahnärztliche Leistung
  • H28 - Schadenersatz aus Vertrag
  • H26 - Reparaturleistung
  • H24 - Rechtsanwalts-/Rechtsbeistandshonorar
  • H06 - Frachtkosten
  • H18 - Miete für Kraftfahrzeug
  • H34 - Speditionskosten
  • H19 - Miete für Wohnraum einschl. Nebenkosten
  • H42 - Versorgungsleistung - Strom, Wasser, Gas, Wärme-
  • H17 - Miete für Geschäftsraum einschl. Nebenkosten
  • H45 - Zeitungs-/Zeitschriftenbezug
  • H37 - Ungerechtfertigte Bereicherung
  • H29 - Schadenersatz aus Unfall/Vorfall
  • H01 - Anzeigen in Zeitungen u.a.
  • H78 - Tierärztliche Leistung
  • H14 - Lagerkosten
  • H77 - Krankentransportkosten
  • H40 - Vermittlungs-/Maklerprovision
  • H15 - Leasing/Mietkauf
  • H23 - Pacht
  • H04 - Darlehensrückzahlung
  • H20 - Mietnebenkosten - auch Renovierungskosten-
  • H79 - Verpflegungskosten
  • H75 - Reisevertrag
  • H33 - Schuldanerkenntnis
  • H39 - Vergleich, außergerichtlicher
  • H70 - Kindertagesstättenbeitrag
  • H90 - Wohngeld/Hausgeld für Wohnungseigentümergemeinschaft
  • H09 - Heimunterbringung
  • H03 - Bürgschaft
  • H07 - Geschäftsbesorgung durch Selbständige
  • H12 - Kontokorrentabrechnung
  • H13 - Krankenhauskosten-Pflege/Behandlung
  • H36 - Überziehung des Bankkontos
  • H61 - Wahlleistungen bei stationärer Behandlung
  • H76 - Telekommunikationsleistungen
Available options:
H05,
H43,
H22,
H21,
H11,
H44,
H08,
H41,
H16,
H10,
H02,
H28,
H26,
H24,
H06,
H18,
H34,
H19,
H42,
H17,
H45,
H37,
H29,
H01,
H78,
H14,
H77,
H40,
H15,
H23,
H04,
H20,
H79,
H75,
H33,
H39,
H70,
H90,
H09,
H03,
H07,
H12,
H13,
H36,
H61,
H76
​
legal_form
string

Legal Form of the company

​
legal_representatives
object[]

The company's legal representatives (if required)

​
tax_deduction_eligibility
enum<string>

The company's input tax deduction eligibility (Vorsteuerabzugsberechtigung)

  • J - Vorsteuerabzugsberechtigt
  • N - Nicht vorsteuerabzugsberechtigt
  • K - Reverse-Charge-Verfahren
  • A - Nicht steuerbare Umsätze - Drittlandunternehmer
Available options:
J,
N,
K,
A
​
notification_channels
object[]

Notification settings for the company

​
iban
string

The company's payout account to which collected funds will be transferred.

Maximum string length: 32