Entities
The main entities used within the partner API
Companies
Companies represent the legal entities that appear as paywise clients and creditors in the debt collection process. These companies are the ones that create invoices and act as creditors.
Required information
In order to start creating claims via the Case Management API you need to provide all relevant information on the company. Once all information is provided, the data_submission_completed flag will indicate that you can start creating claims.
Depending on the onboading flow you choose, you can either provide this info directly via API or have the users provide any missing data. Required are:
namephoneaddresslegal_formtax_deduction_eligibilityvat_number(required if the tax deduction eligibility is set toK)
Depending on the legal form that is provided, you might have to provide information on the legal representatives - see the table below for a detailed definition.
Legal Forms and Legal Representatives
Providing the legal form of a client is important for onboading a client. Depending on your usecase, you might wannt to either provide it via API or have the first user provite the relevant info.
Depending on the legal form of the client, we require input on the legal representatives. Again, this information is required to be able to start the judicial dunning process.
In the table below, find the available legal forms and their requirements on providing legal representatives. The legal representatives are denoted by their type field.
| Legal Form | Description | Legal Representatives required |
|---|---|---|
| AG | Public limited company | — |
| e.V. | Registered association | — |
| Einzelkaufmann | Sole trader | — |
| PartG | Partnership company | — |
| e.G. | Registered cooperative | — |
| Limited | Private limited company (UK) | — |
| FZ LLE | Free Zone Limited Liability Establishment | — |
| S.R.L. | Limited liability company (Italy, Romania) | — |
| OHG & Co. KG | General partnership & limited partnership | — |
| UG & Co. KG | Entrepreneurial company & limited partnership | - komplementaer - geschaeftsführer |
| KG | Limited partnership | - komplementaer |
| OHG | General partnership | - gesellschafter |
| Inc. | Incorporated (US) | — |
| LTD. | Private limited company (UK) | — |
| LLC | Limited liability company (US) | — |
| SARL | Limited liability company (France, Luxembourg) | — |
| d.o.o. | Limited liability company (Slovenia, Croatia) | — |
| UG | Entrepreneurial company | — |
| GmbH | Limited liability company | — |
| GbR | Civil law partnership | - gesellschafter |
| SE | European Company | - vorstand - aufsichtsrat |
| Einzelunternehmer | Single Person Business | - inhaber |
| GmbH & Co. KG | Limited liability company & limited partnership | - komplementaer - geschaeftsführer |
| AG & Co. KG | Public limited company & limited partnership | - komplementaer - geschaeftsführer |
| AG & Co. KGaA | Public limited company & limited partnership | - komplementaer - geschaeftsführer |
| OÜ | Private limited company (Estonia) | — |
| Ltd. & Co. KG | Private limited company & limited partnership | - komplementaer - geschaeftsführer |
| Sp. z o.o. | Limited liability company (Poland) | — |
| Körpersch. d. ö. Rechts | Body of public law | - vorstand |
| B.V. | Private limited company (Netherlands) | — |
| s.r.o. | Limited liability company (Czech Republic) | — |
| Stiftung | Foundation | — |
| S. L. | Limited liability company (Spain) | — |
| A.S | Joint-stock company (Norway) | — |
| WEG | Condominium ownership association | — |
| PartG mbB | Partnership company with limited liability | — |
| AB | Joint-stock company (Sweden) | — |
| FZCO | Free Zone Company | — |
| gGmbH | Non-profit limited liability company | — |
| e.U. | Sole proprietorship (Austria) | — |
| Ltd. Sti | Limited company (Turkey) | — |
Users
A client company can have multiple users that are eligible to view, manage and interact with the data on the paywise platform. A user represents a natural person that is authorized to hand over data. Each Claim you create via the Case Management API will be associated with the user that created this claim for traceability.
User Invites
User invites act as an intermediate entity that holds temporary information on a user that is currently being onboarded. This information is only valid until the user is onboarded or has aborted the process or until the invite’s expiry time ran out.