Wateer API

Welcome to Wateer API documentation. Follow the steps to register, create branches, and send receipts.

[ Base URL: https://api.wateer.com.sa/ ]

How to Send a Receipt to Wateer

  • 1. Register & Create Branch, POS:
    • You must first register and create a branch on the platform.
    • Once your branch and POS are set up, you can proceed to the next step.
    • If you encounter any issues, please contact [email protected].
  • 2. Create and Send Receipt:
    • Endpoint: https://api.wateer.com.sa/send-invoice
    • Method: POST
    • Authentication: Required
    • Request Headers: Required 
      {
  "Pos-Api-Key": "your-api-key"
}
    • Request Body: 
      {
  "invoice_header": {
    "BILL_DATE": "2024:08:02",  #Required,  // type: string (Date in 'YYYY:MM:DD' format)
    "TIME": "12:34:56",  #Required,  // type: string (Time in 'HH:MM:SS' format)
    "TIMESTAMP": "1635872693.3186214", #Required, // type: string (Unix timestamp)
    "BILL_NO": "64", #Required, // type: string (Bill number)
    "BILL_ID": 241103800064, // type: integer (Bill ID)
    "BILL_SER": "20240000011041241103800064", // type: string (Bill serial number)
    "TAX_BILL_TYP": 1 or 2, #Required, // type: int (Tax bill type 2 for business invoice and 1 for simple invoice)
    "QR_CODE": "ASLYtNix2YPYqSDZhtis2K8g2YTZhNin2KrYtdin2YTYp9iqAg8zMTA3OTg5NTA4MDAwMDNFDI...", #Required, // type: string (QR code data)
    "ORDER_TYP": "PICKUP, DELIVERY, ETC.." //type: string (Order type)

    "customer": {
      "C_NAME": "customer name", // type: string (Customer name)
      "C_PHONE_NUMBER": "540377979", // type: string (Customer phone number)
      "C_LOYALTY_ID": "00988237KRDzaq" // type: string (Loyalty ID)
    },

    "items": [
      {
        "I_QTY": 2, #Required, // type: integer (Item quantity)
        "I_SKU": "002-128-A52-W-BLU", #Required, // type: string (Item SKU)
        "I_NAME_EN": "Samsung Galaxy A-52 128GB DS Blue", #Required, // type: string (Item name in English)
        "I_NAME_AR": "سامسونج جالكسي A-52 128 جيجا بايت DS أزرق", #Required, // type: string (Item name in Arabic)
        "I_DESCRIPTION_EN": "item description", // type: string (Item description in English)
        "I_DESCRIPTION_AR": "item description Arabic", // type: string (Item description in Arabic)
        "I_PRICE_EX_VAT": 500, #Required, // type: float (Price excluding VAT)
        "I_PRICE_INC_VAT": 500, #Required, // type: float (Price including VAT)
        "I_TOT_EX_VAT": 1000, #Required, // type: float (Total excluding VAT)
        "I_TOT_INC_VAT": 1150, #Required, // type: float (Total including VAT)
        "I_VAT_AMT": 75, #Required, // type: float (VAT amount)
        "I_VAT_TYP": "S",  #Required,  // type: string (VAT type)
        "DIS_AMT": 0, // type: float (Discount amount)
        "DIS_TOT": 0, // type: float (Discount total)
        "ITM_UNT_AR": "حبة", // type: string (Item unit in Arabic)
        "ITM_UNT_EN": "Pecs", // type: string (Item unit in English)
        "RCRD_NO": 1,  // type: integer (Record number)
        "FREE_QTY": 0  // type: integer (Free quantity)
      }
    ],

    "A_DESC": "مبيعات نقدية",  // type: string (Description)
    "Cashier_CODE": "",  // type: string (Cashier code)
    "Cashier_NAME": "مبيعات نقدية",  // type: string (Cashier name)
    "WH_CODE": 39,  // type: integer (Warehouse code)
    "WH_NAME": "مخزن النرجس",  // type: string (Warehouse name)
    "AD_U_ID": 279,  // type: integer (User ID)
  },
  
  "payment_receipt": {
    "PAY_TYPE": "CASH, MADA, VISA, TAMARA, ETC..", #Required,  // type: string (Payment type)
    "CASH_PAY_AMOUNT": 4525,  // type: float (Cash payment amount)
    "OTHER_PAY_AMOUNT": 0,  // type: float (Other payment amount)
    "CASHIER_NO": 102,  // type: integer (Cashier number)
    "CASHIER_NAME_ID": "ABDULLAH",  // type: string (Cashier name ID)
    "BILL_CURRENCY": "SAR", #Required,  // type: string (Bill currency)
    "BILL_DOC_TYPE": 1  // type: integer (Bill document type)
  },

  "invoice_footer": {
    "PRODUCT_COUNT": 5,  #Required// type: integer (Product count)
    "SUBTOTAL_AMT": 4525, #Required,  // type: float (Subtotal amount)
    "VAT_AMT": 525, #Required,  // type: float (VAT amount)
    "TOTAL_AMT": 4000, #Required,  // type: float (Total amount)
    "DISC_AMT": 100,  // type: float (Discount amount)
    "TOTAL_READ_AMT": "أربعة آلاف وخمسمئة وخمسة وعشرون ريال سعودي" #Required  // type: string (Total amount in words)
  },

  "btob_tax": {
    "B_CUSTOMER": “شركة مسارات وتير”, //type: string (Business Customer Name)
    "B_TAX_CODE": "0000000000", //type: integer (Business Tax Code)
    "B_ADD": “الرياض، طريق الملك عبدالعزيز، حي الصحافة 2992”, //type: string (Business Address)
  },

  "branch_info": {
    "BRN_NO": 2,  // type: integer (Branch number)
    "RC_CODE": "0000000",  // type: string (RC code)
    "BRN_LADD": "الرياض - حي العمل - مركز الكترون التجاري",  // type: string (Branch address in Arabic)
    "BRN_FADD": "Riyadh - Al-Amal Dist. - Electron Center",  // type: string (Branch address in English)
    "BRN_LNAME": "الحلول",  // type: string (Branch name in Arabic)
    "BRN_FNAME": "ultimate",  // type: string (Branch name in English)
    "BRN_LFAX": "الرقم الموحد : 9000000",  // type: string (Fax number in Arabic)
    "BRN_FFAX": "Unified No. 95456456",  // type: string (Fax number in English)
    "BRN_FTELE": "Tele No : 132132 - Fax No : 321312",  // type: string (Telephone number in English)
    "BRN_LTELE": "هاتف : 0000 - فاكس : 00000",  // type: string (Telephone number in Arabic)
    "CMP_LNAME": "شركة الحلول النهائية",  // type: string (Company name in Arabic)
    "CMP_FNAME": "Ultimate",  // type: string (Company name in English)
    "BRN_TAX_CODE": "0000000000"  // type: string (Branch tax code)
  }
}

How to Reprint a Receipt

  • 1. Reprint a Receipt:
    • Endpoint: /api/receipt/action/reprint
    • Method: POST
    • Authentication: Required
    • Request Headers: Required 
      {
  "Pos-Api-Key": "your-pos-api-key"
}
    • Request Body: 
      {
  "BILL_ID": 241103800064  #Required // type: integer (Valid receipt ID)
}