{"info":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","description":"

Zata is a modern API platform by HIQ Africa (Norrsken House, Kigali, Rwanda) for automated Sales Tax compliance, certified by the Rwanda Revenue Authority (RRA). Built for scale, trust, and developer velocity, Zata blends local regulatory expertise with robust documentation and seamless integrations tailored to Rwanda’s market. Listed on OpenFn.org (Zata Adaptor Docs), Zata connects with 70+ systems via OpenFn’s workflow automation, enabling fast, interoperable data flows for businesses, NGOs, and governments.

Keep your Authorization header set to Bearer (see collection variables).
\n
Many endpoints require companyId (and sometimes branchId) headers — ensure these are correct for your tenant.
\n
Use App Data endpoints to populate valid IDs (tax, units, categories, etc.).
\n
Prefer calculating totals with /transaction/calculate before creating sales.
\n

Get Started Today

Sign Up: https://ebm.zata.rw/register
\n
Contact: info@hiq.africa
\n
API Docs: Zata API Documentation
\n
Version: 1.6 (Nov 2025)
\n

Why Choose Zata?

Rapid Onboarding: Get your API key and a guided 15‑minute setup to go live quickly.
\n
Global Integrations: Connect to Odoo, QuickBooks, and 70+ apps via OpenFn (or engage HIQ Africa for custom integrations).
\n
Full Transparency: Clear API connectivity policy, versioning, and change logs.
\n
Developer‑Centric: Low‑code workflows, a smart IDE, example payloads, and open tooling.
\n
Scalable & Secure: Trusted in 40+ countries; built for sensitive data, high throughput, and compliance.
\n

API Overview

Company Initialization

Manage company records: list, create, update, retrieve.
\n
Use Case: Centralize company data and permissions for multi‑branch operations.
\n

Branch Management

Control branch operations: list, create, update, retrieve.
\n
Use Case: Scale to new locations while maintaining consistent governance.
\n

Product Management

Maintain catalog and stock: list, add, update, increase/reduce quantity.
\n
Use Case: Keep inventory accurate for real‑time sales, pricing, and forecasting.
\n

Transactions

Sales, refunds, proformas, calculations; signed receipt URLs and downloads.
\n
Use Case: Automate invoicing, ensure RRA compliance, reconcile revenue.
\n

App Data

Reference lists (product types, payment modes, taxes, units, categories).
\n
Use Case: Power dropdowns, validations, and consistent data entry across UI.
\n

Test

System connectivity health checks.
\n
Use Case: Verify availability in CI/CD and pre‑production smoke tests.
\n

Parties

Manage customers and suppliers: list, create.
\n
Use Case: Maintain a clean CRM/vendor list for faster checkout and purchasing.
\n
Dev Notes: Validate required fields; use pagination and partyType for filtering.
\n

Expenses

Track operational costs: list expenses, create expense, fetch expense categories.
\n
Use Case: Record petty cash, utilities, and other OPEX; analyze spend by category.
\n
Dev Notes: Requires companyId/branchId; use categories and payment modes from reference endpoints.
\n

Finances

Summaries by payment mode (cash, mobile money, card, etc.).
\n
Use Case: End‑of‑day cash‑up and reconciliation; cross‑check POS totals with books.
\n

Purchases

Create internal purchase transactions to restock inventory.
\n
Use Case: Record supplier deliveries; update on‑hand stock and batches.
\n
Dev Notes: Validate productID, paymentMethodID, batchNumber; optionally expireDate, movingUnit.
\n

Transaction PDFs (Signature + Download)

Generate signed URL and download transaction PDFs.
\n
Use Case: Share or print RRA‑compliant receipts/invoices for audits and customers.
\n

What Developers Can Expect

Clear Headers: Most endpoints require companyId; many also require branchId.
\n
Validations: Helpful error messages; enums/IDs come from App Data.
\n
Idempotency: Support safe retries where appropriate (client‑generated ids recommended).
\n
Versioning: Stable v1; deprecations communicated ahead of time.
\n
Testability: Health check endpoint; realistic example payloads.
\n

Endpoint Quick Map

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Path	Method	Purpose	Required Headers	Notes
/api/v1/company	GET	List companies (paginated)	Authorization	perPage, page
/api/v1/company	POST	Create company	Authorization	name, address, phone, email, tin
/api/v1/company	PUT	Update company	Authorization, companyId	Partial updates supported
/api/v1/company/{companyId}	GET	Get company by id	Authorization, companyId	Returns insurance block if available
/api/v1/company/branch	GET	List branches	Authorization, companyId	perPage, page
/api/v1/company/branch	POST	Create branch	Authorization, companyId	name, phone, address, branchCategoryID
/api/v1/company/branch	PUT	Update branch	Authorization, companyId, branchId	name, phone, address
/api/v1/product/branch	GET	List branch products	Authorization, companyId, branchId	perPage, page, searchQuery
/api/v1/product	POST	Create product	Authorization, companyId, branchId	Requires valid IDs from App Data
/api/v1/product/{productId}	GET	Get product by id	Authorization, companyId, branchId	Includes batch/stock details
/api/v1/product/{productId}	PUT	Update product	Authorization, companyId, branchId	e.g., name, branchProductCategoryID
/api/v1/product/increase-quantity/{productId}	PUT	Increase product stock	Authorization, companyId, branchId	description, quantity, salePrice, batchNumber
/api/v1/product/reduce-quantity/{productId}	PUT	Reduce product stock	Authorization, companyId, branchId	quantity, description, batchNumber
/api/v1/transaction	GET	List transactions	Authorization, companyId, branchId	perPage, page, fromDate, toDate, invoiceType
/api/v1/transaction/sale	POST	Create sale	Authorization, companyId, branchId	items[productID, units, unitPrice, batchNumber,…]
/api/v1/transaction/refund/{transactionId}	POST	Create refund	Authorization, companyId, branchId	transactionDate, purchaseCode, note
/api/v1/transaction/proforma	POST	Create proforma	Authorization, companyId, branchId	Like sale; does not alter stock
/api/v1/transaction/calculate	POST	Calculate totals	Authorization, companyId, branchId	Returns line‑level tax/discount/totals
/api/v1/transaction/{transactionId}	GET	Get transaction by id	Authorization, companyId, branchId	Includes item breakdowns
/api/v1/transaction/download-signature/{transactionId}	GET	Generate signed URL	Authorization, companyId, branchId	downloadSize=A4
/api/v1/transaction/download	GET	Download PDF	Authorization, companyId, branchId	Requires expires, id, signature
/api/v1/party	GET	List parties	Authorization, companyId	partyType=Customer
/api/v1/party/new-customer	POST	Create customer	Authorization, companyId	name, address, phone, email, tin, hasInsurance
/api/v1/party/new-supplier	POST	Create supplier	Authorization, companyId	name, address, phone, email, tin
/api/v1/expense	GET	List expenses	Authorization, companyId, branchId	perPage, page, searchQuery
/api/v1/expense	POST	Create expense	Authorization, companyId, branchId	amount, description, date, categoryID, paymentModeID
/api/v1/expense/categories	GET	List expense categories	Authorization, companyId	Cache recommended
/api/v1/company/finance	GET	Finance summary	Authorization, companyId, branchId	Aggregated by payment mode
/api/v1/data/product-type	GET	Product types	Authorization	Cache for performance
/api/v1/data/payment-mode	GET	Payment modes	Authorization, companyId	Use for validation/UI
/api/v1/data/product-category	GET	Product categories	Authorization	ID source for products
/api/v1/data/product-class	GET	Product classes	Authorization	Optional classification
/api/v1/data/product-quantity-unit	GET	Quantity units	Authorization	Required for products
/api/v1/data/product-packaging-unit	GET	Packaging units	Authorization	Pair with quantity unit
/api/v1/data/product-tax	GET	Tax rates	Authorization	Use for product taxID
/api/v1/data/product-country-origin	GET	Countries of origin	Authorization	Cache recommended
/api/v1/test	GET	Health check	—	Returns service status

Unlock Limitless Connectivity with OpenFn

Connect Zata with CRMs, ERPs, databases, and more. OpenFn’s 70+ open‑source adaptors let you build automated workflows to eliminate manual entry, sync data in real time, and scale reliably. Run on OpenFn SaaS or self‑hosted for portability, security, and auditability.

Example: Sync sales from Zata to QuickBooks via OpenFn’s low‑code interface—save time, reduce errors, and maintain audit trails.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"28861196","collectionId":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","publishedId":"2sB3WnwhWc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"388e3c"},"publishDate":"2025-10-30T15:21:11.000Z"},"item":[{"name":"Initialization","item":[{"name":"List All Companies","id":"12f71631-b3c8-417c-9f5d-5c52c2aed3aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"CompanyId","value":"2","type":"text"},{"key":"BranchId","value":"16","type":"text"}],"url":"https://ebm.zata.rw/api/v1/company?perPage=100&page=1","description":"

Function: Retrieves a paginated list of all companies with details like name, address, and branch count.
\n
Parameters: Query perPage (items per page), page (page number).
\n
Role: Provides a comprehensive view of companies, essential for administrative oversight in the API’s company management system.
\n
Note: Set perPage to balance performance and data needs.
\n
Use Case: Populate company table and selectors.
\n

\n","urlObject":{"path":["api","v1","company"],"host":["https://ebm.zata.rw"],"query":[{"description":{"content":"

Number of items per page

\n","type":"text/plain"},"key":"perPage","value":"100"},{"description":{"content":"

Page number

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"055eb5d8-7761-4a32-b21f-b58bf0722c9b","name":"200 OK","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"CompanyId","value":"2","type":"text"},{"key":"BranchId","value":"16","type":"text"}],"url":{"raw":"https://ebm.zata.rw/api/v1/company?perPage=100&page=1","host":["https://ebm.zata.rw"],"path":["api","v1","company"],"query":[{"key":"perPage","value":"100","description":"Number of items per page"},{"key":"page","value":"1","description":"Page number"}]},"description":"- **Function**: Retrieves a paginated list of all companies with details like name, address, and branch count.\n\n- **Parameters**: Query perPage (items per page), page (page number).\n\n- **Role**: Provides a comprehensive view of companies, essential for administrative oversight in the API’s company management system.\n\n- **Note**: Set perPage to balance performance and data needs.\n\n- **Use Case**: Populate company table and selectors."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"0\": {\n \"id\": 1,\n \"name\": \"Zata Point Global Service\",\n \"address\": \"No 1, Zata Point Street, Zata Point\",\n \"phone\": \"08012345678\",\n \"email\": \"hello@example.com\",\n \"tin\": \"123456789\",\n \"branchesCount\": 1,\n \"isDefault\": true\n },\n \"currentPage\": 1,\n \"lastPage\": 1,\n \"itemsPerPage\": 100,\n \"pageItems\": 1,\n \"total\": 1,\n \"timestamp\": \"2021-09-09, 12:00:00\"\n }\n}"}],"_postman_id":"12f71631-b3c8-417c-9f5d-5c52c2aed3aa"},{"name":"Register New Company","id":"9107d527-a583-4e4b-a718-c2ab62e2445f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Zata Point Global Service\",\n \"address\": \"No 1, Zata Point Street, Zata Point\",\n \"phone\": \"08012345678\",\n \"email\": \"sample@sample.com\",\n \"tin\": \"123456789\"\n}"},"url":"https://ebm.zata.rw/api/v1/company","description":"

Function: Creates a new company with provided details.
\n
Parameters: JSON body with name, address, phone, email, tin.
\n
Role: Initializes a company, enabling subsequent branch and product operations.
\n
Note: Ensure TIN meets validation requirements.
\n
Use Case: Company onboarding flow.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","company"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"dda8a7b4-5e1d-49b8-8675-beb4f28df1d8","name":"200 OK","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Zata Point Global Service\",\n \"address\": \"No 1, Zata Point Street, Zata Point\",\n \"phone\": \"08012345678\",\n \"email\": \"sample@sample.com\",\n \"tin\": \"123456789\"\n}"},"url":"https://ebm.zata.rw/api/v1/company","description":"- **Function**: Creates a new company with provided details.\n\n- **Parameters**: JSON body with name, address, phone, email, tin.\n\n- **Role**: Initializes a company, enabling subsequent branch and product operations.\n\n- **Note**: Ensure TIN meets validation requirements.\n\n- **Use Case**: Company onboarding flow."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Company created successfully\"\n}"}],"_postman_id":"9107d527-a583-4e4b-a718-c2ab62e2445f"},{"name":"Update Company Information","id":"91e627b6-9313-4308-93cd-0642bf27d0ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"companyId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Zata Point Global Service\",\n \"address\": \"No 1, Zata Point Street, Zata Point\",\n \"phone\": \"08012345678\",\n \"email\": \"sample@sample.com\",\n \"tin\": \"123456789\"\n}"},"url":"https://ebm.zata.rw/api/v1/company","description":"

Function: Updates an existing company’s details.
\n
Parameters: Header companyId; JSON body with name, address, phone, email, tin.
\n
Role: Maintains accurate company records, supporting data integrity.
\n
Note: Include only fields to update for efficiency.
\n
Use Case: Edit company profile.
\n

Function: Fetches detailed information for a specific company, including insurance data.
\n
Parameters: Path companyId; header companyId.
\n
Role: Enables targeted company data access for detailed views or modifications.
\n
Note: Cache results for frequently accessed companies.
\n
Use Case: View company detail panel.
\n

Manages the creation and maintenance of company records.

\n","_postman_id":"a264a718-9e99-4dc9-97f2-4852d9248d8b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}}},{"name":"Branches","item":[{"name":"List Company Branches","id":"98aef0f1-ae6d-4543-a3dc-e9cb0483609c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"}],"url":"https://ebm.zata.rw/api/v1/company/branch?perPage=100&page=1","description":"

Function: Returns a paginated list of branches for a specified company.
\n
Parameters: Header companyId; query perPage, page.
\n
Role: Facilitates branch oversight for multi-branch management.
\n
Note: Use companyId to scope the request correctly.
\n
Use Case: Branch list and branch picker.
\n

Number of items per page

\n","type":"text/plain"},"key":"perPage","value":"100"},{"description":{"content":"

Page number

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"39c5b5d3-942b-48d9-b518-4d96fed86c6d","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"}],"url":{"raw":"https://ebm.zata.rw/api/v1/company/branch?perPage=100&page=1","host":["https://ebm.zata.rw"],"path":["api","v1","company","branch"],"query":[{"key":"perPage","value":"100","description":"Number of items per page"},{"key":"page","value":"1","description":"Page number"}]},"description":"- **Function**: Returns a paginated list of branches for a specified company.\n\n- **Parameters**: Header companyId; query perPage, page.\n\n- **Role**: Facilitates branch oversight for multi-branch management.\n\n- **Note**: Use companyId to scope the request correctly.\n\n- **Use Case**: Branch list and branch picker."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"name\": \"Zata Point Global Service\",\n \"address\": \"No 1, Zata Point Street, Zata Point\",\n \"phone\": \"08012345678\",\n \"email\": \"hello@example.com\",\n \"tin\": \"123456789\",\n \"updated_at\": \"2021-09-09, 12:00:00\",\n \"insurance\": {\n \"id\": 1,\n \"name\": \"RSSB\",\n \"code\": \"123456789\",\n \"rate\": 90\n }\n}"}],"_postman_id":"98aef0f1-ae6d-4543-a3dc-e9cb0483609c"},{"name":"Create New Branch","id":"30730c90-e621-4680-a287-6f4378602af3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Branch\",\n \"phone\": \"250788888899\",\n \"email\": \"example@gmail.com\",\n \"address\": \"sample Address\",\n \"branchCategoryID\": 1\n}"},"url":"https://ebm.zata.rw/api/v1/company/branch","description":"

Function: Adds a new branch to a company.
\n
Parameters: Header companyId; JSON body with name, phone, email, address, branchCategoryID.
\n
Role: Expands company operations.
\n
Note: Verify branchCategoryID is valid via App Data.
\n
Use Case: Create branch modal.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","company","branch"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"c2d77c63-f2e8-40bc-b0dd-94cab7e29d33","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"New Branch\",\n \"phone\": \"250788888899\",\n \"email\": \"example@gmail.com\",\n \"address\": \"sample Address\",\n \"branchCategoryID\": 1\n}"},"url":"https://ebm.zata.rw/api/v1/company/branch","description":"- **Function**: Adds a new branch to a company.\n\n- **Parameters**: Header companyId; JSON body with name, phone, email, address, branchCategoryID.\n\n- **Role**: Expands company operations.\n\n- **Note**: Verify branchCategoryID is valid via App Data.\n\n- **Use Case**: Create branch modal."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"0\": {\n \"id\": 1,\n \"name\": \"Kicukiro Branch\",\n \"phone\": \"250788888888\",\n \"email\": \"hello@example.com\",\n \"address\": \"KK 369 ST, Kicukiro\",\n \"branchCode\": \"23\"\n },\n \"currentPage\": 1,\n \"lastPage\": 1,\n \"itemsPerPage\": 100,\n \"pageItems\": 1,\n \"total\": 1,\n \"timestamp\": \"2021-09-09, 12:00:00\"\n }\n}"}],"_postman_id":"30730c90-e621-4680-a287-6f4378602af3"},{"name":"Update Branch Details","id":"a1ab7445-f6a8-4f92-b788-78b1fa7a27d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"hirwa\",\n \"phone\": \"250789121212\",\n \"email\": \"sample@gmail.com\",\n \"address\": \"jsdk kjsdksd\"\n}"},"url":"https://ebm.zata.rw/api/v1/company/branch","description":"

Function: Modifies an existing branch’s information.
\n
Parameters: Headers companyId, branchId; JSON body with name, phone, email, address.
\n
Role: Ensures branch data accuracy.
\n
Note: Confirm branchId to target the correct branch.
\n
Use Case: Edit branch side drawer.
\n

Handles operations for company branches.

\n","_postman_id":"e555b76c-748b-4181-ab71-fe6066cc7365","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}}},{"name":"App Data","item":[{"name":"Get Product Types","id":"bde53616-faba-43de-a8a3-4869e17c8bcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ebm.zata.rw/api/v1/data/product-type","description":"

Function: Lists all product types available.
\n
Parameters: None.
\n
Role: Provides reference data for product classification.
\n
Note: Cache for performance.
\n
Use Case: Product type dropdowns.
\n

Function: Returns payment methods for a company.
\n
Parameters: Header companyId.
\n
Role: Validates payment options.
\n
Note: Use to populate UI.
\n
Use Case: Payment mode selection.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","data","payment-mode"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"e1c12b69-1daa-4bc0-8bb4-ff779ecd57be","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"}],"url":"https://ebm.zata.rw/api/v1/data/payment-mode","description":"- **Function**: Returns payment methods for a company.\n\n- **Parameters**: Header companyId.\n\n- **Role**: Validates payment options.\n\n- **Note**: Use to populate UI.\n\n- **Use Case**: Payment mode selection."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"DEBIT & CREDIT CARD\",\n \"code\": \"05\",\n \"description\": \"PAYMENT USING CARD\",\n \"creditCount\": 0,\n \"debitCount\": 0,\n \"creditAmount\": 0,\n \"debitAmount\": 0,\n \"totalDifference\": 0\n },\n {\n \"name\": \"CASH\",\n \"code\": \"01\",\n \"description\": \"CASH\",\n \"creditCount\": 2,\n \"debitCount\": 12,\n \"creditAmount\": \"150000.00\",\n \"debitAmount\": \"14322.88\",\n \"totalDifference\": 4545454\n }\n]"}],"_postman_id":"6c9718c7-d3eb-4219-8702-6c5909495e0e"},{"name":"Get Product Categories","id":"3b7936bf-4a7e-4705-98d3-241552c6cbde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ebm.zata.rw/api/v1/data/product-category","description":"

Function: Lists all product categories.
\n
Parameters: None.
\n
Role: Organizes products for reporting and UI.
\n
Note: Required for branchProductCategoryID.
\n
Use Case: Category filters.
\n

Function: Retrieves product classes.
\n
Parameters: None.
\n
Role: Adds classification granularity.
\n
Note: Optional for basic flows.
\n
Use Case: HS/category mapping.
\n

Function: Lists units for measuring product quantities.
\n
Parameters: None.
\n
Role: Ensures consistent inventory metrics.
\n
Note: Mandatory for product creation.
\n
Use Case: Unit selectors.
\n

Function: Returns packaging units for products.
\n
Parameters: None.
\n
Role: Supports detailed inventory setup.
\n
Note: Pair with quantity units for coherence.
\n
Use Case: Packaging selectors.
\n

Function: Lists applicable tax rates.
\n
Parameters: None.
\n
Role: Ensures compliant pricing.
\n
Note: Use for taxID on product creation.
\n
Use Case: Tax dropdowns.
\n

Function: Lists countries for product origins.
\n
Parameters: None.
\n
Role: Adds traceability to products.
\n
Note: Cache to optimize performance.
\n
Use Case: Country-of-origin select.
\n

Provides reference data for system configurations.

\n","_postman_id":"496d4c1e-b1ac-4b16-8d70-6fc4ae13718b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}}},{"name":"Products","item":[{"name":"List Branch Products","id":"d493f1b3-dc20-494d-bca6-02cc6f054193","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"url":"https://ebm.zata.rw/api/v1/product/branch?perPage=100&page=1&searchQuery=test","description":"

Function: Retrieves paginated products for a branch, including stock and category.
\n
Parameters: Headers companyId, branchId; query perPage, page, searchQuery.
\n
Role: Manages branch-specific inventory views.
\n
Note: Use searchQuery for filtering.
\n
Use Case: Product list and search.
\n

Number of items per page

\n","type":"text/plain"},"key":"perPage","value":"100"},{"description":{"content":"

Page number

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Search Query

\n","type":"text/plain"},"key":"searchQuery","value":"test"}],"variable":[]}},"response":[{"id":"73289e80-a396-41d4-930c-a13f54dc76b8","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"url":{"raw":"https://ebm.zata.rw/api/v1/product/branch?perPage=100&page=1&searchQuery=test","host":["https://ebm.zata.rw"],"path":["api","v1","product","branch"],"query":[{"key":"perPage","value":"100","description":"Number of items per page"},{"key":"page","value":"1","description":"Page number"},{"key":"searchQuery","value":"test","description":"Search Query"}]},"description":"- **Function**: Retrieves paginated products for a branch, including stock and category.\n\n- **Parameters**: Headers companyId, branchId; query perPage, page, searchQuery.\n\n- **Role**: Manages branch-specific inventory views.\n\n- **Note**: Use searchQuery for filtering.\n\n- **Use Case**: Product list and search."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Product Name\",\n \"itemCode\": \"Product Code\",\n \"category\": \"Product Category\",\n \"quantityUnit\": \"Quantity Unit\",\n \"packagingUnit\": \"Packaging Unit\",\n \"tax\": \"Product Tax\",\n \"class\": \"Product Class\",\n \"type\": \"Product Type\",\n \"totalStock\": 10,\n \"image\": \"url\"\n }\n ],\n \"currentPage\": 1,\n \"lastPage\": 1,\n \"itemsPerPage\": 10,\n \"pageItems\": 2,\n \"total\": 2,\n \"timestamp\": \"2024-12-12, 09:16:26\"\n}"}],"_postman_id":"d493f1b3-dc20-494d-bca6-02cc6f054193"},{"name":"Create New Product","id":"7305a8dc-21fd-4ef8-baec-2faadf7668ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Product Name\",\n \"packagingUnitID\": 1,\n \"quantityUnitID\": 1,\n \"countryID\": 1,\n \"taxID\": 1,\n \"branchProductCategoryID\": 1,\n \"hasStock\": \"yes or no\"\n}"},"url":"https://ebm.zata.rw/api/v1/product","description":"

Function: Adds a new product to a branch.
\n
Parameters: Headers companyId, branchId; JSON body with name, packagingUnitID, quantityUnitID, countryID, taxID, branchProductCategoryID, hasStock.
\n
Role: Builds product catalogs.
\n
Note: Use App Data endpoints for valid IDs.
\n
Use Case: Add product form.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","product"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"2a242bb0-53d3-408c-9669-53bfb568501b","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Product Name\",\n \"packagingUnitID\": 1,\n \"quantityUnitID\": 1,\n \"countryID\": 1,\n \"taxID\": 1,\n \"branchProductCategoryID\": 1,\n \"hasStock\": \"yes or no\"\n}"},"url":"https://ebm.zata.rw/api/v1/product","description":"- **Function**: Adds a new product to a branch.\n\n- **Parameters**: Headers companyId, branchId; JSON body with name, packagingUnitID, quantityUnitID, countryID, taxID, branchProductCategoryID, hasStock.\n\n- **Role**: Builds product catalogs.\n\n- **Note**: Use App Data endpoints for valid IDs.\n\n- **Use Case**: Add product form."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Product created successfully\",\n \"productId\": 1\n}"}],"_postman_id":"7305a8dc-21fd-4ef8-baec-2faadf7668ec"},{"name":"Get Product by ID","id":"02884321-14d4-46c3-8ab0-f4871df47482","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"url":"https://ebm.zata.rw/api/v1/product/1","description":"

Function: Fetches detailed product information, including stock and batch details.
\n
Parameters: Path productId; headers companyId, branchId.
\n
Role: Provides in-depth product views.
\n
Note: Useful for editing or transaction prep.
\n
Use Case: Product detail drawer.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","product","1"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"7806cc89-b1e4-4799-ac17-6bfa10fbfce8","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"url":"https://ebm.zata.rw/api/v1/product/1","description":"- **Function**: Fetches detailed product information, including stock and batch details.\n\n- **Parameters**: Path productId; headers companyId, branchId.\n\n- **Role**: Provides in-depth product views.\n\n- **Note**: Useful for editing or transaction prep.\n\n- **Use Case**: Product detail drawer."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"name\": \"Product Name\",\n \"itemCode\": \"Product Code\",\n \"category\": \"Product Category\",\n \"categoryID\": 1,\n \"quantityUnit\": \"Quantity Unit\",\n \"quantityUnitID\": 1,\n \"packagingUnit\": \"Packaging Unit\",\n \"packagingUnitID\": 1,\n \"country\": \"Product Country\",\n \"countryID\": 1,\n \"tax\": \"Product Tax\",\n \"taxID\": 1,\n \"class\": \"Product Class\",\n \"classID\": 1,\n \"type\": \"Product Type\",\n \"typeID\": 1,\n \"branchProductCategory\": \"Product Category\",\n \"branchProductCategoryID\": 1,\n \"totalStock\": 10,\n \"soldInSubUnit\": false,\n \"conversionFactor\": 0,\n \"image\": \"url\",\n \"productDetails\": [\n {\n \"id\": 1,\n \"currentStock\": 10,\n \"purchasePrice\": 10,\n \"salesPrice\": 10,\n \"discountRate\": 20,\n \"status\": \"in_stock\",\n \"expireDate\": \"2024-12-12\",\n \"batchNumber\": \"Batch Number\"\n }\n ]\n}"}],"_postman_id":"02884321-14d4-46c3-8ab0-f4871df47482"},{"name":"Update Product Details","id":"1d7363ac-6535-4d5f-8ed1-289d57feff33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Product Name\",\n \"branchProductCategoryID\": 1\n}"},"url":"https://ebm.zata.rw/api/v1/product/1","description":"

Function: Updates a product’s information.
\n
Parameters: Path productId; headers companyId, branchId; JSON body with fields like name, branchProductCategoryID.
\n
Role: Keeps inventory current.
\n
Note: Partial updates supported.
\n
Use Case: Edit product panel.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","product","1"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"907ed7ee-dce3-49e8-a36f-8a4b3317a8a5","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Product Name\",\n \"branchProductCategoryID\": 1\n}"},"url":"https://ebm.zata.rw/api/v1/product/1","description":"- **Function**: Updates a product’s information.\n\n- **Parameters**: Path productId; headers companyId, branchId; JSON body with fields like name, branchProductCategoryID.\n\n- **Role**: Keeps inventory current.\n\n- **Note**: Partial updates supported.\n\n- **Use Case**: Edit product panel."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Product updated successfully\"\n}"}],"_postman_id":"1d7363ac-6535-4d5f-8ed1-289d57feff33"},{"name":"Increase Product Quantity","id":"4b71070c-be24-4e89-a2a7-5008e1c5f384","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\": \"reason for increasing quantity\",\n \"quantity\": 10,\n \"salePrice\": 10,\n \"batchNumber\": \"Batch Number\",\n \"discountRate\": 0\n}"},"url":"https://ebm.zata.rw/api/v1/product/increase-quantity/1","description":"

Function: Adds stock to a product.
\n
Parameters: Path productId; headers companyId, branchId; JSON body with description, quantity, salePrice, batchNumber, discountRate.
\n
Role: Manages restocking.
\n
Note: Track batchNumber for traceability.
\n
Use Case: Receive stock workflow.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","product","increase-quantity","1"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"09be5d73-fc93-4a0d-aa14-0d8004e28a2c","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\": \"reason for increasing quantity\",\n \"quantity\": 10,\n \"salePrice\": 10,\n \"batchNumber\": \"Batch Number\",\n \"discountRate\": 0\n}"},"url":"https://ebm.zata.rw/api/v1/product/increase-quantity/1","description":"- **Function**: Adds stock to a product.\n\n- **Parameters**: Path productId; headers companyId, branchId; JSON body with description, quantity, salePrice, batchNumber, discountRate.\n\n- **Role**: Manages restocking.\n\n- **Note**: Track batchNumber for traceability.\n\n- **Use Case**: Receive stock workflow."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Product quantity updated successfully\"\n}"}],"_postman_id":"4b71070c-be24-4e89-a2a7-5008e1c5f384"},{"name":"Reduce Product Quantity","id":"e69c02e1-1c44-4dbc-b3e9-995d835860e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"quantity\": 10,\n \"description\": \"reason for reducing quantity\",\n \"batchNumber\": \"Batch Number\"\n}"},"url":"https://ebm.zata.rw/api/v1/product/reduce-quantity/1","description":"

Function: Decreases stock for a product.
\n
Parameters: Path productId; headers companyId, branchId; JSON body with quantity, description, batchNumber.
\n
Role: Maintains inventory balance.
\n
Note: Prevent negative stock with checks.
\n
Use Case: Adjust/consume stock flow.
\n

Oversees product catalog and inventory.

\n","_postman_id":"ed663ccd-28c2-4fda-8f30-c7f116f5bf29","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}}},{"name":"Parties","item":[{"name":"List Company Parties","id":"dd2ec40d-8867-4e7a-9a41-c55302823e03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"}],"url":"https://ebm.zata.rw/api/v1/party?partyType=Customer&perPage=10&page=1","description":"

Function: Get all company parties.
\n
Parameters: Header companyId; query partyType (Customer or Supplier), perPage, page.
\n
Role: Lists customers and suppliers.
\n
Note: Use partyType to filter.
\n
Use Case: Display and filter customer/supplier directory.
\n

Customer or Supplier

\n","type":"text/plain"},"key":"partyType","value":"Customer"},{"key":"perPage","value":"10"},{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"450aabb2-5e6b-429b-938c-251190cf4ec1","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"}],"url":{"raw":"https://ebm.zata.rw/api/v1/party?partyType=Customer&perPage=10&page=1","host":["https://ebm.zata.rw"],"path":["api","v1","party"],"query":[{"key":"partyType","value":"Customer","description":"Customer or Supplier"},{"key":"perPage","value":"10"},{"key":"page","value":"1"}]},"description":"- **Function**: Get all company parties.\n\n- **Parameters**: Header companyId; query partyType (Customer or Supplier), perPage, page.\n\n- **Role**: Lists customers and suppliers.\n\n- **Note**: Use partyType to filter.\n\n- **Use Case**: Display and filter customer/supplier directory."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"John Doe\",\n \"phone\": \"08012345678\",\n \"email\": \"johndoe@example.com\",\n \"tin\": \"123456789\",\n \"address\": \"123 Main St, City, Country\",\n \"partyType\": \"Customer\",\n \"image\": \"https://example.com/image.jpg\"\n }\n ]\n}"}],"_postman_id":"dd2ec40d-8867-4e7a-9a41-c55302823e03"},{"name":"Create New Customer","id":"3a784e44-db72-4090-8e93-e1490d1692d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Doe\",\n \"address\": \"123 Main St, City, Country\",\n \"phone\": \"08012345678\",\n \"email\": \"johndoe@example.com\",\n \"tin\": \"123456789\",\n \"hasInsurance\": \"no\"\n}"},"url":"https://ebm.zata.rw/api/v1/party/new-customer","description":"

Function: Create a new customer.
\n
Parameters: Header companyId; JSON body name, address, phone, email, tin, hasInsurance.
\n
Role: Adds a customer to the directory.
\n
Note: Validation errors return 400 with detailed messages.
\n
Use Case: Add a customer during onboarding or at checkout.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","party","new-customer"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"f5b44a1e-e0fb-4fac-b45a-32008ca064ab","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"John Doe\",\n \"address\": \"123 Main St, City, Country\",\n \"phone\": \"08012345678\",\n \"email\": \"johndoe@example.com\",\n \"tin\": \"123456789\",\n \"hasInsurance\": \"no\"\n}"},"url":"https://ebm.zata.rw/api/v1/party/new-customer","description":"- **Function**: Create a new customer.\n\n- **Parameters**: Header companyId; JSON body name, address, phone, email, tin, hasInsurance.\n\n- **Role**: Adds a customer to the directory.\n\n- **Note**: Validation errors return 400 with detailed messages.\n\n- **Use Case**: Add a customer during onboarding or at checkout."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Customer Created Successfully\"\n}"}],"_postman_id":"3a784e44-db72-4090-8e93-e1490d1692d8"},{"name":"Create New Supplier","id":"48cde9e6-ccb7-4af1-9fbd-80f2d1c10ff9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Supplier Name\",\n \"address\": \"123 Supplier St, City, Country\",\n \"phone\": \"08012345678\",\n \"email\": \"supplier@example.com\",\n \"tin\": \"987654321\"\n}"},"url":"https://ebm.zata.rw/api/v1/party/new-supplier","description":"

Function: Create a new supplier.
\n
Parameters: Header companyId; JSON body name, address, phone, email, tin.
\n
Role: Adds a supplier to the directory.
\n
Note: Ensure TIN is valid.
\n
Use Case: Register a new vendor before recording purchases.
\n

Manage customers and suppliers.

\n","_postman_id":"695cb3b6-9586-4a2a-ae20-97156aa4ee23","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}}},{"name":"Transactions","item":[{"name":"List All Transactions","id":"ca9c14a1-fc83-44fe-971e-b474b616f29e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"companyId","value":"2","type":"text"},{"key":"branchId","value":"16","type":"text"}],"url":"https://ebm.zata.rw/api/v1/transaction?perPage=100&page=1","description":"

Function: Retrieves paginated transactions for a branch.
\n
Parameters: Headers companyId, branchId; query perPage, page, fromDate, toDate, invoiceType.
\n
Role: Offers transaction history for reporting.
\n
Note: Filter by dates for performance.
\n
Use Case: Transactions grid and reporting filters.
\n

\n","urlObject":{"path":["api","v1","transaction"],"host":["https://ebm.zata.rw"],"query":[{"key":"perPage","value":"100"},{"key":"page","value":"1"}],"variable":[]}},"response":[{"id":"b2496a7d-e2d8-45f7-84d8-7b555b2c132c","name":"200 OK","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"GET","header":[{"key":"companyId","value":"2","type":"text"},{"key":"branchId","value":"16","type":"text"}],"url":{"raw":"https://ebm.zata.rw/api/v1/transaction?perPage=100&page=1","host":["https://ebm.zata.rw"],"path":["api","v1","transaction"],"query":[{"key":"perPage","value":"100"},{"key":"page","value":"1"}]},"description":"- **Function**: Retrieves paginated transactions for a branch.\n\n- **Parameters**: Headers companyId, branchId; query perPage, page, fromDate, toDate, invoiceType.\n\n- **Role**: Offers transaction history for reporting.\n\n- **Note**: Filter by dates for performance.\n\n- **Use Case**: Transactions grid and reporting filters."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"invoiceType\": \"sale\",\n \"invoiceNumber\": \"INV001\",\n \"clientName\": \"John Doe\",\n \"salesDate\": \"2023-01-01\",\n \"totalAmount\": 1000,\n \"synced\": true,\n \"isRefunded\": false,\n \"status\": \"approved\",\n \"itemsCount\": 2\n }\n ],\n \"currentPage\": 1,\n \"lastpage\": 1,\n \"itemsPerPage\": 10,\n \"pageItems\": 1,\n \"total\": 1\n}"}],"_postman_id":"ca9c14a1-fc83-44fe-971e-b474b616f29e"},{"name":"Create Sale Transaction","id":"5e9a5302-d6e7-4339-be8c-76ab24fb4cd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"companyId","value":"2","type":"text"},{"key":"branchId","value":"16","type":"text"}],"body":{"mode":"raw","raw":"{\n \"purchaseCode\": \"43034\",\n \"paymentMethodID\": 1,\n \"customerID\": 1,\n \"transactionDate\": \"2024-01-01\",\n \"note\": \"some note\",\n \"customerTIN\": \"123456789\",\n \"customerName\": \"some name\",\n \"customerPhone\": \"+250788888888\",\n \"items\": [{ \n \"productID\": 1, \n \"units\": 12.5, \n \"unitPrice\": 1000, \n \"discountRate\": 0, \n \"batchNumber\": \"someBatch\"\n }]\n}"},"url":"https://ebm.zata.rw/api/v1/transaction/sale","description":"

Function: Processes a new sale, updating stock and generating an invoice.
\n
Parameters: Headers companyId, branchId; JSON body with purchaseCode, paymentMethodID, customerID, transactionDate, note, customerTIN, customerName, customerPhone, items (productID, units, unitPrice, discountRate, batchNumber).
\n
Role: Automates sales, core to revenue flow.
\n
Note: Validate stock before submission; use /transaction/calculate to preview totals.
\n
Use Case: Checkout and invoice issuance.
\n

\n","urlObject":{"path":["api","v1","transaction","sale"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"31ab5f08-d228-4039-bbbf-5dbd6d5d981b","name":"200 OK","originalRequest":{"auth":{"type":"bearer","bearer":{"token":""}},"method":"POST","header":[{"key":"companyId","value":"2","type":"text"},{"key":"branchId","value":"16","type":"text"}],"body":{"mode":"raw","raw":"{\n \"purchaseCode\": \"43034\",\n \"paymentMethodID\": 1,\n \"customerID\": 1,\n \"transactionDate\": \"2024-01-01\",\n \"note\": \"some note\",\n \"customerTIN\": \"123456789\",\n \"customerName\": \"some name\",\n \"customerPhone\": \"+250788888888\",\n \"items\": [{ \n \"productID\": 1, \n \"units\": 12.5, \n \"unitPrice\": 1000, \n \"discountRate\": 0, \n \"batchNumber\": \"someBatch\"\n }]\n}"},"url":"https://ebm.zata.rw/api/v1/transaction/sale","description":"- **Function**: Processes a new sale, updating stock and generating an invoice.\n\n- **Parameters**: Headers companyId, branchId; JSON body with purchaseCode, paymentMethodID, customerID, transactionDate, note, customerTIN, customerName, customerPhone, items (productID, units, unitPrice, discountRate, batchNumber).\n\n- **Role**: Automates sales, core to revenue flow.\n\n- **Note**: Validate stock before submission; use /transaction/calculate to preview totals.\n\n- **Use Case**: Checkout and invoice issuance."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Sale transaction created successfully\",\n \"invoiceID\": 1\n}"}],"_postman_id":"5e9a5302-d6e7-4339-be8c-76ab24fb4cd8"},{"name":"Create Refund Transaction","id":"41438fee-1e15-493c-b8c0-d896edef59b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"transactionDate\": \"2024-01-01\",\n \"purchaseCode\": \"8943786743\",\n \"note\": \"some note\"\n}"},"url":"https://ebm.zata.rw/api/v1/transaction/refund/1","description":"

Function: Issues a refund for a previous transaction.
\n
Parameters: Path transactionId; headers companyId, branchId; JSON body with transactionDate, purchaseCode, note.
\n
Role: Handles reversals, maintaining financial integrity.
\n
Note: Reference original transactionId.
\n
Use Case: Refund flow.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","transaction","refund","1"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"efd67b10-90bd-4c32-9561-f090629039eb","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"transactionDate\": \"2024-01-01\",\n \"purchaseCode\": \"8943786743\",\n \"note\": \"some note\"\n}"},"url":"https://ebm.zata.rw/api/v1/transaction/refund/1","description":"- **Function**: Issues a refund for a previous transaction.\n\n- **Parameters**: Path transactionId; headers companyId, branchId; JSON body with transactionDate, purchaseCode, note.\n\n- **Role**: Handles reversals, maintaining financial integrity.\n\n- **Note**: Reference original transactionId.\n\n- **Use Case**: Refund flow."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Refund transaction created successfully\",\n \"invoiceID\": 1\n}"}],"_postman_id":"41438fee-1e15-493c-b8c0-d896edef59b7"},{"name":"Create Proforma Transaction","id":"eeb3c247-0e05-4bf0-987d-3328643276c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientTin\": \"123456789\",\n \"purchaseCode\": \"43034\",\n \"paymentMethodID\": 1,\n \"transactionDate\": \"2024-01-01\",\n \"note\": \"some note\",\n \"items\": [{ \n \"productID\": 1, \n \"units\": 12.5, \n \"unitPrice\": 1000, \n \"discountRate\": 0, \n \"batchNumber\": \"someBatch\"\n }]\n}"},"url":"https://ebm.zata.rw/api/v1/transaction/proforma","description":"

Function: Generates a proforma invoice for quotes.
\n
Parameters: Headers companyId, branchId; JSON body with clientTin, purchaseCode, paymentMethodID, transactionDate, note, items.
\n
Role: Facilitates preliminary sales.
\n
Note: Does not affect stock.
\n
Use Case: Quote creation.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","transaction","proforma"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"06f9fc1e-67c0-4f65-adc6-e984a3478348","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientTin\": \"123456789\",\n \"purchaseCode\": \"43034\",\n \"paymentMethodID\": 1,\n \"transactionDate\": \"2024-01-01\",\n \"note\": \"some note\",\n \"items\": [{ \n \"productID\": 1, \n \"units\": 12.5, \n \"unitPrice\": 1000, \n \"discountRate\": 0, \n \"batchNumber\": \"someBatch\"\n }]\n}"},"url":"https://ebm.zata.rw/api/v1/transaction/proforma","description":"- **Function**: Generates a proforma invoice for quotes.\n\n- **Parameters**: Headers companyId, branchId; JSON body with clientTin, purchaseCode, paymentMethodID, transactionDate, note, items.\n\n- **Role**: Facilitates preliminary sales.\n\n- **Note**: Does not affect stock.\n\n- **Use Case**: Quote creation."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Proforma transaction created successfully\",\n \"invoiceID\": 1\n}"}],"_postman_id":"eeb3c247-0e05-4bf0-987d-3328643276c2"},{"name":"Calculate Transaction Totals","id":"041682cb-ae6d-43ae-a153-8bee0fa019e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"items\": [{ \n \"productID\": 1, \n \"units\": 90, \n \"unitPrice\": 1000, \n \"discountRate\": 10, \n \"batchNumber\": \"aj9kk89\"\n }]\n}"},"url":"https://ebm.zata.rw/api/v1/transaction/calculate","description":"

Function: Computes totals, taxes, and discounts for a set of items.
\n
Parameters: Headers companyId, branchId; JSON body with items (as in sale).
\n
Role: Enables cost previews for transaction workflows.
\n
Note: Ideal for real-time checkout calculations.
\n
Use Case: Live totals during invoice creation.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","transaction","calculate"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"9fb6a24d-7e70-4985-aae5-1d68af936e9b","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"items\": [{ \n \"productID\": 1, \n \"units\": 90, \n \"unitPrice\": 1000, \n \"discountRate\": 10, \n \"batchNumber\": \"aj9kk89\"\n }]\n}"},"url":"https://ebm.zata.rw/api/v1/transaction/calculate","description":"- **Function**: Computes totals, taxes, and discounts for a set of items.\n\n- **Parameters**: Headers companyId, branchId; JSON body with items (as in sale).\n\n- **Role**: Enables cost previews for transaction workflows.\n\n- **Note**: Ideal for real-time checkout calculations.\n\n- **Use Case**: Live totals during invoice creation."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1212,\n \"code\": \"RWAX20200001\",\n \"name\": \"Product Name\",\n \"class\": \"000675\",\n \"units\": 90,\n \"unitPrice\": 1000,\n \"batchNumber\": \"BATCH001\",\n \"movingUnit\": \"main\",\n \"packagingUnit\": \"box\",\n \"purchasePrice\": 800,\n \"quantityUnit\": \"piece\",\n \"discountAmount\": 100,\n \"discountRate\": 10,\n \"taxAmount\": 162,\n \"taxRate\": 18,\n \"taxableAmount\": 900,\n \"taxName\": \"B\",\n \"expireDate\": \"2024-12-31\"\n }\n]"}],"_postman_id":"041682cb-ae6d-43ae-a153-8bee0fa019e7"},{"name":"Get Transaction by ID","id":"2ffdc943-b3d4-4bb5-8471-13a910f28f2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"url":"https://ebm.zata.rw/api/v1/transaction/1","description":"

Function: Retrieves details of a specific transaction, including items and taxes.
\n
Parameters: Path transactionId; headers companyId, branchId.
\n
Role: Supports audits and reporting.
\n
Note: Parse items for detailed breakdowns.
\n
Use Case: Transaction detail view.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","transaction","1"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"cdb619d5-3966-46c0-9d87-ed861f76dd03","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"url":"https://ebm.zata.rw/api/v1/transaction/1","description":"- **Function**: Retrieves details of a specific transaction, including items and taxes.\n\n- **Parameters**: Path transactionId; headers companyId, branchId.\n\n- **Role**: Supports audits and reporting.\n\n- **Note**: Parse items for detailed breakdowns.\n\n- **Use Case**: Transaction detail view."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 1,\n \"invoiceNumber\": 1,\n \"originalInvoiceNumber\": 1,\n \"clientTin\": \"\",\n \"clientName\": \"\",\n \"clientPhoneNumber\": \"\",\n \"salesTypeCode\": \"\",\n \"receiptTypeCode\": \"\",\n \"paymentTypeCode\": \"\",\n \"salesStatusCode\": \"\",\n \"confirmationDate\": \"\",\n \"type\": \"NS\",\n \"isRefunded\": true,\n \"taxblAmtA\": 300,\n \"taxblAmtB\": 300,\n \"taxblAmtC\": 300,\n \"taxblAmtD\": 300,\n \"taxAmtA\": 300,\n \"taxAmtB\": 300,\n \"taxAmtC\": 300,\n \"taxAmtD\": 300,\n \"totTaxblAmt\": 300,\n \"totTaxAmt\": 300,\n \"totAmt\": 300,\n \"salesDate\": \"2022-01-01 00:00:00\",\n \"note\": \"\",\n \"items\": [\n {\n \"productName\": \"Product Name\",\n \"units\": 10,\n \"unitPrice\": 1000,\n \"taxAmount\": 180,\n \"taxRate\": 18,\n \"taxName\": \"B\",\n \"totalAmount\": 900,\n \"totalDiscount\": 100,\n \"discountRate\": 100\n }\n ]\n}"}],"_postman_id":"2ffdc943-b3d4-4bb5-8471-13a910f28f2b"},{"name":"Get Transaction Download Signature","id":"f61f5746-ae6b-492f-8418-9b6ae187e677","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"url":"https://ebm.zata.rw/api/v1/transaction/download-signature/1?downloadSize=A4","description":"

Function: Generates a signed URL for downloading a transaction PDF.
\n
Parameters: Path transactionId; headers companyId, branchId; query downloadSize (A4, m80, m58).
\n
Role: Secures document access.
\n
Note: Use the returned URL promptly.
\n
Use Case: Prepare receipt download.
\n

A4 | m80 | m58

\n","type":"text/plain"},"key":"downloadSize","value":"A4"}],"variable":[]}},"response":[{"id":"5d46dc2c-431a-4e24-8aba-991a81e4ed80","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"url":{"raw":"https://ebm.zata.rw/api/v1/transaction/download-signature/1?downloadSize=A4","host":["https://ebm.zata.rw"],"path":["api","v1","transaction","download-signature","1"],"query":[{"key":"downloadSize","value":"A4","description":"A4 | m80 | m58"}]},"description":"- **Function**: Generates a signed URL for downloading a transaction PDF.\n\n- **Parameters**: Path transactionId; headers companyId, branchId; query downloadSize (A4, m80, m58).\n\n- **Role**: Secures document access.\n\n- **Note**: Use the returned URL promptly.\n\n- **Use Case**: Prepare receipt download."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://example.com/api/v1/transaction/download?expires=1746382451&id=17&signature=b264d3a5730fdcbf\",\n \"expires_at\": \"2022-01-01 00:00:00\"\n}"}],"_postman_id":"f61f5746-ae6b-492f-8418-9b6ae187e677"},{"name":"Download Signed Transaction","id":"681651da-cdb2-4dc5-bfa9-f4f8503b6fae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"url":"https://ebm.zata.rw/api/v1/transaction/download?expires=1&id=1&signature=b264d3a5730fdcbf","description":"

Function: Downloads the transaction PDF using a signed URL.
\n
Parameters: Headers companyId, branchId; query expires, id, signature.
\n
Role: Provides secure document retrieval.
\n
Note: Response is binary PDF.
\n
Use Case: Download/print receipt.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","transaction","download"],"host":["https://ebm.zata.rw"],"query":[{"key":"expires","value":"1"},{"key":"id","value":"1"},{"key":"signature","value":"b264d3a5730fdcbf"}],"variable":[]}},"response":[{"id":"642505eb-7b65-42b0-97f7-35b2968f3d49","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"url":{"raw":"https://ebm.zata.rw/api/v1/transaction/download?expires=1&id=1&signature=b264d3a5730fdcbf","host":["https://ebm.zata.rw"],"path":["api","v1","transaction","download"],"query":[{"key":"expires","value":"1"},{"key":"id","value":"1"},{"key":"signature","value":"b264d3a5730fdcbf"}]},"description":"- **Function**: Downloads the transaction PDF using a signed URL.\n\n- **Parameters**: Headers companyId, branchId; query expires, id, signature.\n\n- **Role**: Provides secure document retrieval.\n\n- **Note**: Response is binary PDF.\n\n- **Use Case**: Download/print receipt."},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/pdf"}],"cookie":[],"responseTime":null,"body":"[Binary PDF Content]"}],"_postman_id":"681651da-cdb2-4dc5-bfa9-f4f8503b6fae"},{"name":"Create Purchase Transaction","id":"9d746b41-6a57-4c0f-ba5b-b16790e1d0ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentMethodID\": 1,\n \"customerID\": 1,\n \"transactionDate\": \"2024-01-01\",\n \"note\": \"Purchase note\",\n \"items\": [{\n \"productID\": 1,\n \"units\": 10,\n \"unitPrice\": 1000,\n \"discount\": 100,\n \"purchasePrice\": 800,\n \"batchNumber\": \"BATCH001\",\n \"expireDate\": \"2024-12-31\",\n \"movingUnit\": \"main\"\n }]\n}"},"url":"https://ebm.zata.rw/api/v1/transaction/purchase","description":"

Function: Creates an internal purchase transaction (restocking).
\n
Parameters: Headers companyId, branchId; JSON body with paymentMethodID, customerID, transactionDate, note, items (productID, units, unitPrice, discount, purchasePrice, batchNumber, expireDate, movingUnit).
\n
Role: Records purchases and updates stock.
\n
Note: Validate productID and paymentMethodID from App Data.
\n
Use Case: Record supplier deliveries and update stock.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","transaction","purchase"],"host":["https://ebm.zata.rw"],"query":[],"variable":[]}},"response":[{"id":"a317da90-b970-4e9a-a928-c3ea9b92812e","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"paymentMethodID\": 1,\n \"customerID\": 1,\n \"transactionDate\": \"2024-01-01\",\n \"note\": \"Purchase note\",\n \"items\": [{\n \"productID\": 1,\n \"units\": 10,\n \"unitPrice\": 1000,\n \"discount\": 100,\n \"purchasePrice\": 800,\n \"batchNumber\": \"BATCH001\",\n \"expireDate\": \"2024-12-31\",\n \"movingUnit\": \"main\"\n }]\n}"},"url":"https://ebm.zata.rw/api/v1/transaction/purchase","description":"- **Function**: Creates an internal purchase transaction (restocking).\n\n- **Parameters**: Headers companyId, branchId; JSON body with paymentMethodID, customerID, transactionDate, note, items (productID, units, unitPrice, discount, purchasePrice, batchNumber, expireDate, movingUnit).\n\n- **Role**: Records purchases and updates stock.\n\n- **Note**: Validate productID and paymentMethodID from App Data.\n\n- **Use Case**: Record supplier deliveries and update stock."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Purchase transaction created successfully\",\n \"invoiceID\": 1\n}"}],"_postman_id":"9d746b41-6a57-4c0f-ba5b-b16790e1d0ef"}],"id":"dda00e09-64b2-4c8c-bf49-90d96ac38ea6","description":"

Processes and tracks financial transactions.

\n","_postman_id":"dda00e09-64b2-4c8c-bf49-90d96ac38ea6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}}},{"name":"Expenses","item":[{"name":"List Expenses","id":"91d6278d-92b4-410e-a101-adc90164baaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"url":"https://ebm.zata.rw/api/v1/expense?perPage=100&page=1&searchQuery=Office Supplies","description":"

Function: Get all expenses.
\n
Parameters: Headers companyId, branchId; query perPage, page, searchQuery.
\n
Role: Lists branch expenses.
\n
Note: Use searchQuery for filtering.
\n
Use Case: Review and filter operating expenses for a period.
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}},"urlObject":{"path":["api","v1","expense"],"host":["https://ebm.zata.rw"],"query":[{"key":"perPage","value":"100"},{"key":"page","value":"1"},{"key":"searchQuery","value":"Office Supplies"}],"variable":[]}},"response":[{"id":"2076a7a4-75c1-4ee6-ae38-27917da782a5","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"url":{"raw":"https://ebm.zata.rw/api/v1/expense?perPage=100&page=1&searchQuery=Office Supplies","host":["https://ebm.zata.rw"],"path":["api","v1","expense"],"query":[{"key":"perPage","value":"100"},{"key":"page","value":"1"},{"key":"searchQuery","value":"Office Supplies"}]},"description":"- **Function**: Get all expenses.\n\n- **Parameters**: Headers companyId, branchId; query perPage, page, searchQuery.\n\n- **Role**: Lists branch expenses.\n\n- **Note**: Use searchQuery for filtering.\n\n- **Use Case**: Review and filter operating expenses for a period."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1,\n \"amount\": 1000,\n \"description\": \"Office Supplies\",\n \"date\": \"2023-10-01\",\n \"category_id\": 2,\n \"payment_mode_id\": 1,\n \"branch_id\": 1,\n \"created_at\": \"2023-10-01T12:00:00Z\",\n \"updated_at\": \"2023-10-01T12:00:00Z\"\n }\n ],\n \"currentPage\": 1,\n \"lastPage\": 10,\n \"itemsPerPage\": 10,\n \"pageItems\": 10,\n \"total\": 100\n}"}],"_postman_id":"91d6278d-92b4-410e-a101-adc90164baaf"},{"name":"Create New Expense","id":"9880eb27-7d3b-43ee-b959-db205c6ed53b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"body":{"mode":"raw","raw":"{\n \"amount\": 1000,\n \"description\": \"Office Supplies\",\n \"date\": \"2023-10-01\",\n \"categoryID\": 2,\n \"paymentModeID\": 1\n}"},"url":"https://ebm.zata.rw/api/v1/expense","description":"

Function: Create a new expense.
\n
Parameters: Headers companyId, branchId; JSON body amount, description, date, categoryID, paymentModeID.
\n
Role: Records operational costs.
\n
Note: Validate category and payment mode using App Data.
\n
Use Case: Log a petty cash or utility expense.
\n

Function: Get expense categories for the company.
\n
Parameters: Header companyId.
\n
Role: Supports expense creation and reporting.
\n
Note: Cache as this is relatively static.
\n
Use Case: Populate expense category dropdowns.
\n

Track and create expenses.

\n","_postman_id":"8d9edbb8-1fa7-47e6-8712-b24d74fb69e6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}}},{"name":"Finances","item":[{"name":"Get Company Finance","id":"d582b6a6-3666-468e-abe6-62938a3e07e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"companyId","value":"1","type":"text"},{"key":"branchId","value":"1","type":"text"}],"url":"https://ebm.zata.rw/api/v1/company/finance","description":"

Function: Get company finance summary by payment modes.
\n
Parameters: Headers companyId, branchId.
\n
Role: Supports reconciliation and audits.
\n
Note: Aligns with payment modes returned by App Data.
\n
Use Case: End-of-day cash-up and reconciliation.
\n

Finance summaries and reconciliation.

\n","_postman_id":"3bb35a3c-8649-41f1-8ba1-6a1f15290082","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}}},{"name":"Test","item":[{"name":"Test API","id":"407c026f-07c1-4531-a62e-87214e20acb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ebm.zata.rw/api/v1/test","description":"

Verifies API connectivity and status.

Purpose: Availability and connectivity check.
\n
Functionality: Ping endpoint to verify service is up.
\n
Role: Health check before other operations.
\n

\n","_postman_id":"5e4b2f8c-2644-4e70-a045-4ff2620030df","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","id":"852d9387-2db1-4cbb-a931-29f0a3ef6d99","name":"Zata API: Streamlined Tax Compliance","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"54a7934d-4ef2-4455-97d8-cf60eb07cf78"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"0f9999db-fd65-4302-91a2-c119c4080f26"}}],"variable":[{"key":"baseUrl","value":"https://ebm.zata.rw"},{"key":"companyId","value":"1"},{"key":"branchId","value":"1"},{"key":"Authorization","value":"Bearer "}]}