GET
/
sales_milestones
curl --request GET \
  --url https://api.zivio.net/api/v3/sales_milestones \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>'
{
  "milestones": [
    {
      "id": "66",
      "client_suggested": "true",
      "title": "Title of Milestone",
      "details": "Details of Milestone",
      "rate": "1500.00",
      "ccy": "GBP",
      "due_on": "2023-11-07T05:31:56Z",
      "notes": "some notes relating to the milestone",
      "comments": "some comments relating to the milestone",
      "job_id": "2669",
      "job_summary": "summary of miestone",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "status": "open",
      "approved_at": "2023-11-07T05:31:56Z",
      "approved_by": {
        "id": "7158",
        "first_name": "Jack",
        "last_name": "Jones",
        "email": "jack_jones@example.com",
        "org_name": "Organisation Ltd",
        "org_id": "567",
        "business_unit": "Public Private Partnerships",
        "division": "Infastructure",
        "department": "Bridges",
        "vetting_status": "PASSED",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "custom_fields": {
          "key": "value"
        },
        "has_oversight": "<string>"
      },
      "children": [
        "124"
      ],
      "parents": [
        "14"
      ],
      "custom_fields": {
        "key": "value"
      }
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required
​
zivio-tenant-id
string
header
required

Query Parameters

​
status
string

Filter by a status, e.g. [open, submitted, approved, rejected, change_requested, on_hold, draft]

​
created
string

Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on created timestamp for object.

​
updated
string

Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on updated timestamp for object.

​
approved
string

Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on updated timestamp for object.

​
due_on
string

Date range [YYYY-MM-DD+TO+YYYY-MM-DD] to search based on updated timestamp for object.

​
sort
string

Results are sorted by created desc as default. Ordering may be specified, available options are ['approved', created', 'updated'], which can be combined in a comma separated list, e.g. approved:desc,updated:desc,created:asc

​
limit
integer

Number of results returned per request

​
page
integer

Paginate results when number of results exceeds limit

​
job_id
integer

Filter milestones by job id

​
supplier_id
integer

filter milestones by supplier id

Response

200
*/*
ok
​
milestones
object[]
Retrieve a sales invoice by IDRetrieve a sales milestone by ID