{"info":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","description":"

Welcome to the alostaz.io API Documentation

The alostaz.io API provides full access to all the features and capabilities available in our platform. It allows seamless integration and automation of core functionalities within your own applications and systems.

Authentication and Required Headers

Before making requests to the API, please ensure that all required headers are included.
These headers are automatically handled in our Postman collection through pre-request scripts (some utilize environment variables).

Required Headers:

Accept: application/json
\n
Content-Type: application/json
\n
X-Branch-Id: (Branch identifier for the request)
\n
X-Locale: en or ar (Language preference)
\n
X-API-Version: (Specify the API version to use)
\n

In addition, an Authorization header with a Bearer token must be included in every request.

Authentication Token

To obtain an access token:

Navigate to Settings → API in your dashboard.
\n
Create a new API Client.
\n
After creating the client, you will receive:
\n
- A Bearer token for authorization.
  \n
- The API Base URL, which you’ll use for all requests.
  \n
\n

Use these credentials to authenticate and interact with the alostaz.io API securely.

Deprecation Note

We plan to remove deprecated API features and components after 3 months only.
Please monitor your registered email for deprecation notices and migration instructions.

Support

For API Support, please contact our development team at:
📧 dev@alostaz.io

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"49203251","collectionId":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","publishedId":"2sB3QMLUUo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"4F46E5"},"publishDate":"2025-10-14T12:36:52.000Z"},"item":[{"name":"branches","item":[{"name":"Index","id":"f619acac-4ed7-414c-a4f4-c23df90f1908","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/branches","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["branches"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"f619acac-4ed7-414c-a4f4-c23df90f1908"},{"name":"Create","id":"2f2d7cdc-de37-485a-b6cb-8ec4252d3128","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"فرع الرياض الرئيسي\",\n \"partner_list_id\": 1,\n \"business_id\": 1\n}","options":{"raw":{"language":"json"}}},"url":"/branches","description":"

Properties

`name`

Required
Type: string
Max length: 255

`register`

Optional
Type: string
Max length: 255

`address_line_1`

Optional
Type: string
Max length: 255

`address_line_2`

Optional
Type: string
Max length: 255

`district`

Optional
Type: string
Max length: 255

`city`

Optional
Type: string
Max length: 255

`state`

Optional
Type: string
Max length: 255

`postal_code`

Optional
Type: string
Max length: 255

`country`

Optional
Type: string
Length: 2 (ISO 3166-1 alpha-2)
Must be uppercase letters

`partner_list_id`

Required
Type: integer
Must reference an existing partner_lists.id

`business_id`

Required
Type: integer
Must reference an existing businesses.id

Properties

`name`

Required
Type: string
Max length: 255

`register`

Optional
Type: string
Max length: 255

`address_line_1`

Optional
Type: string
Max length: 255

`address_line_2`

Optional
Type: string
Max length: 255

`district`

Optional
Type: string
Max length: 255

`city`

Optional
Type: string
Max length: 255

`state`

Optional
Type: string
Max length: 255

`postal_code`

Optional
Type: string
Max length: 255

`country`

Optional
Type: string
Length: 2 (ISO 3166-1 alpha-2)
Must be uppercase letters

Properties

`name`

Required
Type: string
Max length: 255

Properties

`name`

Required
Type: string
Max length: 255

Properties

`name`

Required
Type: string
Max length: 255

Properties

`name`

Required
Type: string
Max length: 255

`date`

Required
Type: string
Format: Y-m-d

`creates_journal_entry`

Required
Type: integer
Allowed values: 0, 1

Properties

`name`

Required
Type: string
Max length: 255

`date`

Required
Type: string
Format: Y-m-d

`creates_journal_entry`

Required
Type: integer
Allowed values: 0, 1

Filter designs belonging to templates with this type. Allowed values: general, invoice, product.

\n","type":"text/plain"},"key":"type","value":""}],"variable":[]}},"response":[],"_postman_id":"8d1364b9-9300-46d4-8e41-73ada38ac8dd"},{"name":"Create","id":"4997dfbe-23d1-4237-ac48-275ad5f9c9fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/document-template-designs","description":"

Properties

`document_template_id`

Required
Type: integer
Must reference an existing document_templates.id

`name`

Required
Type: string
Max length: 255

`settings`

Required
Type: array
Holds design-specific configuration values

`logo`

Optional
Type: object
Item Properties:
- id
  - Optional
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Optional
  - Type: string
  \n
\n

`left_signature_image`, `middle_signature_image`, `right_signature_image`

Optional
Type: object
Each uses the same properties as logo

`version`

Required
Type: string
Max length: 255

`branches`

Required
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing branches.id
  \n
\n

Properties

`name`

Required
Type: string
Max length: 255

`settings`

Required
Type: array
Holds design-specific configuration values

`logo`

Optional
Type: object
Item Properties:
- id
  - Optional
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Optional
  - Type: string
  \n
\n

`left_signature_image`, `middle_signature_image`, `right_signature_image`

Optional
Type: object
Each uses the same properties as logo

`version`

Required
Type: string
Max length: 255

`branches`

Required
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing branches.id
  \n
\n

Filter templates by type. Allowed values: general, invoice, product.

\n","type":"text/plain"},"key":"type","value":""}],"variable":[]}},"response":[],"_postman_id":"16e5af1c-49fc-4dae-a4af-4a52f9547bc9"},{"name":"View","id":"1ff5e016-4076-461b-9b0e-2d8d5c539059","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/document-templates/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["document-templates",":id"],"host":[""],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"1ff5e016-4076-461b-9b0e-2d8d5c539059"}],"id":"c5ef16d0-af2b-4f60-9a6d-18f795e382de","_postman_id":"c5ef16d0-af2b-4f60-9a6d-18f795e382de","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}},{"name":"exports","item":[{"name":"partners","id":"dda2930d-a696-4a26-8820-a19650d9391b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[]"},"url":"/exports/partners","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["exports","partners"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"dda2930d-a696-4a26-8820-a19650d9391b"},{"name":"products","id":"8e13b0c3-303d-41ad-b15a-cae82979f867","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[]"},"url":"/exports/products","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["exports","products"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"8e13b0c3-303d-41ad-b15a-cae82979f867"}],"id":"504e7292-9334-47a1-bb0a-8190ed72c164","_postman_id":"504e7292-9334-47a1-bb0a-8190ed72c164","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}},{"name":"helpers","item":[{"name":"zatca","item":[{"name":"onboard","id":"bede3df8-191a-4ad2-92fb-f272cf4b0af0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"environment\": \"environment sample value\",\n \"csr_info\": [],\n \"csr_info.uid\": \"csr_info.uid sample value\",\n \"csr_info.organization_name\": \"csr_info.organization_name sample value\",\n \"csr_info.organization_unit_name\": \"csr_info.organization_unit_name sample value\",\n \"csr_info.registered_address\": \"csr_info.registered_address sample value\",\n \"csr_info.business_category\": \"csr_info.business_category sample value\",\n \"otps\": []\n}"},"url":"/helpers/zatca/onboard","description":"

Properties

`environment`

Required
Type: string

`csr_info`

Required
Type: object

`csr_info.uid`

Required
Type: string

`csr_info.organization_name`

Required
Type: string

`csr_info.organization_unit_name`

Required
Type: string

`csr_info.registered_address`

Required
Type: string
Max length: 64

`csr_info.business_category`

Required
Type: string
Max length: 64

`otps`

Required
Type: array

Properties

`invoice_id`

Required
Type: integer
Must reference an existing invoices.id

`document_template_design_id`

Required
Type: integer
Must reference an existing document_template_designs.id (invoice type)

`method`

Required
Type: string
Allowed values: link, email

Properties

`purpose`

Required
Type: string
Max length: 255

`file`

Required
Type: file
Allowed MIME types: xlsx, xls, csv
Maximum size: 16 MB

Required. Return settlements belonging to this invoices.id.

\n","type":"text/plain"},"key":"invoice_id","value":""}],"variable":[]}},"response":[],"_postman_id":"5d518b2d-1997-47cc-ba62-61700a7ab66b"},{"name":"Create","id":"dc4ced56-d4e3-445d-b23b-ba093d50f4ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"invoice_id\": 1201,\n \"amount\": 18500,\n \"date\": \"2024-10-15\"\n}","options":{"raw":{"language":"json"}}},"url":"/invoice-settlements","description":"

Properties

`invoice_id`

Required
Type: integer
Must reference an existing invoices.id with variant standard

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub
Must belong to a branch accessible to the authenticated user

`amount`

Required
Type: integer
Minimum: 1

`description`

Optional
Type: string

`date`

Required
Type: string
Format: date

Properties

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub
Required when the settlement currently targets a journal account

`amount`

Required
Type: integer
Minimum: 1

`description`

Optional
Type: string

`date`

Optional
Type: string
Format: date

Filter by invoice variant. Allowed values: standard, order.

\n","type":"text/plain"},"key":"variant","value":""},{"disabled":true,"description":{"content":"

Filter by invoice status. Allowed values: draft, issued.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Filter by invoice nature. Allowed values: sale, purchase.

\n","type":"text/plain"},"key":"nature","value":""},{"disabled":true,"description":{"content":"

Filter by invoice type. Allowed values: invoice, credit_note.

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Filter by invoice code (partial match).

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Filter by partner identifier.

\n","type":"text/plain"},"key":"partner_id","value":""},{"disabled":true,"description":{"content":"

Filter by partner order code.

\n","type":"text/plain"},"key":"partner_order_code","value":""},{"disabled":true,"description":{"content":"

Filter invoices that contain the given product in their line items.

\n","type":"text/plain"},"key":"product_id","value":""},{"disabled":true,"description":{"content":"

Return invoices created at or after this ISO 8601 date/time.

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Return invoices created at or before this ISO 8601 date/time.

\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"

Return invoices with issue_date on or after this ISO 8601 date/time.

\n","type":"text/plain"},"key":"start_issue_date","value":""},{"disabled":true,"description":{"content":"

Return invoices with issue_date on or before this ISO 8601 date/time.

\n","type":"text/plain"},"key":"end_issue_date","value":""},{"disabled":true,"description":{"content":"

Return invoices with due_date on or after this ISO 8601 date/time.

\n","type":"text/plain"},"key":"start_due_date","value":""},{"disabled":true,"description":{"content":"

Return invoices with due_date on or before this ISO 8601 date/time.

\n","type":"text/plain"},"key":"end_due_date","value":""},{"disabled":true,"description":{"content":"

Search invoices whose notes contain this text.

\n","type":"text/plain"},"key":"notes","value":""},{"disabled":true,"description":{"content":"

Search invoices whose line item descriptions contain this text.

\n","type":"text/plain"},"key":"line_item_description","value":""},{"disabled":true,"description":{"content":"

Filter by whether payments are marked as full (1) or not (0).

\n","type":"text/plain"},"key":"payments_is_full","value":""},{"disabled":true,"description":{"content":"

Filter by comma-separated payment statuses. Allowed values: unpaid, partially_paid, paid, partially_settled, settled.

\n","type":"text/plain"},"key":"payments_status","value":""},{"disabled":true,"description":{"content":"

Filter by stock movements status. Allowed values: pending, partially_processed, processed.

\n","type":"text/plain"},"key":"stock_movements_status","value":""},{"disabled":true,"description":{"content":"

Filter by reverse status. Allowed values: unreversed, partially_reversed, reversed.

\n","type":"text/plain"},"key":"reverse_status","value":""},{"disabled":true,"description":{"content":"

Column used to sort results. Allowed values: id, issue_date, due_date.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

Sort direction. Allowed values: asc, desc.

\n","type":"text/plain"},"key":"order","value":""},{"disabled":true,"description":{"content":"

Number of items per page (max 100).

\n","type":"text/plain"},"key":"per_page","value":""}],"variable":[]}},"response":[],"_postman_id":"f96e8348-0d01-4348-9d64-4796c8859d8b"},{"name":"Create","id":"f94d9568-ebfa-4c47-92a1-473bf8513402","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"variant\": \"standard\",\n \"nature\": \"sale\",\n \"type\": \"invoice\",\n \"status\": \"issued\",\n \"issue_date\": \"2025-10-13T11:08:11.492Z\",\n \"due_date\": \"2025-10-13T11:08:11.492Z\",\n \"partner_id\": 1,\n \"line_items\": [\n {\n \"product_id\": 1,\n \"storehouse_id\": 1,\n \"unit_quantity\": 1000,\n \"unit_price\": 4800,\n \"unit_content\": 1,\n \"taxes\": [\n {\n \"id\": 1\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/invoices","description":"

Properties

`parent_id`

Optional
\n
Type: integer
\n

`variant`

Required
\n
Type: string
\n
Enum: standard, order
\n

`nature`

Required
\n
Type: string
\n
Enum: sale, purchase
\n

`type`

Required
\n
Type: string
\n
Enum: invoice, credit_note
\n

`status`

Required
\n
Type: string
\n
Enum: draft, issued
\n

`code`

Optional
\n
Type: string
\n

`partner_id`

Required
\n
Type: integer
\n

`partner_order_code`

Optional
\n
Type: string
\n

`issue_date`

Required
\n
Type: string
\n
Format: date-time
\n

`due_date`

Required
\n
Type: string
\n
Format: date-time
\n

`journal_account_id`

Optional
\n
Type: integer
\n

`discount_amount`

Optional
\n
Type: integer (minimum 1)
\n

`discount_percentage`

Optional
\n
Type: number (0–100)
\n

`notes`

Optional
\n
Type: string
\n

`responsible_user_id`

Optional
\n
Type: integer
\n

`attachments`

Optional
\n
Type: array (max 5)
\n
Item Properties:
\n
- id
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
- secret
  \n
  - Required
    \n
  - Type: string
    \n
  \n
\n

`line_items`

Required
\n
Type: array
\n
Item Properties:
\n
- product_id
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
- storehouse_id
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
- description
  \n
  - Optional
    \n
  - Type: string
    \n
  \n
- unit_quantity
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
- unit_price
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
- unit_name
  \n
  - Optional
    \n
  - Type: string
    \n
  \n
- unit_content
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
- discount_amount
  \n
  - Optional
    \n
  - Type: integer (minimum 1)
    \n
  \n
- discount_percentage
  \n
  - Optional
    \n
  - Type: number (0–100)
    \n
  \n
- taxes
  \n
  - Optional
    \n
  - Type: array
    \n
  - Item Properties:
    \n
    - id
      - Required
        \n
      - Type: integer
        \n
      \n
    \n
  \n
\n

`journal_analytic_accounts`

Optional
\n
Type: array
\n
Item Properties:
\n
- id
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
- pivot
  \n
  - Required
    \n
  - Type: object
    \n
  - Item Properties:
    \n
    - percentage
      - Required
        \n
      - Type: integer
        \n
      \n
    \n
  \n
\n

`payments`

Optional
\n
Type: array
\n
Item Properties:
\n
- amount
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
- treasury_id
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
\n

`settlements`

Optional
\n
Type: array
\n
Item Properties:
\n
- amount
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
- journal_account_id
  \n
  - Optional
    \n
  - Type: integer
    \n
  \n
\n

Document template design id (Required)

\n","type":"text/plain"},"key":"document_template_design_id","value":""}],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"836008dc-47cb-48dc-aed1-b7a57ac55ff4"},{"name":"Update","id":"eefe38a6-8afa-41a0-85d8-dc27a5f24e4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"due_date\": \"2025-10-27T11:08:11.492Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/invoices/:id","description":"

Properties

`code`

Optional
\n
Type: string
\n

`status`

Optional
\n
Type: string
\n
Enum: draft, issued
\n

`partner_order_code`

Optional
\n
Type: string
\n

`issue_date`

Optional
\n
Type: string
\n
Format: date-time
\n

`due_date`

Optional
\n
Type: string
\n
Format: date-time
\n

`journal_account_id`

Optional
\n
Type: integer
\n

`discount_amount`

Optional
\n
Type: integer (minimum 1)
\n

`discount_percentage`

Optional
\n
Type: number (0-100)
\n

`notes`

Optional
\n
Type: string
\n

`responsible_user_id`

Optional
\n
Type: integer
\n

`attachments`

Optional
\n
Type: array (max 5)
\n
Item Properties:
\n
- id
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
- secret
  \n
  - Required
    \n
  - Type: string
    \n
  \n
\n

`line_items`

Optional
\n
Type: array
\n
Item Properties:
\n
- product_id
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
- storehouse_id
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
- description
  \n
  - Optional
    \n
  - Type: string
    \n
  \n
- unit_quantity
  \n
  - Required
    \n
  - Type: integer (minimum 1)
    \n
  \n
- unit_price
  \n
  - Required
    \n
  - Type: integer (minimum 1)
    \n
  \n
- unit_name
  \n
  - Optional
    \n
  - Type: string
    \n
  \n
- unit_content
  \n
  - Required
    \n
  - Type: integer (minimum 1)
    \n
  \n
- discount_amount
  \n
  - Optional
    \n
  - Type: integer (minimum 1)
    \n
  \n
- discount_percentage
  \n
  - Optional
    \n
  - Type: number (0-100)
    \n
  \n
- taxes
  \n
  - Optional
    \n
  - Type: array
    \n
  - Item Properties:
    \n
    - id
      \n
      - Required
        \n
      - Type: integer
        \n
      \n
    \n
  \n
\n

`journal_analytic_accounts`

Optional
\n
Type: array
\n
Item Properties:
\n
- id
  \n
  - Required
    \n
  - Type: integer
    \n
  \n
- pivot
  \n
  - Required
    \n
  - Type: object
    \n
  - Item Properties:
    \n
    - percentage
      \n
      - Required
        \n
      - Type: integer
        \n
      \n
    \n
  \n
\n

Return changes since this ISO 8601 date/time checkpoint.

\n","type":"text/plain"},"key":"checkpoint","value":""}],"variable":[]}},"response":[],"_postman_id":"dc6e2a42-7b31-45e9-8e38-24d4086b7c99"},{"name":"Create","id":"99a0b468-0e25-4b99-8c9f-3291462c00d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"sub\",\n \"name\": \"مصروفات الرواتب\",\n \"code\": \"5200\",\n \"parent_id\": 3\n}","options":{"raw":{"language":"json"}}},"url":"/journal-accounts","description":"

Properties

`type`

Required
Type: string
Enum: main, sub

`name`

Required
Type: string
Max length: 255

`code`

Required
Type: string
Max length: 255
Must be unique across journal accounts

`parent_id`

Required
Type: integer
Must reference an existing journal_accounts.id with type main

`journal_analytic_accounts`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing journal_analytic_accounts.id with type sub
  \n
- pivot
  - Required
  - Type: object
  - Item Properties:
    - percentage
      - Required
      - Type: number
      - Range: 0.01 - 100
      \n
    \n
  \n
\n
Constraint: cumulative percentage per top-level analytic account must not exceed 100

`branches`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference a branch accessible to the authenticated user
  \n
\n

Properties

`name`

Optional
Type: string
Max length: 255

`code`

Optional
Type: string
Max length: 255
Must be unique across journal accounts (excluding the current account)

`parent_id`

Optional when the account already has a parent; otherwise prohibited
Type: integer
Must reference an existing journal_accounts.id with type main
Cannot equal the current journal account id

`journal_analytic_accounts`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing journal_analytic_accounts.id with type sub
  \n
- pivot
  - Required
  - Type: object
  - Item Properties:
    - percentage
      - Required
      - Type: number
      - Range: 0.01 - 100
      \n
    \n
  \n
\n
Constraint: cumulative percentage per top-level analytic account must not exceed 100

`branches`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference a branch accessible to the authenticated user
  \n
\n

Properties

`type`

Required
Type: string
Enum: main, sub
Root accounts must use main

`name`

Required
Type: string
Max length: 255

`parent_id`

Required when type is sub
Type: integer
Must reference an existing journal_analytic_accounts.id with type main

Properties

`type`

Required
Type: string
Enum: main, sub
Root accounts must use main

`name`

Required
Type: string
Max length: 255

`parent_id`

Required when type is sub
Type: integer
Must reference an existing journal_analytic_accounts.id with type main

Properties

`name`

Required
Type: string
Max length: 255

`parent_id`

Optional
Type: integer
Must reference an existing journal_analytic_accounts.id with type main
Cannot equal the current analytic account id
Required when the account already belongs to a parent

Filter entries whose code contains this value.

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Search entries whose description contains this text.

\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"

Return entries that reference the given journal_accounts.id in one of their records.

\n","type":"text/plain"},"key":"journal_account_id","value":""},{"disabled":true,"description":{"content":"

Return entries dated on or after this ISO 8601 date.

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Return entries dated on or before this ISO 8601 date.

\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"

Sort field. Allowed values: id, date. Defaults to id.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

Sort direction. Allowed values: asc, desc. Defaults to desc.

\n","type":"text/plain"},"key":"order","value":""},{"disabled":true,"description":{"content":"

Items per page (max 20). Defaults to 20.

\n","type":"text/plain"},"key":"per_page","value":""}],"variable":[]}},"response":[],"_postman_id":"38263942-9983-4f3e-9554-278eccc277f9"},{"name":"Create","id":"e59b8d25-ccf1-47f6-bdf2-dc33c56dbb6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"records\": [\n {\n \"journal_account_id\": 41,\n \"type\": \"debit\",\n \"value\": 3500\n },\n {\n \"journal_account_id\": 18,\n \"type\": \"credit\",\n \"value\": 3500\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/journal-entries","description":"

Properties

`code`

Optional
Type: string
Max length: 255
Must be unique across journal entries

`description`

Optional
Type: string

`date`

Optional
Type: string
Format: date

`records`

Required
Type: array
Item Properties:
- journal_account_id
  - Required
  - Type: integer
  - Must reference an existing journal_accounts.id with type sub
  - Must belong to a branch accessible to the authenticated user
  \n
- type
  - Required
  - Type: string
  - Enum: debit, credit
  \n
- value
  - Required
  - Type: integer
  - Minimum: 1
  \n
- description
  - Optional
  - Type: string
  \n
- journal_analytic_accounts
  - Optional
  - Type: array
  - Item Properties:
    - id
      - Required
      - Type: integer
      - Must reference an existing journal_analytic_accounts.id with type sub
      \n
    - pivot
      - Required
      - Type: object
      - Item Properties:
        \n
        percentage
        \n
        Required
        \n
        Type: number
        \n
        Range: 0.01 - 100
        \n
        \n
        \n
        \n
      \n
    \n
  \n
\n
Constraint: the total percentage per top-level analytic account must not exceed 100

`attachments`

Optional
Type: array
Max items: 5
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Required
  - Type: string
  \n
\n

Properties

`code`

Optional
Type: string
Max length: 255
Must be unique across journal entries (excluding the current entry)

`description`

Optional
Type: string

`date`

Optional
Type: string
Format: date

`records`

Optional
Type: array
Item Properties:
- journal_account_id
  - Required
  - Type: integer
  - Must reference an existing journal_accounts.id with type sub
  - Must belong to the branch associated with the journal entry
  \n
- type
  - Required
  - Type: string
  - Enum: debit, credit
  \n
- value
  - Required
  - Type: integer
  - Minimum: 1
  \n
- description
  - Optional
  - Type: string
  \n
- journal_analytic_accounts
  - Optional
  - Type: array
  - Item Properties:
    - id
      - Required
      - Type: integer
      - Must reference an existing journal_analytic_accounts.id with type sub
      \n
    - pivot
      - Required
      - Type: object
      - Item Properties:
        \n
        percentage
        \n
        Required
        \n
        Type: number
        \n
        Range: 0.01 - 100
        \n
        \n
        \n
        \n
      \n
    \n
  \n
\n
Constraint: the total percentage per top-level analytic account must not exceed 100

`attachments`

Optional
Type: array
Max items: 5
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Required
  - Type: string
  \n
\n

Filter by requisition identifier.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Return requisitions targeting the given treasuries.id.

\n","type":"text/plain"},"key":"treasury_id","value":""},{"disabled":true,"description":{"content":"

Set to 1 or 0 to filter by conflict flag.

\n","type":"text/plain"},"key":"has_conflict","value":""},{"disabled":true,"description":{"content":"

Return requisitions created on or after this ISO 8601 date.

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Return requisitions created on or before this ISO 8601 date.

\n","type":"text/plain"},"key":"end_date","value":""}],"variable":[]}},"response":[],"_postman_id":"0d0bdc40-5917-403b-ba25-47b3470f52a5"},{"name":"View","id":"ae816df8-c728-426e-8b77-6f76f74be682","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/money-movement-requisitions/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["money-movement-requisitions",":id"],"host":[""],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"ae816df8-c728-426e-8b77-6f76f74be682"},{"name":"Update","id":"d9fe4396-1558-4e6a-95b9-964f7cb0f7e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"notes\": \"الموافقة بعد مراجعة المدير المالي\"\n}","options":{"raw":{"language":"json"}}},"url":"/money-movement-requisitions/:id","description":"

Properties

`approved_amount`

Optional
Type: integer

`has_conflict`

Optional
Type: integer
Allowed values: 0, 1

`notes`

Optional
Type: string
Max length: 255

`records`

Optional
Type: array
Item Properties:
- id
  - Optional
  - Type: integer
  \n
- product_id
  - Required
  - Type: integer
  - Must reference an existing products.id
  \n
- approved_unit_quantity
  - Required
  - Type: integer
  - Minimum: 0
  \n
- unit_content
  - Required
  - Type: integer
  - Minimum: 1
  \n
\n

Filter by money movement code (partial match).

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Filter by money movement type. Allowed values: incoming, outgoing.

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Search movements whose description contains this text.

\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"

Return movements recorded against the given treasuries.id.

\n","type":"text/plain"},"key":"treasury_id","value":""},{"disabled":true,"description":{"content":"

Return movements dated on or after this ISO 8601 date.

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Return movements dated on or before this ISO 8601 date.

\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"

Set to null (string) to return only manual movements. Other values are reserved.

\n","type":"text/plain"},"key":"source_type","value":""},{"disabled":true,"description":{"content":"

Sort field. Allowed values: id, date. Defaults to id.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

Sort direction. Allowed values: asc, desc. Defaults to desc.

\n","type":"text/plain"},"key":"order","value":""}],"variable":[]}},"response":[],"_postman_id":"49f3a535-3363-4a8d-9b2b-5b82ff96fb07"},{"name":"Create","id":"21165620-810f-4599-9ba0-2495ab796b4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"incoming\",\n \"treasury_id\": 4,\n \"requested_amount\": 12500,\n \"date\": \"2024-09-05\"\n}","options":{"raw":{"language":"json"}}},"url":"/money-movements","description":"

Properties

`code`

Optional
Type: string
Max length: 255
Must be unique across money movements

`type`

Required
Type: string
Enum: incoming, outgoing

`treasury_id`

Required
Type: integer
Must reference an existing treasuries.id

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id
Must belong to a branch accessible to the authenticated user

`requested_amount`

Required
Type: integer

`description`

Optional
Type: string

`date`

Required
Type: string
Format: date

`attachments`

Optional
Type: array
Max items: 5
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Required
  - Type: string
  \n
\n

`taxes`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing taxes.id
  \n
\n

`journal_analytic_accounts`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing journal_analytic_accounts.id with type sub
  \n
- pivot
  - Required
  - Type: object
  - Item Properties:
    - percentage
      - Required
      - Type: number
      - Range: 0.01 - 100
      \n
    \n
  \n
\n
Constraint: the total percentage per top-level analytic account must not exceed 100

Properties

`code`

Optional
Type: string
Max length: 255
Must be unique across money movements (excluding the current movement)

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id
Must belong to the branch associated with this movement

`requested_amount`

Required
Type: integer

`description`

Optional
Type: string

`date`

Optional
Type: string
Format: date

`attachments`

Optional
Type: array
Max items: 5
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Required
  - Type: string
  \n
\n

`taxes`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing taxes.id
  \n
\n

`journal_analytic_accounts`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing journal_analytic_accounts.id with type sub
  \n
- pivot
  - Required
  - Type: object
  - Item Properties:
    - percentage
      - Required
      - Type: number
      - Range: 0.01 - 100
      \n
    \n
  \n
\n
Constraint: the total percentage per top-level analytic account must not exceed 100

Filter by underlying money movement or transfer code (partial match).

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Search transactions whose source description contains this text.

\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"

Return transactions involving the given treasuries.id (as source or destination).

\n","type":"text/plain"},"key":"treasury_id","value":""},{"disabled":true,"description":{"content":"

Return transactions dated on or after this ISO 8601 date.

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Return transactions dated on or before this ISO 8601 date.

\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"

Filter by calculation status of the underlying record. Allowed values: pending, partially_processed, processed.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Sort field. Allowed values: id, date. Defaults to id.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

Sort direction. Allowed values: asc, desc. Defaults to desc.

\n","type":"text/plain"},"key":"order","value":""}],"variable":[]}},"response":[],"_postman_id":"b3d13409-65c6-4770-9b02-f1e9e9ee510d"},{"name":"View","id":"239db74d-6d54-4222-a9fd-a9f5d83a97ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/money-transactions/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["money-transactions",":id"],"host":[""],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"239db74d-6d54-4222-a9fd-a9f5d83a97ec"}],"id":"0a27d05e-5c83-47c9-82ee-3d5224d48d95","_postman_id":"0a27d05e-5c83-47c9-82ee-3d5224d48d95","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}},{"name":"money-transfers","item":[{"name":"Index","id":"cda5d1db-3403-4508-a234-6cbd39bb6c58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/money-transfers","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["money-transfers"],"host":[""],"query":[{"disabled":true,"description":{"content":"

Filter by money transfer code (partial match).

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Search transfers whose description contains this text.

\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"

Return transfers where the given treasuries.id is either source or destination.

\n","type":"text/plain"},"key":"treasury_id","value":""},{"disabled":true,"description":{"content":"

Return transfers dated on or after this ISO 8601 date.

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Return transfers dated on or before this ISO 8601 date.

\n","type":"text/plain"},"key":"end_date","value":""}],"variable":[]}},"response":[],"_postman_id":"cda5d1db-3403-4508-a234-6cbd39bb6c58"},{"name":"Create","id":"a683c105-bd2b-49ff-ab81-9f55f8e372a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_treasury_id\": 3,\n \"destination_treasury_id\": 6,\n \"requested_amount\": 15000,\n \"date\": \"2024-09-10\",\n \"records\": [\n {\n \"product_id\": 21,\n \"requested_unit_quantity\": 15,\n \"unit_content\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/money-transfers","description":"

Properties

`code`

Optional
Type: string
Max length: 255
Must be unique across money transfers

`source_treasury_id`

Required
Type: integer
Must reference an existing treasuries.id

`destination_treasury_id`

Required
Type: integer
Must reference an existing treasuries.id
Must be different from source_treasury_id

`requested_amount`

Required
Type: integer

`description`

Optional
Type: string

`date`

Required
Type: string
Format: date

`attachments`

Optional
Type: array
Max items: 5
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Required
  - Type: string
  \n
\n

Properties

`code`

Optional
Type: string
Max length: 255
Must be unique across money transfers (excluding the current transfer)

`requested_amount`

Required
Type: integer

`description`

Optional
Type: string

`date`

Optional
Type: string
Format: date

`attachments`

Optional
Type: array
Max items: 5
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Required
  - Type: string
  \n
\n

Properties

`name`

Required
Type: string
Max length: 255

Properties

`name`

Required
Type: string
Max length: 255

Required when partner_id is omitted. Allowed values: supplier, client.

\n","type":"text/plain"},"key":"partner_type","value":""},{"disabled":true,"description":{"content":"

Required when partner_type is omitted. Must reference a partner accessible to the current branch.

\n","type":"text/plain"},"key":"partner_id","value":""},{"disabled":true,"description":{"content":"

Filter by payment identifier.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Return payments linked to the given invoice.

\n","type":"text/plain"},"key":"invoice_id","value":""},{"disabled":true,"description":{"content":"

Filter by payment type. Allowed values: incoming, outgoing.

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Filter by treasury identifier.

\n","type":"text/plain"},"key":"treasury_id","value":""},{"disabled":true,"description":{"content":"

Return payments dated on or after this ISO 8601 date.

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Return payments dated on or before this ISO 8601 date.

\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"

Filter by linked money movement status. Allowed values: pending, partially_processed, processed.

\n","type":"text/plain"},"key":"money_movement_status","value":""},{"disabled":true,"description":{"content":"

Sort field. Allowed values: id, date. Defaults to id.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

Sort direction. Allowed values: asc, desc. Defaults to desc.

\n","type":"text/plain"},"key":"order","value":""},{"disabled":true,"description":{"content":"

Items per page (max 20). Defaults to 20.

\n","type":"text/plain"},"key":"per_page","value":""}],"variable":[]}},"response":[],"_postman_id":"0a313961-f701-49b3-9795-4296d1b86428"},{"name":"Create","id":"f376797e-6ddc-4ce8-92cb-68ec72d1ded6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"partner_id\": 8,\n \"treasury_id\": 4,\n \"type\": \"incoming\",\n \"amount\": 2750,\n \"date\": \"2024-08-20\"\n}","options":{"raw":{"language":"json"}}},"url":"/partner-payments","description":"

Properties

`partner_id`

Required
Type: integer
Must reference a partner accessible to the current branch

`treasury_id`

Required
Type: integer
Must reference an existing treasuries.id

`type`

Required
Type: string
Enum: incoming, outgoing

`amount`

Required
Type: integer
Minimum: 1

`description`

Optional
Type: string

`date`

Required
Type: string
Format: date

`responsible_user_id`

Optional
Type: integer
Must reference an existing users.id
Availability: when the enable_responsible_user setting is enabled

`invoices`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing invoices.id with variant standard and status issued
  \n
- pivot
  - Required
  - Type: object
  - Item Properties:
    - amount
      - Required
      - Type: integer
      - Minimum: 1
      \n
    \n
  \n
\n

Properties

`amount`

Required
Type: integer
Minimum: 1

`description`

Optional
Type: string

`date`

Optional
Type: string
Format: date

`responsible_user_id`

Optional
Type: integer
Must reference an existing users.id
Availability: when the enable_responsible_user setting is enabled

`invoices`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing invoices.id with variant standard and status issued
  \n
- pivot
  - Required
  - Type: object
  - Item Properties:
    - amount
      - Required
      - Type: integer
      - Minimum: 1
      \n
    \n
  \n
\n

Filter by partner type. Allowed values: supplier, client.

\n","type":"text/plain"},"key":"type","value":""},{"disabled":true,"description":{"content":"

Return changes since this ISO 8601 date/time checkpoint.

\n","type":"text/plain"},"key":"checkpoint","value":""}],"variable":[]}},"response":[],"_postman_id":"017d0d7d-54ef-49e3-971b-90c3a5caf5d8"},{"name":"Create","id":"d51ec931-1ddb-41f8-a36b-8640a3222e6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"client\",\n \"name\": \"شركة النخبة للاستشارات\",\n \"nature\": \"company\",\n \"tax_number\": \"399999999900003\",\n \"company_register\": \"123456\",\n \"contacts\": [\n {\n \"phone\": \"+966550000001\",\n \"address_line_1\": \"25 شارع الملك فهد\",\n \"address_line_2\": \"\",\n \"city\": \"الرياض\",\n \"state\": \"\",\n \"district\": \"النخيل\",\n \"country\": \"SA\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/partners","description":"

Properties

`type`

Required
Type: string
Enum: supplier, client

`code`

Optional
Type: string
Max length: 255

`name`

Required
Type: string
Max length: 255

`nature`

Required
Type: string
Enum: individual, company

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id of type sub
Availability: when the allow_journal_account_change setting is enabled

`tax_number`

Optional
Type: string
Max length: 255

`company_register`

Optional
Type: string
Max length: 255

`notes`

Optional
Type: string

`responsible_user_id`

Optional
Type: integer
Must reference an existing users.id
Availability: when the enable_responsible_user setting is enabled

`contacts`

Optional
Type: array
Item Properties:
- name
  - Optional
  - Type: string
  - Max length: 255
  \n
- email
  - Optional
  - Type: string
  - Format: email
  - Max length: 255
  \n
- phone
  - Optional
  - Type: string
  - Max length: 255
  \n
- mobile
  - Optional
  - Type: string
  - Max length: 255
  \n
- address_line_1
  - Optional
  - Type: string
  - Max length: 255
  \n
- address_line_2
  - Optional
  - Type: string
  - Max length: 255
  \n
- district
  - Optional
  - Type: string
  - Max length: 255
  \n
- city
  - Optional
  - Type: string
  - Max length: 255
  \n
- state
  - Optional
  - Type: string
  - Max length: 255
  \n
- postal_code
  - Optional
  - Type: string
  - Max length: 255
  \n
- country
  - Optional
  - Type: string
  - Length: 2 (ISO 3166-1 alpha-2)
  - Must be uppercase
  \n
\n

`initial_balance`

Optional
Type: integer

Properties

`code`

Optional
Type: string
Max length: 255
Unique within the same partner type

`name`

Optional
Type: string
Max length: 255

`nature`

Optional
Type: string
Enum: individual, company

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id of type sub
Availability: when the allow_journal_account_change setting is enabled

`tax_number`

Optional
Type: string
Max length: 255

`company_register`

Optional
Type: string
Max length: 255

`notes`

Optional
Type: string

`responsible_user_id`

Optional
Type: integer
Must reference an existing users.id
Availability: when the enable_responsible_user setting is enabled

`contacts`

Optional
Type: array
Item Properties:
- id
  - Optional
  - Type: integer
  \n
- partner_id
  - Optional
  - Type: integer
  \n
- name
  - Optional
  - Type: string
  - Max length: 255
  \n
- email
  - Optional
  - Type: string
  - Format: email
  - Max length: 255
  \n
- phone
  - Optional
  - Type: string
  - Max length: 255
  \n
- mobile
  - Optional
  - Type: string
  - Max length: 255
  \n
- address_line_1
  - Optional
  - Type: string
  - Max length: 255
  \n
- address_line_2
  - Optional
  - Type: string
  - Max length: 255
  \n
- district
  - Optional
  - Type: string
  - Max length: 255
  \n
- city
  - Optional
  - Type: string
  - Max length: 255
  \n
- state
  - Optional
  - Type: string
  - Max length: 255
  \n
- postal_code
  - Optional
  - Type: string
  - Max length: 255
  \n
- country
  - Optional
  - Type: string
  - Length: 2 (ISO 3166-1 alpha-2)
  - Must be uppercase
  \n
\n

Return changes since this ISO 8601 date/time checkpoint.

\n","type":"text/plain"},"key":"checkpoint","value":""}],"variable":[]}},"response":[],"_postman_id":"bc018735-33ea-4adc-9fd5-7ac8562167a4"},{"name":"Create","id":"840b98f8-ba09-46cc-a322-22eed600b0f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"معدات المطابخ\"\n}","options":{"raw":{"language":"json"}}},"url":"/product-categories","description":"

Properties

`name`

Required
Type: string
Max length: 255

`description`

Optional
Type: string

`parent_id`

Optional
Type: integer
Must reference an existing product_categories.id (cannot create cycles)

Properties

`name`

Optional
Type: string
Max length: 255

`description`

Optional
Type: string

`parent_id`

Optional
Type: integer
Must reference an existing product_categories.id
Cannot equal the current category id

Return changes since this ISO 8601 date/time checkpoint.

\n","type":"text/plain"},"key":"checkpoint","value":""}],"variable":[]}},"response":[],"_postman_id":"158ed7f9-771a-46b5-89b4-17470829dc3c"},{"name":"Create","id":"2cfe44f9-5e8b-490d-9858-7cb882492ecc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"قلم رصاص\",\n \"supports_inventory\": 1,\n \"units\": [\n {\n \"content\": 1,\n \"purchase_price\": 100,\n \"sale_price\": 200\n }\n ],\n \"taxes\": [\n {\n \"id\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/products","description":"

Properties

`code`

Optional
Type: string
Max length: 255
Unique across products

`name`

Required
Type: string
Max length: 255

`description`

Optional
Type: string

`supports_inventory`

Required
Type: integer
Enum: 0, 1
Use 1 to track inventory quantities

`low_inventory_quantity`

Optional
Type: integer
Minimum: 0

`product_category_id`

Optional
Type: integer
Must reference an existing product_categories.id

`units`

Required
Type: array
Item Properties:
- name
  - Optional
  - Type: string
  - Max length: 255
  \n
- content
  - Required
  - Type: integer
  - Minimum: 1
  \n
- purchase_price
  - Required when supports_inventory is 1
  - Type: integer
  - Minimum: 1
  \n
- sale_price
  - Required when supports_inventory is 1
  - Type: integer
  - Minimum: 1
  \n
- lowest_sale_price
  - Optional
  - Type: integer
  - Minimum: 1
  \n
- barcodes
  - Optional
  - Type: array
  - Item Properties:
    - value
      - Required
      - Type: string
      - Max length: 255
      \n
    \n
  \n
\n

`image`

Optional
Type: object
Item Properties:
- id
  - Optional
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Optional
  - Type: string
  \n
\n

`taxes`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing taxes.id
  \n
\n

`initial_inventory`

Optional
Type: array
Availability: only when supports_inventory is 1
Item Properties:
- storehouse_id
  - Required
  - Type: integer
  - Must reference an existing storehouses.id
  - Each entry must be distinct
  \n
- unit_quantity
  - Required
  - Type: integer
  - Minimum: 1
  \n
- unit_content
  - Required
  - Type: integer
  - Minimum: 1
  \n
\n

Properties

`code`

Optional
Type: string
Max length: 255
Must be unique across products (excluding the current product)

`name`

Optional
Type: string
Max length: 255

`description`

Optional
Type: string

`low_inventory_quantity`

Optional
Type: integer
Minimum: 0

`product_category_id`

Optional
Type: integer
Must reference an existing product_categories.id

`units`

Optional
Type: array
Item Properties:
- id
  - Optional
  - Type: integer
  \n
- product_id
  - Optional
  - Type: integer
  \n
- name
  - Optional
  - Type: string
  - Max length: 255
  \n
- content
  - Required
  - Type: integer
  - Minimum: 1
  \n
- purchase_price
  - Required when supports_inventory is 1
  - Type: integer
  - Minimum: 1
  \n
- sale_price
  - Required when supports_inventory is 1
  - Type: integer
  - Minimum: 1
  \n
- lowest_sale_price
  - Optional
  - Type: integer
  - Minimum: 1
  \n
- barcodes
  - Optional
  - Type: array
  - Item Properties:
    - id
      - Optional
      - Type: integer
      \n
    - unit_id
      - Optional
      - Type: integer
      \n
    - value
      - Required
      - Type: string
      - Max length: 255
      \n
    \n
  \n
\n

`image`

Optional
Type: object
Item Properties:
- id
  - Optional
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Optional
  - Type: string
  \n
\n

`taxes`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing taxes.id
  \n
\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["products",":id"],"host":[""],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"d00707dd-a4b3-4526-a9ef-6be22028f345"},{"name":"Delete","id":"58125c24-15ff-4667-883b-9ad165351234","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/products/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["products",":id"],"host":[""],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"58125c24-15ff-4667-883b-9ad165351234"}],"id":"6125825c-e8e6-41a3-90fa-b995a7428872","_postman_id":"6125825c-e8e6-41a3-90fa-b995a7428872","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}},{"name":"reports","item":[{"name":"accounting","item":[{"name":"tax","item":[{"name":"detailed","id":"b8f5dc06-da76-4b64-ad18-d0951654f8d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/accounting/tax/detailed","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","accounting","tax","detailed"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b8f5dc06-da76-4b64-ad18-d0951654f8d0"},{"name":"summary","id":"ee0cba9d-fd4b-4f2a-b3d3-24680d8498f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/accounting/tax/summary","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","accounting","tax","summary"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"ee0cba9d-fd4b-4f2a-b3d3-24680d8498f6"}],"id":"e041e14f-ffeb-4502-bcde-ab8d233c9f70","_postman_id":"e041e14f-ffeb-4502-bcde-ab8d233c9f70","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}},{"name":"balance-sheet","id":"2628fbb2-667d-47d4-bd6f-edd21f69a39f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/accounting/balance-sheet","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","accounting","balance-sheet"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"2628fbb2-667d-47d4-bd6f-edd21f69a39f"},{"name":"general-ledger","id":"41a10524-0c91-4aa3-8171-546af7ad432a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/accounting/general-ledger","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","accounting","general-ledger"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"41a10524-0c91-4aa3-8171-546af7ad432a"},{"name":"income-statement","id":"ae29df5f-8ded-46ab-a7a9-4d04665f75e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/accounting/income-statement","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","accounting","income-statement"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"ae29df5f-8ded-46ab-a7a9-4d04665f75e9"},{"name":"journal-analytic-account","id":"2225ac37-4ec0-4e2b-b37e-e566b4c9bca6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/accounting/journal-analytic-account","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","accounting","journal-analytic-account"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"2225ac37-4ec0-4e2b-b37e-e566b4c9bca6"},{"name":"trial-balance","id":"d8d798a9-6ff5-47fb-a4c9-ed199043cfa0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/accounting/trial-balance","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","accounting","trial-balance"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"d8d798a9-6ff5-47fb-a4c9-ed199043cfa0"}],"id":"cf45ae58-5beb-42af-9a24-a717fe7780f3","_postman_id":"cf45ae58-5beb-42af-9a24-a717fe7780f3","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}},{"name":"gross-profit","item":[{"name":"detailed","id":"d63889c8-8d6f-484a-89bd-81ab79a18806","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/gross-profit/detailed","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","gross-profit","detailed"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"d63889c8-8d6f-484a-89bd-81ab79a18806"},{"name":"summary","id":"8f2d4fee-f58c-45f3-ab7b-ce623d14e8b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/gross-profit/summary","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","gross-profit","summary"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"8f2d4fee-f58c-45f3-ab7b-ce623d14e8b8"}],"id":"d3d937b8-d226-4325-82a7-48cab3062258","_postman_id":"d3d937b8-d226-4325-82a7-48cab3062258","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}},{"name":"inventory","item":[{"name":"inventory-value","item":[{"name":"detailed","id":"9b334f68-8462-4613-ada5-ecf06be2d780","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/inventory/inventory-value/detailed","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","inventory","inventory-value","detailed"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"9b334f68-8462-4613-ada5-ecf06be2d780"},{"name":"summary","id":"1ad41e41-bdac-4225-899a-a2bfb28fb312","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/inventory/inventory-value/summary","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","inventory","inventory-value","summary"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"1ad41e41-bdac-4225-899a-a2bfb28fb312"}],"id":"bc44c0d5-8401-4517-9f66-a63ed62fc0fb","_postman_id":"bc44c0d5-8401-4517-9f66-a63ed62fc0fb","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}}],"id":"ae48058d-f414-42bb-a9c2-3d6cab60e3b7","_postman_id":"ae48058d-f414-42bb-a9c2-3d6cab60e3b7","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}},{"name":"invoice","item":[{"name":"detailed","id":"dbc5ebad-1293-44ef-82a7-e0539eaf8438","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/invoice/detailed","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","invoice","detailed"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"dbc5ebad-1293-44ef-82a7-e0539eaf8438"},{"name":"summary","id":"1236190f-fa6d-4097-ae96-444b766902a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/invoice/summary","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","invoice","summary"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"1236190f-fa6d-4097-ae96-444b766902a7"}],"id":"ebe67cf3-efdb-4f0b-903f-429fdc0a58b5","_postman_id":"ebe67cf3-efdb-4f0b-903f-429fdc0a58b5","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}},{"name":"partner","item":[{"name":"aged-balance","id":"0654c4d5-7e99-47b1-a890-a8f1758c504d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/partner/aged-balance","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","partner","aged-balance"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"0654c4d5-7e99-47b1-a890-a8f1758c504d"}],"id":"e7fe0c6d-56f7-4a6c-9600-2ecf62df2c95","_postman_id":"e7fe0c6d-56f7-4a6c-9600-2ecf62df2c95","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}},{"name":"partner-payment","item":[{"name":"detailed","id":"b861efb8-eb21-4e08-82e2-f341667bb633","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/partner-payment/detailed","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","partner-payment","detailed"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b861efb8-eb21-4e08-82e2-f341667bb633"},{"name":"summary","id":"2fbbc5c3-42d0-41fa-b436-4421dc3d8a8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/reports/partner-payment/summary","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["reports","partner-payment","summary"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"2fbbc5c3-42d0-41fa-b436-4421dc3d8a8d"}],"id":"bd8bed3a-b7ad-427b-bcf6-f8d7207a256d","_postman_id":"bd8bed3a-b7ad-427b-bcf6-f8d7207a256d","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}}],"id":"e4a16fcb-c6f9-4754-b8df-abd990b5a2bd","_postman_id":"e4a16fcb-c6f9-4754-b8df-abd990b5a2bd","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}},{"name":"roles","item":[{"name":"Index","id":"756bae10-0d5d-44ff-8edf-d63b307d6f84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/roles","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["roles"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"756bae10-0d5d-44ff-8edf-d63b307d6f84"},{"name":"Create","id":"7ed47d77-4b73-4e45-8f96-6258f720a019","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"مدير المبيعات\",\n \"permissions\": [\n {\n \"name\": \"invoices.manage\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/roles","description":"

Properties

`name`

Required
Type: string
Max length: 255
Must be unique across roles

`permissions`

Required
Type: array
Item Properties:
- name
  - Required
  - Type: string
  - Must be one of the enumerated permission identifiers
  \n
\n

Properties

`name`

Optional
Type: string
Max length: 255
Must be unique across roles (excluding the current role)

`permissions`

Optional
Type: array
Item Properties:
- id
  - Optional
  - Type: integer
  - Existing permission pivot identifier (include when updating existing assignments)
  \n
- name
  - Required
  - Type: string
  - Must be one of the enumerated permission identifiers
  \n
\n

Filter by setting name. Requires administrator privileges.

\n","type":"text/plain"},"key":"name","value":""},{"disabled":true,"description":{"content":"

Controls whether the name filter is an exact match. Allowed values: true, false. Defaults to true.

\n","type":"text/plain"},"key":"exact","value":""},{"disabled":true,"description":{"content":"

When filtering by name, narrow results to the current branch (branch), partner list (partner_list), or business (business).

\n","type":"text/plain"},"key":"owner_type","value":""},{"disabled":true,"description":{"content":"

Override the default owner ID for the given owner_type (e.g. a specific branch, partner list, or business ID).

\n","type":"text/plain"},"key":"owner_id","value":""}],"variable":[]}},"response":[],"_postman_id":"9f79ef6a-3fc1-4ff7-906b-9d6572dfbde1"},{"name":"View","id":"94bc974d-f9e3-4b3c-ae7e-e413d5a26fa7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/settings/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["settings",":id"],"host":[""],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"94bc974d-f9e3-4b3c-ae7e-e413d5a26fa7"},{"name":"Update","id":"313f8a1d-a2d0-4414-8df3-2d67907198f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"value\": true\n}","options":{"raw":{"language":"json"}}},"url":"/settings/:id","description":"

Properties

`value`

Required
Type: varies by setting
Provide the new configuration payload. The expected structure depends on the setting name and must satisfy the server-side validation for that setting.

`files`

Optional
Type: array
Used only for settings that accept file attachments (for example, the company logo)
Item Properties:
- id
  - Optional
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Optional
  - Type: string
  \n
\n

Filter by requisition identifier.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Return requisitions for the given storehouses.id.

\n","type":"text/plain"},"key":"storehouse_id","value":""},{"disabled":true,"description":{"content":"

Set to 1 or 0 to filter by conflict flag.

\n","type":"text/plain"},"key":"has_conflict","value":""},{"disabled":true,"description":{"content":"

Return requisitions created on or after this ISO 8601 date.

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Return requisitions created on or before this ISO 8601 date.

\n","type":"text/plain"},"key":"end_date","value":""}],"variable":[]}},"response":[],"_postman_id":"f6842f9c-91c1-4f2c-9adf-bfae8acd9b4e"},{"name":"View","id":"eba22fcc-2110-409b-ac79-4226e97a7b61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/stock-movement-requisitions/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["stock-movement-requisitions",":id"],"host":[""],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"eba22fcc-2110-409b-ac79-4226e97a7b61"},{"name":"Update","id":"485a7ce3-fab6-45ba-9cdc-3646746311bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"notes\": \"يرجى التأكيد على الجرد قبل الشحن\"\n}","options":{"raw":{"language":"json"}}},"url":"/stock-movement-requisitions/:id","description":"

Properties

`has_conflict`

Optional
Type: integer
Allowed values: 0, 1

`notes`

Optional
Type: string
Max length: 255

`records`

Optional
Type: array
Item Properties:
- id
  - Optional
  - Type: integer
  \n
- product_id
  - Required
  - Type: integer
  - Must reference an existing products.id
  \n
- approved_unit_quantity
  - Required
  - Type: integer
  - Minimum: 0
  \n
- unit_content
  - Required
  - Type: integer
  - Minimum: 1
  \n
\n

Filter by stock movement code (partial match).

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Search stock movements whose description contains this text.

\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"

Return movements recorded for the given storehouse.

\n","type":"text/plain"},"key":"storehouse_id","value":""},{"disabled":true,"description":{"content":"

Return movements dated on or after this ISO 8601 date.

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Return movements dated on or before this ISO 8601 date.

\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"

Filter by source document type. Allowed values: invoice.

\n","type":"text/plain"},"key":"source_type","value":""},{"disabled":true,"description":{"content":"

Filter by source document identifier (requires source_type).

\n","type":"text/plain"},"key":"source_id","value":""},{"disabled":true,"description":{"content":"

Sort field. Allowed values: id, date. Defaults to id.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

Sort direction. Allowed values: asc, desc. Defaults to desc.

\n","type":"text/plain"},"key":"order","value":""}],"variable":[]}},"response":[],"_postman_id":"25e38ab9-68a6-4f7d-8955-e788e2c8013b"},{"name":"Create","id":"3c2ab0de-583b-4879-ab54-0759067fc16a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"incoming\",\n \"storehouse_id\": 5,\n \"date\": \"2024-09-12\",\n \"records\": [\n {\n \"product_id\": 21,\n \"requested_unit_quantity\": 40,\n \"unit_price\": 85,\n \"unit_content\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/stock-movements","description":"

Properties

`code`

Optional
Type: string
Max length: 255
Must be unique across stock movements

`type`

Required
Type: string
Enum: incoming, outgoing

`storehouse_id`

Required
Type: integer
Must reference an existing storehouses.id

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub and belong to the current branch

`description`

Optional
Type: string

`date`

Required
Type: string
Format: date

`records`

Required
Type: array
Item Properties:
- product_id
  - Required
  - Type: integer
  - Must reference an existing inventory-supported products.id
  \n
- requested_unit_quantity
  - Required
  - Type: integer
  - Minimum: 1
  \n
- unit_price
  - Required when type is incoming
  - Prohibited when type is outgoing
  - Type: integer
  - Minimum: 1
  \n
- unit_name
  - Optional
  - Type: string
  - Max length: 255
  \n
- unit_content
  - Required
  - Type: integer
  - Minimum: 1
  \n
\n

`attachments`

Optional
Type: array
Max items: 5
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Required
  - Type: string
  \n
\n

Properties

`code`

Optional
Type: string
Max length: 255
Must be unique across stock movements (excluding the current movement)

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub and belong to the current branch

`description`

Optional
Type: string

`date`

Optional
Type: string
Format: date

`records`

Required
Type: array
Item Properties:
- product_id
  - Required
  - Type: integer
  - Must reference an existing inventory-supported products.id
  \n
- requested_unit_quantity
  - Required
  - Type: integer
  - Minimum: 1
  \n
- unit_price
  - Required when the movement type is incoming
  - Prohibited when the movement type is outgoing
  - Type: integer
  - Minimum: 1
  \n
- unit_name
  - Optional
  - Type: string
  - Max length: 255
  \n
- unit_content
  - Required
  - Type: integer
  - Minimum: 1
  \n
\n

`attachments`

Optional
Type: array
Max items: 5
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Required
  - Type: string
  \n
\n

Filter by stock take identifier.

\n","type":"text/plain"},"key":"id","value":""},{"disabled":true,"description":{"content":"

Search stock takes whose description contains this text.

\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"

Return stock takes recorded for the given storehouse.

\n","type":"text/plain"},"key":"storehouse_id","value":""}],"variable":[]}},"response":[],"_postman_id":"be845335-7a02-48a2-91ec-61e35d037c28"},{"name":"Create","id":"f93afd47-4504-4653-928d-30e1882e366c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"status\": \"draft\",\n \"storehouse_id\": 5,\n \"date\": \"2024-09-01\"\n}","options":{"raw":{"language":"json"}}},"url":"/stock-takes","description":"

Properties

`status`

Required
Type: string
Enum: draft, issued

`storehouse_id`

Required
Type: integer
Must reference an existing storehouses.id

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub and belong to the current branch

`description`

Optional
Type: string

`date`

Required
Type: string
Format: date

`records`

Optional
Type: array
Item Properties:
- product_id
  - Required
  - Type: integer
  - Must reference an existing inventory-supported products.id
  \n
- application_quantity
  - Required
  - Type: integer
  \n
- physical_quantity
  - Required when status is issued
  - Type: integer
  \n
\n

Properties

`status`

Optional
Type: string
Enum: draft, issued

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub and belong to the current branch

`description`

Optional
Type: string

`date`

Optional
Type: string
Format: date

`records`

Optional
Type: array
Item Properties:
- product_id
  - Required
  - Type: integer
  - Must reference an existing inventory-supported products.id
  \n
- application_quantity
  - Required
  - Type: integer
  \n
- physical_quantity
  - Required when the request sets status to issued
  - Type: integer or null
  \n
\n

Filter by stock movement or transfer code (partial match).

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Search transactions whose source description contains this text.

\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"

Return transactions involving the given storehouse.

\n","type":"text/plain"},"key":"storehouse_id","value":""},{"disabled":true,"description":{"content":"

Return transactions that include the given product.

\n","type":"text/plain"},"key":"product_id","value":""},{"disabled":true,"description":{"content":"

Return transactions dated on or after this ISO 8601 date.

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Return transactions dated on or before this ISO 8601 date.

\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"description":{"content":"

Filter by calculation status of the underlying record. Allowed values: pending, partially_processed, processed.

\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"description":{"content":"

Sort field. Allowed values: id, date. Defaults to id.

\n","type":"text/plain"},"key":"order_by","value":""},{"disabled":true,"description":{"content":"

Sort direction. Allowed values: asc, desc. Defaults to desc.

\n","type":"text/plain"},"key":"order","value":""}],"variable":[]}},"response":[],"_postman_id":"302214c0-c096-4da0-8e3b-85c1b7cefa4a"},{"name":"View","id":"c29a0b76-e9a0-4142-869b-a0659621dc4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/stock-transactions/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["stock-transactions",":id"],"host":[""],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[],"_postman_id":"c29a0b76-e9a0-4142-869b-a0659621dc4b"}],"id":"84e6579f-36cb-413d-a1c6-415f63e48c0d","_postman_id":"84e6579f-36cb-413d-a1c6-415f63e48c0d","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}}},{"name":"stock-transfers","item":[{"name":"Index","id":"78f7f897-4407-4c6c-bf55-07c7b2cd1150","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/stock-transfers","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","id":"76d4c653-bf9e-4547-8eb9-086b04cf7a27","name":"alostaz.io","type":"collection"}},"urlObject":{"path":["stock-transfers"],"host":[""],"query":[{"disabled":true,"description":{"content":"

Filter by stock transfer code (partial match).

\n","type":"text/plain"},"key":"code","value":""},{"disabled":true,"description":{"content":"

Search stock transfers whose description contains this text.

\n","type":"text/plain"},"key":"description","value":""},{"disabled":true,"description":{"content":"

Return transfers where the storehouse is either the source or destination.

\n","type":"text/plain"},"key":"storehouse_id","value":""},{"disabled":true,"description":{"content":"

Return transfers dated on or after this ISO 8601 date.

\n","type":"text/plain"},"key":"start_date","value":""},{"disabled":true,"description":{"content":"

Return transfers dated on or before this ISO 8601 date.

\n","type":"text/plain"},"key":"end_date","value":""}],"variable":[]}},"response":[],"_postman_id":"78f7f897-4407-4c6c-bf55-07c7b2cd1150"},{"name":"Create","id":"9db768ed-d6e2-44b3-a210-812797e2b85d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"source_storehouse_id\": 2,\n \"destination_storehouse_id\": 5,\n \"date\": \"2024-09-18\",\n \"records\": [\n {\n \"product_id\": 21,\n \"requested_unit_quantity\": 12,\n \"unit_content\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/stock-transfers","description":"

Properties

`code`

Optional
Type: string
Max length: 255
Must be unique across stock transfers

`source_storehouse_id`

Required
Type: integer
Must reference an existing storehouses.id

`destination_storehouse_id`

Required
Type: integer
Must reference an existing storehouses.id
Must differ from source_storehouse_id

`description`

Optional
Type: string

`date`

Required
Type: string
Format: date

`records`

Required
Type: array
Item Properties:
- product_id
  - Required
  - Type: integer
  - Must reference an existing inventory-supported products.id
  \n
- requested_unit_quantity
  - Required
  - Type: integer
  - Minimum: 1
  \n
- unit_content
  - Required
  - Type: integer
  - Minimum: 1
  \n
- unit_name
  - Optional
  - Type: string
  - Max length: 255
  \n
\n

`attachments`

Optional
Type: array
Max items: 5
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Required
  - Type: string
  \n
\n

Properties

`code`

Optional
Type: string
Max length: 255
Must be unique across stock transfers (excluding the current transfer)

`description`

Optional
Type: string

`date`

Optional
Type: string
Format: date

`records`

Required
Type: array
Item Properties:
- product_id
  - Required
  - Type: integer
  - Must reference an existing inventory-supported products.id
  \n
- requested_unit_quantity
  - Required
  - Type: integer
  - Minimum: 1
  \n
- unit_content
  - Required
  - Type: integer
  - Minimum: 1
  \n
- unit_name
  - Optional
  - Type: string
  - Max length: 255
  \n
\n

`attachments`

Optional
Type: array
Max items: 5
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing stored_files.id
  \n
- secret
  - Required
  - Type: string
  \n
\n

Properties

`file`

Required
Type: file
Allowed MIME types: png, jpg, txt, pdf, doc, docx, xls, xlsx, ppt, pptx, odt, ods, odp
Maximum size: 16 MB

Properties

`name`

Required
Type: string
Max length: 255

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub

`requires_incoming_requisitions`

Required
Type: integer
Allowed values: 0, 1

`requires_outgoing_requisitions`

Required
Type: integer
Allowed values: 0, 1

`branches`

Optional
Type: array
Item Properties:
- id
  - Optional
  - Type: integer
  - Must reference an existing branches.id
  \n
\n

`users`

Optional
Type: array
Item Properties:
- id
  - Optional
  - Type: integer
  - Must reference an existing users.id
  \n
\n

`custodians`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing users.id
  \n
\n

Properties

`name`

Required
Type: string
Max length: 255

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub

`requires_incoming_requisitions`

Optional
Type: integer
Allowed values: 0, 1

`requires_outgoing_requisitions`

Optional
Type: integer
Allowed values: 0, 1

`branches`

Optional
Type: array
Item Properties:
- id
  - Optional
  - Type: integer
  - Must reference an existing branches.id
  \n
\n

`users`

Optional
Type: array
Item Properties:
- id
  - Optional
  - Type: integer
  - Must reference an existing users.id
  \n
\n

`custodians`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing users.id
  \n
\n

Properties

`name`

Required
Type: string
Max length: 255

`percentage`

Required
Type: number
Minimum: 0

`inclusive`

Required
Type: integer
Allowed values: 0, 1

`paid_journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub

`collected_journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub

Properties

`name`

Optional
Type: string
Max length: 255

`percentage`

Optional
Type: number
Minimum: 0

`inclusive`

Optional
Type: integer
Allowed values: 0, 1

`paid_journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub

`collected_journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub

Filter treasuries by type. Allowed values: safe, bank_account, pos_safe, custody.

\n","type":"text/plain"},"key":"type","value":""}],"variable":[]}},"response":[],"_postman_id":"1580cbe1-be32-41e5-b423-8590122d8f02"},{"name":"Create","id":"8ed8ecf4-e49c-460c-b942-a0473f3e6517","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"خزينة الرياض الرئيسية\",\n \"type\": \"safe\",\n \"requires_incoming_requisitions\": 1,\n \"requires_outgoing_requisitions\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/treasuries","description":"

Properties

`name`

Required
Type: string
Max length: 255

`type`

Required
Type: string
Enum: safe, bank_account, pos_safe, custody

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub

`requires_incoming_requisitions`

Required
Type: integer
Allowed values: 0, 1

`requires_outgoing_requisitions`

Required
Type: integer
Allowed values: 0, 1

`branches`

Optional
Type: array
Item Properties:
- id
  - Optional
  - Type: integer
  - Must reference an existing branches.id
  \n
\n

`users`

Optional
Type: array
Item Properties:
- id
  - Optional
  - Type: integer
  - Must reference an existing users.id
  \n
\n

`custodians`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing users.id
  \n
\n

Properties

`name`

Required
Type: string
Max length: 255

`journal_account_id`

Optional
Type: integer
Must reference an existing journal_accounts.id with type sub

`requires_incoming_requisitions`

Optional
Type: integer
Allowed values: 0, 1

`requires_outgoing_requisitions`

Optional
Type: integer
Allowed values: 0, 1

`branches`

Optional
Type: array
Item Properties:
- id
  - Optional
  - Type: integer
  - Must reference an existing branches.id
  \n
\n

`users`

Optional
Type: array
Item Properties:
- id
  - Optional
  - Type: integer
  - Must reference an existing users.id
  \n
\n

`custodians`

Optional
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing users.id
  \n
\n

Set to 1 to return the lightweight sync payload (id, type, name).

\n","type":"text/plain"},"key":"is_sync","value":""}],"variable":[]}},"response":[],"_postman_id":"b4d06a5c-3bb2-4c68-89c5-3cdf496bd76f"},{"name":"Create","id":"d222ba7c-f4af-4ebc-b810-a5538a6a5618","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"type\": \"user\",\n \"name\": \"أحمد المنصور\",\n \"email\": \"ahmed.almansour@example.com\",\n \"password\": \"\",\n \"role_id\": 2,\n \"branches\": [\n {\n \"id\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/users","description":"

Properties

`type`

Required
Type: string
Enum: user, employee

`name`

Required
Type: string
Max length: 255

When `type` is `user`

email
- Required
- Type: string
- Format: email
- Max length: 255
- Must be unique across users
\n
phone
- Optional
- Type: string
- Max length: 255
\n
password
- Required
- Type: string
- Minimum length: 6
\n
role_id
- Required
- Type: integer
- Must reference an existing roles.id
\n
branches
- Required
- Type: array
- Item Properties:
  - id
    - Required
    - Type: integer
    - Must reference an existing branches.id
    \n
  \n
\n

When `type` is `employee`

No additional fields are required. Email, phone, password, role, and branches are managed automatically.

Properties

`name`

Required
Type: string
Max length: 255

`type`

Required for users and employees
Type: string
Allowed values: user, employee
Owners cannot change their type

`email`

Required when the resulting type is user or the target account is an owner
Type: string
Format: email
Max length: 255
Must be unique across users (excluding the current user)

`phone`

Required when editing an owner
Optional otherwise
Type: string
Max length: 255

`password`

Optional
Type: string
Minimum length: 6

`branches`

Required when the resulting type is user or the target account is an owner
Type: array
Item Properties:
- id
  - Required
  - Type: integer
  - Must reference an existing branches.id
  \n
\n

`role_id`

Required when the resulting type is user
Type: integer
Must reference an existing roles.id

Welcome to the alostaz.io API Documentation

Authentication and Required Headers

Authentication Token

Deprecation Note

Support

Properties

name

register

address_line_1

address_line_2

district

city

state

postal_code

country

partner_list_id

business_id

Properties

name

register

address_line_1

address_line_2

district

city

state

postal_code

country

Properties

name

Properties

name

Properties

name

Properties

name

date

creates_journal_entry

Properties

name

date

creates_journal_entry

Properties

document_template_id

name

settings

logo

left_signature_image, middle_signature_image, right_signature_image

version

branches

Properties

name

settings

logo

left_signature_image, middle_signature_image, right_signature_image

version

branches

Properties

environment

csr_info

csr_info.uid

csr_info.organization_name

csr_info.organization_unit_name

csr_info.registered_address

csr_info.business_category

otps

Properties

invoice_id

document_template_design_id

method

Properties

purpose

file

Properties

invoice_id

journal_account_id

amount

description

date

Properties

journal_account_id

`name`

`register`

`address_line_1`

`address_line_2`

`district`

`city`

`state`

`postal_code`

`country`

`partner_list_id`

`business_id`

`name`

`register`

`address_line_1`

`address_line_2`

`district`

`city`

`state`

`postal_code`

`country`

`name`

`name`

`name`

`name`

`date`

`creates_journal_entry`

`name`

`date`

`creates_journal_entry`

`document_template_id`

`name`

`settings`

`logo`

`left_signature_image`, `middle_signature_image`, `right_signature_image`

`version`

`branches`

`name`

`settings`

`logo`

`left_signature_image`, `middle_signature_image`, `right_signature_image`

`version`

`branches`

`environment`

`csr_info`

`csr_info.uid`

`csr_info.organization_name`

`csr_info.organization_unit_name`

`csr_info.registered_address`

`csr_info.business_category`

`otps`

`invoice_id`

`document_template_design_id`

`method`

`purpose`

`file`

`invoice_id`

`journal_account_id`

`amount`

`description`

`date`

`journal_account_id`

`amount`

`description`

`date`

`parent_id`

`variant`

`nature`

`type`

`status`

`code`

`partner_id`

`partner_order_code`

`issue_date`

`due_date`

`journal_account_id`

`discount_amount`

`discount_percentage`

`notes`

`responsible_user_id`

`attachments`