bidPaymentSchedule

Requires permission biddesk:bid:read.

A bid's payment schedule, or null before one is set. Requires Bid Desk and permission to read bids.

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

query BidPaymentSchedule($bidId: ID!) {
  bidPaymentSchedule(bidId: $bidId) {
    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": "query BidPaymentSchedule($bidId: ID!) {\n  bidPaymentSchedule(bidId: $bidId) {\n    bidId\n    version\n    items {\n      dueDays\n      label\n      pct\n      trigger\n    }\n  }\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

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

bidPaymentSchedule(
  bidId: ID!
): BidPaymentSchedule

Arguments

bidPaymentSchedule.bidId ● ID! non-null scalar

The bid.

Type

BidPaymentSchedule object

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