customerStatementPdf

Requires a customer (portal or buyer app) session.

Base64 PDF rendering of customerStatement (same numbers — /8). screen 11.

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 CustomerStatementPdf($from: DateTime!, $to: DateTime!) {
  customerStatementPdf(from: $from, to: $to)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query CustomerStatementPdf($from: DateTime!, $to: DateTime!) {\n  customerStatementPdf(from: $from, to: $to)\n}",
  "variables": {
    "from": "2025-01-15T00:00:00Z",
    "to": "2025-01-15T00:00:00Z"
  }
}
EOF

Variables:

{
  "from": "2025-01-15T00:00:00Z",
  "to": "2025-01-15T00:00:00Z"
}

Response:

{
  "data": {
    "customerStatementPdf": "string"
  }
}

customerStatementPdf(
  from: DateTime!
  to: DateTime!
): String!

Arguments

customerStatementPdf.from ● DateTime! non-null scalar

The first day of the statement.

customerStatementPdf.to ● DateTime! non-null scalar

The last day of the statement.

Type

String scalar

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.