API Documentation

Integrate with CodeTech ERP using our REST API. Available with any paid module subscription.

Contents
Base URL
https://codetech-solutions.com/api/v1

Authentication

All API requests require a Bearer token. Obtain one by logging in.

POST /auth/login
Request Body
{
    "email": "user@company.com",
    "password": "your-password"
}
Response
{
    "token": "1|abc123def456...",
    "user": {
        "id": 1,
        "name": "John Doe",
        "email": "john@company.com"
    }
}
GET /auth/me Auth Required

Header:

Authorization: Bearer {your-token}
POST /auth/logout Auth Required

Rate Limits

TierRequests / Minute
Free60
Growth300
Business600
Unlimited1,000

Check response headers: X-RateLimit-Limit, X-RateLimit-Remaining

Customers

GET /customers List all customers
GET /customers/{id} Get customer details
POST /customers Create customer
PUT /customers/{id} Update customer
DELETE /customers/{id} Delete customer

Products

GET /products List all products
GET /products/{id} Get product details
POST /products Create product
PUT /products/{id} Update product
DELETE /products/{id} Delete product

Invoices Read-only

GET /invoices List all invoices
GET /invoices/{id} Get invoice details

Quotations Read-only

GET /quotations List all quotations
GET /quotations/{id} Get quotation details

Purchase Orders Read-only

GET /purchase-orders List all purchase orders
GET /purchase-orders/{id} Get PO details

Inventory

GET /inventory/stock Get stock levels for all products

Suppliers

GET /suppliers List all suppliers
GET /suppliers/{id} Get supplier details
POST /suppliers Create supplier
PUT /suppliers/{id} Update supplier
DELETE /suppliers/{id} Delete supplier

Payments

GET /payments List all payments
GET /payments/{id} Get payment details
POST /payments Record payment

Employees Read-only

GET /employees List all employees
GET /employees/{id} Get employee details

Leads (CRM)

GET /leads List all leads
GET /leads/{id} Get lead details
POST /leads Create lead
PUT /leads/{id} Update lead
DELETE /leads/{id} Delete lead

Industry Modules

Industry-specific endpoints are available based on your active modules. Each module requires the corresponding plan subscription.

Lawyer

Cases
GET /law-cases List all cases
GET /law-cases/{id} Get case details
POST /law-cases Create case
PUT /law-cases/{id} Update case
DELETE /law-cases/{id} Delete case
Clients
GET /law-clients List all law clients
GET /law-clients/{id} Get client details
POST /law-clients Create client
PUT /law-clients/{id} Update client
DELETE /law-clients/{id} Delete client

Clinic

Patients
GET /patients List all patients
GET /patients/{id} Get patient details
POST /patients Create patient
PUT /patients/{id} Update patient
DELETE /patients/{id} Delete patient
Appointments
GET /clinic-appointments List appointments
GET /clinic-appointments/{id} Get appointment details
POST /clinic-appointments Book appointment

School

GET /students List all students
GET /students/{id} Get student details
POST /students Create student
PUT /students/{id} Update student
DELETE /students/{id} Delete student

Restaurant Read-only

Orders
GET /restaurant-orders List orders
GET /restaurant-orders/{id} Get order details
Menu Items
GET /menu-items List menu items
GET /menu-items/{id} Get menu item details

Real Estate

Properties
GET /properties List all properties
GET /properties/{id} Get property details
POST /properties Create property
PUT /properties/{id} Update property
DELETE /properties/{id} Delete property
Leases Read-only
GET /leases List all leases
GET /leases/{id} Get lease details

Hotel

Reservations
GET /hotel-reservations List reservations
GET /hotel-reservations/{id} Get reservation details
POST /hotel-reservations Create reservation
Guests
GET /hotel-guests List all guests
GET /hotel-guests/{id} Get guest details
POST /hotel-guests Create guest
PUT /hotel-guests/{id} Update guest
DELETE /hotel-guests/{id} Delete guest

Car Rental

Bookings
GET /rental-bookings List bookings
GET /rental-bookings/{id} Get booking details
POST /rental-bookings Create booking
Vehicles Read-only
GET /rental-vehicles List vehicles
GET /rental-vehicles/{id} Get vehicle details

Salon

Appointments
GET /salon-appointments List appointments
GET /salon-appointments/{id} Get appointment details
POST /salon-appointments Book appointment
Clients
GET /salon-clients List salon clients
GET /salon-clients/{id} Get client details
POST /salon-clients Create client
PUT /salon-clients/{id} Update client
DELETE /salon-clients/{id} Delete client

Gym

GET /gym-members List all members
GET /gym-members/{id} Get member details
POST /gym-members Create member
PUT /gym-members/{id} Update member
DELETE /gym-members/{id} Delete member

E-Commerce

Orders Read-only
GET /ecom-orders List orders
GET /ecom-orders/{id} Get order details
Products
GET /ecom-products List products
GET /ecom-products/{id} Get product details
POST /ecom-products Create product
PUT /ecom-products/{id} Update product
DELETE /ecom-products/{id} Delete product

Logistics

GET /shipments List shipments
GET /shipments/{id} Get shipment details with tracking
POST /shipments Create shipment

Error Handling

CodeMeaning
200Success
201Created
401Unauthenticated — invalid or expired token
403Forbidden — insufficient permissions
404Not Found
422Validation Error
429Too Many Requests — rate limit exceeded
500Server Error
Error Response Format
{
    "message": "The given data was invalid.",
    "errors": {
        "name": ["The name field is required."],
        "email": ["The email has already been taken."]
    }
}
CodeTech Support
Online
Start a conversation

Hi there! Tell us a bit about yourself so we can assist you better.

Powered by CodeTech