Vatcodes

Retrieve Vatcodes from the Basecone office where you're user has rights to.

GET vatcodes?companyId=:companyId

Request properties

Property Type Description Optional
CompanyId Guid Company unique Identifier. No

Vatcodes collection properties

Property Type Description
VatCodeUniqueId Guid Unique identifier of Vatcode
Code String Code of Vat
Name String Name of Vatcodes
Percentages Percentage object Percentages of Vatcode.
ExternalId String External identifier from accounting system
Total Int Count of Vatcodes in a company

For details on Vatcodes properties see Vatcode details.

For details on collections see collection details.

Example response:

{
    "vatCodes": [
        {
            "vatCodeUniqueId": "730a5d63-c461-495f-beff-3aa4023a4fe9",
            "externalId": "ICC-purchase",
            "code": "ICC",
            "name": "ICC BAD_ICP",
            "percentages": [
                {
                    "id": "ff48ea6f-0e6a-4ff2-8adf-59722b1c1be8",
                    "percentage": 0.00000,
                    "startDate": null,
                    "externalId": "c186c9cf-3dcc-4cca-a66a-4168d4cf2bcc",
                    "name": null
                }
            ],
            "isIcp": false,
            "vatCodeType": "purchase",
            "isExclusive": true,
            "companyId": "72d7c981-19a3-449a-bd8a-ab1cbc6ace46",
            "_links": [
                {
                    "rel": "self",
                    "href": "http://localhost:54434/vatcodes/730a5d63-c461-495f-beff-3aa4023a4fe9"
                }
            ]
        },
        {
            "vatCodeUniqueId": "54874f1b-e8dc-49db-8d40-60687a0db271",
            "externalId": "ICC-sales",
            "code": "ICC",
            "name": "ICC BAD_ICP",
            "percentages": [
                {
                    "id": "9841de73-7729-460f-99fa-7611a7ce63e7",
                    "percentage": 0.00000,
                    "startDate": null,
                    "externalId": "c186c9cf-3dcc-4cca-a66a-4168d4cf2bcc",
                    "name": null
                }
            ],
            "isIcp": false,
            "vatCodeType": "sales",
            "isExclusive": true,
            "companyId": "72d7c981-19a3-449a-bd8a-ab1cbc6ace46",
            "_links": [
                {
                    "rel": "self",
                    "href": "http://localhost:54434/vatcodes/54874f1b-e8dc-49db-8d40-60687a0db271"
                }
            ]
        },
        {
            "vatCodeUniqueId": "4e73f2dc-b214-4595-bbd3-cfed1927701a",
            "externalId": "AK4-sales",
            "code": "AK4",
            "name": "AK4 AK4 Sales Adding",
            "percentages": [
                {
                    "id": "7967494f-f636-4c9d-8469-e1bdd314a98f",
                    "percentage": 0.12000,
                    "startDate": null,
                    "externalId": "d5211928-00c3-442f-b95c-1f124c7e3034",
                    "name": null
                },
                {
                    "id": "5482b6a2-527b-4cbd-81be-c28ea7f17827",
                    "percentage": 0.02000,
                    "startDate": "2022-12-12T00:00:00",
                    "externalId": "eeced581-bb1f-4353-91fa-728fad159f78",
                    "name": null
                }
            ],
            "isIcp": false,
            "vatCodeType": "sales",
            "isExclusive": false,
            "companyId": "72d7c981-19a3-449a-bd8a-ab1cbc6ace46",
            "_links": [
                {
                    "rel": "self",
                    "href": "http://localhost:54434/vatcodes/4e73f2dc-b214-4595-bbd3-cfed1927701a"
                }
            ]
        },
        {
            "vatCodeUniqueId": "b0aefa7c-59aa-4a15-a349-04fd7c720a77",
            "externalId": "99-purchase",
            "code": "99",
            "name": "99  JAY af te dragen 21%",
            "percentages": [
                {
                    "id": "a114fee1-0484-47c3-88dd-11bdfc2f229b",
                    "percentage": 0.21000,
                    "startDate": null,
                    "externalId": "3790011f-c46f-4cc4-bf01-784e52b918ae",
                    "name": null
                }
            ],
            "isIcp": false,
            "vatCodeType": "purchase",
            "isExclusive": false,
            "companyId": "72d7c981-19a3-449a-bd8a-ab1cbc6ace46",
            "_links": [
                {
                    "rel": "self",
                    "href": "http://localhost:54434/vatcodes/b0aefa7c-59aa-4a15-a349-04fd7c720a77"
                }
            ]
        },
        {
            "vatCodeUniqueId": "5101088f-6a61-4e72-8253-0a4dd3b323db",
            "externalId": "99-sales",
            "code": "99",
            "name": "99  JAY af te dragen 21%",
            "percentages": [
                {
                    "id": "42255add-bd7c-43e2-9868-1e8f09a7aa0a",
                    "percentage": 0.21000,
                    "startDate": null,
                    "externalId": "3790011f-c46f-4cc4-bf01-784e52b918ae",
                    "name": null
                }
            ],
            "isIcp": false,
            "vatCodeType": "sales",
            "isExclusive": false,
            "companyId": "72d7c981-19a3-449a-bd8a-ab1cbc6ace46",
            "_links": [
                {
                    "rel": "self",
                    "href": "http://localhost:54434/vatcodes/5101088f-6a61-4e72-8253-0a4dd3b323db"
                }
            ]
        }
    ],
    "_links": [
        {
            "rel": "self",
            "href": "http://localhost:54434/vatcodes?limit=5&offset=0"
        }
    ],
    "_metadata": {
        "total": 54,
        "count": 5
    }
}