Royalty Eligible

Anyone who is eligible for royalties

This module is not essential for your use, but with it you can list any user or external contact on your company as being eligible for your contract's royalties. This does not makes him receive anything, just helps you administer who you want to be listed when you are selecting someone to receive a royalty in any of your contracts

Create a Royalty Eligible

post

Create a royalty eligible entity (makes a contact eligible for royalties in contracts)

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

companyIdstringrequired

Body

activebooleanrequired

displayNamestringrequired

userIdstringoptional

externalContactIdstringoptional

Responses

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url '/{companyId}/contracts/royalty-eligible/create' \
  --header 'x-w3block-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "active": true,
    "displayName": "text",
    "userId": "text",
    "externalContactId": "text"
  }'

201

401

201

{
  "id": "text",
  "companyId": "text",
  "active": true,
  "displayName": "text",
  "userId": "text",
  "externalContact": {
    "id": "text",
    "companyId": "text",
    "active": true,
    "name": "text",
    "userId": "text",
    "walletAddress": "text",
    "email": "text",
    "description": "text",
    "method": "import",
    "address": "text",
    "phone": "text",
    "deletedAt": "2025-04-10T15:57:35.270Z",
    "createdAt": "2025-04-10T15:57:35.270Z",
    "updatedAt": "2025-04-10T15:57:35.270Z"
  },
  "externalContactId": "text",
  "deletedAt": "2025-04-10T15:57:35.270Z",
  "createdAt": "2025-04-10T15:57:35.270Z",
  "updatedAt": "2025-04-10T15:57:35.270Z"
}

List Royalty Eligibles for your company

get

Get all royalty eligibles by company

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

companyIdstringrequired

Query parameters

pagenumberoptionalDefault: 1

limitnumberoptionalDefault: 10

searchstringoptional

sortBystringoptional

orderBystring · enumoptionalDefault: DESCAvailable options:

minDatestringoptionalExample: 2022-02-15T10:30:05-03:00

maxDatestringoptionalExample: 2022-02-15T10:30:05-03:00

idstring[]optional

userIdsstring[]optional

externalContactIdsstring[]optional

walletsbooleanoptional

Responses

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url '/{companyId}/contracts/royalty-eligible' \
  --header 'x-w3block-api-key: YOUR_API_KEY'

200

401

200

{
  "meta": {
    "itemCount": 1,
    "totalItems": 1,
    "itemsPerPage": 1,
    "totalPages": 1,
    "currentPage": 1
  },
  "links": {
    "first": "http://example.com?page=1",
    "prev": "http://example.com?page=1",
    "next": "http://example.com?page=2",
    "last": "http://example.com?page=3"
  },
  "items": [
    {
      "id": "text",
      "companyId": "text",
      "active": true,
      "displayName": "text",
      "userId": "text",
      "externalContact": {
        "id": "text",
        "companyId": "text",
        "active": true,
        "name": "text",
        "userId": "text",
        "walletAddress": "text",
        "email": "text",
        "description": "text",
        "method": "import",
        "address": "text",
        "phone": "text",
        "deletedAt": "2025-04-10T15:57:35.270Z",
        "createdAt": "2025-04-10T15:57:35.270Z",
        "updatedAt": "2025-04-10T15:57:35.270Z"
      },
      "externalContactId": "text",
      "deletedAt": "2025-04-10T15:57:35.270Z",
      "createdAt": "2025-04-10T15:57:35.270Z",
      "updatedAt": "2025-04-10T15:57:35.270Z",
      "walletAddress": "text"
    }
  ]
}

Activate or deactivate a RoyaltyEligible

When you do not want a contact to be eligible for royalties anymore you can deactivate it so it does not interfere with any contracts they were already used for.

patch

Activate or deactivate a royalty eligible

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

companyIdstringrequired

Body

activebooleanrequired

userIdstringoptional

externalContactIdstringoptional

Responses

patch

cURLJavaScriptPythonHTTP

curl -L \
  --request PATCH \
  --url '/{companyId}/contracts/royalty-eligible' \
  --header 'x-w3block-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "active": true,
    "userId": "text",
    "externalContactId": "text"
  }'

200

401

200

No Content

Get a royalty eligible by id

get

Get a royalty eligible by id

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

companyIdstringrequired

idstringrequired

Responses

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url '/{companyId}/contracts/royalty-eligible/{id}' \
  --header 'x-w3block-api-key: YOUR_API_KEY'

200

401

200

{
  "id": "text",
  "companyId": "text",
  "active": true,
  "displayName": "text",
  "userId": "text",
  "externalContact": {
    "id": "text",
    "companyId": "text",
    "active": true,
    "name": "text",
    "userId": "text",
    "walletAddress": "text",
    "email": "text",
    "description": "text",
    "method": "import",
    "address": "text",
    "phone": "text",
    "deletedAt": "2025-04-10T15:57:35.270Z",
    "createdAt": "2025-04-10T15:57:35.270Z",
    "updatedAt": "2025-04-10T15:57:35.270Z"
  },
  "externalContactId": "text",
  "deletedAt": "2025-04-10T15:57:35.270Z",
  "createdAt": "2025-04-10T15:57:35.270Z",
  "updatedAt": "2025-04-10T15:57:35.270Z"
}