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

application/json

activebooleanRequired

displayNamestringRequired

userIdstringOptional

externalContactIdstringOptional

Responses

201Success

application/json

401

Need user with one of these roles: superAdmin, admin

post

HTTPcURLJavaScriptPython

POST /{companyId}/contracts/royalty-eligible/create HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "active": true,
  "displayName": "text",
  "userId": "text",
  "externalContactId": "text"
}

{
  "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-09-03T22:25:56.297Z",
    "createdAt": "2025-09-03T22:25:56.297Z",
    "updatedAt": "2025-09-03T22:25:56.297Z"
  },
  "externalContactId": "text",
  "deletedAt": "2025-09-03T22:25:56.297Z",
  "createdAt": "2025-09-03T22:25:56.297Z",
  "updatedAt": "2025-09-03T22:25:56.297Z"
}

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: DESCPossible values:

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

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

idstring[]Optional

userIdsstring[]Optional

externalContactIdsstring[]Optional

walletsbooleanOptional

Responses

200Success

application/json

401

Need user with one of these roles: superAdmin, admin

get

HTTPcURLJavaScriptPython

GET /{companyId}/contracts/royalty-eligible HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

{
  "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-09-03T22:25:56.297Z",
        "createdAt": "2025-09-03T22:25:56.297Z",
        "updatedAt": "2025-09-03T22:25:56.297Z"
      },
      "externalContactId": "text",
      "deletedAt": "2025-09-03T22:25:56.297Z",
      "createdAt": "2025-09-03T22:25:56.297Z",
      "updatedAt": "2025-09-03T22:25:56.297Z",
      "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

application/json

activebooleanRequired

userIdstringOptional

externalContactIdstringOptional

Responses

200Success

No content

401

Need user with one of these roles: superAdmin, admin

patch

HTTPcURLJavaScriptPython

PATCH /{companyId}/contracts/royalty-eligible HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "active": true,
  "userId": "text",
  "externalContactId": "text"
}

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

200Success

application/json

401

Need user with one of these roles: superAdmin, admin

get

HTTPcURLJavaScriptPython

GET /{companyId}/contracts/royalty-eligible/{id} HTTP/1.1
Host: 
x-w3block-api-key: YOUR_API_KEY
Accept: */*

{
  "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-09-03T22:25:56.297Z",
    "createdAt": "2025-09-03T22:25:56.297Z",
    "updatedAt": "2025-09-03T22:25:56.297Z"
  },
  "externalContactId": "text",
  "deletedAt": "2025-09-03T22:25:56.297Z",
  "createdAt": "2025-09-03T22:25:56.297Z",
  "updatedAt": "2025-09-03T22:25:56.297Z"
}