Frozen v1 · Update Company - paywise Knowledge Center

Update Company

import requests

url = "https://api.paywise.de/partner/v1/companies/{id}/"

payload = { "name": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

fetch('https://api.paywise.de/partner/v1/companies/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.patch("https://api.paywise.de/partner/v1/companies/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.paywise.de/partner/v1/companies/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"name\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

curl --request PATCH \
  --url https://api.paywise.de/partner/v1/companies/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<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>"
}

{
  "detail": "<string>"
}

PATCH

partner

companies

{id}

Update Company

import requests

url = "https://api.paywise.de/partner/v1/companies/{id}/"

payload = { "name": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>'})
};

fetch('https://api.paywise.de/partner/v1/companies/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.patch("https://api.paywise.de/partner/v1/companies/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.paywise.de/partner/v1/companies/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"name\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

curl --request PATCH \
  --url https://api.paywise.de/partner/v1/companies/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<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>"
}

{
  "detail": "<string>"
}

This page documents a frozen v1 API. It receives only critical correctness or security corrections. For new integrations, use the current API and follow the linked migration guide.

Autorisierungen

Authorization

string

header

erforderlich

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

Pfadparameter

string<uuid>

erforderlich

Body

string

Minimum string length: 1

name

string

Name of the company

Minimum string length: 1

address

object

The company's postal address

Show child attributes

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)

Show child attributes

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

Verfügbare Optionen:

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)

Show child attributes

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

Verfügbare Optionen:

J,

N,

K,

A

notification_channels

object[]

Notification settings for the company

Show child attributes

iban

string

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

Required string length: 1 - 32

Antwort

href

string<uri>

erforderlich

read-only

name

string

erforderlich

Name of the company

phone

string

erforderlich

Phone number of the company (max 50 characters)

data_submission_completed

boolean

Standard:false

erforderlich

read-only

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.

string

address

object

The company's postal address

Show child attributes

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)

Show child attributes

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

Verfügbare Optionen:

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)

Show child attributes

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

Verfügbare Optionen:

J,

N,

K,

A

notification_channels

object[]

Notification settings for the company

Show child attributes

iban

string

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

Maximum string length: 32

Mahnservice

Verwaltung

Frozen v1 · Update Company

Autorisierungen

Pfadparameter

Body

Antwort