# Documents

Documents are all the invoices, quotes, contracts, and other files you have stored in your Lancerkit account. Use the documents API to list, create or update contacts within your Lancerkit account. 

## API endpoints

## List documents

<mark style="color:blue;">`GET`</mark> `https://api.lancerkit.com/documents`

List all the documents on your account

#### Query Parameters

| Name   | Type   | Description                          |
| ------ | ------ | ------------------------------------ |
| search | String | A query to filter the documents list |
| page   | Number |                                      |

{% tabs %}
{% tab title="200: OK All the documents matching your search " %}

```javascript
{
    // Response

}
```

{% endtab %}
{% endtabs %}

## Get a document

<mark style="color:blue;">`GET`</mark> `https://api.lancerkit.com/documents/:id`

Get a specific document from your account

#### Path Parameters

| Name | Type   | Description            |
| ---- | ------ | ---------------------- |
| id   | String | The id of the document |

{% tabs %}
{% tab title="200: OK The specified document" %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## Delete documents

<mark style="color:red;">`DELETE`</mark> `https://api.lancerkit.com/documents`

Delete some documents from your account

#### Request Body

| Name | Type   | Description                        |
| ---- | ------ | ---------------------------------- |
| ids  | String | The ids of the documents to delete |

{% tabs %}
{% tab title="200: OK The number of documents deleted" %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## Edit a document

<mark style="color:green;">`POST`</mark> `https://api.lancerkit.com/documents/:id`

Edit an existing document

#### Path Parameters

| Name | Type   | Description            |
| ---- | ------ | ---------------------- |
| id   | String | The id of the document |

#### Request Body

| Name      | Type   | Description                      |
| --------- | ------ | -------------------------------- |
| type      | String | Invoice / Quote / Charge / Other |
| reference | String |                                  |
| date      | String |                                  |
| currency  | String |                                  |
| amount    | String |                                  |
| contact   | String | The ID of the contact            |

{% tabs %}
{% tab title="200: OK The edited document" %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## Create a document

<mark style="color:green;">`POST`</mark> `https://api.lancerkit.com/documents/new`

Create a new document

#### Path Parameters

| Name | Type   | Description            |
| ---- | ------ | ---------------------- |
| id   | String | The id of the document |

#### Request Body

| Name      | Type   | Description                      |
| --------- | ------ | -------------------------------- |
| type      | String | Invoice / Quote / Charge / Other |
| reference | String |                                  |
| date      | String |                                  |
| currency  | String |                                  |
| amount    | String |                                  |
| contact   | String | The ID of the contact            |

{% tabs %}
{% tab title="200: OK The created document" %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}