Heartwork API

Accounts

Endpointhttps://api.heart.work

Download schema

Fetches a single account, by id.

GET

https://api.heart.work

/core-api/accounts/{id}

Fetches a single account, by id. › path Parameters

id

string · required

Unique id of the account to fetch.

Fetches a single account, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

displayName

string · required

object[] · required

industries

string[] · required

chamberOfCommerceRubricationCodes

string[] · required

tags

string[] · required

object[] · required

externalReference

string

description

string

notes

string

accountCode

string

accountStatus

string

accountType

string · enum

Enum values:

Customer

Supplier

Competitor

Investor

Partner

ownerId

string

object

salesOrderProcessorId

string

employees

integer · int32

vatNumber

string

chamberOfCommerce

string

vatValidationDate

string · date-time

productCatalogId

string

lastContactMoment

string · date-time

object

GET/core-api/accounts/{id}

curl --request GET \
  --url https://api.heart.work/core-api/accounts/:id

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "displayName": "displayName",
  "description": "description",
  "notes": "notes",
  "accountCode": "accountCode",
  "accountStatus": "accountStatus",
  "accountType": "Customer",
  "ownerId": "ownerId",
  "visitingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "billingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "shippingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "otherAddresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "salesOrderProcessorId": "salesOrderProcessorId",
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      }
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "industries": [
    "string"
  ],
  "employees": 0,
  "vatNumber": "vatNumber",
  "chamberOfCommerce": "chamberOfCommerce",
  "chamberOfCommerceRubricationCodes": [
    "string"
  ],
  "vatValidationDate": "2024-08-25T15:00:00Z",
  "productCatalogId": "productCatalogId",
  "tags": [
    "string"
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "attributes": {},
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    },
    "locations": [
      {
        "id": "id",
        "name": "name",
        "type": "Location"
      }
    ]
  },
  "owner": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "salesOrderProcessor": {
    "id": "id",
    "name": "name",
    "type": "Location"
  },
  "productCatalog": {
    "id": "id",
    "name": "name",
    "type": "ProductCatalog"
  }
}

plain

Updates an existing account, replacing it entirely.

PUT

https://api.heart.work

/core-api/accounts/{id}

On success, returns the updated entity in the response.

Updates an existing account, replacing it entirely. › path Parameters

id

string · required

Updates an existing account, replacing it entirely. › Request Body

displayName

string · required

id

string · required

externalReference

string

description

string

notes

string

accountCode

string

accountStatus

string

accountType

string · enum

Enum values:

Customer

Supplier

Competitor

Investor

Partner

ownerId

string

object

object[]

salesOrderProcessorId

string

object[]

industries

string[]

employees

integer · int32

vatNumber

string

chamberOfCommerce

string

chamberOfCommerceRubricationCodes

string[]

vatValidationDate

string · date-time

productCatalogId

string

tags

string[]

lastContactMoment

string · date-time

object

object[]

object

Updates an existing account, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

displayName

string · required

object[] · required

industries

string[] · required

chamberOfCommerceRubricationCodes

string[] · required

tags

string[] · required

object[] · required

externalReference

string

description

string

notes

string

accountCode

string

accountStatus

string

accountType

string · enum

Enum values:

Customer

Supplier

Competitor

Investor

Partner

ownerId

string

object

salesOrderProcessorId

string

employees

integer · int32

vatNumber

string

chamberOfCommerce

string

vatValidationDate

string · date-time

productCatalogId

string

lastContactMoment

string · date-time

object

PUT/core-api/accounts/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/accounts/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "displayName": "displayName",
  "description": "description",
  "notes": "notes",
  "accountCode": "accountCode",
  "accountStatus": "accountStatus",
  "accountType": "Customer",
  "ownerId": "ownerId",
  "visitingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "billingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "shippingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "otherAddresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "salesOrderProcessorId": "salesOrderProcessorId",
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entityId": "entityId"
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "industries": [
    "string"
  ],
  "employees": 0,
  "vatNumber": "vatNumber",
  "chamberOfCommerce": "chamberOfCommerce",
  "chamberOfCommerceRubricationCodes": [
    "string"
  ],
  "vatValidationDate": "2024-08-25T15:00:00Z",
  "productCatalogId": "productCatalogId",
  "tags": [
    "string"
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "attributes": {},
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    },
    "locations": [
      {
        "id": "id",
        "name": "name",
        "type": "Location"
      }
    ]
  },
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "displayName": "displayName",
  "description": "description",
  "notes": "notes",
  "accountCode": "accountCode",
  "accountStatus": "accountStatus",
  "accountType": "Customer",
  "ownerId": "ownerId",
  "visitingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "billingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "shippingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "otherAddresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "salesOrderProcessorId": "salesOrderProcessorId",
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entityId": "entityId"
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "industries": [
    "string"
  ],
  "employees": 0,
  "vatNumber": "vatNumber",
  "chamberOfCommerce": "chamberOfCommerce",
  "chamberOfCommerceRubricationCodes": [
    "string"
  ],
  "vatValidationDate": "2024-08-25T15:00:00Z",
  "productCatalogId": "productCatalogId",
  "tags": [
    "string"
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "attributes": {},
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    },
    "locations": [
      {
        "id": "id",
        "name": "name",
        "type": "Location"
      }
    ]
  },
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "displayName": "displayName",
  "description": "description",
  "notes": "notes",
  "accountCode": "accountCode",
  "accountStatus": "accountStatus",
  "accountType": "Customer",
  "ownerId": "ownerId",
  "visitingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "billingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "shippingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "otherAddresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "salesOrderProcessorId": "salesOrderProcessorId",
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      }
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "industries": [
    "string"
  ],
  "employees": 0,
  "vatNumber": "vatNumber",
  "chamberOfCommerce": "chamberOfCommerce",
  "chamberOfCommerceRubricationCodes": [
    "string"
  ],
  "vatValidationDate": "2024-08-25T15:00:00Z",
  "productCatalogId": "productCatalogId",
  "tags": [
    "string"
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "attributes": {},
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    },
    "locations": [
      {
        "id": "id",
        "name": "name",
        "type": "Location"
      }
    ]
  },
  "owner": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "salesOrderProcessor": {
    "id": "id",
    "name": "name",
    "type": "Location"
  },
  "productCatalog": {
    "id": "id",
    "name": "name",
    "type": "ProductCatalog"
  }
}

plain

Deletes an existing account, by id.

DELETE

https://api.heart.work

/core-api/accounts/{id}

Deletes an existing account, by id. › path Parameters

id

string · required

Unique id of the account to delete.

Deletes an existing account, by id. › Responses

No data returned

DELETE/core-api/accounts/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/accounts/:id

shell

Example Responses

No example specified for this content type

Searches accounts based on specific property values.

GET

https://api.heart.work

/core-api/accounts

Searches accounts based on specific property values. › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

DisplayName

ModifiedAt

Query

string

ids

string[]

external_references

string[]

account_types

string[]

Enum values:

Customer

Supplier

Competitor

Investor

Partner

owner_ids

string[]

industries

string[]

tags

string[]

Searches accounts based on specific property values. › Responses

object[] · required

total

integer · int32 · required

GET/core-api/accounts

curl --request GET \
  --url https://api.heart.work/core-api/accounts

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "displayName": "displayName",
      "description": "description",
      "notes": "notes",
      "accountCode": "accountCode",
      "accountStatus": "accountStatus",
      "accountType": "Customer",
      "ownerId": "ownerId",
      "visitingAddress": {
        "addressType": "addressType",
        "street": "street",
        "zipCode": "zipCode",
        "city": "city",
        "country": "country"
      },
      "billingAddress": {
        "addressType": "addressType",
        "street": "street",
        "zipCode": "zipCode",
        "city": "city",
        "country": "country"
      },
      "shippingAddress": {
        "addressType": "addressType",
        "street": "street",
        "zipCode": "zipCode",
        "city": "city",
        "country": "country"
      },
      "otherAddresses": [
        {
          "addressType": "addressType",
          "street": "street",
          "zipCode": "zipCode",
          "city": "city",
          "country": "country"
        }
      ],
      "salesOrderProcessorId": "salesOrderProcessorId",
      "connections": [
        {
          "label": "label",
          "reverseLabel": "reverseLabel",
          "type": "type",
          "entity": {
            "id": "id",
            "name": "name",
            "type": "Account"
          }
        }
      ],
      "emails": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "phoneNumbers": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "links": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "industries": [
        "string"
      ],
      "employees": 0,
      "vatNumber": "vatNumber",
      "chamberOfCommerce": "chamberOfCommerce",
      "chamberOfCommerceRubricationCodes": [
        "string"
      ],
      "vatValidationDate": "2024-08-25T15:00:00Z",
      "productCatalogId": "productCatalogId",
      "tags": [
        "string"
      ],
      "lastContactMoment": "2024-08-25T15:00:00Z",
      "attributes": {},
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "commerceSettings": {
        "priceSettings": {
          "showSalesPrice": true,
          "showCustomerPrice": true,
          "showSuggestedRetailPrice": true
        },
        "locations": [
          {
            "id": "id",
            "name": "name",
            "type": "Location"
          }
        ]
      },
      "owner": {
        "id": "id",
        "name": "name",
        "type": "HeartworkUser"
      },
      "salesOrderProcessor": {
        "id": "id",
        "name": "name",
        "type": "Location"
      },
      "productCatalog": {
        "id": "id",
        "name": "name",
        "type": "ProductCatalog"
      }
    }
  ],
  "total": 0
}

plain

Creates and stores a new account.

POST

https://api.heart.work

/core-api/accounts

On success, returns the newly created entity in the response.

Creates and stores a new account. › Request Body

displayName

string · required

externalReference

string

description

string

notes

string

accountCode

string

accountStatus

string

accountType

string · enum

Enum values:

Customer

Supplier

Competitor

Investor

Partner

ownerId

string

object

object[]

salesOrderProcessorId

string

object[]

industries

string[]

employees

integer · int32

vatNumber

string

chamberOfCommerce

string

chamberOfCommerceRubricationCodes

string[]

vatValidationDate

string · date-time

productCatalogId

string

tags

string[]

lastContactMoment

string · date-time

object

object[]

object

Creates and stores a new account. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

displayName

string · required

object[] · required

industries

string[] · required

chamberOfCommerceRubricationCodes

string[] · required

tags

string[] · required

object[] · required

externalReference

string

description

string

notes

string

accountCode

string

accountStatus

string

accountType

string · enum

Enum values:

Customer

Supplier

Competitor

Investor

Partner

ownerId

string

object

salesOrderProcessorId

string

employees

integer · int32

vatNumber

string

chamberOfCommerce

string

vatValidationDate

string · date-time

productCatalogId

string

lastContactMoment

string · date-time

object

POST/core-api/accounts

curl --request POST \
  --url https://api.heart.work/core-api/accounts \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "displayName": "displayName",
  "description": "description",
  "notes": "notes",
  "accountCode": "accountCode",
  "accountStatus": "accountStatus",
  "accountType": "Customer",
  "ownerId": "ownerId",
  "visitingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "billingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "shippingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "otherAddresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "salesOrderProcessorId": "salesOrderProcessorId",
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entityId": "entityId"
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "industries": [
    "string"
  ],
  "employees": 0,
  "vatNumber": "vatNumber",
  "chamberOfCommerce": "chamberOfCommerce",
  "chamberOfCommerceRubricationCodes": [
    "string"
  ],
  "vatValidationDate": "2024-08-25T15:00:00Z",
  "productCatalogId": "productCatalogId",
  "tags": [
    "string"
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "attributes": {},
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    },
    "locations": [
      {
        "id": "id",
        "name": "name",
        "type": "Location"
      }
    ]
  }
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "displayName": "displayName",
  "description": "description",
  "notes": "notes",
  "accountCode": "accountCode",
  "accountStatus": "accountStatus",
  "accountType": "Customer",
  "ownerId": "ownerId",
  "visitingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "billingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "shippingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "otherAddresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "salesOrderProcessorId": "salesOrderProcessorId",
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entityId": "entityId"
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "industries": [
    "string"
  ],
  "employees": 0,
  "vatNumber": "vatNumber",
  "chamberOfCommerce": "chamberOfCommerce",
  "chamberOfCommerceRubricationCodes": [
    "string"
  ],
  "vatValidationDate": "2024-08-25T15:00:00Z",
  "productCatalogId": "productCatalogId",
  "tags": [
    "string"
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "attributes": {},
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    },
    "locations": [
      {
        "id": "id",
        "name": "name",
        "type": "Location"
      }
    ]
  }
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "displayName": "displayName",
  "description": "description",
  "notes": "notes",
  "accountCode": "accountCode",
  "accountStatus": "accountStatus",
  "accountType": "Customer",
  "ownerId": "ownerId",
  "visitingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "billingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "shippingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "otherAddresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "salesOrderProcessorId": "salesOrderProcessorId",
  "connections": [
    {
      "label": "label",
      "reverseLabel": "reverseLabel",
      "type": "type",
      "entity": {
        "id": "id",
        "name": "name",
        "type": "Account"
      }
    }
  ],
  "emails": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "phoneNumbers": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "links": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "industries": [
    "string"
  ],
  "employees": 0,
  "vatNumber": "vatNumber",
  "chamberOfCommerce": "chamberOfCommerce",
  "chamberOfCommerceRubricationCodes": [
    "string"
  ],
  "vatValidationDate": "2024-08-25T15:00:00Z",
  "productCatalogId": "productCatalogId",
  "tags": [
    "string"
  ],
  "lastContactMoment": "2024-08-25T15:00:00Z",
  "attributes": {},
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    },
    "locations": [
      {
        "id": "id",
        "name": "name",
        "type": "Location"
      }
    ]
  },
  "owner": {
    "id": "id",
    "name": "name",
    "type": "HeartworkUser"
  },
  "salesOrderProcessor": {
    "id": "id",
    "name": "name",
    "type": "Location"
  },
  "productCatalog": {
    "id": "id",
    "name": "name",
    "type": "ProductCatalog"
  }
}

plain

Fetches a collection of suggested accounts, by query

GET

https://api.heart.work

/core-api/accounts/suggest/{query}

Fetches a collection of suggested accounts, by query › path Parameters

query

string · required

The search query

Fetches a collection of suggested accounts, by query › query Parameters

take

integer · int32

Amount to take

Default: 15

page

integer · int32

The page you want

Default: 0

Fetches a collection of suggested accounts, by query › Responses

object[] · required

total

integer · int32 · required

GET/core-api/accounts/suggest/{query}

curl --request GET \
  --url https://api.heart.work/core-api/accounts/suggest/:query

shell

Example Responses

{
  "data": [
    {
      "kvkNumber": "kvkNumber",
      "branchNumber": "branchNumber",
      "displayName": "displayName",
      "city": "city",
      "street": "street"
    }
  ],
  "total": 0
}

plain

Fetches all the details of an suggested account, by COC number and subdossier number

GET

https://api.heart.work

/core-api/accounts/suggest/{chamberOfCommerceNumber}/details

Fetches all the details of an suggested account, by COC number and subdossier number › path Parameters

chamberOfCommerceNumber

string · required

The chamber of commerce number of the account

Fetches all the details of an suggested account, by COC number and subdossier number › Responses

chamberOfCommerceNumber

string · required

branchNumber

string · required

displayName

string · required

fullName

string · required

object[] · required

rsin

string · required

websites

string[] · required

companyType

string · required

object[] · required

employees

integer · int32

foundationDate

string · date-time

GET/core-api/accounts/suggest/{chamberOfCommerceNumber}/details

curl --request GET \
  --url https://api.heart.work/core-api/accounts/suggest/:chamberOfCommerceNumber/details

shell

Example Responses

{
  "chamberOfCommerceNumber": "chamberOfCommerceNumber",
  "branchNumber": "branchNumber",
  "displayName": "displayName",
  "fullName": "fullName",
  "addresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "rsin": "rsin",
  "employees": 0,
  "websites": [
    "string"
  ],
  "foundationDate": "2024-08-25T15:00:00Z",
  "companyType": "companyType",
  "businessActivities": [
    {
      "code": "code",
      "description": "description"
    }
  ]
}

plain

Get all filterable values for accounts

GET

https://api.heart.work

/core-api/accounts/filters

Get all filterable values for accounts › Responses

object[] · required

tags

string[] · required

industries

string[] · required

GET/core-api/accounts/filters

curl --request GET \
  --url https://api.heart.work/core-api/accounts/filters

shell

Example Responses

{
  "connections": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "owners": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "industries": [
    "string"
  ]
}

plain

GET

https://api.heart.work

/core-api/accounts/stats

Responses

object · required

object[] · required

total

integer · int32 · required

GET/core-api/accounts/stats

curl --request GET \
  --url https://api.heart.work/core-api/accounts/stats

shell

Example Responses

{
  "grandTotals": {
    "ordersTotal": 0,
    "ordersCount": 0,
    "dealsTotal": 0,
    "dealsCount": 0,
    "revenueTotal": 0,
    "revenueCount": 0
  },
  "data": [
    {
      "ordersTotal": 0,
      "ordersCount": 0,
      "dealsTotal": 0,
      "dealsCount": 0,
      "revenueTotal": 0,
      "revenueCount": 0,
      "id": "id",
      "displayName": "displayName",
      "ordersTotalPercentage": 0,
      "dealsTotalPercentage": 0,
      "revenueTotalPercentage": 0
    }
  ],
  "total": 0
}

plain

Fetches all used account unique tags

GET

https://api.heart.work

/core-api/masterdata/accounts/tags

Fetches all used account unique tags › Responses

string[]

GET/core-api/masterdata/accounts/tags

curl --request GET \
  --url https://api.heart.work/core-api/masterdata/accounts/tags

shell

Example Responses

[
  "string"
]

plain

Fetches all used account unique industries

GET

https://api.heart.work

/core-api/masterdata/accounts/industries

Fetches all used account unique industries › Responses

string[]

GET/core-api/masterdata/accounts/industries

curl --request GET \
  --url https://api.heart.work/core-api/masterdata/accounts/industries

shell

Example Responses

[
  "string"
]

plain

Activities