Invitation

/v1/identity/users/invitations GET

/v1/identity/users/invitations

Request parameters

Responses

{
  "data": [
    {
      "id": "example",
      "email": "example",
      "role": "customer",
      "expiresAt": "1971-04-26T12:26:06Z",
      "accepted": true,
      "companyId": "example",
      "invitedById": "example",
      "createdAt": "1971-04-26T12:26:06Z",
      "updateAt": "1971-04-26T12:26:06Z",
      "deletedAt": "1971-04-26T12:26:06Z"
    }
  ],
  "count": 96,
  "total": 96,
  "page": 96,
  "pageCount": 96
}

{
  "code": 96,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

/v1/identity/users/invitations POST

/v1/identity/users/invitations

Request parameters

{
  "role": "customer",
  "emails": [
    "example"
  ]
}

Responses

{
  "data": [
    {
      "token": "example"
    }
  ]
}

{
  "code": 96,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

/v1/identity/users/invitations/accept POST

/v1/identity/users/invitations/accept

Request parameters

{
  "password": "example",
  "token": "example",
  "name": "example"
}

Responses

{
  "user": {
    "id": "example",
    "email": "example",
    "recipientEmail": "example",
    "isActive": true,
    "isVerified": true,
    "type": "customer",
    "tokenIssuedAt": "1971-04-26T12:26:06Z",
    "name": "example",
    "region": "de",
    "webhookUrl": "example",
    "company": {
      "id": "example",
      "name": "example",
      "accountRegion": "eu",
      "handWrittenDocs": true,
      "featureControl": {
        "id": "example",
        "lineItems": true,
        "deliveryNote": true,
        "detectMultiTax": true,
        "duplication": true,
        "eInvoice": true,
        "pagesProcessingCoverage": {
          "splitter": {
            "fromBegin": 96,
            "fromEnd": 96
          },
          "ocr": {
            "fromBegin": 96,
            "fromEnd": 96
          },
          "extractor": {
            "fromBegin": 96,
            "fromEnd": 96
          }
        },
        "dnPagesProcessingCoverage": {
          "splitter": {
            "fromBegin": 96,
            "fromEnd": 96
          },
          "ocr": {
            "fromBegin": 96,
            "fromEnd": 96
          },
          "extractor": {
            "fromBegin": 96,
            "fromEnd": 96
          }
        },
        "companyId": "example",
        "createdAt": "1971-04-26T12:26:06Z",
        "updatedAt": "1971-04-26T12:26:06Z",
        "deletedAt": "1971-04-26T12:26:06Z"
      },
      "fillVendorsData": true,
      "fillRecipientsData": true,
      "divisionId": "example",
      "serial": {
        "id": "example",
        "prefix": "example",
        "numberOfDigits": 96,
        "sequence": 96,
        "isActive": true,
        "isLimitExceeded": true,
        "userId": "example",
        "companyId": "example",
        "createdAt": "1971-04-26T12:26:06Z",
        "updatedAt": "1971-04-26T12:26:06Z",
        "deletedAt": "1971-04-26T12:26:06Z"
      },
      "createdAt": "1971-04-26T12:26:06Z",
      "updatedAt": "1971-04-26T12:26:06Z",
      "deletedAt": "1971-04-26T12:26:06Z"
    },
    "roles": [
      {
        "isDefault": true,
        "name": "example"
      }
    ],
    "companyId": "example",
    "createdAt": "1971-04-26T12:26:06Z",
    "updatedAt": "1971-04-26T12:26:06Z",
    "deletedAt": "1971-04-26T12:26:06Z"
  },
  "token": "example"
}

{
  "code": 96,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

/v1/identity/users/invitations/check POST

/v1/identity/users/invitations/check

Request parameters

{
  "token": "example"
}

Responses

{
  "email": "example",
  "companyName": "example"
}

{
  "code": 96,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

/v1/identity/users/invitations/{id}/cancel PATCH

/v1/identity/users/invitations/{id}/cancel

Request parameters

{}

Responses

{}

{
  "code": 96,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

/v1/identity/users/invitations/{id}/resend PATCH

/v1/identity/users/invitations/{id}/resend

Request parameters

{}

Responses

{}

{
  "code": 96,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}

Last modified: 14 January 2025