Milestones

Add a milestone

Adds work a contractor is to be paid for, checked by the rules of the console's Add milestone form, and recorded in the ledger as create_milestone with via: "api" and the key's id. It is added as the key's issuer's: if the agent holds it on its own judgment, someone other than the issuer must choose Pay now, unless the issuer is the workspace's only approver.

It starts pending, and the API cannot verify it. A GitHub pull request in verificationSource is checked by the agent, which verifies the milestone once the pull request is merged; any other link is evidence for the person who verifies it on Contractors. Once it is verified, the agent decides the payment with every guardrail, and pays only to the contractor's confirmed address. A contractorId the workspace does not hold, or a client's, answers 400.

post/api/v1/milestones

Request

  • Base URL: https://www.vestiarion.xyz
  • URL: https://www.vestiarion.xyz/api/v1/milestones
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Makes a retry safe: up to 255 printable ASCII characters, unique to the record being added, such as its id in your own system. A repeat with the same key and the same body within 24 hours gets the first answer back, with Idempotent-Replayed: true, and adds nothing. The same key with a different body answers 409.

Request body

contractorIdstring required

The id of the contractor or vendor to pay, from GET /api/v1/counterparties or from the answer that added it. A client is not paid for milestones.

titlestring required

What was delivered, 3 to 160 characters.

verificationSourcestring

A link to the delivered work: https, up to 500 characters. A GitHub pull request (https://github.com/<owner>/<repo>/pull/<number>) is checked by the agent, which verifies the milestone once it is merged. Any other link is evidence for the person who verifies the milestone on Contractors.

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.