documentNumberLastIssued

Requires at least one of the permissions settings:documents:update or settings:tenant:read.

Returns the last document number issued for a document type across all periods, such as the latest invoice or quote number, or null when none has been issued. Requires permission to read tenant settings or to update document settings.

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 DocumentNumberLastIssued($docType: DocumentNumberType!) {
  documentNumberLastIssued(docType: $docType)
}

cURL

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

Variables:

{
  "docType": "COLLECTION"
}

Response:

{
  "data": {
    "documentNumberLastIssued": "string"
  }
}

documentNumberLastIssued(
  docType: DocumentNumberType!
): String

Arguments

documentNumberLastIssued.docType ● DocumentNumberType! non-null enum

The document type to look up.

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.