Contracts

All endpoints on this page require a tenant bearer token. See Roles & Permissions for what each @Perm module/level means.

List contracts

GET /contracts · requires contract_view (view)

integer

default:"1"

integer

default:"20"

Max 200.

string

Free-text search.

string

sale | lease

string

Custom contract type code, if configured.

string

in_progress | completed

string

unpaid | partial | paid

string

One of draft, extracted, review, approved, signed, active, completed, archived.

string

boolean

string

default:"asc"

asc | desc

Get a contract

GET /contracts/:id · requires contract_view (view)

Create a contract

POST /contracts · requires contract_edit (edit)

string

required

string

required

string

required

string

sale | lease

string

required

string

required

string

required

string

required

string

required

integer

required

Minimum 1.

number

required

Minimum 0.

number

Minimum 0.

string

required

string

number

string

ISO date.

string

required

ISO date.

string

required

ISO date.

integer

string

File reference.

string

in_progress | completed

string

required

string

object

Custom field values keyed by field id.

string

string[]

array

Initial payment plan lines — see Add a payment line for the shape of each entry.

array

See Add a term note.

array

{ label, value }[]

curl -X POST https://api.alforse.com/api/v1/contracts \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "archiveCode": "A-2026-001",
    "contractNo": "C-2026-001",
    "projectName": "Excavator lease — north yard",
    "subjectId": "sub_123",
    "partyA": "Acme Leasing",
    "partyB": "Northline Construction",
    "equipmentName": "Excavator",
    "equipmentModel": "CAT-320",
    "quantity": 1,
    "unitPrice": 250000,
    "paymentMethod": "bank_transfer",
    "startDate": "2026-08-01",
    "endDate": "2027-08-01",
    "ownerId": "usr_456"
  }'

Update a contract

PATCH /contracts/:id · requires contract_edit (edit) Same fields as create, all optional.

Delete a contract

DELETE /contracts/:id · requires contract_delete (edit)

Bulk operations

Endpoint	Body	Requires
`POST /contracts/bulk-delete`	`{ ids: string[] }` (max 1000)	`contract_delete` (edit)
`POST /contracts/bulk-attachment`	`{ ids: string[], contractAttachment: string }`	`contract_edit` (edit)

Import and export

Endpoint	Body	Requires
`POST /contracts/import`	`{ rows: CreateContractDto[] }`	`contract_edit` (edit)
`GET /contracts/export`	Same query params as List, plus `ids?: string[]` and `profile: "summary" \| "full"`	`export` (edit)
`POST /contracts/export`	Same fields as the `GET` variant, in the body — use this when your filter/id list is too long for a query string	`export` (edit)

Both export endpoints respond with Content-Type: text/csv; charset=utf-8.

OCR extraction

Endpoint	Body	Requires
`POST /contracts/extract`	`{ contractId?, fileRef?, fileName?, text? }`	`contract_edit` (edit)
`PATCH /contracts/extractions/:runId/review`	`{ fields: { fieldKey, status: "accepted" \| "overridden" \| "rejected", overrideValue? }[], applyToContract?, metadata? }`	`contract_edit` (edit)

See Contract Intake for how this fits into the upload flow.

Add a note

POST /contracts/:id/notes · requires contract_edit (edit)

string

required

string

required

Add a term note

POST /contracts/:id/terms · requires contract_edit (edit)

string

required

string

required

string

ISO date.

string

required

Add a payment line

POST /contracts/:id/payments · requires payment_entry (edit)

string

required

string

required

ISO date.

number

required

Minimum 0.

string

number

string

pending | matched | exception

string

number

string

For updating a payment that already exists (rather than adding a new line), see Payments.

Fulfillment tasks

Endpoint	Body	Requires
`POST /contracts/:id/fulfillment-tasks`	`{ code, title, kind?, status?, ownerId?, dueDate?, acceptanceStatus?, attachment?, metadata? }`	`contract_edit` (edit)
`PATCH /contracts/:id/fulfillment-tasks/:taskId`	Same fields, all optional	`contract_edit` (edit)

status is one of pending, in_progress, completed, accepted, blocked, canceled, overdue.

Add an invoice record

POST /contracts/:id/invoices · requires invoice (edit)

string

required

number

required

Minimum 0.

string

draft | issued | void | red_letter

string

number

string

Get Started

Tenant API

List contracts

Get a contract

Create a contract

Update a contract

Delete a contract

Bulk operations

Import and export

OCR extraction

Add a note

Add a term note

Add a payment line

Fulfillment tasks

Add an invoice record

​List contracts

​Get a contract

​Create a contract

​Update a contract

​Delete a contract

​Bulk operations

​Import and export

​OCR extraction

​Add a note

​Add a term note

​Add a payment line

​Fulfillment tasks

​Add an invoice record

List contracts

Get a contract

Create a contract

Update a contract

Delete a contract

Bulk operations

Import and export

OCR extraction

Add a note

Add a term note

Add a payment line

Fulfillment tasks

Add an invoice record