OBJECT

Document

A Document which can be any form of document (invoice, delivery note, statement, etc.).

link GraphQL Schema definition

  • type Document implements Node {
  • # A globally unique identifier. Can be used in various places throughout the
  • # system to identify this single value.
  • id: ID!
  • rowId: UUID!
  • type: DocumentType!
  • categoryRowId: UUID!
  • clientCompanyRowId: UUID!
  • baseDocumentRowId: UUID
  • title: String
  • name: String!
  • language: LanguageCode!
  • version: Datetime
  • numPages: Int!
  • numAttachPages: Int!
  • workflowStepRowId: UUID
  • importedBy: UUID!
  • importedAt: Datetime!
  • sourceDate: Datetime!
  • source: String!
  • sourceRowId: String!
  • sourceFile: String!
  • sourceFileHash: String!
  • fulltext: String!
  • archived: Boolean!
  • supersedes: UUID
  • rearrangedAt: Datetime
  • rearrangedBy: UUID
  • pagesConfirmedAt: Datetime
  • pagesConfirmedBy: UUID
  • updatedAt: UpdatedTime!
  • createdAt: CreatedTime!
  • tags: [String]
  • # Reads a single `DocumentCategory` that is related to this `Document`.
  • documentCategoryByCategoryRowId: DocumentCategory!
  • # Reads a single `ClientCompany` that is related to this `Document`.
  • clientCompanyByClientCompanyRowId: ClientCompany!
  • # Reads a single `Document` that is related to this `Document`.
  • documentByBaseDocumentRowId: Document
  • # Reads a single `DocumentWorkflowStep` that is related to this `Document`.
  • documentWorkflowStepByWorkflowStepRowId: DocumentWorkflowStep
  • # Reads a single `User` that is related to this `Document`.
  • userByImportedBy: User!
  • # Reads a single `User` that is related to this `Document`.
  • userByRearrangedBy: User
  • # Reads a single `DeletedDocument` that is related to this `Document`.
  • deletedDocumentBySupersedes: DeletedDocument
  • # Reads a single `User` that is related to this `Document`.
  • userByPagesConfirmedBy: User
  • # Reads and enables pagination through a set of `BankTransaction`.
  • #
  • # Arguments
  • # first: Only read the first `n` values of the set.
  • # last: Only read the last `n` values of the set.
  • # offset: Skip the first `n` values from our `after` cursor, an
  • # alternative to cursor
  • # based pagination. May not be used with `last`.
  • # before: Read all values in the set before (above) this cursor.
  • # after: Read all values in the set after (below) this cursor.
  • # orderBy: The method to use when ordering `BankTransaction`.
  • # condition: A condition to be used in determining which values
  • # should be returned by the collection.
  • bankTransactionsByImportDocumentRowId(
  • first: Int,
  • last: Int,
  • offset: Int,
  • before: Cursor,
  • after: Cursor,
  • orderBy: [BankTransactionsOrderBy!],
  • condition: BankTransactionCondition
  • ): BankTransactionsConnection!
  • # Reads and enables pagination through a set of `CreditCardTransaction`.
  • #
  • # Arguments
  • # first: Only read the first `n` values of the set.
  • # last: Only read the last `n` values of the set.
  • # offset: Skip the first `n` values from our `after` cursor, an
  • # alternative to cursor
  • # based pagination. May not be used with `last`.
  • # before: Read all values in the set before (above) this cursor.
  • # after: Read all values in the set after (below) this cursor.
  • # orderBy: The method to use when ordering
  • # `CreditCardTransaction`.
  • # condition: A condition to be used in determining which values
  • # should be returned by the collection.
  • creditCardTransactionsByImportDocumentRowId(
  • first: Int,
  • last: Int,
  • offset: Int,
  • before: Cursor,
  • after: Cursor,
  • orderBy: [CreditCardTransactionsOrderBy!],
  • condition: CreditCardTransactionCondition
  • ): CreditCardTransactionsConnection!
  • # Reads and enables pagination through a set of `DeletedDocument`.
  • #
  • # Arguments
  • # first: Only read the first `n` values of the set.
  • # last: Only read the last `n` values of the set.
  • # offset: Skip the first `n` values from our `after` cursor, an
  • # alternative to cursor
  • # based pagination. May not be used with `last`.
  • # before: Read all values in the set before (above) this cursor.
  • # after: Read all values in the set after (below) this cursor.
  • # orderBy: The method to use when ordering `DeletedDocument`.
  • # condition: A condition to be used in determining which values
  • # should be returned by the collection.
  • deletedDocumentsByBaseDocumentRowId(
  • first: Int,
  • last: Int,
  • offset: Int,
  • before: Cursor,
  • after: Cursor,
  • orderBy: [DeletedDocumentsOrderBy!],
  • condition: DeletedDocumentCondition
  • ): DeletedDocumentsConnection!
  • # Reads a single `DeliveryNote` that is related to this `Document`.
  • deliveryNoteByDocumentRowId: DeliveryNote
  • # Reads and enables pagination through a set of `DeliveryNote`.
  • #
  • # Arguments
  • # first: Only read the first `n` values of the set.
  • # last: Only read the last `n` values of the set.
  • # offset: Skip the first `n` values from our `after` cursor, an
  • # alternative to cursor
  • # based pagination. May not be used with `last`.
  • # before: Read all values in the set before (above) this cursor.
  • # after: Read all values in the set after (below) this cursor.
  • # orderBy: The method to use when ordering `DeliveryNote`.
  • # condition: A condition to be used in determining which values
  • # should be returned by the collection.
  • deliveryNotesByDocumentRowId(
  • first: Int,
  • last: Int,
  • offset: Int,
  • before: Cursor,
  • after: Cursor,
  • orderBy: [DeliveryNotesOrderBy!],
  • condition: DeliveryNoteCondition
  • ): DeliveryNotesConnection! @deprecated( reason: "Please use deliveryNoteByDocumentRowId instead" )
  • # Reads and enables pagination through a set of `Document`.
  • #
  • # Arguments
  • # first: Only read the first `n` values of the set.
  • # last: Only read the last `n` values of the set.
  • # offset: Skip the first `n` values from our `after` cursor, an
  • # alternative to cursor
  • # based pagination. May not be used with `last`.
  • # before: Read all values in the set before (above) this cursor.
  • # after: Read all values in the set after (below) this cursor.
  • # orderBy: The method to use when ordering `Document`.
  • # condition: A condition to be used in determining which values
  • # should be returned by the collection.
  • documentsByBaseDocumentRowId(
  • first: Int,
  • last: Int,
  • offset: Int,
  • before: Cursor,
  • after: Cursor,
  • orderBy: [DocumentsOrderBy!],
  • condition: DocumentCondition
  • ): DocumentsConnection!
  • # Reads and enables pagination through a set of `DocumentComment`.
  • #
  • # Arguments
  • # first: Only read the first `n` values of the set.
  • # last: Only read the last `n` values of the set.
  • # offset: Skip the first `n` values from our `after` cursor, an
  • # alternative to cursor
  • # based pagination. May not be used with `last`.
  • # before: Read all values in the set before (above) this cursor.
  • # after: Read all values in the set after (below) this cursor.
  • # orderBy: The method to use when ordering `DocumentComment`.
  • # condition: A condition to be used in determining which values
  • # should be returned by the collection.
  • documentCommentsByDocumentRowId(
  • first: Int,
  • last: Int,
  • offset: Int,
  • before: Cursor,
  • after: Cursor,
  • orderBy: [DocumentCommentsOrderBy!],
  • condition: DocumentCommentCondition
  • ): DocumentCommentsConnection!
  • # Reads and enables pagination through a set of `DocumentMoneyTransaction`.
  • #
  • # Arguments
  • # first: Only read the first `n` values of the set.
  • # last: Only read the last `n` values of the set.
  • # offset: Skip the first `n` values from our `after` cursor, an
  • # alternative to cursor
  • # based pagination. May not be used with `last`.
  • # before: Read all values in the set before (above) this cursor.
  • # after: Read all values in the set after (below) this cursor.
  • # orderBy: The method to use when ordering
  • # `DocumentMoneyTransaction`.
  • # condition: A condition to be used in determining which values
  • # should be returned by the collection.
  • documentMoneyTransactionsByDocumentRowId(
  • first: Int,
  • last: Int,
  • offset: Int,
  • before: Cursor,
  • after: Cursor,
  • orderBy: [DocumentMoneyTransactionsOrderBy!],
  • condition: DocumentMoneyTransactionCondition
  • ): DocumentMoneyTransactionsConnection!
  • # Reads and enables pagination through a set of `DocumentRecurringPayment`.
  • #
  • # Arguments
  • # first: Only read the first `n` values of the set.
  • # last: Only read the last `n` values of the set.
  • # offset: Skip the first `n` values from our `after` cursor, an
  • # alternative to cursor
  • # based pagination. May not be used with `last`.
  • # before: Read all values in the set before (above) this cursor.
  • # after: Read all values in the set after (below) this cursor.
  • # orderBy: The method to use when ordering
  • # `DocumentRecurringPayment`.
  • # condition: A condition to be used in determining which values
  • # should be returned by the collection.
  • documentRecurringPaymentsByDocumentRowId(
  • first: Int,
  • last: Int,
  • offset: Int,
  • before: Cursor,
  • after: Cursor,
  • orderBy: [DocumentRecurringPaymentsOrderBy!],
  • condition: DocumentRecurringPaymentCondition
  • ): DocumentRecurringPaymentsConnection!
  • # Reads and enables pagination through a set of `DocumentTag`.
  • #
  • # Arguments
  • # first: Only read the first `n` values of the set.
  • # last: Only read the last `n` values of the set.
  • # offset: Skip the first `n` values from our `after` cursor, an
  • # alternative to cursor
  • # based pagination. May not be used with `last`.
  • # before: Read all values in the set before (above) this cursor.
  • # after: Read all values in the set after (below) this cursor.
  • # orderBy: The method to use when ordering `DocumentTag`.
  • # condition: A condition to be used in determining which values
  • # should be returned by the collection.
  • documentTagsByDocumentRowId(
  • first: Int,
  • last: Int,
  • offset: Int,
  • before: Cursor,
  • after: Cursor,
  • orderBy: [DocumentTagsOrderBy!],
  • condition: DocumentTagCondition
  • ): DocumentTagsConnection!
  • # Reads and enables pagination through a set of `DocumentVersion`.
  • #
  • # Arguments
  • # first: Only read the first `n` values of the set.
  • # last: Only read the last `n` values of the set.
  • # offset: Skip the first `n` values from our `after` cursor, an
  • # alternative to cursor
  • # based pagination. May not be used with `last`.
  • # before: Read all values in the set before (above) this cursor.
  • # after: Read all values in the set after (below) this cursor.
  • # orderBy: The method to use when ordering `DocumentVersion`.
  • # condition: A condition to be used in determining which values
  • # should be returned by the collection.
  • documentVersionsByDocumentRowId(
  • first: Int,
  • last: Int,
  • offset: Int,
  • before: Cursor,
  • after: Cursor,
  • orderBy: [DocumentVersionsOrderBy!],
  • condition: DocumentVersionCondition
  • ): DocumentVersionsConnection!
  • # Reads a single `DocumentWorkflowState` that is related to this `Document`.
  • documentWorkflowStateByDocumentRowId: DocumentWorkflowState
  • # Reads and enables pagination through a set of `DocumentWorkflowState`.
  • #
  • # Arguments
  • # first: Only read the first `n` values of the set.
  • # last: Only read the last `n` values of the set.
  • # offset: Skip the first `n` values from our `after` cursor, an
  • # alternative to cursor
  • # based pagination. May not be used with `last`.
  • # before: Read all values in the set before (above) this cursor.
  • # after: Read all values in the set after (below) this cursor.
  • # orderBy: The method to use when ordering
  • # `DocumentWorkflowState`.
  • # condition: A condition to be used in determining which values
  • # should be returned by the collection.
  • documentWorkflowStatesByDocumentRowId(
  • first: Int,
  • last: Int,
  • offset: Int,
  • before: Cursor,
  • after: Cursor,
  • orderBy: [DocumentWorkflowStatesOrderBy!],
  • condition: DocumentWorkflowStateCondition
  • ): DocumentWorkflowStatesConnection! @deprecated( reason: "Please use documentWorkflowStateByDocumentRowId instead" )
  • # Reads a single `Invoice` that is related to this `Document`.
  • invoiceByDocumentRowId: Invoice
  • # Reads and enables pagination through a set of `Invoice`.
  • #
  • # Arguments
  • # first: Only read the first `n` values of the set.
  • # last: Only read the last `n` values of the set.
  • # offset: Skip the first `n` values from our `after` cursor, an
  • # alternative to cursor
  • # based pagination. May not be used with `last`.
  • # before: Read all values in the set before (above) this cursor.
  • # after: Read all values in the set after (below) this cursor.
  • # orderBy: The method to use when ordering `Invoice`.
  • # condition: A condition to be used in determining which values
  • # should be returned by the collection.
  • invoicesByDocumentRowId(
  • first: Int,
  • last: Int,
  • offset: Int,
  • before: Cursor,
  • after: Cursor,
  • orderBy: [InvoicesOrderBy!],
  • condition: InvoiceCondition
  • ): InvoicesConnection! @deprecated( reason: "Please use invoiceByDocumentRowId instead" )
  • # Reads and enables pagination through a set of `MoneyTransaction`.
  • #
  • # Arguments
  • # first: Only read the first `n` values of the set.
  • # last: Only read the last `n` values of the set.
  • # offset: Skip the first `n` values from our `after` cursor, an
  • # alternative to cursor
  • # based pagination. May not be used with `last`.
  • # before: Read all values in the set before (above) this cursor.
  • # after: Read all values in the set after (below) this cursor.
  • # orderBy: The method to use when ordering `MoneyTransaction`.
  • # condition: A condition to be used in determining which values
  • # should be returned by the collection.
  • moneyTransactionsByImportDocumentRowId(
  • first: Int,
  • last: Int,
  • offset: Int,
  • before: Cursor,
  • after: Cursor,
  • orderBy: [MoneyTransactionsOrderBy!],
  • condition: MoneyTransactionCondition
  • ): MoneyTransactionsConnection!
  • categoryObjectInstance: ObjectInstance
  • # Title of the `Document` properly derived from its data.
  • derivedTitle: String!
  • # Indicates if the `Document` has been extracted.
  • extracted: Boolean!
  • # Indicates if the `Document` is recurring.
  • isRecurring: Boolean!
  • # The `Document`'s payment status taking into account `Invoice` details and
  • # matched `MoneyTransaction`s.
  • paymentStatus: DocumentPaymentStatus!
  • # The `Document`'s assigned `RealEstateObject`.
  • realEstateObject: RealEstateObject
  • }

link Require by