Heartwork API

VatCodes

Endpointhttps://api.heart.work

Download schema

Fetches a collection of all vat codes

GET

https://api.heart.work

/core-api/catalog/vatcodes

Fetches a collection of all vat codes › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Name

Query

string

ids

string[]

external_references

string[]

Fetches a collection of all vat codes › Responses

object[] · required

total

integer · int32 · required

GET/core-api/catalog/vatcodes

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "code": "code",
      "percentage": 0
    }
  ],
  "total": 0
}

plain

Users Webhooks

Heartwork API

VatCodes

Endpointhttps://api.heart.work

Download schema

Fetches a collection of all vat codes

GET

https://api.heart.work

/core-api/catalog/vatcodes

Fetches a collection of all vat codes › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Name

Query

string

ids

string[]

external_references

string[]

Fetches a collection of all vat codes › Responses

object[] · required

total

integer · int32 · required

GET/core-api/catalog/vatcodes

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "name": "name",
      "code": "code",
      "percentage": 0
    }
  ],
  "total": 0
}

plain

Users Webhooks