OBJECT

Query

Root query

link GraphQL Schema definition

  • type Query {
  • # Fetches all administrations for your accountant.
  • #
  • # Arguments
  • # offset: For paging purposes: which result to start from.
  • # first: For paging purposes: the amount of results that are
  • # returned.
  • administrations(offset: Int, first: Int): [Administration]
  • # Fetches a specific administration for your accountant.
  • #
  • # Arguments
  • # companyNumber: Company number of the administration you want to
  • # look up. This field is required.
  • administration(companyNumber: String!): Administration
  • # Fetches accountant info.
  • accountant: Accountant
  • # Fetches the categories available for the client.
  • #
  • # Arguments
  • # vatnumber: Specific vatnumber of the company whose categories
  • # you want to look up. This field is required.
  • archiveCategories(vatnumber: String!): Categories
  • # Fetches all the associates for your accountant.
  • associates: [AssociateType]
  • # Fetches all the available associate groups.
  • associateGroups: [AssociateGroup]
  • # Fetch company statistics.
  • #
  • # Arguments
  • # type: The type of statistic to query.
  • # Options are: "AIR" or "processing".
  • # Available parameters per type:
  • #
  • # "AIR":
  • # - startPeriod
  • # - endPeriod
  • # - companyNumber
  • #
  • # "processing":
  • # - startPeriod
  • # - endPeriod
  • # - companyNumber
  • # - invoiceType
  • # - worklist
  • #
  • # startPeriod: An RFC-3339 encoded date string.
  • # endPeriod: An RFC-3339 encoded date string.
  • # companyNumber: Company number of the administration whose
  • # statistics you want to query. This field is optional. (e.g. BE0123456789)
  • # invoicetype: The possible invoice types
  • # worklist: If true, query statistics for documents processed
  • # through worklist. If false, query statistics for documents not processed through
  • # worklist.
  • # This field is optional. By default, statistics for all documents are returned.
  • # _offset: For paging purposes: which result to start from.
  • # This field is only used for the "processing" type.
  • getCompanyStatistics(
  • type: String!,
  • startPeriod: Date!,
  • endPeriod: Date!,
  • companyNumber: String,
  • invoicetype: InvoiceType,
  • worklist: Boolean,
  • _offset: Int
  • ): [CompanyStatistic]
  • # Fetch document information.
  • #
  • # Arguments
  • # id: The ID of the document to query.
  • document(id: ID!): Document
  • # Fetch customers information.
  • # The results size is limited to 100.
  • #
  • # Arguments
  • # companyNumber: Company number of the administration whose
  • # customers you want to query. This field is required. (e.g. BE0123456789)
  • # offset: For paging purposes: which result to start from.
  • customers(companyNumber: String!, offset: Int): [BusinessPartner]
  • }

link Require by

This element is not required by anyone