Letter
Represents information about a letter.
type Letter {
id: ID!
correspondenceId: String
externalId: String
correspondenceNumber: String
sequenceNumber: String
number: String
subject: String
clarification: String
body: String
status: RelatedStatusType
sentAt: Date
dueAt: Date
direction: LetterDirection
type: LetterType
source: LetterSource
isComplete: Boolean
canEditBody: Boolean
parent: Letter
comments: [Comment!]!
followers: [User!]
creator: User
createdAt: DateTimeTz!
updatedAt: DateTimeTz!
completedAt: DateTimeTz
deletedAt: DateTimeTz
members(
where: LetterMembersWhereWhereConditions
orderBy: [LetterMembersOrderByOrderByClause!]
first: Int! = 10
after: String
): LetterMembersEdgeConnection!
responsible(first: Int! = 10, after: String): LetterMembersEdgeConnection!
contacts(
where: LetterContactsWhereWhereConditions
orderBy: [LetterContactsOrderByOrderByClause!]
first: Int! = 10
after: String
): ContactConnection!
easements(
where: LetterEasementsWhereWhereConditions
orderBy: [LetterEasementsOrderByOrderByClause!]
first: Int! = 10
after: String
): EasementConnection!
properties(
where: LetterPropertiesWhereWhereConditions
orderBy: [LetterPropertiesOrderByOrderByClause!]
first: Int! = 10
after: String
): PropertyConnection!
projects(
where: LetterProjectsWhereWhereConditions
orderBy: [LetterProjectsOrderByOrderByClause!]
first: Int! = 10
after: String
): ProjectConnection!
tasks(
where: LetterTasksWhereWhereConditions
orderBy: [LetterTasksOrderByOrderByClause!]
first: Int! = 10
after: String
): TaskConnection!
coordinations(
where: LetterCoordinationsWhereWhereConditions
orderBy: [LetterCoordinationsOrderByOrderByClause!]
first: Int! = 10
after: String
): CoordinationConnection!
specifications(
where: LetterSpecificationsWhereWhereConditions
orderBy: [LetterSpecificationsOrderByOrderByClause!]
first: Int! = 10
after: String
): SpecificationConnection!
ordinances(
where: LetterOrdinancesWhereWhereConditions
orderBy: [LetterOrdinancesOrderByOrderByClause!]
first: Int! = 10
after: String
): OrdinanceConnection!
contracts(
where: LetterContractsWhereWhereConditions
orderBy: [LetterContractsOrderByOrderByClause!]
first: Int! = 10
after: String
): ContractConnection!
submissions(
where: LetterSubmissionsWhereWhereConditions
orderBy: [LetterSubmissionsOrderByOrderByClause!]
first: Int! = 10
after: String
): SubmissionConnection!
meters(
where: LetterMetersWhereWhereConditions
orderBy: [LetterMetersOrderByOrderByClause!]
first: Int! = 10
after: String
): MeterConnection!
invoices(
where: LetterInvoicesWhereWhereConditions
orderBy: [LetterInvoicesOrderByOrderByClause!]
first: Int! = 10
after: String
): InvoiceConnection!
files(
where: LetterFilesWhereWhereConditions
orderBy: [LetterFilesOrderByOrderByClause!]
first: Int! = 10
after: String
): FileConnection!
}
Fields
Letter.id ● ID! non-null scalar
Letter's unique identifier.
Letter.correspondenceId ● String scalar
Letter's correspondence unique identifier.
Letter.externalId ● String scalar
Letter's external unique identifier.
Letter.correspondenceNumber ● String scalar
Letter's correspondence number.
Letter.sequenceNumber ● String scalar
Letter's sequence number.
Letter.number ● String scalar
The letter's number.
Letter.subject ● String scalar
The letter's subject.
Letter.clarification ● String scalar
The letter's clarification.
Letter.body ● String scalar
The letter's body.
Letter.status ● RelatedStatusType object
The letter's status.
Letter.sentAt ● Date scalar
Sent date of the letter.
Letter.dueAt ● Date scalar
Due date of the letter.
Letter.direction ● LetterDirection enum
The letter's direction.
Letter.type ● LetterType object
The letter's type.
Letter.source ● LetterSource object
The letter's source.
Letter.isComplete ● Boolean scalar
Determine whether the letter is completed.
Letter.canEditBody ● Boolean scalar
Determine whether the letter's body can be edited.
Letter.parent ● Letter object
The parent letter.
Letter.comments ● [Comment!]! non-null object
The letter's comments.
Letter.followers ● [User!] list object
The letter's followers.
Letter.creator ● User object
The user who created this letter.
Letter.createdAt ● DateTimeTz! non-null scalar
The date and time when the letter was created.
Letter.updatedAt ● DateTimeTz! non-null scalar
The date and time when the letter was last updated.
Letter.completedAt ● DateTimeTz scalar
The date and time when the letter was completed.
Letter.deletedAt ● DateTimeTz scalar
The date and time when the letter was deleted.
Letter.members ● LetterMembersEdgeConnection! non-null object
The letter's members.
Letter.members.where ● LetterMembersWhereWhereConditions input
Letter.members.orderBy ● [LetterMembersOrderByOrderByClause!] list input
Letter.members.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.members.after ● String scalar
A cursor after which elements are returned.
Letter.responsible ● LetterMembersEdgeConnection! non-null object
The letter's responsible member.
Letter.responsible.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.responsible.after ● String scalar
A cursor after which elements are returned.
Letter.contacts ● ContactConnection! non-null object
The letter's contacts.
Letter.contacts.where ● LetterContactsWhereWhereConditions input
Letter.contacts.orderBy ● [LetterContactsOrderByOrderByClause!] list input
Letter.contacts.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.contacts.after ● String scalar
A cursor after which elements are returned.
Letter.easements ● EasementConnection! non-null object
A list of easements associated with the letter.
Letter.easements.where ● LetterEasementsWhereWhereConditions input
Letter.easements.orderBy ● [LetterEasementsOrderByOrderByClause!] list input
Letter.easements.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.easements.after ● String scalar
A cursor after which elements are returned.
Letter.properties ● PropertyConnection! non-null object
A list of properties associated with the letter.
Letter.properties.where ● LetterPropertiesWhereWhereConditions input
Letter.properties.orderBy ● [LetterPropertiesOrderByOrderByClause!] list input
Letter.properties.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.properties.after ● String scalar
A cursor after which elements are returned.
Letter.projects ● ProjectConnection! non-null object
A list of projects associated with the letter.
Letter.projects.where ● LetterProjectsWhereWhereConditions input
Letter.projects.orderBy ● [LetterProjectsOrderByOrderByClause!] list input
Letter.projects.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.projects.after ● String scalar
A cursor after which elements are returned.
Letter.tasks ● TaskConnection! non-null object
The property's tasks.
Letter.tasks.where ● LetterTasksWhereWhereConditions input
Letter.tasks.orderBy ● [LetterTasksOrderByOrderByClause!] list input
Letter.tasks.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.tasks.after ● String scalar
A cursor after which elements are returned.
Letter.coordinations ● CoordinationConnection! non-null object
A list of coordinations associated with the letter.
Letter.coordinations.where ● LetterCoordinationsWhereWhereConditions input
Letter.coordinations.orderBy ● [LetterCoordinationsOrderByOrderByClause!] list input
Letter.coordinations.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.coordinations.after ● String scalar
A cursor after which elements are returned.
Letter.specifications ● SpecificationConnection! non-null object
A list of specifications associated with the letter.
Letter.specifications.where ● LetterSpecificationsWhereWhereConditions input
Letter.specifications.orderBy ● [LetterSpecificationsOrderByOrderByClause!] list input
Letter.specifications.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.specifications.after ● String scalar
A cursor after which elements are returned.
Letter.ordinances ● OrdinanceConnection! non-null object
A list of ordinances associated with the letter.
Letter.ordinances.where ● LetterOrdinancesWhereWhereConditions input
Letter.ordinances.orderBy ● [LetterOrdinancesOrderByOrderByClause!] list input
Letter.ordinances.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.ordinances.after ● String scalar
A cursor after which elements are returned.
Letter.contracts ● ContractConnection! non-null object
A list of contracts associated with the letter.
Letter.contracts.where ● LetterContractsWhereWhereConditions input
Letter.contracts.orderBy ● [LetterContractsOrderByOrderByClause!] list input
Letter.contracts.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.contracts.after ● String scalar
A cursor after which elements are returned.
Letter.submissions ● SubmissionConnection! non-null object
A list of submissions associated with the letter.
Letter.submissions.where ● LetterSubmissionsWhereWhereConditions input
Letter.submissions.orderBy ● [LetterSubmissionsOrderByOrderByClause!] list input
Letter.submissions.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.submissions.after ● String scalar
A cursor after which elements are returned.
Letter.meters ● MeterConnection! non-null object
A list of meters associated with the letter.
Letter.meters.where ● LetterMetersWhereWhereConditions input
Letter.meters.orderBy ● [LetterMetersOrderByOrderByClause!] list input
Letter.meters.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.meters.after ● String scalar
A cursor after which elements are returned.
Letter.invoices ● InvoiceConnection! non-null object
A list of invoices associated with the letter.
Letter.invoices.where ● LetterInvoicesWhereWhereConditions input
Letter.invoices.orderBy ● [LetterInvoicesOrderByOrderByClause!] list input
Letter.invoices.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.invoices.after ● String scalar
A cursor after which elements are returned.
Letter.files ● FileConnection! non-null object
The letter's files.
Letter.files.where ● LetterFilesWhereWhereConditions input
Letter.files.orderBy ● [LetterFilesOrderByOrderByClause!] list input
Letter.files.first ● Int! non-null scalar
Limits number of fetched items. Maximum allowed value: 50.
Letter.files.after ● String scalar
A cursor after which elements are returned.
Returned By
createLetter mutation ● deleteLetter mutation ● duplicateLetter mutation ● letter query ● restoreLetter mutation ● updateLetter mutation
Member Of
Correspondence object ● Letter object ● LetterEdge object