Receipts

Receips are specifications of recieving goods.

Schema

Schema: Reciept

Property	Type	Description
id	ObjectId	Unique identifier
name	String	Optional name of reciept
estimated_arraival	Date	Optional estimated arrival of reciept
reference	String	Reference number identifying the reciept
client	ObjectId	Client identifier
articles	Array	Array of reciept_article schema
created	Date	Time when the reciept was created
updated	Date	Time when the reciept was last modified
recieved	Date	Time when the reciept was recieved
history	Array	Array of reciept_history
documents	Array	Array of URLs to documents
status	Integer	Enum {0: Draft, 1: Waiting, 2: Recieved, 3: Cancelled}
warehouse_site	Warehouse-site	Location to recieve reciept

Schema: Reciept_article

Property	Type	Description
article	Article	Article to be recieved
quantity.ordered	Integer	Amount of the article to be recieved
quantity.recieved	Integer	Amount of the article recieved

Schema: Reciept_history

Property	Type	Description
created	Date	Time when the history record was created
body	String	Log text
type	Integer	Enum {0: Information, 1: Warning, 2: Action}

Get a list of reciepts

If you want to retrieve a list of reciepts, use this GET request:

GET https://api.tirix.io/reciepts

Get a reciept

If you want to fetch an individual reciept, use this GET request:

GET https://api.tirix.io/reciepts/{reciept_id}

Create a new reciept

If you want to create a new reciept, use this POST request:

POST https://api.tirix.io/reciepts

Modify a reciept

If you want to modify a specific reciept, use this PUT request:

PUT https://api.tirix.io/reciepts/{reciept_id}

Delete a reciept

Reciepts are persistent and can not be irreversibly deleted.

TIP

You can suspend the reciept by setting its 'status' property to 3 (cancelled).