exportBidCostSheetXlsx

Requires permission biddesk:cost_sheet:read.

Downloads a cost sheet as an Excel workbook: one row per line with its quantity, currency, rate, source, reference, date and age in days; unit costs and manual reasons only with permission to view costs. Encrypted with a one-time password when the organization requires encrypted exports. Requires Bid Desk and permission to read cost sheets.

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 ExportBidCostSheetXlsx($costSheetId: ID!) {
  exportBidCostSheetXlsx(costSheetId: $costSheetId) {
    fileName
    byteSize
    contentBase64
    password
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation ExportBidCostSheetXlsx($costSheetId: ID!) {\n  exportBidCostSheetXlsx(costSheetId: $costSheetId) {\n    fileName\n    byteSize\n    contentBase64\n    password\n  }\n}",
  "variables": {
    "costSheetId": "id"
  }
}
EOF

Variables:

{
  "costSheetId": "id"
}

Response:

{
  "data": {
    "exportBidCostSheetXlsx": {
      "fileName": "string",
      "byteSize": 0,
      "contentBase64": "string",
      "password": "string"
    }
  }
}

exportBidCostSheetXlsx(
  costSheetId: ID!
): BidXlsxFile!

Arguments

exportBidCostSheetXlsx.costSheetId ● ID! non-null scalar

The cost sheet.

Type

BidXlsxFile object

A generated workbook. When the organization requires encrypted exports, it opens only with password, shown once here.