docs.yaml

{"swagger":"2.0","info":{"contact":{},"title":"Collect API","version":"1.0.0"},"host":"localhost","basePath":"/","schemes":["http"],"paths":{"/api/v1/customers":{"post":{"consumes":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"properties":{"address":{"example":"42404 Tyrell Rest","type":"string"},"city":{"example":"Bethanyhaven","type":"string"},"country":{"example":"Eritrea","type":"string"},"email":{"example":"testMail@abv.bg","type":"string"},"name":{"example":"FS Comapny","type":"string"},"phone":{"example":"359885749321","type":"string"},"postCode":{"example":"91037-0096","type":"string"},"type":{"example":"company","type":"string"},"vat":{"example":999767,"type":"number"}},"type":"object"}}],"responses":{"200":{"description":""}},"tags":["Customer"],"description":"Create Customer","operationId":"createCustomer","summary":"Create Customer"}},"/api/v1/customers/40":{"delete":{"parameters":[],"responses":{"200":{"description":""}},"tags":["Customer"],"description":"Delete Customer","operationId":"deleteCustomer","summary":"Delete Customer"}},"/api/v1/customers/999":{"get":{"parameters":[],"responses":{"200":{"description":""}},"tags":["Customer"],"description":"Retrieve Customers","operationId":"retrieveCustomers","summary":"Retrieve Customers"},"put":{"consumes":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"properties":{"email":{"example":"as@test.com","type":"string"},"type":{"example":"company","type":"string"},"vat":{"example":"555","type":"string"}},"type":"object"}}],"responses":{"200":{"description":""}},"tags":["Customer"],"description":"Update Customer","operationId":"updateCustomer","summary":"Update Customer"}},"/api/v1/invoices/":{"post":{"consumes":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"properties":{"billedDate":{"example":"2016-12-07 13:38:30","type":"string"},"customerId":{"example":26,"type":"number"},"paidDate":{"example":"2016-08-24 19:21:40","type":"string"},"products":{"example":[{"price":99390,"productId":101,"quantity":3,"taxRate":"0.00"},{"price":116756,"productId":102,"quantity":18,"taxRate":"0.00"}],"items":{"properties":{"price":{"example":99390,"type":"number"},"productId":{"example":101,"type":"number"},"quantity":{"example":3,"type":"number"},"taxRate":{"example":"0.00","type":"string"}},"type":"object"},"type":"array"},"status":{"example":"paid","type":"string"},"total":{"example":50000,"type":"number"}},"type":"object"}}],"responses":{"200":{"description":""}},"tags":["Invoice"],"description":"Create Invoice","operationId":"createInvoice","summary":"Create Invoice"}},"/api/v1/invoices/252":{"delete":{"parameters":[],"responses":{"200":{"description":""}},"tags":["Invoice"],"description":"Delete Invoice","operationId":"deleteInvoice","summary":"Delete Invoice"}},"/api/v1/invoices/51":{"get":{"parameters":[{"in":"query","name":"includeProducts","type":"string"}],"responses":{"200":{"description":""}},"tags":["Invoice"],"description":"Retrieve Invoices","operationId":"retrieveInvoices","summary":"Retrieve Invoices"}},"/api/v1/invoices/81":{"put":{"consumes":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"properties":{"billedDate":{"example":"2014-09-28 20:09:20","type":"string"},"status":{"example":"billed","type":"string"},"total":{"example":2005,"type":"number"}},"type":"object"}}],"responses":{"200":{"description":""}},"tags":["Invoice"],"description":"Update Invoice","operationId":"updateInvoice","summary":"Update Invoice"}},"/api/v1/items":{"post":{"consumes":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"properties":{"invoiceId":{"example":251,"type":"number"},"price":{"example":101782,"type":"number"},"productId":{"example":101,"type":"number"},"quantity":{"example":6,"type":"number"},"taxRate":{"example":"20.00","type":"string"}},"type":"object"}}],"responses":{"200":{"description":""}},"tags":["Invoice Products"],"description":"Create Invoice Product","operationId":"createInvoiceProduct","summary":"Create Invoice Product"}},"/api/v1/items/10":{"delete":{"parameters":[],"responses":{"200":{"description":""}},"tags":["Invoice Products"],"description":"Delete Invoice Product","operationId":"deleteInvoiceProduct","summary":"Delete Invoice Product"}},"/api/v1/items/11":{"get":{"parameters":[],"responses":{"200":{"description":""}},"tags":["Invoice Products"],"description":"Retrieve Invoice Products","operationId":"retrieveInvoiceProducts","summary":"Retrieve Invoice Products"},"put":{"consumes":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"properties":{"invoiceId":{"example":251,"type":"number"},"price":{"example":101782,"type":"number"},"quantity":{"example":6,"type":"number"},"taxRate":{"example":"25.00","type":"string"}},"type":"object"}}],"responses":{"200":{"description":""}},"tags":["Invoice Products"],"description":"Update Invoice Product","operationId":"updateInvoiceProduct","summary":"Update Invoice Product"}},"/api/v1/login":{"post":{"parameters":[{"in":"query","name":"email","type":"string"},{"in":"query","name":"password","type":"string"}],"responses":{"200":{"description":""}},"tags":["Token"],"description":"Generate Token","operationId":"generateToken","summary":"Generate Token"}},"/api/v1/payment_methods/":{"post":{"consumes":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"properties":{"description":{"example":"lqlqlqlq","type":"string"},"name":{"example":"Test Method","type":"string"}},"type":"object"}}],"responses":{"200":{"description":""}},"tags":["Payment Methods"],"description":"Create Payment Method","operationId":"createPaymentMethod","summary":"Create Payment Method"}},"/api/v1/payment_methods/1":{"get":{"parameters":[],"responses":{"200":{"description":""}},"tags":["Payment Methods"],"description":"Retrieve Payment Methods","operationId":"retrievePaymentMethods","summary":"Retrieve Payment Methods"}},"/api/v1/payment_methods/11":{"put":{"consumes":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"properties":{"name":{"example":2,"type":"number"}},"type":"object"}}],"responses":{"200":{"description":""}},"tags":["Payment Methods"],"description":"Update Payment Method","operationId":"updatePaymentMethod","summary":"Update Payment Method"}},"/api/v1/payment_methods/12":{"delete":{"parameters":[],"responses":{"200":{"description":""}},"tags":["Payment Methods"],"description":"Delete Payment Method","operationId":"deletePaymentMethod","summary":"Delete Payment Method"}},"/api/v1/payments/":{"post":{"consumes":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"properties":{"amount":{"example":1818,"type":"number"},"invoiceId":{"example":80,"type":"number"},"paymentDate":{"example":"2019-05-02 05:15:16","type":"string"},"paymentMethod":{"example":22,"type":"number"},"refId":{"example":"7ecfddf3-de37-3642-affd-d383cc1debcf","type":"string"}},"type":"object"}}],"responses":{"200":{"description":""}},"tags":["Payments"],"description":"Create Payment","operationId":"createPayment","summary":"Create Payment"}},"/api/v1/payments/10":{"put":{"consumes":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"properties":{"amount":{"example":1818,"type":"number"},"invoiceId":{"example":80,"type":"number"},"paymentDate":{"example":"2019-05-02 05:15:16","type":"string"},"paymentMethod":{"example":22,"type":"number"},"refId":{"example":"7ecfddf3-de37-3642-affd-d383cc1debcg","type":"string"}},"type":"object"}}],"responses":{"200":{"description":""}},"tags":["Payments"],"description":"Update Payment","operationId":"updatePayment","summary":"Update Payment"}},"/api/v1/payments/11":{"delete":{"parameters":[],"responses":{"200":{"description":""}},"tags":["Payments"],"description":"Delete Payment","operationId":"deletePayment","summary":"Delete Payment"},"get":{"parameters":[],"responses":{"200":{"description":""}},"tags":["Payments"],"description":"Retrieve Payments","operationId":"retrievePayments","summary":"Retrieve Payments"}},"/api/v1/products":{"post":{"consumes":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"properties":{"description":{"example":"test desc.","type":"string"},"name":{"example":"prod 1","type":"string"},"price":{"example":500,"type":"number"},"taxRate":{"example":"100.00","type":"string"}},"type":"object"}}],"responses":{"200":{"description":""}},"tags":["Product"],"description":"Create Product","operationId":"createProduct","summary":"Create Product"}},"/api/v1/products/104":{"delete":{"parameters":[],"responses":{"200":{"description":""}},"tags":["Product"],"description":"Delete Product","operationId":"deleteProduct","summary":"Delete Product"}},"/api/v1/products/110":{"put":{"consumes":["application/json"],"parameters":[{"in":"body","name":"body","schema":{"properties":{"description":{"example":"ww","type":"string"},"name":{"example":"prod 1","type":"string"},"price":{"example":500,"type":"number"}},"type":"object"}}],"responses":{"200":{"description":""}},"tags":["Product"],"description":"Update Product","operationId":"updateProduct","summary":"Update Product"}},"/api/v1/products/555":{"get":{"parameters":[],"responses":{"200":{"description":""}},"tags":["Product"],"description":"Retrieve Products","operationId":"retrieveProducts","summary":"Retrieve Products"}},"/api/v1/register":{"post":{"parameters":[{"in":"query","name":"email","type":"string"},{"in":"query","name":"password","type":"string"},{"in":"query","name":"name","type":"string"}],"responses":{"200":{"description":""}},"tags":["Token"],"description":"Register User","operationId":"registerUser","summary":"Register User"}}},"tags":[{"name":"Token"},{"name":"Customer"},{"name":"Invoice"},{"name":"Product"},{"name":"Invoice Products"},{"name":"Payment Methods"},{"name":"Payments"}]}