Moovago GraphQL API Reference

Welcome to the Moovago GraphQL API reference!
(v20260506-1353)

This reference includes the complete set of GraphQL types, queries, mutations, and their parameters.

Learn how to authenticate and use this API in the Getting Started guide.

If you need help, please send us an email at support@moovago.com

Moovago API GraphQL Schema (SDL): moovago_api_graphql_schema.gql

Our Terms of Service: https://moovago.com/conditions-generales-utilisation-service

Contact

Moovago API support

support@moovago.com

Terms of Service

https://moovago.com/conditions-generales-utilisation-service/

API Endpoints
https://<api-backend>/graphql

Queries

companyContactList

Description

List all companies contacts

Response

Returns [CompanyContact!]!

Arguments
Name Description
filter - FilterManyCompanyContactInput!

Example

Query
query CompanyContactList($filter: FilterManyCompanyContactInput!) {
  companyContactList(filter: $filter) {
    id
    companyId
    createdAt
    email
    firstName
    jobTitles {
      teamId
      jobTitleId
    }
    lastName
    mandatorIds
    note
    ownerIds
    phoneLandline
    phoneMobile
    teamId
    title
  }
}
Variables
{"filter": FilterManyCompanyContactInput}
Response
{
  "data": {
    "companyContactList": [
      {
        "id": "e7D6sdhB2g6IOhpu1x6fED2GYtsM",
        "companyId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
        "createdAt": "2023-07-22T08:55:26.000Z",
        "email": "support@moovago.com",
        "firstName": "Moovago",
        "jobTitles": [ContactJobTitlePayload],
        "lastName": "Moovago",
        "mandatorIds": ["6sdhB2g6IOh2pu1x6fEDe7DGYtsM"],
        "note": "Moovago",
        "ownerIds": [
          "I8Px6fEDe7g6IOh2GYtsMD6sdhB2",
          "01DTLM4wFskTx1tWHNhTW22N3aVV"
        ],
        "phoneLandline": "05 54 54 04 60",
        "phoneMobile": "05 54 54 04 60",
        "teamId": "6fED2GYtsMe7D6sdhB2g6IOhpu1x",
        "title": "MADAM"
      }
    ]
  }
}
Queries

companyList

Description

List all companies

Response

Returns [Company!]!

Arguments
Name Description
filter - FilterManyCompanyInput!

Example

Query
query CompanyList($filter: FilterManyCompanyInput!) {
  companyList(filter: $filter) {
    id
    alias
    address
    city
    createdAt
    customerNumbers {
      customerNumber
      teamMandatorId
    }
    email
    lastCR
    mandatorIds
    name
    ncs {
      nc
      teamId
    }
    note
    officialId
    ownerId
    ownerIds
    phone
    phone2
    postalCode
    segmentations {
      teamId
      segmentation {
        criteriaId
        valueId
      }
    }
    status
    statut
    teamId
    timetable
    updatedAt
    url
  }
}
Variables
{"filter": FilterManyCompanyInput}
Response
{
  "data": {
    "companyList": [
      {
        "id": "e7D6sdhB2g6IOhpu1x6fED2GYtsM",
        "alias": "Moovago 79 Niort",
        "address": "46 Rue du 14 Juillet",
        "city": "Niort",
        "createdAt": "2023-07-22T08:55:26.000Z",
        "customerNumbers": [CompanyCustomerNumber],
        "email": "support@moovago.com",
        "lastCR": "2023-07-22T08:55:26.000Z",
        "mandatorIds": ["6sdhB2g6IOh2pu1x6fEDe7DGYtsM"],
        "name": "Moovago",
        "ncs": [CompanyTeamIdNc],
        "note": "L'application du commercial",
        "officialId": "841412497FR",
        "ownerId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
        "ownerIds": [
          "I8Px6fEDe7g6IOh2GYtsMD6sdhB2",
          "01DTLM4wFskTx1tWHNhTW22N3aVV"
        ],
        "phone": "05 54 54 04 60",
        "phone2": "05 54 54 04 60",
        "postalCode": "79000",
        "segmentations": [CompanySegmentation],
        "status": "CUSTOMER",
        "statut": "CUSTOMER",
        "teamId": "6fED2GYtsMe7D6sdhB2g6IOhpu1x",
        "timetable": "lundi  08:30–19:00 \n mardi  08:30–19:00 \n mercredi  08:30–19:00 \n jeudi  08:30–19:00 \n vendredi  08:30–19:00 \n samedi  09:00–12:30 \n dimanche  Fermé",
        "updatedAt": "2023-07-22T08:55:26.000Z",
        "url": "https://moovago.com/"
      }
    ]
  }
}
Queries

companyReportList

Description

List all companies reports

Response

Returns [CompanyReport!]!

Arguments
Name Description
filter - FilterManyCompanyReportInput!

Example

Query
query CompanyReportList($filter: FilterManyCompanyReportInput!) {
  companyReportList(filter: $filter) {
    id
    companyContacts {
      id
      companyId
      createdAt
      email
      firstName
      jobTitles {
        teamId
        jobTitleId
      }
      lastName
      mandatorIds
      note
      ownerIds
      phoneLandline
      phoneMobile
      teamId
      title
    }
    createdById
    createdAt
    company {
      id
      alias
      address
      city
      createdAt
      customerNumbers {
        customerNumber
        teamMandatorId
      }
      email
      lastCR
      mandatorIds
      name
      ncs {
        nc
        teamId
      }
      note
      officialId
      ownerId
      ownerIds
      phone
      phone2
      postalCode
      segmentations {
        teamId
        segmentation {
          criteriaId
          valueId
        }
      }
      status
      statut
      teamId
      timetable
      updatedAt
      url
    }
    date
    mandator {
      id
      name
    }
    note
    ownerIds
    teamId
    types
    assignedUserIds
  }
}
Variables
{"filter": FilterManyCompanyReportInput}
Response
{
  "data": {
    "companyReportList": [
      {
        "id": "e7D6sdhB2g6IOhpu1x6fED2GYtsM",
        "companyContacts": [CompanyContact],
        "createdById": "e7D6sdhB2g6IOhpu1x6fED2GYtsM",
        "createdAt": "2023-07-22T08:55:26.000Z",
        "company": Company,
        "date": "2023-07-22T08:55:26.000Z",
        "mandator": Mandator,
        "note": "Moovago",
        "ownerIds": [
          "I8Px6fEDe7g6IOh2GYtsMD6sdhB2",
          "01DTLM4wFskTx1tWHNhTW22N3aVV"
        ],
        "teamId": "6fED2GYtsMe7D6sdhB2g6IOhpu1x",
        "types": ["xyz789"],
        "assignedUserIds": ["xyz789"]
      }
    ]
  }
}
Queries

mandatorList

Description

List all mandators

Response

Returns [Mandator!]!

Arguments
Name Description
filter - FilterManyMandatorInput!

Example

Query
query MandatorList($filter: FilterManyMandatorInput!) {
  mandatorList(filter: $filter) {
    id
    name
  }
}
Variables
{"filter": FilterManyMandatorInput}
Response
{
  "data": {
    "mandatorList": [{"id": "6sdhB2g6IOh2pu1x6fEDe7DGYtsM", "name": "Moovago"}]
  }
}
Queries

team

Description

Retrieve your team

Response

Returns a Team

Example

Query
query Team {
  team {
    id
    jobTitles {
      id
      label
    }
    name
    members {
      id
      alias
      teamId
    }
    segmentation {
      label
      id
      values {
        id
        label
      }
    }
  }
}
Response
{
  "data": {
    "team": {
      "id": "pu1x6fEDe7D6sdhB2g6IOh2GYtsM",
      "jobTitles": [ContactJobTitle],
      "name": "Moovago",
      "members": [TeamMember],
      "segmentation": [TeamCriteria]
    }
  }
}
Queries

turnoverList

Description

List all turnovers

Response

Returns [Turnover!]!

Arguments
Name Description
filter - FilterManyTurnoverInput!

Example

Query
query TurnoverList($filter: FilterManyTurnoverInput!) {
  turnoverList(filter: $filter) {
    id
    amount
    commission
    companyId
    createdAt
    discount
    invoiceDate
    isComPercent
    mandatorId
    note
    orderDate
    ownerId
    ownerIds
    ref
    remainder
    status
    teamId
  }
}
Variables
{"filter": FilterManyTurnoverInput}
Response
{
  "data": {
    "turnoverList": [
      {
        "id": "tsMD6sdhB2I8Px6fEDe7g6IOh2GY",
        "amount": 1500,
        "commission": 10,
        "companyId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM",
        "createdAt": "2023-07-22T08:55:26.000Z",
        "discount": 5,
        "invoiceDate": "2023-07-22",
        "isComPercent": false,
        "mandatorId": "sdhB2g6IOhe7D6pu1x6fED2GYtsM",
        "note": "xyz789",
        "orderDate": "2023-07-22",
        "ownerId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
        "ownerIds": [
          "I8Px6fEDe7g6IOh2GYtsMD6sdhB2",
          "01DTLM4wFskTx1tWHNhTW22N3aVV"
        ],
        "ref": "xyz789",
        "remainder": "abc123",
        "status": "INVOICED",
        "teamId": "h2GYt7g6IOsMDI8Px6fEDe6sdhB2"
      }
    ]
  }
}

Mutations

company

Description

All mutations about Company

Response

Returns a CompanyMutations!

Example

Query
mutation Company {
  company {
    create {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on InvalidValueProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
      }
      record {
        id
        alias
        address
        city
        createdAt
        customerNumbers {
          customerNumber
          teamMandatorId
        }
        email
        lastCR
        mandatorIds
        name
        ncs {
          nc
          teamId
        }
        note
        officialId
        ownerId
        ownerIds
        phone
        phone2
        postalCode
        segmentations {
          teamId
          segmentation {
            criteriaId
            valueId
          }
        }
        status
        statut
        teamId
        timetable
        updatedAt
        url
      }
      recordId
    }
    update {
      recordId
    }
    delete {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
      }
      recordId
    }
    removeCriteria {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
      }
      recordId
    }
    removeCriteriaMass {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
      }
      recordIds
    }
    removeCustomerNumbers {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on InvalidValueProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
        ... on NotFoundProblem {
          message
        }
      }
      record {
        id
        alias
        address
        city
        createdAt
        customerNumbers {
          customerNumber
          teamMandatorId
        }
        email
        lastCR
        mandatorIds
        name
        ncs {
          nc
          teamId
        }
        note
        officialId
        ownerId
        ownerIds
        phone
        phone2
        postalCode
        segmentations {
          teamId
          segmentation {
            criteriaId
            valueId
          }
        }
        status
        statut
        teamId
        timetable
        updatedAt
        url
      }
      recordId
    }
    setCriteria {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
      }
      recordId
    }
    setCriteriaMass {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
      }
      recordIds
    }
    setCustomerNumbers {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on InvalidValueProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
        ... on NotFoundProblem {
          message
        }
      }
      recordId
      record {
        id
        alias
        address
        city
        createdAt
        customerNumbers {
          customerNumber
          teamMandatorId
        }
        email
        lastCR
        mandatorIds
        name
        ncs {
          nc
          teamId
        }
        note
        officialId
        ownerId
        ownerIds
        phone
        phone2
        postalCode
        segmentations {
          teamId
          segmentation {
            criteriaId
            valueId
          }
        }
        status
        statut
        teamId
        timetable
        updatedAt
        url
      }
    }
  }
}
Response
{
  "data": {
    "company": {
      "create": CompanyCreatePayload,
      "update": CompanyUpdatePayload,
      "delete": CompanyDeletePayload,
      "removeCriteria": CompanyRemoveCriteriaPayload,
      "removeCriteriaMass": CompanyRemoveCriteriaMassPayload,
      "removeCustomerNumbers": CompanyRemoveCustomerNumbersPayload,
      "setCriteria": CompanySetCriteriaPayload,
      "setCriteriaMass": CompanySetCriteriaMassPayload,
      "setCustomerNumbers": CompanySetCustomerNumbersPayload
    }
  }
}
Mutations

companyContact

Description

All mutations about CompanyContact

Response

Returns a CompanyContactMutations!

Example

Query
mutation CompanyContact {
  companyContact {
    create {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
        ... on MissingParameterProblem {
          message
        }
        ... on NotFoundProblem {
          message
        }
      }
      recordId
    }
    update {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
        ... on NotFoundProblem {
          message
        }
      }
      recordId
    }
    delete {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
        ... on NotFoundProblem {
          message
        }
      }
      recordId
    }
    deleteMass {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
      }
      recordIds
    }
  }
}
Response
{
  "data": {
    "companyContact": {
      "create": CompanyContactCreatePayload,
      "update": CompanyContactUpdatePayload,
      "delete": CompanyContactDeletePayload,
      "deleteMass": CompanyContactDeleteMassPayload
    }
  }
}
Mutations

turnover

Description

All mutations about Turnover

Response

Returns a TurnoverMutations!

Example

Query
mutation Turnover {
  turnover {
    create {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
        ... on NotFoundProblem {
          message
        }
      }
      recordId
    }
    createMass {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on LimitExceededProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
        ... on NotFoundProblem {
          message
        }
      }
      recordIds
    }
    update {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
        ... on NotFoundProblem {
          message
        }
      }
      recordId
    }
    delete {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
        ... on NotFoundProblem {
          message
        }
      }
      recordId
    }
    deleteMass {
      errors {
        ... on ForbiddenProblem {
          message
        }
        ... on MalformedParameterProblem {
          message
        }
      }
      recordIds
    }
  }
}
Response
{
  "data": {
    "turnover": {
      "create": TurnoverCreatePayload,
      "createMass": TurnoverCreateMassPayload,
      "update": TurnoverUpdatePayload,
      "delete": TurnoverDeletePayload,
      "deleteMass": TurnoverDeleteMassPayload
    }
  }
}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Company

Fields
Field Name Description
id - ID! Identifier of the company
alias - String! Alias of the company, name, postal code and city concatenated
address - String Street number and name
city - String City name
createdAt - DateTimeUTC Creation date
customerNumbers - [CompanyCustomerNumber!]! List of customer numbers of this company for the teamId and/or one or several mandatorIds
email - String Email
lastCR - DateTimeUTC Date of last report
mandatorIds - [ID!] List of mandator Ids
name - String Name
ncs - [CompanyTeamIdNc!] List of customer numbers (20241118)
replaced by customerNumbers
note - String Note
officialId - String Identifier (SIREN, VAT, etc.)
ownerId - ID Owner id (see TeamMember.id) (20240905)
replaced by ownerIds
ownerIds - [ID!]! List of owner identifiers (see TeamMember.id)
phone - String Phone number
phone2 - String Landline or fax number
postalCode - String Postal code
segmentations - [CompanySegmentation] List of segmentation
status - CompanyStatusEnum Commercial status
statut - CompanyStatusEnum Commercial status (20241022)
replaced by status
teamId - ID Team id of the owner id of the company (see TeamMember.teamId)
timetable - String Opening hours
updatedAt - DateTimeUTC Last modified date
url - String URL (Website url)
Example
{
  "id": "e7D6sdhB2g6IOhpu1x6fED2GYtsM",
  "alias": "Moovago 79 Niort",
  "address": "46 Rue du 14 Juillet",
  "city": "Niort",
  "createdAt": "2023-07-22T08:55:26.000Z",
  "customerNumbers": [CompanyCustomerNumber],
  "email": "support@moovago.com",
  "lastCR": "2023-07-22T08:55:26.000Z",
  "mandatorIds": ["6sdhB2g6IOh2pu1x6fEDe7DGYtsM"],
  "name": "Moovago",
  "ncs": [CompanyTeamIdNc],
  "note": "L'application du commercial",
  "officialId": "841412497FR",
  "ownerId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
  "ownerIds": ["I8Px6fEDe7g6IOh2GYtsMD6sdhB2", "01DTLM4wFskTx1tWHNhTW22N3aVV"],
  "phone": "05 54 54 04 60",
  "phone2": "05 54 54 04 60",
  "postalCode": "79000",
  "segmentations": [CompanySegmentation],
  "status": "CUSTOMER",
  "statut": "CUSTOMER",
  "teamId": "6fED2GYtsMe7D6sdhB2g6IOhpu1x",
  "timetable": "lundi  08:30–19:00 \n mardi  08:30–19:00 \n mercredi  08:30–19:00 \n jeudi  08:30–19:00 \n vendredi  08:30–19:00 \n samedi  09:00–12:30 \n dimanche  Fermé",
  "updatedAt": "2023-07-22T08:55:26.000Z",
  "url": "https://moovago.com/"
}
Types

CompanyContact

Fields
Field Name Description
id - ID! Identifier of the company contact
companyId - ID! Company id (see Company.id)
createdAt - DateTimeUTC! Creation date
email - String! Email
firstName - String! First name
jobTitles - [ContactJobTitlePayload!]! List of job titles
lastName - String! Last name
mandatorIds - [ID!] List of mandator Ids
note - String! Note
ownerIds - [ID!]! List of owner identifiers (see TeamMember.id)
phoneLandline - String! Landline or fax number
phoneMobile - String! Phone number
teamId - ID! Team id of the owners id of the company (see TeamMember.teamId)
title - ContactTitleEnum Title/Civility
Example
{
  "id": "e7D6sdhB2g6IOhpu1x6fED2GYtsM",
  "companyId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
  "createdAt": "2023-07-22T08:55:26.000Z",
  "email": "support@moovago.com",
  "firstName": "Moovago",
  "jobTitles": [ContactJobTitlePayload],
  "lastName": "Moovago",
  "mandatorIds": ["6sdhB2g6IOh2pu1x6fEDe7DGYtsM"],
  "note": "Moovago",
  "ownerIds": ["I8Px6fEDe7g6IOh2GYtsMD6sdhB2", "01DTLM4wFskTx1tWHNhTW22N3aVV"],
  "phoneLandline": "05 54 54 04 60",
  "phoneMobile": "05 54 54 04 60",
  "teamId": "6fED2GYtsMe7D6sdhB2g6IOhpu1x",
  "title": "MADAM"
}
Types

CompanyContactCreateInput

Description

Data needed to create a company contact.

Fields
Input Field Description
companyId - ID! Company id (see Company.id)
email - String Email
firstName - String First name
jobTitles - [ContactJobTitleInput!] Set job titles
lastName - String Last name
note - String Note
phoneLandline - String Landline or fax number
phoneMobile - String Phone number
title - ContactTitleEnum Title/Civility
Example
{
  "companyId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
  "email": "support@moovago.com",
  "firstName": "Franck",
  "jobTitles": [ContactJobTitleInput],
  "lastName": "Dubois",
  "note": "Note",
  "phoneLandline": "05 54 54 04 60",
  "phoneMobile": "05 54 54 04 60",
  "title": "MADAM"
}
Types

CompanyContactCreatePayload

Fields
Field Name Description
errors - [CompanyContactCreateProblem!]!
recordId - ID Identifier of the created company contact
Example
{
  "errors": [ForbiddenProblem],
  "recordId": "pu1x6fEDe7D6sdhB2g6IOh2GYtsM"
}
Types

CompanyContactCreateProblem

Types
Union Types

ForbiddenProblem

MalformedParameterProblem

MissingParameterProblem

NotFoundProblem
Example
ForbiddenProblem
Types

CompanyContactDeleteMassPayload

Fields
Field Name Description
errors - [CompanyContactDeleteMassProblem!]!
recordIds - [ID!]! Identifier of deleted turnovers
Example
{"errors": [ForbiddenProblem], "recordIds": [4]}
Types

CompanyContactDeleteMassProblem

Types
Union Types

ForbiddenProblem

MalformedParameterProblem
Example
ForbiddenProblem
Types

CompanyContactDeletePayload

Fields
Field Name Description
errors - [CompanyContactDeleteProblem!]!
recordId - ID! Identifier of the deleted company contact
Example
{
  "errors": [ForbiddenProblem],
  "recordId": "pu1x6fEDe7D6sdhB2g6IOh2GYtsM"
}
Types

CompanyContactDeleteProblem

Types
Union Types

ForbiddenProblem

MalformedParameterProblem

NotFoundProblem
Example
ForbiddenProblem
Types

CompanyContactInput

Fields
Input Field Description
email - String Email
firstName - String First name
jobTitles - [ContactJobTitleInput!] Set job titles
lastName - String Last name
note - String Note
phoneLandline - String Landline or fax number
phoneMobile - String Phone number
title - ContactTitleEnum Title/Civility
Example
{
  "email": "support@moovago.com",
  "firstName": "Moovago",
  "jobTitles": [ContactJobTitleInput],
  "lastName": "Moovago",
  "note": "Moovago",
  "phoneLandline": "05 54 54 04 60",
  "phoneMobile": "05 54 54 04 60",
  "title": "MADAM"
}
Types

CompanyContactMutations

Fields
Field Name Description
create - CompanyContactCreatePayload! Create a new company contact
Arguments
input - CompanyContactCreateInput!
update - CompanyContactUpdatePayload! Update a company contact
Arguments
input - CompanyContactUpdateInput!
delete - CompanyContactDeletePayload! Delete a company contact
Arguments
id - ID!
deleteMass - CompanyContactDeleteMassPayload! Delete several company contacts
Arguments
ids - [ID!]!
Example
{
  "create": CompanyContactCreatePayload,
  "update": CompanyContactUpdatePayload,
  "delete": CompanyContactDeletePayload,
  "deleteMass": CompanyContactDeleteMassPayload
}
Types

CompanyContactUpdateInput

Description

Data needed to update company contact

Fields
Input Field Description
id - ID! Identifier of the contact to update
input - CompanyContactInput! Data to update
Example
{
  "id": "I8Px6fEDe7g6IOh2GYtsMD6sdhB2",
  "input": CompanyContactInput
}
Types

CompanyContactUpdatePayload

Fields
Field Name Description
errors - [CompanyContactUpdateProblem!]!
recordId - ID! Identifier of the updated company contact
Example
{
  "errors": [ForbiddenProblem],
  "recordId": "pu1x6fEDe7D6sdhB2g6IOh2GYtsM"
}
Types

CompanyContactUpdateProblem

Types
Union Types

ForbiddenProblem

MalformedParameterProblem

NotFoundProblem
Example
ForbiddenProblem
Types

CompanyCreateInput

Description

Data needed to create company.
France only : you can omit countryCode + areaLevel1Code + areaLevel2Code values. They will be deducted automatically from postalCode.

The company will be automatically geolocated. If we can't find the GPS coordinates, we set them randomly in the Atlantique ocean (near Bordeaux city).

Fields
Input Field Description
address - String Street number and name
areaLevel1Code - String ISO 3166-2 code corresponding to the first-level subdivision of the country (for example for France: see list of french region codes here: https://wikipedia.org/wiki/ISO_3166-2:FR)
areaLevel2Code - String ISO 3166-2 code corresponding to the second-level (and/or third-level, depending of the country) subdivision of the country (for example for France: see list of french department codes here: https://wikipedia.org/wiki/ISO_3166-2:FR)
city - String! City name
countryCode - String ISO 3166-1 alpha-2 code. Two-letter code used for representing country names. Default value is "FR". (see list of country codes here: https://www.iso.org/obp/ui/fr/#search/code/)
customerNumbers - [CompanyCustomerNumberInput!] Set the customer numbers of current team and/or mandators associated to this company
email - String Email
name - String! Name
nc - String Set the customer number of current team
note - String Note
officialId - String Identifier (SIREN, VAT, etc.)
ownerId - ID Owner id (see TeamMember.id) (20240905)
replaced by ownerIds
ownerIds - [ID!] List of owner identifiers (see TeamMember.id)
phone - String Phone number
phone2 - String Landline or fax number
postalCode - String! Postal code
segmentations - [CompanySegmentationInput!] Set segmentation criteria and values
statut - CompanyStatusEnum! Commercial status
timetable - String Opening hours
url - String URL (Website url)
Example
{
  "address": "46 Rue du 14 Juillet",
  "areaLevel1Code": "FR-NAQ",
  "areaLevel2Code": "FR-79",
  "city": "Niort",
  "countryCode": "FR",
  "customerNumbers": [CompanyCustomerNumberInput],
  "email": "support@moovago.com",
  "name": "Moovago",
  "nc": "R1234",
  "note": "L'application du commercial",
  "officialId": "841412497FR",
  "ownerId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
  "ownerIds": ["I8Px6fEDe7g6IOh2GYtsMD6sdhB2", "01DTLM4wFskTx1tWHNhTW22N3aVV"],
  "phone": "05 54 54 04 60",
  "phone2": "05 54 54 04 60",
  "postalCode": "79000",
  "segmentations": [CompanySegmentationInput],
  "statut": "CUSTOMER",
  "timetable": "lundi  08:30–19:00 \n mardi  08:30–19:00 \n mercredi  08:30–19:00 \n jeudi  08:30–19:00 \n vendredi  08:30–19:00 \n samedi  09:00–12:30 \n dimanche  Fermé",
  "url": "https://moovago.com/"
}
Types

CompanyCreatePayload

Fields
Field Name Description
errors - [CompanyCreateProblem!]!
record - Company The created company
recordId - ID Identifier of the created company
Example
{
  "errors": [ForbiddenProblem],
  "record": Company,
  "recordId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM"
}
Types

CompanyCreateProblem

Types
Union Types

ForbiddenProblem

InvalidValueProblem

MalformedParameterProblem
Example
ForbiddenProblem
Types

CompanyCriteriaValue

Description

A customer criteria/value id pair

Fields
Field Name Description
criteriaId - String! Criteria id (refer to TeamCriteria.id defined in Team.segmentation)
valueId - String! Value id (refer to TeamCriteriaValue.id defined in Team.segmentation)
Example
{"criteriaId": "q0", "valueId": "q0r0"}
Types

CompanyCriteriaValueInput

Fields
Input Field Description
criteriaId - String! Criteria id (refer to TeamCriteria.id defined in Team.segmentation)
valueId - String! Value id (refer to TeamCriteriaValue.id defined in Team.segmentation)
Example
{"criteriaId": "q0", "valueId": "q0r0"}
Types

CompanyCustomerNumber

Fields
Field Name Description
customerNumber - String! The customer number value
teamMandatorId - ID! The team or mandator identifier concerned by this customer number
Example
{
  "customerNumber": "abc123",
  "teamMandatorId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM"
}
Types

CompanyCustomerNumberInput

Fields
Input Field Description
customerNumber - String! The customer number value
teamMandatorId - ID! Either the teamId or one of mandatorIds of the company
Example
{
  "customerNumber": "abc123",
  "teamMandatorId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM"
}
Types

CompanyDeletePayload

Fields
Field Name Description
errors - [CompanyDeleteProblem!]!
recordId - ID! Identifier of the deleted company
Example
{
  "errors": [ForbiddenProblem],
  "recordId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM"
}
Types

CompanyDeleteProblem

Types
Union Types

ForbiddenProblem

MalformedParameterProblem
Example
ForbiddenProblem
Types

CompanyInput

Fields
Input Field Description
address - String Street number and name
city - String City name
email - String Email
name - String Name
nc - String Customer number
note - String Note
officialId - String Identifier (SIREN, VAT, etc.)
ownerId - ID Owner id (see TeamMember.id) (20240905)
replaced by ownerIds
ownerIds - [ID!] List of owner identifiers (see TeamMember.id)
phone - String Phone number
phone2 - String Landline or fax number
postalCode - String Postal code
status - CompanyStatusEnum Commercial status
statut - CompanyStatusEnum Commercial status (20241022)
replaced by status
timetable - String Opening hours
url - String URL (Website url)
Example
{
  "address": "46 Rue du 14 Juillet",
  "city": "Niort",
  "email": "support@moovago.com",
  "name": "Moovago",
  "nc": "R1234",
  "note": "L'application du commercial",
  "officialId": "841412497FR",
  "ownerId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
  "ownerIds": ["I8Px6fEDe7g6IOh2GYtsMD6sdhB2", "01DTLM4wFskTx1tWHNhTW22N3aVV"],
  "phone": "05 54 54 04 60",
  "phone2": "05 54 54 04 60",
  "postalCode": "79000",
  "status": "CUSTOMER",
  "statut": "CUSTOMER",
  "timetable": "lundi  08:30–19:00 \n mardi  08:30–19:00 \n mercredi  08:30–19:00 \n jeudi  08:30–19:00 \n vendredi  08:30–19:00 \n samedi  09:00–12:30 \n dimanche  Fermé",
  "url": "https://moovago.com/"
}
Types

CompanyMutations

Fields
Field Name Description
create - CompanyCreatePayload! Create a new company
Arguments
input - CompanyCreateInput!
update - CompanyUpdatePayload! Update a company
Arguments
input - CompanyUpdateInput!
delete - CompanyDeletePayload! Delete a company
Arguments
id - ID!
removeCriteria - CompanyRemoveCriteriaPayload! Remove a list of criteria from a company
Arguments
input - CompanyRemoveCriteriaInput!
removeCriteriaMass - CompanyRemoveCriteriaMassPayload! Remove a list of criteria from several companies
Arguments
input - CompanyRemoveCriteriaMassInput!
removeCustomerNumbers - CompanyRemoveCustomerNumbersPayload! Remove a list of customer numbers from a company
Arguments
input - CompanyRemoveCustomerNumbersInput!
setCriteria - CompanySetCriteriaPayload! Set a list of criteria to a company
Arguments
input - CompanySetCriteriaInput!
setCriteriaMass - CompanySetCriteriaMassPayload! Set a list of criteria to several companies
Arguments
input - CompanySetCriteriaMassInput!
setCustomerNumbers - CompanySetCustomerNumbersPayload! Set a list of customer numbers to a company
Arguments
input - CompanySetCustomerNumbersInput!
Example
{
  "create": CompanyCreatePayload,
  "update": CompanyUpdatePayload,
  "delete": CompanyDeletePayload,
  "removeCriteria": CompanyRemoveCriteriaPayload,
  "removeCriteriaMass": CompanyRemoveCriteriaMassPayload,
  "removeCustomerNumbers": CompanyRemoveCustomerNumbersPayload,
  "setCriteria": CompanySetCriteriaPayload,
  "setCriteriaMass": CompanySetCriteriaMassPayload,
  "setCustomerNumbers": CompanySetCustomerNumbersPayload
}
Types

CompanyRemoveCriteriaIdsInput

Fields
Input Field Description
criteriaIds - [String!]! List of criteria identifiers to remove
teamId - ID! Identifier of the team that defined those criteria (refer to Team.id)
Example
{
  "criteriaIds": ["xyz789"],
  "teamId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM"
}
Types

CompanyRemoveCriteriaInput

Fields
Input Field Description
id - ID! Identifier of the company to update
inputs - [CompanyRemoveCriteriaIdsInput!]! List of criteria to remove
Example
{
  "id": "I8Px6fEDe7g6IOh2GYtsMD6sdhB2",
  "inputs": [CompanyRemoveCriteriaIdsInput]
}
Types

CompanyRemoveCriteriaMassInput

Fields
Input Field Description
ids - [ID!]! List of company identifiers to update
inputs - [CompanyRemoveCriteriaIdsInput!]! List of criteria to remove
Example
{
  "ids": ["4"],
  "inputs": [CompanyRemoveCriteriaIdsInput]
}
Types

CompanyRemoveCriteriaMassPayload

Fields
Field Name Description
errors - [CompanyRemoveCriteriaMassProblem!]!
recordIds - [ID!]! Identifiers of updated companies
Example
{
  "errors": [ForbiddenProblem],
  "recordIds": ["4"]
}
Types

CompanyRemoveCriteriaMassProblem

Types
Union Types

ForbiddenProblem

MalformedParameterProblem
Example
ForbiddenProblem
Types

CompanyRemoveCriteriaPayload

Fields
Field Name Description
errors - [CompanyRemoveCriteriaProblem!]!
recordId - ID! Identifier of updated company
Example
{
  "errors": [ForbiddenProblem],
  "recordId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM"
}
Types

CompanyRemoveCriteriaProblem

Types
Union Types

ForbiddenProblem

MalformedParameterProblem
Example
ForbiddenProblem
Types

CompanyRemoveCustomerNumbersInput

Fields
Input Field Description
id - ID! Identifier of the company to update
teamMandatorIds - [ID!]! List of company teamId and/or one or several company mandatorIds
Example
{"id": "I8Px6fEDe7g6IOh2GYtsMD6sdhB2", "teamMandatorIds": [4]}
Types

CompanyRemoveCustomerNumbersPayload

Fields
Field Name Description
errors - [CompanyRemoveCustomerNumbersProblem!]!
record - Company The updated company
recordId - ID! Identifier of updated company
Example
{
  "errors": [ForbiddenProblem],
  "record": Company,
  "recordId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM"
}
Types

CompanyRemoveCustomerNumbersProblem

Types
Union Types

ForbiddenProblem

InvalidValueProblem

MalformedParameterProblem

NotFoundProblem
Example
ForbiddenProblem
Types

CompanyReport

Fields
Field Name Description
id - ID! Identifier of the company report
companyContacts - [CompanyContact!] All CompanyContacts associated to the company report (see CompanyContact)
createdById - ID! Creator Id
createdAt - DateTimeUTC! Date of creation of the report
company - Company! Company associated to the company report (see Company)
date - DateTimeUTC! Date of the report
mandator - Mandator Mandator associated to the company report (see Mandator)
note - String! Note
ownerIds - [ID!]! List of owner identifiers (see TeamMember.id)
teamId - ID! Team id of the owners id of the company (see TeamMember.teamId)
types - [String!] types of report
assignedUserIds - [String!] Assigned users
Example
{
  "id": "e7D6sdhB2g6IOhpu1x6fED2GYtsM",
  "companyContacts": [CompanyContact],
  "createdById": "e7D6sdhB2g6IOhpu1x6fED2GYtsM",
  "createdAt": "2023-07-22T08:55:26.000Z",
  "company": Company,
  "date": "2023-07-22T08:55:26.000Z",
  "mandator": Mandator,
  "note": "Moovago",
  "ownerIds": ["I8Px6fEDe7g6IOh2GYtsMD6sdhB2", "01DTLM4wFskTx1tWHNhTW22N3aVV"],
  "teamId": "6fED2GYtsMe7D6sdhB2g6IOhpu1x",
  "types": ["abc123"],
  "assignedUserIds": ["xyz789"]
}
Types

CompanySegmentation

Description

A customer team/segmentation pair

Fields
Field Name Description
teamId - ID! Team id (see Team.id)
segmentation - [CompanyCriteriaValue] (see Team.segmentation)
Example
{
  "teamId": "6fED2GYtsMe7D6sdhB2g6IOhpu1x",
  "segmentation": [CompanyCriteriaValue]
}
Types

CompanySegmentationInput

Description

Define the segmentation for the team teamId

Fields
Input Field Description
segmentation - [CompanyCriteriaValueInput!]! (see Team.segmentation)
teamId - ID! Team id (see Team.id)
Example
{
  "segmentation": [CompanyCriteriaValueInput],
  "teamId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2"
}
Types

CompanySetCriteriaEntriesInput

Fields
Input Field Description
criteriaEntries - [CompanySetCriteriaEntryInput!]! List of criteria entries to set
teamId - ID! Identifier of the team that defined those criteria (refer to Team.id)
Example
{
  "criteriaEntries": [CompanySetCriteriaEntryInput],
  "teamId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM"
}
Types

CompanySetCriteriaEntryInput

Fields
Input Field Description
criteriaId - String! Criteria identifier (see Team.segmentation)
valueId - String! Value identifier (see Team.segmentation)
Example
{
  "criteriaId": "abc123",
  "valueId": "abc123"
}
Types

CompanySetCriteriaInput

Fields
Input Field Description
id - ID! Identifier of the company to update
inputs - [CompanySetCriteriaEntriesInput!]! List of criteria to set
Example
{
  "id": "I8Px6fEDe7g6IOh2GYtsMD6sdhB2",
  "inputs": [CompanySetCriteriaEntriesInput]
}
Types

CompanySetCriteriaMassInput

Fields
Input Field Description
ids - [ID!]! List of company identifiers to update
inputs - [CompanySetCriteriaEntriesInput!]! List of criteria to set
Example
{
  "ids": ["4"],
  "inputs": [CompanySetCriteriaEntriesInput]
}
Types

CompanySetCriteriaMassPayload

Fields
Field Name Description
errors - [CompanySetCriteriaMassProblem!]!
recordIds - [ID!]! Identifiers of updated companies
Example
{"errors": [ForbiddenProblem], "recordIds": [4]}
Types

CompanySetCriteriaMassProblem

Types
Union Types

ForbiddenProblem

MalformedParameterProblem
Example
ForbiddenProblem
Types

CompanySetCriteriaPayload

Fields
Field Name Description
errors - [CompanySetCriteriaProblem!]!
recordId - ID! Identifier of updated company
Example
{
  "errors": [ForbiddenProblem],
  "recordId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM"
}
Types

CompanySetCriteriaProblem

Types
Union Types

ForbiddenProblem

MalformedParameterProblem
Example
ForbiddenProblem
Types

CompanySetCustomerNumbersInput

Fields
Input Field Description
id - ID! Identifier of the company to update
inputs - [CompanyCustomerNumberInput!]! List of customer numbers to set
Example
{
  "id": "e7D6sdhB2g6IOhpu1x6fED2GYtsM",
  "inputs": [CompanyCustomerNumberInput]
}
Types

CompanySetCustomerNumbersPayload

Fields
Field Name Description
errors - [CompanySetCustomerNumbersProblem!]!
recordId - ID! Identifier of updated company
record - Company The updated company
Example
{
  "errors": [ForbiddenProblem],
  "recordId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM",
  "record": Company
}
Types

CompanySetCustomerNumbersProblem

Types
Union Types

ForbiddenProblem

InvalidValueProblem

MalformedParameterProblem

NotFoundProblem
Example
ForbiddenProblem
Types

CompanyStatusEnum

Description

Status of company

Values
Enum Value Description

CUSTOMER

 Customer

PROSPECT

 Prospect

SUSPECT

 Suspect
Example
"CUSTOMER"
Types

CompanyTeamIdNc

Description

A customer number/team id pair

Fields
Field Name Description
nc - String!
teamId - ID!
Example
{"nc": "R1234", "teamId": "6fED2GYtsMe7D6sdhB2g6IOhpu1x"}
Types

CompanyUpdateInput

Description

Data needed to update company

Fields
Input Field Description
id - ID! Identifier of the company to update
input - CompanyInput! Data to update
Example
{
  "id": "I8Px6fEDe7g6IOh2GYtsMD6sdhB2",
  "input": CompanyInput
}
Types

CompanyUpdatePayload

Fields
Field Name Description
recordId - ID Identifier of the updated company
Example
{"recordId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM"}
Types

ContactJobTitle

Description

Describe one job title for contacts

Fields
Field Name Description
id - Int! Identifier of the job title
label - String! Custom label describing the value
Example
{"id": 23, "label": "PDG"}
Types

ContactJobTitleInput

Fields
Input Field Description
teamId - ID! Identifier of the team (refer to Team.id)
jobTitleId - Int! Identifier of the job title (refer to ContactJobTitle.id)
Example
{"teamId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM", "jobTitleId": 23}
Types

ContactJobTitlePayload

Fields
Field Name Description
teamId - ID! Identifier of the team (refer to Team.id)
jobTitleId - Int! Identifier of the job title (refer to ContactJobTitle.id)
Example
{"teamId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM", "jobTitleId": 23}
Types

ContactTitleEnum

Description

Titles of contact

Values
Enum Value Description

MISTER

 Mister

MADAM

 Madam
Example
"MISTER"
Types

Date

Description

An RFC-3339 compliant full-date string (= date-only, no time) in the format "yyyy-mm-dd"

Example
"2023-07-22"
Types

DateTimeUTC

Description

ISO8601 full datetime UTC formatted string

Example
"2023-07-22T08:55:26.000Z"
Types

FilterManyCompanyContactInput

Description

At least one of teamId/ownerId is required.

Fields
Input Field Description
companyId - ID Filter by companyId
mandatorId - ID Filter by mandatorId
ownerId - ID Filter by owner id (see TeamMember.id)
teamId - ID Filter by team id (see Team.id or TeamMember.teamId)
Example
{
  "companyId": "6IOh2GYI8Px6fEDe7gtsMD6sdhB2",
  "mandatorId": "6fEDe7g6IOI8Pxh2GYtsMD6sdhB2",
  "ownerId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
  "teamId": "I8Px6fEDe7g6IOh2GYtsMD6sdhB2"
}
Types

FilterManyCompanyInput

Fields
Input Field Description
mandatorId - ID Filter by mandatorId
nameRegex - String Allows you to filter by names with a regex
ownerId - ID Filter by owner id (see TeamMember.id)
status - CompanyStatusEnum Filter by commercial status
teamId - ID Filter by team id (see Team.id or TeamMember.teamId)
updatedAtStart - DateTimeUTC Filter on companies that were updated at this date or after (>=)
updatedAtEnd - DateTimeUTC Filter on companies that were updated before this date (<)
Example
{
  "mandatorId": "6fEDe7g6IOI8Pxh2GYtsMD6sdhB2",
  "nameRegex": "^Moo.*",
  "ownerId": "I8Px6fEDe7g6IOh2GYtsMD6sdhB2",
  "status": "CUSTOMER",
  "teamId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
  "updatedAtStart": "2023-01-01T00:00:00.000Z",
  "updatedAtEnd": "2023-02-01T00:00:00.000Z"
}
Types

FilterManyCompanyReportInput

Description

At least one of teamId/ownerId is required.

Fields
Input Field Description
active - Boolean Filter all, non active or active reports
companyId - ID Filter by companyId
mandatorId - ID Filter by mandatorId
ownerId - ID Filter by owner id (see TeamMember.id)
teamId - ID Filter by team id (see Team.id or TeamMember.teamId)
dateFrom - Date Filter by period. If dateFrom is provided, the period runs from dateFrom to three months later. By default, it is today minus three months. If both dateFrom and dateTo are provided, the period must not exceed three months.
dateTo - Date Filter by period. If dateTo is provided, the period runs up to dateTo starting three months earlier. By default, it is today. If both dateFrom and dateTo are provided, the period must not exceed three months.
Example
{
  "active": true,
  "companyId": "6IOh2GYI8Px6fEDe7gtsMD6sdhB2",
  "mandatorId": "6fEDe7g6IOI8Pxh2GYtsMD6sdhB2",
  "ownerId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
  "teamId": "I8Px6fEDe7g6IOh2GYtsMD6sdhB2",
  "dateFrom": "2023-07-22",
  "dateTo": "2023-07-22"
}
Types

FilterManyMandatorInput

Description

At least one of teamId/userId is required.

Fields
Input Field Description
teamId - ID Filter by team id (see Team.id or TeamMember.teamId)
userId - ID Filter by userId (see TeamMember.id)
Example
{
  "teamId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
  "userId": "6fEDe7g6IOI8Pxh2GYtsMD6sdhB2"
}
Types

FilterManyTurnoverInput

Description

At least one of teamId/ownerId is required.

Fields
Input Field Description
companyId - ID Filter by companyId
mandatorId - ID Filter by mandatorId
ownerId - ID Filter by owner id (see TeamMember.id)
status - TurnoverStatusEnum Filter by status (see TurnoverStatusEnum)
teamId - ID Filter by team id (see Team.id or TeamMember.teamId)
Example
{
  "companyId": "6IOh2GYI8Px6fEDe7gtsMD6sdhB2",
  "mandatorId": "6fEDe7g6IOI8Pxh2GYtsMD6sdhB2",
  "ownerId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
  "status": "INVOICED",
  "teamId": "I8Px6fEDe7g6IOh2GYtsMD6sdhB2"
}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

ForbiddenProblem

Fields
Field Name Description
message - String!
Example
{"message": "You are not authorized to access this data"}
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object. The ID type appears in the JSON as a String; however, it is not intended to be human-readable.

Example
"6sdhB2g6IOh2pu1x6fEDe7DGYtsM"
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Types

InvalidValueProblem

Fields
Field Name Description
message - String!
Example
{"message": "The postal code is not correct"}
Types

LimitExceededProblem

Fields
Field Name Description
message - String!
Example
{"message": "You can not create more than 500 turnovers at once."}
Types

MalformedParameterProblem

Fields
Field Name Description
message - String!
Example
{"message": "An input parameter is empty, or contains an illegal character."}
Types

Mandator

Fields
Field Name Description
id - ID! Identifier of the mandator
name - String! Name
Example
{"id": "6sdhB2g6IOh2pu1x6fEDe7DGYtsM", "name": "Moovago"}
Types

MissingParameterProblem

Fields
Field Name Description
message - String!
Example
{
  "message": "The countryCode is required since you specify areaLevel1Code and/or areaLevel2Code."
}
Types

NotFoundProblem

Fields
Field Name Description
message - String!
Example
{"message": "Company does not exist"}
Types

Problem

Fields
Field Name Description
message - String!
Possible Types
Problem Types

ForbiddenProblem

InvalidValueProblem

LimitExceededProblem

MalformedParameterProblem

MissingParameterProblem

NotFoundProblem
Example
{"message": "abc123"}
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"xyz789"
Types

Team

Fields
Field Name Description
id - ID! Identifier of the team
jobTitles - [ContactJobTitle!]! List of possible job titles for a contact
name - String! Name
members - [TeamMember!]! List of team members
segmentation - [TeamCriteria!]! List of segmentation criteria and all their possible values
Example
{
  "id": "pu1x6fEDe7D6sdhB2g6IOh2GYtsM",
  "jobTitles": [ContactJobTitle],
  "name": "Moovago",
  "members": [TeamMember],
  "segmentation": [TeamCriteria]
}
Types

TeamCriteria

Description

Define a segmentation criteria with all their possible values

Fields
Field Name Description
label - String Custom label describing the criteria
id - String Identifier of the criteria
values - [TeamCriteriaValue] List all the possible values corresponding to the criteria
Example
{
  "label": "Brand",
  "id": "q0",
  "values": [TeamCriteriaValue]
}
Types

TeamCriteriaValue

Description

Describe one value of a criteria

Fields
Field Name Description
id - String Identifier of the value
label - String Custom label describing the value
Example
{"id": "q0r0", "label": "Moovago"}
Types

TeamMember

Description

A user member of a Team

Fields
Field Name Description
id - ID! Identifier of the team member
alias - String! Alias of this member in the corresponding team
teamId - ID Member team id (see Team.id)
Example
{
  "id": "I8Px6fEDe7g6IOh2GYtsMD6sdhB2",
  "alias": "F. Dubois",
  "teamId": "6fED2GYtsMe7D6sdhB2g6IOhpu1x"
}
Types

Turnover

Fields
Field Name Description
id - ID! Identifier of the turnover
amount - Float!
commission - Float!
companyId - ID!
createdAt - DateTimeUTC! Creation date
discount - Float!
invoiceDate - Date!
isComPercent - Boolean! If true, the commission field is a percent of amount.
If false, it's raw amount of commission.
mandatorId - ID
note - String!
orderDate - Date!
ownerId - ID! Owner id (see TeamMember.id). This is the same as the company.ownerId of companyId. (20240905)
replaced by ownerIds
ownerIds - [ID!]! List of owner identifiers (see TeamMember.id - This is the same as the company.ownerId of companyId.)
ref - String!
remainder - String!
status - TurnoverStatusEnum! Turnover status
teamId - ID! Team id (see Team.id or TeamMember.teamId). This is the same as the company.teamId of companyId.
Example
{
  "id": "tsMD6sdhB2I8Px6fEDe7g6IOh2GY",
  "amount": 1500,
  "commission": 10,
  "companyId": "e7D6sdhB2g6IOhpu1x6fED2GYtsM",
  "createdAt": "2023-07-22T08:55:26.000Z",
  "discount": 5,
  "invoiceDate": "2023-07-22",
  "isComPercent": true,
  "mandatorId": "sdhB2g6IOhe7D6pu1x6fED2GYtsM",
  "note": "abc123",
  "orderDate": "2023-07-22",
  "ownerId": "7g6IOh2GYtsMD6I8Px6fEDesdhB2",
  "ownerIds": ["I8Px6fEDe7g6IOh2GYtsMD6sdhB2", "01DTLM4wFskTx1tWHNhTW22N3aVV"],
  "ref": "abc123",
  "remainder": "xyz789",
  "status": "INVOICED",
  "teamId": "h2GYt7g6IOsMDI8Px6fEDe6sdhB2"
}
Types

TurnoverCreateInput

Fields
Input Field Description
amount - Float
commission - Float
companyId - ID!
discount - Float
invoiceDate - Date!
isComPercent - Boolean If this field is true, commission is percent of amount. Else, it's raw amount of commission. Default value is true.
mandatorId - ID
note - String
orderDate - Date!
ref - String
remainder - String
status - TurnoverStatusEnum
Example
{
  "amount": 1500,
  "commission": 10,
  "companyId": "7g6IOh2GYtsMDI8Px6fEDe6sdhB2",
  "discount": 5,
  "invoiceDate": "2023-07-22",
  "isComPercent": true,
  "mandatorId": "h2GYt7g6IOsMDI8Px6fEDe6sdhB2",
  "note": "Custom note",
  "orderDate": "2023-07-22",
  "ref": "R857458",
  "remainder": "N 11052",
  "status": "INVOICED"
}
Types

TurnoverCreateMassPayload

Fields
Field Name Description
errors - [TurnoverCreateMassProblem!]!
recordIds - [ID!]! Identifier of the created turnovers
Example
{"errors": [ForbiddenProblem], "recordIds": [4]}
Types

TurnoverCreateMassProblem

Types
Union Types

ForbiddenProblem

LimitExceededProblem

MalformedParameterProblem

NotFoundProblem
Example
ForbiddenProblem
Types

TurnoverCreatePayload

Fields
Field Name Description
errors - [TurnoverCreateProblem!]!
recordId - ID Identifier of the created turnover
Example
{
  "errors": [ForbiddenProblem],
  "recordId": "h2GYt7g6IOsMDI8Px6fEDe6sdhB2"
}
Types

TurnoverCreateProblem

Types
Union Types

ForbiddenProblem

MalformedParameterProblem

NotFoundProblem
Example
ForbiddenProblem
Types

TurnoverDeleteMassPayload

Fields
Field Name Description
errors - [TurnoverDeleteMassProblem!]!
recordIds - [ID!]! Identifier of deleted turnovers
Example
{
  "errors": [ForbiddenProblem],
  "recordIds": ["4"]
}
Types

TurnoverDeleteMassProblem

Types
Union Types

ForbiddenProblem

MalformedParameterProblem
Example
ForbiddenProblem
Types

TurnoverDeletePayload

Fields
Field Name Description
errors - [TurnoverDeleteProblem!]!
recordId - ID! Identifier of the deleted turnover
Example
{
  "errors": [ForbiddenProblem],
  "recordId": "h2GYt7g6IOsMDI8Px6fEDe6sdhB2"
}
Types

TurnoverDeleteProblem

Types
Union Types

ForbiddenProblem

MalformedParameterProblem

NotFoundProblem
Example
ForbiddenProblem
Types

TurnoverInput

Fields
Input Field Description
amount - Float
commission - Float
discount - Float
invoiceDate - Date
isComPercent - Boolean If this field is true, commission is percent of amount. Else, it's raw amount of commission. Default value is true.
mandatorId - ID
note - String
orderDate - Date
ref - String
remainder - String
status - TurnoverStatusEnum
Example
{
  "amount": 1500,
  "commission": 10,
  "discount": 5,
  "invoiceDate": "2023-07-22",
  "isComPercent": true,
  "mandatorId": "h2GYt7g6IOsMDI8Px6fEDe6sdhB2",
  "note": "Custom note",
  "orderDate": "2023-07-22",
  "ref": "R857458",
  "remainder": "N 11052",
  "status": "INVOICED"
}
Types

TurnoverMutations

Fields
Field Name Description
create - TurnoverCreatePayload! Create a new turnover
Arguments
input - TurnoverCreateInput!
createMass - TurnoverCreateMassPayload! Create several turnovers (500 maximum)
Arguments
inputs - [TurnoverCreateInput!]!
update - TurnoverUpdatePayload! Update a turnover
Arguments
input - TurnoverUpdateInput!
delete - TurnoverDeletePayload! Delete a turnover
Arguments
id - ID!
deleteMass - TurnoverDeleteMassPayload! Delete several turnovers
Arguments
ids - [ID!]!
Example
{
  "create": TurnoverCreatePayload,
  "createMass": TurnoverCreateMassPayload,
  "update": TurnoverUpdatePayload,
  "delete": TurnoverDeletePayload,
  "deleteMass": TurnoverDeleteMassPayload
}
Types

TurnoverStatusEnum

Description

Status of turnover

Values
Enum Value Description

INVOICED

 Invoiced

LOST

 Lost

ORDERED

 Ordered
Example
"INVOICED"
Types

TurnoverUpdateInput

Description

Data needed to update a turnover

Fields
Input Field Description
id - ID! Identifier of the turnover to update
input - TurnoverInput! Data to update
Example
{
  "id": "I8Px6fEDe7g6IOh2GYtsMD6sdhB2",
  "input": TurnoverInput
}
Types

TurnoverUpdatePayload

Fields
Field Name Description
errors - [TurnoverUpdateProblem!]!
recordId - ID! Identifier of the updated turnover
Example
{
  "errors": [ForbiddenProblem],
  "recordId": "h2GYt7g6IOsMDI8Px6fEDe6sdhB2"
}
Types

TurnoverUpdateProblem

Types
Union Types

ForbiddenProblem

MalformedParameterProblem

NotFoundProblem
Example
ForbiddenProblem
Documentation by Anvil SpectaQL