Skip to main content
GET
Get a managed company

Authorizations

Authorization
string
header
required

Partner API Bearer key: Authorization: Bearer <key>. Keys are created only through authorized portal or staff flows.

Headers

If-None-Match
string

Return 304 with an empty body when the current ETag matches one of the supplied validators (or *).

Path Parameters

id
string<uuid>
required

UUID of the managed company in this request.

Response

Detail and mutation representation of a Partner-managed company.

case_access
enum<string>
required

Whether the partner may operate the Case Management API for this company.

Available options:
available,
unavailable
case_submission_readiness
object
required

Whether company data is complete enough to submit a case.

created_at
string<date-time>
required
read-only

Time at which the managed company was created.

customer_number
string
required
read-only

paywise customer number assigned to the managed company.

id
string<uuid>
required
read-only

Stable identifier for this resource.

name
string
required

Registered or trading name of the company.

Maximum string length: 255
onboarding_mode
enum<string>
required

Selected mode for this Partner-company relationship. Read-only after creation.

Available options:
api_only,
web_flow
onboarding_status
enum<string>
required

Administrator confirmation status: confirmation_not_required for api_only; confirmation_pending for provisional web_flow; confirmed for confirmed web_flow. Poll this field independently of membership setup or email delivery.

Available options:
confirmation_not_required,
confirmation_pending,
confirmed
sandbox_origin
enum<string>
required

Provenance of this record. sandbox_native — created inside the sandbox and therefore a test resource you fully own. production_mirror — a read-only copy of a production record. unclassified — everything else, including every record in production. Determines what may be changed in the sandbox, so it is published rather than left to guesswork.

  • production_mirror - Production mirror
  • sandbox_native - Sandbox native
  • unclassified - Unclassified
Available options:
production_mirror,
sandbox_native,
unclassified
updated_at
string<date-time>
required
read-only

Time at which the managed company was last updated.

address
object | null

Postal address of the company.

default_claim_type
enum<string> | null

Default contract or transaction type for new principal claims.

  • 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
external_reference
string | null

Your own identifier for this company (for example a CRM id). Unique per partner, compared byte-exact after trimming surrounding whitespace (case-sensitive): creating a second company with the same value returns 409 company_exists with the existing company_id. Filter with ?external_reference= on the list endpoint.

Maximum string length: 120

Permanent public code from GET /legal-forms/.

People or organizations legally representing the company.

notification_channels
object[]

Company-level email recipients for operational notifications.

payout_bank_account
object | null

Account to which collected funds are transferred.

phone
string | null

Primary telephone number of the company in E.164 format; null clears it.

Maximum string length: 50
tax_treatment
enum<string> | null

Company's input-VAT or reverse-charge treatment.

  • input_tax_deductible - input_tax_deductible
  • not_input_tax_deductible - not_input_tax_deductible
  • reverse_charge - reverse_charge
  • third_country_non_taxable - third_country_non_taxable
Available options:
input_tax_deductible,
not_input_tax_deductible,
reverse_charge,
third_country_non_taxable
users
object[]

User memberships in the managed company. Each entry identifies a membership and its current onboarding or revocation state.

vat_number
string | null

VAT identification number of the company.

Maximum string length: 64