{"info":{"_postman_id":"a89604c2-e952-4d50-8d7b-941054bef535","name":"Qoyod API","description":"

Overview

\n

Qoyod's API consists of 19 resource types, expect responses to be in json.

\n

Resources in the current version are:

\n
    \n

  1. Accounts

    \n
    2. \n

  2. Products

    \n
    3. \n

  3. Inventories

    \n
    4. \n

  4. Product Categories

    \n
    5. \n

  5. Product Units

    \n
    6. \n

  6. Vendors

    \n
    7. \n

  7. Purchase Orders

    \n
    8. \n

  8. Bills

    \n
    9. \n

  9. Bill Payments

    \n
    10. \n

  10. Simple Bills

    \n
    11. \n

  11. Simple Bill Payments

    \n
    12. \n

  12. Debit Notes

    \n
    13. \n

  13. Customers

    \n
    14. \n

  14. Quotes

    \n
    15. \n

  15. Invoices

    \n
    16. \n

  16. Invoice Payments

    \n
    17. \n

  17. Credit Notes

    \n
    18. \n

  18. Receipts

    \n
    19. \n

  19. Journal Entries

    \n
    20. \n
\n

Authentication

\n

All requests in this api require an API-KEY header, this can be generated from your General Settings page. Once you generate your API key, save your settings and try out our API.

\n

Error Codes

\n

Expect typical HTTP response codes, 200, 201, 400, 404, 500, ...

\n

Searching and Sorting

\n

All index endpoints use ransack for searching and sorting by any parameter.
Default sorting is by \"id asc\".

\n

The below example searches for products with sku containing \"acc\", sorted by buying_price desc:

\n

https://api.qoyod.com/2.0/products?q[sku_cont]=acc&q[s]=buying_price+desc

\n

A complete list of search terms can be found here

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Searching and Sorting","slug":"searching-and-sorting"}],"owner":"3850881","collectionId":"a89604c2-e952-4d50-8d7b-941054bef535","publishedId":"RzZ6HLRA","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"14293C","highlight":"1B97DF"},"publishDate":"2018-12-30T01:06:09.000Z"},"item":[{"name":"API V2","item":[{"name":"Accounts","item":[{"name":"All accounts","id":"b2d9634f-59f1-4cec-9ad3-926ee6a87ea2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/accounts","urlObject":{"path":["2.0","accounts"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"d88c3d57-c8e7-4adc-8aee-0d410f11cbc5","name":"All accounts","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 14:59:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"e7d3b50da85b78df77ef41258303e624\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"dca4c72f-0579-451d-ab28-051e49818da4"},{"key":"X-Runtime","value":"0.489363"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"accounts\": [\n {\n \"id\": 1,\n \"code\": \"120101\",\n \"name_en\": \"Lands\",\n \"name_ar\": \"الأراضي\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Property, plant, and equipment\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 2,\n \"code\": \"120102\",\n \"name_en\": \"Buildings\",\n \"name_ar\": \"المباني\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Property, plant, and equipment\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 3,\n \"code\": \"120103\",\n \"name_en\": \"Equipment\",\n \"name_ar\": \"المعدات\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Property, plant, and equipment\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 6,\n \"code\": \"120104\",\n \"name_en\": \"Computers & printers\",\n \"name_ar\": \"أجهزة مكتبية وطابعات\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Property, plant, and equipment\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 7,\n \"code\": \"110101\",\n \"name_en\": \"Cash on hand\",\n \"name_ar\": \"النقدية في الخزينة\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Non-bank Cash and equivalents\",\n \"receive_payments\": true,\n \"status\": \"Active\"\n },\n {\n \"id\": 8,\n \"code\": \"110201\",\n \"name_en\": \"Bank Current Account - Bank Name\",\n \"name_ar\": \"حساب البنك الجاري - اسم البنك\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Bank Account\",\n \"receive_payments\": true,\n \"status\": \"Active\"\n },\n {\n \"id\": 9,\n \"code\": \"1103\",\n \"name_en\": \"Accounts receivable\",\n \"name_ar\": \"المدينون\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Accounts receivable\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 10,\n \"code\": \"1106\",\n \"name_en\": \"Inventory\",\n \"name_ar\": \"المخزون\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Inventory\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 11,\n \"code\": \"5204\",\n \"name_en\": \"Rental expenses\",\n \"name_ar\": \"مصاريف الإيجار\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"General and Administrative\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 12,\n \"code\": \"5101\",\n \"name_en\": \"Cost of goods sold\",\n \"name_ar\": \"تكلفة البضاعة المباعة\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"Cost of sales\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 13,\n \"code\": \"5201\",\n \"name_en\": \"Salaries and administrative fees\",\n \"name_ar\": \"الرواتب والرسوم الإدارية\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"Salaries\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 14,\n \"code\": \"2101\",\n \"name_en\": \"Accounts payable\",\n \"name_ar\": \"الدائنون\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Liability\",\n \"balance\": \"0.0\",\n \"type\": \"Liability\",\n \"group_type\": \"Accounts payable\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 15,\n \"code\": \"3101\",\n \"name_en\": \"Registered capital\",\n \"name_ar\": \"رأس المال المسجل\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Equity\",\n \"balance\": \"0.0\",\n \"type\": \"Equity\",\n \"group_type\": \"Registered capital\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 16,\n \"code\": \"3402\",\n \"name_en\": \"Retained earnings or losses\",\n \"name_ar\": \"الأرباح المبقاة (أو الخسائر)\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Equity\",\n \"balance\": \"0.0\",\n \"type\": \"Equity\",\n \"group_type\": \"Retained earnings\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 17,\n \"code\": \"4101\",\n \"name_en\": \"Revenue of Products and services Sales\",\n \"name_ar\": \"إيرادات المبيعات/ الخدمات\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Revenue\",\n \"balance\": \"0.0\",\n \"type\": \"Revenue\",\n \"group_type\": \"Sales\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 18,\n \"code\": \"4201\",\n \"name_en\": \"Other income\",\n \"name_ar\": \"إيرادات أخرى\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Revenue\",\n \"balance\": \"0.0\",\n \"type\": \"Revenue\",\n \"group_type\": \"Other Revenue\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 19,\n \"code\": \"2105\",\n \"name_en\": \"VAT payable\",\n \"name_ar\": \"ضريبة القيمة المضافة المستحقة\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Liability\",\n \"balance\": \"0.0\",\n \"type\": \"Liability\",\n \"group_type\": \"Taxes Payable\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 22,\n \"code\": \"1202\",\n \"name_en\": \"Intangible assets\",\n \"name_ar\": \"الأصول غير الملموسة\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Intangible assets\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 23,\n \"code\": \"1203\",\n \"name_en\": \"Investment property\",\n \"name_ar\": \"العقارات الاستثمارية\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Other Fixed Assets\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 26,\n \"code\": \"2102\",\n \"name_en\": \"Accrued expenses\",\n \"name_ar\": \"مصروفات مستحقة\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Liability\",\n \"balance\": \"0.0\",\n \"type\": \"Liability\",\n \"group_type\": \"Accrued expenses\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 27,\n \"code\": \"2103\",\n \"name_en\": \"Accrued salaries\",\n \"name_ar\": \"الرواتب المستحقة\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Liability\",\n \"balance\": \"0.0\",\n \"type\": \"Liability\",\n \"group_type\": \"Accrued salaries and amounts owed to employees\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 28,\n \"code\": \"2104\",\n \"name_en\": \"Short-term loans\",\n \"name_ar\": \"قروض قصيرة الأجل\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Liability\",\n \"balance\": \"0.0\",\n \"type\": \"Liability\",\n \"group_type\": \"Short-term Borrowings\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 30,\n \"code\": \"2106\",\n \"name_en\": \"Accrued Taxes\",\n \"name_ar\": \"الضرائب المستحقة\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Liability\",\n \"balance\": \"0.0\",\n \"type\": \"Liability\",\n \"group_type\": \"Taxes Payable\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 31,\n \"code\": \"2107\",\n \"name_en\": \"Unearned revenues\",\n \"name_ar\": \"إيرادات غير مكتسبة\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Liability\",\n \"balance\": \"0.0\",\n \"type\": \"Liability\",\n \"group_type\": \"Unearned revenues\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 32,\n \"code\": \"2108\",\n \"name_en\": \"General Organization for Social insurance payable\",\n \"name_ar\": \"مستحقات المؤسسة العامة للتأمينات الاجتماعية\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Liability\",\n \"balance\": \"0.0\",\n \"type\": \"Liability\",\n \"group_type\": \"Other Current Liability\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 34,\n \"code\": \"210901\",\n \"name_en\": \"Buildings accumulated depreciation\",\n \"name_ar\": \"مجمع استهلاك المباني\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Liability\",\n \"balance\": \"0.0\",\n \"type\": \"Liability\",\n \"group_type\": \"Accumulated Depreciation\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 35,\n \"code\": \"210902\",\n \"name_en\": \"Equipment accumulated depreciation\",\n \"name_ar\": \"مجمع استهلاك المعدات\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Liability\",\n \"balance\": \"0.0\",\n \"type\": \"Liability\",\n \"group_type\": \"Accumulated Depreciation\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 36,\n \"code\": \"210903\",\n \"name_en\": \"Computers & printers accumulated depreciation\",\n \"name_ar\": \"مجمع استهلاك أجهزة مكتبية وطابعات\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Liability\",\n \"balance\": \"0.0\",\n \"type\": \"Liability\",\n \"group_type\": \"Accumulated Depreciation\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 38,\n \"code\": \"2201\",\n \"name_en\": \"Long-term loans\",\n \"name_ar\": \"قروض طويلة أجل\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Liability\",\n \"balance\": \"0.0\",\n \"type\": \"Liability\",\n \"group_type\": \"Long-term Borrowings\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 41,\n \"code\": \"110102\",\n \"name_en\": \"Petty cash\",\n \"name_ar\": \"العهد النقدية\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Petty cash\",\n \"receive_payments\": true,\n \"status\": \"Active\"\n },\n {\n \"id\": 42,\n \"code\": \"3102\",\n \"name_en\": \"Additional paid in capital\",\n \"name_ar\": \"رأس المال الإضافي المدفوع\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Equity\",\n \"balance\": \"0.0\",\n \"type\": \"Equity\",\n \"group_type\": \"Additional paid-in capital\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 44,\n \"code\": \"3201\",\n \"name_en\": \"Opening balance\",\n \"name_ar\": \"أرصدة افتتاحية\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Equity\",\n \"balance\": \"0.0\",\n \"type\": \"Equity\",\n \"group_type\": \"Other Equity\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 45,\n \"code\": \"3301\",\n \"name_en\": \"Statutory reserve\",\n \"name_ar\": \"احتياطي نظامي\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Equity\",\n \"balance\": \"0.0\",\n \"type\": \"Equity\",\n \"group_type\": \"Reserves\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 46,\n \"code\": \"3302\",\n \"name_en\": \"Foreign currency translation reserve\",\n \"name_ar\": \"احتياطي ترجمة عملات أجنبية\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Equity\",\n \"balance\": \"0.0\",\n \"type\": \"Equity\",\n \"group_type\": \"Reserves\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 49,\n \"code\": \"3401\",\n \"name_en\": \"Profit and loss\",\n \"name_ar\": \"الأرباح والخسائر العاملة\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Equity\",\n \"balance\": \"0.0\",\n \"type\": \"Equity\",\n \"group_type\": \"Retained earnings\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 54,\n \"code\": \"110401\",\n \"name_en\": \"Prepaid medical insurance\",\n \"name_ar\": \"تأمين طبي مقدم\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Prepaid expenses and others\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 57,\n \"code\": \"110402\",\n \"name_en\": \"Prepaid rent\",\n \"name_ar\": \"إيجار مقدم\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Prepaid expenses and others\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 58,\n \"code\": \"5102\",\n \"name_en\": \"Salaries and wages\",\n \"name_ar\": \"رواتب وأجور\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"Other Direct Cost\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 59,\n \"code\": \"5103\",\n \"name_en\": \"Sales commissions\",\n \"name_ar\": \"عمولات البيع\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"Other Direct Cost\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 61,\n \"code\": \"1105\",\n \"name_en\": \"Staff advances\",\n \"name_ar\": \"مدفوعات مقدمة للموظفين\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Employees advances\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 62,\n \"code\": \"5202\",\n \"name_en\": \"Medical insurance and treatment\",\n \"name_ar\": \"تأمين طبي\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"General and Administrative\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 63,\n \"code\": \"5203\",\n \"name_en\": \"Marketing and advertising\",\n \"name_ar\": \"مصاريف تسويقية ودعائية\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"Marketing\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 65,\n \"code\": \"5205\",\n \"name_en\": \"Commissions and incentives\",\n \"name_ar\": \"عمولات وحوافز\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"Employee incentives and benefits\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 66,\n \"code\": \"5206\",\n \"name_en\": \"Travel Expenses\",\n \"name_ar\": \"تذاكر سفر\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"General and Administrative\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 67,\n \"code\": \"5207\",\n \"name_en\": \"Social insurance expense\",\n \"name_ar\": \"التأمينات الاجتماعية\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"General and Administrative\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 68,\n \"code\": \"5208\",\n \"name_en\": \"Government fees\",\n \"name_ar\": \"الرسوم الحكومية\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"General and Administrative\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 69,\n \"code\": \"5209\",\n \"name_en\": \"Fees and subscriptions\",\n \"name_ar\": \"رسوم واشتراكات\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"General and Administrative\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 70,\n \"code\": \"5210\",\n \"name_en\": \"Utilities expenses\",\n \"name_ar\": \"مصاريف خدمات المكتب\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"General and Administrative\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 71,\n \"code\": \"5211\",\n \"name_en\": \"Stationery and prints\",\n \"name_ar\": \"مصاريف مكتبية ومطبوعات\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"General and Administrative\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 72,\n \"code\": \"5212\",\n \"name_en\": \"Hospitality and cleanliness\",\n \"name_ar\": \"مصاريف ضيافة\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"General and Administrative\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 73,\n \"code\": \"5213\",\n \"name_en\": \"Interest and bank commissions\",\n \"name_ar\": \"فوائد وعمولات بنكية\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"General and Administrative\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 74,\n \"code\": \"5214\",\n \"name_en\": \"Other expenses\",\n \"name_ar\": \"مصاريف أخرى\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"General and Administrative\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 76,\n \"code\": \"521501\",\n \"name_en\": \"Buildings depreciation expense\",\n \"name_ar\": \"مصروف إهلاك المباني\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"Depreciation\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 77,\n \"code\": \"521502\",\n \"name_en\": \"Equipment depreciation expense\",\n \"name_ar\": \"مصروف إهلاك المعدات\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"Depreciation\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 78,\n \"code\": \"521503\",\n \"name_en\": \"Computers & printers depreciation expense\",\n \"name_ar\": \"مصروف إهلاك أجهزة مكتبية وطابعات\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"Depreciation\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 79,\n \"code\": \"5216\",\n \"name_en\": \"Zakat\",\n \"name_ar\": \"الزكاة\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"General and Administrative\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 80,\n \"code\": \"5217\",\n \"name_en\": \"TAX\",\n \"name_ar\": \"الضرائب\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"Taxes\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 81,\n \"code\": \"5218\",\n \"name_en\": \"Change in currency value gains or losses\",\n \"name_ar\": \"ترجمة عملات أجنبية\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"Other Operational Cost\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 82,\n \"code\": \"5219\",\n \"name_en\": \"Transportation expense\",\n \"name_ar\": \"مصروف نقل ومواصلات\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"General and Administrative\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 84,\n \"code\": \"5104\",\n \"name_en\": \"Shipping and custom fees\",\n \"name_ar\": \"شحن وتخليص جمركي\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"0.0\",\n \"type\": \"Expense\",\n \"group_type\": \"Other Direct Cost\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n },\n {\n \"id\": 85,\n \"code\": \"2110\",\n \"name_en\": \"End of Services Provision\",\n \"name_ar\": \"مخصص مكافأة نهاية الخدمة\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Liability\",\n \"balance\": \"0.0\",\n \"type\": \"Liability\",\n \"group_type\": \"End of service benefits\",\n \"receive_payments\": false,\n \"status\": \"Active\"\n }\n ]\n}"}],"_postman_id":"b2d9634f-59f1-4cec-9ad3-926ee6a87ea2"},{"name":"Get an account","event":[{"listen":"test","script":{"id":"dd084c53-4706-469c-a243-d5175d57c40f","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"ad16616f-3b6f-4a22-a8b8-6bea5552e14a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/accounts/7","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","accounts","7"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"a8a2a723-6e1c-41b5-b538-7d6582a2fa95","name":"Get an account","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/accounts/7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 14:59:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"5efedca5d84ef1ca174d0663c7473b91\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"20c341fb-7fa5-4270-b46d-180b534634ae"},{"key":"X-Runtime","value":"0.021223"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"account\": {\n \"id\": 7,\n \"code\": \"110101\",\n \"name_en\": \"Cash on hand\",\n \"name_ar\": \"النقدية في الخزينة\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Non-bank Cash and equivalents\",\n \"receive_payments\": true,\n \"status\": \"Active\"\n }\n}"}],"_postman_id":"ad16616f-3b6f-4a22-a8b8-6bea5552e14a"},{"name":"Create an account","id":"f8bb19d5-df27-448a-bc9f-dd73eed5a157","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"account\": {\r\n\t\t\"name_en\": \"Albilad Bank Account\",\r\n\t\t\"name_ar\": \"حساب بنك البلاد\",\r\n\t\t\"code\": \"412\",\r\n\t\t\"description\": \"Account description\",\r\n\t\t\"recieve_payments\": \"true\",\r\n\t\t\"type\": \"Bank\"\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/accounts","description":"

Parameters

\n
    \n

  1. name_en(required, unique): account english name.

    \n
    2. \n

  2. name_ar(required, unique): account arabic name.

    \n
    3. \n

  3. code(required, unique)

    \n
    4. \n

  4. description(optional)

    \n
    5. \n

  5. receive_payments(required): \"true\" or \"false\", allows or disallows creating receipts with this account

    \n
    6. \n

  6. type(required): must be one of the types listed below

    \n
    7. \n
\n

Account Types are as follows:

\n\n","urlObject":{"path":["2.0","accounts"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"9ca60cf2-b4be-49ab-bda7-a9e1f678e270","name":"Create an account","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"account\": {\r\n\t\t\"name_en\": \"Albilad Bank Account\",\r\n\t\t\"name_ar\": \"حساب بنك البلاد\",\r\n\t\t\"code\": \"412\",\r\n\t\t\"description\": \"Account description\",\r\n\t\t\"recieve_payments\": \"true\",\r\n\t\t\"type\": \"Bank\"\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:00:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"5ed11d1df8a6c472552afa044ee827a9\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"d9e84c91-353e-454b-b68e-de508932a9c7"},{"key":"X-Runtime","value":"0.212121"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"account\": {\n \"id\": 86,\n \"code\": \"412\",\n \"name_en\": \"Albilad Bank Account\",\n \"name_ar\": \"حساب بنك البلاد\",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Asset\",\n \"balance\": \"0.0\",\n \"type\": \"Asset\",\n \"group_type\": \"Bank Account\",\n \"receive_payments\": true,\n \"status\": \"Active\"\n }\n}"}],"_postman_id":"f8bb19d5-df27-448a-bc9f-dd73eed5a157"}],"id":"69d3b1cb-6e16-4396-9d8d-2a78503649a3","event":[{"listen":"prerequest","script":{"id":"56168c49-7dfc-433d-96a4-f15e049134de","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dbb04914-fcee-4988-88be-8d5f5589e91a","type":"text/javascript","exec":[""]}}],"_postman_id":"69d3b1cb-6e16-4396-9d8d-2a78503649a3","description":""},{"name":"Products & Inventories","item":[{"name":"Inventories","item":[{"name":"Inventory Management","item":[{"name":"Create inventory adjustment","id":"44f03918-dc76-426e-9d1c-ab73d823bc66","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"inventory_adjustment\": {\r\n\t\t\"inventory_id\": \"1\", \r\n\t\t\"revenue_account_id\": \"17\",\r\n\t\t\"expense_account_id\": \"12\", \r\n\t\t\"date\": \"2019-10-30\", \r\n\t\t\"description\": \"We only have 5 pieces\",\r\n\t\t\"line_items\": [{\r\n\t\t\t\"product_id\": \"4\",\r\n\t\t\t\"actual_quantity\": \"5\",\r\n\t\t\t\"rate\": \"10\"\r\n\t\t}]\r\n\t} \r\n}"},"url":"https://www.qoyod.com/2.0/inventory_adjustments","description":"

Parameters

\n
    \n
  1. inventory_id(required): id of the inventory you want to adjust
    2. \n
  2. revenue_account_id(required): account where revenue will be registered if the quantity will be increased (must be of type Revenue)
    3. \n
  3. expense_account_id(required): account where revenue will be registered if the quantity will be decreased (must be of type Expense)
    4. \n
  4. date(required)
    5. \n
  5. description(required)
    6. \n
  6. line_items(required)
      \n
    1. product_id(required)
      2. \n
    2. actual_quantity(required): The quantity that you now actually have in stock, NOT the difference between actual quantity and registered quantity.
      3. \n
    3. rate(required): the inventory value of one piece.
      4. \n
    \n
    7. \n
\n","urlObject":{"path":["2.0","inventory_adjustments"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"f2c96965-1794-4d86-8698-72f70e474443","name":"Create Inventory Adjustment","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"inventory_adjustment\": {\r\n\t\t\"inventory_id\": \"1\", \r\n\t\t\"revenue_account_id\": \"17\",\r\n\t\t\"expense_account_id\": \"12\", \r\n\t\t\"date\": \"2019-10-30\", \r\n\t\t\"description\": \"We only have 5 pieces\",\r\n\t\t\"line_items\": [{\r\n\t\t\t\"product_id\": \"4\",\r\n\t\t\t\"actual_quantity\": \"5\",\r\n\t\t\t\"rate\": \"10\"\r\n\t\t}]\r\n\t} \r\n}"},"url":"https://www.qoyod.com/2.0/inventory_adjustments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 Feb 2020 15:11:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"dec09ed85a0afdd8b951f110d6defd12\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"a59b59df-5016-4e7f-85f4-9084be612ac7"},{"key":"X-Runtime","value":"0.379964"}],"cookie":[],"responseTime":null,"body":"{\n \"inventory_adjustment\": {\n \"id\": 1,\n \"date\": \"2019-10-30\",\n \"description\": \"We only have 5 pieces\",\n \"line_items\": [\n {\n \"id\": 1,\n \"product\": {\n \"id\": 4,\n \"name\": \"Wireless Headphone\"\n },\n \"quantity\": \"8.0\",\n \"value\": \"10.0\"\n }\n ],\n \"revenue_account\": {\n \"id\": 17,\n \"code\": \"310\",\n \"name_en\": \"Sales\",\n \"name_ar\": \"المبيعات\",\n \"type_of_account\": \"Credit\",\n \"parent_type\": \"Revenue\",\n \"balance\": \"271.0\",\n \"type\": \"Revenue\",\n \"group_type\": \"Revenue\"\n },\n \"expense_account\": {\n \"id\": 12,\n \"code\": \"540\",\n \"name_en\": \"Cost Of Goods Sold\",\n \"name_ar\": \"تكلفه البضائع \",\n \"type_of_account\": \"Debit\",\n \"parent_type\": \"Expense\",\n \"balance\": \"828.23\",\n \"type\": \"DirectCost\",\n \"group_type\": \"Expenses\"\n }\n }\n}"}],"_postman_id":"44f03918-dc76-426e-9d1c-ab73d823bc66"},{"name":"Create inventory transfer","id":"c9d84046-c613-4fc4-8481-308f09a21aeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n\t\"inventory_transfer\": {\r\n\t\t\"from_location\": \"1\",\r\n\t\t\"to_location\": \"3\",\r\n\t\t\"date\": \"2019-10-30\",\r\n\t\t\"description\": \"سماعتين من فرع السليمانية لفرع الياسمين\",\r\n\t\t\"line_items\": [\r\n\t\t\t{\r\n\t\t\t\t\"product_id\": \"4\",\r\n\t\t\t\t\"quantity\": \"2\"\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/inventory_transfers","description":"

Parameters

\n
    \n
  1. from_location(required): id of the inventory you are transferring from
    2. \n
  2. to_location(required): id of the inventory you are transferring to
    3. \n
  3. transfer_account(optional): account where inventory value is transferred to and from, defaults to the default Inventory account (id: 10).
    4. \n
  4. date(required)
    5. \n
  5. description(required)
    6. \n
  6. line_items(required)
      \n
    1. product_id(required)
      2. \n
    2. quantity(required)
      3. \n
    \n
    7. \n
\n","urlObject":{"path":["2.0","inventory_transfers"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"f0cd6552-0ca0-44d6-ae32-072cc840d74b","name":"Create Inventory Transfer","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"body":{"mode":"raw","raw":"{ \r\n\t\"inventory_transfer\": {\r\n\t\t\"from_location\": \"1\",\r\n\t\t\"to_location\": \"3\",\r\n\t\t\"date\": \"2019-10-30\",\r\n\t\t\"description\": \"سماعتين من فرع السليمانية لفرع الياسمين\",\r\n\t\t\"line_items\": [\r\n\t\t\t{\r\n\t\t\t\t\"product_id\": \"4\",\r\n\t\t\t\t\"quantity\": \"2\"\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/inventory_transfers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 17 Feb 2020 15:12:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"e6fca855dc5f4d92eb8da5c89337725b\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"b3fbd577-ed05-4201-8d72-892ee1517b11"},{"key":"X-Runtime","value":"0.381721"}],"cookie":[],"responseTime":null,"body":"{\n \"inventory_transfer\": {\n \"id\": 2,\n \"date\": \"2019-10-30\",\n \"description\": \"سماعتين من فرع السليمانية لفرع الياسمين\",\n \"from\": {\n \"id\": 1,\n \"en_name\": \"Alsulaimaniah Branch\",\n \"ar_name\": \"فرع السليمانية\"\n },\n \"to\": {\n \"id\": 3,\n \"en_name\": \"Alyasmeen Branch\",\n \"ar_name\": \"فرع الياسمين\"\n },\n \"line_items\": [\n {\n \"id\": 2,\n \"product\": {\n \"id\": 4,\n \"name\": \"Wireless Headphone\"\n },\n \"quantity\": \"2.0\"\n }\n ]\n }\n}"}],"_postman_id":"c9d84046-c613-4fc4-8481-308f09a21aeb"}],"id":"b86fa2b2-6cd6-4d16-b93b-2f2c60bf23c7","event":[{"listen":"prerequest","script":{"id":"16608393-04b8-48bf-a70a-2d413243b141","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1aa3904d-4085-4234-b906-c41443af9d91","type":"text/javascript","exec":[""]}}],"_postman_id":"b86fa2b2-6cd6-4d16-b93b-2f2c60bf23c7","description":""},{"name":"Get all inventories","id":"41a1a834-c28e-477c-8d49-4960b666833c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/inventories","urlObject":{"path":["2.0","inventories"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"8107c1a8-7dfd-41b9-b49e-7b45c1ed94da","name":"Get all inventories","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/inventories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 18:55:29 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"0f8ee7a2f64dd77b63f16579683d3037\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"cdc919b0-b44b-4c62-af19-3f533dcd5a02"},{"key":"X-Runtime","value":"0.054105"}],"cookie":[],"responseTime":null,"body":"{\n \"inventories\": [\n {\n \"id\": 1,\n \"ar_name\": \"فرع السليمانية\",\n \"name\": \"Alsulaimaniah Branch\",\n \"account_id\": 10,\n \"created_at\": \"2019-10-30T19:56:17.000+03:00\",\n \"updated_at\": \"2019-10-30T21:51:21.000+03:00\",\n \"address\": {\n \"id\": 1,\n \"shipping_address\": \"شارع الثلاثين\",\n \"shipping_city\": \"الرياض\",\n \"shipping_state\": \"الرياض\",\n \"shipping_zip\": \"11525\",\n \"shipping_country\": \"Saudi Arabia\"\n }\n },\n {\n \"id\": 2,\n \"ar_name\": \"فرع الخبر الشمالية\",\n \"name\": \"Alkhobar Alshamaliah Branch\",\n \"account_id\": 10,\n \"created_at\": \"2019-10-30T21:53:05.000+03:00\",\n \"updated_at\": \"2019-10-30T21:53:05.000+03:00\",\n \"address\": {\n \"id\": 2,\n \"shipping_address\": \"شارع الملك فهد\",\n \"shipping_city\": \"الخبر\",\n \"shipping_state\": \"الشرقية\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"Saudi Arabia\"\n }\n }\n ]\n}"}],"_postman_id":"41a1a834-c28e-477c-8d49-4960b666833c"},{"name":"Get an inventory","id":"2d9db51d-dbaf-4bbe-964f-4ba4c9ffae04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/inventories/1","urlObject":{"path":["2.0","inventories","1"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"4184297c-5eff-4e10-a8ed-1ae113ba97a3","name":"Get an inventory","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/inventories/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 18:55:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"b4313cdbabeac83a7c0c455dff9b3836\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"8e6a3aca-89f2-4e4f-b00f-5356bfe26c06"},{"key":"X-Runtime","value":"0.054288"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"ar_name\": \"فرع السليمانية\",\n \"name\": \"Alsulaimaniah Branch\",\n \"account_id\": 10,\n \"created_at\": \"2019-10-30T19:56:17.000+03:00\",\n \"updated_at\": \"2019-10-30T21:51:21.000+03:00\",\n \"address\": {\n \"id\": 1,\n \"shipping_address\": \"شارع الثلاثين\",\n \"shipping_city\": \"الرياض\",\n \"shipping_state\": \"الرياض\",\n \"shipping_zip\": \"11525\",\n \"shipping_country\": \"Saudi Arabia\"\n }\n}"}],"_postman_id":"2d9db51d-dbaf-4bbe-964f-4ba4c9ffae04"},{"name":"Create an inventory","id":"67a791ae-b54c-432c-92db-0cc1b4249c9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"inventory\": {\r\n\t\t\"name\": \"Alyasmeen Branch\",\r\n\t\t\"ar_name\": \"فرع الياسمين\",\r\n\t\t\"account_id\": \"10\",\r\n\t\t\"address\": {\r\n\t\t\t\"shipping_address\": \"Anas Ibn Malik\",\r\n\t\t\t\"shipping_city\": \"Riyadh\",\r\n\t\t\t\"shipping_state\": \"Riyadh\",\r\n\t\t\t\"shipping_zip\": \"11525\",\r\n \"shipping_country\": \"Saudi Arabia\"\r\n\t\t}\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/inventories","description":"

Parameters

\n
    \n
  1. name(required)
    2. \n
  2. ar_name(required)
    3. \n
  3. account_id(required): The account where inventory adjustments are registered (must be an account of type Inventory)
    4. \n
  4. address(optional)
      \n
    1. shipping_address(optional)
      2. \n
    2. shipping_city(optional)
      3. \n
    3. shipping_state(optional)
      4. \n
    4. shipping_zip(optional)
      5. \n
    5. shipping_country(optional)
      6. \n
    \n
    5. \n
\n","urlObject":{"path":["2.0","inventories"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"a9f0e3e7-188a-4241-8716-e986eb69f83a","name":"Create inventory","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"inventory\": {\r\n\t\t\"name\": \"Alyasmeen Branch\",\r\n\t\t\"ar_name\": \"فرع الياسمين\",\r\n\t\t\"account_id\": \"10\",\r\n\t\t\"address\": {\r\n\t\t\t\"shipping_address\": \"Anas Ibn Malik\",\r\n\t\t\t\"shipping_city\": \"Riyadh\",\r\n\t\t\t\"shipping_state\": \"Riyadh\",\r\n\t\t\t\"shipping_zip\": \"11525\",\r\n \"shipping_country\": \"Saudi Arabia\"\r\n\t\t}\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/inventories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 19:02:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"edc2f0d1353655699c6b23d3a01d5428\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"b25988af-3f33-48a0-80df-1452b8e61fbb"},{"key":"X-Runtime","value":"0.075651"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 3,\n \"ar_name\": \"فرع الياسمين\",\n \"name\": \"Alyasmeen Branch\",\n \"account_id\": 10,\n \"created_at\": \"2019-10-30T22:02:36.430+03:00\",\n \"updated_at\": \"2019-10-30T22:02:36.430+03:00\",\n \"address\": {\n \"id\": 3,\n \"shipping_address\": \"Anas Ibn Malik\",\n \"shipping_city\": \"Riyadh\",\n \"shipping_state\": \"Riyadh\",\n \"shipping_zip\": \"11525\",\n \"shipping_country\": \"Saudi Arabia\"\n }\n}"}],"_postman_id":"67a791ae-b54c-432c-92db-0cc1b4249c9d"},{"name":"Update an inventory","id":"4a962fc1-82cb-4a85-8342-031811f9cdf1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"inventory\": {\r\n\t\t\"name\": \"new name\"\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/inventories/1","description":"

Enter only the parameters you wish to change

\n

Parameters

\n
    \n
  1. name
    2. \n
  2. ar_name
    3. \n
  3. address
      \n
    1. shipping_address
      2. \n
    2. shipping_city
      3. \n
    3. shipping_state
      4. \n
    4. shipping_zip
      5. \n
    5. shipping_country
      6. \n
    \n
    4. \n
\n","urlObject":{"path":["2.0","inventories","1"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"4778dd79-bf40-4497-95dc-7b013c53e72b","name":"Update an inventory","originalRequest":{"method":"PATCH","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"inventory\": {\r\n\t\t\"name\": \"new name\"\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/inventories/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 19:08:37 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"a69c85ce0d6c67bdbf474e55c9c8c304\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"f1da6999-e44e-4075-8392-758f4d2be0aa"},{"key":"X-Runtime","value":"0.076824"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"ar_name\": \"فرع السليمانية\",\n \"name\": \"new name\",\n \"account_id\": 10,\n \"created_at\": \"2019-10-30T19:56:17.000+03:00\",\n \"updated_at\": \"2019-10-30T22:08:37.740+03:00\",\n \"address\": {\n \"id\": 1,\n \"shipping_address\": \"شارع الثلاثين\",\n \"shipping_city\": \"الرياض\",\n \"shipping_state\": \"الرياض\",\n \"shipping_zip\": \"11525\",\n \"shipping_country\": \"Saudi Arabia\"\n }\n}"}],"_postman_id":"4a962fc1-82cb-4a85-8342-031811f9cdf1"}],"id":"52469ae8-7f25-4693-ac43-5fe00a15abb9","_postman_id":"52469ae8-7f25-4693-ac43-5fe00a15abb9","description":""},{"name":"Product Categories","item":[{"name":"All categories","id":"afb57802-3e75-4afc-aa1d-4fe445f96086","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/categories","urlObject":{"path":["2.0","categories"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"38eaa510-0a31-4958-a35a-8efd19547315","name":"All Categories","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 18:20:55 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"56dc0b6b0cce9bf26638c62a35510ace\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"66d5ed36-caf1-4963-8104-4fb14ce89faa"},{"key":"X-Runtime","value":"0.021194"}],"cookie":[],"responseTime":null,"body":"{\n \"categories\": [\n {\n \"id\": 1,\n \"name\": \"Accessories\",\n \"description\": \"اكسسوارات\",\n \"parent_id\": null\n },\n {\n \"id\": 2,\n \"name\": \"Devices\",\n \"description\": \"أجهزة\",\n \"parent_id\": null\n },\n {\n \"id\": 3,\n \"name\": \"Mobile Phones\",\n \"description\": \"جوالات\",\n \"parent_id\": 2\n },\n {\n \"id\": 4,\n \"name\": \"Tablets\",\n \"description\": \"أجهزة لوحية\",\n \"parent_id\": 2\n },\n {\n \"id\": 5,\n \"name\": \"Portable Batteries\",\n \"description\": \"بطاريات متنقلة\",\n \"parent_id\": null\n },\n {\n \"id\": 6,\n \"name\": \"Maintenance\",\n \"description\": \"صيانة\",\n \"parent_id\": null\n },\n {\n \"id\": 7,\n \"name\": \"Covers\",\n \"description\": \"كفرات\",\n \"parent_id\": 1\n }\n ]\n}"}],"_postman_id":"afb57802-3e75-4afc-aa1d-4fe445f96086"},{"name":"Get a category","id":"caa30331-2e80-4c50-989c-f7eb55f12c29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/categories/1","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","categories","1"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"05211519-8c95-454f-8974-7875f978a668","name":"Get a Category","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/categories/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 18:21:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"db9a16a4d992cfffc6b1c33788d38d71\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"7fe18958-b1b8-4a59-b38a-cfd759fb911b"},{"key":"X-Runtime","value":"0.018712"}],"cookie":[],"responseTime":null,"body":"{\n \"category\": {\n \"id\": 1,\n \"name\": \"Accessories\",\n \"description\": \"اكسسوارات\",\n \"parent_id\": null\n }\n}"}],"_postman_id":"caa30331-2e80-4c50-989c-f7eb55f12c29"},{"name":"Create a category","id":"4894e00b-d502-485d-be68-1a9f7d94a21b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"category\": {\n \t\"name\": \"Cables\",\n \t\"description\": \"أسلاك\",\n \t\"parent_id\": 1\n }\n}"},"url":"https://www.qoyod.com/2.0/categories","description":"

Parameters

\n
    \n
  1. name(required): The name of the category.
    2. \n
  2. description(optional): A description of the category
    3. \n
  3. parent_id(optional): id of parent category, cannot be a parent of itself.
    4. \n
\n","urlObject":{"path":["2.0","categories"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"ac158f28-5e78-4d83-a9cc-70f71e287078","name":"Create a Category","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"category\": {\n \t\"name\": \"Cables\",\n \t\"description\": \"أسلاك\",\n \t\"parent_id\": \"1\"\n }\n}"},"url":"https://www.qoyod.com/2.0/categories"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 18:21:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"201 Created"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"6d1769bd51bc1e2a620ecaa848a20175\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"66b16dd0-51e8-426e-982d-ffeb1319415b"},{"key":"X-Runtime","value":"0.049240"}],"cookie":[],"responseTime":null,"body":"{\n \"category\": {\n \"id\": 9,\n \"name\": \"Cables\",\n \"description\": \"أسلاك\",\n \"parent_id\": 1\n }\n}"},{"id":"af0775d3-b0e4-421c-9a66-280b2c7d2579","name":"Create multiple categories","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"category\": [{\n \t\"name\": \"Cables\",\n \t\"description\": \"أسلاك\",\n \t\"parent_id\": 1\n },\n {\n \t\"name\": \"Chargers\",\n \t\"description\": \"شواحن\",\n \t\"parent_id\": 1\n }]\n}"},"url":"https://www.qoyod.com/2.0/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Mar 2020 09:35:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"db487f11de16d6a1e2a6d267110cba5d\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"29b3e83f-797d-471e-a790-ddee48bf10e4"},{"key":"X-Runtime","value":"0.094504"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 12,\n \"name\": \"Cables\",\n \"description\": \"أسلاك\",\n \"parent_id\": 1\n },\n {\n \"id\": 13,\n \"name\": \"Chargers\",\n \"description\": \"شواحن\",\n \"parent_id\": 1\n }\n]"}],"_postman_id":"4894e00b-d502-485d-be68-1a9f7d94a21b"},{"name":"Update a category","id":"e1aecefc-dfa9-432c-a5bc-0e54418b48d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"category\": {\n \t\"description\": \"updated description\"\n }\n}"},"url":"https://www.qoyod.com/2.0/categories/1","description":"

Enter only the parameters you wish to change

\n

Parameters

\n
    \n
  1. name: The name of the category.
    2. \n
  2. description: A description of the category
    3. \n
  3. parent_id: id of parent category, cannot be a parent of itself.
    4. \n
\n","urlObject":{"path":["2.0","categories","1"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"c47f588d-ad7b-48dd-9116-b9c591f0f81c","name":"Update a Category","originalRequest":{"method":"PUT","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"category\": {\n \t\"description\": \"updated description\"\n }\n}"},"url":"https://www.qoyod.com/2.0/categories/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 18:23:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"204055b90310c9501efc9a84792110d7\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"073eb6dc-d9f3-4736-bb87-d4d22417a02e"},{"key":"X-Runtime","value":"0.043445"}],"cookie":[],"responseTime":null,"body":"{\n \"category\": {\n \"id\": 1,\n \"name\": \"Accessories\",\n \"description\": \"updated description\",\n \"parent_id\": null\n }\n}"}],"_postman_id":"e1aecefc-dfa9-432c-a5bc-0e54418b48d4"}],"id":"5b187ffd-c7c7-4125-b5ac-760f2b7e9752","_postman_id":"5b187ffd-c7c7-4125-b5ac-760f2b7e9752","description":""},{"name":"Product Units","item":[{"name":"Get all units","id":"277d868e-2497-49a6-9a14-b29d31ebfc84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/product_unit_types","urlObject":{"path":["2.0","product_unit_types"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"5781bd1f-3f38-4e38-a8f3-2fc55cb1ce00","name":"Get All Unit Types","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/product_unit_types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 18:23:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"94589a369450915e142d3d491221b610\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"c2418ca1-b5f4-4d13-9387-7f710730eae2"},{"key":"X-Runtime","value":"0.028924"}],"cookie":[],"responseTime":null,"body":"{\n \"product_unit_types\": [\n {\n \"id\": 1,\n \"unit_name\": \"جرام\",\n \"unit_representation\": \"ج\"\n },\n {\n \"id\": 2,\n \"unit_name\": \"كیلو جرام\",\n \"unit_representation\": \"كج\"\n },\n {\n \"id\": 3,\n \"unit_name\": \"لتر\",\n \"unit_representation\": \"لتر\"\n },\n {\n \"id\": 4,\n \"unit_name\": \"متر مربع\",\n \"unit_representation\": \"م٢\"\n },\n {\n \"id\": 5,\n \"unit_name\": \"متر مكعب\",\n \"unit_representation\": \"م٣\"\n },\n {\n \"id\": 6,\n \"unit_name\": \"قطعة\",\n \"unit_representation\": \"قطعة\"\n },\n {\n \"id\": 7,\n \"unit_name\": \" وحدة\",\n \"unit_representation\": \"وحدة\"\n }\n ]\n}"}],"_postman_id":"277d868e-2497-49a6-9a14-b29d31ebfc84"},{"name":"Get a unit","id":"08b00d9f-c092-41bb-ba25-eb820a23f3c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/product_unit_types/1","urlObject":{"path":["2.0","product_unit_types","1"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"5ff5b5fc-7303-4b22-9628-bd014ba084dd","name":"Get a Unit Type","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/product_unit_types/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 18:24:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"042c2853463f325d56c8da0811082137\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"8600ab65-9eb7-4045-b2c8-a4382011da76"},{"key":"X-Runtime","value":"0.023139"}],"cookie":[],"responseTime":null,"body":"{\n \"product_unit_type\": {\n \"id\": 1,\n \"unit_name\": \"جرام\",\n \"unit_representation\": \"ج\"\n }\n}"}],"_postman_id":"08b00d9f-c092-41bb-ba25-eb820a23f3c5"},{"name":"Create a unit","id":"4326c74d-f7f5-4018-9e6e-ca04cf4ce901","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"product_unit_type\":\n\t{\n \"unit_name\": \"Carton\",\n \"unit_representation\": \"Carton\"\n\t}\n}"},"url":"https://www.qoyod.com/2.0/product_unit_types","description":"

Parameters

\n
    \n
  1. unit_name(required)
    2. \n
  2. unit_representation(required)
    3. \n
\n","urlObject":{"path":["2.0","product_unit_types"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"1094f654-011d-4c6e-a1b6-6b56a64596bd","name":"Create a Unit Type","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"product_unit_type\":\n\t{\n \"unit_name\": \"Carton\",\n \"unit_representation\": \"Carton\"\n\t}\n}"},"url":"https://www.qoyod.com/2.0/product_unit_types"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 18:26:49 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"201 Created"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"0da5e2b5ab7e2bd14b038fab388c6671\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"c2ca6aed-41b4-4b21-845c-08e9dd22c798"},{"key":"X-Runtime","value":"0.058629"}],"cookie":[],"responseTime":null,"body":"{\n \"product_unit_type\": {\n \"id\": 8,\n \"unit_name\": \"Carton\",\n \"unit_representation\": \"Carton\"\n }\n}"}],"_postman_id":"4326c74d-f7f5-4018-9e6e-ca04cf4ce901"}],"id":"549549a9-5913-4fdc-a92c-8ab7b02b68ee","event":[{"listen":"prerequest","script":{"id":"25e1ddd5-ad50-4f0d-8a72-9904ac0a76f3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5fcd69a0-7c6e-4941-b40a-3d11f12a68eb","type":"text/javascript","exec":[""]}}],"_postman_id":"549549a9-5913-4fdc-a92c-8ab7b02b68ee","description":""},{"name":"All products","id":"64217dfc-6937-4efc-a0ac-50445ccaa9ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/products","urlObject":{"path":["2.0","products"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"81d175ee-420f-4c56-ac53-841222ca7d1d","name":"All products","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/products"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 31 Oct 2019 02:37:50 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"b4833d5d2f4ae41545b8be726bf5444c\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"f037c35e-cc8b-4923-8a66-062a49fb40e6"},{"key":"X-Runtime","value":"0.094057"}],"cookie":[],"responseTime":null,"body":"{\n \"products\": [\n {\n \"id\": 1,\n \"name_ar\": \"جوال سامسونج\",\n \"name_en\": \"Samsung Phone\",\n \"description\": \"جوال سامسوتج جميل جدا\",\n \"category_id\": 3,\n \"type\": \"Product\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"buying_price\": \"850.0\",\n \"selling_price\": \"1000.0\",\n \"sku\": \"ph-1\",\n \"barcode\": \"230879840\",\n \"is_sold\": true,\n \"is_bought\": true,\n \"inventories\": [\n {\n \"id\": 1,\n \"name_en\": \"Alsulaimaniah Branch\",\n \"name_ar\": \"فرع السليمانية\",\n \"stock\": \"20.0\"\n }\n ],\n \"ingredients\": [],\n \"unit_conversions\": []\n },\n {\n \"id\": 2,\n \"name_ar\": \"تابلت هواهي\",\n \"name_en\": \"Huawei Tablet\",\n \"description\": \"تابلت هواوي درجة أولى\",\n \"category_id\": 4,\n \"type\": \"Product\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"buying_price\": \"1000.0\",\n \"selling_price\": \"1200.0\",\n \"sku\": \"ta-2\",\n \"barcode\": \"747402854\",\n \"is_sold\": true,\n \"is_bought\": true,\n \"inventories\": [\n {\n \"id\": 1,\n \"name_en\": \"Alsulaimaniah Branch\",\n \"name_ar\": \"فرع السليمانية\",\n \"stock\": \"20.0\"\n }\n ],\n \"ingredients\": [],\n \"unit_conversions\": []\n },\n {\n \"id\": 3,\n \"name_ar\": \"صيانة\",\n \"name_en\": \"maintainance\",\n \"description\": \"صيانة عامة\",\n \"category_id\": 6,\n \"type\": \"Service\",\n \"unit_type\": 7,\n \"unit\": \"وحدة\",\n \"buying_price\": 0,\n \"selling_price\": \"50.0\",\n \"sku\": \"ma-00\",\n \"barcode\": null,\n \"is_sold\": true,\n \"is_bought\": false,\n \"inventories\": [],\n \"ingredients\": [],\n \"unit_conversions\": []\n },\n {\n \"id\": 4,\n \"name_ar\": \"سماعة اذن لاسلكية\",\n \"name_en\": \"Wireless Headphone\",\n \"description\": \"سماعة بلوتوث\",\n \"category_id\": 1,\n \"type\": \"Product\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"buying_price\": \"55.0\",\n \"selling_price\": \"70.0\",\n \"sku\": \"acc-1\",\n \"barcode\": \"769552946\",\n \"is_sold\": true,\n \"is_bought\": true,\n \"inventories\": [\n {\n \"id\": 1,\n \"name_en\": \"Alsulaimaniah Branch\",\n \"name_ar\": \"فرع السليمانية\",\n \"stock\": \"5.0\"\n },\n {\n \"id\": 3,\n \"name_en\": \"Alyasmeen Branch\",\n \"name_ar\": \"فرع الياسمين\",\n \"stock\": \"2.0\"\n }\n ],\n \"ingredients\": [],\n \"unit_conversions\": []\n },\n {\n \"id\": 5,\n \"name_ar\": \"عرض جوال وسماعة لاسلكية\",\n \"name_en\": \"Phone and Headphones Bundle\",\n \"description\": \"جوال وسماعة معا بسعر مخفض\",\n \"category_id\": 3,\n \"type\": \"Recipe\",\n \"unit_type\": 7,\n \"unit\": \"وحدة\",\n \"buying_price\": 0,\n \"selling_price\": \"1030.0\",\n \"sku\": \"bu-1\",\n \"barcode\": \"\",\n \"is_sold\": true,\n \"is_bought\": false,\n \"inventories\": [],\n \"ingredients\": [\n {\n \"product_id\": 1,\n \"quantity\": \"1.0\",\n \"product_unit_id\": 6\n },\n {\n \"product_id\": 4,\n \"quantity\": \"1.0\",\n \"product_unit_id\": 6\n }\n ],\n \"unit_conversions\": []\n },\n {\n \"id\": 6,\n \"name_ar\": \"كيس كشخة\",\n \"name_en\": \"Nice Bag\",\n \"description\": \"كيس فاخر\",\n \"category_id\": 1,\n \"type\": \"RawMaterial\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"buying_price\": \"2.0\",\n \"selling_price\": 0,\n \"sku\": \"kees1\",\n \"barcode\": \"\",\n \"is_sold\": false,\n \"is_bought\": true,\n \"inventories\": [],\n \"ingredients\": [],\n \"unit_conversions\": [\n {\n \"to_unit\": 6,\n \"from_unit\": 8,\n \"rate\": \"100.0\"\n }\n ]\n },\n {\n \"id\": 7,\n \"name_ar\": \"اجار المحل\",\n \"name_en\": \"Rent\",\n \"description\": \"غالي شوي\",\n \"category_id\": 11,\n \"type\": \"Expense\",\n \"unit_type\": 9,\n \"unit\": \"Year\",\n \"buying_price\": \"30000.0\",\n \"selling_price\": 0,\n \"sku\": \"rent\",\n \"barcode\": null,\n \"is_sold\": false,\n \"is_bought\": true,\n \"inventories\": [],\n \"ingredients\": [],\n \"unit_conversions\": []\n },\n {\n \"id\": 8,\n \"name_ar\": \"دبوس شريحة\",\n \"name_en\": \"SIM Pin\",\n \"description\": \"يفك أزمات\",\n \"category_id\": 1,\n \"type\": \"Product\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"buying_price\": \"1.0\",\n \"selling_price\": \"5.0\",\n \"sku\": \"acc-2\",\n \"barcode\": \"\",\n \"is_sold\": true,\n \"is_bought\": true,\n \"inventories\": [],\n \"ingredients\": [],\n \"unit_conversions\": [\n {\n \"to_unit\": 6,\n \"from_unit\": 8,\n \"rate\": \"100.0\"\n }\n ]\n },\n {\n \"id\": 9,\n \"name_ar\": \"أدوات لحام\",\n \"name_en\": \"Welding Supplies\",\n \"description\": \"\",\n \"category_id\": 6,\n \"type\": \"Product\",\n \"unit_type\": 7,\n \"unit\": \"وحدة\",\n \"buying_price\": \"10.0\",\n \"selling_price\": 0,\n \"sku\": \"ma-c1\",\n \"barcode\": \"\",\n \"is_sold\": false,\n \"is_bought\": true,\n \"inventories\": [],\n \"ingredients\": [],\n \"unit_conversions\": []\n }\n ]\n}"}],"_postman_id":"64217dfc-6937-4efc-a0ac-50445ccaa9ad"},{"name":"Get a product","id":"a19a2f5a-bc3e-4c9c-9b97-4f5fe8f777e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/products/4","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","products","4"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"272ab963-4be3-40ed-af0b-dc4a1f7b501d","name":"Get a product","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/products/4"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 31 Oct 2019 02:37:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"9175e772815ae73f554ab28d3b45b64d\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"93902e43-2500-4acf-848d-30164544b024"},{"key":"X-Runtime","value":"0.434659"}],"cookie":[],"responseTime":null,"body":"{\n \"product\": [\n {\n \"id\": 4,\n \"name_ar\": \"سماعة اذن لاسلكية\",\n \"name_en\": \"Wireless Headphone\",\n \"description\": \"سماعة بلوتوث\",\n \"category_id\": 1,\n \"type\": \"Product\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"buying_price\": \"55.0\",\n \"selling_price\": \"70.0\",\n \"sku\": \"acc-1\",\n \"barcode\": \"769552946\",\n \"is_sold\": true,\n \"is_bought\": true,\n \"inventories\": [\n {\n \"id\": 1,\n \"name_en\": \"Alsulaimaniah Branch\",\n \"name_ar\": \"فرع السليمانية\",\n \"stock\": \"5.0\"\n },\n {\n \"id\": 3,\n \"name_en\": \"Alyasmeen Branch\",\n \"name_ar\": \"فرع الياسمين\",\n \"stock\": \"2.0\"\n }\n ],\n \"ingredients\": [],\n \"unit_conversions\": []\n }\n ]\n}"}],"_postman_id":"a19a2f5a-bc3e-4c9c-9b97-4f5fe8f777e7"},{"name":"Create a product","id":"6e9cecd9-60dc-4b5a-b6f2-b56f36e9f4c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"product\": {\n\t\"sku\": \"cable-1\",\n \"barcode\": \"548572\",\n \"name_ar\": \"سلك يو اس بي سي 1 متر\",\n \"name_en\": \"USB-C Cable 1 Meter\",\n \"description\":\"ذو جودة فائقة\",\n \"product_unit_type_id\": \"6\",\n \"category_id\": \"1\",\n \n \"track_quantity\": \"1\",\n \n\t\"purchase_item\": \"1\",\n \"buying_price\": \"10.0\",\n\t\"expense_account_id\": \"12\",\n\t\n\t\"sale_item\": \"1\",\n \"selling_price\": \"20.0\",\n\t\"sales_account_id\": \"17\",\n\t\n\t\"tax_id\": \"1\"\n\t}\n}"},"url":"https://www.qoyod.com/2.0/products/","description":"

Parameters

\n
    \n
  1. SKU(required, unique): the SKU of the product, must be unique.
    2. \n
  2. barcode(optional)
    3. \n
  3. name_ar(required): product arabic name.
    4. \n
  4. name_en(required): product english name.
    5. \n
  5. description(optional)
    6. \n
  6. product_unit_type_id(required): The base unit id of the product.
    7. \n
  7. category_id(required): The category id of the product.
    8. \n
  8. track_quantity(optional): Is this product an inventory item? Set 1 for true, otherwise remove it or set it to 0.
    9. \n
  9. purchase_item: enter 1 if you buy the product, leave it empty or zero otherwise.
    10. \n
  10. buying_price: the price you buy the product for, only required if purchase_item is true
    11. \n
  11. expense_account_id: the cost of goods sold or purchases account where the cost is registered, only required if purchase_item is true
    12. \n
  12. sale_item: enter 1 if you sell the product, leave it empty or zero otherwise.
    13. \n
  13. selling_price: the price you sell the product for, only required if sale_item is true
    14. \n
  14. sales_account_id: the sales account where the sales revenue is registered, only required if sale_item is true
    15. \n
  15. tax_id(required): Enter one of the following default choices, or you can create your own taxes by going to the tax settings page:
      \n
    1. 1: 15% VAT
      2. \n
    2. 2: 0% VAT
      3. \n
    3. 3: Tax exempt
      4. \n
    \n
    16. \n
  16. special_tax_reason_id : only for use when tax is \"Zero\" or \"Exempt\"
      \n
    1. In case tax is \"Zero\"
        \n
      1. 1 : Export of goods
        2. \n
      2. 2 : Export of services
        3. \n
      3. 3 : Qualifying metals
        4. \n
      4. 4 : Private education to citizen
        5. \n
      5. 5 : Private healthcare to citizen
        6. \n
      6. 6 : Medicines and medical equipment
        7. \n
      7. 7 : International transport of Goods
        8. \n
      8. 8 : International transport of passengers
        9. \n
      9. 9 : Supply of a qualifying means of transport
        10. \n
      10. 10 : Services relating to Goods or passenger transportation
        11. \n
      11. 11 : Services directly connected to supply of international passenger transport
        12. \n
      \n
      2. \n
    2. In case tax is \"Exempt\"
        \n
      1. 12 : Financial services
        2. \n
      2. 13 : Life insurance services
        3. \n
      3. 14 : Real estate transactions
        4. \n
      \n
      3. \n
    \n
    17. \n
  17. type(optional): Enter one of the following choices, defaults to \"Product\":
      \n
    1. \"Product\"
      2. \n
    2. \"Service\"
      3. \n
    3. \"Expense\"
      4. \n
    4. \"RawMaterial\"
      5. \n
    5. \"Recipe\"
      6. \n
    \n
    18. \n
  18. ingredients_attributes: only for use if type is \"Recipe\"
      \n
    1. component_id: the product id of the ingredient
      2. \n
    2. unit_id: unit id of the ingredient
      3. \n
    3. quantity: how much of the ingredient is needed to make 1 recipe
      4. \n
    \n
    19. \n
  19. unit_conversions(optional): Each product can have multiple units other than the base unit specified above in parameter #6:
      \n
    1. from_unit(required): the new unit you would like to add
      2. \n
    2. rate(required): 1 x from_unit = rate x base_unit
      3. \n
    3. unit_purchase_price(optional)
      4. \n
    4. unit_selling_price(optional)
      5. \n
    5. barcode(optional)
      6. \n
    \n
    20. \n
\n","urlObject":{"path":["2.0","products",""],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"59c4f005-f358-4d6b-aac2-5dff4b1394f8","name":"Create a product","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"product\": {\n\t\"sku\": \"cable-1\",\n \"barcode\": \"548572\",\n \"name_ar\": \"سلك يو اس بي سي 1 متر\",\n \"name_en\": \"USB-C Cable 1 Meter\",\n \"description\":\"ذو جودة فائقة\",\n \"product_unit_type_id\": \"6\",\n \"category_id\": \"1\",\n \n \"track_quantity\": \"1\",\n \n\t\"purchase_item\": \"1\",\n \"buying_price\": \"10.0\",\n\t\"expense_account_id\": \"12\",\n\t\n\t\"sale_item\": \"1\",\n \"selling_price\": \"20.0\",\n\t\"sales_account_id\": \"17\",\n\t\n\t\"tax_id\": \"1\"\n\t}\n}"},"url":"https://www.qoyod.com/2.0/products/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 31 Oct 2019 02:42:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"201 Created"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"5dae0f0cbe7cfc96280dbba9a7c3666f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"1c7b37ab-809a-4d7b-90de-675b93c56310"},{"key":"X-Runtime","value":"0.219402"}],"cookie":[],"responseTime":null,"body":"{\n \"product\": {\n \"id\": 10,\n \"name_ar\": \"سلك يو اس بي سي 1 متر\",\n \"name_en\": \"USB-C Cable 1 Meter\",\n \"description\": \"ذو جودة فائقة\",\n \"category_id\": 1,\n \"type\": \"Product\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"buying_price\": \"10.0\",\n \"selling_price\": \"20.0\",\n \"sku\": \"cable-1\",\n \"barcode\": \"548572\",\n \"is_sold\": true,\n \"is_bought\": true,\n \"inventories\": [],\n \"ingredients\": [],\n \"unit_conversions\": []\n }\n}"},{"id":"9704c15c-e6e4-484f-9368-5d89c1501748","name":"Create multiple products","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"product\": [{\n\t\"sku\": \"cable-2\",\n \"barcode\": \"548573\",\n \"name_ar\": \"سلك يو اس بي سي 2 متر\",\n \"name_en\": \"USB-C Cable 2 Meters\",\n \"description\":\"ذو جودة فائقة\",\n \"product_unit_type_id\": \"6\",\n \"category_id\": \"1\",\n \n \"track_quantity\": \"1\",\n \n\t\"purchase_item\": \"1\",\n \"buying_price\": \"12.50\",\n\t\"expense_account_id\": \"12\",\n\t\n\t\"sale_item\": \"1\",\n \"selling_price\": \"25.0\",\n\t\"sales_account_id\": \"17\",\n\t\n\t\"tax_id\": \"1\"\n\t},\n\t{\n\t\"sku\": \"cable-3\",\n \"barcode\": \"548574\",\n \"name_ar\": \"سلك يو اس بي سي 3 متر\",\n \"name_en\": \"USB-C Cable 3 Meters\",\n \"description\":\"ذو جودة فائقة\",\n \"product_unit_type_id\": \"6\",\n \"category_id\": \"1\",\n \n \"track_quantity\": \"1\",\n \n\t\"purchase_item\": \"1\",\n \"buying_price\": \"15.0\",\n\t\"expense_account_id\": \"12\",\n\t\n\t\"sale_item\": \"1\",\n \"selling_price\": \"30.0\",\n\t\"sales_account_id\": \"17\",\n\t\n\t\"tax_id\": \"1\"\n\t}]\n}"},"url":"https://www.qoyod.com/2.0/products/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Mar 2020 11:08:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"8a47afeac8bd93fd7926f2f3e9134548\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"7b684fd3-7d52-4ca8-9d4a-74ca1934b533"},{"key":"X-Runtime","value":"0.213615"}],"cookie":[],"responseTime":null,"body":"{\n \"products\": [\n {\n \"id\": 11,\n \"name_ar\": \"سلك يو اس بي سي 2 متر\",\n \"name_en\": \"USB-C Cable 2 Meters\",\n \"description\": \"ذو جودة فائقة\",\n \"category_id\": 1,\n \"type\": \"Product\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"buying_price\": \"12.5\",\n \"selling_price\": \"25.0\",\n \"sku\": \"cable-2\",\n \"barcode\": \"548573\",\n \"is_sold\": true,\n \"is_bought\": true,\n \"inventories\": [],\n \"ingredients\": [],\n \"unit_conversions\": []\n },\n {\n \"id\": 12,\n \"name_ar\": \"سلك يو اس بي سي 3 متر\",\n \"name_en\": \"USB-C Cable 3 Meters\",\n \"description\": \"ذو جودة فائقة\",\n \"category_id\": 1,\n \"type\": \"Product\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"buying_price\": \"15.0\",\n \"selling_price\": \"30.0\",\n \"sku\": \"cable-3\",\n \"barcode\": \"548574\",\n \"is_sold\": true,\n \"is_bought\": true,\n \"inventories\": [],\n \"ingredients\": [],\n \"unit_conversions\": []\n }\n ]\n}"},{"id":"a661eb66-afb9-4a8f-8089-639fb9930d3d","name":"Create a recipe","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"product\": {\n \"sku\": \"bu-2\",\n \"barcode\": \"548573\",\n \"name_ar\": \"عرض جوال وتابلت\",\n \"name_en\": \"Tablet and Phone Combo\",\n \"description\":\"\",\n \"product_unit_type_id\": \"6\",\n \"category_id\": \"2\",\n \"type\":\"Recipe\",\n \"track_quantity\": \"0\",\n \n \"purchase_item\": \"0\",\n \"expense_account_id\": \"12\",\n \n \"sale_item\": \"1\",\n \"selling_price\": \"1800\",\n \"sales_account_id\": \"17\",\n \n \"tax_id\": \"1\",\n\n \"ingredients_attributes\": [\n {\n \"component_id\": \"1\",\n \"unit_id\": \"6\",\n \"quantity\": \"1\"\n },\n {\n \"component_id\": \"2\",\n \"unit_id\": \"6\",\n \"quantity\": \"1\"\n }\n ]\n\t}\n}"},"url":"https://www.qoyod.com/2.0/products/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 23 Nov 2020 13:57:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"2f6e98bd55679e18abbc0a4750e96beb\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"e377a4f9-2389-4262-b82a-6b19dd271de3"},{"key":"X-Runtime","value":"0.085348"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"product\": {\n \"id\": 15,\n \"name_ar\": \"عرض جوال وتابلت\",\n \"name_en\": \"Tablet and Phone Combo\",\n \"description\": \"\",\n \"category_id\": 2,\n \"type\": \"Recipe\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"buying_price\": 0,\n \"selling_price\": \"1800.0\",\n \"sku\": \"bu-2\",\n \"barcode\": \"548573\",\n \"is_sold\": true,\n \"is_bought\": false,\n \"track_quantity\": false,\n \"inventories\": [],\n \"ingredients\": [\n {\n \"id\": 5,\n \"product_id\": 15,\n \"component_id\": 1,\n \"quantity\": \"1.0\",\n \"unit_id\": 6,\n \"created_at\": \"2020-11-23T16:57:31.000+03:00\",\n \"updated_at\": \"2020-11-23T16:57:31.000+03:00\"\n },\n {\n \"id\": 6,\n \"product_id\": 15,\n \"component_id\": 2,\n \"quantity\": \"1.0\",\n \"unit_id\": 6,\n \"created_at\": \"2020-11-23T16:57:31.000+03:00\",\n \"updated_at\": \"2020-11-23T16:57:31.000+03:00\"\n }\n ],\n \"unit_conversions\": []\n }\n}"}],"_postman_id":"6e9cecd9-60dc-4b5a-b6f2-b56f36e9f4c2"},{"name":"Update a product","id":"18d499b4-148a-4217-8c3b-5be02bf069ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"product\": {\n \t\"barcode\": \"2221414\"\n }\n}"},"url":"https://www.qoyod.com/2.0/products/10","description":"

Enter only the parameters you wish to change.

\n

Please consider the following:
- Cannot update inventory status of the product (tracked or not) if the product is involved already in any invoices/bills
- Cannot update stock quantities directly (use inventory adjustments).
- Cannot update `product unit type` if the product is involved already in any invoices/bills
- Cannot update `sales account` if the product is involved already in any invoices/bills
- Cannot update `purchase account` if the product is not tracked (not an inventory item) and a buying price is already defined
- `cogs account` cannot be empty if the product is tracked (marked as an inventory item)

\n

Parameters

\n
    \n

  1. SKU

    \n
    2. \n

  2. barcode

    \n
    3. \n

  3. name_ar

    \n
    4. \n

  4. name_en

    \n
    5. \n

  5. description

    \n
    6. \n

  6. category_id

    \n
    7. \n

  7. ingredients_attributes: only for use if type is \"Recipe\"

    \n
      \n

    1. component_id: the product id of the ingredient

      \n
      2. \n

    2. unit_id: unit id of the ingredient

      \n
      3. \n

    3. quantity: how much of the ingredient is needed to make 1 recipe

      \n
      4. \n
    \n
    8. \n

  8. unit_conversions

    \n
      \n

    1. from_unit(required): the new unit you would like to add

      \n
      2. \n

    2. rate(required): 1 x from_unit = rate x base_unit

      \n
      3. \n

    3. unit_purchase_price(optional)

      \n
      4. \n

    4. unit_selling_price(optional)

      \n
      5. \n

    5. barcode(optional)

      \n
      6. \n
    \n
    9. \n
\n","urlObject":{"path":["2.0","products","10"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"d1dd6e90-7996-4877-913b-fe93c922c2d9","name":"Update a product","originalRequest":{"method":"PUT","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"product\": {\n \t\"barcode\": \"2221414\"\n }\n}"},"url":"https://www.qoyod.com/2.0/products/10"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 31 Oct 2019 03:14:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"754034e81327660f46949529cf468066\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"6e050388-eb86-4d33-a2ae-d1a0cd5a5228"},{"key":"X-Runtime","value":"0.080529"}],"cookie":[],"responseTime":null,"body":"{\n \"product\": {\n \"id\": 10,\n \"name_ar\": \"سلك يو اس بي سي 1 متر\",\n \"name_en\": \"USB-C Cable 1 Meter\",\n \"description\": \"ذو جودة فائقة\",\n \"category_id\": 1,\n \"type\": \"Product\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"buying_price\": \"10.0\",\n \"selling_price\": \"20.0\",\n \"sku\": \"cable-1\",\n \"barcode\": \"2221414\",\n \"is_sold\": true,\n \"is_bought\": true,\n \"inventories\": [],\n \"ingredients\": [],\n \"unit_conversions\": []\n }\n}"}],"_postman_id":"18d499b4-148a-4217-8c3b-5be02bf069ed"}],"id":"9ed4657f-456a-4331-a4ec-9886702a98b7","event":[{"listen":"prerequest","script":{"id":"85a68b49-114f-4ddc-825d-382dd776aea3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"72b104ac-e759-403f-bbfb-747c04b0304f","type":"text/javascript","exec":[""]}}],"_postman_id":"9ed4657f-456a-4331-a4ec-9886702a98b7","description":""},{"name":"Purchases","item":[{"name":"Vendors","item":[{"name":"All vendors","id":"abd4baec-8100-4e95-8346-b4ed3ce30e25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/vendors","urlObject":{"path":["2.0","vendors"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"698d1cd9-0a41-4479-b05d-090d3599265e","name":"All vendors","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/vendors"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 20:39:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"261622a5b0a175006008012ad8bf08e8\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"e0562299-b207-4a0d-baff-8dea20996293"},{"key":"X-Runtime","value":"0.087611"}],"cookie":[],"responseTime":null,"body":"{\n \"vendors\": [\n {\n \"id\": 1,\n \"name\": \"Riyad Abdu\",\n \"organization\": \"Sony\",\n \"email\": \"riyad.abdu@sony.sa\",\n \"phone_number\": \"0123456789\",\n \"tax_number\": \"123456789012345\",\n \"status\": \"Active\"\n },\n {\n \"id\": 3,\n \"name\": \"Saleh Alamri\",\n \"organization\": \"مؤسسة صالح العمري لبيع الجملة\",\n \"email\": \"saleh@alamri-wholesale.net\",\n \"phone_number\": \"0123456798\",\n \"tax_number\": \"543210987654321\",\n \"status\": \"Active\"\n }\n ]\n}"}],"_postman_id":"abd4baec-8100-4e95-8346-b4ed3ce30e25"},{"name":"Get a vendor","id":"11e99997-159f-471b-9ddc-6f97978c8523","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/vendors/1","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","vendors","1"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"ff2612c0-d441-4905-9109-30a91d2748d9","name":"Get a vendor","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/vendors/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 20:39:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"929230ab9f05628248cc94d5406acbfc\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"b3c5c903-ac5e-48ac-a558-467911ca7aac"},{"key":"X-Runtime","value":"0.086413"}],"cookie":[],"responseTime":null,"body":"{\n \"contact\": {\n \"id\": 1,\n \"name\": \"Riyad Abdu\",\n \"organization\": \"Sony\",\n \"email\": \"riyad.abdu@sony.sa\",\n \"phone_number\": \"0123456789\",\n \"tax_number\": \"123456789012345\",\n \"status\": \"Active\"\n }\n}"}],"_postman_id":"11e99997-159f-471b-9ddc-6f97978c8523"},{"name":"Create a vendor","id":"57e10d35-5fb8-4443-87b2-227957cb032d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \"contact\": { \n \"name\": \"Saleh Alamri\",\n \"organization\": \"مؤسسة صالح العمري لبيع الجملة\",\n \"email\": \"saleh@alamri-wholesale.net\",\n \"phone_number\": \"0123456798\",\n \"tax_number\": \"543210987654321\"\n }\n}"},"url":"https://www.qoyod.com/2.0/vendors","description":"

Parameters

\n
    \n
  1. name(required)
    2. \n
  2. organization(optional)
    3. \n
  3. phone_number(optional)
    4. \n
  4. email(optional)
    5. \n
  5. status(optional): \"Active\" or \"Inactive\", defaults to \"Active\".
    6. \n
\n","urlObject":{"path":["2.0","vendors"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"20ebdb43-48ec-4f3b-abc8-dee23bc87afd","name":"Create a vendor","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \"contact\": { \n \"name\": \"Saleh Alamri\",\n \"organization\": \"مؤسسة صالح العمري لبيع الجملة\",\n \"email\": \"saleh@alamri-wholesale.net\",\n \"phone_number\": \"0123456798\",\n \"tax_number\": \"543210987654321\"\n }\n}"},"url":"https://www.qoyod.com/2.0/vendors"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 20:38:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"201 Created"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"aba2587a16eb468e238246aa0473840a\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"1a88fb64-fd83-43b0-858a-d0367fadd9ae"},{"key":"X-Runtime","value":"0.187610"}],"cookie":[],"responseTime":null,"body":"{\n \"contact\": {\n \"id\": 3,\n \"name\": \"Saleh Alamri\",\n \"organization\": \"مؤسسة صالح العمري لبيع الجملة\",\n \"email\": \"saleh@alamri-wholesale.net\",\n \"phone_number\": \"0123456798\",\n \"tax_number\": \"543210987654321\",\n \"status\": \"Active\"\n }\n}"},{"id":"c86d7176-5c8e-40d3-b0fb-161708f2a2a5","name":"Create a vendor","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{ \n \"contact\": [{ \n \"name\": \"Saleh Alamri\",\n \"organization\": \"مؤسسة صالح العمري لبيع الجملة\",\n \"email\": \"saleh@alamri-wholesale.net\",\n \"phone_number\": \"0123456798\",\n \"tax_number\": \"543210987654321\"\n },\n { \n \"name\": \"Hasan Ahmadi\",\n \"organization\": \"مؤسسة حسن أحمدي للتجارة\",\n \"email\": \"hasan@ahmadi-trade.org\",\n \"phone_number\": \"0123456798\",\n \"tax_number\": \"456789123654987\"\n }]\n}"},"url":"https://www.qoyod.com/2.0/vendors"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Mar 2020 11:12:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"87e168bc22d54736bda955d2dfe5ead7\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"8432e6fc-751d-4420-a301-567fc5cb73ba"},{"key":"X-Runtime","value":"0.193738"}],"cookie":[],"responseTime":null,"body":"{\n \"contacts\": [\n {\n \"id\": 7,\n \"name\": \"Saleh Alamri\",\n \"organization\": \"مؤسسة صالح العمري لبيع الجملة\",\n \"email\": \"saleh@alamri-wholesale.net\",\n \"phone_number\": \"0123456798\",\n \"tax_number\": \"543210987654321\",\n \"status\": \"Active\"\n },\n {\n \"id\": 8,\n \"name\": \"Hasan Ahmadi\",\n \"organization\": \"مؤسسة حسن أحمدي للتجارة\",\n \"email\": \"hasan@ahmadi-trade.org\",\n \"phone_number\": \"0123456798\",\n \"tax_number\": \"456789123654987\",\n \"status\": \"Active\"\n }\n ]\n}"}],"_postman_id":"57e10d35-5fb8-4443-87b2-227957cb032d"},{"name":"Update a vendor","id":"92678c60-57f9-4f43-9e5d-8fd2cbb08d4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"phone_number\": \"02245612301\"\n }\n}"},"url":"https://www.qoyod.com/2.0/vendors/1","description":"

Enter only the parameters you wish to change

\n

Parameters

\n
    \n
  1. name
    2. \n
  2. organization
    3. \n
  3. phone_number
    4. \n
  4. email
    5. \n
  5. status \"Active\" or \"Inactive\".
    6. \n
\n","urlObject":{"path":["2.0","vendors","1"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"9e3f151a-40f6-43b5-8121-6995e0dfcae0","name":"Update a vendor","originalRequest":{"method":"PUT","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n \"phone_number\": \"02245612301\"\n }\n}"},"url":"https://www.qoyod.com/2.0/vendors/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 20:52:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"37ed918894a31d4363caa1aec7ee59fb\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"0df07fc0-7ee3-4a8a-8397-674db7acd685"},{"key":"X-Runtime","value":"0.070542"}],"cookie":[],"responseTime":null,"body":"{\n \"contact\": {\n \"id\": 1,\n \"name\": \"Riyad Abdu\",\n \"organization\": \"Sony\",\n \"email\": \"riyad.abdu@sony.sa\",\n \"phone_number\": \"02245612301\",\n \"tax_number\": \"123456789012345\",\n \"status\": \"Active\"\n }\n}"}],"_postman_id":"92678c60-57f9-4f43-9e5d-8fd2cbb08d4f"}],"id":"2d32a6a1-72d3-4a63-8c18-074ed5ba69b5","_postman_id":"2d32a6a1-72d3-4a63-8c18-074ed5ba69b5","description":""},{"name":"Purchase Orders","item":[{"name":"All orders","id":"d0d0e297-2ba8-4d7f-b1ed-1085b2b61e55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/orders","urlObject":{"path":["2.0","orders"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"a16704b0-d185-4ab8-bc56-8c2a32b45931","name":"All orders","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:03:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"33f7584c305e3dfc10adad2a7d106c11\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"70dbc6ca-0c1b-4b96-b723-7b7937676fb6"},{"key":"X-Runtime","value":"0.129480"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"orders\": [\n {\n \"id\": 10,\n \"contact_id\": 1,\n \"reference\": \"ORD1\",\n \"issue_date\": \"2019-10-30\",\n \"expiry_date\": \"2019-10-31\",\n \"status\": \"Billed\",\n \"total_amount\": \"40010.25\",\n \"notes\": \"\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 2,\n \"product_name\": \"Huawei Tablet\",\n \"description\": \"تابلت هواوي درجة أولى\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"1000.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"total\": \"21000.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"جوال سامسوتج جميل جدا\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"850.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"total\": \"17850.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 4,\n \"product_name\": \"Wireless Headphone\",\n \"description\": \"سماعة بلوتوث\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"55.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"total\": \"1155.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 8,\n \"product_name\": \"SIM Pin\",\n \"description\": \"يفك أزمات\",\n \"quantity\": \"5.0\",\n \"unit_price\": \"1.0\",\n \"unit_type\": 8,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"total\": \"5.25\",\n \"inventory_id\": 1\n }\n ]\n },\n {\n \"id\": 11,\n \"contact_id\": 1,\n \"reference\": \"ORD2\",\n \"issue_date\": \"2019-10-30\",\n \"expiry_date\": \"2019-10-31\",\n \"status\": \"Billed\",\n \"total_amount\": \"38855.25\",\n \"notes\": \"\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 2,\n \"product_name\": \"Huawei Tablet\",\n \"description\": \"تابلت هواوي درجة أولى\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"1000.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"total\": \"21000.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"جوال سامسوتج جميل جدا\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"850.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"total\": \"17850.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 8,\n \"product_name\": \"SIM Pin\",\n \"description\": \"يفك أزمات\",\n \"quantity\": \"5.0\",\n \"unit_price\": \"1.0\",\n \"unit_type\": 8,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"total\": \"5.25\",\n \"inventory_id\": 1\n }\n ]\n },\n {\n \"id\": 12,\n \"contact_id\": 1,\n \"reference\": \"order3421\",\n \"issue_date\": \"2019-10-30\",\n \"expiry_date\": \"2019-10-31\",\n \"status\": \"Approved\",\n \"total_amount\": \"23037.53\",\n \"notes\": \"القبول خلال يوم عمل\",\n \"terms_conditions\": null,\n \"line_items\": [\n {\n \"product_id\": 2,\n \"product_name\": \"Huawei Tablet\",\n \"description\": \"تابلت هواوي درجة أولى\",\n \"quantity\": \"13.0\",\n \"unit_price\": \"1000.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"3.15\",\n \"discount_amount\": \"409.5\",\n \"tax_percent\": \"5.0\",\n \"total\": \"13220.03\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"جوال سامسوتج خمسة انش\",\n \"quantity\": \"11.0\",\n \"unit_price\": \"850.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"total\": \"9817.5\",\n \"inventory_id\": 1\n }\n ]\n }\n ]\n}"}],"_postman_id":"d0d0e297-2ba8-4d7f-b1ed-1085b2b61e55"},{"name":"Get an order","id":"a4cb6e85-d133-4e89-a2e6-23e9cb215b90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/orders/10","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","orders","10"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"12447027-1fcf-42ba-b2c1-04df1a9e82fa","name":"Get an order","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/orders/10"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:04:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"d30c49e31f629811d8814431ebf4b9b5\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"2af8e482-4c58-4b71-b14c-12c6e7652bd2"},{"key":"X-Runtime","value":"0.100460"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"order\": {\n \"id\": 10,\n \"contact_id\": 1,\n \"reference\": \"ORD1\",\n \"issue_date\": \"2019-10-30\",\n \"expiry_date\": \"2019-10-31\",\n \"status\": \"Billed\",\n \"total_amount\": \"40010.25\",\n \"notes\": \"\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 2,\n \"product_name\": \"Huawei Tablet\",\n \"description\": \"تابلت هواوي درجة أولى\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"1000.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"total\": \"21000.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"جوال سامسوتج جميل جدا\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"850.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"total\": \"17850.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 4,\n \"product_name\": \"Wireless Headphone\",\n \"description\": \"سماعة بلوتوث\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"55.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"total\": \"1155.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 8,\n \"product_name\": \"SIM Pin\",\n \"description\": \"يفك أزمات\",\n \"quantity\": \"5.0\",\n \"unit_price\": \"1.0\",\n \"unit_type\": 8,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"total\": \"5.25\",\n \"inventory_id\": 1\n }\n ]\n }\n}"}],"_postman_id":"a4cb6e85-d133-4e89-a2e6-23e9cb215b90"},{"name":"Create an order","id":"574c3549-82f2-4dc3-aeed-4c10bd080e05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"contact_id\": 1,\n \"reference\": \"order3422\",\n \"issue_date\": \"2021-01-11\",\n \"expiry_date\": \"2021-01-12\",\n \"status\": \"Approved\",\n\t\t\"inventory_id\": 1,\n \"notes\": \"القبول خلال يوم عمل\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 2,\n \"description\": \"تابلت هواوي درجة أولى\",\n \"quantity\": 13,\n \"unit_price\": 1000,\n \"discount\": 3.15,\n \"discount_type\": \"percentage\",\n \"tax_percent\": 15\n },\n {\n \"product_id\": 1,\n \"description\": \"جوال سامسوتج خمسة انش\",\n \"quantity\": 11.0,\n \"unit_price\": 850.0,\n \"discount\": 20,\n \"discount_type\": \"amount\",\n \"tax_percent\": 15\n },\n {\n \"product_id\": 4,\n \"quantity\": 1,\n \"unit_price\": 200.0,\n \"tax_percent\": 15\n }\n ]\n }\n}"},"url":"https://www.qoyod.com/2.0/orders","description":"

Parameters

\n
    \n
  1. contact_id(required): The id of the vendor you are purchasing from.
    2. \n
  2. issue_date(required): The issue date of the purchase order, format: yyyy-mm-dd
    3. \n
  3. expiry_date(required): The due date of the purchase order, format: yyyy-mm-dd
    4. \n
  4. status(required): The status of the purchase order, can be Draft or Approved
    5. \n
  5. inventory_id(required)
    6. \n
  6. notes(optional)
    7. \n
  7. terms_conditions(optional)
    8. \n
  8. line_items: An array of line items, each line item follows this format:
      \n
    1. product_id(required)
      2. \n
    2. unit_type(optional): unit type id of the product, defaults to the product's default unit type.
      3. \n
    3. description(optional)
      4. \n
    4. quantity(required)
      5. \n
    5. unit_price(required)
      6. \n
    6. discount(optional)
      7. \n
    7. discount_type(optional): determines whether the discount above is a percentage or an amount, can be percentage or amount, defaults to percentage
      8. \n
    8. tax_percent(optional)
      9. \n
    9. is_inclusive(optional): set to true if the entered unit price is tax inclusive, defaults to false
      10. \n
    \n
    9. \n
  9. custom_fields(optional): Array of custom fields and their values to add to the purchase order, custom fields must already be added in the website's settings page
    10. \n
\n","urlObject":{"path":["2.0","orders"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"e94ada3c-14a3-4322-804d-119e552788a1","name":"Create an order","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"order\": {\n \"contact_id\": 1,\n \"reference\": \"order3422\",\n \"issue_date\": \"2021-01-11\",\n \"expiry_date\": \"2021-01-12\",\n \"status\": \"Approved\",\n\t\t\"inventory_id\": 1,\n \"notes\": \"القبول خلال يوم عمل\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 2,\n \"description\": \"تابلت هواوي درجة أولى\",\n \"quantity\": 13,\n \"unit_price\": 1000,\n \"discount\": 3.15,\n \"discount_type\": \"percentage\",\n \"tax_percent\": 15\n },\n {\n \"product_id\": 1,\n \"description\": \"جوال سامسوتج خمسة انش\",\n \"quantity\": 11.0,\n \"unit_price\": 850.0,\n \"discount\": 20,\n \"discount_type\": \"amount\",\n \"tax_percent\": 15\n },\n {\n \"product_id\": 4,\n \"quantity\": 1,\n \"unit_price\": 200.0,\n \"tax_percent\": 15\n }\n ]\n }\n}"},"url":"https://www.qoyod.com/2.0/orders"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:36:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"36ec1e7b064cad00f75076fccf884ab3\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"3b8f454c-d89c-4dcf-b4f7-ed5b24904fea"},{"key":"X-Runtime","value":"0.502225"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"order\": {\n \"id\": 19,\n \"contact_id\": 1,\n \"reference\": \"order3422\",\n \"issue_date\": \"2021-01-11\",\n \"expiry_date\": \"2021-01-12\",\n \"status\": \"Approved\",\n \"total_amount\": \"25438.58\",\n \"notes\": \"القبول خلال يوم عمل\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 2,\n \"product_name\": \"Huawei Tablet\",\n \"description\": \"تابلت هواوي درجة أولى\",\n \"quantity\": \"13.0\",\n \"unit_price\": \"1000.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"3.15\",\n \"discount_amount\": \"409.5\",\n \"tax_percent\": \"15.0\",\n \"total\": \"14479.08\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"جوال سامسوتج خمسة انش\",\n \"quantity\": \"11.0\",\n \"unit_price\": \"850.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.21\",\n \"discount_amount\": \"20.0\",\n \"tax_percent\": \"15.0\",\n \"total\": \"10729.5\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 4,\n \"product_name\": \"Wireless Headphone\",\n \"description\": null,\n \"quantity\": \"1.0\",\n \"unit_price\": \"200.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"15.0\",\n \"total\": \"230.0\",\n \"inventory_id\": 1\n }\n ],\n \"custom_fields\": {\n \"customfield1\": \"custom value 1\",\n \"customfield2\": \"custom value 2\"\n }\n }\n}"}],"_postman_id":"574c3549-82f2-4dc3-aeed-4c10bd080e05"}],"id":"6cdfab78-3ca6-4670-ba41-88b593ff0eeb","event":[{"listen":"prerequest","script":{"id":"799b0199-0a56-4ed6-987a-6d57d952d8ac","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ec50aafe-967c-455d-8c79-315c1cebbb36","type":"text/javascript","exec":[""]}}],"_postman_id":"6cdfab78-3ca6-4670-ba41-88b593ff0eeb","description":""},{"name":"Bills","item":[{"name":"Get All bills","id":"96eb0b33-8308-4056-a4f1-697a6b4d7e30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/bills","urlObject":{"path":["2.0","bills"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"f5767cc9-8470-48ab-9192-5974c060980b","name":"Get All bills","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/bills"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:46:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"ed2310787f0600fa2b516db90e8de231\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"397fdae1-0426-4265-a4f1-4988ce8f14af"},{"key":"X-Runtime","value":"0.046192"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"bills\": [\n {\n \"id\": 15,\n \"status\": \"Partially Paid\",\n \"issue_date\": \"2019-10-30\",\n \"due_date\": \"2019-10-31\",\n \"total\": \"38855.25\",\n \"paid_amount\": \"5030.0\",\n \"due_amount\": \"33825.25\",\n \"reference\": \"4597231\",\n \"notes\": \"\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 2,\n \"product_name\": \"Huawei Tablet\",\n \"description\": \"تابلت هواوي درجة أولى\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"1000.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax\": \"5.0\",\n \"line_total\": \"21000.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"جوال سامسوتج جميل جدا\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"850.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax\": \"5.0\",\n \"line_total\": \"17850.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 8,\n \"product_name\": \"SIM Pin\",\n \"description\": \"يفك أزمات\",\n \"quantity\": \"5.0\",\n \"unit_price\": \"1.0\",\n \"unit_type\": 8,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax\": \"5.0\",\n \"line_total\": \"5.25\",\n \"inventory_id\": 1\n }\n ],\n \"payments\": [\n {\n \"id\": 9,\n \"amount\": \"5000.0\",\n \"date\": \"2019-10-30\",\n \"source_id\": 8,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 15,\n \"allocatee_type\": \"Bill\"\n },\n {\n \"id\": 12,\n \"amount\": \"30.0\",\n \"date\": \"2019-10-30\",\n \"source_id\": 7,\n \"source_type\": \"DebitNote\",\n \"allocatee_id\": 15,\n \"allocatee_type\": \"Bill\"\n }\n ],\n \"contact\": {\n \"id\": 1,\n \"name\": \"Riyad Abdu\",\n \"organization\": \"Sony\",\n \"email\": \"riyad.abdu@sony.sa\",\n \"phone_number\": \"02245612301\",\n \"tax_number\": \"123456789012345\",\n \"status\": \"Active\"\n }\n },\n {\n \"id\": 20,\n \"status\": \"Approved\",\n \"issue_date\": \"2021-01-11\",\n \"due_date\": \"2021-02-11\",\n \"total\": \"34500.0\",\n \"paid_amount\": \"0.0\",\n \"due_amount\": \"34500.0\",\n \"reference\": \"APIbill-1\",\n \"notes\": null,\n \"terms_conditions\": null,\n \"line_items\": [\n {\n \"product_id\": 7,\n \"product_name\": \"Rent\",\n \"description\": \"اجار المحل\",\n \"quantity\": \"1.0\",\n \"unit_price\": \"30000.0\",\n \"unit_type\": 9,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax\": \"15.0\",\n \"line_total\": \"34500.0\",\n \"inventory_id\": 1\n }\n ],\n \"payments\": [],\n \"contact\": {\n \"id\": 1,\n \"name\": \"Riyad Abdu\",\n \"organization\": \"Sony\",\n \"email\": \"riyad.abdu@sony.sa\",\n \"phone_number\": \"02245612301\",\n \"tax_number\": \"123456789012345\",\n \"status\": \"Active\"\n }\n },\n {\n \"id\": 4,\n \"status\": \"Paid\",\n \"issue_date\": \"2019-10-30\",\n \"due_date\": \"2019-10-31\",\n \"total\": \"37242.98\",\n \"paid_amount\": \"37242.98\",\n \"due_amount\": \"0.0\",\n \"reference\": \"BIL14346\",\n \"notes\": \"

الدفع عبر التحويل فقط

\",\n \"terms_conditions\": \"

مهنا استرجاع

\",\n \"line_items\": [\n {\n \"product_id\": 2,\n \"product_name\": \"Huawei Tablet\",\n \"description\": \"\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"1000.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"5.0\",\n \"discount_amount\": \"1000.0\",\n \"tax\": \"5.0\",\n \"line_total\": \"19950.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"850.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"3.15\",\n \"discount_amount\": \"535.5\",\n \"tax\": \"5.0\",\n \"line_total\": \"17287.73\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 8,\n \"product_name\": \"SIM Pin\",\n \"description\": \"\",\n \"quantity\": \"5.0\",\n \"unit_price\": \"1.0\",\n \"unit_type\": 8,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax\": \"5.0\",\n \"line_total\": \"5.25\",\n \"inventory_id\": 1\n }\n ],\n \"payments\": [\n {\n \"id\": 8,\n \"amount\": \"37242.98\",\n \"date\": \"2021-01-07\",\n \"source_id\": 7,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 4,\n \"allocatee_type\": \"Bill\"\n }\n ],\n \"contact\": {\n \"id\": 1,\n \"name\": \"Riyad Abdu\",\n \"organization\": \"Sony\",\n \"email\": \"riyad.abdu@sony.sa\",\n \"phone_number\": \"02245612301\",\n \"tax_number\": \"123456789012345\",\n \"status\": \"Active\"\n }\n }\n ]\n}"}],"_postman_id":"96eb0b33-8308-4056-a4f1-697a6b4d7e30"},{"name":"Get a bill","id":"d52637d3-4b62-4a7a-a077-919cfe76699a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/bills/15","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","bills","15"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"00262114-9d16-44b2-9966-e268133531f9","name":"Get a bill","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/bills/15"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:47:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"1a84f6ec2984bd02b59cdad7e8d88dba\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"26b3068c-02ff-41d2-bd7a-436379530d70"},{"key":"X-Runtime","value":"0.241141"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"bill\": {\n \"id\": 15,\n \"status\": \"Partially Paid\",\n \"issue_date\": \"2019-10-30\",\n \"due_date\": \"2019-10-31\",\n \"total\": \"38855.25\",\n \"paid_amount\": \"5030.0\",\n \"due_amount\": \"33825.25\",\n \"reference\": \"4597231\",\n \"notes\": \"\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 2,\n \"product_name\": \"Huawei Tablet\",\n \"description\": \"تابلت هواوي درجة أولى\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"1000.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax\": \"5.0\",\n \"line_total\": \"21000.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"جوال سامسوتج جميل جدا\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"850.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax\": \"5.0\",\n \"line_total\": \"17850.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 8,\n \"product_name\": \"SIM Pin\",\n \"description\": \"يفك أزمات\",\n \"quantity\": \"5.0\",\n \"unit_price\": \"1.0\",\n \"unit_type\": 8,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax\": \"5.0\",\n \"line_total\": \"5.25\",\n \"inventory_id\": 1\n }\n ],\n \"payments\": [\n {\n \"id\": 9,\n \"amount\": \"5000.0\",\n \"date\": \"2019-10-30\",\n \"source_id\": 8,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 15,\n \"allocatee_type\": \"Bill\"\n },\n {\n \"id\": 12,\n \"amount\": \"30.0\",\n \"date\": \"2019-10-30\",\n \"source_id\": 7,\n \"source_type\": \"DebitNote\",\n \"allocatee_id\": 15,\n \"allocatee_type\": \"Bill\"\n }\n ],\n \"contact\": {\n \"id\": 1,\n \"name\": \"Riyad Abdu\",\n \"organization\": \"Sony\",\n \"email\": \"riyad.abdu@sony.sa\",\n \"phone_number\": \"02245612301\",\n \"tax_number\": \"123456789012345\",\n \"status\": \"Active\"\n }\n }\n}"}],"_postman_id":"d52637d3-4b62-4a7a-a077-919cfe76699a"},{"name":"Create a bill","id":"b94ee8e3-27b2-4942-b8d7-4253ab4087b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"bill\": {\n\t\t\"contact_id\": 1,\n \"status\": \"Approved\",\n \"issue_date\": \"2021-01-11\",\n \"due_date\": \"2021-02-11\",\n \"reference\": \"APIbill-1\",\n\t\t\"inventory_id\": 1,\n \"line_items\": [\n {\n \"product_id\": 7,\n \"description\": \"اجار المحل\",\n \"quantity\": 1,\n \"unit_price\": 30000,\n \"discount\": \"0\",\n \"tax_percent\": \"15\"\n }\n ],\n \"custom_fields\": {\n \"customfield1\": \"custom value 1\",\n \"customfield2\": \"custom value 2\"\n }\n }\n}"},"url":"https://www.qoyod.com/2.0/bills","description":"

Parameters

\n
    \n
  1. contact_id(required): The id of the vendor you are buying from.
    2. \n
  2. status(required): The status of the bill, can be Draft or Approved.
    3. \n
  3. issue_date(required): The issue date of the bill, format: yyyy-mm-dd.
    4. \n
  4. due_date(required): The due date of the bill, format: yyyy-mm-dd.
    5. \n
  5. reference(optional, unique): A unique reference for the bill, will be autogenerated if not sent.
    6. \n
  6. inventory_id(required)
    7. \n
  7. line_items(required): An array of line items in the bill, each line item follows this format:
      \n
    1. product_id(required)
      2. \n
    2. description(optional)
      3. \n
    3. quantity(required)
      4. \n
    4. unit_price(required)
      5. \n
    5. unit_type(optional): unit type id of the product, defaults to the product's default unit type.
      6. \n
    6. discount(optional)
      7. \n
    7. discount_type(optional): determines whether the discount above is a percentage or an amount, can be percentage or amount, defaults to percentage
      8. \n
    8. tax_percent(optional)
      9. \n
    9. is_inclusive(optional): set to true if the entered unit price is tax inclusive, defaults to false
      10. \n
    \n
    8. \n
  8. custom_fields(optional): Array of custom fields and their values to add to the bill, custom fields must already be added in the website's settings page
    9. \n
\n","urlObject":{"path":["2.0","bills"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"b623b103-1fd1-48c8-b714-0c70ed76b584","name":"Create a bill","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"bill\": {\n\t\t\"contact_id\": 1,\n \"status\": \"Approved\",\n \"issue_date\": \"2021-01-11\",\n \"due_date\": \"2021-02-11\",\n \"reference\": \"APIbill-1\",\n\t\t\"inventory_id\": 1,\n \"line_items\": [\n {\n \"product_id\": 7,\n \"description\": \"اجار المحل\",\n \"quantity\": 1,\n \"unit_price\": 30000,\n \"discount\": \"0\",\n \"tax_percent\": \"15\"\n }\n ]\n }\n}"},"url":"https://www.qoyod.com/2.0/bills"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:44:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"a2363c2c7037250f749dd2e4793afaf4\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"4eefab13-0957-4eb2-b218-f8bdba7a12b4"},{"key":"X-Runtime","value":"0.546578"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"bill\": {\n \"id\": 20,\n \"status\": \"Approved\",\n \"issue_date\": \"2021-01-11\",\n \"due_date\": \"2021-02-11\",\n \"total\": \"34500.0\",\n \"paid_amount\": \"0.0\",\n \"due_amount\": \"34500.0\",\n \"reference\": \"APIbill-1\",\n \"notes\": null,\n \"terms_conditions\": null,\n \"line_items\": [\n {\n \"product_id\": 7,\n \"product_name\": \"Rent\",\n \"description\": \"اجار المحل\",\n \"quantity\": \"1.0\",\n \"unit_price\": \"30000.0\",\n \"unit_type\": 9,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax\": \"15.0\",\n \"line_total\": \"34500.0\",\n \"inventory_id\": 1\n }\n ],\n \"payments\": [],\n \"contact\": {\n \"id\": 1,\n \"name\": \"Riyad Abdu\",\n \"organization\": \"Sony\",\n \"email\": \"riyad.abdu@sony.sa\",\n \"phone_number\": \"02245612301\",\n \"tax_number\": \"123456789012345\",\n \"status\": \"Active\"\n }\n }\n}"}],"_postman_id":"b94ee8e3-27b2-4942-b8d7-4253ab4087b7"},{"name":"Delete a bill","id":"901b28f3-69a5-4907-8719-6b9cb6a2e4a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/bills/1","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","bills","1"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"7dba66cb-4bbe-4db0-8b9a-82105e25824b","name":"Delete a bill","originalRequest":{"method":"DELETE","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/bills/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jan 2020 13:10:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"cf83d280cebf911a84758313c258d53e\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"37fbbed1-c370-421f-a0e9-a485a51f1845"},{"key":"X-Runtime","value":"0.303796"}],"cookie":[],"responseTime":null,"body":"Bill destroyed successfully"}],"_postman_id":"901b28f3-69a5-4907-8719-6b9cb6a2e4a5"}],"id":"500f2b63-e380-4339-b9e0-d32dca13c11a","_postman_id":"500f2b63-e380-4339-b9e0-d32dca13c11a","description":""},{"name":"Simple Bills","item":[{"name":"Get All simple bills","id":"47e4efc4-59ad-4337-9fe8-cf8fbac38031","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/simple_bills","urlObject":{"path":["2.0","simple_bills"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"757a0a93-380b-4923-b281-604825c66747","name":"Get All simple bills","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/simple_bills"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:46:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"ed2310787f0600fa2b516db90e8de231\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"397fdae1-0426-4265-a4f1-4988ce8f14af"},{"key":"X-Runtime","value":"0.046192"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"simple_bills\": [\n {\n \"id\": 24,\n \"status\": \"Partially Paid\",\n \"issue_date\": \"2024-12-22\",\n \"total\": \"115.0\",\n \"paid_amount\": \"45.0\",\n \"due_amount\": \"70.0\",\n \"reference\": \"SBill1\",\n \"created_at\": \"2024-12-22T08:29:11.000+03:00\",\n \"updated_at\": \"2025-04-27T13:06:50.000+03:00\",\n \"created_by\": \"kapil@qoyod.com\",\n \"line_items\": [\n {\n \"id\": 1,\n \"description\": \"Test\",\n \"project_id\": null,\n \"total_amount\": \"100.0\",\n \"tax\": 15.0,\n \"line_total\": \"115.0\",\n \"inventory_id\": 1,\n \"is_inclusive\": false,\n \"unrounded_vat_value\": \"15.0\",\n \"expense_account\": {\n \"id\": 12,\n \"en_name\": \"Cost of goods sold\",\n \"created_at\": \"2024-12-01T12:48:15.000+03:00\",\n \"updated_at\": \"2024-12-01T12:48:15.000+03:00\",\n \"ar_description\": \"تكلفة البضاعة المباعة\",\n \"code\": \"5101\",\n \"is_locked\": false,\n \"receive_payments\": false,\n \"status\": \"Active\",\n \"type_of_account\": \"Debit\",\n \"ar_name\": \"تكلفة البضاعة المباعة\",\n \"parent_id\": 56,\n \"deleted_at\": null,\n \"parent_kind\": \"expense\",\n \"branch_kind\": \"direct_cost\",\n \"account_kind\": \"cost_of_sales\",\n \"en_description\": \"Cost of good sold\"\n }\n }\n ],\n \"payments\": [\n {\n \"id\": 62,\n \"amount\": \"5.0\",\n \"date\": \"2024-12-25\",\n \"source_id\": 38,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 24,\n \"allocatee_type\": \"SimpleBill\",\n \"created_at\": \"2024-12-26T13:33:21.000+03:00\",\n \"updated_at\": \"2024-12-26T13:33:21.000+03:00\"\n },\n {\n \"id\": 87,\n \"amount\": \"5.0\",\n \"date\": \"2019-10-30\",\n \"source_id\": 50,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 24,\n \"allocatee_type\": \"SimpleBill\",\n \"created_at\": \"2025-04-27T12:38:00.000+03:00\",\n \"updated_at\": \"2025-04-27T12:38:00.000+03:00\"\n },\n {\n \"id\": 88,\n \"amount\": \"10.0\",\n \"date\": \"2025-02-24\",\n \"source_id\": 47,\n \"source_type\": \"DebitNote\",\n \"allocatee_id\": 24,\n \"allocatee_type\": \"SimpleBill\",\n \"created_at\": \"2025-04-27T12:44:56.000+03:00\",\n \"updated_at\": \"2025-04-27T12:44:56.000+03:00\"\n },\n {\n \"id\": 89,\n \"amount\": \"10.0\",\n \"date\": \"2025-02-24\",\n \"source_id\": 47,\n \"source_type\": \"DebitNote\",\n \"allocatee_id\": 24,\n \"allocatee_type\": \"SimpleBill\",\n \"created_at\": \"2025-04-27T12:46:09.000+03:00\",\n \"updated_at\": \"2025-04-27T12:46:09.000+03:00\"\n },\n {\n \"id\": 90,\n \"amount\": \"5.0\",\n \"date\": \"2019-10-30\",\n \"source_id\": 51,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 24,\n \"allocatee_type\": \"SimpleBill\",\n \"created_at\": \"2025-04-27T13:05:36.000+03:00\",\n \"updated_at\": \"2025-04-27T13:05:36.000+03:00\"\n },\n {\n \"id\": 91,\n \"amount\": \"10.0\",\n \"date\": \"2025-02-24\",\n \"source_id\": 47,\n \"source_type\": \"DebitNote\",\n \"allocatee_id\": 24,\n \"allocatee_type\": \"SimpleBill\",\n \"created_at\": \"2025-04-27T13:06:50.000+03:00\",\n \"updated_at\": \"2025-04-27T13:06:50.000+03:00\"\n }\n ],\n \"contact\": {\n \"id\": 3,\n \"name\": \"Vendor 3\",\n \"organization\": \"\",\n \"status\": \"Active\",\n \"created_at\": \"2024-12-15T10:59:48.000+03:00\",\n \"updated_at\": \"2024-12-15T10:59:48.000+03:00\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"secondary_phone_number\": null,\n \"tax_number\": \"\",\n \"custom_fields\": {},\n \"customer_details\": {},\n \"website\": null,\n \"pos\": true,\n \"government_entity\": false,\n \"billing_address\": null,\n \"shipping_address\": null,\n \"bank\": null\n }\n },\n {\n \"id\": 48,\n \"status\": \"Approved\",\n \"issue_date\": \"2025-02-25\",\n \"total\": \"23.0\",\n \"paid_amount\": \"0.0\",\n \"due_amount\": \"23.0\",\n \"reference\": \"SBill2\",\n \"created_at\": \"2025-02-25T10:17:04.000+03:00\",\n \"updated_at\": \"2025-02-25T10:17:17.000+03:00\",\n \"created_by\": \"kapil@qoyod.com\",\n \"line_items\": [\n {\n \"id\": 2,\n \"description\": \"Test\",\n \"project_id\": null,\n \"total_amount\": \"20.0\",\n \"tax\": 15.0,\n \"line_total\": \"23.0\",\n \"inventory_id\": 1,\n \"is_inclusive\": false,\n \"unrounded_vat_value\": \"3.0\",\n \"expense_account\": {\n \"id\": 12,\n \"en_name\": \"Cost of goods sold\",\n \"created_at\": \"2024-12-01T12:48:15.000+03:00\",\n \"updated_at\": \"2024-12-01T12:48:15.000+03:00\",\n \"ar_description\": \"تكلفة البضاعة المباعة\",\n \"code\": \"5101\",\n \"is_locked\": false,\n \"receive_payments\": false,\n \"status\": \"Active\",\n \"type_of_account\": \"Debit\",\n \"ar_name\": \"تكلفة البضاعة المباعة\",\n \"parent_id\": 56,\n \"deleted_at\": null,\n \"parent_kind\": \"expense\",\n \"branch_kind\": \"direct_cost\",\n \"account_kind\": \"cost_of_sales\",\n \"en_description\": \"Cost of good sold\"\n }\n }\n ],\n \"payments\": [],\n \"contact\": {\n \"id\": 3,\n \"name\": \"Vendor 3\",\n \"organization\": \"\",\n \"status\": \"Active\",\n \"created_at\": \"2024-12-15T10:59:48.000+03:00\",\n \"updated_at\": \"2024-12-15T10:59:48.000+03:00\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"secondary_phone_number\": null,\n \"tax_number\": \"\",\n \"custom_fields\": {},\n \"customer_details\": {}, \"website\": null,\n \"pos\": true,\n \"government_entity\": false,\n \"billing_address\": null,\n \"shipping_address\": null,\n \"bank\": null\n }\n }\n ]\n}"}],"_postman_id":"47e4efc4-59ad-4337-9fe8-cf8fbac38031"},{"name":"Get a simple bill","id":"bb913729-5f86-4f88-abac-0e925b41ab4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/simple_bills/15","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","simple_bills","15"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"8a126628-ff86-436b-a432-19a0bedcafa3","name":"Get a simple bill","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/simple_bills/15"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:47:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"1a84f6ec2984bd02b59cdad7e8d88dba\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"26b3068c-02ff-41d2-bd7a-436379530d70"},{"key":"X-Runtime","value":"0.241141"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"simple_bill\": {\n \"id\": 70,\n \"status\": \"Draft\",\n \"issue_date\": \"2021-01-11\",\n \"total\": \"3450.0\",\n \"paid_amount\": \"0.0\",\n \"due_amount\": \"3450.0\",\n \"reference\": \"SBill7\",\n \"created_at\": \"2025-04-27T12:59:41.000+03:00\",\n \"updated_at\": \"2025-04-27T12:59:41.000+03:00\",\n \"created_by\": \"\",\n \"line_items\": [\n {\n \"id\": 20,\n \"description\": \"اجار المحل\",\n \"project_id\": null,\n \"total_amount\": \"3000.0\",\n \"tax\": 15.0,\n \"line_total\": \"3450.0\",\n \"inventory_id\": 1,\n \"is_inclusive\": false,\n \"unrounded_vat_value\": \"450.0\",\n \"expense_account\": {\n \"id\": 7,\n \"en_name\": \"Cash on hand\",\n \"created_at\": \"2024-12-01T12:48:13.000+03:00\",\n \"updated_at\": \"2024-12-01T12:48:13.000+03:00\",\n \"ar_description\": \"النقدية في الخزينة\",\n \"code\": \"110101\",\n \"is_locked\": false,\n \"receive_payments\": true,\n \"status\": \"Active\",\n \"type_of_account\": \"Debit\",\n \"ar_name\": \"النقدية في الخزينة\",\n \"parent_id\": 29,\n \"deleted_at\": null,\n \"parent_kind\": \"assets\",\n \"branch_kind\": \"current_assets\",\n \"account_kind\": \"non_bank_cash_and_equivalents\",\n \"en_description\": \"Cash in hand\"\n }\n }\n ],\n \"payments\": [],\n \"contact\": {\n \"id\": 1,\n \"name\": \"Vendor\",\n \"organization\": \"\",\n \"status\": \"Active\",\n \"created_at\": \"2024-12-01T12:49:19.000+03:00\",\n \"updated_at\": \"2024-12-01T12:49:19.000+03:00\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"secondary_phone_number\": null,\n \"tax_number\": \"\",\n \"custom_fields\": {},\n \"customer_details\": {},\n \"website\": null,\n \"pos\": true,\n \"government_entity\": false,\n \"billing_address\": null,\n \"shipping_address\": null,\n \"bank\": null\n }\n }\n}\n"}],"_postman_id":"bb913729-5f86-4f88-abac-0e925b41ab4f"},{"name":"Create a simple bill","id":"a63cdbbb-90d9-4a66-bc9e-0652d886cdee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"simple_bill\": {\n \"contact_id\": 1,\n \"status\": \"Draft\",\n \"issue_date\": \"2021-01-11\", \n \"inventory_id\": 1,\n \"simple_bill_items_attributes\": [\n {\n \"expense_category_id\": 7,\n \"description\": \"اجار المحل\",\n \"total_amount\": 3000,\n \"tax_id\": \"1\"\n }\n ]\n }\n}"},"url":"https://www.qoyod.com/2.0/simple_bills","description":"

Parameters

\n
    \n

  1. contact_id(required): The id of the vendor you are buying from.

    \n
    2. \n

  2. status(required): The status of the simple bill , can be Draft or Approved.

    \n
    3. \n

  3. issue_date(required): The issue date of the simple bill, format: yyyy-mm-dd.

    \n
    4. \n

  4. reference(optional, unique): A unique reference for the simple bill, will be autogenerated if not sent.

    \n
    5. \n

  5. inventory_id(required)

    \n
    6. \n

  6. simple_bill_items_attributes(required): An array of simple_bill_items_attributes in the simple bill, each simple_bill_item follows this format:

    \n
      \n

    1. expense_category_id(required)

      \n
      2. \n

    2. description(optional)

      \n
      3. \n

    3. total_amount(required)

      \n
      4. \n

    4. tax_id(required)

      \n
      5. \n

    5. is_inclusive(optional)

      \n
      6. \n
    \n
    7. \n

  7. custom_fields(optional): Array of custom fields and their values to add to the simple bill, custom fields must already be added in the website's settings page

    \n
    8. \n
\n","urlObject":{"path":["2.0","simple_bills"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"e67ca4e9-d638-4d0d-9ccb-e508a2e0b193","name":"Create a simple bill","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"simple_bill\": {\n \"contact_id\": 1,\n \"status\": \"Draft\",\n \"issue_date\": \"2021-01-11\", \n \"inventory_id\": 1,\n \"simple_bill_items_attributes\": [\n {\n \"expense_category_id\": 7,\n \"description\": \"اجار المحل\",\n \"total_amount\": 3000,\n \"tax_id\": \"1\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://www.qoyod.com/2.0/simple_bills"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:44:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"a2363c2c7037250f749dd2e4793afaf4\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"4eefab13-0957-4eb2-b218-f8bdba7a12b4"},{"key":"X-Runtime","value":"0.546578"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"simple_bill\": {\n \"id\": 71,\n \"status\": \"Draft\",\n \"issue_date\": \"2021-01-11\",\n \"total\": \"3450.0\",\n \"paid_amount\": \"0.0\",\n \"due_amount\": \"3450.0\",\n \"reference\": \"SBill8\",\n \"created_at\": \"2025-04-28T14:18:15.000+03:00\",\n \"updated_at\": \"2025-04-28T14:18:15.000+03:00\",\n \"created_by\": \"\",\n \"line_items\": [\n {\n \"id\": 21,\n \"description\": \"اجار المحل\",\n \"project_id\": null,\n \"total_amount\": \"3000.0\",\n \"tax\": 15.0,\n \"line_total\": \"3450.0\",\n \"inventory_id\": 1,\n \"is_inclusive\": false,\n \"unrounded_vat_value\": \"450.0\",\n \"expense_account\": {\n \"id\": 7,\n \"en_name\": \"Cash on hand\",\n \"created_at\": \"2024-12-01T12:48:13.000+03:00\",\n \"updated_at\": \"2024-12-01T12:48:13.000+03:00\",\n \"ar_description\": \"النقدية في الخزينة\",\n \"code\": \"110101\",\n \"is_locked\": false,\n \"receive_payments\": true,\n \"status\": \"Active\",\n \"type_of_account\": \"Debit\",\n \"ar_name\": \"النقدية في الخزينة\",\n \"parent_id\": 29,\n \"deleted_at\": null,\n \"parent_kind\": \"assets\",\n \"branch_kind\": \"current_assets\",\n \"account_kind\": \"non_bank_cash_and_equivalents\",\n \"en_description\": \"Cash in hand\"\n }\n }\n ],\n \"payments\": [],\n \"contact\": {\n \"id\": 1,\n \"name\": \"Vendor\",\n \"organization\": \"\",\n \"status\": \"Active\",\n \"created_at\": \"2024-12-01T12:49:19.000+03:00\",\n \"updated_at\": \"2024-12-01T12:49:19.000+03:00\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"secondary_phone_number\": null,\n \"tax_number\": \"\",\n \"custom_fields\": {},\n \"customer_details\": {},\n \"website\": null,\n \"pos\": true,\n \"government_entity\": false,\n \"billing_address\": null,\n \"shipping_address\": null,\n \"bank\": null\n }\n }\n}"}],"_postman_id":"a63cdbbb-90d9-4a66-bc9e-0652d886cdee"},{"name":"Update a simple bill","id":"9d90fdb3-f680-463c-8f70-0c00ba6efa50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PATCH","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"simple_bill\": { \n \"issue_date\": \"2021-01-15\" \n }\n}\n"},"url":"https://www.qoyod.com/2.0/simple_bills/2","description":"

Parameters

\n
    \n

  1. contact_id(required): The id of the vendor you are buying from.

    \n
    2. \n

  2. status(required): The status of the simple bill , can be Draft or Approved.

    \n
    3. \n

  3. issue_date(required): The issue date of the simple bill, format: yyyy-mm-dd.

    \n
    4. \n

  4. reference(optional, unique): A unique reference for the simple bill, will be autogenerated if not sent.

    \n
    5. \n

  5. inventory_id(required)

    \n
    6. \n

  6. simple_bill_items_attributes(required): An array of simple_bill_items_attributes in the simple bill, each simple_bill_item follows this format:

    \n
      \n

    1. expense_category_id(required)

      \n
      2. \n

    2. description(optional)

      \n
      3. \n

    3. total_amount(required)

      \n
      4. \n

    4. tax_id(required)

      \n
      5. \n

    5. is_inclusive(optional)

      \n
      6. \n
    \n
    7. \n

  7. custom_fields(optional): Array of custom fields and their values to add to the simple bill, custom fields must already be added in the website's settings page

    \n
    8. \n
\n","urlObject":{"path":["2.0","simple_bills","2"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"1ed7cba2-34a6-407b-80cd-8c13ec8a5a42","name":"Update a simple bill","originalRequest":{"method":"PATCH","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"simple_bill\": { \n \"issue_date\": \"2021-01-15\" \n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://www.qoyod.com/2.0/simple_bills/2"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:44:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"a2363c2c7037250f749dd2e4793afaf4\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"4eefab13-0957-4eb2-b218-f8bdba7a12b4"},{"key":"X-Runtime","value":"0.546578"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"simple_bill\": {\n \"id\": 71,\n \"status\": \"Draft\",\n \"issue_date\": \"2021-01-15\",\n \"total\": \"3450.0\",\n \"paid_amount\": \"0.0\",\n \"due_amount\": \"3450.0\",\n \"reference\": \"SBill8\",\n \"created_at\": \"2025-04-28T14:18:15.000+03:00\",\n \"updated_at\": \"2025-04-28T14:18:15.000+03:00\",\n \"created_by\": \"\",\n \"line_items\": [\n {\n \"id\": 21,\n \"description\": \"اجار المحل\",\n \"project_id\": null,\n \"total_amount\": \"3000.0\",\n \"tax\": 15.0,\n \"line_total\": \"3450.0\",\n \"inventory_id\": 1,\n \"is_inclusive\": false,\n \"unrounded_vat_value\": \"450.0\",\n \"expense_account\": {\n \"id\": 7,\n \"en_name\": \"Cash on hand\",\n \"created_at\": \"2024-12-01T12:48:13.000+03:00\",\n \"updated_at\": \"2024-12-01T12:48:13.000+03:00\",\n \"ar_description\": \"النقدية في الخزينة\",\n \"code\": \"110101\",\n \"is_locked\": false,\n \"receive_payments\": true,\n \"status\": \"Active\",\n \"type_of_account\": \"Debit\",\n \"ar_name\": \"النقدية في الخزينة\",\n \"parent_id\": 29,\n \"deleted_at\": null,\n \"parent_kind\": \"assets\",\n \"branch_kind\": \"current_assets\",\n \"account_kind\": \"non_bank_cash_and_equivalents\",\n \"en_description\": \"Cash in hand\"\n }\n }\n ],\n \"payments\": [],\n \"contact\": {\n \"id\": 1,\n \"name\": \"Vendor\",\n \"organization\": \"\",\n \"status\": \"Active\",\n \"created_at\": \"2024-12-01T12:49:19.000+03:00\",\n \"updated_at\": \"2024-12-01T12:49:19.000+03:00\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"secondary_phone_number\": null,\n \"tax_number\": \"\",\n \"custom_fields\": {},\n \"customer_details\": {},\n \"website\": null,\n \"pos\": true,\n \"government_entity\": false,\n \"billing_address\": null,\n \"shipping_address\": null,\n \"bank\": null\n }\n }\n}"}],"_postman_id":"9d90fdb3-f680-463c-8f70-0c00ba6efa50"},{"name":"Delete a simple bill","id":"c22dcf88-a6d9-43cd-aa1d-6d549b527a0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/simple_bills/1","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","simple_bills","1"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"48c389fa-15f1-4fae-b321-f94b0e6f2daf","name":"Delete a simple bill","originalRequest":{"method":"DELETE","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/bills/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jan 2020 13:10:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"cf83d280cebf911a84758313c258d53e\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"37fbbed1-c370-421f-a0e9-a485a51f1845"},{"key":"X-Runtime","value":"0.303796"}],"cookie":[],"responseTime":null,"body":"SimpleBill destroyed successfully"}],"_postman_id":"c22dcf88-a6d9-43cd-aa1d-6d549b527a0f"}],"id":"356a7bad-07d0-45cf-b623-0c9d83c10b1d","_postman_id":"356a7bad-07d0-45cf-b623-0c9d83c10b1d","description":""},{"name":"Bill Payments","item":[{"name":"Get All bill payments","id":"35a83f13-d068-49b6-94b6-31f0cff0b976","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/bill_payments","urlObject":{"path":["2.0","bill_payments"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"a26ba68c-54cd-40a0-9b6c-5827ef52e9ff","name":"Get All bill payments","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/bill_payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 23:06:53 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"afd2635b3111b0dd752d2f537c02a9af\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"f6c48a54-b0e9-4d8d-bc81-7df27bd83c15"},{"key":"X-Runtime","value":"0.030774"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"receipts\": [\n {\n \"id\": 1,\n \"reference\": \"PYT1\",\n \"description\": \"\",\n \"date\": \"2019-10-30\",\n \"amount\": \"548.63\",\n \"kind\": \"paid\",\n \"contact_id\": 1,\n \"account_id\": 7,\n \"allocations\": []\n },\n {\n \"id\": 7,\n \"reference\": \"PYT34\",\n \"description\": \"\",\n \"date\": \"2021-01-07\",\n \"amount\": \"37242.98\",\n \"kind\": \"paid\",\n \"contact_id\": 1,\n \"account_id\": 20,\n \"allocations\": [\n {\n \"id\": 8,\n \"amount\": \"37242.98\",\n \"date\": \"2021-01-07T00:00:00.000+03:00\",\n \"allocatee_id\": 4,\n \"allocatee_type\": \"Bill\",\n \"created_at\": \"2021-01-07T02:05:42.000+03:00\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"35a83f13-d068-49b6-94b6-31f0cff0b976"},{"name":"Get a bill payment","id":"c807ca58-930f-4aa2-b02b-b96612f9eefc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/bill_payments/7","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","bill_payments","7"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"a1199472-3c44-41b7-8c57-e32f6c2c53c7","name":"Get a bill payment","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/bill_payments/7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 23:07:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"8df08b59bf5e568d9bdcf0481465953d\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"5d8d3304-9f0a-4e1f-bea5-23c5a9a47797"},{"key":"X-Runtime","value":"0.028686"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 7,\n \"reference\": \"PYT34\",\n \"description\": \"\",\n \"date\": \"2021-01-07\",\n \"amount\": \"37242.98\",\n \"kind\": \"paid\",\n \"contact_id\": 1,\n \"account_id\": 20,\n \"allocations\": [\n {\n \"id\": 8,\n \"amount\": \"37242.98\",\n \"date\": \"2021-01-07T00:00:00.000+03:00\",\n \"allocatee_id\": 4,\n \"allocatee_type\": \"Bill\",\n \"created_at\": \"2021-01-07T02:05:42.000+03:00\"\n }\n ]\n}"}],"_postman_id":"c807ca58-930f-4aa2-b02b-b96612f9eefc"},{"name":"Create a bill payment","id":"aefd5a8d-623c-45aa-a757-06a991420c72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"bill_payment\":\n {\n \t\"reference\": \"PYT17894\",\n \t\"description\": \"partial bill payment for alamri\",\n \"bill_id\": \"15\",\n \"account_id\": \"8\",\n \"date\": \"2019-10-30\",\n \"amount\": \"5000\"\n }\n}\n"},"url":"https://www.qoyod.com/2.0/bill_payments","description":"

Parameters

\n
    \n

  1. reference(required, unique)

    \n
    2. \n

  2. description(optional)

    \n
    3. \n

  3. bill_id(required): id of the bill you wish to pay

    \n
    4. \n

  4. account_id(required): The account debited for this payment

    \n
    5. \n

  5. date(required)

    \n
    6. \n

  6. amount(required)

    \n
    7. \n
\n","urlObject":{"path":["2.0","bill_payments"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"cc4ab1ef-47c7-41d6-adb1-f30bc98f4025","name":"Create a bill payment","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"bill_payment\":\n {\n \t\"reference\": \"PYT17894\",\n \t\"description\": \"partial bill payment for alamri\",\n \"bill_id\": \"15\",\n \"account_id\": \"8\",\n \"date\": \"2019-10-30\",\n \"amount\": \"5000\"\n }\n}\n"},"url":"https://www.qoyod.com/2.0/bill_payments"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 23:11:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Location","value":"/api/2.0/receipts/8"},{"key":"ETag","value":"W/\"8c4d4fa5c40ac9018e30a274664900fe\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"40eafcf0-93fb-4e37-8153-e1f6f0da6ccf"},{"key":"X-Runtime","value":"0.119299"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"payment\": {\n \"id\": 8,\n \"contact_id\": 1,\n \"reference\": \"PYT17894\",\n \"account_id\": 8,\n \"description\": \"partial bill payment for alamri\",\n \"date\": \"2019-10-30\",\n \"amount\": \"5000.0\",\n \"created_at\": \"2021-01-07T02:11:17.000+03:00\",\n \"updated_at\": \"2021-01-07T02:11:17.000+03:00\",\n \"kind\": \"paid\"\n }\n}"}],"_postman_id":"aefd5a8d-623c-45aa-a757-06a991420c72"},{"name":"Allocate existing debit note or receipt","id":"2eedf1b0-f40a-43a6-916d-4ae1a75c0fc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"bill\": {\n \"allocations_attributes\": [\n {\n \"source_type\": \"DebitNote\",\n \"source_id\": 7,\n \"amount\": \"30.00\",\n \"date\": \"2021-01-07\"\n }\n ]\n }\n}"},"url":"https://www.qoyod.com/2.0/bills/15/allocations","description":"

Parameters

\n
    \n
  1. source_type(required): \"DebitNote\" or \"Receipt\"
    2. \n
  2. source_id(required): the id of the debit note or receipt
    3. \n
  3. date(required)
    4. \n
  4. amount(required)
    5. \n
\n","urlObject":{"path":["2.0","bills","15","allocations"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"d881bc4a-2412-4d14-990a-be5563cf3c02","name":"Allocate existing debit note or receipt","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"bill\": {\n \"allocations_attributes\": [\n {\n \"source_type\": \"DebitNote\",\n \"source_id\": 7,\n \"amount\": \"30.00\",\n \"date\": \"2021-01-07\"\n }\n ]\n }\n}"},"url":"https://www.qoyod.com/2.0/bills/15/allocations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 00:03:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"4df0e985831ff1beab91701e6322deaf\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"28c8955c-97e8-4db2-82b1-214afcc43d16"},{"key":"X-Runtime","value":"0.094070"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"bill\": {\n \"id\": 15,\n \"status\": \"Partially Paid\",\n \"issue_date\": \"2019-10-30\",\n \"due_date\": \"2019-10-31\",\n \"total\": \"38855.25\",\n \"paid_amount\": \"5030.0\",\n \"due_amount\": \"33825.25\",\n \"reference\": \"4597231\",\n \"notes\": \"\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 2,\n \"product_name\": \"Huawei Tablet\",\n \"description\": \"تابلت هواوي درجة أولى\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"1000.0\",\n \"unit_type\": 6,\n \"discount\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax\": \"5.0\",\n \"line_total\": \"21000.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"جوال سامسوتج جميل جدا\",\n \"quantity\": \"20.0\",\n \"unit_price\": \"850.0\",\n \"unit_type\": 6,\n \"discount\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax\": \"5.0\",\n \"line_total\": \"17850.0\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 8,\n \"product_name\": \"SIM Pin\",\n \"description\": \"يفك أزمات\",\n \"quantity\": \"5.0\",\n \"unit_price\": \"1.0\",\n \"unit_type\": 8,\n \"discount\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax\": \"5.0\",\n \"line_total\": \"5.25\",\n \"inventory_id\": 1\n }\n ],\n \"payments\": [\n {\n \"id\": 9,\n \"amount\": \"5000.0\",\n \"date\": \"2019-10-30\",\n \"source_id\": 8,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 15,\n \"allocatee_type\": \"Bill\"\n },\n {\n \"id\": 12,\n \"amount\": \"30.0\",\n \"date\": \"2019-10-30\",\n \"source_id\": 7,\n \"source_type\": \"DebitNote\",\n \"allocatee_id\": 15,\n \"allocatee_type\": \"Bill\"\n }\n ],\n \"contact\": {\n \"id\": 1,\n \"name\": \"Riyad Abdu\",\n \"organization\": \"Sony\",\n \"email\": \"riyad.abdu@sony.sa\",\n \"phone_number\": \"02245612301\",\n \"tax_number\": \"123456789012345\",\n \"status\": \"Active\"\n }\n }\n}"}],"_postman_id":"2eedf1b0-f40a-43a6-916d-4ae1a75c0fc6"}],"id":"6b4548dc-79e1-4b24-8217-42c93de694d0","event":[{"listen":"prerequest","script":{"id":"10897fad-37b5-4dd6-898d-97835373e0d5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8bca4a63-f15c-45ee-96ba-8e5ee2b7a76f","type":"text/javascript","exec":[""]}}],"_postman_id":"6b4548dc-79e1-4b24-8217-42c93de694d0","description":""},{"name":"Simple Bill Payments","item":[{"name":"Get All simple bill payments","id":"3a01f4cc-0c51-4d09-9b01-ca444f8003a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/simple_bill_payments","urlObject":{"path":["2.0","simple_bill_payments"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"a5451e1b-cd25-4a5e-bd75-fec7d44336a9","name":"Get All simple bill payments","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/simple_bill_payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 23:06:53 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"afd2635b3111b0dd752d2f537c02a9af\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"f6c48a54-b0e9-4d8d-bc81-7df27bd83c15"},{"key":"X-Runtime","value":"0.030774"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"receipts\": [\n {\n \"id\": 18,\n \"reference\": \"PYT12\",\n \"description\": \"test\",\n \"date\": \"2024-12-16\",\n \"amount\": \"10.0\",\n \"kind\": \"paid\",\n \"contact_id\": 2,\n \"account_id\": 7,\n \"created_at\": \"2024-12-16T15:21:25.000+03:00\",\n \"updated_at\": \"2024-12-16T15:21:25.000+03:00\",\n \"allocations\": [\n {\n \"id\": 29,\n \"amount\": \"10.0\",\n \"date\": \"2024-12-16\",\n \"source_id\": 18,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 3,\n \"allocatee_type\": \"CreditNote\",\n \"created_at\": \"2024-12-16T15:21:25.000+03:00\",\n \"updated_at\": \"2024-12-16T15:21:25.000+03:00\"\n }\n ]\n },\n {\n \"id\": 38,\n \"reference\": \"PYT30\",\n \"description\": \"test\",\n \"date\": \"2024-12-25\",\n \"amount\": \"5.0\",\n \"kind\": \"paid\",\n \"contact_id\": 3,\n \"account_id\": 7,\n \"created_at\": \"2024-12-26T13:33:21.000+03:00\",\n \"updated_at\": \"2025-03-12T10:38:37.000+03:00\",\n \"allocations\": []\n }, \n ]\n}\n"}],"_postman_id":"3a01f4cc-0c51-4d09-9b01-ca444f8003a9"},{"name":"Get a simple bill payment","id":"680c6996-a36c-49c4-9b59-a2573169c4b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/simple_bill_payments/7","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","simple_bill_payments","7"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"5d333990-9635-43f4-b9f0-2a697d9aea0b","name":"Get a simple bill payment","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/bill_payments/224"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 23:07:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"8df08b59bf5e568d9bdcf0481465953d\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"5d8d3304-9f0a-4e1f-bea5-23c5a9a47797"},{"key":"X-Runtime","value":"0.028686"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"receipt\": {\n \"id\": 24,\n \"reference\": \"PYT17\",\n \"description\": \"test\",\n \"date\": \"2024-12-19\",\n \"amount\": \"20.0\",\n \"kind\": \"received\",\n \"contact_id\": 2,\n \"account_id\": 7,\n \"created_at\": \"2024-12-19T11:11:54.000+03:00\",\n \"updated_at\": \"2024-12-19T11:11:54.000+03:00\",\n \"allocations\": [\n {\n \"id\": 38,\n \"amount\": \"10.0\",\n \"date\": \"2024-12-19\",\n \"source_id\": 24,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 14,\n \"allocatee_type\": \"PerformanceBond\",\n \"created_at\": \"2024-12-19T11:11:54.000+03:00\",\n \"updated_at\": \"2024-12-19T11:11:54.000+03:00\"\n }\n ]\n }\n}\n"}],"_postman_id":"680c6996-a36c-49c4-9b59-a2573169c4b8"},{"name":"Create a simple bill payment","id":"9e3b4ea4-14d4-4e93-a7a2-c5bd5e12fa11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"simple_bill_payment\":\n {\n \"reference\": \"PYT17895\",\n \"description\": \"partial bill payment for alamri\",\n \"simple_bill_id\": \"24\",\n \"account_id\": \"8\",\n \"date\": \"2019-10-30\",\n \"amount\": \"5\"\n }\n}\n"},"url":"https://www.qoyod.com/2.0/simple_bill_payments","description":"

Parameters

\n
    \n

  1. reference(required, unique)

    \n
    2. \n

  2. description(optional)

    \n
    3. \n

  3. simple_bill_id(required): id of the simple bill you wish to pay

    \n
    4. \n

  4. account_id(required): The account debited for this payment

    \n
    5. \n

  5. date(required)

    \n
    6. \n

  6. amount(required)

    \n
    7. \n
\n","urlObject":{"path":["2.0","simple_bill_payments"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"082040db-37af-4c45-9e3c-2053e86075d4","name":"Create a simple bill payment","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"simple_bill_payment\":\n {\n \"reference\": \"PYT17895\",\n \"description\": \"partial bill payment for alamri\",\n \"simple_bill_id\": \"24\",\n \"account_id\": \"8\",\n \"date\": \"2019-10-30\",\n \"amount\": \"5\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://www.qoyod.com/2.0/bill_payments"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 23:11:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Location","value":"/api/2.0/receipts/8"},{"key":"ETag","value":"W/\"8c4d4fa5c40ac9018e30a274664900fe\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"40eafcf0-93fb-4e37-8153-e1f6f0da6ccf"},{"key":"X-Runtime","value":"0.119299"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"payment\": {\n \"id\": 53,\n \"reference\": \"PYT178961\",\n \"description\": \"partial bill payment for alamri\",\n \"date\": \"2019-10-30\",\n \"amount\": \"5.0\",\n \"kind\": \"paid\",\n \"contact_id\": 3,\n \"account_id\": 8,\n \"created_at\": \"2025-04-28T15:07:04.000+03:00\",\n \"updated_at\": \"2025-04-28T15:07:04.000+03:00\",\n \"allocations\": [\n {\n \"id\": 93,\n \"amount\": \"5.0\",\n \"date\": \"2019-10-30\",\n \"source_id\": 53,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 24,\n \"allocatee_type\": \"SimpleBill\",\n \"created_at\": \"2025-04-28T15:07:04.000+03:00\",\n \"updated_at\": \"2025-04-28T15:07:04.000+03:00\"\n }\n ]\n }\n}\n"}],"_postman_id":"9e3b4ea4-14d4-4e93-a7a2-c5bd5e12fa11"},{"name":"Allocate existing debit note or receipt","id":"d236b5e8-a413-47be-90b9-6100791921f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"simple_bill\": {\n \"allocations_attributes\": [\n {\n \"source_type\": \"DebitNote/Receipt\",\n \"source_id\": debit_note_id/receipt_id,\n \"amount\": \"10\",\n \"date\": \"2021-01-07\"\n }\n ]\n }\n}\n"},"url":"https://www.qoyod.com/api/2.0/simple_bills/15/allocations","description":"

Parameters

\n
    \n

  1. source_type(required): \"DebitNote\" or \"Receipt\"

    \n
    2. \n

  2. source_id(required): the id of the debit note or receipt

    \n
    3. \n

  3. date(required)

    \n
    4. \n

  4. amount(required)

    \n
    5. \n
\n","urlObject":{"path":["api","2.0","simple_bills","15","allocations"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"41cfb31e-590c-48e2-956d-5c8a706856f1","name":"Allocate existing debit note or receipt","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"simple_bill\": {\n \"allocations_attributes\": [\n {\n \"source_type\": \"DebitNote/Receipt\",\n \"source_id\": debit_note_id/receipt_id,\n \"amount\": \"10\",\n \"date\": \"2021-01-07\"\n }\n ]\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://www.qoyod.com/2.0/simple_bills/15/allocations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Jan 2021 00:03:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"4df0e985831ff1beab91701e6322deaf\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"28c8955c-97e8-4db2-82b1-214afcc43d16"},{"key":"X-Runtime","value":"0.094070"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"simple_bill\": {\n \"id\": 24,\n \"status\": \"Partially Paid\",\n \"issue_date\": \"2024-12-22\",\n \"total\": \"115.0\",\n \"paid_amount\": 60.0,\n \"due_amount\": \"55.0\",\n \"reference\": \"SBill1\",\n \"created_at\": \"2024-12-22T08:29:11.000+03:00\",\n \"updated_at\": \"2025-06-03T16:47:39.000+03:00\",\n \"created_by\": \"kapil@qoyod.com\",\n \"line_items\": [\n {\n \"id\": 1,\n \"description\": \"Test\",\n \"project_id\": null,\n \"total_amount\": \"100.0\",\n \"tax\": 15.0,\n \"line_total\": \"115.0\",\n \"inventory_id\": 1,\n \"is_inclusive\": false,\n \"unrounded_vat_value\": \"15.0\",\n \"expense_account\": {\n \"id\": 12,\n \"en_name\": \"Cost of goods sold\",\n \"created_at\": \"2024-12-01T12:48:15.000+03:00\",\n \"updated_at\": \"2024-12-01T12:48:15.000+03:00\",\n \"ar_description\": \"تكلفة البضاعة المباعة\",\n \"code\": \"5101\",\n \"is_locked\": false,\n \"receive_payments\": false,\n \"status\": \"Active\",\n \"type_of_account\": \"Debit\",\n \"ar_name\": \"تكلفة البضاعة المباعة\",\n \"parent_id\": 56,\n \"deleted_at\": null,\n \"parent_kind\": \"expense\",\n \"branch_kind\": \"direct_cost\",\n \"account_kind\": \"cost_of_sales\",\n \"en_description\": \"Cost of good sold\"\n }\n }\n ],\n \"payments\": [\n {\n \"id\": 62,\n \"amount\": \"5.0\",\n \"date\": \"2024-12-25\",\n \"source_id\": Debit/Receipt ID,\n \"source_type\": \"Debit/Receipt\",\n \"allocatee_id\": simple_bill_id,\n \"allocatee_type\": \"SimpleBill\",\n \"created_at\": \"2024-12-26T13:33:21.000+03:00\",\n \"updated_at\": \"2024-12-26T13:33:21.000+03:00\"\n }\n ],\n \"contact\": {\n \"id\": 3,\n \"name\": \"Vendor 3\",\n \"organization\": \"\",\n \"status\": \"Active\",\n \"created_at\": \"2024-12-15T10:59:48.000+03:00\",\n \"updated_at\": \"2024-12-15T10:59:48.000+03:00\"\n }\n }\n}\n\n\n"}],"_postman_id":"d236b5e8-a413-47be-90b9-6100791921f7"}],"id":"495837fd-b217-4baa-ba85-cb431b98b4de","event":[{"listen":"prerequest","script":{"id":"10897fad-37b5-4dd6-898d-97835373e0d5","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8bca4a63-f15c-45ee-96ba-8e5ee2b7a76f","type":"text/javascript","exec":[""]}}],"_postman_id":"495837fd-b217-4baa-ba85-cb431b98b4de","description":""},{"name":"Debit Notes","item":[{"name":"All debit notes","id":"6408c9ce-cd46-4641-87f1-ceae996eeaae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/debit_notes","urlObject":{"path":["2.0","debit_notes"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"cab2a5d8-adc6-4bba-842c-ce99e52439ca","name":"All debit notes","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/debit_notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:48:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"cc61a64a4fd21697ee38178ab8439a5c\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"89bc969b-9da0-43fb-b3e1-f12a504ba518"},{"key":"X-Runtime","value":"0.147714"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"debit_notes\": [\n {\n \"id\": 7,\n \"contact_id\": 1,\n \"status\": \"Partially Used\",\n \"issue_date\": \"2019-10-30\",\n \"total_amount\": \"35.7\",\n \"remaining_amount\": \"5.7\",\n \"notes\": \"\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 4,\n \"product_name\": \"Wireless Headphone\",\n \"description\": \"بضاعة مرتجعة\",\n \"price\": \"34.0\",\n \"quantity\": \"1.0\",\n \"unit_type\": 6,\n \"tax_percent\": \"5.0\",\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"total\": \"35.7\",\n \"inventory_id\": 1\n }\n ]\n }\n ]\n}"}],"_postman_id":"6408c9ce-cd46-4641-87f1-ceae996eeaae"},{"name":"Get a debit note","id":"46228bef-d89a-4ea8-a2f8-068f280c9b2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"","value":""}],"url":"https://www.qoyod.com/2.0/debit_notes/7","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","debit_notes","7"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"001e4c3f-a1ff-4f4f-af1d-9e93a65fe584","name":"Get a debit note","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"","value":""}],"url":"https://www.qoyod.com/2.0/debit_notes/7"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:49:11 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"efaf19a5a53a13dd0ac46b9d09300ead\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"87832721-7303-4732-ad7c-95b2829d6a20"},{"key":"X-Runtime","value":"0.050832"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"note\": {\n \"id\": 7,\n \"contact_id\": 1,\n \"status\": \"Partially Used\",\n \"issue_date\": \"2019-10-30\",\n \"total_amount\": \"35.7\",\n \"remaining_amount\": \"5.7\",\n \"notes\": \"\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 4,\n \"product_name\": \"Wireless Headphone\",\n \"description\": \"بضاعة مرتجعة\",\n \"price\": \"34.0\",\n \"quantity\": \"1.0\",\n \"unit_type\": 6,\n \"tax_percent\": \"5.0\",\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"total\": \"35.7\",\n \"inventory_id\": 1\n }\n ]\n }\n}"}],"_postman_id":"46228bef-d89a-4ea8-a2f8-068f280c9b2e"},{"name":"Create a debit note","id":"38ff0d14-764e-43ea-9d80-83d7fc0523a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"debit_note\": {\n \"contact_id\": 1,\n \"issue_date\": \"2021-01-11\",\n \"status\": \"Approved\",\n \"inventory_id\": 1,\n\t\t\"term_conditions\": \"\",\n \t\"notes\": \"\",\n \"line_items\": [\n {\n \"product_id\": 4,\n \"description\": \"بضاعة مرتجعة\",\n \"unit_price\": \"34\",\n \"quantity\": \"1\",\n \"tax_percent\": \"15.0\"\n }\n ],\n \"custom_fields\": {\n \"customfield1\": \"custom value 1\",\n \"customfield2\": \"custom value 2\"\n }\n }\n}"},"url":"https://www.qoyod.com/2.0/debit_notes","description":"

Parameters

\n
    \n
  1. contact_id(required): The id of the vendor you are returning the products to
    2. \n
  2. reference (optional, unique): will be autogenerated if not sent.
    3. \n
  3. issue_date(required): The issue date - format: yyyy-mm-dd
    4. \n
  4. status(required): The status can be Draft or Approved
    5. \n
  5. inventory_id(required)
    6. \n
  6. terms_conditions(optional)
    7. \n
  7. notes(optional)
    8. \n
  8. draft_if_out_of_stock(optional): If one or more of the products do not have enough quantity, create the Debit Note as \"Draft\" instead of returning an error.
    9. \n
  9. line_items: An array of line items, each line item follows this format:
      \n
    1. product_id(required)
      2. \n
    2. description(optional)
      3. \n
    3. unit_price(required)
      4. \n
    4. quantity(required)
      5. \n
    5. unit_type(optional): unit type id of the product, defaults to the product's default unit type.
      6. \n
    6. discount(optional)
      7. \n
    7. discount_type(optional): determines whether the discount above is a percentage or an amount, can be percentage or amount, defaults to percentage
      8. \n
    8. tax_percent(optional)
      9. \n
    \n
    10. \n
  10. custom_fields(optional): Array of custom fields and their values to add to the debit note, custom fields must already be added in the website's settings page
    11. \n
\n","urlObject":{"path":["2.0","debit_notes"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"66b3d7c0-d81f-48e2-9082-d2f44874d569","name":"Create a debit note","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"debit_note\": {\n \"contact_id\": 1,\n \"issue_date\": \"2021-01-11\",\n \"status\": \"Approved\",\n \"inventory_id\": 1,\n\t\t\"term_conditions\": \"\",\n \t\"notes\": \"\",\n \"line_items\": [\n {\n \"product_id\": 4,\n \"description\": \"بضاعة مرتجعة\",\n \"unit_price\": \"34\",\n \"quantity\": \"1\",\n \"tax_percent\": \"15.0\"\n }\n ]\n }\n}"},"url":"https://www.qoyod.com/2.0/debit_notes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 16:18:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"6489666545c55a3c84110bbe1f45cf28\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"8f034819-36ca-4c66-a4c3-81c9049dfdcf"},{"key":"X-Runtime","value":"0.227954"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"note\": {\n \"id\": 23,\n \"reference\": \"DBN5\",\n \"contact_id\": 1,\n \"status\": \"Unused\",\n \"issue_date\": \"2021-01-11\",\n \"total_amount\": \"39.1\",\n \"remaining_amount\": \"39.1\",\n \"notes\": \"\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 4,\n \"product_name\": \"Wireless Headphone\",\n \"description\": \"بضاعة مرتجعة\",\n \"price\": \"34.0\",\n \"quantity\": \"1.0\",\n \"unit_type\": 6,\n \"tax_percent\": \"15.0\",\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"total\": \"39.1\",\n \"inventory_id\": 1\n }\n ]\n }\n}"}],"_postman_id":"38ff0d14-764e-43ea-9d80-83d7fc0523a1"},{"name":"Delete a debit note","id":"49a346fa-a64c-4041-acfc-fd8ec49545e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"","value":""}],"url":"https://www.qoyod.com/2.0/debit_notes/2","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","debit_notes","2"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"96f42558-e6b8-402d-953d-8142d8bc43b6","name":"Delete a debit note","originalRequest":{"method":"DELETE","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"","value":""}],"url":"https://www.qoyod.com/2.0/debit_notes/2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jan 2020 13:18:10 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"dd5162d194ace1a013a90909be201c70\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"ec8afe23-1d19-45f2-a00c-af5e88554de2"},{"key":"X-Runtime","value":"0.221155"}],"cookie":[],"responseTime":null,"body":"Debit note destroyed successfully"}],"_postman_id":"49a346fa-a64c-4041-acfc-fd8ec49545e2"}],"id":"008688df-1437-415f-b085-e710fa4d69b7","_postman_id":"008688df-1437-415f-b085-e710fa4d69b7","description":""}],"id":"e071c907-c56b-4739-8d32-e7c162f96686","_postman_id":"e071c907-c56b-4739-8d32-e7c162f96686","description":""},{"name":"Sales","item":[{"name":"Customers","item":[{"name":"All customers","id":"427b0551-3cee-4fab-9a38-5792ea89ef68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/customers","urlObject":{"path":["2.0","customers"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"40cc20d1-8b2f-4c40-b5f7-66ddad3685e9","name":"All customers","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/customers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 23:30:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"acb57ea4d7e76bfc7d3a6b7eb1fb6fed\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"0ad2bea6-8eea-4577-9e21-fe1ce0af54c7"},{"key":"X-Runtime","value":"0.039079"}],"cookie":[],"responseTime":null,"body":"{\n \"customers\": [\n {\n \"id\": 2,\n \"name\": \"عميل مار\",\n \"organization\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"tax_number\": \"\",\n \"status\": \"Active\"\n },\n {\n \"id\": 5,\n \"name\": \"عبدالقدوس أبوفرج\",\n \"organization\": \"\",\n \"email\": \"abdulqoddoos-abofaraj@hotmail.com\",\n \"phone_number\": \"255597854231\",\n \"tax_number\": \"\",\n \"status\": \"Active\"\n }\n ]\n}"}],"_postman_id":"427b0551-3cee-4fab-9a38-5792ea89ef68"},{"name":"Get a customer","id":"ff0d3f39-7747-43b8-a40b-7ef5dbd77271","request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"body":{"mode":"raw","raw":" "},"url":"https://www.qoyod.com/2.0/customers/2","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","customers","2"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"2dbee03b-bad5-41ca-b4b5-eb306e9c4ef7","name":"Get a customer","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/customers/2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 23:27:20 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"eedd398a62ae930931070ab35e7d7916\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"874d98e1-4584-4080-9f4f-37636bf8c974"},{"key":"X-Runtime","value":"0.044800"}],"cookie":[],"responseTime":null,"body":"{\n \"contact\": {\n \"id\": 2,\n \"name\": \"عميل مار\",\n \"organization\": \"\",\n \"email\": \"\",\n \"phone_number\": \"\",\n \"tax_number\": \"\",\n \"status\": \"Active\"\n }\n}"}],"_postman_id":"ff0d3f39-7747-43b8-a40b-7ef5dbd77271"},{"name":"Create customer","id":"a59c4399-73c8-4dd5-a9d4-8c97b2794643","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"contact\": {\r\n \"name\": \"عبدالقدوس أبوفرج\",\r\n \"organization\": \"\",\r\n \"email\": \"abdulqoddoos-abofaraj@hotmail.com\",\r\n \"phone_number\": \"255597854231\",\r\n \"tax_number\": \"\",\r\n \"status\": \"Active\",\r\n \"shipping_address\": {\r\n \"shipping_address\": \"shipping address 123\",\r\n \"shipping_city\": \"Cairo\",\r\n \"shipping_state\": \"\",\r\n \"shipping_zip\": \"\",\r\n \"shipping_country\": \"Egypt\"\r\n },\r\n \"billing_address\": {\r\n \"billing_address\": \"billing address 123\",\r\n \"billing_city\": \"Cairo\",\r\n \"billing_state\": \"\",\r\n \"billing_zip\": \"\",\r\n \"billing_country\": \"Egypt\",\r\n \"building_number\": \"\"\r\n }\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/customers","description":"

Parameters

\n
    \n

  1. name(required)

    \n
    2. \n

  2. organization(optional)

    \n
    3. \n

  3. phone_number(optional)

    \n
    4. \n

  4. secondary_phone_number (optional)

    \n
    5. \n

  5. email(optional)

    \n
    6. \n

  6. status(optional): \"Active\" or \"Inactive\", defaults to \"Active\".

    \n
    7. \n

  7. tax_number(optional)

    \n
    8. \n

  8. shipping_address (optional)

    \n
    9. \n

  9. billing_address (optional)

    \n
    10. \n
\n","urlObject":{"path":["2.0","customers"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"c5a70677-5da5-43e6-8956-7725bcf2f1e5","name":"Create customer","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"contact\": {\r\n \"name\": \"عبدالقدوس أبوفرج\",\r\n \"organization\": \"\",\r\n \"email\": \"abdulqoddoos-abofaraj@hotmail.com\",\r\n \"phone_number\": \"255597854231\",\r\n \"tax_number\": \"\",\r\n \"status\": \"Active\",\r\n \"shipping_address\": {\r\n \"shipping_address\": \"shipping address 123\",\r\n \"shipping_city\": \"Cairo\",\r\n \"shipping_state\": \"\",\r\n \"shipping_zip\": \"\",\r\n \"shipping_country\": \"Egypt\"\r\n },\r\n \"billing_address\": {\r\n \"billing_address\": \"billing address 123\",\r\n \"billing_city\": \"Cairo\",\r\n \"billing_state\": \"\",\r\n \"billing_zip\": \"\",\r\n \"billing_country\": \"Egypt\",\r\n \"building_number\": \"\"\r\n }\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/customers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 23:29:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"201 Created"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"0f9e7ca1ce11a9d622cb37c28bb8da46\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"3b1d6d59-a732-4101-a6d1-fcca7452092f"},{"key":"X-Runtime","value":"0.091995"}],"cookie":[],"responseTime":null,"body":"{\n \"contact\": {\n \"id\": 5,\n \"name\": \"عبدالقدوس أبوفرج\",\n \"organization\": \"\",\n \"email\": \"abdulqoddoos-abofaraj@hotmail.com\",\n \"phone_number\": \"255597854231\",\n \"tax_number\": \"\",\n \"status\": \"Active\",\n \"billing_address\": {\n \"id\": 16,\n \"contact_id\": 22,\n \"is_default\": null,\n \"billing_address\": \"billing address 123\",\n \"billing_city\": \"Cairo\",\n \"billing_state\": \"\",\n \"billing_zip\": \"\",\n \"billing_country\": \"Egypt\",\n \"created_at\": \"2025-11-25T11:59:15.000+03:00\",\n \"updated_at\": \"2025-11-25T11:59:15.000+03:00\",\n \"building_number\": \"\"\n },\n \"shipping_address\": {\n \"id\": 12,\n \"contact_id\": 22,\n \"is_default\": null,\n \"shipping_address\": \"shipping address 123\",\n \"shipping_city\": \"Cairo\",\n \"shipping_state\": \"\",\n \"shipping_zip\": \"\",\n \"shipping_country\": \"Egypt\",\n \"created_at\": \"2025-11-25T11:59:15.000+03:00\",\n \"updated_at\": \"2025-11-25T11:59:15.000+03:00\",\n \"shipping_building_number\": null\n }\n }\n}"},{"id":"f5e607ab-204d-474d-a781-6d69b92e1a18","name":"Create multiple customers","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"contact\": [\r\n {\r\n \"name\": \"customer 1\",\r\n \"organization\": \"organization 1\"\r\n },\r\n {\r\n \"name\": \"customer 2\",\r\n \"organization\": \"organization 2\"\r\n }\r\n ]\r\n}\r\n"},"url":"https://www.qoyod.com/2.0/customers"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 17 Dec 2019 14:08:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"201 Created"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"d886b1e8b0efade6fca08550126d0e52\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"3f417c15-c0d5-4a96-9106-d74624c479d6"},{"key":"X-Runtime","value":"0.149488"}],"cookie":[],"responseTime":null,"body":"{\n \"contacts\": [\n {\n \"id\": 496,\n \"name\": \"customer 1\",\n \"organization\": \"organization 1\",\n \"email\": null,\n \"phone_number\": null,\n \"tax_number\": null,\n \"status\": \"Active\"\n },\n {\n \"id\": 497,\n \"name\": \"customer 2\",\n \"organization\": \"organization 2\",\n \"email\": null,\n \"phone_number\": null,\n \"tax_number\": null,\n \"status\": \"Active\"\n }\n ]\n}"}],"_postman_id":"a59c4399-73c8-4dd5-a9d4-8c97b2794643"},{"name":"Update a customer","id":"c2105ab2-4e87-4bc4-b43d-686742d7fe1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n\t\t\"phone_number\": \"2222244444\"\n }\n}"},"url":"https://www.qoyod.com/2.0/customers/2","description":"

Enter only the parameters you wish to change

\n

Parameters

\n
    \n
  1. name
    2. \n
  2. organization
    3. \n
  3. phone_number
    4. \n
  4. email
    5. \n
  5. status: \"Active\" or \"Inactive\".
    6. \n
\n","urlObject":{"path":["2.0","customers","2"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"e01db131-1980-446f-b24d-03637b96ed6e","name":"Update a customer","originalRequest":{"method":"PUT","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contact\": {\n\t\t\"phone_number\": \"2222244444\"\n }\n}"},"url":"https://www.qoyod.com/2.0/customers/2"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 30 Oct 2019 23:31:01 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"b066905272c84d51b605fff6799cf7c0\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"d887f35f-016a-486f-bd20-6a960704c53c"},{"key":"X-Runtime","value":"0.094883"}],"cookie":[],"responseTime":null,"body":"{\n \"contact\": {\n \"id\": 2,\n \"name\": \"عميل مار\",\n \"organization\": \"\",\n \"email\": \"\",\n \"phone_number\": \"2222244444\",\n \"tax_number\": \"\",\n \"status\": \"Active\"\n }\n}"}],"_postman_id":"c2105ab2-4e87-4bc4-b43d-686742d7fe1b"}],"id":"d98ff8eb-c7a8-44ac-ba67-339d43bf9cf0","_postman_id":"d98ff8eb-c7a8-44ac-ba67-339d43bf9cf0","description":""},{"name":"Quotes","item":[{"name":"All quotes","id":"29450c3a-1167-4a61-bfb0-7b46238e8604","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/quotes","urlObject":{"path":["2.0","quotes"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"798328f5-796d-43c0-9be7-fa50b8d8bfb0","name":"All quotes","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/quotes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:50:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"1bbcbd7ceea1737c8a768d82ec163773\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"0dbaa162-3683-483d-9062-c474e998423f"},{"key":"X-Runtime","value":"0.226108"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"quote\": [\n {\n \"id\": 14,\n \"contact_id\": 5,\n \"total_amount\": \"3320.1\",\n \"issue_date\": \"2019-10-30\",\n \"expiry_date\": \"2019-10-31\",\n \"status\": \"Approved\",\n \"reference\": \"api-quote-1\",\n \"notes\": \"القبول خلال يوم عمل\",\n \"terms_conditions\": null,\n \"line_items\": [\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"لون أسود\",\n \"quantity\": \"3.0\",\n \"unit_price\": \"1054.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"inventory_id\": 1,\n \"total\": \"3320.1\"\n }\n ]\n },\n {\n \"id\": 13,\n \"contact_id\": 5,\n \"total_amount\": \"11970.0\",\n \"issue_date\": \"2019-10-30\",\n \"expiry_date\": \"2019-10-31\",\n \"status\": \"Approved\",\n \"reference\": \"QTE1\",\n \"notes\": \"

نقبل النقد ومدى

\",\n \"terms_conditions\": \"

الرد خلال يوم عمل

\",\n \"line_items\": [\n {\n \"product_id\": 2,\n \"product_name\": \"Huawei Tablet\",\n \"description\": \"تابلت هواوي درجة أولى\",\n \"quantity\": \"10.0\",\n \"unit_price\": \"1200.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"5.0\",\n \"discount_amount\": \"600.0\",\n \"tax_percent\": \"5.0\",\n \"inventory_id\": 1,\n \"total\": \"11970.0\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"29450c3a-1167-4a61-bfb0-7b46238e8604"},{"name":"Get a quote","id":"43db7977-b0da-4469-98b4-1ad6cbcf704c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/quotes/14","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","quotes","14"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"29f25345-6ebe-4ae0-b771-985b658b73cf","name":"Get a quote","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/quotes/14"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 15:50:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"17889b51cbfb2a7b4bd3b1ad37ff33c3\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"f0d00c75-6195-44df-a787-abb0c1d40035"},{"key":"X-Runtime","value":"0.021767"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"quote\": {\n \"id\": 14,\n \"contact_id\": 5,\n \"total_amount\": \"3320.1\",\n \"issue_date\": \"2019-10-30\",\n \"expiry_date\": \"2019-10-31\",\n \"status\": \"Approved\",\n \"reference\": \"api-quote-1\",\n \"notes\": \"القبول خلال يوم عمل\",\n \"terms_conditions\": null,\n \"line_items\": [\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"لون أسود\",\n \"quantity\": \"3.0\",\n \"unit_price\": \"1054.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"inventory_id\": 1,\n \"total\": \"3320.1\"\n }\n ]\n }\n}"}],"_postman_id":"43db7977-b0da-4469-98b4-1ad6cbcf704c"},{"name":"Create a quote","id":"99d148a1-3d16-4744-a021-c8201ed05fce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quote\": {\n \"contact_id\": 5,\n \"quotation_no\":\"api-quote-3\",\n \"issue_date\": \"2021-01-11\",\n \"expiry_date\": \"2021-01-12\",\n \"status\": \"Approved\",\n\t\t\"notes\": \"القبول خلال يوم عمل\",\n \"terms_conditions\": \"نقبل النقد وبطاقات مدى\",\n\t\t\"inventory_id\": 1,\n \"line_items\": [\n {\n \"product_id\": 1,\n \"description\": \"لون أسود\",\n \"quantity\": \"3.0\",\n \"unit_price\": \"1054.0\",\n \"discount\": \"10\",\n \"discount_type\":\"percentage\",\n \"tax_percent\": \"15\"\n }\n ],\n \"custom_fields\": {\n \"customfield1\": \"custom value 1\",\n \"customfield2\": \"custom value 2\"\n }\n }\n}"},"url":"https://www.qoyod.com/2.0/quotes","description":"

Parameters

\n
    \n
  1. contact_id(required): The id of the customer you are selling to
    2. \n
  2. quotation_number(required, unique)
    3. \n
  3. issue_date(required): The issue date of the quote, format: yyyy-mm-dd
    4. \n
  4. expiry_date(required): The due date of the quote, format: yyyy-mm-dd
    5. \n
  5. status(required): The status of the quote, can be Draft or Approved, defaults to draft
    6. \n
  6. terms_conditions(optional)
    7. \n
  7. notes(optional)
    8. \n
  8. inventory_id(required)
    9. \n
  9. line_items: An array of line items, each line item follows this format:
      \n
    1. product_id(required)
      2. \n
    2. description(optional)
      3. \n
    3. quantity(required)
      4. \n
    4. unit_price(required)
      5. \n
    5. unit_type(optional): unit type id of the product, defaults to the product's default unit type.
      6. \n
    6. discount(optional)
      7. \n
    7. discount_type(optional): determines whether the discount above is a percentage or an amount, can be percentage or amount, defaults to percentage
      8. \n
    8. tax_percent(optional)
      9. \n
    9. is_inclusive(optional): set to true if the entered unit price is tax inclusive, defaults to false
      10. \n
    \n
    10. \n
  10. custom_fields(optional): Array of custom fields and their values to add to the quote, custom fields must already be added in the website's settings page
    11. \n
\n","urlObject":{"path":["2.0","quotes"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"c6c83502-cef2-4cdd-9d4a-6cdb202a1abb","name":"Create a quote","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quote\": {\n \"contact_id\": 5,\n \"quotation_no\":\"api-quote-3\",\n \"issue_date\": \"2021-01-11\",\n \"expiry_date\": \"2021-01-12\",\n \"status\": \"Approved\",\n\t\t\"notes\": \"القبول خلال يوم عمل\",\n \"terms_conditions\": \"نقبل النقد وبطاقات مدى\",\n\t\t\"inventory_id\": 1,\n \"line_items\": [\n {\n \"product_id\": 1,\n \"description\": \"لون أسود\",\n \"quantity\": \"3.0\",\n \"unit_price\": \"1054.0\",\n \"discount\": \"10\",\n \"discount_type\":\"percentage\",\n \"tax_percent\": \"15\"\n }\n ]\n }\n}"},"url":"https://www.qoyod.com/2.0/quotes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 16:29:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"34fb548e6592c2cad515cf79c149faa0\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"cd3bafbe-01f3-44e2-8bd4-1692d6ede92a"},{"key":"X-Runtime","value":"0.147497"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"quote\": {\n \"id\": 25,\n \"contact_id\": 5,\n \"total_amount\": \"3272.67\",\n \"issue_date\": \"2021-01-11\",\n \"expiry_date\": \"2021-01-12\",\n \"status\": \"Approved\",\n \"reference\": \"api-quote-3\",\n \"notes\": \"القبول خلال يوم عمل\",\n \"terms_conditions\": \"نقبل النقد وبطاقات مدى\",\n \"line_items\": [\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"لون أسود\",\n \"quantity\": \"3.0\",\n \"unit_price\": \"1054.0\",\n \"unit_type\": 6,\n \"discount_percent\": \"10.0\",\n \"discount_amount\": \"316.2\",\n \"tax_percent\": \"15.0\",\n \"inventory_id\": 1,\n \"total\": \"3272.67\"\n }\n ]\n }\n}"}],"_postman_id":"99d148a1-3d16-4744-a021-c8201ed05fce"}],"id":"b9e2b36f-6a27-43c1-bd0b-0d955f3932e1","event":[{"listen":"prerequest","script":{"id":"23b3b81e-fb72-46ff-a10a-d653a85cf846","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c3e6e7cc-5ea3-4a47-8cad-fe2c5d0899ac","type":"text/javascript","exec":[""]}}],"_postman_id":"b9e2b36f-6a27-43c1-bd0b-0d955f3932e1","description":""},{"name":"Invoices","item":[{"name":"All invoices","id":"8f254523-2957-4acb-bf4a-3ce0b3053115","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/invoices","urlObject":{"path":["2.0","invoices"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"eb1cad54-2b30-48f4-9dd0-d307b3fcacf0","name":"All invoices","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/invoices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 23:15:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"c65372f2cbc8d27bb4318c4acaa1121f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"e35ac311-8a6d-4898-a485-b156402bc5f1"},{"key":"X-Runtime","value":"0.041970"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"invoices\": [\n {\n \"id\": 3,\n \"description\": \"an example invoice\",\n \"issue_date\": \"2019-10-30\",\n \"due_date\": \"2019-10-30\",\n \"due_amount\": \"618.45\",\n \"paid_amount\": \"0.0\",\n \"total\": \"618.45\",\n \"contact_id\": 2,\n \"status\": \"Approved\",\n \"reference\": \"547894\",\n \"notes\": null,\n \"terms_conditions\": null,\n \"line_items\": [\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"\",\n \"quantity\": \"1.0\",\n \"unit_price\": \"589.0\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"line_total\": \"618.45\",\n \"inventory_id\": 1\n }\n ],\n \"payments\": []\n },\n {\n \"id\": 2,\n \"description\": \"an example invoice\",\n \"issue_date\": \"2019-10-30\",\n \"due_date\": \"2019-10-30\",\n \"due_amount\": \"618.45\",\n \"paid_amount\": \"0.0\",\n \"total\": \"618.45\",\n \"contact_id\": 2,\n \"status\": \"Approved\",\n \"reference\": \"api-inv-1\",\n \"notes\": null,\n \"terms_conditions\": null,\n \"line_items\": [\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"\",\n \"quantity\": \"1.0\",\n \"unit_price\": \"589.0\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"line_total\": \"618.45\",\n \"inventory_id\": 1\n }\n ],\n \"payments\": []\n },\n {\n \"id\": 1,\n \"description\": \"\",\n \"issue_date\": \"2019-10-30\",\n \"due_date\": \"2019-10-30\",\n \"due_amount\": \"1.5\",\n \"paid_amount\": \"18.5\",\n \"total\": \"20.0\",\n \"contact_id\": 2,\n \"status\": \"Partially Paid\",\n \"reference\": \"INV2\",\n \"notes\": \"\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 3,\n \"product_name\": \"maintainance\",\n \"description\": \"نركيب حامي شاشة\",\n \"quantity\": \"1.0\",\n \"unit_price\": \"20.0\",\n \"unit_type\": 7,\n \"unit\": \"وحدة\",\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"0.0\",\n \"line_total\": \"20.0\",\n \"inventory_id\": 2\n }\n ],\n \"payments\": [\n {\n \"id\": 6,\n \"amount\": \"10.5\",\n \"date\": \"2019-10-30\",\n \"source_id\": 4,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 1,\n \"allocatee_type\": \"Invoice\"\n },\n {\n \"id\": 7,\n \"amount\": \"8.0\",\n \"date\": \"2019-10-30\",\n \"source_id\": 6,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 1,\n \"allocatee_type\": \"Invoice\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"8f254523-2957-4acb-bf4a-3ce0b3053115"},{"name":"Get an invoice","id":"f8631121-0a08-4517-a4db-e4f0f483cd20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/invoices/1","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","invoices","1"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"1268d975-b71a-463f-bfb0-6b99d20a6d02","name":"Get an invoice","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/invoices/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 23:16:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"dc4ece626b4d58714a19d29e672bcda7\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"eda7358d-03d9-420d-98ca-b7ff785ed19c"},{"key":"X-Runtime","value":"0.068010"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": 1,\n \"description\": \"\",\n \"issue_date\": \"2019-10-30\",\n \"due_date\": \"2019-10-30\",\n \"due_amount\": \"1.5\",\n \"paid_amount\": \"18.5\",\n \"total\": \"20.0\",\n \"contact_id\": 2,\n \"status\": \"Partially Paid\",\n \"reference\": \"INV2\",\n \"notes\": \"\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 3,\n \"product_name\": \"maintainance\",\n \"description\": \"نركيب حامي شاشة\",\n \"quantity\": \"1.0\",\n \"unit_price\": \"20.0\",\n \"unit_type\": 7,\n \"unit\": \"وحدة\",\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"0.0\",\n \"line_total\": \"20.0\",\n \"inventory_id\": 2\n }\n ],\n \"payments\": [\n {\n \"id\": 6,\n \"amount\": \"10.5\",\n \"date\": \"2019-10-30\",\n \"source_id\": 4,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 1,\n \"allocatee_type\": \"Invoice\"\n },\n {\n \"id\": 7,\n \"amount\": \"8.0\",\n \"date\": \"2019-10-30\",\n \"source_id\": 6,\n \"source_type\": \"Receipt\",\n \"allocatee_id\": 1,\n \"allocatee_type\": \"Invoice\"\n }\n ]\n }\n}"}],"_postman_id":"f8631121-0a08-4517-a4db-e4f0f483cd20"},{"name":"Get an invoice as PDF","id":"b3e7f250-931e-4fee-a0a4-9391703727c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/invoices/2/pdf","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","invoices","2","pdf"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"21eac9c4-ec60-4abb-b6d2-b132e2a93b4d","name":"Get an invoice as PDF","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/invoices/2/pdf"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 15 May 2023 08:08:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"x-frame-options","value":"SAMEORIGIN"},{"key":"x-xss-protection","value":"1; mode=block"},{"key":"x-content-type-options","value":"nosniff"},{"key":"x-download-options","value":"noopen"},{"key":"x-permitted-cross-domain-policies","value":"none"},{"key":"referrer-policy","value":"strict-origin-when-cross-origin"},{"key":"access-control-allow-origin","value":"*"},{"key":"access-control-allow-methods","value":"GET, POST, PUT, OPTIONS"},{"key":"access-control-allow-headers","value":"*"},{"key":"ratelimit-limit","value":"300"},{"key":"ratelimit-remaining","value":"299"},{"key":"ratelimit-reset","value":"1684138140"},{"key":"etag","value":"W/\"811866b828b6c9cca59298280833d094\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"5fc57b00-ecf4-413b-b79c-dec548cec70b"},{"key":"x-runtime","value":"1.535161"},{"key":"strict-transport-security","value":"max-age=31536000; includeSubDomains"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7c79e4fb4c728254-IAD"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"pdf_file\": \"https://cdn.qoyod.com/export/pdf/6e812d637401271c87de1206a2477102b9b756d3/Ca1GkCGop_vaI-xVUkcZuA/4Iz2mCIDb4rY6nB-tIzxKQ.pdf\",\n \"expire_at\": \"Wed, 17 May 2023 08:08:43 GMT\"\n}"}],"_postman_id":"b3e7f250-931e-4fee-a0a4-9391703727c6"},{"name":"Create an invoice","id":"8d1e529e-85f3-4e40-8952-b5726e0ad2be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"invoice\": {\n\t\t\"contact_id\": 2,\n \"reference\": \"api-inv-2\",\n \"description\": \"an example invoice\",\n \"issue_date\": \"2019-10-30\",\n \"due_date\": \"2019-10-30\",\n \"status\": \"Approved\",\n\t\t\"inventory_id\": 1,\n \"line_items\": [\n {\n \"product_id\": 1,\n \"description\": \"\",\n \"quantity\": 1.0,\n \"unit_price\": 589.2,\n \"discount\": 20,\n \"discount_type\": \"percentage\",\n \"tax_percent\": 15\n },\n {\n \"product_id\": 2,\n \"description\": \"\",\n \"quantity\": 2,\n \"unit_price\": 200,\n \"discount\": 50,\n \"discount_type\": \"amount\",\n \"tax_percent\": 15\n }\n ],\n \"custom_fields\": {\n \"customfield1\": \"custom value 1\",\n \"customfield2\": \"custom value 2\"\n }\n }\n}\n"},"url":"https://www.qoyod.com/2.0/invoices","description":"

Parameters

\n
    \n

  1. contact_id(required): The id of the contact you want to sell to

    \n
    2. \n

  2. reference(optional, unique): will be autogenerated if not sent.

    \n
    3. \n

  3. description(optional)

    \n
    4. \n

  4. issue_date(required): The issue date of the invoice, format: yyyy-mm-dd

    \n
    5. \n

  5. due_date(required): The due date of the invoice, format: yyyy-mm-dd

    \n
    6. \n

  6. status(required): The status of the invoice, can be Draft or Approved, defaults to draft

    \n
    7. \n

  7. inventory_id(required): The inventory where this product belongs, required.

    \n
    8. \n

  8. draft_if_out_of_stock(optional): If one or more of the products do not have enough quantity, create the invoice as \"Draft\" instead of returning an error.

    \n
    9. \n

  9. line_items(required): An array of line items in the invoice, each line item follows this format:

    \n
      \n

    1. product_id(required)

      \n
      2. \n

    2. description(optional)

      \n
      3. \n

    3. quantity(required): Products that are tracked (marked as inventory items) cannot be used in invoices if current stock does not have enough quantity

      \n
      4. \n

    4. unit_price(required)

      \n
      5. \n

    5. unit_type(optional): unit type id of the product, defaults to the product's default unit type..

      \n
      6. \n

    6. discount(optional)

      \n
      7. \n

    7. discount_type(optional): determines whether the discount above is a percentage or an amount, can be percentage or amount, defaults to percentage

      \n
      8. \n

    8. tax_percent(optional)

      \n
      9. \n

    9. is_inclusive(optional): set to true if the entered unit price is tax inclusive, defaults to false

      \n
      10. \n
    \n
    10. \n

  10. custom_fields(optional): Array of custom fields and their values to add to the invoice, custom fields must already be added in the website's settings page

    \n
    11. \n
\n","urlObject":{"path":["2.0","invoices"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"52d6a837-45b6-46b8-9877-e0e09bf67416","name":"Create an invoice","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"invoice\": {\n\t\t\"contact_id\": 2,\n \"reference\": \"api-inv-2\",\n \"description\": \"an example invoice\",\n \"issue_date\": \"2019-10-30\",\n \"due_date\": \"2019-10-30\",\n \"status\": \"Approved\",\n\t\t\"inventory_id\": 1,\n \"line_items\": [\n {\n \"product_id\": 1,\n \"description\": \"\",\n \"quantity\": 1.0,\n \"unit_price\": 589.2,\n \"discount\": 20,\n \"discount_type\": \"percentage\",\n \"tax_percent\": 15\n },\n {\n \"product_id\": 2,\n \"description\": \"\",\n \"quantity\": 2,\n \"unit_price\": 200,\n \"discount\": 50,\n \"discount_type\": \"amount\",\n \"tax_percent\": 15\n }\n ]\n }\n}\n"},"url":"https://www.qoyod.com/2.0/invoices"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 16:35:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"301166d50cbaabc6cf635e825de3dd8a\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"e0d883db-d9e6-47ba-bcc1-caeede0aa1fc"},{"key":"X-Runtime","value":"0.885159"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": 26,\n \"description\": \"an example invoice\",\n \"issue_date\": \"2019-10-30\",\n \"due_date\": \"2019-10-30\",\n \"due_amount\": \"944.56\",\n \"paid_amount\": \"0.0\",\n \"total\": \"944.56\",\n \"contact_id\": 2,\n \"status\": \"Approved\",\n \"reference\": \"api-inv-2\",\n \"notes\": null,\n \"terms_conditions\": null,\n \"line_items\": [\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"\",\n \"quantity\": \"1.0\",\n \"unit_price\": \"589.2\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"discount_percent\": \"20.0\",\n \"discount_amount\": \"117.84\",\n \"tax_percent\": \"15.0\",\n \"line_total\": \"542.06\",\n \"inventory_id\": 1\n },\n {\n \"product_id\": 2,\n \"product_name\": \"Huawei Tablet\",\n \"description\": \"\",\n \"quantity\": \"2.0\",\n \"unit_price\": \"200.0\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"discount_percent\": \"12.5\",\n \"discount_amount\": \"50.0\",\n \"tax_percent\": \"15.0\",\n \"line_total\": \"402.5\",\n \"inventory_id\": 1\n }\n ],\n \"payments\": []\n }\n}"}],"_postman_id":"8d1e529e-85f3-4e40-8952-b5726e0ad2be"},{"name":"Delete an invoice","id":"d4e4be50-ae90-4f92-bceb-5e58beedad96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/invoices/1","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","invoices","1"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"4ad38c27-3459-4f7a-88bf-f2fffadefb80","name":"Delete an invoice","originalRequest":{"method":"DELETE","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/invoices/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jan 2020 13:24:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"1f9644e1c7950b275ead3dc23f4221d8\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"0fb2e65e-5f54-4585-a073-b21ae2dbed5b"},{"key":"X-Runtime","value":"0.319106"}],"cookie":[],"responseTime":null,"body":"Invoice destroyed successfully"}],"_postman_id":"d4e4be50-ae90-4f92-bceb-5e58beedad96"}],"id":"c37f5f7b-a69f-44bd-8080-f861d38fe9e4","_postman_id":"c37f5f7b-a69f-44bd-8080-f861d38fe9e4","description":""},{"name":"Invoice Payments","item":[{"name":"All Invoice Payments","id":"1c2ebf42-6f93-44fb-a17f-cdaf076dcdb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/invoice_payments","urlObject":{"path":["2.0","invoice_payments"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"b173c82e-45f4-47a3-b2db-a1a8fa0c465d","name":"All Invoice Payments","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/invoice_payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 23:18:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"57992d7513fb568aba222c5a8bd23cfd\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"1a9ca669-1f58-4550-bb12-ad768a158609"},{"key":"X-Runtime","value":"0.042725"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"receipts\": [\n {\n \"id\": 3,\n \"reference\": \"PYT2020\",\n \"description\": \"\",\n \"date\": \"2019-10-30\",\n \"amount\": \"1055.25\",\n \"kind\": \"received\",\n \"contact_id\": 2,\n \"account_id\": 7,\n \"allocations\": []\n },\n {\n \"id\": 4,\n \"reference\": \"InvPayRef#0032\",\n \"description\": \"Invoice Payment\",\n \"date\": \"2019-10-30\",\n \"amount\": \"10.5\",\n \"kind\": \"received\",\n \"contact_id\": 2,\n \"account_id\": 11,\n \"allocations\": [\n {\n \"id\": 6,\n \"amount\": \"10.5\",\n \"date\": \"2019-10-30T00:00:00.000+03:00\",\n \"allocatee_id\": 1,\n \"allocatee_type\": \"Invoice\",\n \"created_at\": \"2019-10-31T03:18:28.000+03:00\"\n }\n ]\n },\n {\n \"id\": 6,\n \"reference\": \"PYT33\",\n \"description\": \"\",\n \"date\": \"2019-10-30\",\n \"amount\": \"9.0\",\n \"kind\": \"received\",\n \"contact_id\": 2,\n \"account_id\": 8,\n \"allocations\": [\n {\n \"id\": 7,\n \"amount\": \"8.0\",\n \"date\": \"2019-10-30T00:00:00.000+03:00\",\n \"allocatee_id\": 1,\n \"allocatee_type\": \"Invoice\",\n \"created_at\": \"2019-10-31T04:08:24.000+03:00\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"1c2ebf42-6f93-44fb-a17f-cdaf076dcdb3"},{"name":"Get an invoice payment","id":"bc6fde4f-44fa-4dd4-8c12-a934459f2254","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/invoice_payments/6","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","invoice_payments","6"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"7059de97-46f2-49e3-b187-3ca5cde72c4f","name":"Get an invoice payment","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/invoice_payments/6"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 23:18:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"1d3f89c6a9e2852ad1957417f971aff1\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"0594c3e1-52e2-42b6-afcb-3af707d79460"},{"key":"X-Runtime","value":"0.027864"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 6,\n \"reference\": \"PYT33\",\n \"description\": \"\",\n \"date\": \"2019-10-30\",\n \"amount\": \"9.0\",\n \"kind\": \"received\",\n \"contact_id\": 2,\n \"account_id\": 8,\n \"allocations\": [\n {\n \"id\": 7,\n \"amount\": \"8.0\",\n \"date\": \"2019-10-30T00:00:00.000+03:00\",\n \"allocatee_id\": 1,\n \"allocatee_type\": \"Invoice\",\n \"created_at\": \"2019-10-31T04:08:24.000+03:00\"\n }\n ]\n}"}],"_postman_id":"bc6fde4f-44fa-4dd4-8c12-a934459f2254"},{"name":"Create an invoice payment","id":"93b7ecfc-5ff0-4d47-a38d-574301234e31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"invoice_payment\":\n { \n \t\"reference\": \"PYT49283\",\n \"invoice_id\": \"2\",\n \"account_id\": \"7\",\n \"date\": \"2021-01-07\",\n \"amount\": \"10.51\"\n }\n}\n"},"url":"https://www.qoyod.com/2.0/invoice_payments","description":"

Parameters

\n
    \n
  1. reference(required, unique)
    2. \n
  2. invoice_id(required): The invoice you want to pay
    3. \n
  3. account_id(required): The account credited for this payment
    4. \n
  4. date(required)
    5. \n
  5. amount(required)
    6. \n
\n","urlObject":{"path":["2.0","invoice_payments"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"608fdf03-3983-4bf0-9bad-a9263432c79f","name":"Create an invoice payment","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"invoice_payment\":\n { \n \t\"reference\": \"PYT49283\",\n \"invoice_id\": \"2\",\n \"account_id\": \"7\",\n \"date\": \"2021-01-07\",\n \"amount\": \"10.51\"\n }\n}\n"},"url":"https://www.qoyod.com/2.0/invoice_payments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 23:26:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"69496d14bd16b5f9820232fca1f24c32\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"ac27a84c-8373-433c-9a10-9bd6d93e722f"},{"key":"X-Runtime","value":"0.155847"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 9,\n \"reference\": \"PYT49283\",\n \"description\": \"Invoice Payment\",\n \"date\": \"2021-01-07\",\n \"amount\": \"10.51\",\n \"kind\": \"received\",\n \"contact_id\": 2,\n \"account_id\": 7,\n \"allocations\": [\n {\n \"id\": 10,\n \"amount\": \"10.51\",\n \"date\": \"2021-01-07T00:00:00.000+03:00\",\n \"allocatee_id\": 2,\n \"allocatee_type\": \"Invoice\",\n \"created_at\": \"2021-01-07T02:26:48.000+03:00\"\n }\n ]\n}"}],"_postman_id":"93b7ecfc-5ff0-4d47-a38d-574301234e31"},{"name":"Allocate existing credit note or receipt","id":"034a8588-53d4-4f7d-b491-c81b68ec7f9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"invoice\": {\n \"allocations_attributes\": [\n {\n \"source_type\": \"CreditNote\",\n \"source_id\": 8,\n \"amount\": \"618.45\",\n \"date\": \"2021-01-07\"\n }\n ]\n }\n}"},"url":"https://www.qoyod.com/2.0/invoices/3/allocations","description":"

Parameters

\n
    \n
  1. source_type(required): \"CreditNote\" or \"Receipt\"
    2. \n
  2. source_id(required): the id of the credit note or receipt
    3. \n
  3. date(required)
    4. \n
  4. amount(required)
    5. \n
\n","urlObject":{"path":["2.0","invoices","3","allocations"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"c8348618-f713-41d8-90bc-500cc525e9eb","name":"Create an invoice payment Copy","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"invoice\": {\n \"allocations_attributes\": [\n {\n \"source_type\": \"CreditNote\",\n \"source_id\": 8,\n \"amount\": \"618.45\",\n \"date\": \"2021-01-07\"\n }\n ]\n }\n}"},"url":"https://www.qoyod.com/2.0/invoices/3/allocations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Jan 2021 23:54:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"71593015bd5145c884b29cb6cb7f681e\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"f573f8a4-6cd8-4096-9567-f685f6e0293d"},{"key":"X-Runtime","value":"0.111765"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"invoice\": {\n \"id\": 3,\n \"description\": \"an example invoice\",\n \"issue_date\": \"2019-10-30\",\n \"due_date\": \"2019-10-30\",\n \"due_amount\": \"0.0\",\n \"paid_amount\": \"618.45\",\n \"total\": \"618.45\",\n \"contact_id\": 2,\n \"status\": \"Paid\",\n \"reference\": \"547894\",\n \"notes\": null,\n \"terms_conditions\": null,\n \"line_items\": [\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"\",\n \"quantity\": \"1.0\",\n \"unit_price\": \"589.0\",\n \"unit_type\": 6,\n \"unit\": \"قطعة\",\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"tax_percent\": \"5.0\",\n \"line_total\": \"618.45\",\n \"inventory_id\": 1\n }\n ],\n \"payments\": [\n {\n \"id\": 11,\n \"amount\": \"618.45\",\n \"date\": \"2019-10-30\",\n \"source_id\": 8,\n \"source_type\": \"CreditNote\",\n \"allocatee_id\": 3,\n \"allocatee_type\": \"Invoice\"\n }\n ]\n }\n}"}],"_postman_id":"034a8588-53d4-4f7d-b491-c81b68ec7f9a"}],"id":"0425a61c-5838-48be-8933-72e6b242f9a8","event":[{"listen":"prerequest","script":{"id":"abd02fe5-c7e9-4948-875d-30d31d600176","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e85f50bf-9d04-45bc-9e7a-32b1636a3841","type":"text/javascript","exec":[""]}}],"_postman_id":"0425a61c-5838-48be-8933-72e6b242f9a8","description":""},{"name":"Credit Notes","item":[{"name":"All credit notes","id":"a8196e10-ec2d-4369-9dc4-9fdd02aed062","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/credit_notes","urlObject":{"path":["2.0","credit_notes"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"83330614-2e68-4acc-8c7d-16c85c8473d5","name":"All credit notes","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/credit_notes"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 16:37:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"9d4a5efc52672af05405b7818bcefc41\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"04db3b15-b8b4-4a8c-ab1b-07520f7cdd46"},{"key":"X-Runtime","value":"0.268159"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"credit_notes\": [\n {\n \"id\": 8,\n \"reference\": \"CRN2\",\n \"contact_id\": 2,\n \"status\": \"Partially Used\",\n \"issue_date\": \"2019-10-30\",\n \"total_amount\": \"1036.35\",\n \"remaining_amount\": \"417.9\",\n \"notes\": \"\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"استرجاع\",\n \"price\": \"987.0\",\n \"quantity\": \"1.0\",\n \"unit_type\": 6,\n \"tax_percent\": \"5.0\",\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"total\": \"1036.35\",\n \"inventory_id\": 1\n }\n ]\n }\n ]\n}"}],"_postman_id":"a8196e10-ec2d-4369-9dc4-9fdd02aed062"},{"name":"Get a credit note","id":"8f8a2230-ff58-44b2-9a18-78334fe07bc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/credit_notes/8","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","credit_notes","8"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"76ed32dd-0064-4c80-b99e-5792290bca3a","name":"Get a credit note","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/credit_notes/8"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 16:37:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"edae65fe2f79ccf17ac9204a374a5a9e\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"de716fc9-f71e-4e3f-ae89-8be9904ad38d"},{"key":"X-Runtime","value":"0.054371"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"note\": {\n \"id\": 8,\n \"reference\": \"CRN2\",\n \"contact_id\": 2,\n \"status\": \"Partially Used\",\n \"issue_date\": \"2019-10-30\",\n \"total_amount\": \"1036.35\",\n \"remaining_amount\": \"417.9\",\n \"notes\": \"\",\n \"terms_conditions\": \"\",\n \"line_items\": [\n {\n \"product_id\": 1,\n \"product_name\": \"Samsung Phone\",\n \"description\": \"استرجاع\",\n \"price\": \"987.0\",\n \"quantity\": \"1.0\",\n \"unit_type\": 6,\n \"tax_percent\": \"5.0\",\n \"discount_percent\": \"0.0\",\n \"discount_amount\": \"0.0\",\n \"total\": \"1036.35\",\n \"inventory_id\": 1\n }\n ]\n }\n}"}],"_postman_id":"8f8a2230-ff58-44b2-9a18-78334fe07bc6"},{"name":"Delete a credit note","id":"0279fcd0-18ba-4f82-8d2c-6389fa3bb5fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/credit_notes/5","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","credit_notes","5"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"c865aaa1-fecc-414d-9281-3d4b28eb8de5","name":"Delete a credit note","originalRequest":{"method":"DELETE","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/credit_notes/5"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 02 Jan 2020 13:28:00 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"22053040727c46a4d4f132850383d7bd\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"aaea98d1-5c58-4288-b6bb-3ae08b6a81c2"},{"key":"X-Runtime","value":"0.252368"}],"cookie":[],"responseTime":null,"body":"Credit note destroyed successfully"}],"_postman_id":"0279fcd0-18ba-4f82-8d2c-6389fa3bb5fd"},{"name":"Create a credit note","id":"db2cf2ee-c70d-4eb0-bcd6-2abeb7c5e516","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"credit_note\": {\n \"contact_id\": 2,\n \"issue_date\": \"2019-10-30\",\n\t\t\"status\": \"Approved\",\n\t\t\"inventory_id\":\"1\",\n\t\t\"term_conditions\": \"\",\n \t\"notes\": \"\",\n \"line_items\": [\n {\n \"product_id\": 1,\n \"description\": \"استرجاع\",\n \"unit_price\": \"987.0\",\n \"quantity\": \"1.0\",\n \"discount_percent\": \"0.0\",\n \"tax_percent\": \"5.0\"\n }\n ],\n \"custom_fields\": {\n \"customfield1\": \"custom value 1\",\n \"customfield2\": \"custom value 2\"\n }\n }\n}"},"url":"https://www.qoyod.com/2.0/credit_notes","description":"

Parameters

\n
    \n
  1. contact_id(required): The id of the customer you are returning the products from
    2. \n
  2. reference (optional, unique): will be autogenerated if not sent.
    3. \n
  3. issue_date(required): The issue date - format: yyyy-mm-dd
    4. \n
  4. status(required): The status can be Draft or Approved
    5. \n
  5. inventory_id(required)
    6. \n
  6. terms_conditions(optional)
    7. \n
  7. notes(optional)
    8. \n
  8. line_items: An array of line items, each line item follows this format:
      \n
    1. product_id(required)
      2. \n
    2. description(optional)
      3. \n
    3. unit_price(required)
      4. \n
    4. quantity(required)
      5. \n
    5. unit_type(optional): unit type id of the product, defaults to the product's default unit type.
      6. \n
    6. discount(optional)
      7. \n
    7. discount_type(optional): determines whether the discount above is a percentage or an amount, can be percentage or amount, defaults to percentage
      8. \n
    8. tax_percent(optional)
      9. \n
    \n
    9. \n
  9. custom_fields(optional): Array of custom fields and their values to add to the credit note, custom fields must already be added in the website's settings page
    10. \n
\n","urlObject":{"path":["2.0","credit_notes"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"fc608262-eb60-4498-86e4-e0ce948c9c5f","name":"Create a credit note","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"credit_note\": {\n \"contact_id\": 2,\n \"issue_date\": \"2019-10-30\",\n\t\t\"status\": \"Approved\",\n\t\t\"inventory_id\":\"1\",\n\t\t\"term_conditions\": \"\",\n \t\"notes\": \"\",\n \"line_items\": [\n {\n \"product_id\": 1,\n \"description\": \"استرجاع\",\n \"unit_price\": \"987.0\",\n \"quantity\": \"1.0\",\n \"discount_percent\": \"0.0\",\n \"tax_percent\": \"5.0\"\n }\n ]\n }\n}"},"url":"https://www.qoyod.com/2.0/credit_notes"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 31 Oct 2019 00:59:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"201 Created"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"02e3c75bfb69d9caa9d19fddc316ea03\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"3a5395c5-1a3d-4b96-9ee0-bedcbded547b"},{"key":"X-Runtime","value":"0.338207"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 6,\n \"contact_id\": 2,\n \"note_no\": \"CRN2\",\n \"total_amount\": \"1036.35\",\n \"used_amount\": \"0.0\",\n \"issue_date\": \"2019-10-30\",\n \"created_at\": \"2019-10-31T03:59:05.779+03:00\",\n \"updated_at\": \"2019-10-31T03:59:05.779+03:00\",\n \"status\": \"Unused\",\n \"term_conditions\": \"\",\n \"notes\": \"\",\n \"commercial_document_id\": null,\n \"deleted_at\": null\n}"}],"_postman_id":"db2cf2ee-c70d-4eb0-bcd6-2abeb7c5e516"}],"id":"f66b3987-5408-4f46-92a5-e5e4f532d90b","_postman_id":"f66b3987-5408-4f46-92a5-e5e4f532d90b","description":""}],"id":"75ae66d1-d6e4-4dd9-84cb-5c58ca53d8e4","_postman_id":"75ae66d1-d6e4-4dd9-84cb-5c58ca53d8e4","description":""},{"name":"Receipts","item":[{"name":"Get All receipts","id":"d454da78-d74c-4f39-bf65-079c9bdfde0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/receipts","urlObject":{"path":["2.0","receipts"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"1bdc4b7e-1edd-46f4-8b5f-77e935087673","name":"Get All Receipts","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/receipts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 31 Oct 2019 01:00:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"9526d8598854687c45794f058062369c\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"767fbed5-d654-4dc9-8363-0b1432b7c81b"},{"key":"X-Runtime","value":"0.136474"}],"cookie":[],"responseTime":null,"body":"{\n \"receipts\": [\n {\n \"id\": 1,\n \"reference\": \"PYT1\",\n \"description\": \"\",\n \"date\": \"2019-10-30\",\n \"amount\": \"548.63\",\n \"kind\": \"paid\",\n \"contact_id\": 1,\n \"account_id\": 7,\n \"allocations\": [\n {\n \"id\": 1,\n \"amount\": \"548.63\",\n \"date\": \"2019-10-30T00:00:00.000+03:00\",\n \"allocatee_id\": 1,\n \"allocatee_type\": \"ContactBill\",\n \"created_at\": \"2019-10-30T22:22:48.000+03:00\"\n }\n ]\n },\n {\n \"id\": 2,\n \"reference\": \"Rent2019\",\n \"description\": \"Bill payment for rent\",\n \"date\": \"2019-10-30\",\n \"amount\": \"30000.0\",\n \"kind\": \"paid\",\n \"contact_id\": 4,\n \"account_id\": 11,\n \"allocations\": [\n {\n \"id\": 2,\n \"amount\": \"30000.0\",\n \"date\": \"2019-10-30T00:00:00.000+03:00\",\n \"allocatee_id\": 4,\n \"allocatee_type\": \"ContactBill\",\n \"created_at\": \"2019-10-31T01:40:44.000+03:00\"\n }\n ]\n },\n {\n \"id\": 3,\n \"reference\": \"PYT2020\",\n \"description\": \"\",\n \"date\": \"2019-10-30\",\n \"amount\": \"1055.25\",\n \"kind\": \"received\",\n \"contact_id\": 2,\n \"account_id\": 7,\n \"allocations\": [\n {\n \"id\": 5,\n \"amount\": \"1055.25\",\n \"date\": \"2019-10-30T00:00:00.000+03:00\",\n \"allocatee_id\": 1,\n \"allocatee_type\": \"ContactInvoice\",\n \"created_at\": \"2019-10-31T02:50:47.000+03:00\"\n }\n ]\n },\n {\n \"id\": 4,\n \"reference\": \"InvPayRef#0032\",\n \"description\": \"Invoice Payment\",\n \"date\": \"2019-10-30\",\n \"amount\": \"10.5\",\n \"kind\": \"received\",\n \"contact_id\": 2,\n \"account_id\": 11,\n \"allocations\": [\n {\n \"id\": 6,\n \"amount\": \"10.5\",\n \"date\": \"2019-10-30T00:00:00.000+03:00\",\n \"allocatee_id\": 2,\n \"allocatee_type\": \"ContactInvoice\",\n \"created_at\": \"2019-10-31T03:18:28.000+03:00\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"d454da78-d74c-4f39-bf65-079c9bdfde0e"},{"name":"Get a receipt","id":"192d146d-af8f-4574-b979-297de4d7e1f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/receipts/1","urlObject":{"path":["2.0","receipts","1"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"117a74f6-2f8a-4c69-bdda-bd5fa2d64df6","name":"Get a Receipt","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/receipts/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 31 Oct 2019 01:00:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"63bdb447e3f0bb1eb270ca8cbabe4bc7\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"0a29796f-246e-40f7-a706-f3b0e9342806"},{"key":"X-Runtime","value":"0.077426"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"reference\": \"PYT1\",\n \"description\": \"\",\n \"date\": \"2019-10-30\",\n \"amount\": \"548.63\",\n \"kind\": \"paid\",\n \"contact_id\": 1,\n \"account_id\": 7,\n \"allocations\": [\n {\n \"id\": 1,\n \"amount\": \"548.63\",\n \"date\": \"2019-10-30T00:00:00.000+03:00\",\n \"allocatee_id\": 1,\n \"allocatee_type\": \"ContactBill\",\n \"created_at\": \"2019-10-30T22:22:48.000+03:00\"\n }\n ]\n}"}],"_postman_id":"192d146d-af8f-4574-b979-297de4d7e1f1"},{"name":"Create Receipt","id":"455182d0-237b-4cb2-a70b-85ef1cadf497","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"receipt\": {\r\n\t\t\"contact_id\": \"2\",\r\n\t\t\"reference\": \"api-customer-payment-1\",\r\n\t\t\"kind\": \"received\",\r\n\t\t\"account_id\": 7,\r\n\t\t\"amount\": 30,\r\n\t\t\"description\": \"Testing api\",\r\n\t\t\"date\": \"2019-10-30\"\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/receipts","description":"

Parameters

\n
    \n
  1. contact_id(required)
    2. \n
  2. reference(required, unique)
    3. \n
  3. kind(required): received or paid
    4. \n
  4. account_id(required)
    5. \n
  5. amount(required)
    6. \n
  6. description(optional)
    7. \n
  7. date(required)
    8. \n
\n","urlObject":{"path":["2.0","receipts"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"e15d91e3-ff30-4ea5-a768-bf05f8a28c7b","name":"Create Receipt","originalRequest":{"method":"POST","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"receipt\": {\r\n\t\t\"contact_id\": \"2\",\r\n\t\t\"reference\": \"api-customer-payment-1\",\r\n\t\t\"kind\": \"received\",\r\n\t\t\"account_id\": 7,\r\n\t\t\"amount\": 30,\r\n\t\t\"description\": \"Testing api\",\r\n\t\t\"date\": \"2019-10-30\"\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/receipts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 31 Oct 2019 01:01:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"201 Created"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"Location","value":"/api/2.0/receipts/5"},{"key":"ETag","value":"W/\"c88576c90e167c3192c9512036a087b1\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"a15b3b43-06d6-48b9-b4aa-d627f529bd4c"},{"key":"X-Runtime","value":"0.130410"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 5,\n \"contact_id\": 2,\n \"reference\": \"api-customer-payment-1\",\n \"account_id\": 7,\n \"description\": \"Testing api\",\n \"date\": \"2019-10-30\",\n \"amount\": \"30.0\",\n \"created_at\": \"2019-10-31T04:01:24.473+03:00\",\n \"updated_at\": \"2019-10-31T04:01:24.473+03:00\",\n \"kind\": \"received\"\n}"}],"_postman_id":"455182d0-237b-4cb2-a70b-85ef1cadf497"},{"name":"Allocate a receipt","id":"f290e0aa-f7ae-4d73-8d3f-8504b0e9e36f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"allocation\": {\r\n\t\t\"allocatee_type\": \"Invoice\", \r\n\t\t\"allocatee_id\": \"26\",\r\n\t\t\"amount\": \"10\"\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/receipts/3/allocations","description":"

Parameters

\n
    \n
  1. allocatee_type(required): The type of document you are allocating to (Invoice, Bill, CreditNote, or DebitNote)
    2. \n
  2. allocatee_id(required): id of the invoice, bill, or note
    3. \n
  3. amount(required): amount of allocation
    4. \n
\n","urlObject":{"path":["2.0","receipts","3","allocations"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"1e3bc4d1-a62c-40bc-a24b-ed93beacca37","name":"Allocate a receipt","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"allocation\": {\r\n\t\t\"allocatee_type\": \"Invoice\", \r\n\t\t\"allocatee_id\": \"26\",\r\n\t\t\"amount\": \"10\"\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/receipts/3/allocations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 11 Jan 2021 16:42:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.16.1"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"e93e7ceeb9f64cee4664bb70c9e616bc\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"6ac5aa42-d318-4868-9bec-cb47db26f0de"},{"key":"X-Runtime","value":"0.647537"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 13,\n \"amount\": \"10.0\",\n \"date\": \"2019-10-30T00:00:00.000+03:00\",\n \"allocatee_id\": 26,\n \"allocatee_type\": \"Invoice\",\n \"created_at\": \"2021-01-11T19:42:39.000+03:00\"\n}"}],"_postman_id":"f290e0aa-f7ae-4d73-8d3f-8504b0e9e36f"},{"name":"Delete a receipt","id":"2dc225b3-cca4-4266-99b6-28df02bc0858","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/receipts/5","urlObject":{"path":["2.0","receipts","5"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"4868bdbf-3a27-467a-8d6f-d2d39802a49f","name":"Delete a Receipt","originalRequest":{"method":"DELETE","header":[{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"url":"https://www.qoyod.com/2.0/receipts/5"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 31 Oct 2019 01:02:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"7215ee9c7d9dc229d2921a40e899ec5f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"34ad73ec-b11e-4f55-b687-9a65eecdc0cf"},{"key":"X-Runtime","value":"0.103163"}],"cookie":[],"responseTime":null,"body":" "}],"_postman_id":"2dc225b3-cca4-4266-99b6-28df02bc0858"}],"id":"8a19d880-67fd-4ba6-a2b7-d136b397281c","_postman_id":"8a19d880-67fd-4ba6-a2b7-d136b397281c","description":""},{"name":"Journal Entries","item":[{"name":"All journal entries","id":"fe37c692-661e-4a6f-b541-208185e56e51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/journal_entries","urlObject":{"path":["2.0","journal_entries"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"f7828530-edcb-4079-8dcd-590ea90983d3","name":"All journal entries","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/journal_entries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 31 Oct 2019 01:25:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"af5faec55d8d12eadd1ec4563b380ac9\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"88debecb-3d42-4dd3-8c97-be7021862ec1"},{"key":"X-Runtime","value":"0.075877"}],"cookie":[],"responseTime":null,"body":"{\n \"journal_entries\": [\n {\n \"id\": 1,\n \"date\": \"2019-10-30\",\n \"description\": \"راتب دحيم\",\n \"total_debit\": \"5000.0\",\n \"total_credit\": \"5000.0\",\n \"debit_amounts\": [\n {\n \"amount\": \"5000.0\",\n \"account_id\": 13,\n \"entry_id\": 26,\n \"all_comments\": []\n }\n ],\n \"credit_amounts\": [\n {\n \"amount\": \"5000.0\",\n \"account_id\": 8,\n \"entry_id\": 26,\n \"all_comments\": []\n }\n ]\n },\n {\n \"id\": 2,\n \"date\": \"2019-10-30\",\n \"description\": \"test description\",\n \"total_debit\": \"124.0\",\n \"total_credit\": \"124.0\",\n \"debit_amounts\": [\n {\n \"amount\": \"23.0\",\n \"account_id\": 9,\n \"entry_id\": 27,\n \"all_comments\": [\n \"debit 23 riyals customer 2\"\n ],\n \"contact_id\": 2\n },\n {\n \"amount\": \"101.0\",\n \"account_id\": 11,\n \"entry_id\": 27,\n \"all_comments\": [\n \"debit 101 riyals account_id 11\"\n ]\n }\n ],\n \"credit_amounts\": [\n {\n \"amount\": \"71.0\",\n \"account_id\": 10,\n \"entry_id\": 27,\n \"all_comments\": [\n \"credit 71 riyals account_id 10\"\n ]\n },\n {\n \"amount\": \"53.0\",\n \"account_id\": 15,\n \"entry_id\": 27,\n \"all_comments\": [\n \"credit 53 riyals account_id 15\"\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"fe37c692-661e-4a6f-b541-208185e56e51"},{"name":"Get a journal entry","id":"2df8af2b-93c3-44c8-9b6c-c6cf2ec8de1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/journal_entries/1","description":"

URL Parameters

\n
    \n
  1. /:id
    2. \n
\n","urlObject":{"path":["2.0","journal_entries","1"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"e4a7c8be-be50-486d-b967-25ab276eaab6","name":"Get a journal entry","originalRequest":{"method":"GET","header":[{"key":"API-KEY","value":"insert-your-api-key-here"}],"url":"https://www.qoyod.com/2.0/journal_entries/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 31 Oct 2019 01:15:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"dab6f1bd27e591c4f32b86062d15ab58\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"fcbede39-dab9-4b81-b3dd-06309d8507c7"},{"key":"X-Runtime","value":"0.144105"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"date\": \"2019-10-30\",\n \"description\": \"راتب دحيم\",\n \"total_debit\": \"5000.0\",\n \"total_credit\": \"5000.0\",\n \"debit_amounts\": [\n {\n \"amount\": \"5000.0\",\n \"account_id\": 13,\n \"entry_id\": 26,\n \"all_comments\": []\n }\n ],\n \"credit_amounts\": [\n {\n \"amount\": \"5000.0\",\n \"account_id\": 8,\n \"entry_id\": 26,\n \"all_comments\": []\n }\n ]\n}"}],"_postman_id":"2df8af2b-93c3-44c8-9b6c-c6cf2ec8de1b"},{"name":"Create a journal entry","id":"14582a17-d5ed-4f52-9fe5-e669af07f44d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"journal_entry\":{\r\n\t\t\"description\": \"test description\", \r\n\t\t\"date\":\"2019-10-30\",\r\n\t\t\"debit_amounts\":[\r\n\t\t\t{\r\n\t\t\t\t\"account_id\": 9,\r\n\t\t\t\t\"contact_id\": 2,\r\n\t\t\t\t\"amount\": 23,\r\n\t\t\t\t\"comment\": \"debit 23 riyals customer 2\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"account_id\": 11,\r\n\t\t\t\t\"amount\": 101,\r\n\t\t\t\t\"comment\": \"debit 101 riyals account_id 11\"\r\n\t\t\t}\r\n\t\t],\r\n\t\t\"credit_amounts\":[\r\n\t\t\t{\r\n\t\t\t\t\"account_id\": 10,\r\n\t\t\t\t\"amount\": 71,\r\n\t\t\t\t\"comment\": \"credit 71 riyals account_id 10\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"account_id\": 15,\r\n\t\t\t\t\"amount\": 53,\r\n\t\t\t\t\"comment\": \"credit 53 riyals account_id 15\"\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/journal_entries","description":"

Parameters

\n
    \n
  1. description(required)
    2. \n
  2. date(required):format yyyy-mm-dd
    3. \n
  3. debit_amounts(required): array of debit amounts
      \n
    1. account_id(required): the account you want to debit
      2. \n
    2. contact_id(optional): can only choose customers if account id = 9, and can only choose vendors if account id = 14
      3. \n
    3. amount(required)
      4. \n
    4. comment(optional)
      5. \n
    \n
    4. \n
  4. credit_amounts(required): array of credit amounts
      \n
    1. account_id(required): the account you want to credit
      2. \n
    2. contact_id(optional): can only choose customers if account id = 9, and can only choose vendors if account id = 14
      3. \n
    3. amount(required)
      4. \n
    4. comment(optional)
      5. \n
    \n
    5. \n
\n","urlObject":{"path":["2.0","journal_entries"],"host":["https://www.qoyod.com"],"query":[],"variable":[]}},"response":[{"id":"b3b5ecfc-52fe-4304-b4a1-52f43d4e5daf","name":"Create a Journal Entry","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"API-KEY","value":"insert-your-api-key-here","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"journal_entry\":{\r\n\t\t\"description\": \"test description\", \r\n\t\t\"date\":\"2019-10-30\",\r\n\t\t\"debit_amounts\":[\r\n\t\t\t{\r\n\t\t\t\t\"account_id\": 9,\r\n\t\t\t\t\"contact_id\": 2,\r\n\t\t\t\t\"amount\": 23,\r\n\t\t\t\t\"comment\": \"debit 23 riyals customer 2\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"account_id\": 11,\r\n\t\t\t\t\"amount\": 101,\r\n\t\t\t\t\"comment\": \"debit 101 riyals account_id 11\"\r\n\t\t\t}\r\n\t\t],\r\n\t\t\"credit_amounts\":[\r\n\t\t\t{\r\n\t\t\t\t\"account_id\": 10,\r\n\t\t\t\t\"amount\": 71,\r\n\t\t\t\t\"comment\": \"credit 71 riyals account_id 10\"\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"account_id\": 15,\r\n\t\t\t\t\"amount\": 53,\r\n\t\t\t\t\"comment\": \"credit 53 riyals account_id 15\"\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n}"},"url":"https://www.qoyod.com/2.0/journal_entries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 31 Oct 2019 01:18:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx/1.14.1"},{"key":"Status","value":"200 OK"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, PUT, OPTIONS"},{"key":"Access-Control-Allow-Headers","value":"*"},{"key":"ETag","value":"W/\"54f85fde62b05eed399b12ffd4bd3623\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"X-Request-Id","value":"dd650b64-e746-47b5-a78c-c71c42e79b2f"},{"key":"X-Runtime","value":"0.238328"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 2,\n \"date\": \"2019-10-30\",\n \"description\": \"test description\",\n \"total_debit\": \"124.0\",\n \"total_credit\": \"124.0\",\n \"debit_amounts\": [\n {\n \"amount\": \"23.0\",\n \"account_id\": 9,\n \"entry_id\": 27,\n \"all_comments\": [\n \"debit 23 riyals customer 2\"\n ],\n \"contact_id\": 2\n },\n {\n \"amount\": \"101.0\",\n \"account_id\": 11,\n \"entry_id\": 27,\n \"all_comments\": [\n \"debit 101 riyals account_id 11\"\n ]\n }\n ],\n \"credit_amounts\": [\n {\n \"amount\": \"71.0\",\n \"account_id\": 10,\n \"entry_id\": 27,\n \"all_comments\": [\n \"credit 71 riyals account_id 10\"\n ]\n },\n {\n \"amount\": \"53.0\",\n \"account_id\": 15,\n \"entry_id\": 27,\n \"all_comments\": [\n \"credit 53 riyals account_id 15\"\n ]\n }\n ]\n}"}],"_postman_id":"14582a17-d5ed-4f52-9fe5-e669af07f44d"}],"id":"fdd2bf11-1d1b-4bb8-821e-fbbf7d9856b6","_postman_id":"fdd2bf11-1d1b-4bb8-821e-fbbf7d9856b6","description":""}],"id":"ca6102c4-b645-4d88-85e1-75810ddc8a9c","_postman_id":"ca6102c4-b645-4d88-85e1-75810ddc8a9c","description":""}],"event":[{"listen":"prerequest","script":{"id":"30bb4503-cfa9-449e-83cf-67a49210581d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"813fd1d8-6519-4b8d-9161-7a8df7e13991","type":"text/javascript","exec":[""]}}],"variable":[{"key":"domain","value":"https://www.qoyod.com"},{"key":"api_key","value":"insert-your-api-key-here"}]}