documentTemplateConfig

Requires permission settings:documents:read.

The saved document template config for a document type (null if unset).

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 DocumentTemplateConfig($documentType: String!) {
  documentTemplateConfig(documentType: $documentType) {
    id
    companyName
    accentColor
    companyAddress
    documentType
    footerText
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DocumentTemplateConfig($documentType: String!) {\n  documentTemplateConfig(documentType: $documentType) {\n    id\n    companyName\n    accentColor\n    companyAddress\n    documentType\n    footerText\n  }\n}",
  "variables": {
    "documentType": "string"
  }
}
EOF

Variables:

{
  "documentType": "string"
}

Response:

{
  "data": {
    "documentTemplateConfig": {
      "id": "id",
      "companyName": "string",
      "accentColor": "string",
      "companyAddress": "string",
      "documentType": "string",
      "footerText": "string"
    }
  }
}

documentTemplateConfig(
  documentType: String!
): DocumentTemplateConfig

Arguments

documentTemplateConfig.documentType ● String! non-null scalar

The kind of document, for example a quote or an invoice.

Type

DocumentTemplateConfig object

The organization's setup of one document template.