Klienci i kontrahenci
Klienci, kontakty i kontrahenci — utrzymuj CRM i Flowtly w synchronizacji.
Klient
Endpoints
| GET | /clients | Pobiera kolekcję zasobów Client. |
| POST | /clients | Tworzy zasób Client. |
| GET | /clients/{id} | Pobiera zasób Client. |
| PATCH | /clients/{id} | Aktualizuje zasób Client. |
| GET | /clients/{id}/documents | Pobiera zasób Client. |
| GET | /clients/search | Pobiera kolekcję zasobów Client. |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| country* | string (iri-reference) | |
| currency* | string (iri-reference) | |
| defaultCost | string,null (iri-reference) | |
| status* | string | |
| attributeSet | string,null (iri-reference) | |
| name* | string | |
| dueDays | integer | |
| tinType* | string | |
| tinCountry | stringnull | |
| tin | stringnull | |
| externalPaymentCustomerId | stringnull | |
| invoiceComment | stringnull | |
| defaultTaxRate | stringnull | |
| documentsLanguage | string | |
| addressPhoneNumber | stringnull | |
| addressCity | stringnull | |
| addressPostCode | stringnull | |
| addressStreetLine | stringnull | |
| addressBuildingNumber | stringnull | |
| addressLocaleNumber | stringnull | |
| addressCountry | string,null (iri-reference) | |
| clientContacts | array | |
| vatNumber | stringnull |
Kontakt klienta
Endpoints
| GET | /client-contacts | Pobiera kolekcję zasobów ClientContact. |
| POST | /client-contacts | Tworzy zasób ClientContact. |
| GET | /client-contacts/{id} | Pobiera zasób ClientContact. |
| PATCH | /client-contacts/{id} | Aktualizuje zasób ClientContact. |
| DELETE | /client-contacts/{id} | Usuwa zasób ClientContact. |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| id | integer | |
| client | string (iri-reference) | |
| type* | string | |
| position | integer | |
| email* | string (email) | |
| name* | string | |
| title | stringnull | |
| phone | stringnull | |
| createdAt | string (date-time) | |
| updatedAt | string (date-time) | |
| possibleTypes | string |
Notatka klienta
Endpoints
| GET | /client-notes | Pobiera kolekcję zasobów ClientNote. |
| POST | /client-notes | Tworzy zasób ClientNote. |
| GET | /client-notes/{id} | Pobiera zasób ClientNote. |
| PATCH | /client-notes/{id} | Aktualizuje zasób ClientNote. |
| DELETE | /client-notes/{id} | Usuwa zasób ClientNote. |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| id | string | |
| client* | string (iri-reference) | |
| employee* | string (iri-reference) | |
| note* | string | |
| createdAt | string (date-time) | |
| updatedAt | string (date-time) |
Kontrahent
Endpoints
| GET | /counterparties | Pobiera kolekcję zasobów Counterparty. |
| POST | /counterparties | Tworzy zasób Counterparty. |
| GET | /counterparties/{id} | Pobiera zasób Counterparty. |
| PATCH | /counterparties/{id} | Aktualizuje zasób Counterparty. |
| DELETE | /counterparties/{id} | Usuwa zasób Counterparty. |
| POST | /counterparties/{id}/enrich-branding-ai | Queue single counterparty branding enrich via AI |
| POST | /counterparties/{id}/merge | Merge counterparties |
| POST | /counterparties/enrich-branding-ai | Queue counterparties branding enrich via AI |
| POST | /counterparty | Create supplier/client + counterparty by type |
| PATCH | /counterparty/{id} | Update supplier/client + counterparty by type |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| id | integer | |
| type | string | |
| requireAttachment | boolean | |
| cyclic | boolean | |
| budgetNeutral | boolean | |
| logoUrl | stringnull | |
| corporateWebsiteUrl | stringnull | |
| displayName | string | |
| costGroupIcon | stringnull |
Konto bankowe kontrahenta
Endpoints
| POST | /counterparty-bank-accounts | Tworzy zasób CounterpartyBankAccount. |
| DELETE | /counterparty-bank-accounts/{id} | Usuwa zasób CounterpartyBankAccount. |
Pola schematu
| Pole | Typ | Opis |
|---|---|---|
| id | integer | |
| counterparty | string (iri-reference) | |
| accountNumber | string | |
| accountNumberNormalized | string | |
| createdAt | string (date-time) | |
| updatedAt | string (date-time) |