setBidPaymentSchedule

Requires permission biddesk:proposal:edit.

Sets a bid's whole payment schedule: one to twelve milestones whose shares add up to exactly one hundred percent. Refused with PAYMENT_SCHEDULE_INVALID, PAYMENT_SCHEDULE_NOT_100, PAYMENT_SCHEDULE_VERSION_REQUIRED or VERSION_CONFLICT. Requires Bid Desk and permission to edit proposals.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation SetBidPaymentSchedule($input: SetBidPaymentScheduleInput!) {
  setBidPaymentSchedule(input: $input) {
    bidId
    version
    items {
      dueDays
      label
      pct
      trigger
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetBidPaymentSchedule($input: SetBidPaymentScheduleInput!) {\n  setBidPaymentSchedule(input: $input) {\n    bidId\n    version\n    items {\n      dueDays\n      label\n      pct\n      trigger\n    }\n  }\n}",
  "variables": {
    "input": {
      "bidId": "id",
      "items": [
        {
          "label": "string",
          "pct": "string",
          "trigger": "ADVANCE"
        }
      ]
    }
  }
}
EOF

Variables:

{
  "input": {
    "bidId": "id",
    "items": [
      {
        "label": "string",
        "pct": "string",
        "trigger": "ADVANCE"
      }
    ]
  }
}

Response:

{
  "data": {
    "setBidPaymentSchedule": {
      "bidId": "id",
      "version": 0,
      "items": [
        {
          "dueDays": 0,
          "label": "string",
          "pct": "string",
          "trigger": "ADVANCE"
        }
      ]
    }
  }
}

setBidPaymentSchedule(
  input: SetBidPaymentScheduleInput!
): BidPaymentSchedule!

Arguments

setBidPaymentSchedule.input ● SetBidPaymentScheduleInput! non-null input

The bid, its schedule's version and the milestones.

Type

BidPaymentSchedule object

A bid's payment schedule; its shares add up to exactly one hundred percent.