schema.graphql

type Query {
  accounting: Accounting
  ats: Ats
  crm: Crm
  customerSupport: CustomerSupport
  ecommerce: Ecommerce
  fileStorage: FileStorage
  hris: Hris
  lead: Lead
  sms: Sms
  issueTracking: IssueTracking
  vault: Vault
}

type Mutation {
  accounting: MutationAccounting
  crm: MutationCrm
  customerSupport: MutationCustomerSupport
  fileStorage: MutationFileStorage
  hris: MutationHris
  lead: MutationLead
  sms: MutationSms
  issueTracking: MutationIssueTracking
  vault: MutationVault
}

type Accounting {
  """
  List Credit Notes
  """
  CreditNotes(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): GetCreditNotesResponse
  """
  List Payments
  """
  Payments(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): PaymentList
  """
  List Suppliers
  """
  Suppliers(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: SuppliersFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): SupplierList
  """
  Get BalanceSheet
  """
  balanceSheet(
    """
    Apply filters
    """
    filter: BalanceSheetFilterInput
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): BalanceSheet
  """
  Get Bill
  """
  bill(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Bill
  """
  List Bills
  """
  bills(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    Apply sorting
    """
    sort: BillsSortInput
  ): BillList
  """
  Get company info
  """
  companyInfo(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): CompanyInfo
  """
  Get Credit Note
  """
  creditNote(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): CreditNote
  """
  Get Customer
  """
  customer(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Customer
  """
  List Customers
  """
  customers(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: CustomersFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): CustomerList
  """
  Get Invoice
  """
  invoice(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Invoice
  """
  Get Invoice Item
  """
  invoiceItem(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): InvoiceItem
  """
  List Invoice Items
  """
  invoiceItems(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: InvoiceItemsFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): InvoiceItemList
  """
  List Invoices
  """
  invoices(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    Apply sorting
    """
    sort: InvoicesSortInput
  ): InvoiceList
  """
  List Journal Entries
  """
  journalEntries(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): JournalEntryList
  """
  Get Journal Entry
  """
  journalEntry(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): JournalEntry
  """
  Get Ledger Account
  """
  ledgerAccount(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): LedgerAccount
  """
  List Ledger Accounts
  """
  ledgerAccounts(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): LedgerAccountList
  """
  Get Payment
  """
  payment(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Payment
  """
  Get Profit and Loss
  """
  profitAndLoss(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: ProfitAndLossFilterInput
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): ProfitAndLoss
  """
  Get Supplier
  """
  supplier(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Supplier
  "Get Tax Rate. Note: Not all connectors return the actual rate/percentage value. In this case, only the tax code or reference is returned. Support will soon be added to return the actual rate/percentage by doing additional calls in the background to provide the full view of a given tax rate. Connectors Affected: Quickbooks"
  taxRate(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): TaxRate
  "List Tax Rates. Note: Not all connectors return the actual rate/percentage value. In this case, only the tax code or reference is returned. Connectors Affected: Quickbooks"
  taxRates(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: TaxRatesFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): TaxRateList
}

type GetCreditNotesResponse {
  data: [CreditNote]!
  """
  Response metadata
  """
  meta: Meta
}

type CreditNote {
  account: LinkedLedgerAccount
  allocations: [AllocationsListItem]
  """
  The balance reflecting any payments made against the transaction.
  """
  balance: Float
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Currency Exchange Rate at the time entity was recorded/generated.
  """
  currencyRate: Float
  """
  The customer this entity is linked to.
  """
  customer: LinkedCustomer
  """
  Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD
  """
  dateIssued: String
  """
  Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD
  """
  datePaid: String
  """
  Unique identifier representing the entity
  """
  id: String!
  lineItems: [InvoiceLineItem]
  """
  Optional note to be associated with the credit note.
  """
  note: String
  """
  Credit note number.
  """
  number: String
  """
  Optional reference message ie: Debit remittance detail.
  """
  reference: String
  """
  Indicates the total credit amount still available to apply towards the payment.
  """
  remainingCredit: Float
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Status of credit notes
  """
  status: CreditNoteStatus
  """
  Sub-total amount, normally before tax.
  """
  subTotal: Float
  """
  Applicable tax id/code override if tax is not supplied on a line item basis.
  """
  taxCode: String
  """
  Amounts are including tax
  """
  taxInclusive: Boolean
  """
  Optional terms to be associated with the credit note.
  """
  terms: String
  """
  Amount of transaction
  """
  totalAmount: Float!
  """
  Total tax amount applied to this invoice.
  """
  totalTax: Float
  """
  Type of payment
  """
  type: CreditNoteType
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type LinkedLedgerAccount {
  """
  The code assigned to the account.
  """
  code: String
  """
  The unique identifier for the account.
  """
  id: String
  """
  The name of the account.
  """
  name: String
  """
  The nominal code of the account.
  """
  nominalCode: String
}

type AllocationsListItem {
  """
  Amount of payment that should be attributed to this allocation. If null, the total_amount will be used.
  """
  amount: Float
  code: String
  """
  Unique identifier of entity this payment should be attributed to.
  """
  id: String
  """
  Type of entity this payment should be attributed to.
  """
  type: AllocationType
}

enum AllocationType {
  invoice
  order
  expense
  credit_memo
  over_payment
  pre_payment
}

enum Currency {
  UNKNOWN_CURRENCY
  AED
  AFN
  ALL
  AMD
  ANG
  AOA
  ARS
  AUD
  AWG
  AZN
  BAM
  BBD
  BDT
  BGN
  BHD
  BIF
  BMD
  BND
  BOB
  BOV
  BRL
  BSD
  BTN
  BWP
  BYR
  BZD
  CAD
  CDF
  CHE
  CHF
  CHW
  CLF
  CLP
  CNY
  COP
  COU
  CRC
  CUC
  CUP
  CVE
  CZK
  DJF
  DKK
  DOP
  DZD
  EGP
  ERN
  ETB
  EUR
  FJD
  FKP
  GBP
  GEL
  GHS
  GIP
  GMD
  GNF
  GTQ
  GYD
  HKD
  HNL
  HRK
  HTG
  HUF
  IDR
  ILS
  INR
  IQD
  IRR
  ISK
  JMD
  JOD
  JPY
  KES
  KGS
  KHR
  KMF
  KPW
  KRW
  KWD
  KYD
  KZT
  LAK
  LBP
  LKR
  LRD
  LSL
  LTL
  LVL
  LYD
  MAD
  MDL
  MGA
  MKD
  MMK
  MNT
  MOP
  MRO
  MUR
  MVR
  MWK
  MXN
  MXV
  MYR
  MZN
  NAD
  NGN
  NIO
  NOK
  NPR
  NZD
  OMR
  PAB
  PEN
  PGK
  PHP
  PKR
  PLN
  PYG
  QAR
  RON
  RSD
  RUB
  RWF
  SAR
  SBD
  SCR
  SDG
  SEK
  SGD
  SHP
  SLL
  SOS
  SRD
  SSP
  STD
  SVC
  SYP
  SZL
  THB
  TJS
  TMT
  TND
  TOP
  TRC
  TRY
  TTD
  TWD
  TZS
  UAH
  UGX
  USD
  USN
  USS
  UYI
  UYU
  UZS
  VEF
  VND
  VUV
  WST
  XAF
  XAG
  XAU
  XBA
  XBB
  XBC
  XBD
  XCD
  XDR
  XOF
  XPD
  XPF
  XPT
  XTS
  XXX
  YER
  ZAR
  ZMK
  ZMW
  BTC
  ETH
}

"""
The customer this entity is linked to.
"""
type LinkedCustomer {
  """
  The company name of the customer.
  """
  companyName: String
  """
  The display ID of the customer.
  """
  displayId: String
  """
  The display name of the customer.
  """
  displayName: String
  """
  The ID of the customer this entity is linked to.
  """
  id: String!
  """
  The name of the customer. Deprecated, use display_name instead.
  """
  name: String
}

type InvoiceLineItem {
  """
  User defined item code
  """
  code: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Department id
  """
  departmentId: String
  """
  User defined description
  """
  description: String
  """
  Discount amount applied to the line item when supported downstream.
  """
  discountAmount: Float
  """
  Discount percentage applied to the line item when supported downstream.
  """
  discountPercentage: Float
  """
  A unique identifier for an object.
  """
  id: String
  item: LinkedInvoiceItem
  ledgerAccount: LinkedLedgerAccount
  """
  Line number in the invoice
  """
  lineNumber: Int
  """
  Location id
  """
  locationId: String
  quantity: Float
  """
  Row ID
  """
  rowId: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Tax amount
  """
  taxAmount: Float
  taxRate: LinkedTaxRate
  """
  Total amount of the line item
  """
  totalAmount: Float
  """
  Item type
  """
  type: InvoiceLineItemType
  """
  Description of the unit type the item is sold as, ie: kg, hour.
  """
  unitOfMeasure: String
  unitPrice: Float
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type LinkedInvoiceItem {
  """
  User defined item code
  """
  code: String
  """
  ID of the linked item. A reference to the [invoice item](https://developers.apideck.com/apis/accounting/reference#tag/Invoice-Items) that was used to create this line item
  """
  id: String
  """
  User defined item name
  """
  name: String
}

type LinkedTaxRate {
  """
  Tax rate code
  """
  code: String
  """
  The ID of the object.
  """
  id: String
  """
  Name of the tax rate
  """
  name: String
  """
  Rate of the tax rate
  """
  rate: Float
}

enum InvoiceLineItemType {
  sales_item
  discount
  info
  sub_total
}

enum CreditNoteStatus {
  draft
  authorised
  paid
  voided
  deleted
}

enum CreditNoteType {
  accounts_receivable_credit
  accounts_payable_credit
}

"""
Response metadata
"""
type Meta {
  """
  Cursors to navigate to previous or next pages through the API
  """
  cursors: Cursors
  """
  Number of items returned in the data property of the response
  """
  itemsOnPage: Int
}

"""
Cursors to navigate to previous or next pages through the API
"""
type Cursors {
  """
  Cursor to navigate to the current page of results through the API
  """
  current: String
  """
  Cursor to navigate to the next page of results through the API
  """
  next: String
  """
  Cursor to navigate to the previous page of results through the API
  """
  previous: String
}

input PassThroughInput {
  """
  All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)
  """
  exampleDownstreamProperty: String
}

type PaymentList {
  data: [Payment]!
  """
  Response metadata
  """
  meta: Meta
}

type Payment {
  account: LinkedLedgerAccount
  """
  Unique identifier for the account to allocate payment to.
  """
  accountsReceivableAccountId: String
  """
  Type of accounts receivable account.
  """
  accountsReceivableAccountType: String
  allocations: [PaymentAllocation]
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Currency Exchange Rate at the time entity was recorded/generated.
  """
  currencyRate: Float
  """
  The customer this entity is linked to.
  """
  customer: LinkedCustomer
  """
  Payment id to be displayed.
  """
  displayId: String
  """
  The third-party API ID of original entity
  """
  downstreamId: String
  """
  Unique identifier representing the entity
  """
  id: String!
  """
  Optional note to be associated with the payment.
  """
  note: String
  """
  Payment method name
  """
  paymentMethod: String
  """
  Unique identifier for the payment method.
  """
  paymentMethodId: String
  """
  Optional reference message returned by payment method on processing
  """
  paymentMethodReference: String
  """
  Payment has been reconciled
  """
  reconciled: Boolean
  """
  Optional payment reference message ie: Debit remittance detail.
  """
  reference: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Status of payment
  """
  status: PaymentStatus
  """
  The supplier this entity is linked to.
  """
  supplier: LinkedSupplier
  """
  Amount of payment
  """
  totalAmount: Float!
  """
  Date transaction was entered - YYYY:MM::DDThh:mm:ss.sTZD
  """
  transactionDate: String!
  """
  Type of payment
  """
  type: PaymentType
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type PaymentAllocation {
  """
  Amount of payment that should be attributed to this allocation. If null, the total_amount will be used.
  """
  amount: Float
  code: String
  """
  Unique identifier of entity this payment should be attributed to.
  """
  id: String
  """
  Type of entity this payment should be attributed to.
  """
  type: AllocationType
}

enum PaymentStatus {
  authorised
  paid
  voided
  deleted
}

"""
The supplier this entity is linked to.
"""
type LinkedSupplier {
  address: Address
  """
  The company name of the supplier.
  """
  companyName: String
  """
  The display name of the supplier.
  """
  displayName: String
  """
  The ID of the supplier this entity is linked to.
  """
  id: String!
}

type Address {
  """
  Name of city.
  """
  city: String
  contactName: String
  """
  country code according to ISO 3166-1 alpha-2.
  """
  country: String
  """
  Address field that holds a sublocality, such as a county
  """
  county: String
  email: String
  fax: String
  id: String
  latitude: String
  """
  Line 1 of the address e.g. number, street, suite, apt #, etc.
  """
  line1: String
  """
  Line 2 of the address
  """
  line2: String
  """
  Line 3 of the address
  """
  line3: String
  """
  Line 4 of the address
  """
  line4: String
  longitude: String
  name: String
  phoneNumber: String
  """
  Zip code or equivalent.
  """
  postalCode: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  salutation: String
  """
  Name of state
  """
  state: String
  """
  Street number
  """
  streetNumber: String
  string: String
  type: AddressType
  website: String
}

enum AddressType {
  primary
  secondary
  home
  office
  shipping
  billing
  other
}

enum PaymentType {
  accounts_receivable
  accounts_payable
  accounts_receivable_credit
  accounts_payable_credit
  accounts_receivable_overpayment
  accounts_payable_overpayment
  accounts_receivable_prepayment
  accounts_payable_prepayment
}

type SupplierList {
  data: [Supplier]!
  """
  Response metadata
  """
  meta: Meta
}

type Supplier {
  account: LinkedLedgerAccount
  addresses: [Address]
  bankAccounts: [BankAccount]
  """
  The name of the company.
  """
  companyName: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Display ID
  """
  displayId: String
  """
  Display name
  """
  displayName: String
  """
  The third-party API ID of original entity
  """
  downstreamId: String
  emails: [Email]
  """
  The first name of the person.
  """
  firstName: String
  """
  A unique identifier for an object.
  """
  id: String!
  """
  Is this an individual or business supplier
  """
  individual: Boolean
  """
  The last name of the person.
  """
  lastName: String
  """
  Middle name of the person.
  """
  middleName: String
  """
  Some notes about this supplier
  """
  notes: String
  phoneNumbers: [PhoneNumber]
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Supplier status
  """
  status: SupplierStatus
  suffix: String
  taxNumber: String
  taxRate: LinkedTaxRate
  """
  The job title of the person.
  """
  title: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
  websites: [Website]
}

type BankAccount {
  """
  The name which you used in opening your bank account.
  """
  accountName: String
  """
  A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number.
  """
  accountNumber: String
  """
  The type of bank account.
  """
  accountType: AccountType
  """
  A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.
  """
  bankCode: String
  bic: String
  """
  A branch identifier is a unique identifier for a branch of a bank or financial institution.
  """
  branchIdentifier: String
  """
  A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution.
  """
  bsbNumber: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  iban: String
}

enum AccountType {
  bank_account
  credit_card
  other
}

type Email {
  email: String!
  id: String
  type: EmailType
}

enum EmailType {
  primary
  secondary
  work
  personal
  billing
  other
}

type PhoneNumber {
  areaCode: String
  countryCode: String
  extension: String
  id: String
  number: String!
  type: PhoneType
}

enum PhoneType {
  primary
  secondary
  home
  work
  office
  mobile
  assistant
  fax
  directdialin
  personal
  other
}

enum SupplierStatus {
  active
  inactive
  archived
  gdprerasurerequest
  unknown
}

type Website {
  id: String
  type: WebsiteType
  url: String!
}

enum WebsiteType {
  primary
  secondary
  work
  personal
  other
}

input SuppliersFilterInput {
  """
  Company Name of supplier to search for
  """
  companyName: String
  """
  Email of supplier to search for
  """
  email: String
}

type BalanceSheet {
  assets: Assets!
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  The start date of the report
  """
  endDate: String
  equity: Equity!
  """
  A unique identifier for an object.
  """
  id: String
  liabilities: Liabilities!
  """
  The name of the report
  """
  reportName: String!
  """
  The start date of the report
  """
  startDate: String!
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type Assets {
  currentAssets: CurrentAssets!
  fixedAssets: FixedAssets!
  """
  Total assets
  """
  total: Float!
}

type CurrentAssets {
  accounts: [CurrentAssetAccountsList]!
  """
  Total current assets
  """
  total: Float!
}

type CurrentAssetAccountsList {
  """
  A unique identifier for an object.
  """
  id: String
  """
  The name of the current asset account
  """
  name: String
  """
  The value of the current asset
  """
  value: Float
}

type FixedAssets {
  accounts: [FixedAssetAccountsList]!
  """
  Total fixed assets
  """
  total: Float!
}

type FixedAssetAccountsList {
  """
  A unique identifier for an object.
  """
  id: String
  """
  The name of the fixed asset account
  """
  name: String
  """
  The value of the fixed asset
  """
  value: Float
}

type Equity {
  items: [EquityItemsList]!
  """
  Total equity
  """
  total: Float!
}

type EquityItemsList {
  """
  A unique identifier for an object.
  """
  id: String
  """
  The type of the equity
  """
  name: String
  """
  The equity amount
  """
  value: Float
}

type Liabilities {
  accounts: [LiabilityAccountsList]!
  """
  Total liabilities
  """
  total: Float!
}

type LiabilityAccountsList {
  """
  A unique identifier for an object.
  """
  id: String
  """
  The name of the liability account
  """
  name: String
  """
  The value of the liability
  """
  value: Float
}

input BalanceSheetFilterInput {
  """
  Filter by end date. If end date is given, start date is required.
  """
  endDate: String
  """
  Filter by start date. If start date is given, end date is required.
  """
  startDate: String
}

type Bill {
  """
  Balance of bill due.
  """
  balance: Float
  """
  Date bill was issued - YYYY-MM-DD.
  """
  billDate: String
  billNumber: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Currency Exchange Rate at the time entity was recorded/generated.
  """
  currencyRate: Float
  """
  Amount of deposit made to this bill.
  """
  deposit: Float
  """
  The third-party API ID of original entity
  """
  downstreamId: String
  """
  The due date is the date on which a payment is scheduled to be received by the supplier - YYYY-MM-DD.
  """
  dueDate: String
  """
  A unique identifier for an object.
  """
  id: String
  ledgerAccount: LinkedLedgerAccount
  lineItems: [BillLineItem]
  notes: String
  """
  The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD.
  """
  paidDate: String
  """
  A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.
  """
  poNumber: String
  """
  Optional bill reference.
  """
  reference: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Invoice status
  """
  status: Status
  """
  Sub-total amount, normally before tax.
  """
  subTotal: Float
  """
  The supplier this entity is linked to.
  """
  supplier: LinkedSupplier
  """
  Applicable tax id/code override if tax is not supplied on a line item basis.
  """
  taxCode: String
  """
  Amounts are including tax
  """
  taxInclusive: Boolean
  """
  Terms of payment.
  """
  terms: String
  """
  Total amount of bill, including tax.
  """
  total: Float
  """
  Total tax amount applied to this bill.
  """
  totalTax: Float
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type BillLineItem {
  """
  User defined item code
  """
  code: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Department id
  """
  departmentId: String
  """
  User defined description
  """
  description: String
  """
  Discount percentage
  """
  discountPercentage: Float
  """
  A unique identifier for an object.
  """
  id: String
  item: LinkedInvoiceItem
  ledgerAccount: LinkedLedgerAccount
  """
  Line number in the invoice
  """
  lineNumber: Int
  """
  Location id
  """
  locationId: String
  quantity: Float
  """
  Row ID
  """
  rowId: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Tax amount
  """
  taxAmount: Float
  taxRate: LinkedTaxRate
  """
  Total amount of the line item
  """
  totalAmount: Float
  """
  Bill Line Item type
  """
  type: BillLineItemType
  """
  Description of the unit type the item is sold as, ie: kg, hour.
  """
  unitOfMeasure: String
  unitPrice: Float
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

enum BillLineItemType {
  expense_item
  expense_account
}

enum Status {
  live
  upcoming
  requested
  accepted
  scheduled
  canceled
  queued
  sending
  sent
  failed
  delivered
  undelivered
  receiving
  received
  read
  active
  inactive
  trial
  other
  tentative
  declined
  draft
  submitted
  authorised
  partially_paid
  paid
  void
  credit
  deleted
}

type BillList {
  data: [Bill]!
  """
  Response metadata
  """
  meta: Meta
}

input BillsSortInput {
  """
  The field on which to sort the Bills
  """
  by: BillsSortBy
  """
  The direction in which to sort the results
  """
  direction: SortDirection
}

enum BillsSortBy {
  updated_at
}

enum SortDirection {
  asc
  desc
}

type CompanyInfo {
  addresses: [Address]
  """
  Whether sales tax is calculated automatically for the company
  """
  automatedSalesTax: Boolean
  """
  The name of the company.
  """
  companyName: String
  """
  Date when company file was created
  """
  companyStartDate: String
  """
  country code according to ISO 3166-1 alpha-2.
  """
  country: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  defaultSalesTax: LinkedTaxRate
  emails: [Email]
  """
  The start month of fiscal year.
  """
  fiscalYearStartMonth: FiscalYearStartMonth
  """
  A unique identifier for an object.
  """
  id: String
  """
  language code according to ISO 639-1. For the United States - EN
  """
  language: String
  """
  The legal name of the company
  """
  legalName: String
  phoneNumbers: [PhoneNumber]
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Whether sales tax is enabled for the company
  """
  salesTaxEnabled: Boolean
  salesTaxNumber: String
  """
  Based on the status some functionality is enabled or disabled.
  """
  status: CompanyStatus
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

enum FiscalYearStartMonth {
  January
  February
  March
  April
  May
  June
  July
  August
  September
  October
  November
  December
}

enum CompanyStatus {
  active
  inactive
}

type Customer {
  account: LinkedLedgerAccount
  addresses: [Address]
  bankAccounts: [BankAccount]
  """
  The name of the company.
  """
  companyName: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Display ID
  """
  displayId: String
  """
  Display name
  """
  displayName: String
  """
  The third-party API ID of original entity
  """
  downstreamId: String
  emails: [Email]
  """
  The first name of the person.
  """
  firstName: String
  """
  A unique identifier for an object.
  """
  id: String!
  """
  Is this an individual or business customer
  """
  individual: Boolean
  """
  The last name of the person.
  """
  lastName: String
  """
  Middle name of the person.
  """
  middleName: String
  """
  Some notes about this customer
  """
  notes: String
  """
  The parent customer this entity is linked to.
  """
  parent: LinkedParentCustomer
  phoneNumbers: [PhoneNumber]
  """
  If true, indicates this is a Project.
  """
  project: Boolean
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Customer status
  """
  status: CustomerStatus
  suffix: String
  taxNumber: String
  taxRate: LinkedTaxRate
  """
  The job title of the person.
  """
  title: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
  websites: [Website]
}

"""
The parent customer this entity is linked to.
"""
type LinkedParentCustomer {
  """
  The parent ID of the customer this entity is linked to.
  """
  id: String!
  """
  The name of the parent customer.
  """
  name: String
}

enum CustomerStatus {
  active
  archived
  gdprerasurerequest
  unknown
  inactive
}

type CustomerList {
  data: [Customer]!
  """
  Response metadata
  """
  meta: Meta
}

input CustomersFilterInput {
  """
  Company Name of customer to search for
  """
  companyName: String
  """
  Display Name of customer to search for
  """
  displayName: String
  """
  Email of customer to search for
  """
  email: String
  """
  First name of customer to search for
  """
  firstName: String
  """
  Last name of customer to search for
  """
  lastName: String
}

type Invoice {
  """
  Balance of invoice due.
  """
  balance: Float
  billingAddress: Address
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Currency Exchange Rate at the time entity was recorded/generated.
  """
  currencyRate: Float
  """
  The customer this entity is linked to.
  """
  customer: LinkedCustomer
  """
  Customer memo
  """
  customerMemo: String
  """
  Amount of deposit made to this invoice.
  """
  deposit: Float
  """
  Discount amount applied to this invoice.
  """
  discountAmount: Float
  """
  Discount percentage applied to this invoice.
  """
  discountPercentage: Float
  """
  The third-party API ID of original entity
  """
  downstreamId: String
  """
  The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD.
  """
  dueDate: String
  """
  A unique identifier for an object.
  """
  id: String
  """
  Date invoice was issued - YYYY-MM-DD.
  """
  invoiceDate: String
  """
  Invoice sent to contact/customer.
  """
  invoiceSent: Boolean
  lineItems: [InvoiceLineItem]
  """
  Invoice number.
  """
  number: String
  """
  A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.
  """
  poNumber: String
  """
  Optional invoice reference.
  """
  reference: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  shippingAddress: Address
  """
  URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.
  """
  sourceDocumentUrl: String
  """
  Invoice status
  """
  status: Status
  """
  Sub-total amount, normally before tax.
  """
  subTotal: Float
  """
  Applicable tax id/code override if tax is not supplied on a line item basis.
  """
  taxCode: String
  """
  Amounts are including tax
  """
  taxInclusive: Boolean
  """
  Optional invoice template
  """
  templateId: String
  """
  Terms of payment.
  """
  terms: String
  """
  Total amount of invoice, including tax.
  """
  total: Float
  """
  Total tax amount applied to this invoice.
  """
  totalTax: Float
  """
  Invoice type
  """
  type: InvoiceType
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

enum InvoiceType {
  standard
  credit
  service
  product
  supplier
  other
}

type InvoiceItem {
  active: Boolean
  assetAccount: LinkedLedgerAccount
  """
  User defined item code
  """
  code: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  A short description of the item
  """
  description: String
  expenseAccount: LinkedLedgerAccount
  """
  The ID of the item.
  """
  id: String
  incomeAccount: LinkedLedgerAccount
  """
  The date of opening balance if inventory item is tracked - YYYY-MM-DD.
  """
  inventoryDate: String
  """
  Item name
  """
  name: String
  purchaseDetails: PurchaseDetails
  """
  Item is available for purchase transactions
  """
  purchased: Boolean
  quantity: Float
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  salesDetails: SalesDetails
  """
  Item will be available on sales transactions
  """
  sold: Boolean
  """
  If true, transactions for this item are taxable
  """
  taxable: Boolean
  """
  Item is inventoried
  """
  tracked: Boolean
  """
  Item type
  """
  type: InvoiceItemType
  unitPrice: Float
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type PurchaseDetails {
  """
  Amounts are including tax
  """
  taxInclusive: Boolean
  taxRate: LinkedTaxRate
  """
  Description of the unit type the item is sold as, ie: kg, hour.
  """
  unitOfMeasure: String
  unitPrice: Float
}

type SalesDetails {
  """
  Amounts are including tax
  """
  taxInclusive: Boolean
  taxRate: LinkedTaxRate
  """
  Description of the unit type the item is sold as, ie: kg, hour.
  """
  unitOfMeasure: String
  unitPrice: Float
}

enum InvoiceItemType {
  inventory
  service
  other
}

type InvoiceItemList {
  data: [InvoiceItem]!
  """
  Response metadata
  """
  meta: Meta
}

input InvoiceItemsFilterInput {
  """
  Name of Invoice Items to search for
  """
  name: String
}

type InvoiceList {
  data: [Invoice]!
  """
  Response metadata
  """
  meta: Meta
}

input InvoicesSortInput {
  """
  The field on which to sort the Invoices
  """
  by: InvoicesSortBy
  """
  The direction in which to sort the results
  """
  direction: SortDirection
}

enum InvoicesSortBy {
  updated_at
}

type JournalEntryList {
  data: [JournalEntry]!
  """
  Response metadata
  """
  meta: Meta
}

type JournalEntry {
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Currency Exchange Rate at the time entity was recorded/generated.
  """
  currencyRate: Float
  """
  A unique identifier for an object.
  """
  id: String
  """
  Journal symbol of the entry. For example IND for indirect costs
  """
  journalSymbol: String
  """
  Requires a minimum of 2 line items that sum to 0
  """
  lineItems: [JournalEntryLineItem]
  """
  Reference for the journal entry.
  """
  memo: String
  """
  This is the date on which the journal entry was added. This can be different from the creation date and can also be backdated.
  """
  postedAt: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Journal entry title
  """
  title: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type JournalEntryLineItem {
  """
  A unique identifier for an object.
  """
  departmentId: String
  """
  User defined description
  """
  description: String
  """
  A unique identifier for an object.
  """
  id: String
  ledgerAccount: LinkedLedgerAccount!
  """
  A unique identifier for an object.
  """
  locationId: String
  """
  Tax amount
  """
  taxAmount: Float
  taxRate: LinkedTaxRate
  """
  Debit entries are considered positive, and credit entries are considered negative.
  """
  totalAmount: Float!
  trackingCategory: LinkedTrackingCategory
  """
  Debit entries are considered positive, and credit entries are considered negative.
  """
  type: JournalEntryLineItemType!
}

type LinkedTrackingCategory {
  """
  The unique identifier for the tracking category.
  """
  id: String
  """
  The name of the tracking category.
  """
  name: String
}

enum JournalEntryLineItemType {
  debit
  credit
}

type LedgerAccount {
  """
  Whether the account is active or not.
  """
  active: Boolean
  bankAccount: BankAccount
  """
  The categories of the account.
  """
  categories: [CategoriesListItem]
  """
  The classification of account.
  """
  classification: Classification
  """
  The code assigned to the account.
  """
  code: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  The current balance of the account.
  """
  currentBalance: Float
  """
  The description of the account.
  """
  description: String
  """
  The human readable display ID used when displaying the account
  """
  displayId: String
  """
  The fully qualified name of the account.
  """
  fullyQualifiedName: String
  """
  Whether the account is a header or not.
  """
  header: Boolean
  """
  A unique identifier for an object.
  """
  id: String
  """
  Reconciliation Date means the last calendar day of each Reconciliation Period.
  """
  lastReconciliationDate: String
  level: Float
  """
  The name of the account.
  """
  name: String
  """
  The nominal code of the ledger account.
  """
  nominalCode: String
  """
  The opening balance of the account.
  """
  openingBalance: Float
  parentAccount: ParentAccount
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  The status of the account.
  """
  status: LedgerAccountStatus
  """
  Whether the account is a sub account or not.
  """
  subAccount: Boolean
  """
  The sub accounts of the account.
  """
  subAccounts: [SubAccountsListItem]
  """
  The sub type of account.
  """
  subType: String
  taxRate: LinkedTaxRate
  """
  The tax type of the account.
  """
  taxType: String
  """
  The type of account.
  """
  type: LedgerAccountType
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type CategoriesListItem {
  id: String
  """
  The name of the category.
  """
  name: String
}

enum Classification {
  asset
  equity
  expense
  liability
  revenue
  income
  other_income
  other_expense
  costs_of_sales
}

type ParentAccount {
  """
  The human readable display ID used when displaying the parent account
  """
  displayId: String
  """
  The ID of the parent account.
  """
  id: String
  """
  The name of the parent account.
  """
  name: String
}

enum LedgerAccountStatus {
  active
  inactive
  archived
}

type SubAccountsListItem {
  """
  The name of the sub account.
  """
  accountSubName: String
  """
  The ID of the sub account.
  """
  id: String
}

enum LedgerAccountType {
  accounts_receivable
  revenue
  sales
  other_income
  bank
  current_asset
  fixed_asset
  non_current_asset
  other_asset
  balancesheet
  equity
  expense
  other_expense
  costs_of_sales
  accounts_payable
  credit_card
  current_liability
  non_current_liability
  other_liability
}

type LedgerAccountList {
  data: [LedgerAccount]!
  """
  Response metadata
  """
  meta: Meta
}

type ProfitAndLoss {
  currency: String!
  """
  Customer id
  """
  customerId: String
  """
  The start date of the report
  """
  endDate: String
  expenses: Expenses!
  grossProfit: GrossProfit
  """
  A unique identifier for an object.
  """
  id: String
  income: Income!
  netIncome: NetIncome
  netOperatingIncome: NetOperatingIncome
  """
  The name of the report
  """
  reportName: String!
  """
  The start date of the report
  """
  startDate: String
}

type Expenses {
  records: [ProfitAndLossRecordsListItem]!
  """
  Total expense
  """
  total: Float!
}

type ProfitAndLossRecordsListItem {
  id: String
  records: [RecordsListItem]
  title: String
  total: Float
  type: JSON
  value: Float
}

type RecordsListItem {
  id: String
  records: [RecordsListItem]
  title: String
  total: Float
  type: JSON
  value: Float
}

"""
The \`JSON\` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).
"""
scalar JSON

type GrossProfit {
  records: [ProfitAndLossRecordsListItem]!
  """
  Total gross profit
  """
  total: Float!
}

type Income {
  records: [ProfitAndLossRecordsListItem]!
  """
  Total income
  """
  total: Float!
}

type NetIncome {
  records: [ProfitAndLossRecordsListItem]!
  """
  Total net income
  """
  total: Float!
}

type NetOperatingIncome {
  records: [ProfitAndLossRecordsListItem]!
  """
  Total net operating income
  """
  total: Float!
}

input ProfitAndLossFilterInput {
  """
  Filter by customer id
  """
  customerId: String
  """
  Filter by end date. If end date is given, start date is required.
  """
  endDate: String
  """
  Filter by start date. If start date is given, end date is required.
  """
  startDate: String
}

type TaxRate {
  """
  Tax code assigned to identify this tax rate.
  """
  code: String
  components: [ComponentsListItem]
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Description of tax rate
  """
  description: String
  """
  Effective tax rate
  """
  effectiveTaxRate: Float
  """
  ID assigned to identify this tax rate.
  """
  id: String
  """
  Name assigned to identify this tax rate.
  """
  name: String
  """
  ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities.
  """
  originalTaxRateId: String
  """
  Report Tax type to aggregate tax collected or paid for reporting purposes
  """
  reportTaxType: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Tax rate status
  """
  status: TaxRateStatus
  """
  Unique identifier for the account for tax collected.
  """
  taxPayableAccountId: String
  """
  Unique identifier for the account for tax remitted.
  """
  taxRemittedAccountId: String
  """
  Not compounded sum of the components of a tax rate
  """
  totalTaxRate: Float
  """
  Tax type used to indicate the source of tax collected or paid
  """
  type: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type ComponentsListItem {
  compound: Boolean
  id: String
  name: String
  rate: Float
}

enum TaxRateStatus {
  active
  inactive
  archived
}

type TaxRateList {
  data: [TaxRate]!
  """
  Response metadata
  """
  meta: Meta
}

input TaxRatesFilterInput {
  """
  Boolean to describe if tax rate can be used for asset accounts
  """
  assets: Boolean
  """
  Boolean to describe if tax rate can be used for equity accounts
  """
  equity: Boolean
  """
  Boolean to describe if tax rate can be used for expense accounts
  """
  expenses: Boolean
  """
  Boolean to describe if tax rate can be used for liability accounts
  """
  liabilities: Boolean
  """
  Boolean to describe if tax rate can be used for revenue accounts
  """
  revenue: Boolean
}

type MutationAccounting {
  """
  Create Bill
  """
  billsAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: BillInput!
  ): UnifiedId
  """
  Delete Bill
  """
  billsDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Bill
  """
  billsUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: BillInput!
  ): UnifiedId
  """
  Create Credit Note
  """
  creditNotesAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: CreditNoteInput!
  ): UnifiedId
  """
  Delete Credit Note
  """
  creditNotesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Credit Note
  """
  creditNotesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: CreditNoteInput!
  ): UnifiedId
  """
  Create Customer
  """
  customersAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: CustomerInput!
  ): UnifiedId
  """
  Delete Customer
  """
  customersDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Customer
  """
  customersUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: CustomerInput!
  ): UnifiedId
  """
  Create Invoice Item
  """
  invoiceItemsAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: InvoiceItemInput!
  ): UnifiedId
  """
  Delete Invoice Item
  """
  invoiceItemsDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Invoice Item
  """
  invoiceItemsUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: InvoiceItemInput!
  ): UnifiedId
  """
  Create Invoice
  """
  invoicesAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: InvoiceInput!
  ): InvoiceResponse
  """
  Delete Invoice
  """
  invoicesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): InvoiceResponse
  """
  Update Invoice
  """
  invoicesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: InvoiceInput!
  ): InvoiceResponse
  """
  Create Journal Entry
  """
  journalEntriesAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: JournalEntryInput!
  ): UnifiedId
  """
  Delete Journal Entry
  """
  journalEntriesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Journal Entry
  """
  journalEntriesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: JournalEntryInput!
  ): UnifiedId
  """
  Create Ledger Account
  """
  ledgerAccountsAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: LedgerAccountInput!
  ): UnifiedId
  """
  Delete Ledger Account
  """
  ledgerAccountsDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Ledger Account
  """
  ledgerAccountsUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: LedgerAccountInput!
  ): UnifiedId
  """
  Create Payment
  """
  paymentsAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: PaymentInput!
  ): UnifiedId
  """
  Delete Payment
  """
  paymentsDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Payment
  """
  paymentsUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: PaymentInput!
  ): UnifiedId
  """
  Create Supplier
  """
  suppliersAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: SupplierInput!
  ): UnifiedId
  """
  Delete Supplier
  """
  suppliersDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Supplier
  """
  suppliersUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: SupplierInput!
  ): UnifiedId
  """
  Create Tax Rate
  """
  taxRatesAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: TaxRateInput!
  ): UnifiedId
  """
  Delete Tax Rate
  """
  taxRatesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Tax Rate
  """
  taxRatesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: TaxRateInput!
  ): UnifiedId
}

type UnifiedId {
  """
  The unique identifier of the resource
  """
  id: String!
}

input BillInput {
  """
  Balance of bill due.
  """
  balance: Float
  """
  Date bill was issued - YYYY-MM-DD.
  """
  billDate: String
  billNumber: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Currency Exchange Rate at the time entity was recorded/generated.
  """
  currencyRate: Float
  """
  Amount of deposit made to this bill.
  """
  deposit: Float
  """
  The due date is the date on which a payment is scheduled to be received by the supplier - YYYY-MM-DD.
  """
  dueDate: String
  ledgerAccount: LinkedLedgerAccountInput
  lineItems: [BillLineItemInput]
  notes: String
  """
  The paid date is the date on which a payment was sent to the supplier - YYYY-MM-DD.
  """
  paidDate: String
  """
  A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.
  """
  poNumber: String
  """
  Optional bill reference.
  """
  reference: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Invoice status
  """
  status: Status
  """
  Sub-total amount, normally before tax.
  """
  subTotal: Float
  """
  The supplier this entity is linked to.
  """
  supplier: LinkedSupplierInput
  """
  Applicable tax id/code override if tax is not supplied on a line item basis.
  """
  taxCode: String
  """
  Amounts are including tax
  """
  taxInclusive: Boolean
  """
  Terms of payment.
  """
  terms: String
  """
  Total amount of bill, including tax.
  """
  total: Float
  """
  Total tax amount applied to this bill.
  """
  totalTax: Float
}

input LinkedLedgerAccountInput {
  """
  The code assigned to the account.
  """
  code: String
  """
  The unique identifier for the account.
  """
  id: String
  """
  The nominal code of the account.
  """
  nominalCode: String
}

input BillLineItemInput {
  """
  User defined item code
  """
  code: String
  """
  Department id
  """
  departmentId: String
  """
  User defined description
  """
  description: String
  """
  Discount percentage
  """
  discountPercentage: Float
  item: LinkedInvoiceItemInput
  ledgerAccount: LinkedLedgerAccountInput
  """
  Line number in the invoice
  """
  lineNumber: Int
  """
  Location id
  """
  locationId: String
  quantity: Float
  """
  Row ID
  """
  rowId: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Tax amount
  """
  taxAmount: Float
  taxRate: LinkedTaxRateInput
  """
  Total amount of the line item
  """
  totalAmount: Float
  """
  Bill Line Item type
  """
  type: BillLineItemType
  """
  Description of the unit type the item is sold as, ie: kg, hour.
  """
  unitOfMeasure: String
  unitPrice: Float
}

input LinkedInvoiceItemInput {
  """
  ID of the linked item. A reference to the [invoice item](https://developers.apideck.com/apis/accounting/reference#tag/Invoice-Items) that was used to create this line item
  """
  id: String
}

input LinkedTaxRateInput {
  """
  The ID of the object.
  """
  id: String
}

"""
The supplier this entity is linked to.
"""
input LinkedSupplierInput {
  address: AddressInput
  """
  The display name of the supplier.
  """
  displayName: String
  """
  The ID of the supplier this entity is linked to.
  """
  id: String!
}

input AddressInput {
  """
  Name of city.
  """
  city: String
  contactName: String
  """
  country code according to ISO 3166-1 alpha-2.
  """
  country: String
  """
  Address field that holds a sublocality, such as a county
  """
  county: String
  email: String
  fax: String
  id: String
  latitude: String
  """
  Line 1 of the address e.g. number, street, suite, apt #, etc.
  """
  line1: String
  """
  Line 2 of the address
  """
  line2: String
  """
  Line 3 of the address
  """
  line3: String
  """
  Line 4 of the address
  """
  line4: String
  longitude: String
  name: String
  phoneNumber: String
  """
  Zip code or equivalent.
  """
  postalCode: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  salutation: String
  """
  Name of state
  """
  state: String
  """
  Street number
  """
  streetNumber: String
  string: String
  type: AddressType
  website: String
}

input CreditNoteInput {
  account: LinkedLedgerAccountInput
  allocations: [AllocationsListItemInput]
  """
  The balance reflecting any payments made against the transaction.
  """
  balance: Float
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Currency Exchange Rate at the time entity was recorded/generated.
  """
  currencyRate: Float
  """
  The customer this entity is linked to.
  """
  customer: LinkedCustomerInput
  """
  Date credit note issued - YYYY:MM::DDThh:mm:ss.sTZD
  """
  dateIssued: String
  """
  Date credit note paid - YYYY:MM::DDThh:mm:ss.sTZD
  """
  datePaid: String
  lineItems: [InvoiceLineItemInput]
  """
  Optional note to be associated with the credit note.
  """
  note: String
  """
  Credit note number.
  """
  number: String
  """
  Optional reference message ie: Debit remittance detail.
  """
  reference: String
  """
  Indicates the total credit amount still available to apply towards the payment.
  """
  remainingCredit: Float
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Status of credit notes
  """
  status: CreditNoteStatus
  """
  Sub-total amount, normally before tax.
  """
  subTotal: Float
  """
  Applicable tax id/code override if tax is not supplied on a line item basis.
  """
  taxCode: String
  """
  Amounts are including tax
  """
  taxInclusive: Boolean
  """
  Optional terms to be associated with the credit note.
  """
  terms: String
  """
  Amount of transaction
  """
  totalAmount: Float!
  """
  Total tax amount applied to this invoice.
  """
  totalTax: Float
  """
  Type of payment
  """
  type: CreditNoteType
}

input AllocationsListItemInput {
  """
  Amount of payment that should be attributed to this allocation. If null, the total_amount will be used.
  """
  amount: Float
  """
  Unique identifier of entity this payment should be attributed to.
  """
  id: String
  """
  Type of entity this payment should be attributed to.
  """
  type: AllocationType
}

"""
The customer this entity is linked to.
"""
input LinkedCustomerInput {
  """
  The display name of the customer.
  """
  displayName: String
  """
  The ID of the customer this entity is linked to.
  """
  id: String!
  """
  The name of the customer. Deprecated, use display_name instead.
  """
  name: String
}

input InvoiceLineItemInput {
  """
  User defined item code
  """
  code: String
  """
  Department id
  """
  departmentId: String
  """
  User defined description
  """
  description: String
  """
  Discount amount applied to the line item when supported downstream.
  """
  discountAmount: Float
  """
  Discount percentage applied to the line item when supported downstream.
  """
  discountPercentage: Float
  item: LinkedInvoiceItemInput
  ledgerAccount: LinkedLedgerAccountInput
  """
  Line number in the invoice
  """
  lineNumber: Int
  """
  Location id
  """
  locationId: String
  quantity: Float
  """
  Row ID
  """
  rowId: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Tax amount
  """
  taxAmount: Float
  taxRate: LinkedTaxRateInput
  """
  Total amount of the line item
  """
  totalAmount: Float
  """
  Item type
  """
  type: InvoiceLineItemType
  """
  Description of the unit type the item is sold as, ie: kg, hour.
  """
  unitOfMeasure: String
  unitPrice: Float
}

input CustomerInput {
  account: LinkedLedgerAccountInput
  addresses: [AddressInput]
  bankAccounts: [BankAccountInput]
  """
  The name of the company.
  """
  companyName: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Display ID
  """
  displayId: String
  """
  Display name
  """
  displayName: String
  emails: [EmailInput]
  """
  The first name of the person.
  """
  firstName: String
  """
  Is this an individual or business customer
  """
  individual: Boolean
  """
  The last name of the person.
  """
  lastName: String
  """
  Middle name of the person.
  """
  middleName: String
  """
  Some notes about this customer
  """
  notes: String
  """
  The parent customer this entity is linked to.
  """
  parent: LinkedParentCustomerInput
  phoneNumbers: [PhoneNumberInput]
  """
  If true, indicates this is a Project.
  """
  project: Boolean
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Customer status
  """
  status: CustomerStatus
  suffix: String
  taxNumber: String
  taxRate: LinkedTaxRateInput
  """
  The job title of the person.
  """
  title: String
  websites: [WebsiteInput]
}

input BankAccountInput {
  """
  The name which you used in opening your bank account.
  """
  accountName: String
  """
  A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number.
  """
  accountNumber: String
  """
  The type of bank account.
  """
  accountType: AccountType
  """
  A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.
  """
  bankCode: String
  bic: String
  """
  A branch identifier is a unique identifier for a branch of a bank or financial institution.
  """
  branchIdentifier: String
  """
  A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution.
  """
  bsbNumber: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  iban: String
}

input EmailInput {
  email: String!
  id: String
  type: EmailType
}

"""
The parent customer this entity is linked to.
"""
input LinkedParentCustomerInput {
  """
  The parent ID of the customer this entity is linked to.
  """
  id: String!
  """
  The name of the parent customer.
  """
  name: String
}

input PhoneNumberInput {
  areaCode: String
  countryCode: String
  extension: String
  id: String
  number: String!
  type: PhoneType
}

input WebsiteInput {
  id: String
  type: WebsiteType
  url: String!
}

input InvoiceItemInput {
  active: Boolean
  assetAccount: LinkedLedgerAccountInput
  """
  User defined item code
  """
  code: String
  """
  A short description of the item
  """
  description: String
  expenseAccount: LinkedLedgerAccountInput
  incomeAccount: LinkedLedgerAccountInput
  """
  The date of opening balance if inventory item is tracked - YYYY-MM-DD.
  """
  inventoryDate: String
  """
  Item name
  """
  name: String
  purchaseDetails: PurchaseDetailsInput
  """
  Item is available for purchase transactions
  """
  purchased: Boolean
  quantity: Float
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  salesDetails: SalesDetailsInput
  """
  Item will be available on sales transactions
  """
  sold: Boolean
  """
  If true, transactions for this item are taxable
  """
  taxable: Boolean
  """
  Item is inventoried
  """
  tracked: Boolean
  """
  Item type
  """
  type: InvoiceItemType
  unitPrice: Float
}

input PurchaseDetailsInput {
  """
  Amounts are including tax
  """
  taxInclusive: Boolean
  taxRate: LinkedTaxRateInput
  """
  Description of the unit type the item is sold as, ie: kg, hour.
  """
  unitOfMeasure: String
  unitPrice: Float
}

input SalesDetailsInput {
  """
  Amounts are including tax
  """
  taxInclusive: Boolean
  taxRate: LinkedTaxRateInput
  """
  Description of the unit type the item is sold as, ie: kg, hour.
  """
  unitOfMeasure: String
  unitPrice: Float
}

type InvoiceResponse {
  """
  The third-party API ID of original entity
  """
  downstreamId: String
  """
  A unique identifier for an object.
  """
  id: String
}

input InvoiceInput {
  """
  Balance of invoice due.
  """
  balance: Float
  billingAddress: AddressInput
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Currency Exchange Rate at the time entity was recorded/generated.
  """
  currencyRate: Float
  """
  The customer this entity is linked to.
  """
  customer: LinkedCustomerInput
  """
  Customer memo
  """
  customerMemo: String
  """
  Amount of deposit made to this invoice.
  """
  deposit: Float
  """
  Discount amount applied to this invoice.
  """
  discountAmount: Float
  """
  Discount percentage applied to this invoice.
  """
  discountPercentage: Float
  """
  The invoice due date is the date on which a payment or invoice is scheduled to be received by the seller - YYYY-MM-DD.
  """
  dueDate: String
  """
  Date invoice was issued - YYYY-MM-DD.
  """
  invoiceDate: String
  """
  Invoice sent to contact/customer.
  """
  invoiceSent: Boolean
  lineItems: [InvoiceLineItemInput]
  """
  Invoice number.
  """
  number: String
  """
  A PO Number uniquely identifies a purchase order and is generally defined by the buyer. The buyer will match the PO number in the invoice to the Purchase Order.
  """
  poNumber: String
  """
  Optional invoice reference.
  """
  reference: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  shippingAddress: AddressInput
  """
  URL link to a source document - shown as 'Go to [appName]' in the downstream app. Currently only supported for Xero.
  """
  sourceDocumentUrl: String
  """
  Invoice status
  """
  status: Status
  """
  Sub-total amount, normally before tax.
  """
  subTotal: Float
  """
  Applicable tax id/code override if tax is not supplied on a line item basis.
  """
  taxCode: String
  """
  Amounts are including tax
  """
  taxInclusive: Boolean
  """
  Optional invoice template
  """
  templateId: String
  """
  Terms of payment.
  """
  terms: String
  """
  Total amount of invoice, including tax.
  """
  total: Float
  """
  Total tax amount applied to this invoice.
  """
  totalTax: Float
  """
  Invoice type
  """
  type: InvoiceType
}

input JournalEntryInput {
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Currency Exchange Rate at the time entity was recorded/generated.
  """
  currencyRate: Float
  """
  Journal symbol of the entry. For example IND for indirect costs
  """
  journalSymbol: String
  """
  Requires a minimum of 2 line items that sum to 0
  """
  lineItems: [JournalEntryLineItemInput]
  """
  Reference for the journal entry.
  """
  memo: String
  """
  This is the date on which the journal entry was added. This can be different from the creation date and can also be backdated.
  """
  postedAt: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Journal entry title
  """
  title: String
}

input JournalEntryLineItemInput {
  """
  User defined description
  """
  description: String
  ledgerAccount: LinkedLedgerAccountInput!
  """
  Tax amount
  """
  taxAmount: Float
  taxRate: LinkedTaxRateInput
  """
  Debit entries are considered positive, and credit entries are considered negative.
  """
  totalAmount: Float!
  trackingCategory: LinkedTrackingCategoryInput
  """
  Debit entries are considered positive, and credit entries are considered negative.
  """
  type: JournalEntryLineItemType!
}

input LinkedTrackingCategoryInput {
  """
  The unique identifier for the tracking category.
  """
  id: String
  """
  The name of the tracking category.
  """
  name: String
}

input LedgerAccountInput {
  """
  Whether the account is active or not.
  """
  active: Boolean
  bankAccount: BankAccountInput
  """
  The classification of account.
  """
  classification: Classification
  """
  The code assigned to the account.
  """
  code: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  The current balance of the account.
  """
  currentBalance: Float
  """
  The description of the account.
  """
  description: String
  """
  The human readable display ID used when displaying the account
  """
  displayId: String
  """
  The fully qualified name of the account.
  """
  fullyQualifiedName: String
  """
  Whether the account is a header or not.
  """
  header: Boolean
  """
  Reconciliation Date means the last calendar day of each Reconciliation Period.
  """
  lastReconciliationDate: String
  level: Float
  """
  The name of the account.
  """
  name: String
  """
  The nominal code of the ledger account.
  """
  nominalCode: String
  """
  The opening balance of the account.
  """
  openingBalance: Float
  parentAccount: ParentAccountInput
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  The status of the account.
  """
  status: LedgerAccountStatus
  """
  Whether the account is a sub account or not.
  """
  subAccount: Boolean
  """
  The sub type of account.
  """
  subType: String
  taxRate: LinkedTaxRateInput
  """
  The tax type of the account.
  """
  taxType: String
  """
  The type of account.
  """
  type: LedgerAccountType
}

input ParentAccountInput {
  """
  The human readable display ID used when displaying the parent account
  """
  displayId: String
  """
  The ID of the parent account.
  """
  id: String
  """
  The name of the parent account.
  """
  name: String
}

input PaymentInput {
  account: LinkedLedgerAccountInput
  """
  Unique identifier for the account to allocate payment to.
  """
  accountsReceivableAccountId: String
  """
  Type of accounts receivable account.
  """
  accountsReceivableAccountType: String
  allocations: [PaymentAllocationInput]
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Currency Exchange Rate at the time entity was recorded/generated.
  """
  currencyRate: Float
  """
  The customer this entity is linked to.
  """
  customer: LinkedCustomerInput
  """
  Payment id to be displayed.
  """
  displayId: String
  """
  Optional note to be associated with the payment.
  """
  note: String
  """
  Payment method name
  """
  paymentMethod: String
  """
  Unique identifier for the payment method.
  """
  paymentMethodId: String
  """
  Optional reference message returned by payment method on processing
  """
  paymentMethodReference: String
  """
  Payment has been reconciled
  """
  reconciled: Boolean
  """
  Optional payment reference message ie: Debit remittance detail.
  """
  reference: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Status of payment
  """
  status: PaymentStatus
  """
  The supplier this entity is linked to.
  """
  supplier: LinkedSupplierInput
  """
  Amount of payment
  """
  totalAmount: Float!
  """
  Date transaction was entered - YYYY:MM::DDThh:mm:ss.sTZD
  """
  transactionDate: String!
  """
  Type of payment
  """
  type: PaymentType
}

input PaymentAllocationInput {
  """
  Amount of payment that should be attributed to this allocation. If null, the total_amount will be used.
  """
  amount: Float
  """
  Unique identifier of entity this payment should be attributed to.
  """
  id: String
  """
  Type of entity this payment should be attributed to.
  """
  type: AllocationType
}

input SupplierInput {
  account: LinkedLedgerAccountInput
  addresses: [AddressInput]
  bankAccounts: [BankAccountInput]
  """
  The name of the company.
  """
  companyName: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Display ID
  """
  displayId: String
  """
  Display name
  """
  displayName: String
  emails: [EmailInput]
  """
  The first name of the person.
  """
  firstName: String
  """
  Is this an individual or business supplier
  """
  individual: Boolean
  """
  The last name of the person.
  """
  lastName: String
  """
  Middle name of the person.
  """
  middleName: String
  """
  Some notes about this supplier
  """
  notes: String
  phoneNumbers: [PhoneNumberInput]
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Supplier status
  """
  status: SupplierStatus
  suffix: String
  taxNumber: String
  taxRate: LinkedTaxRateInput
  """
  The job title of the person.
  """
  title: String
  websites: [WebsiteInput]
}

input TaxRateInput {
  """
  Tax code assigned to identify this tax rate.
  """
  code: String
  components: [ComponentsListItemInput]
  """
  Description of tax rate
  """
  description: String
  """
  Effective tax rate
  """
  effectiveTaxRate: Float
  """
  ID assigned to identify this tax rate.
  """
  id: String
  """
  Name assigned to identify this tax rate.
  """
  name: String
  """
  ID of the original tax rate from which the new tax rate is derived. Helps to understand the relationship between corresponding tax rate entities.
  """
  originalTaxRateId: String
  """
  Report Tax type to aggregate tax collected or paid for reporting purposes
  """
  reportTaxType: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  Tax rate status
  """
  status: TaxRateStatus
  """
  Unique identifier for the account for tax collected.
  """
  taxPayableAccountId: String
  """
  Unique identifier for the account for tax remitted.
  """
  taxRemittedAccountId: String
  """
  Not compounded sum of the components of a tax rate
  """
  totalTaxRate: Float
  """
  Tax type used to indicate the source of tax collected or paid
  """
  type: String
}

input ComponentsListItemInput {
  compound: Boolean
  id: String
  name: String
  rate: Float
}

type Ats {
  """
  Get applicant
  """
  applicant(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Applicant
  """
  List applicants
  """
  applicants(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: JobsFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): ApplicantList
  """
  Get Job
  """
  job(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Job
  """
  List Jobs
  """
  jobs(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): JobList
}

type Applicant {
  addresses: [Address]
  anonymized: Boolean
  applications: [String]
  archived: Boolean
  """
  The date of birth of the person.
  """
  birthday: String
  confidential: Boolean
  coordinatorId: String
  coverLetter: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  customFields: [CustomField]
  cvUrl: String
  deleted: Boolean
  """
  The time at which the object was deleted.
  """
  deletedAt: String
  """
  The user who deleted the object.
  """
  deletedBy: String
  emails: [Email]
  """
  The first name of the person.
  """
  firstName: String
  followers: [String]
  """
  Typically a list of previous companies where the contact has worked or schools that the contact has attended
  """
  headline: String
  """
  A unique identifier for an object.
  """
  id: String
  """
  The initials of the person, usually derived from their first, middle, and last names.
  """
  initials: String
  jobUrl: String
  lastInteractionAt: String
  """
  The last name of the person.
  """
  lastName: String
  """
  Middle name of the person.
  """
  middleName: String
  """
  The name of an applicant.
  """
  name: String
  ownerId: String
  phoneNumbers: [PhoneNumber]
  """
  The URL of the photo of a person.
  """
  photoUrl: String
  """
  The PositionId the applicant applied for.
  """
  positionId: String
  recordUrl: String
  recruiterId: String
  rejectedAt: String
  socialLinks: [SocialLinksListItem]
  sourceId: String
  sourcedBy: String
  sources: [String]
  stageId: String
  tags: [String]
  """
  The job title of the person.
  """
  title: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
  websites: [WebsitesListItem]
}

type CustomField {
  """
  More information about the custom field
  """
  description: String
  id: String!
  """
  Name of the custom field.
  """
  name: String
  value: JSON
}

type SocialLinksListItem {
  id: String
  type: String
  url: String!
}

type WebsitesListItem {
  id: String
  type: WebsiteType
  url: String!
}

type ApplicantList {
  data: [Applicant]!
  """
  Response metadata
  """
  meta: Meta
}

input JobsFilterInput {
  """
  Id of the job to filter on
  """
  jobId: String
}

type Job {
  addresses: [Address]
  """
  Specifies whether an employee of the organization can apply for the job.
  """
  availableToEmployees: Boolean
  blocks: [BlocksListItem]
  """
  Details of the branch for which the job is created.
  """
  branch: Branch
  closing: String
  closingDate: String
  """
  The closing section of the job description in HTML format
  """
  closingHtml: String
  """
  The code of the job.
  """
  code: String
  confidential: Boolean
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  deleted: Boolean
  department: Department
  """
  A description of the object.
  """
  description: String
  """
  The job description in HTML format
  """
  descriptionHtml: String
  employmentTerms: EmploymentTerms
  """
  Level of experience required for the job role.
  """
  experience: String
  followers: [String]
  hiringManagers: [HiringManagersListItem]
  """
  A unique identifier for an object.
  """
  id: String
  """
  URL of the job portal
  """
  jobPortalUrl: String
  """
  language code according to ISO 639-1. For the United States - EN
  """
  language: String
  ownerId: String
  publishedAt: String
  recordUrl: String
  """
  The recruiter is generally someone who is tasked to help the hiring manager find and screen qualified applicant
  """
  recruiters: [String]
  """
  Specifies whether the posting is for a remote job.
  """
  remote: Boolean
  """
  A job's Requisition ID (Req ID) allows your organization to identify and track a job based on alphanumeric naming conventions unique to your company's internal processes.
  """
  requisitionId: String
  salary: Salary
  """
  Sequence in relation to other jobs.
  """
  sequence: Int
  slug: String
  """
  The status of the job.
  """
  status: JobStatus
  tags: [String]
  """
  The job title of the person.
  """
  title: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
  """
  URL of the job description
  """
  url: String
  """
  The visibility of the job
  """
  visibility: Visibility
}

type BlocksListItem {
  content: String
  title: String
}

"""
Details of the branch for which the job is created.
"""
type Branch {
  """
  A unique identifier for an object.
  """
  id: String
  """
  Name of the branch.
  """
  name: String
}

type Department {
  code: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  description: String
  """
  A unique identifier for an object.
  """
  id: String
  """
  Department name
  """
  name: String
  """
  Parent ID
  """
  parentId: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

enum EmploymentTerms {
  fulltime
  parttime
  internship
  contractor
  employee
  freelance
  temp
  seasonal
  volunteer
  other
}

type HiringManagersListItem {
  id: String
}

type Salary {
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  Maximum salary payable for the job role.
  """
  max: Int
  """
  Minimum salary payable for the job role.
  """
  min: Int
}

enum JobStatus {
  draft
  internal
  published
  completed
  onhold
  private
}

enum Visibility {
  public
  internal
}

type JobList {
  data: [Job]!
  """
  Response metadata
  """
  meta: Meta
}

type MutationAts {
  """
  Create applicant
  """
  applicantsAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: ApplicantInput!
  ): UnifiedId
}

input ApplicantInput {
  addresses: [AddressInput]
  anonymized: Boolean
  applications: [String]
  archived: Boolean
  """
  The date of birth of the person.
  """
  birthday: String
  confidential: Boolean
  coordinatorId: String
  coverLetter: String
  customFields: [CustomFieldInput]
  deleted: Boolean
  emails: [EmailInput]
  """
  The first name of the person.
  """
  firstName: String
  followers: [String]
  """
  Typically a list of previous companies where the contact has worked or schools that the contact has attended
  """
  headline: String
  """
  The initials of the person, usually derived from their first, middle, and last names.
  """
  initials: String
  """
  The last name of the person.
  """
  lastName: String
  """
  Middle name of the person.
  """
  middleName: String
  """
  The name of an applicant.
  """
  name: String
  ownerId: String
  phoneNumbers: [PhoneNumberInput]
  """
  The URL of the photo of a person.
  """
  photoUrl: String
  """
  The PositionId the applicant applied for.
  """
  positionId: String
  recordUrl: String
  recruiterId: String
  socialLinks: [SocialLinksListItemInput]
  sources: [String]
  stageId: String
  tags: [String]
  """
  The job title of the person.
  """
  title: String
  websites: [WebsitesListItemInput]
}

input CustomFieldInput {
  """
  More information about the custom field
  """
  description: String
  id: String!
  """
  Name of the custom field.
  """
  name: String
  value: JSON
}

input SocialLinksListItemInput {
  id: String
  type: String
  url: String!
}

input WebsitesListItemInput {
  id: String
  type: WebsiteType
  url: String!
}

type Crm {
  """
  List activities
  """
  activities(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: ActivitiesFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): ActivityList
  """
  Get activity
  """
  activity(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Activity
  """
  List companies
  """
  companies(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: CompaniesFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    Apply sorting
    """
    sort: CompaniesSortInput
  ): CompanyList
  """
  Get company
  """
  company(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Company
  """
  Get contact
  """
  contact(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Contact
  """
  List contacts
  """
  contacts(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: ContactsFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    Apply sorting
    """
    sort: ContactsSortInput
  ): ContactList
  """
  Get lead
  """
  lead(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Lead
  """
  List leads
  """
  leads(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: LeadsFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    Apply sorting
    """
    sort: LeadsSortInput
  ): LeadList
  """
  Get note
  """
  note(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Note
  """
  List notes
  """
  notes(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): NoteList
  """
  List opportunities
  """
  opportunities(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: OpportunitiesFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    Apply sorting
    """
    sort: OpportunitiesSortInput
  ): OpportunityList
  """
  Get opportunity
  """
  opportunity(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Opportunity
  """
  Get pipeline
  """
  pipeline(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Pipeline
  """
  List pipelines
  """
  pipelines(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): PipelinesList
  """
  Get user
  """
  user(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): User
  """
  List users
  """
  users(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UserList
}

type ActivityList {
  data: [Activity]!
  """
  Response metadata
  """
  meta: Meta
}

type Activity {
  accountId: String
  activityDate: String
  activityDatetime: String
  allDayEvent: Boolean
  archived: Boolean
  assetId: String
  attendees: [ActivityAttendee]
  campaignId: String
  caseId: String
  child: Boolean
  companyId: String
  contactId: String
  contractId: String
  createdAt: String
  createdBy: String
  customFields: [CustomField]
  customObjectId: String
  deleted: Boolean
  description: String
  """
  Whether the Activity is done or not
  """
  done: Boolean
  """
  The third-party API ID of original entity
  """
  downstreamId: String
  durationMinutes: Int
  durationSeconds: Int
  endDate: String
  endDatetime: String
  eventSubType: String
  groupEvent: Boolean
  groupEventType: String
  id: String
  leadId: String
  location: String
  locationAddress: Address
  note: String
  opportunityId: String
  ownerId: String
  private: Boolean
  productId: String
  recurrent: Boolean
  reminderDatetime: String
  reminderSet: Boolean
  showAs: ShowAs
  solutionId: String
  startDatetime: String
  title: String
  type: ActivityType!
  updatedAt: String
  updatedBy: String
  userId: String
  videoConferenceId: String
  videoConferenceUrl: String
}

type ActivityAttendee {
  contactId: String
  createdAt: String
  emailAddress: String
  firstName: String
  id: String
  isOrganizer: Boolean
  lastName: String
  middleName: String
  name: String
  prefix: String
  status: Status
  suffix: String
  updatedAt: String
  userId: String
}

enum ShowAs {
  free
  busy
}

enum ActivityType {
  call
  meeting
  email
  note
  task
  deadline
  sendletter
  sendquote
  other
}

input ActivitiesFilterInput {
  updatedSince: String
}

type CompanyList {
  data: [Company]!
  """
  Response metadata
  """
  meta: Meta
}

type Company {
  """
  An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity.
  """
  abnBranch: String
  """
  An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia.
  """
  abnOrTfn: String
  """
  The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank.
  """
  acn: String
  addresses: [Address]
  """
  Annual revenue
  """
  annualRevenue: String
  bankAccounts: [BankAccount]
  """
  The date of birth of the person.
  """
  birthday: String
  createdAt: String
  createdBy: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  customFields: [CustomField]
  deleted: Boolean
  description: String
  emails: [Email]
  fax: String
  """
  The first name of the person.
  """
  firstName: String
  id: String
  image: String
  """
  Industry
  """
  industry: String
  interactionCount: Int
  lastActivityAt: String
  """
  The last name of the person.
  """
  lastName: String
  name: String!
  """
  Number of employees
  """
  numberOfEmployees: String
  ownerId: String
  """
  Ownership
  """
  ownership: String
  """
  Parent ID
  """
  parentId: String
  payeeNumber: String
  phoneNumbers: [PhoneNumber]
  readOnly: Boolean
  rowType: CompanyRowType
  salesTaxNumber: String
  """
  A formal salutation for the person. For example, 'Mr', 'Mrs'
  """
  salutation: String
  socialLinks: [SocialLink]
  status: String
  tags: [String]
  updatedAt: String
  updatedBy: String
  """
  VAT number
  """
  vatNumber: String
  websites: [Website]
}

type CompanyRowType {
  id: String
  name: String
}

type SocialLink {
  id: String
  type: String
  url: String!
}

input CompaniesFilterInput {
  """
  Name of the company to filter on
  """
  name: String
}

input CompaniesSortInput {
  """
  The field on which to sort the Companies
  """
  by: CompaniesSortBy
  """
  The direction in which to sort the results
  """
  direction: SortDirection
}

enum CompaniesSortBy {
  created_at
  updated_at
  name
}

type Contact {
  active: Boolean
  addresses: [Address]
  birthday: String
  companyId: String
  companyName: String
  createdAt: String
  currentBalance: Float
  customFields: [CustomField]
  department: String
  description: String
  emailDomain: String
  emails: [Email]
  fax: String
  firstCallAt: String
  firstEmailAt: String
  firstName: String
  gender: Gender
  id: String
  image: String
  """
  language code according to ISO 639-1. For the United States - EN
  """
  language: String
  lastActivityAt: String
  lastName: String
  leadId: String
  leadSource: String
  middleName: String
  name: String!
  ownerId: String
  phoneNumbers: [PhoneNumber]
  """
  The URL of the photo of a person.
  """
  photoUrl: String
  prefix: String
  socialLinks: [SocialLink]
  status: String
  suffix: String
  tags: [String]
  title: String
  type: Type
  updatedAt: String
  websites: [Website]
}

enum Gender {
  male
  female
  unisex
  other
  not_specified
}

enum Type {
  text
  checkbox
  tel
  email
  url
  textarea
  select
  filteredselect
  multiselect
  datetime
  date
  time
  number
  sms
  mms
  contractor
  employee
  freelance
  temp
  internship
  other
  customer
  supplier
  personal
}

type ContactList {
  data: [Contact]!
  """
  Response metadata
  """
  meta: Meta
}

input ContactsFilterInput {
  """
  Unique identifier for the associated company of the contact to filter on
  """
  companyId: String
  """
  Email of the contact to filter on
  """
  email: String
  """
  First name of the contact to filter on
  """
  firstName: String
  """
  Last name of the contact to filter on
  """
  lastName: String
  """
  Name of the contact to filter on
  """
  name: String
}

input ContactsSortInput {
  """
  The field on which to sort the Contacts
  """
  by: ContactsSortBy
  """
  The direction in which to sort the results
  """
  direction: SortDirection
}

enum ContactsSortBy {
  created_at
  updated_at
  name
  first_name
  last_name
  email
}

type Lead {
  addresses: [Address]
  companyId: String
  companyName: String!
  contactId: String
  createdAt: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  customFields: [CustomField]
  description: String
  emails: [Email]
  fax: String
  firstName: String
  id: String
  """
  language code according to ISO 639-1. For the United States - EN
  """
  language: String
  lastName: String
  leadSource: String
  monetaryAmount: Float
  name: String!
  ownerId: String
  phoneNumbers: [PhoneNumber]
  prefix: String
  socialLinks: [SocialLink]
  status: String
  tags: [String]
  title: String
  updatedAt: String
  websites: [Website]
  """
  Get lead
  """
  lead(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Lead
  """
  List leads
  """
  leads(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: LeadsFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    Apply sorting
    """
    sort: LeadsSortInput
  ): LeadList
}

type LeadList {
  data: [Lead]!
  """
  Response metadata
  """
  meta: Meta
}

input LeadsFilterInput {
  """
  E-mail of the lead to filter on
  """
  email: String
  """
  First name of the lead to filter on
  """
  firstName: String
  """
  Last name of the lead to filter on
  """
  lastName: String
  """
  Name of the lead to filter on
  """
  name: String
}

input LeadsSortInput {
  """
  The field on which to sort the Leads
  """
  by: LeadsSortBy
  """
  The direction in which to sort the results
  """
  direction: SortDirection
}

enum LeadsSortBy {
  created_at
  updated_at
  name
  first_name
  last_name
  email
}

type Note {
  active: Boolean
  companyId: String
  contactId: String
  content: String
  createdAt: String
  createdBy: String
  id: String
  leadId: String
  opportunityId: String
  ownerId: String
  title: String
  updatedAt: String
  updatedBy: String
}

type NoteList {
  data: [Note]!
  """
  Response metadata
  """
  meta: Meta
}

type OpportunityList {
  data: [Opportunity]!
  """
  Response metadata
  """
  meta: Meta
}

type Opportunity {
  """
  The actual closing date for the opportunity. If close_date is null, the opportunity is not closed yet.
  """
  closeDate: String
  """
  The unique identifier of the company associated with the opportunity.
  """
  companyId: String
  """
  The name of the company associated with the opportunity.
  """
  companyName: String
  """
  The unique identifier of the contact associated with the opportunity.
  """
  contactId: String
  """
  An array of unique identifiers of all contacts associated with the opportunity.
  """
  contactIds: [String]
  """
  The date and time when the opportunity was created.
  """
  createdAt: String
  """
  The unique identifier of the user who created the opportunity.
  """
  createdBy: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  customFields: [CustomField]
  """
  The date and time when the opportunity was last contacted.
  """
  dateLastContacted: String
  """
  The date and time when the lead associated with the opportunity was created.
  """
  dateLeadCreated: String
  """
  The date and time when the stage of the opportunity was last changed.
  """
  dateStageChanged: String
  """
  Indicates whether the opportunity has been deleted.
  """
  deleted: Boolean
  """
  A description of the opportunity.
  """
  description: String
  """
  The expected revenue from the opportunity
  """
  expectedRevenue: Float
  """
  A unique identifier for the opportunity.
  """
  id: String
  """
  The number of interactions with the opportunity.
  """
  interactionCount: Float
  """
  The date and time of the last activity associated with the opportunity.
  """
  lastActivityAt: String
  """
  The unique identifier of the lead associated with the opportunity.
  """
  leadId: String
  """
  The source of the lead associated with the opportunity.
  """
  leadSource: String
  """
  The reason why the opportunity was lost.
  """
  lossReason: String
  """
  The unique identifier of the reason why the opportunity was lost.
  """
  lossReasonId: String
  """
  The monetary value associated with the opportunity
  """
  monetaryAmount: Float
  """
  The unique identifier of the user who owns the opportunity.
  """
  ownerId: String
  """
  The unique identifier of the pipeline associated with the opportunity
  """
  pipelineId: String
  """
  The unique identifier of the stage in the pipeline associated with the opportunity.
  """
  pipelineStageId: String
  """
  The unique identifier of the primary contact associated with the opportunity.
  """
  primaryContactId: String!
  """
  The priority level of the opportunity.
  """
  priority: String
  """
  The unique identifier of the source of the opportunity.
  """
  sourceId: String
  """
  The date and time when the stage of the opportunity was last changed.
  """
  stageLastChangedAt: String
  """
  The current status of the opportunity.
  """
  status: String
  """
  The unique identifier of the current status of the opportunity.
  """
  statusId: String
  tags: [String]
  """
  The title or name of the opportunity.
  """
  title: String!
  """
  The type of the opportunity
  """
  type: String
  """
  The date and time when the opportunity was last updated.
  """
  updatedAt: String
  """
  The unique identifier of the user who last updated the opportunity.
  """
  updatedBy: String
  """
  The probability of winning the opportunity, expressed as a percentage.
  """
  winProbability: Float
  """
  The reason why the opportunity was won.
  """
  wonReason: String
  """
  The unique identifier of the reason why the opportunity was won.
  """
  wonReasonId: String
}

input OpportunitiesFilterInput {
  """
  Company ID to filter on
  """
  companyId: String
  """
  Monetary amount to filter on
  """
  monetaryAmount: Float
  """
  Status to filter on
  """
  status: String
  """
  Title of the opportunity to filter on
  """
  title: String
  """
  Win probability to filter on
  """
  winProbability: Float
}

input OpportunitiesSortInput {
  """
  The field on which to sort the Opportunities
  """
  by: OpportunitiesSortBy
  """
  The direction in which to sort the results
  """
  direction: SortDirection
}

enum OpportunitiesSortBy {
  created_at
  updated_at
  title
  win_probability
  monetary_amount
  status
}

type Pipeline {
  active: Boolean
  archived: Boolean
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  displayOrder: Int
  id: String
  name: String!
  stages: [StagesListItem]
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  winProbabilityEnabled: Boolean
}

type StagesListItem {
  displayOrder: Int
  id: String
  name: String
  value: String
  """
  The expected probability of winning an Opportunity in this Pipeline Stage. Valid values are [0-100].
  """
  winProbability: Int
}

type PipelinesList {
  data: [Pipeline]!
  """
  Response metadata
  """
  meta: Meta
}

type User {
  addresses: [Address]
  """
  The name of the company.
  """
  companyName: String
  createdAt: String
  """
  The department the person is currently in. [Deprecated](https://developers.apideck.com/changelog) in favor of the dedicated department_id and department_name field.
  """
  department: String
  """
  A description of the object.
  """
  description: String
  """
  The division the person is currently in. Usually a collection of departments or teams or regions.
  """
  division: String
  emails: [Email]!
  """
  An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.
  """
  employeeNumber: String
  """
  The first name of the person.
  """
  firstName: String
  id: String
  image: String
  """
  language code according to ISO 639-1. For the United States - EN
  """
  language: String
  """
  The last name of the person.
  """
  lastName: String
  parentId: String
  phoneNumbers: [PhoneNumber]
  status: String
  """
  The job title of the person.
  """
  title: String
  updatedAt: String
  username: String
}

type UserList {
  data: [User]!
  """
  Response metadata
  """
  meta: Meta
}

type MutationCrm {
  """
  Create activity
  """
  activitiesAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: ActivityInput!
  ): UnifiedId
  """
  Delete activity
  """
  activitiesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update activity
  """
  activitiesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: ActivityInput!
  ): UnifiedId
  """
  Create company
  """
  companiesAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: CompanyInput!
  ): UnifiedId
  """
  Delete company
  """
  companiesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update company
  """
  companiesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: CompanyInput!
  ): UnifiedId
  """
  Create contact
  """
  contactsAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: ContactInput!
  ): UnifiedId
  """
  Delete contact
  """
  contactsDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update contact
  """
  contactsUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: ContactInput!
  ): UnifiedId
  """
  Create lead
  """
  leadsAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: LeadInput!
  ): UnifiedId
  """
  Delete lead
  """
  leadsDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update lead
  """
  leadsUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: LeadInput!
  ): UnifiedId
  """
  Create note
  """
  notesAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: NoteInput!
  ): UnifiedId
  """
  Delete note
  """
  notesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update note
  """
  notesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: NoteInput!
  ): UnifiedId
  """
  Create opportunity
  """
  opportunitiesAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: OpportunityInput!
  ): UnifiedId
  """
  Delete opportunity
  """
  opportunitiesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update opportunity
  """
  opportunitiesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: OpportunityInput!
  ): UnifiedId
  """
  Create pipeline
  """
  pipelinesAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: PipelineInput!
  ): UnifiedId
  """
  Delete pipeline
  """
  pipelinesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update pipeline
  """
  pipelinesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: PipelineInput!
  ): UnifiedId
  """
  Create user
  """
  usersAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: UserInput!
  ): UnifiedId
  """
  Delete user
  """
  usersDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update user
  """
  usersUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: UserInput!
  ): UnifiedId
}

input ActivityInput {
  accountId: String
  activityDate: String
  activityDatetime: String
  allDayEvent: Boolean
  archived: Boolean
  assetId: String
  attendees: [ActivityAttendeeInput]
  campaignId: String
  caseId: String
  child: Boolean
  companyId: String
  contactId: String
  contractId: String
  customFields: [CustomFieldInput]
  customObjectId: String
  deleted: Boolean
  description: String
  """
  Whether the Activity is done or not
  """
  done: Boolean
  durationSeconds: Int
  endDate: String
  endDatetime: String
  eventSubType: String
  groupEvent: Boolean
  groupEventType: String
  leadId: String
  location: String
  locationAddress: AddressInput
  note: String
  opportunityId: String
  ownerId: String
  private: Boolean
  productId: String
  recurrent: Boolean
  reminderDatetime: String
  reminderSet: Boolean
  showAs: ShowAs
  solutionId: String
  startDatetime: String
  title: String
  type: ActivityType!
  userId: String
  videoConferenceId: String
  videoConferenceUrl: String
}

input ActivityAttendeeInput {
  emailAddress: String
  firstName: String
  isOrganizer: Boolean
  lastName: String
  middleName: String
  name: String
  prefix: String
  status: Status
  suffix: String
}

input CompanyInput {
  """
  An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity.
  """
  abnBranch: String
  """
  An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia.
  """
  abnOrTfn: String
  """
  The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank.
  """
  acn: String
  addresses: [AddressInput]
  """
  Annual revenue
  """
  annualRevenue: String
  bankAccounts: [BankAccountInput]
  """
  The date of birth of the person.
  """
  birthday: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  customFields: [CustomFieldInput]
  description: String
  emails: [EmailInput]
  fax: String
  """
  The first name of the person.
  """
  firstName: String
  image: String
  """
  Industry
  """
  industry: String
  """
  The last name of the person.
  """
  lastName: String
  name: String!
  """
  Number of employees
  """
  numberOfEmployees: String
  ownerId: String
  """
  Ownership
  """
  ownership: String
  payeeNumber: String
  phoneNumbers: [PhoneNumberInput]
  readOnly: Boolean
  rowType: CompanyRowTypeInput
  salesTaxNumber: String
  """
  A formal salutation for the person. For example, 'Mr', 'Mrs'
  """
  salutation: String
  socialLinks: [SocialLinkInput]
  status: String
  tags: [String]
  """
  VAT number
  """
  vatNumber: String
  websites: [WebsiteInput]
}

input CompanyRowTypeInput {
  id: String
  name: String
}

input SocialLinkInput {
  id: String
  type: String
  url: String!
}

input ContactInput {
  active: Boolean
  addresses: [AddressInput]
  birthday: String
  companyId: String
  companyName: String
  currentBalance: Float
  customFields: [CustomFieldInput]
  department: String
  description: String
  emailDomain: String
  emails: [EmailInput]
  fax: String
  firstName: String
  gender: Gender
  image: String
  """
  language code according to ISO 639-1. For the United States - EN
  """
  language: String
  lastName: String
  leadId: String
  leadSource: String
  middleName: String
  name: String!
  ownerId: String
  phoneNumbers: [PhoneNumberInput]
  """
  The URL of the photo of a person.
  """
  photoUrl: String
  prefix: String
  socialLinks: [SocialLinkInput]
  status: String
  suffix: String
  tags: [String]
  title: String
  type: Type
  websites: [WebsiteInput]
}

input LeadInput {
  addresses: [AddressInput]
  companyId: String
  companyName: String!
  contactId: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  customFields: [CustomFieldInput]
  description: String
  emails: [EmailInput]
  fax: String
  firstName: String
  """
  language code according to ISO 639-1. For the United States - EN
  """
  language: String
  lastName: String
  leadSource: String
  monetaryAmount: Float
  name: String!
  ownerId: String
  phoneNumbers: [PhoneNumberInput]
  prefix: String
  socialLinks: [SocialLinkInput]
  status: String
  tags: [String]
  title: String
  websites: [WebsiteInput]
}

input NoteInput {
  active: Boolean
  companyId: String
  contactId: String
  content: String
  leadId: String
  opportunityId: String
  ownerId: String
  title: String
}

input OpportunityInput {
  """
  The actual closing date for the opportunity. If close_date is null, the opportunity is not closed yet.
  """
  closeDate: String
  """
  The unique identifier of the company associated with the opportunity.
  """
  companyId: String
  """
  The name of the company associated with the opportunity.
  """
  companyName: String
  """
  The unique identifier of the contact associated with the opportunity.
  """
  contactId: String
  """
  An array of unique identifiers of all contacts associated with the opportunity.
  """
  contactIds: [String]
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  customFields: [CustomFieldInput]
  """
  A description of the opportunity.
  """
  description: String
  """
  The unique identifier of the lead associated with the opportunity.
  """
  leadId: String
  """
  The source of the lead associated with the opportunity.
  """
  leadSource: String
  """
  The reason why the opportunity was lost.
  """
  lossReason: String
  """
  The unique identifier of the reason why the opportunity was lost.
  """
  lossReasonId: String
  """
  The monetary value associated with the opportunity
  """
  monetaryAmount: Float
  """
  The unique identifier of the user who owns the opportunity.
  """
  ownerId: String
  """
  The unique identifier of the pipeline associated with the opportunity
  """
  pipelineId: String
  """
  The unique identifier of the stage in the pipeline associated with the opportunity.
  """
  pipelineStageId: String
  """
  The unique identifier of the primary contact associated with the opportunity.
  """
  primaryContactId: String!
  """
  The priority level of the opportunity.
  """
  priority: String
  """
  The unique identifier of the source of the opportunity.
  """
  sourceId: String
  """
  The date and time when the stage of the opportunity was last changed.
  """
  stageLastChangedAt: String
  """
  The current status of the opportunity.
  """
  status: String
  """
  The unique identifier of the current status of the opportunity.
  """
  statusId: String
  tags: [String]
  """
  The title or name of the opportunity.
  """
  title: String!
  """
  The type of the opportunity
  """
  type: String
  """
  The probability of winning the opportunity, expressed as a percentage.
  """
  winProbability: Float
  """
  The reason why the opportunity was won.
  """
  wonReason: String
  """
  The unique identifier of the reason why the opportunity was won.
  """
  wonReasonId: String
}

input PipelineInput {
  active: Boolean
  archived: Boolean
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  displayOrder: Int
  id: String
  name: String!
  stages: [StagesListItemInput]
  winProbabilityEnabled: Boolean
}

input StagesListItemInput {
  displayOrder: Int
  name: String
  value: String
  """
  The expected probability of winning an Opportunity in this Pipeline Stage. Valid values are [0-100].
  """
  winProbability: Int
}

input UserInput {
  addresses: [AddressInput]
  """
  The name of the company.
  """
  companyName: String
  """
  The department the person is currently in. [Deprecated](https://developers.apideck.com/changelog) in favor of the dedicated department_id and department_name field.
  """
  department: String
  """
  A description of the object.
  """
  description: String
  """
  The division the person is currently in. Usually a collection of departments or teams or regions.
  """
  division: String
  emails: [EmailInput]!
  """
  An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.
  """
  employeeNumber: String
  """
  The first name of the person.
  """
  firstName: String
  image: String
  """
  language code according to ISO 639-1. For the United States - EN
  """
  language: String
  """
  The last name of the person.
  """
  lastName: String
  parentId: String
  password: String
  phoneNumbers: [PhoneNumberInput]
  status: String
  """
  The job title of the person.
  """
  title: String
  username: String
}

type CustomerSupport {
  """
  Get Customer Support Customer
  """
  customerSupportCustomer(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): CustomerSupportCustomer
  """
  List Customer Support Customers
  """
  customerSupportCustomers(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): CustomerSupportCustomerList
}

type CustomerSupportCustomer {
  addresses: [Address]
  bankAccounts: BankAccount
  """
  The name of the company.
  """
  companyName: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  emails: [Email]
  """
  The first name of the person.
  """
  firstName: String
  """
  A unique identifier for an object.
  """
  id: String
  individual: Boolean
  """
  The last name of the person.
  """
  lastName: String
  notes: String
  phoneNumbers: [PhoneNumber]
  """
  Customer status
  """
  status: CustomerStatus
  taxNumber: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type CustomerSupportCustomerList {
  data: [CustomerSupportCustomer]!
  """
  Response metadata
  """
  meta: Meta
}

type MutationCustomerSupport {
  """
  Create Customer Support Customer
  """
  customersAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: CustomerSupportCustomerInput!
  ): UnifiedId
  """
  Delete Customer Support Customer
  """
  customersDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Customer Support Customer
  """
  customersUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: CustomerSupportCustomerInput!
  ): UnifiedId
}

input CustomerSupportCustomerInput {
  addresses: [AddressInput]
  bankAccounts: BankAccountInput
  """
  The name of the company.
  """
  companyName: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  emails: [EmailInput]
  """
  The first name of the person.
  """
  firstName: String
  individual: Boolean
  """
  The last name of the person.
  """
  lastName: String
  notes: String
  phoneNumbers: [PhoneNumberInput]
  """
  Customer status
  """
  status: CustomerStatus
  taxNumber: String
}

type Ecommerce {
  """
  List Customers
  """
  customers(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: EcommerceCustomersFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): EcommerceCustomerList
  """
  Get Customer
  """
  ecommerceCustomer(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): EcommerceCustomer
  """
  Get Order
  """
  ecommerceOrder(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): EcommerceOrder
  """
  Get Product
  """
  ecommerceProduct(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): EcommerceProduct
  """
  Get Store
  """
  ecommerceStore(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): EcommerceStore
  """
  List Orders
  """
  orders(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: EcommerceOrdersFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): EcommerceOrderList
  """
  List Products
  """
  products(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): EcommerceProductList
}

type EcommerceCustomerList {
  data: [EcommerceCustomer]!
  """
  Response metadata
  """
  meta: Meta
}

type EcommerceCustomer {
  """
  An array of addresses for the customer.
  """
  addresses: [AddressesListItem]
  """
  Company name of the customer
  """
  companyName: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  An array of email addresses for the customer.
  """
  emails: [Email]
  """
  First name of the customer
  """
  firstName: String
  """
  A unique identifier for an object.
  """
  id: String!
  """
  Last name of the customer
  """
  lastName: String
  """
  Full name of the customer
  """
  name: String
  orders: [LinkedEcommerceOrder]
  """
  An array of phone numbers for the customer.
  """
  phoneNumbers: [PhoneNumber]
  """
  The current status of the customer
  """
  status: EcommerceCustomerStatus
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
}

type AddressesListItem {
  """
  City of the customer
  """
  city: String
  """
  Country of the customer
  """
  country: String
  """
  A unique identifier for an object.
  """
  id: String
  """
  First line of the street address of the customer
  """
  line1: String
  """
  Second line of the street address of the customer
  """
  line2: String
  """
  Postal code of the customer
  """
  postalCode: String
  """
  State of the customer
  """
  state: String
  type: EcommerceCustomerAddressType
}

enum EcommerceCustomerAddressType {
  billing
  shipping
  other
}

"""
The order this entity is linked to.
"""
type LinkedEcommerceOrder {
  """
  A unique identifier for an object.
  """
  id: String
  """
  Current status of the order.
  """
  status: EcommerceOrderStatus
  """
  The total amount of the order.
  """
  total: String
}

enum EcommerceOrderStatus {
  active
  completed
  cancelled
  archived
  unknown
}

enum EcommerceCustomerStatus {
  active
  archived
}

input EcommerceCustomersFilterInput {
  """
  Customer email address to filter on
  """
  email: String
  """
  Customer phone number to filter on
  """
  phoneNumber: String
}

type EcommerceOrder {
  """
  An object representing a shipping or billing address.
  """
  billingAddress: EcommerceAddress
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  The customer this entity is linked to.
  """
  customer: LinkedEcommerceCustomer
  discounts: [EcommerceDiscount]
  """
  Current fulfillment status of the order.
  """
  fulfillmentStatus: EcommerceFulfillmentStatus
  """
  A unique identifier for an object.
  """
  id: String!
  lineItems: [EcommerceOrderLineItem]
  """
  Note for the order.
  """
  note: String
  """
  Order number, if any.
  """
  orderNumber: String
  """
  Payment method used for this order.
  """
  paymentMethod: String
  """
  Current payment status of the order.
  """
  paymentStatus: EcommercePaymentStatus
  """
  An object representing a shipping or billing address.
  """
  shippingAddress: EcommerceAddress
  """
  Shipping cost, if any.
  """
  shippingCost: String
  """
  Current status of the order.
  """
  status: EcommerceOrderStatus
  """
  Sub-total amount, normally before tax.
  """
  subTotal: String
  """
  Total amount due.
  """
  totalAmount: String
  """
  Total discount, if any.
  """
  totalDiscount: String
  """
  Total tax, if any.
  """
  totalTax: String
  tracking: [TrackingItem]
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
}

"""
An object representing a shipping or billing address.
"""
type EcommerceAddress {
  """
  City of the billing address.
  """
  city: String
  """
  Company name of the customer
  """
  companyName: String
  """
  Country of the billing address.
  """
  country: String
  """
  Address line 1 of the billing address.
  """
  line1: String
  """
  Address line 2 of the billing address.
  """
  line2: String
  """
  Postal/ZIP code of the billing address.
  """
  postalCode: String
  """
  State/province of the billing address.
  """
  state: String
}

"""
The customer this entity is linked to.
"""
type LinkedEcommerceCustomer {
  """
  Company name of the customer
  """
  companyName: String
  emails: [Email]
  """
  First name of the customer
  """
  firstName: String
  """
  The ID of the customer this entity is linked to.
  """
  id: String!
  """
  Last name of the customer
  """
  lastName: String
  """
  Full name of the customer
  """
  name: String
  phoneNumbers: [PhoneNumber]
}

"""
An object representing a discount applied to an ecommerce order or product.
"""
type EcommerceDiscount {
  """
  The fixed amount of the discount.
  """
  amount: String
  """
  The code used to apply the discount.
  """
  code: String
  """
  The percentage of the discount.
  """
  percentage: String
}

enum EcommerceFulfillmentStatus {
  pending
  shipped
  partial
  delivered
  cancelled
  returned
  unknown
}

"""
A single line item of an ecommerce order, representing a product or variant with associated options, quantity, and pricing information.
"""
type EcommerceOrderLineItem {
  """
  The description of the product or variant associated with the line item.
  """
  description: String
  discounts: [EcommerceDiscount]
  """
  A unique identifier for an object.
  """
  id: String
  """
  The name of the product or variant associated with the line item.
  """
  name: String!
  options: [OptionsListItem]
  """
  A unique identifier for the product associated with the line item.
  """
  productId: String
  """
  The quantity of the product or variant associated with the line item.
  """
  quantity: String!
  """
  The SKU of the product or variant associated with the line item.
  """
  sku: String
  """
  The total tax amount applied to the product or variant associated with the line item.
  """
  taxAmount: String
  """
  The tax rate applied to the product or variant associated with the line item.
  """
  taxRate: String
  """
  The total amount for the product(s) or variant associated with the line item, including taxes and discounts.
  """
  totalAmount: String!
  """
  The unit price of the product or variant associated with the line item.
  """
  unitPrice: String
  """
  A unique identifier for the variant of the product associated with the line item, if applicable.
  """
  variantId: String
}

type OptionsListItem {
  """
  A unique identifier for the option.
  """
  id: String
  """
  The name of the option.
  """
  name: String
  """
  The value of the option.
  """
  value: String
}

enum EcommercePaymentStatus {
  pending
  authorized
  paid
  partial
  refunded
  voided
  unknown
}

"""
Represents the tracking information associated with an ecommerce order.
"""
type TrackingItem {
  """
  The tracking number associated with the shipment, which can be used to track the progress of the delivery.
  """
  number: String!
  """
  The name or code of the carrier or shipping company that is handling the shipment.
  """
  provider: String!
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The URL of the carrier's tracking page, which can be used to view detailed information about the shipment's progress.
  """
  url: String
}

type EcommerceProduct {
  """
  An array of categories for the product, used for organization and searching.
  """
  categories: [EcommerceProductCategory]
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  A detailed description of the product.
  """
  description: String
  """
  A unique identifier for an object.
  """
  id: String!
  """
  An array of image URLs for the product.
  """
  images: [EcommerceProductImage]
  """
  The quantity of the product in stock.
  """
  inventoryQuantity: String
  """
  The name of the product as it should be displayed to customers.
  """
  name: String
  """
  An array of options for the product.
  """
  options: [EcommerceProductOption]
  """
  The price of the product.
  """
  price: String
  """
  The stock keeping unit of the product.
  """
  sku: String
  """
  The current status of the product (active or archived).
  """
  status: EcommerceProductStatus
  """
  An array of tags for the product, used for organization and searching.
  """
  tags: [String]
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  variants: [VariantsListItem]
  """
  The weight of the product.
  """
  weight: String
  """
  The unit of measurement for the weight of the product.
  """
  weightUnit: String
}

type EcommerceProductCategory {
  """
  A unique identifier for an object.
  """
  id: String
  """
  The name of the category.
  """
  name: String
}

type EcommerceProductImage {
  """
  A unique identifier for an object.
  """
  id: String
  """
  The URL of an image of the product.
  """
  url: String
}

type EcommerceProductOption {
  """
  A unique identifier for the option of the product.
  """
  id: String
  """
  The name of the option for the product.
  """
  name: String
  values: [String]
}

enum EcommerceProductStatus {
  active
  archived
}

type VariantsListItem {
  """
  A unique identifier for the variant of the product.
  """
  id: String
  images: [EcommerceVariantImage]
  """
  The quantity of the variant in stock.
  """
  inventoryQuantity: String
  """
  The name for the variant, used for displaying to customers.
  """
  name: String
  options: [EcommerceVariantOption]
  """
  The price of the variant.
  """
  price: String
  """
  The stock keeping unit of the variant.
  """
  sku: String
  """
  The weight of the variant.
  """
  weight: String
  """
  The unit of measurement for the weight of the variant.
  """
  weightUnit: String
}

type EcommerceVariantImage {
  """
  A unique identifier for an object.
  """
  id: String
  """
  The URL of an image of the variant.
  """
  url: String
}

type EcommerceVariantOption {
  """
  A unique identifier for the option of the variant.
  """
  id: String
  """
  The name of the option for the variant.
  """
  name: String
  """
  The value of the option for the variant.
  """
  value: String
}

type EcommerceStore {
  """
  The store's admin login URL
  """
  adminUrl: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  A unique identifier for an object.
  """
  id: String!
  """
  The store's name
  """
  name: String
  """
  The store's website URL
  """
  storeUrl: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
}

type EcommerceOrderList {
  data: [EcommerceOrder]!
  """
  Response metadata
  """
  meta: Meta
}

input EcommerceOrdersFilterInput {
  """
  Customer email address to filter on
  """
  email: String
}

type EcommerceProductList {
  data: [EcommerceProduct]!
  """
  Response metadata
  """
  meta: Meta
}

type FileStorage {
  """
  Get Drive
  """
  drive(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Drive
  """
  Get DriveGroup
  """
  driveGroup(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): DriveGroup
  """
  List DriveGroups
  """
  driveGroups(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: DriveGroupsFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): DriveGroupList
  """
  List Drives
  """
  drives(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: DrivesFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): DriveList
  """
  List Files
  """
  files(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: FilesFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    Apply sorting
    """
    sort: FilesSortInput
  ): FileList
  """
  Get Folder
  """
  folder(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Folder
  """
  Get Shared Link
  """
  sharedLink(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): SharedLink
  """
  List SharedLinks
  """
  sharedLinks(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): SharedLinkList
  """
  Get File
  """
  unifiedFile(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedFile
  """
  Get Upload Session. Use the \`part_size\` to split your file into parts. Upload the parts to the [Upload part of File](#operation/uploadSessionsUpload) endpoint. Note that the base URL is upload.apideck.com instead of unify.apideck.com. For more information on uploads, refer to the [file upload guide](/guides/file-upload).
  """
  uploadSession(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UploadSession
}

type Drive {
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  A description of the object.
  """
  description: String
  """
  A unique identifier for an object.
  """
  id: String!
  """
  The name of the drive
  """
  name: String!
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type DriveGroup {
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  A description of the object.
  """
  description: String
  """
  The display name of the drive group
  """
  displayName: String
  """
  A unique identifier for an object.
  """
  id: String!
  """
  The name of the drive group
  """
  name: String!
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type DriveGroupList {
  data: [DriveGroup]!
  """
  Response metadata
  """
  meta: Meta
}

input DriveGroupsFilterInput {
  """
  ID of the drive group to filter on
  """
  parentGroupId: String
}

type DriveList {
  data: [Drive]!
  """
  Response metadata
  """
  meta: Meta
}

input DrivesFilterInput {
  """
  ID of the drive group to filter on
  """
  groupId: String
}

type FileList {
  data: [UnifiedFile]!
  """
  Response metadata
  """
  meta: Meta
}

type UnifiedFile {
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Optional description of the file
  """
  description: String
  """
  Whether the current user can download this file
  """
  downloadable: Boolean
  """
  The third-party API ID of original entity
  """
  downstreamId: String
  """
  A unique identifier for an object.
  """
  id: String!
  """
  The MIME type of the file.
  """
  mimeType: String
  """
  The name of the file
  """
  name: String!
  owner: Owner
  """
  The parent folders of the file, starting from the root
  """
  parentFolders: [LinkedFolder]
  """
  Whether the list of parent folder is complete. Some connectors only return the direct parent of a file
  """
  parentFoldersComplete: Boolean
  """
  The full path of the file or folder (includes the file name)
  """
  path: String
  """
  The size of the file in bytes
  """
  size: Int
  """
  The type of resource. Could be file, folder or url
  """
  type: FileType!
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type Owner {
  """
  Email of the owner
  """
  email: String
  """
  ID of the owner
  """
  id: String
  """
  Name of the owner
  """
  name: String
}

type LinkedFolder {
  """
  A unique identifier for an object.
  """
  id: String!
  """
  The name of the folder
  """
  name: String
}

enum FileType {
  file
  folder
  url
}

input FilesFilterInput {
  """
  ID of the drive to filter on
  """
  driveId: String
  """
  ID of the folder to filter on. The root folder has an alias "root"
  """
  folderId: String
  """
  Only return files and folders that are shared
  """
  shared: Boolean
}

input FilesSortInput {
  """
  The field on which to sort the Files
  """
  by: FilesSortBy
  """
  The direction in which to sort the results
  """
  direction: SortDirection
}

enum FilesSortBy {
  updated_at
  name
}

type Folder {
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Optional description of the folder
  """
  description: String
  """
  A unique identifier for an object.
  """
  id: String
  """
  The name of the folder
  """
  name: String!
  owner: Owner
  """
  The parent folders of the file, starting from the root
  """
  parentFolders: [LinkedFolder]!
  """
  Whether the list of parent folder is complete. Some connectors only return the direct parent of a folder
  """
  parentFoldersComplete: Boolean
  """
  The full path of the folder (includes the folder name)
  """
  path: String
  """
  The size of the folder in bytes
  """
  size: Int
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type SharedLink {
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The URL that can be used to download the file.
  """
  downloadUrl: String
  expiresAt: String
  """
  Indicated if the shared link is password protected.
  """
  passwordProtected: Boolean
  """
  The scope of the shared link.
  """
  scope: Scope
  target: SharedLinkTarget
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The URL that can be used to view the file.
  """
  url: String
}

enum Scope {
  public
  company
}

type SharedLinkTarget {
  """
  A unique identifier for an object.
  """
  id: String!
  """
  The name of the file
  """
  name: String
  """
  The type of resource. Could be file, folder or url
  """
  type: FileType
}

type SharedLinkList {
  data: [SharedLink]!
  """
  Response metadata
  """
  meta: Meta
}

type UploadSession {
  expiresAt: String
  """
  A unique identifier for an object.
  """
  id: String
  """
  Indicates if parts of the file can uploaded in parallel.
  """
  parallelUploadSupported: Boolean
  """
  Size in bytes of each part of the file that you will upload. Uploaded parts need to be this size for the upload to be successful.
  """
  partSize: Float
  """
  Indicates if the upload session was completed successfully.
  """
  success: Boolean
  """
  The range of bytes that was successfully uploaded.
  """
  uploadedByteRange: String
}

type MutationFileStorage {
  """
  Create DriveGroup
  """
  driveGroupsAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: DriveGroupInput!
  ): UnifiedId
  """
  Delete DriveGroup
  """
  driveGroupsDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update DriveGroup
  """
  driveGroupsUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: DriveGroupInput!
  ): UnifiedId
  """
  Create Drive
  """
  drivesAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: DriveInput!
  ): UnifiedId
  """
  Delete Drive
  """
  drivesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Drive
  """
  drivesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: DriveInput!
  ): UnifiedId
  """
  Delete File
  """
  filesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Search Files
  """
  filesSearch(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Optional unmapped key/values that will be passed through to downstream as query parameters
    """
    passThrough: PassThroughInput
    requestBody: FilesSearchInput!
  ): FileList
  """
  Rename or move File
  """
  filesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: UpdateFileRequestInput!
  ): UnifiedId
  """
  Create Folder
  """
  foldersAdd(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: CreateFolderRequestInput!
  ): UnifiedId
  """
  Delete Folder
  """
  foldersDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Rename or move Folder
  """
  foldersUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: UpdateFolderRequestInput!
  ): UnifiedId
  """
  Create Shared Link
  """
  sharedLinksAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: SharedLinkInput!
  ): UnifiedId
  """
  Delete Shared Link
  """
  sharedLinksDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Shared Link
  """
  sharedLinksUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: SharedLinkInput!
  ): UnifiedId
  """
  Start an Upload Session. Upload sessions are used to upload large files, use the [Upload File](#operation/filesUpload) endpoint to upload smaller files (up to 100MB). Note that the base URL is upload.apideck.com instead of unify.apideck.com. For more information on uploads, refer to the [file upload guide](/guides/file-upload).
  """
  uploadSessionsAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: CreateUploadSessionRequestInput!
  ): UnifiedId
  """
  Abort Upload Session. Note that the base URL is upload.apideck.com instead of unify.apideck.com. For more information on uploads, refer to the [file upload guide](/guides/file-upload).
  """
  uploadSessionsDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Finish Upload Session. Only call this endpoint after all File parts have been uploaded to [Upload part of File](#operation/uploadSessionsUpload). Note that the base URL is upload.apideck.com instead of unify.apideck.com. For more information on uploads, refer to the [file upload guide](/guides/file-upload).
  """
  uploadSessionsFinish(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: JSON
  ): UnifiedFile
}

input DriveGroupInput {
  """
  A description of the object.
  """
  description: String
  """
  The display name of the drive group
  """
  displayName: String
  """
  The name of the drive group
  """
  name: String!
}

input DriveInput {
  """
  A description of the object.
  """
  description: String
  """
  The name of the drive
  """
  name: String!
}

input FilesSearchInput {
  """
  ID of the drive to filter on
  """
  driveId: String
  """
  The query to search for. May match across multiple fields.
  """
  query: String!
}

input UpdateFileRequestInput {
  """
  Optional description of the file.
  """
  description: String
  """
  The name of the file.
  """
  name: String
  """
  The parent folder to create the new file within.
  """
  parentFolderId: String
}

input CreateFolderRequestInput {
  """
  Optional description of the folder.
  """
  description: String
  """
  ID of the drive to create the folder in.
  """
  driveId: String
  """
  The name of the folder.
  """
  name: String!
  """
  The parent folder to create the new file within.
  """
  parentFolderId: String!
}

input UpdateFolderRequestInput {
  """
  Optional description of the folder.
  """
  description: String
  """
  The name of the folder.
  """
  name: String
  """
  The parent folder to create the new file within.
  """
  parentFolderId: String
}

input SharedLinkInput {
  """
  The URL that can be used to download the file.
  """
  downloadUrl: String
  """
  Optional password for the shared link.
  """
  password: String
  """
  The scope of the shared link.
  """
  scope: Scope
  """
  The ID of the file or folder to link.
  """
  targetId: String!
}

input CreateUploadSessionRequestInput {
  """
  ID of the drive to upload to.
  """
  driveId: String
  """
  The name of the file.
  """
  name: String!
  """
  The parent folder to create the new file within.
  """
  parentFolderId: String!
  """
  The size of the file in bytes
  """
  size: Int!
}

type Hris {
  """
  Get Department
  """
  department(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Department
  """
  List Departments
  """
  departments(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): DepartmentList
  """
  Get Employee
  """
  employee(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Employee
  """
  Get payroll for employee
  """
  employeePayroll(
    """
    ID of the employee you are acting upon.
    """
    employeeId: String!
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the payroll you are acting upon.
    """
    payrollId: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): EmployeePayroll
  """
  List payrolls for employee
  """
  employeePayrolls(
    """
    ID of the employee you are acting upon.
    """
    employeeId: String!
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: PayrollsFilterInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): EmployeePayrolls
  """
  List schedules for employee, a schedule is a work pattern, not the actual worked hours, for an employee.
  """
  employeeSchedules(
    """
    ID of the employee you are acting upon.
    """
    employeeId: String!
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): EmployeeSchedules
  """
  List Employees
  """
  employees(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: EmployeesFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    Apply sorting
    """
    sort: EmployeesSortInput
  ): EmployeeList
  """
  List Companies
  """
  hrisCompanies(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): HrisCompanyList
  """
  Get Company
  """
  hrisCompany(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): HrisCompany
  """
  A Job for employee.
  """
  hrisJob(
    """
    ID of the employee you are acting upon.
    """
    employeeId: String!
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the job you are acting upon.
    """
    jobId: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): HrisJob
  """
  List Jobs for employee.
  """
  jobs(
    """
    ID of the employee you are acting upon.
    """
    employeeId: String!
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): HrisJobs
  """
  Get Payroll
  """
  payroll(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the payroll you are acting upon.
    """
    payrollId: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Payroll
  """
  List Payroll
  """
  payrolls(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: PayrollsFilterInput
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): [Payroll]
  """
  Get Time Off Request
  """
  timeOffRequest(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): TimeOffRequest
  """
  List Time Off Requests
  """
  timeOffRequests(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: TimeOffRequestsFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): TimeOffRequestList
}

type DepartmentList {
  data: [Department]!
  """
  Response metadata
  """
  meta: Meta
}

type Employee {
  addresses: [Address]
  """
  The date of birth of the person.
  """
  birthday: String
  """
  The unique identifier of the company.
  """
  companyId: String
  """
  The name of the company.
  """
  companyName: String
  compensations: [CompensationsListItem]
  """
  Country code according to ISO 3166-1 alpha-2.
  """
  countryOfBirth: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  customFields: [CustomField]
  """
  The date the person deceased.
  """
  deceasedOn: String
  deleted: Boolean
  """
  The department the person is currently in. [Deprecated](https://developers.apideck.com/changelog) in favor of the dedicated department_id and department_name field.
  """
  department: String
  """
  Unique identifier of the department ID this employee belongs to.
  """
  departmentId: String
  """
  Name of the department this employee belongs to.
  """
  departmentName: String
  """
  A description of the object.
  """
  description: String
  """
  Indicate the employee's dietary preference.
  """
  dietaryPreference: String
  """
  The direct reports refer to the individuals who report directly to a person in the organizational hierarchy.
  """
  directReports: [String]
  """
  The name used to display the employee, often a combination of their first and last names.
  """
  displayName: String
  """
  The division the person is currently in. Usually a collection of departments or teams or regions.
  """
  division: String
  """
  Unique identifier of the division this employee belongs to.
  """
  divisionId: String
  emails: [Email]
  """
  An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.
  """
  employeeNumber: String
  """
  An End Date is the date that the employee ended working at the company
  """
  employmentEndDate: String
  employmentRole: EmploymentRole
  """
  A Start Date is the date that the employee started working at the company
  """
  employmentStartDate: String
  """
  The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status.
  """
  employmentStatus: EmploymentStatus
  """
  The first name of the person.
  """
  firstName: String
  """
  Indicate the employee's food allergies.
  """
  foodAllergies: [String]
  """
  The gender represents the gender identity of a person.
  """
  gender: Gender
  """
  A unique identifier for an object.
  """
  id: String!
  """
  The initials of the person, usually derived from their first, middle, and last names.
  """
  initials: String
  jobs: [JobsListItem]
  languages: [String]
  """
  The last name of the person.
  """
  lastName: String
  """
  The reason because the employment ended.
  """
  leavingReason: LeavingReason
  manager: Manager
  """
  The marital status of the employee.
  """
  maritalStatus: String
  """
  Middle name of the person.
  """
  middleName: String
  nationalities: [String]
  partner: Partner
  phoneNumbers: [PhoneNumber]
  """
  The URL of the photo of a person.
  """
  photoUrl: String
  """
  language code according to ISO 639-1. For the United States - EN
  """
  preferredLanguage: String
  """
  The name the employee prefers to be addressed by, which may be different from their legal name.
  """
  preferredName: String
  """
  The preferred pronouns of the person.
  """
  pronouns: String
  recordUrl: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  A formal salutation for the person. For example, 'Mr', 'Mrs'
  """
  salutation: String
  socialLinks: [SocialLinksListItem]
  """
  A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.
  """
  socialSecurityNumber: String
  """
  When the employee is imported as a new hire, this field indicates what system (e.g. the name of the ATS) this employee was imported from.
  """
  source: String
  """
  Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS).
  """
  sourceId: String
  tags: [String]
  taxCode: String
  taxId: String
  """
  The team the person is currently in.
  """
  team: Team
  """
  The time zone related to the resource. The value is a string containing a standard time zone identifier, e.g. Europe/London.
  """
  timezone: String
  """
  The job title of the person.
  """
  title: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
  """
  Indicates if the employee works from a remote location.
  """
  worksRemote: Boolean
}

type CompensationsListItem {
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  The date on which a change to an employee's compensation takes effect.
  """
  effectiveDate: String
  """
  The FLSA status for this compensation.
  """
  flsaStatus: FlsaStatus
  """
  A unique identifier for an object.
  """
  id: String
  """
  The ID of the job to which the compensation belongs.
  """
  jobId: String
  """
  Unit of measurement for employee compensation.
  """
  paymentUnit: PaymentUnit
  """
  The amount paid per payment unit.
  """
  rate: Float
}

enum FlsaStatus {
  exempt
  salariednonexempt
  nonexempt
  owner
}

enum PaymentUnit {
  hour
  week
  month
  year
  paycheck
}

type EmploymentRole {
  """
  The work schedule of the employee.
  """
  subType: SubType
  """
  The type of employment relationship the employee has with the organization.
  """
  type: Type
}

enum SubType {
  full_time
  part_time
  hourly
}

enum EmploymentStatus {
  active
  inactive
  terminated
  other
}

type JobsListItem {
  """
  The rate of pay for the employee in their current job role.
  """
  compensationRate: Float
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  A unique identifier for an object.
  """
  employeeId: String
  """
  The date on which the employee leaves or is expected to leave their current job role.
  """
  endDate: String
  """
  The date on which the employee was hired by the organization
  """
  hiredAt: String
  """
  A unique identifier for an object.
  """
  id: String
  """
  Indicates whether this the employee's primary job.
  """
  isPrimary: Boolean
  location: Address
  """
  Unit of measurement for employee compensation.
  """
  paymentUnit: PaymentUnit
  """
  The position and responsibilities of the person within the organization.
  """
  role: String
  """
  The date on which the employee starts working in their current job role.
  """
  startDate: String
  """
  The job title of the person.
  """
  title: String
}

enum LeavingReason {
  dismissed
  resigned
  redundancy
  other
}

type Manager {
  """
  The email address of the manager.
  """
  email: String
  """
  The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status.
  """
  employmentStatus: EmploymentStatus
  """
  The first name of the person.
  """
  firstName: String
  """
  A unique identifier for an object.
  """
  id: String
  """
  The last name of the person.
  """
  lastName: String
  """
  The name of the manager, often a combination of their first and last names.
  """
  name: String
}

type Partner {
  birthday: String
  deceasedOn: String
  """
  The first name of the person.
  """
  firstName: String
  """
  The gender represents the gender identity of a person.
  """
  gender: Gender
  """
  A unique identifier for an object.
  """
  id: String
  initials: String
  """
  The last name of the person.
  """
  lastName: String
  """
  Middle name of the person.
  """
  middleName: String
}

"""
The team the person is currently in.
"""
type Team {
  """
  The unique identifier of the team.
  """
  id: String
  """
  The name of the team.
  """
  name: String
}

type EmployeePayroll {
  employee: Employee
  payroll: Payroll
}

type Payroll {
  """
  The date on which employees will be paid for the payroll.
  """
  checkDate: String!
  """
  The unique identifier of the company.
  """
  companyId: String
  """
  An array of compensations for the payroll.
  """
  compensations: [Compensation]
  """
  The end date, inclusive, of the pay period.
  """
  endDate: String!
  """
  A unique identifier for an object.
  """
  id: String!
  """
  Whether or not the payroll has been successfully processed. Note that processed payrolls cannot be updated.
  """
  processed: Boolean!
  """
  The date the payroll was processed.
  """
  processedDate: String
  """
  The start date, inclusive, of the pay period.
  """
  startDate: String!
  totals: PayrollTotals
}

type Compensation {
  """
  An array of employee benefits for the pay period.
  """
  benefits: [Benefit]
  """
  An array of employee deductions for the pay period.
  """
  deductions: [Deduction]
  """
  A unique identifier for an object.
  """
  employeeId: String!
  """
  The employee's gross pay. Only available when payroll has been processed
  """
  grossPay: Float
  """
  The employee's net pay. Only available when payroll has been processed
  """
  netPay: Float
  """
  An array of employer and employee taxes for the pay period.
  """
  taxes: [Tax]
}

type Benefit {
  """
  The amount deducted for benefit.
  """
  employeeDeduction: Float
  """
  The amount of employer contribution.
  """
  employerContribution: Float
  """
  The name of the benefit.
  """
  name: String
}

type Deduction {
  """
  The amount deducted.
  """
  amount: Float
  """
  The name of the deduction.
  """
  name: String
}

type Tax {
  """
  The amount of the tax.
  """
  amount: Float
  """
  Paid by employer.
  """
  employer: Boolean
  """
  The name of the tax.
  """
  name: String
}

type PayrollTotals {
  """
  The total check amount for the payroll.
  """
  checkAmount: Float
  """
  The total company debit for the payroll.
  """
  companyDebit: Float
  """
  The total amount of employee deducted benefits for the payroll.
  """
  employeeBenefitDeductions: Float
  """
  The total amount of employee paid taxes for the payroll.
  """
  employeeTaxes: Float
  """
  The total amount of company contributed benefits for the payroll.
  """
  employerBenefitContributions: Float
  """
  The total amount of employer paid taxes for the payroll.
  """
  employerTaxes: Float
  """
  The gross pay amount for the payroll.
  """
  grossPay: Float
  """
  The net pay amount for the payroll.
  """
  netPay: Float
  """
  The total tax debit for the payroll.
  """
  taxDebit: Float
}

type EmployeePayrolls {
  employee: Employee
  payrolls: [Payroll]
}

input PayrollsFilterInput {
  """
  Return payrolls whose pay period is before the end date
  """
  endDate: String
  """
  Return payrolls whose pay period is after the start date
  """
  startDate: String
}

type EmployeeSchedules {
  employee: Employee
  schedules: [Schedule]
}

type Schedule {
  """
  The end date, inclusive, of the schedule period.
  """
  endDate: String!
  """
  A unique identifier for an object.
  """
  id: String!
  """
  The start date, inclusive, of the schedule period.
  """
  startDate: String!
  workPattern: WorkPattern!
}

type WorkPattern {
  evenWeeks: EvenWeeks
  oddWeeks: OddWeeks
}

type EvenWeeks {
  hoursFriday: Float
  hoursMonday: Float
  hoursSaturday: Float
  hoursSunday: Float
  hoursThursday: Float
  hoursTuesday: Float
  hoursWednesday: Float
}

type OddWeeks {
  hoursFriday: Float
  hoursMonday: Float
  hoursSaturday: Float
  hoursSunday: Float
  hoursThursday: Float
  hoursTuesday: Float
  hoursWednesday: Float
}

type EmployeeList {
  data: [Employee]!
  """
  Response metadata
  """
  meta: Meta
}

input EmployeesFilterInput {
  """
  Company ID to filter on
  """
  companyId: String
  """
  ID of the department to filter on
  """
  departmentId: String
  """
  Email to filter on
  """
  email: String
  """
  Employee number to filter on
  """
  employeeNumber: String
  """
  Employment status to filter on
  """
  employmentStatus: EmploymentStatusFilter
  """
  First Name to filter on
  """
  firstName: String
  """
  Last Name to filter on
  """
  lastName: String
  """
  Manager id to filter on
  """
  managerId: String
  """
  Job title to filter on
  """
  title: String
}

enum EmploymentStatusFilter {
  active
  inactive
  terminated
  other
}

input EmployeesSortInput {
  """
  The field on which to sort the Employees
  """
  by: EmployeesSortBy
  """
  The direction in which to sort the results
  """
  direction: SortDirection
}

enum EmployeesSortBy {
  first_name
  last_name
  created_at
  updated_at
}

type HrisCompanyList {
  data: [HrisCompany]!
  """
  Response metadata
  """
  meta: Meta
}

type HrisCompany {
  addresses: [Address]
  """
  An Company Number, Company ID or Company Code, is a unique number that has been assigned to each company.
  """
  companyNumber: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  debtorId: String
  deleted: Boolean
  displayName: String
  emails: [Email]
  """
  A unique identifier for an object.
  """
  id: String
  legalName: String!
  phoneNumbers: [PhoneNumber]
  status: Status
  subdomain: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
  websites: [Website]
}

type HrisJob {
  """
  Department name
  """
  department: String
  """
  Id of the employee
  """
  employeeId: String
  """
  The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status.
  """
  employmentStatus: EmploymentStatus
  endDate: String
  """
  A unique identifier for an object.
  """
  id: String
  """
  Indicates whether this the employee's primary job.
  """
  isPrimary: Boolean
  location: Location
  startDate: String
  """
  The job title of the person.
  """
  title: String
}

type Location {
  name: String
}

type HrisJobs {
  employee: Employee
  jobs: [HrisJob]
}

type TimeOffRequest {
  """
  The amount of time off requested.
  """
  amount: Float
  """
  The date the request was approved
  """
  approvalDate: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  Description of the time off request.
  """
  description: String
  """
  ID of the employee
  """
  employeeId: String
  """
  The end date of the time off request.
  """
  endDate: String
  """
  A unique identifier for an object.
  """
  id: String
  notes: Notes
  """
  ID of the policy
  """
  policyId: String
  """
  The date the request was made.
  """
  requestDate: String
  """
  The type of request
  """
  requestType: TimeOffRequestType
  """
  The start date of the time off request.
  """
  startDate: String
  """
  The status of the time off request.
  """
  status: TimeOffRequestStatus
  """
  The unit of time off requested. Possible values include: \`hours\`, \`days\`, or \`other\`.
  """
  units: TimeOffRequestUnits
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
}

type Notes {
  employee: String
  manager: String
}

enum TimeOffRequestType {
  vacation
  sick
  personal
  jury_duty
  volunteer
  bereavement
  other
}

enum TimeOffRequestStatus {
  requested
  approved
  declined
  cancelled
  deleted
  other
}

enum TimeOffRequestUnits {
  days
  hours
  other
}

type TimeOffRequestList {
  data: [TimeOffRequest]!
  """
  Response metadata
  """
  meta: Meta
}

input TimeOffRequestsFilterInput {
  """
  Employee ID
  """
  employeeId: String
  """
  End date
  """
  endDate: String
  """
  Start date
  """
  startDate: String
  """
  Time off request status to filter on
  """
  timeOffRequestStatus: TimeOffStatusFilter
}

enum TimeOffStatusFilter {
  requested
  approved
  declined
  cancelled
  deleted
  other
}

type MutationHris {
  """
  Create Company
  """
  companiesAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: HrisCompanyInput!
  ): UnifiedId
  """
  Delete Company
  """
  companiesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Company
  """
  companiesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: HrisCompanyInput!
  ): UnifiedId
  """
  Create Department
  """
  departmentsAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: DepartmentInput!
  ): UnifiedId
  """
  Delete Department
  """
  departmentsDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Department
  """
  departmentsUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: DepartmentInput!
  ): UnifiedId
  """
  Create Employee
  """
  employeesAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: EmployeeInput!
  ): UnifiedId
  """
  Delete Employee
  """
  employeesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Employee
  """
  employeesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: EmployeeInput!
  ): UnifiedId
  """
  Create Time Off Request
  """
  timeOffRequestsAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: TimeOffRequestInput!
  ): UnifiedId
  """
  Delete Time Off Request
  """
  timeOffRequestsDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Time Off Request
  """
  timeOffRequestsUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: TimeOffRequestInput!
  ): UnifiedId
}

input HrisCompanyInput {
  addresses: [AddressInput]
  """
  An Company Number, Company ID or Company Code, is a unique number that has been assigned to each company.
  """
  companyNumber: String
  debtorId: String
  displayName: String
  emails: [EmailInput]
  legalName: String!
  phoneNumbers: [PhoneNumberInput]
  status: Status
  subdomain: String
  websites: [WebsiteInput]
}

input DepartmentInput {
  code: String
  description: String
  """
  Department name
  """
  name: String
}

input EmployeeInput {
  addresses: [AddressInput]
  """
  The date of birth of the person.
  """
  birthday: String
  """
  The unique identifier of the company.
  """
  companyId: String
  """
  The name of the company.
  """
  companyName: String
  compensations: [CompensationsListItemInput]
  """
  Country code according to ISO 3166-1 alpha-2.
  """
  countryOfBirth: String
  customFields: [CustomFieldInput]
  """
  The date the person deceased.
  """
  deceasedOn: String
  deleted: Boolean
  """
  The department the person is currently in. [Deprecated](https://developers.apideck.com/changelog) in favor of the dedicated department_id and department_name field.
  """
  department: String
  """
  Unique identifier of the department ID this employee belongs to.
  """
  departmentId: String
  """
  Name of the department this employee belongs to.
  """
  departmentName: String
  """
  A description of the object.
  """
  description: String
  """
  Indicate the employee's dietary preference.
  """
  dietaryPreference: String
  """
  The direct reports refer to the individuals who report directly to a person in the organizational hierarchy.
  """
  directReports: [String]
  """
  The name used to display the employee, often a combination of their first and last names.
  """
  displayName: String
  """
  The division the person is currently in. Usually a collection of departments or teams or regions.
  """
  division: String
  """
  Unique identifier of the division this employee belongs to.
  """
  divisionId: String
  emails: [EmailInput]
  """
  An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.
  """
  employeeNumber: String
  """
  An End Date is the date that the employee ended working at the company
  """
  employmentEndDate: String
  employmentRole: EmploymentRoleInput
  """
  A Start Date is the date that the employee started working at the company
  """
  employmentStartDate: String
  """
  The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status.
  """
  employmentStatus: EmploymentStatus
  """
  The first name of the person.
  """
  firstName: String
  """
  Indicate the employee's food allergies.
  """
  foodAllergies: [String]
  """
  The gender represents the gender identity of a person.
  """
  gender: Gender
  """
  The initials of the person, usually derived from their first, middle, and last names.
  """
  initials: String
  jobs: [JobsListItemInput]
  languages: [String]
  """
  The last name of the person.
  """
  lastName: String
  """
  The reason because the employment ended.
  """
  leavingReason: LeavingReason
  manager: ManagerInput
  """
  The marital status of the employee.
  """
  maritalStatus: String
  """
  Middle name of the person.
  """
  middleName: String
  nationalities: [String]
  partner: PartnerInput
  phoneNumbers: [PhoneNumberInput]
  """
  The URL of the photo of a person.
  """
  photoUrl: String
  """
  language code according to ISO 639-1. For the United States - EN
  """
  preferredLanguage: String
  """
  The name the employee prefers to be addressed by, which may be different from their legal name.
  """
  preferredName: String
  """
  The preferred pronouns of the person.
  """
  pronouns: String
  recordUrl: String
  """
  A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.
  """
  rowVersion: String
  """
  A formal salutation for the person. For example, 'Mr', 'Mrs'
  """
  salutation: String
  socialLinks: [SocialLinksListItemInput]
  """
  A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.
  """
  socialSecurityNumber: String
  """
  When the employee is imported as a new hire, this field indicates what system (e.g. the name of the ATS) this employee was imported from.
  """
  source: String
  """
  Unique identifier of the employee in the system this employee was imported from (e.g. the ID in the ATS).
  """
  sourceId: String
  tags: [String]
  taxCode: String
  taxId: String
  """
  The team the person is currently in.
  """
  team: TeamInput
  """
  The time zone related to the resource. The value is a string containing a standard time zone identifier, e.g. Europe/London.
  """
  timezone: String
  """
  The job title of the person.
  """
  title: String
  """
  Indicates if the employee works from a remote location.
  """
  worksRemote: Boolean
}

input CompensationsListItemInput {
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  The date on which a change to an employee's compensation takes effect.
  """
  effectiveDate: String
  """
  The FLSA status for this compensation.
  """
  flsaStatus: FlsaStatus
  """
  Unit of measurement for employee compensation.
  """
  paymentUnit: PaymentUnit
  """
  The amount paid per payment unit.
  """
  rate: Float
}

input EmploymentRoleInput {
  """
  The work schedule of the employee.
  """
  subType: SubType
  """
  The type of employment relationship the employee has with the organization.
  """
  type: Type
}

input JobsListItemInput {
  """
  The rate of pay for the employee in their current job role.
  """
  compensationRate: Float
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  The date on which the employee leaves or is expected to leave their current job role.
  """
  endDate: String
  """
  The date on which the employee was hired by the organization
  """
  hiredAt: String
  """
  Indicates whether this the employee's primary job.
  """
  isPrimary: Boolean
  location: AddressInput
  """
  Unit of measurement for employee compensation.
  """
  paymentUnit: PaymentUnit
  """
  The position and responsibilities of the person within the organization.
  """
  role: String
  """
  The date on which the employee starts working in their current job role.
  """
  startDate: String
  """
  The job title of the person.
  """
  title: String
}

input ManagerInput {
  """
  The email address of the manager.
  """
  email: String
  """
  The employment status of the employee, indicating whether they are currently employed, inactive, terminated, or in another status.
  """
  employmentStatus: EmploymentStatus
  """
  The first name of the person.
  """
  firstName: String
  """
  The last name of the person.
  """
  lastName: String
  """
  The name of the manager, often a combination of their first and last names.
  """
  name: String
}

input PartnerInput {
  birthday: String
  deceasedOn: String
  """
  The first name of the person.
  """
  firstName: String
  """
  The gender represents the gender identity of a person.
  """
  gender: Gender
  initials: String
  """
  The last name of the person.
  """
  lastName: String
  """
  Middle name of the person.
  """
  middleName: String
}

"""
The team the person is currently in.
"""
input TeamInput {
  """
  The unique identifier of the team.
  """
  id: String
  """
  The name of the team.
  """
  name: String
}

input TimeOffRequestInput {
  """
  The amount of time off requested.
  """
  amount: Float
  """
  The date the request was approved
  """
  approvalDate: String
  """
  Description of the time off request.
  """
  description: String
  """
  ID of the employee
  """
  employeeId: String
  """
  The end date of the time off request.
  """
  endDate: String
  notes: NotesInput
  """
  ID of the policy
  """
  policyId: String
  """
  The date the request was made.
  """
  requestDate: String
  """
  The type of request
  """
  requestType: TimeOffRequestType
  """
  The start date of the time off request.
  """
  startDate: String
  """
  The status of the time off request.
  """
  status: TimeOffRequestStatus
  """
  The unit of time off requested. Possible values include: \`hours\`, \`days\`, or \`other\`.
  """
  units: TimeOffRequestUnits
}

input NotesInput {
  employee: String
  manager: String
}

type MutationLead {
  """
  Create lead
  """
  leadsAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: LeadInput!
  ): UnifiedId
  """
  Delete lead
  """
  leadsDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update lead
  """
  leadsUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: LeadInput!
  ): UnifiedId
}

type Sms {
  """
  Get Message
  """
  message(
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Message
  """
  List Messages
  """
  messages(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): MessageList
}

type Message {
  """
  The message text.
  """
  body: String!
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  The direction of the message.
  """
  direction: Direction
  """
  The error returned if your message status is failed or undelivered.
  """
  error: Error
  """
  The phone number that initiated the message.
  """
  from: String!
  """
  A unique identifier for an object.
  """
  id: String
  """
  The ID of the Messaging Service used with the message. In case of Plivo this links to the Powerpack ID.
  """
  messagingServiceId: String
  """
  The number of media files associated with the message.
  """
  numberOfMediaFiles: Int
  """
  The number of units that make up the complete message. Messages can be split up due to the constraints of the message size.
  """
  numberOfUnits: Int
  """
  Price of the message.
  """
  price: Price
  """
  A client reference.
  """
  reference: String
  """
  The scheduled date and time of the message.
  """
  scheduledAt: String
  """
  The date and time that the message was sent
  """
  sentAt: String
  """
  Status of the delivery of the message.
  """
  status: Status
  subject: String
  """
  The phone number that received the message.
  """
  to: String!
  """
  Set to sms for SMS messages and mms for MMS messages.
  """
  type: Type
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
  """
  The user who last updated the object.
  """
  updatedBy: String
  """
  Define a webhook to receive delivery notifications.
  """
  webhookUrl: String
}

enum Direction {
  inbound
  outboundapi
  outboundcall
  outboundreply
  unknown
}

"""
The error returned if your message status is failed or undelivered.
"""
type Error {
  """
  The error_code provides more information about the failure. If the message was successful, this value is null
  """
  code: String
  message: String
}

"""
Price of the message.
"""
type Price {
  """
  Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
  """
  currency: Currency
  """
  """
  perUnit: String
  """
  """
  totalAmount: String
}

type MessageList {
  data: [Message]!
  """
  Response metadata
  """
  meta: Meta
}

type MutationSms {
  """
  Create Message
  """
  messagesAdd(
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: MessageInput!
  ): UnifiedId
  """
  Delete Message
  """
  messagesDelete(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): UnifiedId
  """
  Update Message
  """
  messagesUpdate(
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: MessageInput!
  ): UnifiedId
}

input MessageInput {
  """
  The message text.
  """
  body: String!
  """
  The phone number that initiated the message.
  """
  from: String!
  """
  The ID of the Messaging Service used with the message. In case of Plivo this links to the Powerpack ID.
  """
  messagingServiceId: String
  """
  A client reference.
  """
  reference: String
  """
  The scheduled date and time of the message.
  """
  scheduledAt: String
  subject: String
  """
  The phone number that received the message.
  """
  to: String!
  """
  Set to sms for SMS messages and mms for MMS messages.
  """
  type: Type
  """
  Define a webhook to receive delivery notifications.
  """
  webhookUrl: String
}

type IssueTracking {
  """
  Get Collection
  """
  collection(
    """
    The collection ID
    """
    collectionId: String!
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): Collection
  """
  List Tags
  """
  collectionTag(
    """
    The collection ID
    """
    collectionId: String!
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): TagsList
  """
  Get Ticket
  """
  collectionTicket(
    """
    The collection ID
    """
    collectionId: String!
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    ID of the ticket you are acting upon.
    """
    ticketId: String!
  ): Ticket
  """
  Get Comment
  """
  collectionTicketComment(
    """
    The collection ID
    """
    collectionId: String!
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    ID of the ticket you are acting upon.
    """
    ticketId: String!
  ): CollectionTicketComment
  """
  List Comments
  """
  collectionTicketComments(
    """
    The collection ID
    """
    collectionId: String!
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    Apply sorting
    """
    sort: CommentsSortInput
    """
    ID of the ticket you are acting upon.
    """
    ticketId: String!
  ): CommentList
  """
  List Tickets
  """
  collectionTickets(
    """
    The collection ID
    """
    collectionId: String!
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Apply filters
    """
    filter: IssuesFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    Apply sorting
    """
    sort: TicketsSortInput
  ): TicketList
  """
  Get user
  """
  collectionUser(
    """
    The collection ID
    """
    collectionId: String!
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): CollectionUser
  """
  List Users
  """
  collectionUsers(
    """
    The collection ID
    """
    collectionId: String!
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
  ): CollectionUserList
  """
  List Collections
  """
  collections(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: \`fields=name,email,addresses.city\`<br /><br />In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.
    """
    fields: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    Apply sorting
    """
    sort: CollectionsSortInput
  ): CollectionList
}

type Collection {
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  Description of the collection
  """
  description: String
  """
  A unique identifier for an object.
  """
  id: String!
  """
  Name of the collection
  """
  name: String
  """
  The collections's parent ID
  """
  parentId: String
  """
  The collections's type
  """
  type: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
}

type TagsList {
  data: [CollectionTag]!
  """
  Response metadata
  """
  meta: Meta
}

type CollectionTag {
  """
  A unique identifier for an object.
  """
  id: String!
  name: String
}

type Ticket {
  assignees: [Assignee]
  """
  The ticket's collection ID
  """
  collectionId: String
  """
  When the ticket was completed
  """
  completedAt: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  The ticket's description. HTML version of description is mapped if supported by the third-party platform
  """
  description: String
  """
  Due date of the ticket
  """
  dueDate: String
  """
  A unique identifier for an object.
  """
  id: String!
  """
  The ticket's parent ID
  """
  parentId: String
  """
  Priority of the ticket
  """
  priority: Priority
  """
  The current status of the ticket. Possible values include: open, in_progress, closed, or - in cases where there is no clear mapping - the original value passed through.
  """
  status: String
  """
  Subject of the ticket
  """
  subject: String
  tags: [CollectionTag]
  """
  The ticket's type
  """
  type: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
}

type Assignee {
  """
  A unique identifier for an object.
  """
  id: String!
  username: String
}

enum Priority {
  low
  normal
  high
  urgent
}

type CollectionTicketComment {
  """
  Body of the comment
  """
  body: String
  """
  The date and time when the object was created.
  """
  createdAt: String
  """
  The user who created the object.
  """
  createdBy: String
  """
  A unique identifier for an object.
  """
  id: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
}

type CommentList {
  data: [CollectionTicketComment]!
  """
  Response metadata
  """
  meta: Meta
}

input CommentsSortInput {
  """
  The field on which to sort the Comments
  """
  by: CommentsSortBy
  """
  The direction in which to sort the results
  """
  direction: SortDirection
}

enum CommentsSortBy {
  created_at
  updated_at
}

type TicketList {
  data: [Ticket]!
  """
  Response metadata
  """
  meta: Meta
}

input IssuesFilterInput {
  """
  Only return tickets assigned to a specific user
  """
  assigneeId: String
  """
  Only return tickets since a specific date
  """
  since: String
  """
  Filter by ticket status, can be \`open\`, \`closed\` or \`all\`. Will passthrough if none of the above match
  """
  status: [String]
}

input TicketsSortInput {
  """
  The field on which to sort the Tickets
  """
  by: TicketsSortBy
  """
  The direction in which to sort the results
  """
  direction: SortDirection
}

enum TicketsSortBy {
  created_at
  updated_at
}

type CollectionUser {
  """
  The date and time when the object was created.
  """
  createdAt: String
  email: String
  firstName: String
  """
  A unique identifier for an object.
  """
  id: String
  lastName: String
  name: String
  """
  The URL of the photo of a person.
  """
  photoUrl: String
  """
  The date and time when the object was last updated.
  """
  updatedAt: String
}

type CollectionUserList {
  data: [CollectionUser]!
  """
  Response metadata
  """
  meta: Meta
}

type CollectionList {
  data: [Collection]!
  """
  Response metadata
  """
  meta: Meta
}

input CollectionsSortInput {
  """
  The field on which to sort the Collections
  """
  by: CollectionsSortBy
  """
  The direction in which to sort the results
  """
  direction: SortDirection
}

enum CollectionsSortBy {
  name
  created_at
  updated_at
}

type MutationIssueTracking {
  """
  Create Comment
  """
  collectionTicketCommentsAdd(
    """
    The collection ID
    """
    collectionId: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: CollectionTicketCommentInput!
    """
    ID of the ticket you are acting upon.
    """
    ticketId: String!
  ): UnifiedId
  """
  Delete Comment
  """
  collectionTicketCommentsDelete(
    """
    The collection ID
    """
    collectionId: String!
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    ID of the ticket you are acting upon.
    """
    ticketId: String!
  ): UnifiedId
  """
  Update Comment
  """
  collectionTicketCommentsUpdate(
    """
    The collection ID
    """
    collectionId: String!
    """
    ID of the record you are acting upon.
    """
    id: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: CollectionTicketCommentInput!
    """
    ID of the ticket you are acting upon.
    """
    ticketId: String!
  ): UnifiedId
  """
  Create Ticket
  """
  collectionTicketsAdd(
    """
    The collection ID
    """
    collectionId: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: TicketInput!
  ): UnifiedId
  """
  Delete Ticket
  """
  collectionTicketsDelete(
    """
    The collection ID
    """
    collectionId: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    """
    ID of the ticket you are acting upon.
    """
    ticketId: String!
  ): UnifiedId
  """
  Update Ticket
  """
  collectionTicketsUpdate(
    """
    The collection ID
    """
    collectionId: String!
    """
    Include raw response. Mostly used for debugging purposes
    """
    raw: Boolean
    requestBody: TicketInput!
    """
    ID of the ticket you are acting upon.
    """
    ticketId: String!
  ): UnifiedId
}

input CollectionTicketCommentInput {
  """
  Body of the comment
  """
  body: String
}

input TicketInput {
  assignees: [AssigneeInput]
  """
  The ticket's description. HTML version of description is mapped if supported by the third-party platform
  """
  description: String
  """
  Due date of the ticket
  """
  dueDate: String
  """
  The ticket's parent ID
  """
  parentId: String
  """
  Priority of the ticket
  """
  priority: Priority
  """
  The current status of the ticket. Possible values include: open, in_progress, closed, or - in cases where there is no clear mapping - the original value passed through.
  """
  status: String
  """
  Subject of the ticket
  """
  subject: String
  tags: [CollectionTagInput]
  """
  The ticket's type
  """
  type: String
}

input AssigneeInput {
  """
  A unique identifier for an object.
  """
  id: String!
}

input CollectionTagInput {
  """
  A unique identifier for an object.
  """
  id: String!
}

type Vault {
  """
  Get a connection
  """
  connection(
    """
    Service ID of the resource to return
    """
    serviceId: String!
    """
    Unified API
    """
    unifiedApi: String!
  ): Connection
  "This endpoint returns custom settings and their defaults required by connection for a given resource."
  connectionSettings(
    """
    Resource Name
    """
    resource: String!
    """
    Service ID of the resource to return
    """
    serviceId: String!
    """
    Unified API
    """
    unifiedApi: String!
  ): Connection
  "This endpoint includes all the configured integrations and contains the required assetsto build an integrations page where your users can install integrations.OAuth2 supported integrations will contain authorize and revoke links to handle the authentication flows."
  connections(
    """
    Scope results to Unified API
    """
    api: String
    """
    Scopes results to connections that have been configured or not
    """
    configured: Boolean
  ): [Connection]
  "Consumer detail including their aggregated counts with the connections they have authorized."
  consumer(
    """
    ID of the consumer to return
    """
    consumerId: String!
  ): Consumer
  "Get consumer request counts within a given datetime range."
  consumerRequestCounts(
    """
    ID of the consumer to return
    """
    consumerId: String!
    """
    Scopes results to requests that happened before datetime
    """
    endDatetime: String!
    """
    Scopes results to requests that happened after datetime
    """
    startDatetime: String!
  ): ConsumerRequestCountsInDateRangeResponse
  "This endpoint includes all application consumers, along with an aggregated count of requests made."
  consumers(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
  ): GetConsumersResponse
  "This endpoint includes all consumer request logs."
  logs(
    """
    Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
    """
    cursor: String
    """
    Filter results
    """
    filter: LogsFilterInput
    """
    Number of results to return. Minimum 1, Maximum 200, Default 20
    """
    limit: Int
  ): LogList
}

type Connection {
  """
  Type of authorization used by the connector
  """
  authType: AuthType
  """
  The OAuth redirect URI. Redirect your users to this URI to let them authorize your app in the connector's UI. Before you can use this URI, you must add \`redirect_uri\` as a query parameter to the \`authorize_url\`. Be sure to URL encode the \`redirect_uri\` part. Your users will be redirected to this \`redirect_uri\` after they granted access to your app in the connector's UI.
  """
  authorizeUrl: String
  configurableResources: [String]
  configuration: [ConfigurationListItem]
  createdAt: Float
  """
  Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API.
  """
  enabled: Boolean
  """
  The settings that are wanted to create a connection.
  """
  formFields: [FormField]
  """
  Whether the connector has a guide available in the developer docs or not (https://docs.apideck.com/connectors/{service_id}/docs/consumer+connection).
  """
  hasGuide: Boolean
  """
  A visual icon of the connection, that will be shown in the Vault
  """
  icon: String
  """
  The unique identifier of the connection.
  """
  id: String
  """
  The current state of the Integration.
  """
  integrationState: IntegrationState
  """
  The logo of the connection, that will be shown in the Vault
  """
  logo: String
  """
  Attach your own consumer specific metadata
  """
  metadata: JSON
  """
  The name of the connection
  """
  name: String
  """
  OAuth grant type used by the connector. More info: https://oauth.net/2/grant-types
  """
  oauthGrantType: OAuthGrantType
  resourceSchemaSupport: [String]
  resourceSettingsSupport: [String]
  """
  The OAuth revoke URI. Redirect your users to this URI to revoke this connection. Before you can use this URI, you must add \`redirect_uri\` as a query parameter. Your users will be redirected to this \`redirect_uri\` after they granted access to your app in the connector's UI.
  """
  revokeUrl: String
  """
  The ID of the service this connection belongs to.
  """
  serviceId: String
  """
  Connection settings. Values will persist to \`form_fields\` with corresponding id
  """
  settings: JSON
  """
  List of settings that are required to be configured on integration before authorization can occur
  """
  settingsRequiredForAuthorization: [String]
  """
  [Connection state flow](#section/Connection-state)
  """
  state: ConnectionState
  """
  Status of the connection.
  """
  status: Status
  subscriptions: [WebhookSubscription]
  tagLine: String
  """
  The unified API category where the connection belongs to.
  """
  unifiedApi: String
  updatedAt: Float
  validationSupport: Boolean
  """
  The website URL of the connection
  """
  website: String
}

enum AuthType {
  oauth2
  apiKey
  basic
  custom
  none
}

type ConfigurationListItem {
  defaults: [DefaultsListItem]
  resource: String
}

type DefaultsListItem {
  id: String
  options: [FormFieldOption]
  target: Target
  value: JSON
}

type FormFieldOption {
  id: String
  label: String
  options: [SimpleFormFieldOption]
  value: JSON
}

type SimpleFormFieldOption {
  label: String
  value: JSON
}

enum Target {
  custom_fields
  resource
}

type FormField {
  """
  Only applicable to select fields. Allow the user to add a custom value though the option select if the desired value is not in the option select list.
  """
  allowCustomValues: Boolean
  customField: Boolean
  """
  The description of the form field
  """
  description: String
  """
  Indicates if the form field is displayed in a “read-only” mode.
  """
  disabled: Boolean
  """
  Indicates if the form field is not displayed but the value that is being stored on the connection.
  """
  hidden: Boolean
  """
  The unique identifier of the form field.
  """
  id: String
  """
  The label of the field
  """
  label: String
  options: [FormFieldOption]
  """
  The placeholder for the form field
  """
  placeholder: String
  """
  Prefix to display in front of the form field.
  """
  prefix: String
  """
  Indicates if the form field is required, which means it must be filled in before the form can be submitted
  """
  required: Boolean
  """
  Indicates if the form field contains sensitive data, which will display the value as a masked input.
  """
  sensitive: Boolean
  """
  Suffix to display next to the form field.
  """
  suffix: String
  type: Type
}

enum IntegrationState {
  disabled
  needs_configuration
  configured
}

enum OAuthGrantType {
  authorization_code
  client_credentials
  password
}

enum ConnectionState {
  available
  callable
  added
  authorized
  invalid
}

type WebhookSubscription {
  """
  The date and time the webhook subscription was created downstream
  """
  createdAt: String
  """
  The list of downstream Events this connection is subscribed to
  """
  downstreamEventTypes: [String]
  """
  The ID of the downstream service
  """
  downstreamId: String
  """
  The URL the downstream is sending to when the event is triggered
  """
  executeUrl: String
  """
  The list of Unify Events this connection is subscribed to
  """
  unifyEventTypes: [String]
}

type Consumer {
  aggregatedRequestCount: Float
  """
  ID of your Apideck Application
  """
  applicationId: String
  connections: [ConsumerConnection]
  """
  Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.
  """
  consumerId: String!
  created: String
  """
  The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended.
  """
  metadata: ConsumerMetadata
  modified: String
  requestCountUpdated: String
  requestCounts: RequestCountAllocation
  services: [String]
}

type ConsumerConnection {
  """
  Type of authorization used by the connector
  """
  authType: AuthType
  consumerId: String
  createdAt: String
  enabled: Boolean
  icon: String
  id: String
  logo: String
  """
  Attach your own consumer specific metadata
  """
  metadata: JSON
  name: String
  serviceId: String
  """
  Connection settings. Values will persist to \`form_fields\` with corresponding id
  """
  settings: JSON
  state: State
  tagLine: String
  unifiedApi: String
  updatedAt: String
  website: String
}

enum State {
  available
  callable
  added
  configured
  authorized
}

"""
The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended.
"""
type ConsumerMetadata {
  """
  The name of the account as shown in the sidebar.
  """
  accountName: String
  """
  The email of the user as shown in the sidebar.
  """
  email: String
  """
  The avatar of the user in the sidebar. Must be a valid URL
  """
  image: String
  """
  The name of the user as shown in the sidebar.
  """
  userName: String
}

type RequestCountAllocation {
  proxy: Float
  unify: Float
  vault: Float
}

type ConsumerRequestCountsInDateRangeResponse {
  aggregatedRequestCount: Float
  applicationId: String
  consumerId: String
  endDatetime: String
  requestCounts: RequestCountAllocation
  startDatetime: String
}

type GetConsumersResponse {
  data: [DataListItem]!
  """
  Response metadata
  """
  meta: Meta
}

type DataListItem {
  aggregatedRequestCount: Float
  applicationId: String
  consumerId: String
  created: String
  """
  The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended.
  """
  metadata: ConsumerMetadata
  modified: String
  requestCountUpdated: String
  requestCounts: RequestCountAllocation
  services: [String]
}

type LogList {
  data: [Log]!
  """
  Response metadata
  """
  meta: Meta
}

type Log {
  """
  Indicates if the request was made via REST or Graphql endpoint.
  """
  apiStyle: String!
  """
  The Apideck base URL the request was made to.
  """
  baseUrl: String!
  """
  Indicates whether or not this is a child or parent request.
  """
  childRequest: Boolean!
  """
  The consumer Id associated with the request.
  """
  consumerId: String!
  """
  The entire execution time in milliseconds it took to call the Apideck service provider.
  """
  duration: Float!
  """
  If error occurred, this is brief explanation
  """
  errorMessage: String
  """
  The entire execution time in milliseconds it took to make the request.
  """
  execution: Int!
  """
  When request is a parent request, this indicates if there are child requests associated.
  """
  hasChildren: Boolean!
  """
  HTTP Method of request.
  """
  httpMethod: String!
  """
  UUID acting as Request Identifier.
  """
  id: String!
  """
  Latency added by making this request via Unified Api.
  """
  latency: Float!
  """
  The request as defined in OpenApi Spec.
  """
  operation: Operation!
  """
  When request is a child request, this UUID indicates it's parent request.
  """
  parentId: String!
  """
  The path component of the URI the request was made to.
  """
  path: String!
  """
  Indicates whether the request was made using Apidecks sandbox credentials or not.
  """
  sandbox: Boolean!
  """
  Apideck service provider associated with request.
  """
  service: Service!
  """
  The IP address of the source of the request.
  """
  sourceIp: String
  """
  HTTP Status code that was returned.
  """
  statusCode: Int!
  """
  Whether or not the request was successful.
  """
  success: Boolean!
  """
  ISO Date and time when the request was made.
  """
  timestamp: String!
  """
  Which Unified Api request was made to.
  """
  unifiedApi: UnifiedApi!
}

"""
The request as defined in OpenApi Spec.
"""
type Operation {
  """
  The OpenApi Operation Id associated with the request
  """
  id: String!
  """
  The OpenApi Operation name associated with the request
  """
  name: String!
}

"""
Apideck service provider associated with request.
"""
type Service {
  """
  Apideck service provider id.
  """
  id: String!
  """
  Apideck service provider name.
  """
  name: String!
}

enum UnifiedApi {
  crm
  lead
  proxy
  vault
  accounting
  hris
  ats
  ecommerce
  issuetracking
  pos
  filestorage
  sms
}

input LogsFilterInput {
  connectorId: String
  excludeUnifiedApis: String
  statusCode: Float
}

type MutationVault {
  """
  Update default values for a connection's resource settings
  """
  connectionSettingsUpdate(
    requestBody: ConnectionInput!
    """
    Resource Name
    """
    resource: String!
    """
    Service ID of the resource to return
    """
    serviceId: String!
    """
    Unified API
    """
    unifiedApi: String!
  ): Connection
  """
  Deletes a connection
  """
  connectionsDelete(
    """
    Service ID of the resource to return
    """
    serviceId: String!
    """
    Unified API
    """
    unifiedApi: String!
  ): JSON
  """
  Update a connection
  """
  connectionsUpdate(
    requestBody: ConnectionInput!
    """
    Service ID of the resource to return
    """
    serviceId: String!
    """
    Unified API
    """
    unifiedApi: String!
  ): Connection
  """
  Create a consumer
  """
  consumersAdd(requestBody: ConsumerInput!): Consumer
  """
  Delete consumer and all their connections, including credentials.
  """
  consumersDelete(
    """
    ID of the consumer to return
    """
    consumerId: String!
  ): DeleteConsumerResponse
  """
  Update consumer metadata such as name and email.
  """
  consumersUpdate(
    """
    ID of the consumer to return
    """
    consumerId: String!
    requestBody: UpdateConsumerRequestInput!
  ): Consumer
  "Making a POST request to this endpoint will initiate a Hosted Vault session. Redirect the consumer to the returnedURL to allow temporary access to manage their integrations and settings.Note: This is a short lived token that will expire after 1 hour (TTL: 3600)."
  sessionsCreate(requestBody: SessionInput): CreateSessionResponse
}

input ConnectionInput {
  configuration: [ConfigurationListItemInput]
  """
  Whether the connection is enabled or not. You can enable or disable a connection using the Update Connection API.
  """
  enabled: Boolean
  """
  Attach your own consumer specific metadata
  """
  metadata: JSON
  """
  Connection settings. Values will persist to \`form_fields\` with corresponding id
  """
  settings: JSON
}

input ConfigurationListItemInput {
  defaults: [DefaultsListItemInput]
  resource: String
}

input DefaultsListItemInput {
  id: String
  options: [FormFieldOptionInput]
  value: JSON
}

input FormFieldOptionInput {
  id: String
  label: String
  options: [SimpleFormFieldOptionInput]
  value: JSON
}

input SimpleFormFieldOptionInput {
  label: String
  value: JSON
}

input ConsumerInput {
  """
  Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.
  """
  consumerId: String!
  """
  The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended.
  """
  metadata: ConsumerMetadataInput
}

"""
The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended.
"""
input ConsumerMetadataInput {
  """
  The name of the account as shown in the sidebar.
  """
  accountName: String
  """
  The email of the user as shown in the sidebar.
  """
  email: String
  """
  The avatar of the user in the sidebar. Must be a valid URL
  """
  image: String
  """
  The name of the user as shown in the sidebar.
  """
  userName: String
}

type DeleteConsumerResponse {
  """
  Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.
  """
  consumerId: String
}

input UpdateConsumerRequestInput {
  """
  The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended.
  """
  metadata: ConsumerMetadataInput
}

type CreateSessionResponse {
  sessionToken: String!
  sessionUri: String!
}

input SessionInput {
  """
  The metadata of the consumer. This is used to display the consumer in the sidebar. This is optional, but recommended.
  """
  consumerMetadata: ConsumerMetadataInput
  """
  Custom consumer settings that are passed as part of the session.
  """
  customConsumerSettings: JSON
  """
  The URL to redirect the user to after the session has been configured.
  """
  redirectUri: String
  """
  Settings to change the way the Vault is displayed.
  """
  settings: SessionSettingsInput
  """
  Theming options to change the look and feel of Vault.
  """
  theme: ThemeInput
}

"""
Settings to change the way the Vault is displayed.
"""
input SessionSettingsInput {
  """
  Hide actions from your users in [Vault](/apis/vault/reference#section/Get-Started). Actions in \`allow_actions\` will be shown on a connection in Vault.
  Available actions are: \`delete\`, \`disconnect\`, \`reauthorize\` and \`disable\`.
  Empty array will hide all actions. By default all actions are visible.
  """
  allowActions: [AllowActionsListItem]
  """
  Automatically redirect to redirect uri after the connection has been configured as callable. Defaults to \`false\`.
  """
  autoRedirect: Boolean
  """
  Hide Apideck connection guides in [Vault](/apis/vault/reference#section/Get-Started). Defaults to \`false\`.
  """
  hideGuides: Boolean
  """
  A boolean that controls the display of the configurable resources for an integration. When set to true, the resource configuration options will be hidden and not shown to the user. When set to false, the resource configuration options will be displayed to the user.
  """
  hideResourceSettings: Boolean
  """
  Configure [Vault](/apis/vault/reference#section/Get-Started) to run in isolation mode, meaning it only shows the connection settings and hides the navigation items.
  """
  isolationMode: Boolean
  """
  Configure [Vault](/apis/vault/reference#section/Get-Started) to show a banner informing the logged in user is in a test environment.
  """
  sandboxMode: Boolean
  """
  The duration of time the session is valid for (maximum 1 week).
  """
  sessionLength: String
  """
  Configure [Vault](/apis/vault/reference#section/Get-Started) to show the logs page. Defaults to \`true\`.
  """
  showLogs: Boolean
  """
  Configure [Vault](/apis/vault/reference#section/Get-Started) to show the sidebar. Defaults to \`true\`.
  """
  showSidebar: Boolean
  """
  Configure [Vault](/apis/vault/reference#section/Get-Started) to show the suggestions page. Defaults to \`false\`.
  """
  showSuggestions: Boolean
  """
  Provide the IDs of the Unified APIs you want to be visible. Leaving it empty or omitting this field will show all Unified APIs.
  """
  unifiedApis: [UnifiedApiId]
}

enum AllowActionsListItem {
  delete
  disconnect
  reauthorize
  disable
}

enum UnifiedApiId {
  accounting
  ats
  calendar
  crm
  csp
  customersupport
  ecommerce
  email
  emailmarketing
  expensemanagement
  filestorage
  form
  hris
  lead
  payroll
  pos
  procurement
  projectmanagement
  script
  sms
  spreadsheet
  teammessaging
  issuetracking
  timeregistration
  transactionalemail
  vault
  datawarehouse
}

"""
Theming options to change the look and feel of Vault.
"""
input ThemeInput {
  """
  The URL to the favicon to use for Vault.
  """
  favicon: String
  """
  The URL to the logo to use for Vault.
  """
  logo: String
  """
  The primary color to use for Vault.
  """
  primaryColor: String
  """
  The URL to the privacy policy that will be shown in the sidebar.
  """
  privacyUrl: String
  """
  The background color to use for the sidebar.
  """
  sidepanelBackgroundColor: String
  """
  The text color to use for the sidebar.
  """
  sidepanelTextColor: String
  """
  The URL to the terms and conditions that will be shown in the sidebar.
  """
  termsUrl: String
  """
  The name that will be shown in the sidebar.
  """
  vaultName: String
}