# Introduction

## Issue model

### Example

```json
{
  "id": 1,
  "state": "to_do",
  "type": "type",
  "type_description": "Long description",
  "description": "Issue description",
  "location": "where?",
  "customer_id": 12,
  "store_id": 1000,
  "created_at": "2020-11-30T17:12:46.435Z",
  "updated_at": "2020-11-30T17:12:46.435Z?",
  "attachments": [] // list of attachments - See Issue attachment
}
```

## Definition

Key | Type | Optional | Description
--------- | --------- | --------- | ---------
id | integer | no |
state | string | no | issue state
type | string | no | issue type key
type_description | string | no | issue type name
description | string | no | issue description
location | string | yes | location
customer_id | integer | no |
store_id | integer | no |
created_at | datetime | no | Time of creation
updated_at | datetime | no | Time of creation
attachments | array | yes | List of attachments

## Issue Type model

### Example

```json
{
  "id": 1,
  "type": "issue_type",
  "description": "Issue type description"
}
```

### Definition

Key | Type | Optional | Description
--------- | --------- | --------- | ---------
id | integer | no |
type | string | no | issue type key
description | string | no | issue type name

## Issue attachment model

### Example

```json
{
  "url": "http://image.com/image.jpg",
  "sub_identifier": "file1"
}
```

### Description

Key | Type | Optional | Description
--------- | --------- | --------- | ---------
url | string | no |
sub_identifier | string | yes |