### Products API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing products, including adding, retrieving, and removing them. ```APIDOC ## Products API ### Description Manages product information within the system. ### Endpoints - **POST /products/add**: Add a new product. - **POST /products/add-or-update**: Add or update products. - **GET /products/all-by-supplier**: Get all products by supplier ID. - **DELETE /products/remove**: Remove a product. - **GET /products/show-more**: Show more product-related actions. ``` -------------------------------- ### General (Connectivity) API Source: https://ask.zaharasoftware.com/api-docs/index General API documentation endpoint. ```APIDOC ## General (Connectivity) API ### Description General endpoint for API documentation and connectivity information. ### Endpoints - **GET /api-documentation**: Access general API documentation. ``` -------------------------------- ### Products API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing products, including adding, retrieving, and removing products. ```APIDOC ## Products API ### Description Manages product information within the system. ### Endpoints - **POST /products**: Add a new product. - **POST /products/range**: Add or update products. - **GET /products/supplier/{supplierId}**: Get all products by supplier ID. - **DELETE /products/{id}**: Remove a product. ### Request Example (Add Product) ```json { "name": "Laptop", "price": 1200.00 } ``` ### Response Example (Get Product) ```json { "id": "prod1", "name": "Laptop", "supplierId": "sup1" } ``` ``` -------------------------------- ### Projects API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing projects, including adding, retrieving, and updating them. ```APIDOC ## Projects API ### Description Manages project information, including creation, retrieval, and updates. ### Endpoints - **POST /projects/add**: Add a new project. - **GET /projects/all**: Get all projects. - **GET /projects/all-with-skip-take**: Get all projects with skip and take parameters. - **GET /projects/search**: Get projects by search criteria. - **GET /projects/by-id**: Get a project by its ID. - **GET /projects/by-property-value**: Get a project by its property value. - **GET /projects/exists-by-id**: Check if a project exists by its ID. - **GET /projects/after-date**: Get projects after a specific date. - **GET /projects/after-date-with-skip-take**: Get projects after a specific date (with skip and take). - **GET /projects/before-date**: Get projects before a specific date. - **GET /projects/before-date-with-skip-take**: Get projects before a specific date (with skip and take). - **PUT /projects/update**: Update an existing project. - **GET /projects/show-more**: Show more project-related actions. ``` -------------------------------- ### Projects API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing projects, including adding, retrieving, updating, and searching. ```APIDOC ## Projects API ### Description Provides functionality for managing projects. ### Endpoints - **POST /projects**: Add a new project. - **GET /projects**: Get all projects. - **GET /projects/skip/{skip}/take/{take}**: Get all projects with pagination. - **GET /projects/search**: Get projects by search query. - **GET /projects/{id}**: Get a project by its ID. - **GET /projects/property-value**: Get projects by property value. - **GET /projects/exists/{id}**: Check if a project exists by ID. - **GET /projects/after-date**: Get projects after a specific date. - **GET /projects/after-date/skip/{skip}/take/{take}**: Get projects after a date with pagination. - **GET /projects/before-date**: Get projects before a specific date. - **GET /projects/before-date/skip/{skip}/take/{take}**: Get projects before a date with pagination. - **PUT /projects/{id}**: Update a project. ### Request Example (Add Project) ```json { "name": "Website Redesign", "startDate": "2023-11-01" } ``` ### Response Example (Get Project) ```json { "id": "proj1", "name": "Website Redesign", "status": "Active" } ``` ``` -------------------------------- ### Create Support Ticket API Source: https://ask.zaharasoftware.com/api-docs/index API endpoint for creating a support ticket, including fields for contact information, subject, and description. ```APIDOC ## Create Support Ticket ### Description Allows users to create a support ticket with detailed information. ### Method POST ### Endpoint /support/ticket ### Parameters #### Request Body - **email** (string) - Required - The email address of the user submitting the ticket. - **verification_code** (string) - Optional - A code for verification purposes. - **name** (string) - Required - The name of the user. - **tenancy** (string) - Required - The tenancy the ticket belongs to. - **business_unit** (string) - Required - The business unit associated with the ticket. - **integration** (string) - Optional - Integration details if applicable. - **subject** (string) - Required - The subject line of the support ticket. - **description** (string) - Required - A detailed description of the issue. - **attachments** (array of files) - Optional - Supporting files (screenshots, spreadsheets, PDFs). Max 5 MB each. ``` -------------------------------- ### Project Items API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing project items, including adding and updating them. ```APIDOC ## Project Items API ### Description Manages individual items within projects. ### Endpoints - **POST /project-items/add**: Add a project item. - **GET /project-items/by-project-id**: Get project items by Project ID. - **PUT /project-items/update**: Update a project item. ``` -------------------------------- ### Users API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for retrieving user information, including users by business unit or tenancy. ```APIDOC ## Users API ### Description Provides endpoints to retrieve user information based on various criteria. ### Endpoints - **GET /users/new-by-business-unit**: Get all new users for a specific business unit. - **GET /users/all**: Get all users. - **GET /users/all-include-deleted**: Get all users, including deleted ones. - **GET /users/by-business-unit**: Get a user by ID within a business unit. - **GET /users/by-tenancy**: Get a user by ID within a tenancy. - **GET /users/after-date-by-business-unit**: Get users after a date for a business unit. - **GET /users/after-date-by-tenancy**: Get users after a date for a tenancy. - **GET /users/before-date-by-business-unit**: Get users before a date for a business unit. - **GET /users/before-date-by-tenancy**: Get users before a date for a tenancy. - **GET /users/show-more**: Show more user-related actions. ``` -------------------------------- ### Project Items API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing project items, including adding and updating. ```APIDOC ## Project Items API ### Description Manages items associated with projects. ### Endpoints - **POST /project-items**: Add a project item. - **GET /project-items/project/{projectId}**: Get project items by Project ID. - **PUT /project-items/{id}**: Update a project item. ### Request Example (Add Project Item) ```json { "projectId": "proj1", "description": "Software Development License", "quantity": 1 } ``` ``` -------------------------------- ### Exchange Rates API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for retrieving exchange rate information. ```APIDOC ## Exchange Rates API ### Description Provides endpoints to retrieve current exchange rates. ### Endpoints - **GET /exchange-rates**: Get exchange rate information. ``` -------------------------------- ### Exchange Rates API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for retrieving exchange rate information. ```APIDOC ## Exchange Rates API ### Description Provides access to current exchange rate data. ### Endpoint - **GET /exchange-rates**: Get exchange rate information. ### Response Example (Success) ```json { "currency": "USD", "rate": 0.85 } ``` ``` -------------------------------- ### Users API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for retrieving user information, including filtering by business unit or tenancy. ```APIDOC ## Users API ### Description Provides access to user data. ### Endpoints - **GET /users/new/business-unit**: Get all new users for a business unit. - **GET /users**: Get all users. - **GET /users/include-deleted**: Get all users, including deleted ones. - **GET /users/business-unit/{businessUnitId}**: Get user by ID for a business unit. - **GET /users/tenancy/{tenancyId}**: Get user by ID for a tenancy. - **GET /users/business-unit/after-date**: Get users after a date for a business unit. - **GET /users/tenancy/after-date**: Get users after a date for a tenancy. - **GET /users/business-unit/before-date**: Get users before a date for a business unit. - **GET /users/tenancy/before-date**: Get users before a date for a tenancy. ### Response Example (Get User) ```json { "id": "user1", "username": "john.doe", "email": "john.doe@example.com" } ``` ``` -------------------------------- ### Budgets API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing budgets, including applying budgets to invoices, retrieving budget information, and checking if orders are within budget. ```APIDOC ## Budgets API ### Description Manages budget-related operations, including application and retrieval. ### Endpoints - **POST /budgets/apply-to-invoices**: Apply budgets to multiple invoices. - **POST /budgets/apply-invoice**: Apply an invoice to a budget. - **GET /budgets**: Get all budgets. - **GET /budgets/applicable-by-invoices**: Get applicable budgets by invoice IDs. - **GET /budgets/{budgetId}**: Get a budget by its ID. - **GET /budgets/invoice/{invoiceId}**: Get a budget by invoice ID. - **GET /budgets/order-within-budget**: Check if an order is within budget. ### Request Example (Apply Invoice to Budget) ```json { "invoiceId": "inv456", "budgetId": "bud789" } ``` ### Response Example (Get Budget) ```json { "budgetId": "bud789", "name": "Q3 Marketing Budget", "amount": 5000.00 } ``` ``` -------------------------------- ### Budgets API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing budgets, including applying budgets to invoices and retrieving budget information. ```APIDOC ## Budgets API ### Description Manages budget allocations and retrieval for financial planning. ### Endpoints - **POST /budgets/apply-to-invoices**: Apply budgets to multiple invoices. - **POST /budgets/apply-invoice**: Apply an invoice to a budget. - **GET /budgets/all**: Get all budgets. - **GET /budgets/applicable-by-invoice**: Get applicable budgets by invoice IDs. - **GET /budgets/by-id**: Get a budget by its ID. - **GET /budgets/by-invoice**: Get a budget by invoice ID. - **GET /budgets/is-within-budget**: Check if an order is within budget. - **GET /budgets/show-more**: Show more budget-related actions. ``` -------------------------------- ### Workflows API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for retrieving workflow information. ```APIDOC ## Workflows API ### Description Provides endpoints to retrieve information about available workflows. ### Endpoints - **GET /workflows/all**: Get all workflows. ``` -------------------------------- ### Workflows API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for retrieving workflow information. ```APIDOC ## Workflows API ### Description Provides access to workflow definitions. ### Endpoint - **GET /workflows**: Get all workflows. ### Response Example (Success) ```json [ { "id": "wf1", "name": "Invoice Approval" } ] ``` ``` -------------------------------- ### Business Units API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for retrieving information about business units. ```APIDOC ## Business Units API ### Description Retrieves a list of available business units. ### Endpoint - **GET /business-units**: Get all business units. ### Response Example (Success) ```json [ { "id": "bu1", "name": "Sales Department" }, { "id": "bu2", "name": "Marketing Department" } ] ``` ``` -------------------------------- ### Business Units API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for retrieving information about business units. ```APIDOC ## Business Units API ### Description Provides endpoints to retrieve information about business units. ### Endpoints - **GET /business-units**: Get all business units. ``` -------------------------------- ### Draft Invoices API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for uploading draft invoices. ```APIDOC ## Draft Invoices API ### Description Handles the uploading of draft invoices into the system. ### Endpoint - **POST /draft-invoices/upload**: Upload an invoice to the inbox. ### Request Example (Upload Invoice) ```json { "invoiceData": "base64EncodedInvoiceString" } ``` ``` -------------------------------- ### Draft Invoices API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for uploading draft invoices. ```APIDOC ## Draft Invoices API ### Description Handles the uploading of draft invoices to the system. ### Endpoints - **POST /draft-invoices/upload-to-inbox**: Upload an invoice to the inbox as a draft. ``` -------------------------------- ### Purchase Orders API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing purchase orders, including adding, retrieving, and updating them. ```APIDOC ## Purchase Orders API ### Description Manages purchase orders, from creation to tracking related invoices and orders. ### Endpoints - **POST /purchase-orders/add**: Add a new purchase order. - **GET /purchase-orders/check-exists**: Check if a purchase order exists. - **GET /purchase-orders/all**: Get all purchase orders. - **GET /purchase-orders/invoices-related**: Get invoices related to a purchase order. - **GET /purchase-orders/by-property-value**: Get purchase orders by property value. - **GET /purchase-orders/exists-by-order-number**: Check if a purchase order exists by its order number. - **GET /purchase-orders/after-date**: Get purchase orders after a specific date. - **GET /purchase-orders/before-date**: Get purchase orders before a specific date. - **GET /purchase-orders/property-value-by-ids**: Get property value by Purchase Order IDs (e.g., Supplier Name). - **GET /purchase-orders/by-id**: Get a purchase order by its ID. - **PUT /purchase-orders/update**: Update an existing purchase order. - **GET /purchase-orders/show-more**: Show more purchase order-related actions. ``` -------------------------------- ### Approvals API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing document approvals, including adding process logs, approving, rejecting, and retrieving documents. ```APIDOC ## Approvals API ### Description Provides endpoints for managing document approval workflows. ### Endpoints - **POST /approvals/process-log**: Add a process log to a document. - **POST /approvals/approve**: Approve a document. - **GET /approvals/documents**: Get all documents. - **GET /approvals/grn**: Get GRN after a specific date. - **GET /approvals/invoice-pdf**: Get the primary invoice file as a PDF. - **POST /approvals/reject**: Reject a document. - **POST /approvals/send-to-workflow**: Send a document to a workflow. - **POST /approvals/send-to-workflow/{workflowId}**: Send a document to a specific workflow ID. ### Request Example (Approve Document) ```json { "documentId": "doc123" } ``` ### Response Example (Success) ```json { "status": "success", "message": "Document approved successfully." } ``` ``` -------------------------------- ### Suppliers API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing suppliers, including adding, retrieving, updating, and searching. ```APIDOC ## Suppliers API ### Description Manages supplier information within the system. ### Endpoints - **POST /suppliers/range**: Add or update a range of suppliers. - **POST /suppliers**: Add a new supplier. - **POST /suppliers/email-address**: Add a supplier email address. - **GET /suppliers/invoice-number-exists**: Check if an invoice number exists for a supplier. - **GET /suppliers/{id}**: Get a supplier by ID. - **GET /suppliers/property-value**: Get supplier by property value. - **GET /suppliers/exists/{id}**: Check if a supplier exists by ID. - **GET /suppliers/skip/{skip}/take/{take}**: Get suppliers with pagination. - **GET /suppliers/after-date**: Get suppliers after a specific date. - **GET /suppliers/before-date**: Get suppliers before a specific date. - **GET /suppliers/search**: Get suppliers by search query. - **PUT /suppliers/{id}**: Update a supplier. ### Request Example (Add Supplier) ```json { "name": "Acme Corp", "contactEmail": "info@acme.com" } ``` ### Response Example (Get Supplier) ```json { "id": "sup1", "name": "Acme Corp", "status": "Active" } ``` ``` -------------------------------- ### Approvals API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing document approvals, including adding process logs, approving documents, and rejecting documents. ```APIDOC ## Approvals API ### Description Provides endpoints for managing document approval workflows. ### Endpoints - **POST /approvals/process-log**: Add a process log to a document. - **POST /approvals/approve**: Approve a document. - **GET /approvals/documents**: Get all documents. - **GET /approvals/grn-after-date**: Get GRN after a specific date. - **GET /approvals/invoice-pdf**: Get the primary invoice file as a PDF. - **POST /approvals/reject**: Reject a document. - **POST /approvals/send-to-workflow**: Send a document to a workflow. - **POST /approvals/send-to-workflow-by-id**: Send a document to a workflow specifying the workflow ID. - **GET /approvals/show-more**: Show more approval-related actions. ``` -------------------------------- ### Suppliers API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing suppliers, including adding, retrieving, and updating them. ```APIDOC ## Suppliers API ### Description Manages supplier information, including adding, updating, and retrieving details. ### Endpoints - **POST /suppliers/add-or-update-range**: Add or update a range of suppliers. - **POST /suppliers/add**: Add a new supplier. - **POST /suppliers/add-email-address**: Add an email address for a supplier. - **GET /suppliers/invoice-number-exists**: Check if an invoice number exists for a supplier. - **GET /suppliers/by-id**: Get a supplier by its ID. - **GET /suppliers/by-property-value**: Get a supplier by its property value. - **GET /suppliers/exists-by-id**: Check if a supplier exists by its ID. - **GET /suppliers/all-with-skip-take**: Get suppliers with skip and take parameters. - **GET /suppliers/after-date**: Get suppliers added after a specific date. - **GET /suppliers/before-date**: Get suppliers added before a specific date. - **PUT /suppliers/update**: Update an existing supplier. - **GET /suppliers/show-more**: Show more supplier-related actions. ``` -------------------------------- ### Goods Received Note (GRN) API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing Goods Received Notes (GRNs). ```APIDOC ## Goods Received Note (GRN) API ### Description Manages Goods Received Notes (GRNs) for tracking received goods. ### Endpoints - **POST /grn/add**: Add a new GRN. - **POST /grn/add-multiple**: Add multiple GRNs. - **GET /grn/all**: Get all GRNs (with skip and take). - **GET /grn/after-date**: Get GRNs after a specific date (with skip and take). - **GET /grn/before-date**: Get GRNs before a specific date (with skip and take). - **GET /grn/by-grn-id**: Get a GRN by its ID. - **GET /grn/by-property-value**: Get GRNs by property value (GRN Number). - **GET /grn/show-more**: Show more GRN-related actions. ``` -------------------------------- ### Purchase Orders API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing purchase orders, including adding, retrieving, updating, and checking order status. ```APIDOC ## Purchase Orders API ### Description Manages purchase orders within the system. ### Endpoints - **POST /purchase-orders**: Add a new purchase order. - **GET /purchase-orders/exists**: Check if an order exists. - **GET /purchase-orders/order-number/{orderNumber}**: Get order exists by Order Number. - **GET /purchase-orders**: Get all purchase orders. - **GET /purchase-orders/invoices**: Get invoices related to a purchase order. - **GET /purchase-orders/property-value**: Get order by property value. - **GET /purchase-orders/{id}**: Get a purchase order by ID. - **GET /purchase-orders/after-date**: Get orders after a specific date. - **GET /purchase-orders/before-date**: Get orders before a specific date. - **GET /purchase-orders/property-value/ids**: Get property value by Purchase Order IDs (Example Supplier Name). - **PUT /purchase-orders/{id}**: Update a purchase order. ### Request Example (Add Purchase Order) ```json { "orderNumber": "PO-5678", "supplierId": "sup1", "orderDate": "2023-10-27" } ``` ### Response Example (Get Purchase Order) ```json { "id": "po1", "orderNumber": "PO-5678", "status": "Issued" } ``` ``` -------------------------------- ### Divisions API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing divisions, including adding, retrieving, updating, and searching for divisions. ```APIDOC ## Divisions API ### Description Provides endpoints for managing organizational divisions. ### Endpoints - **POST /divisions**: Add a new division. - **GET /divisions**: Get all divisions. - **GET /divisions/skip/{skip}/take/{take}**: Get all divisions with pagination. - **GET /divisions/{id}**: Get a division by its ID. - **GET /divisions/property-value**: Get divisions by property value. - **GET /divisions/search**: Search for a division. - **GET /divisions/exists/{id}**: Check if a division exists by ID. - **PUT /divisions/{id}**: Update a division. ### Request Example (Add Division) ```json { "name": "Research and Development" } ``` ### Response Example (Get Division) ```json { "id": "div1", "name": "Research and Development" } ``` ``` -------------------------------- ### Invoices API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing invoices, including adding, updating, deleting, and retrieving them. ```APIDOC ## Invoices API ### Description Manages all aspects of invoice processing, from creation to retrieval. ### Endpoints - **POST /invoices/add**: Add a new invoice. - **POST /invoices/add-or-update-by-range**: Add or update invoices by a range. - **GET /invoices/count-ready-for-export**: Count invoices ready for export (Smartsync). - **DELETE /invoices/delete**: Delete an invoice. - **GET /invoices/all**: Get all invoices (with skip and take). - **GET /invoices/exists**: Check if an invoice exists. - **GET /invoices/exists-by-number**: Check if an invoice exists by its number. - **GET /invoices/has-attachment**: Check if an invoice has an attachment. - **GET /invoices/after-date**: Get invoices after a specific date. - **GET /invoices/after-date-with-skip-take**: Get invoices after a specific date (with skip and take). - **GET /invoices/before-date**: Get invoices before a specific date. - **GET /invoices/by-export-type**: Get invoices by export type (e.g., Smartsync and Ready for Export). - **GET /invoices/by-export-type-with-skip-take**: Get invoices by export type (with skip and take). - **GET /invoices/by-id**: Get invoices by their ID. - **GET /invoices/by-property-value**: Get invoices by property value. - **PUT /invoices/update**: Update an existing invoice. - **POST /invoices/upload-pdf**: Upload an invoice PDF. - **GET /invoices/show-more**: Show more invoice-related actions. ``` -------------------------------- ### Divisions API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing divisions, including adding, retrieving, and updating them. ```APIDOC ## Divisions API ### Description Manages organizational divisions within the system. ### Endpoints - **POST /divisions/add**: Add a new division. - **GET /divisions/all**: Get all divisions. - **GET /divisions/all-with-skip-take**: Get all divisions with skip and take parameters. - **GET /divisions/by-id**: Get a division by its ID. - **GET /divisions/by-property-value**: Get a division by its property value. - **GET /divisions/search**: Search for a division. - **GET /divisions/exists-by-id**: Check if a division exists by its ID. - **PUT /divisions/update**: Update an existing division. - **GET /divisions/show-more**: Show more division-related actions. ``` -------------------------------- ### Documents API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing document history and export status. ```APIDOC ## Documents API ### Description Manages document-related actions, including history and export status. ### Endpoints - **POST /documents/history**: Add a document history entry. - **POST /documents/export**: Complete document export. - **GET /documents/history/{id}**: Get document history by ID. - **GET /documents/exported/{exportType}**: Check if documents have been exported to a specific type. - **GET /documents/exported/multiple/{exportType}**: Check if multiple documents have been exported to a specific type. ### Request Example (Add History Entry) ```json { "documentId": "doc456", "action": "Created", "timestamp": "2023-10-27T10:00:00Z" } ``` ``` -------------------------------- ### Documents API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing document history and export status. ```APIDOC ## Documents API ### Description Provides endpoints for managing document history and export processes. ### Endpoints - **POST /documents/history/add**: Add a document history entry. - **POST /documents/export/complete**: Complete document export. - **GET /documents/history/by-id**: Get document history by ID. - **GET /documents/exported/to-export-type**: Check if a document has been exported to a specific type. - **GET /documents/exported/multiple-to-export-type**: Check if multiple documents have been exported to a specific type. - **GET /documents/show-more**: Show more document-related actions. ``` -------------------------------- ### Nominal Codes API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing nominal codes, including adding, retrieving, updating, and searching. ```APIDOC ## Nominal Codes API ### Description Manages nominal codes used for accounting purposes. ### Endpoints - **POST /nominal-codes**: Add a new nominal code. - **GET /nominal-codes**: Get all nominal codes. - **GET /nominal-codes/search**: Search for a nominal code. - **GET /nominal-codes/{id}**: Get a nominal code by ID. - **GET /nominal-codes/property-value**: Get nominal code by property value. - **GET /nominal-codes/exists/{id}**: Check if a nominal code exists by ID. - **GET /nominal-codes/skip/{skip}/take/{take}**: Get nominal codes with pagination. - **PUT /nominal-codes/{id}**: Update a nominal code. ### Request Example (Add Nominal Code) ```json { "code": "1000", "description": "Sales Revenue" } ``` ### Response Example (Get Nominal Code) ```json { "id": "nc1", "code": "1000", "description": "Sales Revenue" } ``` ``` -------------------------------- ### Invoices API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing invoices, including adding, updating, deleting, retrieving, and filtering. ```APIDOC ## Invoices API ### Description Provides comprehensive management of invoices. ### Endpoints - **POST /invoices**: Add a new invoice. - **POST /invoices/range**: Add or update invoices by range. - **GET /invoices/export/count**: Count invoices ready for export. - **DELETE /invoices/{id}**: Delete an invoice. - **GET /invoices**: Get all invoices (with Skip and Take). - **GET /invoices/exists**: Check if an invoice exists. - **GET /invoices/exists/{invoiceNumber}**: Check if an invoice exists by invoice number. - **GET /invoices/has-attachment**: Check if an invoice has an attachment. - **GET /invoices/after-date**: Get invoices after a specific date. - **GET /invoices/after-date/skip/{skip}/take/{take}**: Get invoices after a date with pagination. - **GET /invoices/before-date**: Get invoices before a specific date. - **GET /invoices/export-type/{exportType}**: Get invoices by export type. - **GET /invoices/export-type/{exportType}/skip/{skip}/take/{take}**: Get invoices by export type with pagination. - **GET /invoices/{id}**: Get an invoice by its ID. - **GET /invoices/property-value**: Get invoices by property value. - **PUT /invoices/{id}**: Update an invoice. - **POST /invoices/pdf**: Upload an invoice PDF. ### Request Example (Add Invoice) ```json { "invoiceNumber": "INV-001", "supplierId": "sup1", "date": "2023-10-27", "totalAmount": 150.75 } ``` ### Response Example (Get Invoice) ```json { "id": "inv1", "invoiceNumber": "INV-001", "status": "Approved" } ``` ``` -------------------------------- ### Goods Received Note (GRN) API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing Goods Received Notes (GRNs), including adding, retrieving, and filtering. ```APIDOC ## Goods Received Note (GRN) API ### Description Manages Goods Received Notes (GRNs) within the system. ### Endpoints - **POST /grns**: Add a new GRN. - **POST /grns/multiple**: Add multiple GRNs. - **GET /grns**: Get all GRNs (with Skip and Take). - **GET /grns/after-date**: Get GRNs after a specific date (with Skip and Take). - **GET /grns/before-date**: Get GRNs before a specific date (with Skip and Take). - **GET /grns/{grnId}**: Get a GRN by its ID. - **GET /grns/property-value**: Get GRNs by property value (GRN Number). ### Request Example (Add GRN) ```json { "grnNumber": "GRN123", "supplierId": "sup1", "items": [ { "productId": "prod1", "quantity": 10 } ] } ``` ### Response Example (Get GRN) ```json { "id": "grn1", "grnNumber": "GRN123", "status": "Received" } ``` ``` -------------------------------- ### Cost Codes API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing cost codes, including adding, retrieving, updating, and searching for cost codes. ```APIDOC ## Cost Codes API ### Description Provides functionality for managing cost codes within the system. ### Endpoints - **POST /cost-codes**: Add a new cost code. - **GET /cost-codes**: Get all cost codes. - **GET /cost-codes/skip/{skip}/take/{take}**: Get all cost codes with pagination. - **GET /cost-codes/{id}**: Get a cost code by its ID. - **GET /cost-codes/property-value**: Get cost codes by property value. - **GET /cost-codes/search**: Search for a cost code. - **PUT /cost-codes/{id}**: Update a cost code. ### Request Example (Add Cost Code) ```json { "code": "DEV-001", "description": "Development Costs" } ``` ### Response Example (Get Cost Code) ```json { "id": "cc1", "code": "DEV-001", "description": "Development Costs" } ``` ``` -------------------------------- ### Nominal Codes API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing nominal codes, including adding, retrieving, and updating them. ```APIDOC ## Nominal Codes API ### Description Manages nominal codes for accounting purposes. ### Endpoints - **POST /nominal-codes/add**: Add a new nominal code. - **GET /nominal-codes/all**: Get all nominal codes. - **GET /nominal-codes/search**: Search for a nominal code. - **GET /nominal-codes/by-id**: Get a nominal code by its ID. - **GET /nominal-codes/by-property-value**: Get a nominal code by its property value. - **GET /nominal-codes/exists-by-id**: Check if a nominal code exists by its ID. - **GET /nominal-codes/all-with-skip-take**: Get nominal codes with skip and take parameters. - **PUT /nominal-codes/update**: Update an existing nominal code. - **GET /nominal-codes/show-more**: Show more nominal code-related actions. ``` -------------------------------- ### Custom Fields (Document) API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing custom fields associated with documents. ```APIDOC ## Custom Fields (Document) API ### Description Manages custom fields that can be applied to documents. ### Endpoints - **GET /custom-fields/document**: Get all custom fields for documents. - **GET /custom-fields/document/property-value**: Get custom fields by property value. - **GET /custom-fields/document/exists/{id}**: Check if a custom field exists by ID. - **GET /custom-fields/document/{id}**: Get custom fields by ID. - **PUT /custom-fields/document/{id}**: Update custom fields. ### Response Example (Get Custom Field) ```json { "id": "cf1", "name": "Project Code", "type": "text" } ``` ``` -------------------------------- ### Custom Fields (Document) API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing custom fields associated with documents. ```APIDOC ## Custom Fields (Document) API ### Description Manages custom fields that can be applied to documents. ### Endpoints - **GET /custom-fields/document/all**: Get all custom fields for documents. - **GET /custom-fields/document/by-property-value**: Get custom fields by a property value. - **GET /custom-fields/document/exists-by-id**: Check if a custom field exists by its ID. - **GET /custom-fields/document/by-id**: Get custom fields by their ID. - **PUT /custom-fields/document/update**: Update custom fields for documents. - **GET /custom-fields/document/show-more**: Show more document custom field actions. ``` -------------------------------- ### Tax Codes API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing tax codes, including adding, retrieving, updating, and searching. ```APIDOC ## Tax Codes API ### Description Manages tax codes used for financial calculations. ### Endpoints - **POST /tax-codes**: Add a new tax code. - **GET /tax-codes/exists/{id}**: Check if a tax code exists by ID. - **GET /tax-codes**: Get all tax codes. - **GET /tax-codes/skip/{skip}/take/{take}**: Get all tax codes with pagination. - **GET /tax-codes/search**: Search for a tax code. - **GET /tax-codes/{id}**: Get a tax code by ID. - **GET /tax-codes/property-value**: Get tax code by property value. - **PUT /tax-codes/{id}**: Update a tax code. ### Request Example (Add Tax Code) ```json { "code": "VAT", "rate": 20.0 } ``` ### Response Example (Get Tax Code) ```json { "id": "tc1", "code": "VAT", "rate": 20.0 } ``` ``` -------------------------------- ### Cost Codes API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing cost codes, including adding, retrieving, and updating them. ```APIDOC ## Cost Codes API ### Description Manages cost code entries for financial tracking. ### Endpoints - **POST /cost-codes/add**: Add a new cost code. - **GET /cost-codes/all**: Get all cost codes. - **GET /cost-codes/all-with-skip-take**: Get all cost codes with skip and take parameters. - **GET /cost-codes/by-id**: Get a cost code by its ID. - **GET /cost-codes/by-property-value**: Get cost codes by a specific property value. - **GET /cost-codes/search**: Search for a cost code. - **PUT /cost-codes/update**: Update an existing cost code. - **GET /cost-codes/show-more**: Show more cost code-related actions. ``` -------------------------------- ### Shared Data API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for accessing shared data like currencies and supplier email addresses. ```APIDOC ## Shared Data API ### Description Provides access to shared data entities like currencies and supplier email addresses. ### Endpoints - **GET /shared-data/currencies**: Get a list of available currencies. - **POST /shared-data/supplier-email-addresses/remove**: Remove a supplier email address. - **PUT /shared-data/supplier-email-addresses/update**: Update a supplier email address. ``` -------------------------------- ### Shared Data API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for accessing shared data like currencies and supplier email addresses. ```APIDOC ## Shared Data API ### Description Provides access to shared data entities. ### Endpoints - **GET /shared-data/currencies**: Get a list of available currencies. - **POST /shared-data/supplier-email-addresses**: Add a supplier email address. - **DELETE /shared-data/supplier-email-addresses/{id}**: Remove a supplier email address. - **PUT /shared-data/supplier-email-addresses/{id}**: Update a supplier email address. ### Response Example (Get Currencies) ```json [ {"code": "USD", "name": "United States Dollar"}, {"code": "EUR", "name": "Euro"} ] ``` ``` -------------------------------- ### Tax Codes API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing tax codes, including adding, retrieving, and updating them. ```APIDOC ## Tax Codes API ### Description Manages tax codes used for financial calculations. ### Endpoints - **POST /tax-codes/add**: Add a new tax code. - **GET /tax-codes/check-exists-by-id**: Check if a tax code exists by its ID. - **GET /tax-codes/all**: Get all tax codes. - **GET /tax-codes/all-with-skip-take**: Get all tax codes with skip and take parameters. - **GET /tax-codes/search**: Search for a tax code. - **GET /tax-codes/by-id**: Get a tax code by its ID. - **GET /tax-codes/by-property-value**: Get a tax code by its property value. - **PUT /tax-codes/update**: Update an existing tax code. - **GET /tax-codes/show-more**: Show more tax code-related actions. ``` -------------------------------- ### Division Restrictions API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing division-specific restrictions. ```APIDOC ## Division Restrictions API ### Description Manages restrictions applied at the division level. ### Endpoints - **GET /division-restrictions/{id}**: Get division restrictions by ID. - **GET /division-restrictions/division/{divisionId}/type/{type}**: Get restrictions by division ID and type (Cost Code). - **GET /division-restrictions/division/{divisionId}/type/{type}/project**: Get restrictions by division ID and type (Project). - **GET /division-restrictions/division/{divisionId}/type/{type}/nominal-code**: Get restrictions by division ID and type (Nominal Code). - **PUT /division-restrictions**: Update restrictions. ### Request Example (Update Restrictions) ```json { "divisionId": "div1", "type": "Cost Code", "restrictedValues": ["CC-001", "CC-002"] } ``` ``` -------------------------------- ### Division Restrictions API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing division-specific restrictions. ```APIDOC ## Division Restrictions API ### Description Manages restrictions applied to divisions based on type. ### Endpoints - **GET /division-restrictions/by-id**: Get division restrictions by ID. - **GET /division-restrictions/by-division-id-and-type-cost-code**: Get restrictions by Division ID and Type (Cost Code). - **GET /division-restrictions/by-division-id-and-type-project**: Get restrictions by Division ID and Type (Project). - **GET /division-restrictions/by-division-id-and-type-nominal-code**: Get restrictions by Division ID and Type = Nominal Code. - **PUT /division-restrictions/update**: Update division restrictions. - **GET /division-restrictions/show-more**: Show more division restriction actions. ``` -------------------------------- ### Custom Fields (Line Item) API Source: https://ask.zaharasoftware.com/api-docs/index Endpoints for managing custom fields associated with line items. ```APIDOC ## Custom Fields (Line Item) API ### Description Manages custom fields that can be applied to line items within documents. ### Endpoints - **GET /custom-fields/line-item/all**: Get all custom fields for line items. - **GET /custom-fields/line-item/by-id**: Get a custom coding field by its ID. - **GET /custom-fields/line-item/by-property-value**: Get a custom coding field by its property value. - **GET /custom-fields/line-item/exists-by-id**: Check if a custom coding field exists by its ID. - **PUT /custom-fields/line-item/update-by-id**: Update a custom field by its ID. - **GET /custom-fields/line-item/show-more**: Show more line item custom field actions. ``` -------------------------------- ### Custom Fields (Line Item) API Source: https://ask.zaharasoftware.com/api-docs/home Endpoints for managing custom fields associated with line items in documents. ```APIDOC ## Custom Fields (Line Item) API ### Description Manages custom fields applicable to line items within documents. ### Endpoints - **GET /custom-fields/line-item**: Get all custom fields for line items. - **GET /custom-fields/line-item/coding-field/{id}**: Get a coding field by ID. - **GET /custom-fields/line-item/coding-field/property-value**: Get coding fields by property value. - **GET /custom-fields/line-item/coding-field/exists/{id}**: Check if a coding field exists by ID. - **PUT /custom-fields/line-item/{id}**: Update a custom field by ID. ### Response Example (Get Line Item Custom Field) ```json { "id": "licf1", "name": "Department Allocation", "type": "dropdown" } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.