builtinDocumentTemplate

Requires permission settings:documents:read.

The Liquid source of the template ARC ships for a document type.

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 BuiltinDocumentTemplate($docType: String!) {
  builtinDocumentTemplate(docType: $docType)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BuiltinDocumentTemplate($docType: String!) {\n  builtinDocumentTemplate(docType: $docType)\n}",
  "variables": {
    "docType": "string"
  }
}
EOF

Variables:

{
  "docType": "string"
}

Response:

{
  "data": {
    "builtinDocumentTemplate": "string"
  }
}

builtinDocumentTemplate(
  docType: String!
): String!

Arguments

builtinDocumentTemplate.docType ● String! non-null scalar

The document type, e.g. invoice.

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.