TRANXACT.AI Help

Accounting · Projects & Portfolios

Milestones

A billing milestone is what turns delivery into an invoice — the join between the plan and the cash.

Type REST11 operationsBase path /api/accounting/project-milestonesPublished as /api/v1/project-milestones

Download specification (OpenAPI 3.1) Screen: Milestones

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Accounting › Milestones on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tableacct.project_milestones · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

11 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/accounting/project-milestonesList milestones

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "milestone_no": "MIL-000001",
      "name": "Example",
      "milestone_type": "text",
      "planned_date": "2026-10-30",
      "forecast_date": "2026-10-30",
      "actual_date": "2026-10-30",
      "billing_pct": "1250.00",
      "billing_amount": "1250.00",
      "currency": "USD",
      "progress_pct": "1250.00"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/project-milestones?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/project-milestones/{id}Read one project milestone

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "milestone_no": "MIL-000001",
  "name": "Example",
  "milestone_type": "text",
  "planned_date": "2026-10-30",
  "forecast_date": "2026-10-30",
  "actual_date": "2026-10-30",
  "billing_pct": "1250.00",
  "billing_amount": "1250.00",
  "currency": "USD",
  "progress_pct": "1250.00"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/project-milestones/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/project-milestonesCreate a project milestone

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
project_iduuidYesProject
wbs_element_iduuidNoWork breakdown element
milestone_notextYesNumber
nametextYesName
milestone_typetextNoType
planned_datedateNoPlanned
forecast_datedateNoForecast
actual_datedateNoAchieved
billing_pctnumericNoBills % of contract
billing_amountnumericNoBills amount
currencytextNoCurrency
progress_pctnumericNoProgress %
ar_invoice_iduuidNoAr invoice id
rev_billing_iduuidNoRev billing id
notestextNoNotes

Sample body

{
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "milestone_no": "MIL-000001",
  "name": "Example",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "milestone_type": "text",
  "planned_date": "2026-10-30",
  "forecast_date": "2026-10-30"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "milestone_no": "MIL-000001",
  "name": "Example",
  "milestone_type": "text",
  "planned_date": "2026-10-30",
  "forecast_date": "2026-10-30",
  "actual_date": "2026-10-30",
  "billing_pct": "1250.00",
  "billing_amount": "1250.00",
  "currency": "USD",
  "progress_pct": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/project-milestones" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","milestone_no":"MIL-000001","name":"Example","wbs_element_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","milestone_type":"text","planned_date":"2026-10-30","forecast_date":"2026-10-30"}'
PUT/api/accounting/project-milestones/{id}Change a project milestone

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
project_iduuidYesProject
wbs_element_iduuidNoWork breakdown element
milestone_notextYesNumber
nametextYesName
milestone_typetextNoType
planned_datedateNoPlanned
forecast_datedateNoForecast
actual_datedateNoAchieved
billing_pctnumericNoBills % of contract
billing_amountnumericNoBills amount
currencytextNoCurrency
progress_pctnumericNoProgress %
ar_invoice_iduuidNoAr invoice id
rev_billing_iduuidNoRev billing id
notestextNoNotes

Sample body

{
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "milestone_no": "MIL-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "project_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wbs_element_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "milestone_no": "MIL-000001",
  "name": "Example",
  "milestone_type": "text",
  "planned_date": "2026-10-30",
  "forecast_date": "2026-10-30",
  "actual_date": "2026-10-30",
  "billing_pct": "1250.00",
  "billing_amount": "1250.00",
  "currency": "USD",
  "progress_pct": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/project-milestones/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","milestone_no":"MIL-000001"}'
DELETE/api/accounting/project-milestones/{id}Delete a project milestone

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/accounting/project-milestones/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/project-milestones/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/project-milestones/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/accounting/project-milestones/{id}/achieveAchieve

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

actualDate

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/project-milestones/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/achieve" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"actualDate":"value"}'
POST/api/accounting/project-milestones/{id}/confirmConfirm

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/project-milestones/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/confirm" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/project-milestones/{id}/invoiceInvoice

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

arInvoiceId

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/project-milestones/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/invoice" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"arInvoiceId":"value"}'
POST/api/accounting/project-milestones/{id}/missMiss

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

forecastDate

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/project-milestones/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/miss" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"forecastDate":"value"}'
POST/api/accounting/project-milestones/{id}/cancelCancel

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

reason

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/project-milestones/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'

Data model

Every field of a project milestone, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
project_iduuidread, writeProject
wbs_element_iduuidread, writeWork breakdown element
milestone_notextread, writeNumber
nametextread, writeName
milestone_typetextread, writeType
planned_datedateread, writePlanned
forecast_datedateread, writeForecast
actual_datedateread, writeAchieved
billing_pctnumericread, writeBills % of contract
billing_amountnumericread, writeBills amount
currencytextread, writeCurrency
progress_pctnumericread, writeProgress %
ar_invoice_iduuidread, writeAr invoice id
rev_billing_iduuidread, writeRev billing id
statustextread onlyStatus
confirmed_byuuidread onlyConfirmed by
confirmed_attimestamp with time zoneread onlyConfirmed at
notestextread, writeNotes
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
achieved_attimestamp with time zoneread onlyAchieved at

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › Milestones for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.