Get entity from Vats by key
GET/Vats(:id)
Get entity from Vats by key
Request
Path Parameters
id uuidrequired
Possible values: Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
key: id of Vat
Query Parameters
$select string[]
Possible values: [name
, pct
, includesVAT
, defaultVat
, id
, createdDate
, updatedDate
, organizationId
, reference
, creatorId
, customField1
, customField2
, customField3
, customField4
, customField5
, organization
]
Select properties to be returned
$expand string[]
Possible values: [*
, organization
]
Expand related entities
Responses
- 200
- default
Retrieved entity
- application/json
- Schema
- Example (from schema)
Schema
name string
pct decimal
includesVAT boolean
defaultVat boolean
id uuid
createdDate date-time
updatedDate date-time
organizationId uuid
reference string
creatorId uuid
customField1 string
customField2 string
customField3 string
customField4 string
customField5 string
organization
{
"name": "string",
"pct": 0,
"includesVAT": true,
"defaultVat": true,
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdDate": "2024-12-04T06:46:25.001Z",
"updatedDate": "2024-12-04T06:46:25.001Z",
"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference": "string",
"creatorId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customField1": "string",
"customField2": "string",
"customField3": "string",
"customField4": "string",
"customField5": "string",
"organization": {}
}
error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
error
object
required
code stringrequired
message stringrequired
target string
details
object[]
code stringrequired
message stringrequired
target string
innererror object
The structure of this object is service-specific
{
"error": {
"code": "string",
"message": "string",
"target": "string",
"details": [
{
"code": "string",
"message": "string",
"target": "string"
}
],
"innererror": {}
}
}
Loading...