Umowy, kontrakty, załączniki i harmonogramy płatności — automatyzuj procesy umowne.
Umowa
Endpoints
GET
/agreements
Pobiera kolekcję zasobów Agreement.
POST
/agreements
Tworzy zasób Agreement.
GET
/agreements/{id}
Pobiera zasób Agreement.
PATCH
/agreements/{id}
Aktualizuje zasób Agreement.
GET
/agreements/action-needed
Pobiera kolekcję zasobów Agreement.
GET
/agreements/without-file
Pobiera kolekcję zasobów Agreement.
GET
/agreements/without-file/active
Pobiera kolekcję zasobów Agreement.
Pola schematu
Pole
Typ
Opis
employee
string,null (iri-reference)
type
string
variant
string
amount
number
minutesPerWeek
integer
jobSize
integer
amountType
string
billingType
string
positionName
stringnull
position
string,null (iri-reference)
dateFrom
string (date-time)
dateTo
string,null (date-time)
currency
string (iri-reference)
cost
string,null (iri-reference)
hoursPerWeek
integer
Umowa
Endpoints
GET
/contracts
Pobiera kolekcję zasobów Contract.
POST
/contracts
Tworzy zasób Contract.
GET
/contracts/{id}
Pobiera zasób Contract.
PATCH
/contracts/{id}
Aktualizuje zasób Contract.
DELETE
/contracts/{id}
Usuwa zasób Contract.
GET
/contracts/{id}/documents
Pobiera zasób Contract.
POST
/contracts/{id}/invoice-from-virtual-line
Create an Invoice from a virtual (unmaterialized) row of a recurring contract's schedule preview.
POST
/contracts/{id}/send-for-signature
Send the contract's existing uploaded document to the signature middleware.
GET
/contracts/{id}/signature-status
Live per-signer signing status for a contract.
Pola schematu
Pole
Typ
Opis
name
string
direction
string
counterparty
string,null (iri-reference)
project
string,null (iri-reference)
currency
string (iri-reference)
totalAmount
stringnull
dateFrom
string,null (date-time)
dateTo
string,null (date-time)
cyclic
boolean
Marks the contract as a recurring/ongoing relationship rather than a
one-shot deal — e.g. a monthly retainer, ongoing security service, or
indefinite tenancy. When true, dateTo is conventionally left null
(open-ended) until the contract is actually terminated. The flag is
advisory: the system doesn't auto-generate PaymentScheduleLines from
a cadence; consumers (UI badges, calendar rendering) decide how to
present cyclic contracts.
notes
stringnull
description
stringnull
signatureEnvelopeId
stringnull
signatureStatus
stringnull
signatureSentAt
string,null (date-time)
signatureCompletedAt
string,null (date-time)
Załącznik umowy
Endpoints
GET
/contract-attachments
Pobiera kolekcję zasobów ContractAttachment.
POST
/contract-attachments
Tworzy zasób ContractAttachment.
GET
/contract-attachments/{id}
Pobiera zasób ContractAttachment.
POST
/contract-attachments/{id}/mark-reviewed
Tworzy zasób ContractAttachment.
GET
/contract-attachments/{id}/preview
Preview contract attachment file
POST
/contract-attachments/{id}/reanalyze
Tworzy zasób ContractAttachment.
POST
/contract-attachments/create-base64
Tworzy zasób ContractAttachment.
Pola schematu
Pole
Typ
Opis
id
string
contract
string (iri-reference)
organizationId
string
Organization is mapped on a separate EntityManager (central DB), so a
Doctrine ManyToOne would reference an entity the default EM cannot
resolve and any query touching this row would 500 with a
MappingException. Store the organization ID as a plain VARCHAR(8)
column instead — the same shape the migration already defined and the
pattern the rest of `src/Entity/` uses for cross-EM references. Resolve
the actual Organization entity via OrganizationRepository (central EM)
at the call site.
filename
string
mimeType
string
size
integer
storagePath
string
status
string
kind
string
analysisResult
arraynull
analysisSummary
arraynull
reviewedAt
string,null (date-time)
createdAt
string (date-time)
updatedAt
string (date-time)
contractId
stringnull
Surfaces the linked contract's id in the response so the FE can
navigate to /contracts/{id} after a successful upload. The
ManyToOne `$contract` field itself stays unexposed (no Groups) to
keep the contract-attachment:read payload narrow — exposing the
full Contract entity here would leak unrelated fields and require
an extra serialization group.
file
string
Pozycja harmonogramu płatności
Endpoints
GET
/contracts/{contractId}/payment-schedule-lines
Pobiera kolekcję zasobów PaymentScheduleLine.
GET
/payment-schedule-lines
Pobiera kolekcję zasobów PaymentScheduleLine.
POST
/payment-schedule-lines
Tworzy zasób PaymentScheduleLine.
GET
/payment-schedule-lines/{id}
Pobiera zasób PaymentScheduleLine.
PATCH
/payment-schedule-lines/{id}
Aktualizuje zasób PaymentScheduleLine.
DELETE
/payment-schedule-lines/{id}
Usuwa zasób PaymentScheduleLine.
POST
/payment-schedule-lines/{id}/invoice
Create an Invoice from this contract schedule line.
Pola schematu
Pole
Typ
Opis
id
string
date
string (date-time)
amount
string
note
stringnull
source
string
invoice
mixed
Inverse side of Invoice.paymentScheduleLine. Read-only — set when the
"Create invoice" button issues an Invoice from this line; the unique
index on the owning side guarantees at most one Invoice per line.