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

GET 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

200: OK All the documents matching your search

{
    // Response

}

Get a document

GET 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

200: OK The specified document

{
    // Response
}

Delete documents

DELETE 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

200: OK The number of documents deleted

{
    // Response
}

Edit a document

POST 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

200: OK The edited document

{
    // Response
}

Create a document

POST 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

200: OK The created document

{
    // Response
}