https://wiki.idempiere.org/w-en/api.php?action=feedcontributions&feedformat=atom&user=HengsiniDempiere en - User contributions [en]2026-09-30T02:38:18ZUser contributionsMediaWiki 1.35.2https://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23877Antigravity.md2026-05-11T11:21:18Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- Add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```json<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"java.configuration.updateBuildConfiguration": "disabled",<br />
"java.configuration.runtimes": [<br />
{<br />
"name": "JavaSE-17",<br />
"path": "/usr/lib/jvm/java-17-temurin-jdk",<br />
"default": true<br />
}<br />
],<br />
"java.project.resourceFilters": [],<br />
"files.eol": "\n",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Replace `"path": "/usr/lib/jvm/java-17-temurin-jdk"` with your JDK17 path. The default JVM configuration is important for test and remote debugging.<br />
- `"java.project.resourceFilters": []` is to stop antigravity adding the following to .project files:<br />
```xml<br />
<filteredResources><br />
<filter><br />
<id>1774448868880</id><br />
<name></name><br />
<type>30</type><br />
<matcher><br />
<id>org.eclipse.core.resources.regexFilterMatcher</id><br />
<arguments>node_modules|\.git|__CREATED_BY_JAVA_LANGUAGE_SERVER__</arguments><br />
</matcher><br />
</filter><br />
</filteredResources><br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```text<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To ignore changes to tracked .project files:<br />
```text<br />
git update-index --skip-worktree **/.project<br />
```<br />
<br />
- To restore tracking of .project files:<br />
```text<br />
git update-index --no-skip-worktree **/.project<br />
```<br />
<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add more source folder to your workspace (File > Add Folder to Workspace...)<br />
- [iDempiere MCP Server](https://github.com/hengsin/idempiere-mcp)<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- It is faster and more reliable to **Reload Target Platform** using **org.idempiere.p2.targetplatform.mirror.target** instead of **org.idempiere.p2.targetplatform.target**.<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
```text<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.<br />
- To debug integration test<br />
- Add the following to `"configurations"` in launch.json:<br />
```json<br />
{<br />
"type": "java",<br />
"request": "attach",<br />
"name": "Attach by Process ID",<br />
"processId": "${command:PickJavaProcess}",<br />
"projectName": "org.adempiere.base"<br />
}<br />
```<br />
- Add `-DdebugPort=5005`, for e.g, `./mvnw --offline integration-test -DskipTests=false -Dtest=EnvTest -DdebugPort=5005`<br />
- With the `-DdebugPort=5005` option, the test will start and "freeze" at 0% with a message like:<br />
`Listening for transport dt_socket at address: 5005`<br />
- At **Run and Debug**, start the **Attach by Process ID** configuration. A dialog will popup for you to select the process that's waiting for connection at port 5005.<br />
- Some useful shortcuts:<br />
- Ctrl+R : Open recent workspaces.<br />
- Ctrl+P : Open recent files.<br />
- Shift+Alt+B : Invoke Incremental or Full Build.<br />
- Antigravity doesn't has build in support for generation of SerialVersionUID. Install the `Code Generator For Java` extension to get that.<br />
- To retain bundles installed using OSGi console or Extension Manager form after restart of the iDempiere server, you need to comments out the `@1\:start` part of the `osgi.bundles=...simpleconfigurator...` line in `config.ini` (inside the `-configuration` folder). Note that this is not needed in a deploy environment as it is to workaround the combine effect of `-dev` (Equinox Development Mode) and `simpleconfigurator`.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23876Antigravity.md2026-05-11T11:20:16Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- Add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```json<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"java.configuration.updateBuildConfiguration": "disabled",<br />
"java.configuration.runtimes": [<br />
{<br />
"name": "JavaSE-17",<br />
"path": "/usr/lib/jvm/java-17-temurin-jdk",<br />
"default": true<br />
}<br />
],<br />
"java.project.resourceFilters": [],<br />
"files.eol": "\n",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Replace `"path": "/usr/lib/jvm/java-17-temurin-jdk"` with your JDK17 path. The default JVM configuration is important for test and remote debugging.<br />
- `"java.project.resourceFilters": []` is to stop antigravity adding the following to .project files:<br />
```xml<br />
<filteredResources><br />
<filter><br />
<id>1774448868880</id><br />
<name></name><br />
<type>30</type><br />
<matcher><br />
<id>org.eclipse.core.resources.regexFilterMatcher</id><br />
<arguments>node_modules|\.git|__CREATED_BY_JAVA_LANGUAGE_SERVER__</arguments><br />
</matcher><br />
</filter><br />
</filteredResources><br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```text<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To ignore changes to tracked .project files:<br />
```text<br />
git update-index --skip-worktree **/.project<br />
```<br />
<br />
- To restore tracking of .project files:<br />
```text<br />
git update-index --no-skip-worktree **/.project<br />
```<br />
<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add more source folder to your workspace (File > Add Folder to Workspace...)<br />
- [iDempiere MCP Server](https://github.com/hengsin/idempiere-mcp)<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- It is faster and more reliable to **Reload Target Platform** using **org.idempiere.p2.targetplatform.mirror.target** instead of **org.idempiere.p2.targetplatform.target**.<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
```text<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.<br />
- To debug integration test<br />
- Add the following to `"configurations"` in launch.json:<br />
```json<br />
{<br />
"type": "java",<br />
"request": "attach",<br />
"name": "Attach by Process ID",<br />
"processId": "${command:PickJavaProcess}",<br />
"projectName": "org.adempiere.base"<br />
}<br />
```<br />
- Add `-DdebugPort=5005`, for e.g, `./mvnw --offline integration-test -DskipTests=false -Dtest=EnvTest -DdebugPort=5005`<br />
- With the `-DdebugPort=5005` option, the test will start and "freeze" at 0% with a message like:<br />
`Listening for transport dt_socket at address: 5005`<br />
- At **Run and Debug**, start the **Attach by Process ID** configuration. A dialog will popup for you to select the process that's waiting for connection at port 5005.<br />
- Some useful shortcuts:<br />
- Ctrl+R : Open recent workspaces.<br />
- Ctrl+P : Open recent files.<br />
- Shift+Alt+B : Invoke Incremental or Full Build.<br />
- Antigravity doesn't has build in support for generation of SerialVersionUID. Install the `Code Generator For Java` extension to get that.<br />
- To retain bundles installed using OSGi console or Extension Manager form after restart of the iDempiere server, you need to comments out the `@1\:start` part of the `osgi.bundles=...simpleconfigurator...` line in `config.ini` (inside the `-configuration` folder). Note that this is not needed in a deploy environment as it is to workaround the combination effect of `-dev` (equinox Dev Mode) and `simpleconfigurator`.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23875Antigravity.md2026-05-11T10:54:11Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- Add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```json<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"java.configuration.updateBuildConfiguration": "disabled",<br />
"java.configuration.runtimes": [<br />
{<br />
"name": "JavaSE-17",<br />
"path": "/usr/lib/jvm/java-17-temurin-jdk",<br />
"default": true<br />
}<br />
],<br />
"java.project.resourceFilters": [],<br />
"files.eol": "\n",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Replace `"path": "/usr/lib/jvm/java-17-temurin-jdk"` with your JDK17 path. The default JVM configuration is important for test and remote debugging.<br />
- `"java.project.resourceFilters": []` is to stop antigravity adding the following to .project files:<br />
```xml<br />
<filteredResources><br />
<filter><br />
<id>1774448868880</id><br />
<name></name><br />
<type>30</type><br />
<matcher><br />
<id>org.eclipse.core.resources.regexFilterMatcher</id><br />
<arguments>node_modules|\.git|__CREATED_BY_JAVA_LANGUAGE_SERVER__</arguments><br />
</matcher><br />
</filter><br />
</filteredResources><br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```text<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To ignore changes to tracked .project files:<br />
```text<br />
git update-index --skip-worktree **/.project<br />
```<br />
<br />
- To restore tracking of .project files:<br />
```text<br />
git update-index --no-skip-worktree **/.project<br />
```<br />
<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add more source folder to your workspace (File > Add Folder to Workspace...)<br />
- [iDempiere MCP Server](https://github.com/hengsin/idempiere-mcp)<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- It is faster and more reliable to **Reload Target Platform** using **org.idempiere.p2.targetplatform.mirror.target** instead of **org.idempiere.p2.targetplatform.target**.<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
```text<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.<br />
- To debug integration test<br />
- Add the following to `"configurations"` in launch.json:<br />
```json<br />
{<br />
"type": "java",<br />
"request": "attach",<br />
"name": "Attach by Process ID",<br />
"processId": "${command:PickJavaProcess}",<br />
"projectName": "org.adempiere.base"<br />
}<br />
```<br />
- Add `-DdebugPort=5005`, for e.g, `./mvnw --offline integration-test -DskipTests=false -Dtest=EnvTest -DdebugPort=5005`<br />
- With the `-DdebugPort=5005` option, the test will start and "freeze" at 0% with a message like:<br />
`Listening for transport dt_socket at address: 5005`<br />
- At **Run and Debug**, start the **Attach by Process ID** configuration. A dialog will popup for you to select the process that's waiting for connection at port 5005.<br />
- Some useful shortcuts:<br />
- Ctrl+R : Open recent workspaces.<br />
- Ctrl+P : Open recent files.<br />
- Shift+Alt+B : Invoke Incremental or Full Build.<br />
- Antigravity doesn't has build in support for generation of SerialVersionUID. Install the `Code Generator For Java` extension to get that.<br />
- To retain bundles installed using OSGi console or Extension Manager form after restart of the iDempiere server, you need to comments out the `@1\:start` part of the `osgi.bundles=...simpleconfigurator...` line. Note that this is not needed in a deploy environment as it is to workaround the combination effect of `-dev` (equinox Dev Mode) and `simpleconfigurator`.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23874Antigravity.md2026-05-11T10:51:23Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- Add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```json<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"java.configuration.updateBuildConfiguration": "disabled",<br />
"java.configuration.runtimes": [<br />
{<br />
"name": "JavaSE-17",<br />
"path": "/usr/lib/jvm/java-17-temurin-jdk",<br />
"default": true<br />
}<br />
],<br />
"java.project.resourceFilters": [],<br />
"files.eol": "\n",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Replace `"path": "/usr/lib/jvm/java-17-temurin-jdk"` with your JDK17 path. The default JVM configuration is important for test and remote debugging.<br />
- `"java.project.resourceFilters": []` is to stop antigravity adding the following to .project files:<br />
```xml<br />
<filteredResources><br />
<filter><br />
<id>1774448868880</id><br />
<name></name><br />
<type>30</type><br />
<matcher><br />
<id>org.eclipse.core.resources.regexFilterMatcher</id><br />
<arguments>node_modules|\.git|__CREATED_BY_JAVA_LANGUAGE_SERVER__</arguments><br />
</matcher><br />
</filter><br />
</filteredResources><br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```text<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To ignore changes to tracked .project files:<br />
```text<br />
git update-index --skip-worktree **/.project<br />
```<br />
<br />
- To restore tracking of .project files:<br />
```text<br />
git update-index --no-skip-worktree **/.project<br />
```<br />
<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add more source folder to your workspace (File > Add Folder to Workspace...)<br />
- [iDempiere MCP Server](https://github.com/hengsin/idempiere-mcp)<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- It is faster and more reliable to **Reload Target Platform** using **org.idempiere.p2.targetplatform.mirror.target** instead of **org.idempiere.p2.targetplatform.target**.<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
```text<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.<br />
- To debug integration test<br />
- Add the following to `"configurations"` in launch.json:<br />
```json<br />
{<br />
"type": "java",<br />
"request": "attach",<br />
"name": "Attach by Process ID",<br />
"processId": "${command:PickJavaProcess}",<br />
"projectName": "org.adempiere.base"<br />
}<br />
```<br />
- Add `-DdebugPort=5005`, for e.g, `./mvnw --offline integration-test -DskipTests=false -Dtest=EnvTest -DdebugPort=5005`<br />
- With the `-DdebugPort=5005` option, the test will start and "freeze" at 0% with a message like:<br />
`Listening for transport dt_socket at address: 5005`<br />
- At **Run and Debug**, start the **Attach by Process ID** configuration. A dialog will popup for you to select the process that's waiting for connection at port 5005.<br />
- Some useful shortcuts:<br />
- Ctrl+R : Open recent workspaces.<br />
- Ctrl+P : Open recent files.<br />
- Shift+Alt+B : Invoke Incremental or Full Build.<br />
- Antigravity doesn't has build in support for generation of SerialVersionUID. Install the `Code Generator For Java` extension to get that.<br />
- To retain bundles installed using OSGi console or Extension Manager form after restart of the iDempiere server, you need to comments out the '@1\:start` part of the `osgi.bundles=...simpleconfigurator...` line. Note that this is not needed in a deploy environment as it is to workaround the combination effect of `-dev` (equinox Dev Mode) and `simpleconfigurator`.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23873Antigravity.md2026-05-11T08:52:49Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- Add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```json<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"java.configuration.updateBuildConfiguration": "disabled",<br />
"java.configuration.runtimes": [<br />
{<br />
"name": "JavaSE-17",<br />
"path": "/usr/lib/jvm/java-17-temurin-jdk",<br />
"default": true<br />
}<br />
],<br />
"java.project.resourceFilters": [],<br />
"files.eol": "\n",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Replace `"path": "/usr/lib/jvm/java-17-temurin-jdk"` with your JDK17 path. The default JVM configuration is important for test and remote debugging.<br />
- `"java.project.resourceFilters": []` is to stop antigravity adding the following to .project files:<br />
```xml<br />
<filteredResources><br />
<filter><br />
<id>1774448868880</id><br />
<name></name><br />
<type>30</type><br />
<matcher><br />
<id>org.eclipse.core.resources.regexFilterMatcher</id><br />
<arguments>node_modules|\.git|__CREATED_BY_JAVA_LANGUAGE_SERVER__</arguments><br />
</matcher><br />
</filter><br />
</filteredResources><br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```text<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To ignore changes to tracked .project files:<br />
```text<br />
git update-index --skip-worktree **/.project<br />
```<br />
<br />
- To restore tracking of .project files:<br />
```text<br />
git update-index --no-skip-worktree **/.project<br />
```<br />
<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add more source folder to your workspace (File > Add Folder to Workspace...)<br />
- [iDempiere MCP Server](https://github.com/hengsin/idempiere-mcp)<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- It is faster and more reliable to **Reload Target Platform** using **org.idempiere.p2.targetplatform.mirror.target** instead of **org.idempiere.p2.targetplatform.target**.<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
```text<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.<br />
- To debug integration test<br />
- Add the following to `"configurations"` in launch.json:<br />
```json<br />
{<br />
"type": "java",<br />
"request": "attach",<br />
"name": "Attach by Process ID",<br />
"processId": "${command:PickJavaProcess}",<br />
"projectName": "org.adempiere.base"<br />
}<br />
```<br />
- Add `-DdebugPort=5005`, for e.g, `./mvnw --offline integration-test -DskipTests=false -Dtest=EnvTest -DdebugPort=5005`<br />
- With the `-DdebugPort=5005` option, the test will start and "freeze" at 0% with a message like:<br />
`Listening for transport dt_socket at address: 5005`<br />
- At **Run and Debug**, start the **Attach by Process ID** configuration. A dialog will popup for you to select the process that's waiting for connection at port 5005.<br />
- Some useful shortcuts:<br />
- Ctrl+R : Open recent workspaces.<br />
- Ctrl+P : Open recent files.<br />
- Shift+Alt+B : Invoke Incremental or Full Build.<br />
- Antigravity doesn't has build in support for generation of SerialVersionUID. Install the `Code Generator For Java` extension to get that.<br />
- To retain bundles installed using OSGi console or Extension Manager form after restart of the iDempiere server, you need to comments out the `osgi.bundles=...simpleconfigurator...` line. Note that this is not needed in a deploy environment as it is to workaround the combination effect of `-dev` (equinox Dev Mode) and `simpleconfigurator`.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23867Antigravity.md2026-05-05T02:17:59Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- Add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```json<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"java.configuration.updateBuildConfiguration": "disabled",<br />
"java.configuration.runtimes": [<br />
{<br />
"name": "JavaSE-17",<br />
"path": "/usr/lib/jvm/java-17-temurin-jdk",<br />
"default": true<br />
}<br />
],<br />
"java.project.resourceFilters": [],<br />
"files.eol": "\n",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Replace `"path": "/usr/lib/jvm/java-17-temurin-jdk"` with your JDK17 path. The default JVM configuration is important for test and remote debugging.<br />
- `"java.project.resourceFilters": []` is to stop antigravity adding the following to .project files:<br />
```xml<br />
<filteredResources><br />
<filter><br />
<id>1774448868880</id><br />
<name></name><br />
<type>30</type><br />
<matcher><br />
<id>org.eclipse.core.resources.regexFilterMatcher</id><br />
<arguments>node_modules|\.git|__CREATED_BY_JAVA_LANGUAGE_SERVER__</arguments><br />
</matcher><br />
</filter><br />
</filteredResources><br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```text<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To ignore changes to tracked .project files:<br />
```text<br />
git update-index --skip-worktree **/.project<br />
```<br />
<br />
- To restore tracking of .project files:<br />
```text<br />
git update-index --no-skip-worktree **/.project<br />
```<br />
<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add more source folder to your workspace (File > Add Folder to Workspace...)<br />
- [iDempiere MCP Server](https://github.com/hengsin/idempiere-mcp)<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- It is faster and more reliable to **Reload Target Platform** using **org.idempiere.p2.targetplatform.mirror.target** instead of **org.idempiere.p2.targetplatform.target**.<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
```text<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.<br />
- To debug integration test<br />
- Add the following to `"configurations"` in launch.json:<br />
```json<br />
{<br />
"type": "java",<br />
"request": "attach",<br />
"name": "Attach by Process ID",<br />
"processId": "${command:PickJavaProcess}",<br />
"projectName": "org.adempiere.base"<br />
}<br />
```<br />
- Add `-DdebugPort=5005`, for e.g, `./mvnw --offline integration-test -DskipTests=false -Dtest=EnvTest -DdebugPort=5005`<br />
- With the `-DdebugPort=5005` option, the test will start and "freeze" at 0% with a message like:<br />
`Listening for transport dt_socket at address: 5005`<br />
- At **Run and Debug**, start the **Attach by Process ID** configuration. A dialog will popup for you to select the process that's waiting for connection at port 5005.<br />
- Some useful shortcuts:<br />
- Ctrl+R : Open recent workspaces.<br />
- Ctrl+P : Open recent files.<br />
- Shift+Alt+B : Invoke Incremental or Full Build.<br />
- Antigravity doesn't has build in support for generation of SerialVersionUID. Install the `Code Generator For Java` extension to get that.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23848Antigravity.md2026-04-17T09:08:30Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- Add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```json<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"java.configuration.updateBuildConfiguration": "disabled",<br />
"java.configuration.runtimes": [<br />
{<br />
"name": "JavaSE-17",<br />
"path": "/usr/lib/jvm/java-17-temurin-jdk",<br />
"default": true<br />
}<br />
],<br />
"java.project.resourceFilters": [],<br />
"files.eol": "\n",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Replace `"path": "/usr/lib/jvm/java-17-temurin-jdk"` with your JDK17 path. The default JVM configuration is important for test and remote debugging.<br />
- `"java.project.resourceFilters": []` is to stop antigravity adding the following to .project files:<br />
```xml<br />
<filteredResources><br />
<filter><br />
<id>1774448868880</id><br />
<name></name><br />
<type>30</type><br />
<matcher><br />
<id>org.eclipse.core.resources.regexFilterMatcher</id><br />
<arguments>node_modules|\.git|__CREATED_BY_JAVA_LANGUAGE_SERVER__</arguments><br />
</matcher><br />
</filter><br />
</filteredResources><br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```text<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To ignore changes to tracked .project files:<br />
```text<br />
git update-index --skip-worktree **/.project<br />
```<br />
<br />
- To restore tracking of .project files:<br />
```text<br />
git update-index --no-skip-worktree **/.project<br />
```<br />
<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add more source folder to your workspace (File > Add Folder to Workspace...)<br />
- [iDempiere MCP Server](https://github.com/hengsin/idempiere-mcp)<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
```text<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.<br />
- To debug integration test<br />
- Add the following to `"configurations"` in launch.json:<br />
```json<br />
{<br />
"type": "java",<br />
"request": "attach",<br />
"name": "Attach by Process ID",<br />
"processId": "${command:PickJavaProcess}",<br />
"projectName": "org.adempiere.base"<br />
}<br />
```<br />
- Add `-DdebugPort=5005`, for e.g, `./mvnw --offline integration-test -DskipTests=false -Dtest=EnvTest -DdebugPort=5005`<br />
- With the `-DdebugPort=5005` option, the test will start and "freeze" at 0% with a message like:<br />
`Listening for transport dt_socket at address: 5005`<br />
- At **Run and Debug**, start the **Attach by Process ID** configuration. A dialog will popup for you to select the process that's waiting for connection at port 5005.<br />
- Some useful shortcuts:<br />
- Ctrl+R : Open recent workspaces.<br />
- Ctrl+P : Open recent files.<br />
- Shift+Alt+B : Invoke Incremental or Full Build.<br />
- Antigravity doesn't has build in support for generation of SerialVersionUID. Install the `Code Generator For Java` extension to get that.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23847Antigravity.md2026-04-17T08:55:03Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- Add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```json<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"java.configuration.updateBuildConfiguration": "disabled",<br />
"java.configuration.runtimes": [<br />
{<br />
"name": "JavaSE-17",<br />
"path": "/usr/lib/jvm/java-17-temurin-jdk",<br />
"default": true<br />
}<br />
],<br />
"java.project.resourceFilters": [],<br />
"files.eol": "\n",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Replace `"path": "/usr/lib/jvm/java-17-temurin-jdk"` with your JDK17 path. The default JVM configuration is important for test and remote debugging.<br />
- `"java.project.resourceFilters": []` is to stop antigravity adding the following to .project files:<br />
```xml<br />
<filteredResources><br />
<filter><br />
<id>1774448868880</id><br />
<name></name><br />
<type>30</type><br />
<matcher><br />
<id>org.eclipse.core.resources.regexFilterMatcher</id><br />
<arguments>node_modules|\.git|__CREATED_BY_JAVA_LANGUAGE_SERVER__</arguments><br />
</matcher><br />
</filter><br />
</filteredResources><br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```text<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To ignore changes to tracked .project files:<br />
```text<br />
git update-index --skip-worktree **/.project<br />
```<br />
<br />
- To restore tracking of .project files:<br />
```text<br />
git update-index --no-skip-worktree **/.project<br />
```<br />
<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add more source folder to your workspace (File > Add Folder to Workspace...)<br />
- [iDempiere MCP Server](https://github.com/hengsin/idempiere-mcp)<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
```text<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.<br />
- To debug integration test<br />
- Add the following to `"configurations"` in launch.json:<br />
```json<br />
{<br />
"type": "java",<br />
"request": "attach",<br />
"name": "Attach by Process ID",<br />
"processId": "${command:PickJavaProcess}",<br />
"projectName": "org.adempiere.base"<br />
}<br />
```<br />
- Add `-DdebugPort=5005`, for e.g, `./mvnw --offline integration-test -DskipTests=false -Dtest=EnvTest -DdebugPort=5005`<br />
- With the `-DdebugPort=5005` option, the test will start and "freeze" at 0% with a message like:<br />
`Listening for transport dt_socket at address: 5005`<br />
- At **Run and Debug**, start the **Attach by Process ID** configuration. A dialog will popup for you to select the process that's waiting for connection at port 5005.<br />
- Some useful shortcuts:<br />
- Ctrl+R : Open recent workspaces.<br />
- Ctrl+P : Open recent files.<br />
- Shift+Alt+B : Invoke Incremental or Full Build.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23819Antigravity.md2026-04-11T07:58:10Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- Add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```json<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"java.configuration.updateBuildConfiguration": "disabled",<br />
"java.configuration.runtimes": [<br />
{<br />
"name": "JavaSE-17",<br />
"path": "/usr/lib/jvm/java-17-temurin-jdk",<br />
"default": true<br />
}<br />
],<br />
"files.eol": "\n",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Replace `"path": "/usr/lib/jvm/java-17-temurin-jdk"` with your JDK17 path. The default JVM configuration is important for test and remote debugging.<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```text<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To ignore changes to tracked .project file:<br />
```text<br />
git update-index --skip-worktree **/.project<br />
```<br />
<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add more source folder to your workspace (File > Add Folder to Workspace...)<br />
- [iDempiere MCP Server](https://github.com/hengsin/idempiere-mcp)<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
```text<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.<br />
- To debug integration test<br />
- Add the following to `"configurations"` in launch.json:<br />
```json<br />
{<br />
"type": "java",<br />
"request": "attach",<br />
"name": "Attach by Process ID",<br />
"processId": "${command:PickJavaProcess}",<br />
"projectName": "org.adempiere.base"<br />
}<br />
```<br />
- Add `-DdebugPort=5005`, for e.g, `./mvnw --offline integration-test -DskipTests=false -Dtest=EnvTest -DdebugPort=5005`<br />
- With the `-DdebugPort=5005` option, the test will start and "freeze" at 0% with a message like:<br />
`Listening for transport dt_socket at address: 5005`<br />
- At **Run and Debug**, start the **Attach by Process ID** configuration. A dialog will popup for you to select the process that's waiting for connection at port 5005.<br />
- Some useful shortcuts:<br />
- Ctrl+R : Open recent workspaces.<br />
- Ctrl+P : Open recent files.<br />
- Shift+Alt+B : Invoke Incremental or Full Build.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23818Antigravity.md2026-04-11T07:47:58Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- Add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```json<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"java.configuration.updateBuildConfiguration": "disabled",<br />
"java.configuration.runtimes": [<br />
{<br />
"name": "JavaSE-17",<br />
"path": "/usr/lib/jvm/java-17-temurin-jdk",<br />
"default": true<br />
}<br />
],<br />
"files.eol": "\n",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Replace `"path": "/usr/lib/jvm/java-17-temurin-jdk"` with your JDK17 path. The default JVM configuration is important for test and remote debugging.<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```text<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To ignore changes to tracked .project file:<br />
```text<br />
git update-index --skip-worktree **/.project<br />
```<br />
<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add more source folder to your workspace (File > Add Folder to Workspace...)<br />
- [iDempiere REST API](https://github.com/bxservice/idempiere-rest)<br />
- [iDempiere MCP Server](https://github.com/hengsin/idempiere-mcp)<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
<br />
```text<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.<br />
- To debug integration test<br />
- Add the following to `"configurations"` in launch.json:<br />
```json<br />
{<br />
"type": "java",<br />
"request": "attach",<br />
"name": "Attach by Process ID",<br />
"processId": "${command:PickJavaProcess}",<br />
"projectName": "org.adempiere.base"<br />
}<br />
```<br />
- Add `-DdebugPort=5005`, for e.g, `./mvnw --offline integration-test -DskipTests=false -Dtest=EnvTest -DdebugPort=5005`<br />
- With the `-DdebugPort=5005` option, the test will start and "freeze" at 0% with a message like:<br />
`Listening for transport dt_socket at address: 5005`<br />
- At **Run and Debug**, start the **Attach by Process ID** configuration. A dialog will popup for you to select the process that's waiting for connection at port 5005.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23817Antigravity.md2026-04-11T03:40:44Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"files.eol": "\n",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To ignore changes to tracked .project file:<br />
```<br />
git update-index --skip-worktree **/.project<br />
```<br />
<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add more source folder to your workspace (File > Add Folder to Workspace...)<br />
- [iDempiere REST API](https://github.com/bxservice/idempiere-rest)<br />
- [iDempiere MCP Server](https://github.com/hengsin/idempiere-mcp)<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
<br />
```<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23816Antigravity.md2026-04-11T01:36:47Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"files.eol": "\n",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To ignore changes to tracked .project file:<br />
```<br />
git update-index --skip-worktree **/.project<br />
```<br />
<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add iDempiere mcp source folder to your workspace<br />
- https://github.com/hengsin/idempiere-mcp<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
<br />
```<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23813Antigravity.md2026-04-10T03:02:04Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"files.eol": "auto",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To ignore changes to tracked .project file:<br />
```<br />
git update-index --skip-worktree **/.project<br />
```<br />
<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add iDempiere mcp source folder to your workspace<br />
- https://github.com/hengsin/idempiere-mcp<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
<br />
```<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Accounting_Info.md&diff=23807Accounting Info.md2026-03-31T03:17:22Z<p>Hengsin: Created page with "# iDempiere Accounting Module **Summary:** The foundational accounting engine for iDempiere. It processes all document-level transactions (Invoices, Payments, Material Receip..."</p>
<hr />
<div># iDempiere Accounting Module<br />
<br />
**Summary:** The foundational accounting engine for iDempiere. It processes all document-level transactions (Invoices, Payments, Material Receipts, etc.) and transforms them into balanced accounting entries (Fact ACCT) based on the configured Accounting Schema and Chart of Accounts.<br />
<br />
## 🚀 Features<br />
<br />
* **Real-Time Posting:** Automatically generates accounting facts upon document completion.<br />
* **Multi-Currency Support:** Handles complex currency conversions and realized/unrealized gain/loss calculations.<br />
* **Multi-Schema Accounting:** Supports posting a single transaction to multiple accounting schemas simultaneously (e.g., Local GAAP and IFRS).<br />
* **Flexible Dimensions:** Provides core support for accounting dimensions including Organization, Account, Product, Business Partner, Project, and Sales Region.<br />
* **Suspense Accounting:** Robust handling of unbalanced entries by routing them to configured suspense accounts for manual review.<br />
* **Document Integration:** Pre-configured posting logic for all standard iDempiere documents (AR/AP Invoices, Bank Statements, Inventory Moves, etc.).<br />
<br />
## ⚙️ Compatibility<br />
<br />
* **Core Module**<br />
* **Java Version:** 17+<br />
<br />
## 📦 Database Changes<br />
<br />
* **Core Tables:** Manages data within `Fact_Acct`, `C_AcctSchema`, `C_ValidCombination`, and `GL_Category`.<br />
* **Posting Logic:** Uses the `Doc_*` class hierarchy to define how specific document types are translated into debits and credits.<br />
<br />
## 🛠 Usage & Configuration<br />
<br />
* **Configuration:** <br />
1. Define your **Accounting Schema** and **Chart of Accounts**.<br />
2. Set up **Default Accounts** for Products, Business Partners, and Tax Categories.<br />
* **Execution:** Transactions are usually posted automatically.<br />
* **Audit:** Use the **Performance Analysis > Accounting Fact** window to audit individual entries and drill back to the source document.<br />
<br />
## 👤 Author / Support<br />
<br />
* **Developer:** iDempiere Community<br />
* **Source Code:** [https://github.com/idempiere/idempiere/tree/master/org.idempiere.acct](https://github.com/idempiere/idempiere/tree/master/org.idempiere.acct)<br />
* **Documentation:** [iDempiere Wiki - Accounting](https://wiki.idempiere.org/en/IDempiere_Accounting)</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23804Antigravity.md2026-03-28T06:03:10Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"files.eol": "auto",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add iDempiere mcp source folder to your workspace<br />
- https://github.com/hengsin/idempiere-mcp<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Add `"projectName": "org.adempiere.base"` to enable evaluation of expression in debug (using the **Debug Console**).<br />
- You can use inline comment as instruction to guide the agent to generate code for your need. You can remove the inline comment after you have accept or reject the generated code.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
<br />
```<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23799Antigravity.md2026-03-24T08:02:55Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"files.eol": "auto",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add iDempiere mcp source folder to your workspace<br />
- https://github.com/hengsin/idempiere-mcp<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
<br />
```<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
<br />
- After making changes to MANIFEST.MF, run **Full Build** to resolve build errors.<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23774Antigravity.md2026-03-19T03:09:41Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"files.eol": "auto",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add iDempiere mcp source folder to your workspace<br />
- https://github.com/hengsin/idempiere-mcp<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to recreate it from the latest .launch file.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
<br />
```<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23773Antigravity.md2026-03-19T03:09:06Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketplace (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"files.eol": "auto",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add iDempiere mcp source folder to your workspace<br />
- https://github.com/hengsin/idempiere-mcp<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- If there are changes to a .launch file, remove the entry from **launch.json** to get recreate it from the latest .launch file.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
<br />
```<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=NF12_Multiple_SSO_Provider_Support&diff=23772NF12 Multiple SSO Provider Support2026-03-19T03:03:24Z<p>Hengsin: </p>
<hr />
<div>'''Developer:''' [[User:Dpansheriya|Deepak Pansheriya]] [https://www.logilite.com Logilite Technologies]<br />
<br />
'''Feature Ticket:''' [https://idempiere.atlassian.net/browse/IDEMPIERE-6304 IDEMPIERE-6304]<br />
===Multiple SSO Provider Support===<br />
This enhancement introduces the ability to configure and support '''multiple Single Sign-On (SSO) providers''' in iDempiere. Previously, only one SSO provider could be used at a time, and the system lacked flexibility to present multiple options at login.<br />
<br />
With this feature, system administrators can now configure more than one SSO provider (e.g., Cognito, Keycloak) and present each as a distinct '''login button on the login page'''. This provides organizations with flexible identity provider options and improves user experience across different domains or roles.<br />
<br />
'''System Configuration: SSO_SHOW_LOGINPAGE'''<br />
*'''Y''' – Shows the iDempiere login page with native login and SSO provider buttons<br />
*'''N''' – Skips the login page and redirects to SSO (if one provider) or shows only SSO buttons (if multiple)<br />
===Behavior Examples===<br />
{| class="wikitable"<br />
!Providers<br />
!SSO_SHOW_LOGINPAGE<br />
!Result<br />
|-<br />
|Cognito<br />
|Y<br />
|Shows button for Cognito, allows login with iDempiere credentials<br />
|-<br />
|Cognito<br />
|N<br />
|Redirects to Cognito<br />
|-<br />
|Cognito + Keycloak<br />
|Y<br />
|Shows button for Cognito and Keycloak, allows login with iDempiere credentials<br />
|-<br />
|Cognito + Keycloak<br />
|N<br />
|Shows button for Cognito and Keycloak<br />
|}<br />
===How to Configure===<br />
#Create multiple entries in the '''SSO Configuration''' window (e.g., Cognito and Keycloak).<br />
#Set the system config:<br />
##<code>SSO_SHOW_LOGINPAGE</code> to <code>Y</code> or <code>N</code> depending on your desired login experience.<br />
#Run '''Cache Reset.'''<br />
<br />
== IDEMPIERE-6820 Add multi tenant support to SSO ==<br />
'''Feature Ticket:''' [https://idempiere.atlassian.net/browse/IDEMPIERE-6304 IDEMPIERE-6304]<br />
# Change the window "SSO Configuration" to advanced and tenant level<br />
# The selection of SSO principal configurations by tenant is via the tenant=loginPrefix query parameter.<br />
## When the parameter is missing, it fall backs to SSO principal configurations in system tenant (i.e with AD_Client_ID=0) which should make it backward compatible.<br />
## Uses the query parameter approach to support translation from tenant specific URL, for example from gw.idempiere.org/webui/index.zul to test.idempiere.org/webui/index.zul?tenant=gw.<br />
## When tenant parameter exists, get SSO configuration by AD_Client_ID={AD_Client_ID of tenant parameter}.<br />
## When no tenant parameter, get SSO configuration by AD_Client_ID=0 (effectively same as the implementation prior to this ticket).<br />
## Tenant selection at Role selection panel is disable when tenant query parameter exists.<br />
# SSO Configuration window changes:<br />
## Only show configurations for current login tenant.<br />
## The Application Client ID, Application Redirect URL and Application Discovery URI shouldn't be always updateable.<br />
## Hide Tenant ID field if SSO Provider is OpenID Connect.<br />
## Make Application Discovery URI and Application Client ID field mandatory if SSO Provider is OpenID Connect.<br />
## Hide iDempiere Monitor Redirect URIs and Felix Web Console Redirect URIs field if current login tenant is not System tenant.<br />
# Example Configurations:<br />
* SSO Configuration for System Tenant:<br />
[[File:System Tenant SSO Configuration.png|800x600px|frameless|System Tenant SSO Configuration]]<br />
* Login Prefix Setup for System tenant:<br />
[[File:System Tenant Login Prefix.png|400x300px|frameless|System Tenant Login Prefix]]<br />
* SSO Configuration for GardenWorld Tenant:<br />
[[File:Garden World Tenant SSO Configuration.png|800x600px|frameless|Garden World Tenant SSO Configuration]]<br />
* Login Prefix Setup for GardenWorld tenant:<br />
[[File:Garden World Login Prefix.png|400x300px|frameless|Garden World Login Prefix]]<br />
<br />
==See Also==<br />
*[[NF11_Single_SignOn|iDempiere Single SignOn]]<br />
<br />
[[Category:New Features|T]]<br />
[[Category:New Features Technical]]<br />
[[Category:New Features w12|T]]</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=NF12_Multiple_SSO_Provider_Support&diff=23771NF12 Multiple SSO Provider Support2026-03-19T03:02:41Z<p>Hengsin: </p>
<hr />
<div>'''Developer:''' [[User:Dpansheriya|Deepak Pansheriya]] [https://www.logilite.com Logilite Technologies]<br />
<br />
'''Feature Ticket:''' [https://idempiere.atlassian.net/browse/IDEMPIERE-6304 IDEMPIERE-6304]<br />
===Multiple SSO Provider Support===<br />
This enhancement introduces the ability to configure and support '''multiple Single Sign-On (SSO) providers''' in iDempiere. Previously, only one SSO provider could be used at a time, and the system lacked flexibility to present multiple options at login.<br />
<br />
With this feature, system administrators can now configure more than one SSO provider (e.g., Cognito, Keycloak) and present each as a distinct '''login button on the login page'''. This provides organizations with flexible identity provider options and improves user experience across different domains or roles.<br />
<br />
'''System Configuration: SSO_SHOW_LOGINPAGE'''<br />
*'''Y''' – Shows the iDempiere login page with native login and SSO provider buttons<br />
*'''N''' – Skips the login page and redirects to SSO (if one provider) or shows only SSO buttons (if multiple)<br />
===Behavior Examples===<br />
{| class="wikitable"<br />
!Providers<br />
!SSO_SHOW_LOGINPAGE<br />
!Result<br />
|-<br />
|Cognito<br />
|Y<br />
|Shows button for Cognito, allows login with iDempiere credentials<br />
|-<br />
|Cognito<br />
|N<br />
|Redirects to Cognito<br />
|-<br />
|Cognito + Keycloak<br />
|Y<br />
|Shows button for Cognito and Keycloak, allows login with iDempiere credentials<br />
|-<br />
|Cognito + Keycloak<br />
|N<br />
|Shows button for Cognito and Keycloak<br />
|}<br />
===How to Configure===<br />
#Create multiple entries in the '''SSO Configuration''' window (e.g., Cognito and Keycloak).<br />
#Set the system config:<br />
##<code>SSO_SHOW_LOGINPAGE</code> to <code>Y</code> or <code>N</code> depending on your desired login experience.<br />
#Run '''Cache Reset.'''<br />
<br />
== IDEMPIERE-6820 Add multi tenant support to SSO ==<br />
'''Feature Ticket:''' [https://idempiere.atlassian.net/browse/IDEMPIERE-6304 IDEMPIERE-6304]<br />
# Change the window "SSO Configuration" to advanced and tenant level<br />
# The selection of SSO principal configurations by tenant is via the tenant=loginPrefix query parameter.<br />
## When the parameter is missing, it fall backs to SSO principal configurations in system tenant (i.e with AD_Client_ID=0) which should make it backward compatible.<br />
## Uses the query parameter approach to support translation from tenant specific URL, for example from gw.idempiere.org/webui/index.zul to test.idempiere.org/webui/index.zul?tenant=gw.<br />
## When tenant parameter exists, get SSO configuration by AD_Client_ID={AD_Client_ID of tenant parameter}.<br />
## When no tenant parameter, get SSO configuration by AD_Client_ID=0 (effectively same as the implementation prior to this ticket).<br />
## Tenant selection at Role selection panel is disable when tenant query parameter exists.<br />
# SSO Configuration window changes:<br />
## Only show configurations for current login tenant.<br />
## The Application Client ID, Application Redirect URL and Application Discovery URI shouldn't be always updateable.<br />
## Hide Tenant ID field if SSO Provider is OpenID Connect.<br />
## Make Application Discovery URI and Application Client ID field mandatory if SSO Provider is OpenID Connect.<br />
## Hide iDempiere Monitor Redirect URIs and Felix Web Console Redirect URIs field if current login tenant is not System tenant.<br />
# Example Configurations:<br />
* SSO Configuration for System Tenant:<br />
[[File:System Tenant SSO Configuration.png|800x600px|frameless|System Tenant SSO Configuration]]<br />
* Login Prefix Setup for System tenant:<br />
[[File:System Tenant Login Prefix.png|400x300px|frameless|System Tenant Login Prefix]]<br />
* SSO Configuration for GardenWorld Tenant:<br />
[[File:Garden World Tenant SSO Configuration.png|800x600px|frameless|Garden World Tenant SSO Configuration]]<br />
* Login Prefix Setup for GardenWorld tenant:<br />
[[File:Garden World Login Prefix.png|400x300px|frameless|Garden World Login Prefix]]<br />
<br />
===See Also===<br />
*[[NF11_Single_SignOn|iDempiere Single SignOn]]<br />
<br />
[[Category:New Features|T]]<br />
[[Category:New Features Technical]]<br />
[[Category:New Features w12|T]]</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=File:Garden_World_Login_Prefix.png&diff=23770File:Garden World Login Prefix.png2026-03-19T02:58:08Z<p>Hengsin: </p>
<hr />
<div>Garden World Login Prefix</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=File:System_Tenant_Login_Prefix.png&diff=23769File:System Tenant Login Prefix.png2026-03-19T02:57:00Z<p>Hengsin: </p>
<hr />
<div>System Tenant Login Prefix</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=File:Garden_World_Tenant_SSO_Configuration.png&diff=23768File:Garden World Tenant SSO Configuration.png2026-03-19T02:56:11Z<p>Hengsin: </p>
<hr />
<div>Garden World Tenant SSO Configuration</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=File:System_Tenant_SSO_Configuration.png&diff=23767File:System Tenant SSO Configuration.png2026-03-19T02:55:14Z<p>Hengsin: </p>
<hr />
<div>System Tenant SSO Configuration</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23699Antigravity.md2026-02-21T09:47:50Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketpalce (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"files.eol": "auto",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add iDempiere mcp source folder to your workspace<br />
- https://github.com/hengsin/idempiere-mcp<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- A new launch configuration entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that (for e.g, "cwd": "/home/hengsin/idempiere-workspace/idempiere").<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the initial launch, open the **Run/Debug View** and launch from the drop down list of available launch configuration.<br />
- Note that if you use Right Click > Debug PDE Application to launch a launch configuration again, it will overwrite the changes that you have make to the launch.json file.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
<br />
```<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23698Antigravity.md2026-02-20T22:20:17Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketpalce (Gear icon > **Open Antigravity User Settings > Editor**): <br />
- https://marketplace.visualstudio.com/items (Marketplace Item URL)<br />
- https://marketplace.visualstudio.com/_apis/public/gallery (Marketplace Gallery URL)<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"files.eol": "auto",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (Gear Icon > **Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add iDempiere mcp source folder to your workspace<br />
- https://github.com/hengsin/idempiere-mcp<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- An entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that.<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the first run, you can open the **launch.json** file, select **Run > Start Debugging** to run it.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
<br />
```<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23697Antigravity.md2026-02-20T22:16:28Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketpalce: <br />
- https://marketplace.visualstudio.com/items<br />
- https://marketplace.visualstudio.com/_apis/public/gallery<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"files.eol": "auto",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (**Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add iDempiere mcp source folder to your workspace<br />
- https://github.com/hengsin/idempiere-mcp<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- An entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that.<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the first run, you can open the **launch.json** file, select **Run > Start Debugging** to run it.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
<br />
```<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23696Antigravity.md2026-02-20T22:15:43Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketpalce: <br />
- https://marketplace.visualstudio.com/items<br />
- https://marketplace.visualstudio.com/_apis/public/gallery<br />
- Install **Extension Pack for Java** extension<br />
- Install **Eclipse PDE Support** extension<br />
- **File > Open Folder...** , select iDempiere source folder<br />
- **File > Add Folder to Workspace...** , add idempiere-rest source folder to your workspace<br />
- **File > Add Folder to Workspace...** , add your other project source folder to your workspace<br />
- **File > Save Workspace As...** to save your workspace<br />
- add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formatting only changes:<br />
```<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"files.eol": "auto",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
- To set active target platform, right click on the target definition file (.target file) and select **Reload Target Platform**<br />
<br />
# Optional<br />
- Install **Eclipse Keymap** extension to use Eclipse Key Binding<br />
- Enable browser extension (**Open Antigravity User Settings > Enable Browser Tools**)<br />
- Install Gemini CLI: https://github.com/google-gemini/gemini-cli<br />
- Enable Gemini CLI integration with antigravity: **/ide install**<br />
- Note that this might be needed for /ide install: `sudo ln -s /usr/bin/antigravity /usr/local/bin/agy`<br />
- Install iDempiere examples for Gemini CLI<br />
- `gemini skills install https://github.com/hengsin/idempiere-examples`<br />
- Install iDempiere skills for Gemini CLI: https://github.com/hengsin/idempiere-skills<br />
- Add iDempiere mcp source folder to your workspace<br />
- https://github.com/hengsin/idempiere-mcp<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- To run a launch configuration, right click on launch configuration (.launch file) and select **Debug PDE Application**<br />
- An entry will be added to the **launch.json** file.<br />
- If the startup workspace folder is wrong, add the **"cwd"** property in launch.json to fix that.<br />
- If it is not launch with the intended Java runtime environment, add **"javaExec"** property in launch.json to set the Java runtime environment to use. This property should contain the absolute path of the Java executable to use (for e.g, "javaExec": "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- After the first run, you can open the **launch.json** file, select **Run > Start Debugging** to run it.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add **Customizations** rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
```<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
```<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, try ask the agent to do it for you.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23694Antigravity.md2026-02-20T16:34:34Z<p>Hengsin: </p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketpalce: <br />
- https://marketplace.visualstudio.com/items<br />
- https://marketplace.visualstudio.com/_apis/public/gallery<br />
- Install Java extension pack<br />
- Install Eclipse PDE extension<br />
- File > Open Folder... , select iDempiere source folder<br />
- File > Add Folder to Workspace... , add idempiere-rest source folder to your workspace<br />
- File > Add Folder to Workspace... , add your other project source folder to your workspace<br />
- File > Save Workspace As... to save your workspace<br />
- add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formating only changes:<br />
```<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"files.eol": "auto",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
<br />
# Optional<br />
- Install Eclipse Keymap extension to use Eclipse Key Binding<br />
- Enable browser extension (Open Antigravity User Settings > Enable Browser Tools)<br />
- Install gemini cli: https://github.com/google-gemini/gemini-cli<br />
- Enable gemini cli integration with antigravity: /ide install<br />
- note that this might be needed for /ide install: sudo ln -s /usr/bin/antigravity /usr/local/bin/agy<br />
- Install idempiere examples for gemini cli<br />
- gemini skills install https://github.com/hengsin/idempiere-examples<br />
- Install idempiere skills for gemini cli: https://github.com/hengsin/idempiere-skills<br />
- Add idempiere mcp source folder to your workspace<br />
- https://github.com/hengsin/idempiere-mcp<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- When running launch configuration created with Eclipse, you might face issue with startup workspace folder. Use the "cwd" property in launch.json to fix that.<br />
- Use "javaExec" property in launch.json to set the JDK to run or debug iDempiere. This property should be the absolute path of the Java executable (for e.g, "/usr/lib/jvm/java-17-temurin-jdk/bin/java").<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add Customizations rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
````<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
````<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, just ask the agent to do it for you.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Antigravity.md&diff=23693Antigravity.md2026-02-20T14:05:50Z<p>Hengsin: Created page with "# Setup - Install from https://antigravity.google/ - Switch to visual studio code marketpalce: - https://marketplace.visualstudio.com/items - https://marketplace.visualst..."</p>
<hr />
<div># Setup<br />
- Install from https://antigravity.google/<br />
- Switch to visual studio code marketpalce: <br />
- https://marketplace.visualstudio.com/items<br />
- https://marketplace.visualstudio.com/_apis/public/gallery<br />
- Install Java extension pack<br />
- Install Eclipse PDE extension<br />
- File > Open Folder... , select iDempiere source folder<br />
- File > Add Folder to Workspace... , add idempiere-rest source folder to your workspace<br />
- File > Add Folder to Workspace... , add your other project source folder to your workspace<br />
- File > Save Workspace As... to save your workspace<br />
- add the following properties to "settings" in the save .code-workspace file to prevent unnecessary formating only changes:<br />
```<br />
"settings": {<br />
"editor.formatOnSave": false,<br />
"editor.formatOnType": false,<br />
"editor.formatOnPaste": false,<br />
"editor.codeActionsOnSave": {<br />
"source.fixAll": "never",<br />
"source.organizeImports": "never"<br />
},<br />
"files.eol": "auto",<br />
"files.trimTrailingWhitespace": false,<br />
"files.insertFinalNewline": false,<br />
"files.trimFinalNewlines": false<br />
}<br />
```<br />
- Add the following to {idempiere source folder}/.git/info/exclude file:<br />
```<br />
.project<br />
.vscode<br />
*.properties<br />
*.ks<br />
**/.settings/<br />
*.sh<br />
**/*.launch<br />
*.blacklist<br />
*.blacklist.*<br />
*.code-workspace<br />
```<br />
<br />
# Optional<br />
- Install Eclipse Keymap extension to use Eclipse Key Binding<br />
- Enable browser extension (Open Antigravity User Settings > Enable Browser Tools)<br />
- Install gemini cli: https://github.com/google-gemini/gemini-cli<br />
- Enable gemini cli integration with antigravity: /ide install<br />
- note that this might be needed for /ide install: sudo ln -s /usr/bin/antigravity /usr/local/bin/agy<br />
- Install idempiere examples for gemini cli<br />
- gemini skills install https://github.com/hengsin/idempiere-examples<br />
- Install idempiere skills for gemini cli: https://github.com/hengsin/idempiere-skills<br />
- Add idempiere mcp source folder to your workspace<br />
- https://github.com/hengsin/idempiere-mcp<br />
<br />
# What you still need from Eclipse<br />
- Create new launch configuration<br />
- Check and fix target platform state<br />
<br />
# Tips<br />
- There's no build in tool to create OSGi component XML file from annotation but you can ask the agent to do that for you.<br />
- When running launch configuration created with Eclipse, you might face issue with startup workspace folder. Use the "cwd" property in launch.json to fix that.<br />
- Automatic build can cause conflict with mvn build. You might want to disable automatic build if you frequently use maven to run build or run unit test.<br />
- Add Customizations rule to guide the agent on the running of mvn build and unit test for iDempiere:<br />
````<br />
**For running of unit test and integration test using maven**<br />
* Run from workspace root folder<br />
* Set JAVA_HOME to /usr/lib/jvm/java-17-temurin-jdk<br />
* mvn integration-test -DskipTests=false -DmaterializeProduct=none -DassembleRepository=none -Dtest=**test class name**<br />
* Always run in terminal<br />
````<br />
- If you have an IDE or workspace settings that you can't locate the place to change it, just ask the agent to do it for you.</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=NF13_Read_Access_To_Tables_Not_In_Role_Table_Access_List&diff=23588NF13 Read Access To Tables Not In Role Table Access List2026-01-02T12:02:33Z<p>Hengsin: </p>
<hr />
<div>'''Feature:''' Add READ_TABLES_NOT_IN_TABLE_ACCESS_INCLUDE_LIST AD_SysConfig flag for Role Table Access<br />
<br />
'''Goal:''' Functional<br />
<br />
'''Developer:''' [[User:Hengsin|Heng Sin]]<br />
<br />
'''Feature Ticket:''' [https://idempiere.atlassian.net/browse/IDEMPIERE-6730 IDEMPIERE-6730]<br />
<br />
===Description===<br />
When using the Role Table Access Include list (i.e uncheck the Exclude checkbox) for Read Write access, the current behaviour is hard coded as the role has no access to other tables that is not part of the include list. This make it very hard to use as you have to figure out all other tables that the user should have read only access to.<br />
<br />
===Changes===<br />
<br />
# Add client level '''READ_TABLES_NOT_IN_TABLE_ACCESS_INCLUDE_LIST''' AD_SysConfig Y/N entry.<br />
#* '''N''' to disallow both read-only and read write access to other tables that's not part of the Role Table Access include list.<br />
#* '''Y''' to allow read-only access to tables not in the include list.<br />
#* Default is '''N''' to maintain backward compatibility.<br />
# Note that you still can use the Role Table Access Exclude feature to disallow access to specific set of tables). <br />
<br />
[[Category:New Features|F]]<br />
[[Category:New Features w13|F]]<br />
[[Category:New Features Functional]]</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=NF13_Read_Access_To_Tables_Not_In_Role_Table_Access_List&diff=23587NF13 Read Access To Tables Not In Role Table Access List2026-01-02T11:59:50Z<p>Hengsin: Created page with "'''Feature:''' Add READ_TABLES_NOT_IN_TABLE_ACCESS_INCLUDE_LIST AD_SysConfig flag for Role Table Access '''Goal:''' Functional '''Developer:''' User:Hengsin '''Feature..."</p>
<hr />
<div>'''Feature:''' Add READ_TABLES_NOT_IN_TABLE_ACCESS_INCLUDE_LIST AD_SysConfig flag for Role Table Access<br />
<br />
'''Goal:''' Functional<br />
<br />
'''Developer:''' [[User:Hengsin]]<br />
<br />
'''Feature Ticket:''' [https://idempiere.atlassian.net/browse/IDEMPIERE-6730 IDEMPIERE-6730]<br />
<br />
===Description===<br />
When using the Role Table Access Include list (i.e uncheck the Exclude checkbox) for Read Write access, the current behaviour is hard coded as the role has no access to other tables that is not part of the include list. This make it very hard to use as you have to figure out all other tables that the user should have read only access to.<br />
<br />
===Changes===<br />
<br />
# Add client level '''READ_TABLES_NOT_IN_TABLE_ACCESS_INCLUDE_LIST''' AD_SysConfig Y/N entry.<br />
#* '''N''' to disallow both read-only and read write access to other tables that's not part of the Role Table Access include list.<br />
#* '''Y''' to allow read-only access to tables not in the include list.<br />
#* Default is '''N''' to maintain backward compatibility.<br />
# Note that you still can use the Role Table Access Exclude feature to disallow access to specific set of tables). <br />
<br />
[[Category:New Features|F]]<br />
[[Category:New Features w13|F]]<br />
[[Category:New Features Functional]]</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=NF12_Improve_Password_Hashing&diff=23550NF12 Improve Password Hashing2025-11-04T06:14:28Z<p>Hengsin: Created page with "= '''Feature:''' Improve Password Hashing= '''Goal:''' Technical '''Developer:''' Carlos Ruiz Heng Sin '''Description:''' Currently pa..."</p>
<hr />
<div>= '''Feature:''' Improve Password Hashing=<br />
<br />
'''Goal:''' Technical<br />
<br />
'''Developer:''' [[User:CarlosRuiz|Carlos Ruiz]] [[User:Hengsin|Heng Sin]]<br />
<br />
'''Description:'''<br />
<br />
Currently password hashing is using SHA-512 and salt is generated using SHA1PRNG random generator and 64 bytes.<br />
<br />
This ticket make the following changes to improve the security of password hashing in iDempiere:<br />
* Generate salt using the DRBG algorithm and 256 bit strength.<br />
* Add support for PBKDF2 and Argon2 hashing algorithm.<br />
<br/><br />
'''Changes:'''<br />
<br />
1. Added USER_PASSWORD_HASH_ALGORITHM System Configurator entry. Supported values are SHA-512, PBKDF2 and Argon2.<br />
[[File:User password hash algorithm.png|600x600px|frameless|USER_PASSWORD_HASH_ALGORITHM]]<br />
<br/><br />
<br />
2. Added '''Password Hash Algorithm''' parameter to the '''Convert passwords to hashes''' process.<br />
[[File:Convert passwords to hash.png|600x600px|frameless|Convert password to hashes process]]<br />
<br/><br />
<br />
'''Migration of existing SHA-512 hashes''':<br />
<p><br />
* Change USER_PASSWORD_HASH_ALGORITHM System Configurator entry to PBKDF2 or Argon2, reset cache.<br />
* User's password will be rehashed using the newly set algorithm when they login next time.<br />
<br/><br />
<br />
'''Technical Info:''' [https://idempiere.atlassian.net/browse/IDEMPIERE-6712 IDEMPIERE-6712]<br />
<br />
[[Category:New Features|T]]<br />
[[Category:New Features w12|T]]<br />
[[Category:New Features Technical]]</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=File:Convert_passwords_to_hash.png&diff=23549File:Convert passwords to hash.png2025-11-04T06:08:49Z<p>Hengsin: </p>
<hr />
<div>Convert passwords to hashes process</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=File:User_password_hash_algorithm.png&diff=23548File:User password hash algorithm.png2025-11-04T06:06:01Z<p>Hengsin: </p>
<hr />
<div>USER_PASSWORD_HASH_ALGORITHM System Configurator</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=OIDC_SSO_Amazon_Cognito_Testing_Steps&diff=23484OIDC SSO Amazon Cognito Testing Steps2025-08-21T03:00:08Z<p>Hengsin: /* Testing using Postman */</p>
<hr />
<div><br />
== Create user pool ==<br />
Amazon Cognito https://console.aws.amazon.com/cognito/home > User pools > Create user pool<br />
<br />
=== Step 1: Select Cognito user pool provider type ===<br />
'''IMPORTANT NOTES:'''<br />
<br />
* if you are planning to use EMail authentication with iDempiere then select EMail as the '''ONLY''' attribute for sign in, otherwise you won't be able to create your users based on emails<br />
* if you are planning to use Name as authentication you can select both User Name + EMail, but make sure that you check "Make user case sensitive", otherwise you won't be able to create GardenAdmin as user (it will end and gardenadmin and the REST integration won't work)<br />
<br />
[[File:Amazon Cognito Testing Step 1.png]]<br />
<br />
=== Step 2: Configure password and authentication policy ===<br />
[[File:Amazon Cognito Testing Step 2.png]] ===<br />
<br />
=== Step 3: Configure sign-up experience ===<br />
[[File:Amazon Cognito Testing Step 3.png]]<br />
<br />
=== Step 4: Configure email and SMS delivery ===<br />
[[File:Amazon Cognito Testing Step 4.png]]<br />
<br />
=== Step 5: Integrate app ===<br />
<br />
==== Step 5.1: Setup integration with app ====<br />
[[File:Amazon Cognito Testing Step 5 1.png]]<br />
<br />
==== Step 5.2: Setup Cognito domain ====<br />
[[File:Amazon Cognito Testing Step 5 2.png]]<br />
<br />
==== Step 5.3: Select Confidential client, enter app client name and select Generate a client secret ====<br />
[[File:Amazon Cognito Testing Step 5 3.png]]<br />
<br />
==== Step 5.4: Enter callback URLs ====<br />
[[File:Amazon Cognito Testing Step 5 4.png]]<br />
<br />
==== Step 5.5: Add ALLOW_USER_PASSWORD_AUTH to Authentication flows ====<br />
[[File:Amazon Cognito Testing Step 5 5.png]]<br />
<br />
==== Step 5.6: Add Profile to Open ID Connect scopes ====<br />
[[File:Amazon Cognito Testing Step 5 6.png]]<br />
<br />
== User pool configuration ==<br />
<br />
=== Step 1: Create user ===<br />
User pool: GardenWorld > Users > Create user<br />
<br />
''Notes:'' <br />
<br />
* ''User name = iDempiere user (AD_User.Name)''<br />
* ''Email address = iDempiere user (AD_User.EMail)''<br />
* ''User has to login for the first time using the temporary password to change new password''<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 1.png]]<br />
<br />
=== Step 2: Create group (Optional) ===<br />
NOTE this step and the next are optional, not required if you uncheck the "Authorization" flag in the iDempiere "Rest OpenID Connect Service configuration" explaned below.<br />
<br />
User pool: GardenWorld > Groups > Create group<br />
<br />
''Note: Group name = iDempiere role (AD_Role.Name) without space''<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 2.png]]<br />
<br />
=== Step 3: Add user to group ===<br />
User pool: GardenWorld > Groups > Group: GardenWorldAdmin > Add user to group<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 3.png]]<br />
<br />
=== Step 4: Get region, User pool ID, Client ID, Client secret, Domain and Allowed callback URLs ===<br />
<br />
==== Step 4.1: Copy region and User pool ID ====<br />
User pool: GardenWorld > App integration<br />
<br />
Get the region from the Token signing key URL. Token signing key URL format - <nowiki>https://cognito-idp</nowiki>.[region].amazonaws.com/[userPoolId]/.well-known/jwks.json.<br />
<br />
Copy the User pool ID<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 4 1.png]]<br />
<br />
==== Step 4.2: Copy Client ID and Client secret ====<br />
User pool: GardenWorld > App integration > App client: iDempiere Web Client<br />
<br />
Copy the Client ID and Client secret<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 4 2.png]]<br />
<br />
==== Step 4.3: Copy Domain ====<br />
''Note: Cognito domain is required for Authorization Code Grant authorization flow''<br />
<br />
User pool: GardenWorld > App integration > Domain<br />
<br />
Copy Domain<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 4 3.png]]<br />
<br />
==== Step 4.4: Copy Allowed callback URLs and Hosted UI link address ====<br />
''Note: Allowed callback URL is required for Authorization Code Grant authorization flow''<br />
<br />
User pool: GardenWorld > App integration > App client: iDempiere Web Client > Hosted UI<br />
<br />
Copy Allowed callback URLs<br />
<br />
Right-click on the View Hosted UI button to Copy link address<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 4 4.png]]<br />
<br />
=== Step 5: Pre Token Generation Lambda trigger (Optional) ===<br />
User attributes such as email, phone number etc. are included in the ID Token instead of Access Token. <br />
<br />
You have to set up a Pre Token Generation Lambda trigger to add custom claims (such as user email, phone number etc.) to the Access Token. Customization of Access Token requires user to turn on the Advanced security features.<br />
<br />
== Rest OpenID Connect Service configuration ==<br />
iDempiere Web Client > Tenant: GardenWorld > Rest OpenID Connect Service<br />
<br />
Authority URL format - <nowiki>https://cognito-idp</nowiki>.[region].amazonaws.com/[userPoolId]<br />
<br />
Audience - User pool: GardenWorld > App integration > App client: iDempiere Web Client > Client ID<br />
<br />
Authorization - when checked the integration will verify the roles vs the groups configured on Cognito, when unchecked the roles assignment is completely managed on iDempiere<br />
<br />
[[File:Amazon Cognito Testing Rest OpenID Connect Service.png]]<br />
<br />
== Generate Secret Hash ==<br />
''Note: Secret Hash is required for Resource Owner Password Credentials (ROPC) authorization flow''<br />
<br />
* Combine the User name and Client ID into a single string<br />
* Hash the combined string using the HMAC-SHA256 algorithm and the client secret as the key<br />
* Base64 encode the resulting hash<br />
<br />
For example, to generate the hash using a linux CLI:<br />
USERNAME=<cognito user pool username><br />
CLIENT_ID=<your client_id><br />
CLIENT_SECRET=<your client secret><br />
SECRET_HASH=$(echo -n $USERNAME$CLIENT_ID | openssl sha256 -binary -mac HMAC -macopt key:$CLIENT_SECRET | base64)<br />
echo $SECRET_HASH<br />
<br />
Alternatively for testing you can use an online generator like this: https://www.devglan.com/online-tools/hmac-sha256-online<br />
<br />
== Testing using Postman ==<br />
<br />
* Import amazon-cognito-oidc-test.postman_collection.json and environment-http---localhost-8080.postman_environment.json to Postman<br />
* Set variable value<br />
** cognitoDomain - Get Domain value from User pool configuration > Step 4.3 (for Authorization Code Grant flow only)<br />
** cognitoRegion - Get region value from User pool configuration > Step 4.1<br />
** cognitoClientId - Get Client ID value from User pool configuration > Step 4.1<br />
** cognitoSecret - Get Client secret value from User pool configuration > Step 4.1 <br />
** cognitoRedirectUri - Get Allowed callback URL from User pool configuration > Step 4.4 (for Authorization Code Grant flow only)<br />
** cognitoUsername - User name of User pool: GardenWorld > Users > User: GardenAdmin (for Resource Owner Password Credentials flow only)<br />
** cognitoPassword - Password of User pool: GardenWorld > Users > User: GardenAdmin (for Resource Owner Password Credentials flow only)<br />
** cognitoSecretHash - Get the generated secret hash from Generate Secret Hash (for Resource Owner Password Credentials flow only)<br />
<br />
=== Authentication Flow 1: Authorization Code Grant ===<br />
===== Step 1: Get New Access Token =====<br />
At the '''Authorization''' tab, click '''Get New Access Token'''<br />
# Postman Desktop, uncheck '''Authorize using browser''', use '''https://oauth.pstmn.io/v1/callback''' for callback url<br />
# Postman Web, callback url is fix as '''https://oauth.pstmn.io/v1/browser-callback'''<br />
# VSCode Postman Extension, callback url is fix as '''https://oauth.pstmn.io/v1/vscode-callback'''<br />
# Depends on the type of Postman client you are using, add the corresponding callback url to Cognito's allowed callback url list<br />
<br/><br />
[[File:Postman OAuth2 Get New Access Token.png|400x400px|frameless|Postman OAuth2 Get New Access Token]]<br />
<br />
===== Step 2: Cognito Login =====<br />
'''Get New Access Token''' will open the login dialog for Cognito<br />
<br />
[[File:Cognito Sign In.png|400x400px|frameless|Cognito Sign In]]<br />
<br />
===== Step 3: Use Token =====<br />
Upon successful authentication, click '''Proceed''' to open the '''MANAGE ACCESS TOKENS''' dialog. Click '''Use Token''' to use the return access token<br />
<br />
[[File:Postman Authorization Use Token.png|400x400px|frameless|Postman Authorization Use Token]]<br />
<br />
After execution of '''Use Token''', Access Token is the current token for Bearer Authorization<br />
<br />
[[File:Postman Authorization Current Access Token.png|400x400px|frameless|Postman Authorization Current Access Token]]<br />
<br />
===== Step 4: Send Request =====<br />
''Notes:'' <br />
<br />
* ''X-ID-Role is required if user has more than one role access''<br />
* ''X-ID-Organization is required if user + role has more than one organization access''<br />
<br/><br />
[[File:Postman OAuth2 Send Request.png|400x400px|frameless|Postman OAuth2 Send Request]]<br />
<br />
==== Authentication Flow 2: Resource Owner Password Credentials (ROPC) ====<br />
For ROPC flow, the access token is not OpenID scope, therefore cannot be used to access the endpoints return from well known configuration URL.<br />
<br />
===== Step 1: Get Token =====<br />
[[File:Amazon Cognito Testing Postman Step 1 2 1.png]]<br />
<br />
===== Step 2: Refresh Token =====<br />
[[File:Amazon Cognito Testing Postman Step 1 2 2.png]]<br />
<br />
===== Step 3.1: Get tax records where C_TaxCategory_ID=107 =====<br />
''Notes:'' <br />
<br />
* ''X-ID-IdToken is required if iDempiere is configured to use email to login and email information is not included in the Access Token (for Resource Owner Password Credentials flow only)''<br />
* ''X-ID-Role is required if user has more than one role access''<br />
* ''X-ID-Organization is required if user + role has more than one organization access''<br />
<br />
[[File:Amazon Cognito Testing Postman Step 2 1.png]]<br />
<br />
==== Step 3.2: Get document no and description of the order records ====<br />
''Notes:'' <br />
<br />
* ''X-ID-IdToken is required if iDempiere is configured to use email to login and email information is not included in the Access Token (for Resource Owner Password Credentials flow only)''<br />
* ''X-ID-Role is required if user has more than one role access''<br />
* ''X-ID-Organization is required if user + role has more than one organization access''<br />
<br />
[[File:Amazon Cognito Testing Postman Step 2 2.png]]</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=OIDC_SSO_Amazon_Cognito_Testing_Steps&diff=23483OIDC SSO Amazon Cognito Testing Steps2025-08-21T02:50:50Z<p>Hengsin: /* Testing using Postman */</p>
<hr />
<div><br />
== Create user pool ==<br />
Amazon Cognito https://console.aws.amazon.com/cognito/home > User pools > Create user pool<br />
<br />
=== Step 1: Select Cognito user pool provider type ===<br />
'''IMPORTANT NOTES:'''<br />
<br />
* if you are planning to use EMail authentication with iDempiere then select EMail as the '''ONLY''' attribute for sign in, otherwise you won't be able to create your users based on emails<br />
* if you are planning to use Name as authentication you can select both User Name + EMail, but make sure that you check "Make user case sensitive", otherwise you won't be able to create GardenAdmin as user (it will end and gardenadmin and the REST integration won't work)<br />
<br />
[[File:Amazon Cognito Testing Step 1.png]]<br />
<br />
=== Step 2: Configure password and authentication policy ===<br />
[[File:Amazon Cognito Testing Step 2.png]] ===<br />
<br />
=== Step 3: Configure sign-up experience ===<br />
[[File:Amazon Cognito Testing Step 3.png]]<br />
<br />
=== Step 4: Configure email and SMS delivery ===<br />
[[File:Amazon Cognito Testing Step 4.png]]<br />
<br />
=== Step 5: Integrate app ===<br />
<br />
==== Step 5.1: Setup integration with app ====<br />
[[File:Amazon Cognito Testing Step 5 1.png]]<br />
<br />
==== Step 5.2: Setup Cognito domain ====<br />
[[File:Amazon Cognito Testing Step 5 2.png]]<br />
<br />
==== Step 5.3: Select Confidential client, enter app client name and select Generate a client secret ====<br />
[[File:Amazon Cognito Testing Step 5 3.png]]<br />
<br />
==== Step 5.4: Enter callback URLs ====<br />
[[File:Amazon Cognito Testing Step 5 4.png]]<br />
<br />
==== Step 5.5: Add ALLOW_USER_PASSWORD_AUTH to Authentication flows ====<br />
[[File:Amazon Cognito Testing Step 5 5.png]]<br />
<br />
==== Step 5.6: Add Profile to Open ID Connect scopes ====<br />
[[File:Amazon Cognito Testing Step 5 6.png]]<br />
<br />
== User pool configuration ==<br />
<br />
=== Step 1: Create user ===<br />
User pool: GardenWorld > Users > Create user<br />
<br />
''Notes:'' <br />
<br />
* ''User name = iDempiere user (AD_User.Name)''<br />
* ''Email address = iDempiere user (AD_User.EMail)''<br />
* ''User has to login for the first time using the temporary password to change new password''<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 1.png]]<br />
<br />
=== Step 2: Create group (Optional) ===<br />
NOTE this step and the next are optional, not required if you uncheck the "Authorization" flag in the iDempiere "Rest OpenID Connect Service configuration" explaned below.<br />
<br />
User pool: GardenWorld > Groups > Create group<br />
<br />
''Note: Group name = iDempiere role (AD_Role.Name) without space''<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 2.png]]<br />
<br />
=== Step 3: Add user to group ===<br />
User pool: GardenWorld > Groups > Group: GardenWorldAdmin > Add user to group<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 3.png]]<br />
<br />
=== Step 4: Get region, User pool ID, Client ID, Client secret, Domain and Allowed callback URLs ===<br />
<br />
==== Step 4.1: Copy region and User pool ID ====<br />
User pool: GardenWorld > App integration<br />
<br />
Get the region from the Token signing key URL. Token signing key URL format - <nowiki>https://cognito-idp</nowiki>.[region].amazonaws.com/[userPoolId]/.well-known/jwks.json.<br />
<br />
Copy the User pool ID<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 4 1.png]]<br />
<br />
==== Step 4.2: Copy Client ID and Client secret ====<br />
User pool: GardenWorld > App integration > App client: iDempiere Web Client<br />
<br />
Copy the Client ID and Client secret<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 4 2.png]]<br />
<br />
==== Step 4.3: Copy Domain ====<br />
''Note: Cognito domain is required for Authorization Code Grant authorization flow''<br />
<br />
User pool: GardenWorld > App integration > Domain<br />
<br />
Copy Domain<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 4 3.png]]<br />
<br />
==== Step 4.4: Copy Allowed callback URLs and Hosted UI link address ====<br />
''Note: Allowed callback URL is required for Authorization Code Grant authorization flow''<br />
<br />
User pool: GardenWorld > App integration > App client: iDempiere Web Client > Hosted UI<br />
<br />
Copy Allowed callback URLs<br />
<br />
Right-click on the View Hosted UI button to Copy link address<br />
<br />
[[File:Amazon Cognito Testing User Pool Step 4 4.png]]<br />
<br />
=== Step 5: Pre Token Generation Lambda trigger (Optional) ===<br />
User attributes such as email, phone number etc. are included in the ID Token instead of Access Token. <br />
<br />
You have to set up a Pre Token Generation Lambda trigger to add custom claims (such as user email, phone number etc.) to the Access Token. Customization of Access Token requires user to turn on the Advanced security features.<br />
<br />
== Rest OpenID Connect Service configuration ==<br />
iDempiere Web Client > Tenant: GardenWorld > Rest OpenID Connect Service<br />
<br />
Authority URL format - <nowiki>https://cognito-idp</nowiki>.[region].amazonaws.com/[userPoolId]<br />
<br />
Audience - User pool: GardenWorld > App integration > App client: iDempiere Web Client > Client ID<br />
<br />
Authorization - when checked the integration will verify the roles vs the groups configured on Cognito, when unchecked the roles assignment is completely managed on iDempiere<br />
<br />
[[File:Amazon Cognito Testing Rest OpenID Connect Service.png]]<br />
<br />
== Generate Secret Hash ==<br />
''Note: Secret Hash is required for Resource Owner Password Credentials (ROPC) authorization flow''<br />
<br />
* Combine the User name and Client ID into a single string<br />
* Hash the combined string using the HMAC-SHA256 algorithm and the client secret as the key<br />
* Base64 encode the resulting hash<br />
<br />
For example, to generate the hash using a linux CLI:<br />
USERNAME=<cognito user pool username><br />
CLIENT_ID=<your client_id><br />
CLIENT_SECRET=<your client secret><br />
SECRET_HASH=$(echo -n $USERNAME$CLIENT_ID | openssl sha256 -binary -mac HMAC -macopt key:$CLIENT_SECRET | base64)<br />
echo $SECRET_HASH<br />
<br />
Alternatively for testing you can use an online generator like this: https://www.devglan.com/online-tools/hmac-sha256-online<br />
<br />
== Testing using Postman ==<br />
<br />
* Import amazon-cognito-oidc-test.postman_collection.json and environment-http---localhost-8080.postman_environment.json to Postman<br />
* Set variable value<br />
** cognitoDomain - Get Domain value from User pool configuration > Step 4.3 (for Authorization Code Grant flow only)<br />
** cognitoRegion - Get region value from User pool configuration > Step 4.1<br />
** cognitoClientId - Get Client ID value from User pool configuration > Step 4.1<br />
** cognitoSecret - Get Client secret value from User pool configuration > Step 4.1 <br />
** cognitoRedirectUri - Get Allowed callback URL from User pool configuration > Step 4.4 (for Authorization Code Grant flow only)<br />
** cognitoUsername - User name of User pool: GardenWorld > Users > User: GardenAdmin (for Resource Owner Password Credentials flow only)<br />
** cognitoPassword - Password of User pool: GardenWorld > Users > User: GardenAdmin (for Resource Owner Password Credentials flow only)<br />
** cognitoSecretHash - Get the generated secret hash from Generate Secret Hash (for Resource Owner Password Credentials flow only)<br />
<br />
=== Step 1: Get and Refresh Token ===<br />
There are two authentication flows used to get token and refresh token: Authorization Code Grant and Resource Owner Password Credentials (ROPC).<br />
<br />
For ROPC flow, the access token is not OpenID scope, therefore cannot be used to access the endpoints return from well known configuration URL.<br />
<br />
==== Step 1.1: Authorization Code Grant ====<br />
<br />
===== Step 1.1.1: Get New Access Token =====<br />
At the '''Authorization''' tab, click '''Get New Access Token'''<br />
# Postman Desktop, uncheck '''Authorize using browser''', use '''https://oauth.pstmn.io/v1/callback''' for callback url<br />
# Postman Web, callback url is fix as '''https://oauth.pstmn.io/v1/browser-callback'''<br />
# VSCode Postman Extension, callback url is fix as '''https://oauth.pstmn.io/v1/vscode-callback'''<br />
# Depends on the type of Postman client you are using, add the corresponding callback url to Cognito's allowed callback url list<br />
<br/><br />
[[File:Postman OAuth2 Get New Access Token.png|400x400px|frameless|Postman OAuth2 Get New Access Token]]<br />
<br />
===== Step 1.1.2: Cognito Login =====<br />
'''Get New Access Token''' will open the login dialog for Cognito<br />
<br />
[[File:Cognito Sign In.png|400x400px|frameless|Cognito Sign In]]<br />
<br />
===== Step 1.1.3: Use Token =====<br />
Upon successful authentication, click '''Proceed''' to open the '''MANAGE ACCESS TOKENS''' dialog. Click '''Use Token''' to use the return access token<br />
<br />
[[File:Postman Authorization Use Token.png|400x400px|frameless|Postman Authorization Use Token]]<br />
<br />
After execution of '''Use Token''', Access Token is the current token for Bearer Authorization<br />
<br />
[[File:Postman Authorization Current Access Token.png|400x400px|frameless|Postman Authorization Current Access Token]]<br />
<br />
===== Step 1.1.4: Send Request =====<br />
<br />
[[File:Postman OAuth2 Send Request.png|400x400px|frameless|Postman OAuth2 Send Request]]<br />
<br />
==== Step 1.2: Resource Owner Password Credentials (ROPC) ====<br />
<br />
===== Step 1.2.1: Get Token =====<br />
[[File:Amazon Cognito Testing Postman Step 1 2 1.png]]<br />
<br />
===== Step 1.2.2: Refresh Token =====<br />
[[File:Amazon Cognito Testing Postman Step 1 2 2.png]]<br />
<br />
=== Step 2: Sample REST requests ===<br />
<br />
==== Step 2.1: Get tax records where C_TaxCategory_ID=107 ====<br />
''Notes:'' <br />
<br />
* ''X-ID-IdToken is required if iDempiere is configured to use email to login and email information is not included in the Access Token (for Resource Owner Password Credentials flow only)''<br />
* ''X-ID-Role is required if user has more than one role access''<br />
* ''X-ID-Organization is required if user + role has more than one organization access''<br />
<br />
[[File:Amazon Cognito Testing Postman Step 2 1.png]]<br />
<br />
==== Step 2.2: Get document no and description of the order records ====<br />
''Notes:'' <br />
<br />
* ''X-ID-IdToken is required if iDempiere is configured to use email to login and email information is not included in the Access Token (for Resource Owner Password Credentials flow only)''<br />
* ''X-ID-Role is required if user has more than one role access''<br />
* ''X-ID-Organization is required if user + role has more than one organization access''<br />
<br />
[[File:Amazon Cognito Testing Postman Step 2 2.png]]</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=File:Postman_OAuth2_Get_New_Access_Token.png&diff=23482File:Postman OAuth2 Get New Access Token.png2025-08-21T02:43:53Z<p>Hengsin: </p>
<hr />
<div>Postman OAuth2 Get New Access Token</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=File:Postman_OAuth2_Send_Request.png&diff=23481File:Postman OAuth2 Send Request.png2025-08-21T02:31:02Z<p>Hengsin: </p>
<hr />
<div>Postman OAuth2 Send Request</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=File:Postman_Authorization_Current_Access_Token.png&diff=23480File:Postman Authorization Current Access Token.png2025-08-21T02:24:51Z<p>Hengsin: </p>
<hr />
<div>Postman Authorization Current Access Token</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=File:Postman_Authorization_Use_Token.png&diff=23479File:Postman Authorization Use Token.png2025-08-21T02:22:03Z<p>Hengsin: </p>
<hr />
<div>Postman Authorization Use Token</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=File:Cognito_Sign_In.png&diff=23478File:Cognito Sign In.png2025-08-21T02:19:31Z<p>Hengsin: </p>
<hr />
<div>Cognito Sign In</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=File:Postman_Authorization_Get_New_Access_Token.png&diff=23477File:Postman Authorization Get New Access Token.png2025-08-21T02:17:04Z<p>Hengsin: </p>
<hr />
<div>Postman Authorization Get New Access Token</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=REST_Web_Services&diff=23434REST Web Services2025-07-22T10:59:34Z<p>Hengsin: </p>
<hr />
<div>* '''Maintainers:''' [http://www.bx-service.com BX Service GmbH] team<br />
* '''Status:''' used in production, up to date with release 11 and master<br />
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2]<br />
* '''Sources:''' https://github.com/bxservice/idempiere-rest<br />
* '''Continuous Integration:''' https://jenkins.idempiere.org/job/idempiere-rest/ (installation instructions)<br />
* '''Swagger UI:''' https://hengsin.github.io/idempiere-rest-swagger-ui<br />
<br />
= Introduction =<br />
The iDempiere REST API is a plugin that allows developers to communicate with an iDempiere server via a RESTful API. This information is delivered via HTTP using JSON. <br />
<br />
The iDempiere REST API seeks to follow the OData standard and uses the following structure and endpoints.<br />
<br />
You can find examples of every call in the [https://github.com/bxservice/idempiere-rest/tree/master/com.trekglobal.idempiere.rest.api/postman postman collection sample files in the official repository].<br />
<br />
= Global URL parameters =<br />
<br />
* '''locale:''' in any call you can use the URL parameter locale <code>?locale={locale}</code> to define the language. For example adding <code>?locale=es_CO</code> to the login URL <code>api/v1/auth/tokens</code> will return any error message in Spanish.<br />
<br />
= Login in to get your Bearer authorization token =<br />
<br />
'''Properties:'''<br />
<br />
* '''userName:'''The user name being authenticated, here you would need to use the user Name or the EMail depending on the [[System Configurator (Window ID-50006)#USE EMAIL FOR LOGIN|SysConfig USE_EMAIL_FOR_LOGIN]]<br />
* '''password:''' the password of the user being authenticated<br />
* parameters:<br />
** '''clientId:''' the client ID from AD_Client, here you can use the AD_Client_ID or the Value for authentication<br />
** '''roleId:''' the role ID from AD_Role, here you can use the AD_Role_ID or the role Name for authentication<br />
** '''organizationId:''' the organization ID from AD_Org, here you can use the AD_Org_ID or the organization Name for authentication<br />
** '''warehouseId:''' the warehouse ID from M_Warehouse, here you can use the M_Warehouse_ID or the warehouse Name for authentication<br />
** '''language:''' the language for the session, as defined in AD_Language.AD_Language<br />
<br />
<br />
'''IMPORTANT:''' REST API just allows to log in to roles with Role Type = WebService, or without Role Type. This means by default is not possible to login with role System, you need to clear the Role Type in System, or even better create a WebService role for System tenant.<br />
<br />
There are two ways to log in to get your authorization token:<br />
<br />
== One-step log-in ==<br />
<br />
When you know beforehand all the login information needed to get into the system, you need to do a POST request to the following endpoint<br />
<br><br />
<code>.../api/v1/auth/tokens</code><br />
<br />
With a body like this:<br />
<syntaxhighlight lang="json"><br />
{<br />
"userName": "{{userName}}",<br />
"password": "{{password}}",<br />
"parameters": {<br />
"clientId": {{clientId}},<br />
"roleId": {{roleId}},<br />
"organizationId": {{organizationId}},<br />
"warehouseId": {{warehouseId}},<br />
"language": "{{language}}"<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
''Change all the {{propertyname}} values to the ones you want to use in your instance.''<br />
<br />
== Normal log-in ==<br />
<br />
If you want to log in as a user would normally do in iDempiere (choosing a role, warehouse, client, etc), you need to do the following requests<br />
<br />
<code>POST .../api/v1/auth/tokens</code><br />
<br><br />
Body:<br />
<syntaxhighlight lang="json"><br />
{<br />
"userName": "{{userName}}",<br />
"password": "{{password}}"<br />
}<br />
</syntaxhighlight><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"clients": [<br />
{<br />
"id": 11,<br />
"name": "GardenWorld"<br />
}<br />
],<br />
"token": "eyJraWQiOiJpZGVtcGllcmUiLCJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJHYXJkZW5BZG1pbiIsImlzcyI6ImlkZW1waWVyZS5vcmciLCJDbGllbnRzIjoiMTEiLCJleHAiOjE2NjY5NjQ5Mjh9.3t0MuK6ReF7xNmb36ITM36VSKI5QnK3n0ZF_LIgPQSrso4oRhDsL8Mudc0NqH4qjvvKDlYsPquYKtrHnB5UiZg"<br />
}<br />
</syntaxhighlight><br />
<br />
With that token you can request for login information from the user that is being authenticated. You need to add it to the request Header with Key value as:<br><br />
<code> Authorization: Bearer {authToken}</code><br />
<br />
The information you can request is the following, and it needs to be done in this order because each request needs information from the previous call:<br><br />
<code>GET .../api/v1/auth/roles?client={clientId}</code><br />
::Returns an array with the roles that the user has access to<br />
<br><br />
<code>GET .../api/v1/auth/organizations?client={clientId}&role={roleId}</code><br />
::Returns an array with the organizations that the user has access to.<br />
<br><br />
<code>/api/v1/auth/warehouses?client={clientId}&role={roleId}&organization={organizationId}</code><br />
::Returns an array with the warehouses that the user has access to.<br />
<br><br />
<code>GET .../api/v1/auth/language?client={clientId}</code><br />
::Returns an array with the languages the user can login with.<br />
<br><br />
When you have all the data you need to do a final PUT request like this:<br />
<br />
<code>PUT .../api/v1/auth/tokens</code><br />
<br />
Body:<br />
<syntaxhighlight lang="json"><br />
{<br />
"clientId": {clientId},<br />
"roleId": {roleId},<br />
"organizationId": {organizationId},<br />
"warehouseId": {warehouseId},<br />
"language": "{language}"<br />
}<br />
</syntaxhighlight><br />
<br />
* ''The language, organizationId and warehouseId properties are optional, it can be omitted and the system will use the default language and 0 for the organization.''<br />
<br />
* ''If the warehouseId property is omitted the system assigns by default the warehouse defined for the organization, if the warehouse is passed as 0, then the login doesn't assign a default warehouse.''<br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"userId": 101,<br />
"language": "en_US",<br />
"token": "eyJraWQiOiJpZGVtcGllcmUiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHYXJkZW5BZG1pbiIsIkFEX0NsaWVudF9JRCI6MTEsIkFEX1VzZXJfSUQiOjEwMSwiQURfUm9sZV9JRCI6MjAwMDAxLCJBRF9PcmdfSUQiOjExLCJNX1dhcmVob3VzZV9JRCI6MTAzLCJBRF9MYW5ndWFnZSI6ImVuX1VTIiwiQURfU2Vzc2lvbl9JRCI6MTAwMDE2MiwiaXNzIjoiaWRlbXBpZXJlLm9yZyIsImV4cCI6MTcwMTc3NTUzN30.bAUEhPylAQhZjZquJhvLpO9zMZG3g6zlM_IqO9ifeXJpAJBOoJtDqd8CrYPU1PKURzoPRSUglbKqr1LsXdz38A",<br />
"refresh_token": "eyJraWQiOiJpZGVtcGllcmUiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIwODk1OTIyNC1iYzBhLTRkNTQtOTlhZS1jNmRmZjNiOGEwMzUiLCJpc3MiOiJpZGVtcGllcmUub3JnIiwiZXhwIjoxNzAxODU4MzM3fQ.uSE5SOtWgPvReC4JtyV4alHd-ccU0L9QhIpP2TwT7C5TJFeCGVYTdyWc291DaIweyiIGCfWFgQlbe0oH1EEXXg"<br />
}<br />
</syntaxhighlight><br />
<br />
= Abbreviated log-in =<br />
The <code>POST .../api/v1/auth/tokens</code> operation described above can be sufficient for a login when the user has only access to one client, one role and one organization. In this case the POST operation returns immediately the token and refresh_token and the payload includes the values that were assumed for the login.<br />
<br />
= Refresh Token =<br />
<br />
As you see above, the login process returns a token and a refresh_token, normally the token expires in 1 hour and the refresh_token expires in 24 hours. These expiration defaults can be changed using SysConfig keys REST_TOKEN_EXPIRE_IN_MINUTES and REST_REFRESH_TOKEN_EXPIRE_IN_MINUTES.<br />
<br />
It is a common practice in front-end development to store the refresh_token in a cookie or browser data, while keeping the token itself just in memory. This approach is taken due to the sensitive nature of the information contained within the token, which must not be disclosed.<br />
<br />
When the token expires, you can get a new token calling the following request:<br />
<br />
<code>POST .../api/v1/auth/refresh</code><br />
<br><br />
Body:<syntaxhighlight lang="json"><br />
{<br />
"refresh_token": "{{refreshToken}}",<br />
"clientId": {{clientId}},<br />
"userId": 101<br />
}<br />
</syntaxhighlight><br />
<br />
Note that clientId and userId are recommended, but optional, it can be disabled with the SysConfig keys REST_MANDATORY_CLIENT_ID_ON_REFRESH=N and REST_MANDATORY_USER_ID_ON_REFRESH=N<br />
<br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"token": "eyJraWQiOiJpZGVtcGllcmUiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHYXJkZW5BZG1pbiIsIkFEX0NsaWVudF9JRCI6MTEsIkFEX1VzZXJfSUQiOjEwMSwiQURfUm9sZV9JRCI6MTAyLCJBRF9PcmdfSUQiOjExLCJNX1dhcmVob3VzZV9JRCI6MTAzLCJBRF9MYW5ndWFnZSI6ImVuX1VTIiwiQURfU2Vzc2lvbl9JRCI6MTAwMDIyMCwiaXNzIjoiaWRlbXBpZXJlLm9yZyIsImV4cCI6MTczMDgxNTUwM30.MzmpXlpuIUjKkYdKi2G50ORcSt2FcLT4-x-OO1LVzDDoO8lNm7P9ELaWWViKktOzN_pKtocIA59LlXzXBmWVtA",<br />
"refresh_token": "eyJraWQiOiJpZGVtcGllcmUiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiZTQ3Zjg4YjkyMmU5MzU5NzEwNmRlNWIwOGQ1ZDljMjk3OTQxMzNkNjYxMWFjOWZkMmI1NGE5NWExODFjNDIxIiwiaXNzIjoiaWRlbXBpZXJlLm9yZyJ9.efa6M1oOb_QDnSKopNsdDygd1fF3S-ozr3DXjn1qANyPEVK-kg3Y2anGXrqQCtUzmxWBi8eTY4C6r5wXY6jtFA"<br />
}<br />
</syntaxhighlight><br />
<br />
The new tokens are set with new expiration times as configured.<br />
<br />
Refresh tokens can be expired (deleted) using the process "Expire Refresh Tokens"<br />
<br />
A refresh token can be used just one time. If a refresh token tries to be used a second time a potential breach is set on the system and all the tokens associated with the refresh token are invalidated.<br />
<br />
= Logout =<br />
<br />
Logout a session from a token.<br />
<br />
<code>POST .../api/v1/auth/logout</code><br />
<br><br />
Body:<syntaxhighlight lang="json"><br />
{<br />
"token": "{{authToken}}"<br />
}<br />
</syntaxhighlight><br />
<br />
The session associated to the token will be logged out.<br />
<br />
This token cannot be used again, neither the refresh token associated.<br />
<br />
= Common Headers =<br />
<br />
* Content-Type: application/json<br />
* Accept: application/json<br />
* Authorization: Bearer {authToken}<br />
** All calls except the first one (POST/auth) require an authorization bearer that is returned by the /auth APIs from the previous steps.<br />
<br />
= Requesting Data =<br />
<br />
iDempiere supports requests for data via HTTP '''GET''' requests.<br />
<br />
On every get request the response will include this information, in addition to the one requested:<br />
* id: the record ID<br />
* uid: the UUID of the record<br />
* model-name: the table name of the record<br />
* {columnname}: each pair of column/value is represented as a json object with the columnname:<br />
** String: strings are represented directly as a json string quoted value<br />
** Yes/No: these are represented as true/false<br />
** Numbers: numbers are represented as a json number without quotes<br />
** Dates/Times: timestamp values are represented as a json date (quoted string with format [https://en.wikipedia.org/wiki/ISO_8601 ISO_8601]<br />
** Foreign keys: these are represented as a json object with the following values:<br />
*** propertyLabel -> the foreign name<br />
*** id -> the foreign record ID<br />
*** identifier -> the foreign identifier<br />
*** model-name -> the foreign table name<br />
** Binary: binary columns are represented directly as a json string base64 encoded value<br />
** Images: these are represented as a json object with the following values:<br />
*** propertyLabel -> the foreign name<br />
*** id -> the foreign record ID<br />
*** data -> a string containing the base64 encoded data for the image<br />
*** model-name -> the foreign table name<br />
<br />
== Requesting PO Collections ==<br />
The request below returns the collection of taxes.<br />
<code>GET /api/v1/models/c_tax</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 4,<br />
"records-size": 2,<br />
"skip-records": 0,<br />
"row-count": 8,<br />
"array-count": 2,<br />
"records": [<br />
{<br />
"id": 106,<br />
"uid": "315dacb1-415c-45e7-8dac-a9a44fa8aca7",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2003-01-08T13:14:01Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "GST",<br />
"Description": "Canadian Federal Sales Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2003-02-22T02:20:37Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 0,<br />
"identifier": "~System (deprecated)~",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "2001-01-01",<br />
"IsSummary": false,<br />
"Rate": 7,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "GST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": false,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
},<br />
{<br />
"id": 107,<br />
"uid": "d76b09c5-531b-4f98-a8c6-9af848b6697b",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2003-01-08T15:06:11Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "PST",<br />
"Description": "Canadian Provintial Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2003-02-22T02:20:37Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 0,<br />
"identifier": "~System (deprecated)~",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "2002-01-01",<br />
"IsSummary": false,<br />
"Rate": 7.5,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "PST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": false,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Requesting an Individual PO by ID ==<br />
The request below returns an individual PO of type tax by the given id "106".<br />
''* You can use here either record id or the UUID (C_Tax_ID or C_Tax_UU value)''<br />
<br />
<code>GET /api/v1/models/c_tax/106</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 106,<br />
"uid": "315dacb1-415c-45e7-8dac-a9a44fa8aca7",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2003-01-08T13:14:01Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "GST",<br />
"Description": "Canadian Federal Sales Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2003-02-22T02:20:37Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 0,<br />
"identifier": "~System (deprecated)~",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "2001-01-01",<br />
"IsSummary": false,<br />
"Rate": 7,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "GST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": false,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
}<br />
</syntaxhighlight><br />
<br />
== Requesting an Individual Property ==<br />
To address an entity property clients append a path segment containing property name to the URL of the entity.<br />
The request below returns the Rate property of a tax.<br />
<code>GET /api/v1/models/c_tax/106/rate</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 106,<br />
"uid": "315dacb1-415c-45e7-8dac-a9a44fa8aca7",<br />
"Rate": 7,<br />
"model-name": "c_tax"<br />
}<br />
</syntaxhighlight><br />
<br />
= Querying Data =<br />
<br />
iDempiere supports various kinds of query options for querying data. This section will help you go through the common scenarios for these query options.<br />
<br />
== Query Option $filter ==<br />
The <code>$filter</code> query option allows developers to filter a collection of resources that are addressed by a request URL. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. These are the basic predicates that are supported:<br />
<br />
* $filter<br />
** Logical operators<br />
*** eq -> equals =<br />
*** neq -> not equals !=<br />
*** in -> IN<br />
*** gt -> greater than ><br />
*** ge -> greater or equal >=<br />
*** lt -> less than <<br />
*** le -> less or equal <=<br />
*** and -> &<br />
*** or -> |<br />
*** not -> !<br />
** Method operators (WARNING: there must not be spaces before/after the parameters on these functions, strings must be surrounded by single quotes):<br />
*** contains -> if a string contains another string<br />
*** startswith -> if a string starts with another string<br />
*** endswith -> if a string ends with another string<br />
*** tolower -> convert a string to lowercase<br />
*** toupper -> convert a string to uppercase<br />
** Parenthesis are supported<br />
<br />
== Examples ==<br />
The request below using $filter to get business partners where IsCustomer = true and IsActive = true and the name starts with 'Pa'<br />
<code>GET /api/v1/models/c_bpartner?$filter=isCustomer eq true AND isActive eq true AND startswith(name,'Pa') AND C_BPartner_ID in (120,121)</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 1,<br />
"records-size": 3,<br />
"skip-records": 0,<br />
"row-count": 1,<br />
"array-count": 1,<br />
"records": [<br />
{<br />
"id": 121,<br />
"uid": "39e85feb-94a2-4e41-ae45-e7d49d7be077",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2003-01-13T10:14:03Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2020-11-11T13:16:05Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Value": "Patio",<br />
"Name": "Patio Fun, Inc.",<br />
"SalesVolume": 0,<br />
"NumberEmployees": 0,<br />
"IsSummary": false,<br />
"AD_Language": {<br />
"propertyLabel": "Language",<br />
"id": "es_CO",<br />
"identifier": "Spanish (Colombia)",<br />
"model-name": "ad_language"<br />
},<br />
"IsVendor": true,<br />
"IsCustomer": true,<br />
"IsProspect": false,<br />
"FirstSale": "2020-11-05",<br />
"SO_CreditLimit": 0,<br />
"SO_CreditUsed": 588.24,<br />
"AcqusitionCost": 0,<br />
"PotentialLifeTimeValue": 0,<br />
"ActualLifeTimeValue": 588.24,<br />
"ShareOfCustomer": 0,<br />
"IsEmployee": false,<br />
"IsSalesRep": false,<br />
"IsOneTime": false,<br />
"IsTaxExempt": false,<br />
"IsDiscountPrinted": true,<br />
"C_BP_Group_ID": {<br />
"propertyLabel": "Business Partner Group",<br />
"id": 104,<br />
"identifier": "Vendors",<br />
"model-name": "c_bp_group"<br />
},<br />
"SendEMail": false,<br />
"SOCreditStatus": {<br />
"propertyLabel": "Credit Status",<br />
"id": "O",<br />
"identifier": "Credit OK",<br />
"model-name": "ad_ref_list"<br />
},<br />
"TotalOpenBalance": 588.240,<br />
"IsPOTaxExempt": false,<br />
"IsManufacturer": false,<br />
"Is1099Vendor": false,<br />
"IsUseTaxIdDigit": false,<br />
"IsDetailedNames": false,<br />
"model-name": "c_bpartner"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Query Option $expand ==<br />
iDempiere supports nested filters in <code>$expand</code>. <br />
<br />
The request below return Orders and all their Lines and Taxes.<br />
<code>GET /api/v1/models/c_order?$expand=c_orderLine,c_ordertax</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 68,<br />
"records-size": 1,<br />
"skip-records": 0,<br />
"row-count": 68,<br />
"array-count": 1,<br />
"records": [<br />
{<br />
"id": 1000019,<br />
"uid": "7144b00f-a283-465e-8d2d-1fe89eac5748",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 11,<br />
"identifier": "HQ",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-07-22T17:36:20Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-07-22T17:36:20Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"DocumentNo": "50012",<br />
"DocStatus": {<br />
"propertyLabel": "Document Status",<br />
"id": "DR",<br />
"identifier": "Drafted",<br />
"model-name": "ad_ref_list"<br />
},<br />
"C_DocType_ID": {<br />
"propertyLabel": "Document Type",<br />
"id": 0,<br />
"identifier": "** New **",<br />
"model-name": "c_doctype"<br />
},<br />
"C_DocTypeTarget_ID": {<br />
"propertyLabel": "Target Document Type",<br />
"id": 132,<br />
"identifier": "Standard Order",<br />
"model-name": "c_doctype"<br />
},<br />
"Description": "Order Description from Business Partner Definition",<br />
"IsApproved": true,<br />
"IsCreditApproved": false,<br />
"IsDelivered": false,<br />
"IsInvoiced": false,<br />
"IsPrinted": false,<br />
"IsTransferred": false,<br />
"DateOrdered": "2021-07-19",<br />
"DatePromised": "2021-07-19",<br />
"DateAcct": "2021-07-19",<br />
"SalesRep_ID": {<br />
"propertyLabel": "Sales Representative",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"C_PaymentTerm_ID": {<br />
"propertyLabel": "Payment Term",<br />
"id": 106,<br />
"identifier": "2%10 Net 30",<br />
"model-name": "c_paymentterm"<br />
},<br />
"C_Currency_ID": {<br />
"propertyLabel": "Currency",<br />
"id": 102,<br />
"identifier": "EUR",<br />
"model-name": "c_currency"<br />
},<br />
"InvoiceRule": {<br />
"propertyLabel": "Invoice Rule",<br />
"id": "I",<br />
"identifier": "Immediate",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightAmt": 0,<br />
"DeliveryViaRule": {<br />
"propertyLabel": "Delivery Via",<br />
"id": "P",<br />
"identifier": "Pickup",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PriorityRule": {<br />
"propertyLabel": "Priority",<br />
"id": "5",<br />
"identifier": "Medium",<br />
"model-name": "ad_ref_list"<br />
},<br />
"TotalLines": 14500,<br />
"GrandTotal": 14500,<br />
"M_Warehouse_ID": {<br />
"propertyLabel": "Warehouse",<br />
"id": 103,<br />
"identifier": "HQ Warehouse",<br />
"model-name": "m_warehouse"<br />
},<br />
"M_PriceList_ID": {<br />
"propertyLabel": "Price List",<br />
"id": 101,<br />
"identifier": "Standard",<br />
"model-name": "m_pricelist"<br />
},<br />
"C_BPartner_ID": {<br />
"propertyLabel": "Business Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"AD_User_ID": {<br />
"propertyLabel": "User/Contact",<br />
"id": 1000011,<br />
"identifier": "Carlitos Boss",<br />
"model-name": "ad_user"<br />
},<br />
"POReference": "Order Reference 1234",<br />
"ChargeAmt": 0,<br />
"Processed": false,<br />
"C_BPartner_Location_ID": {<br />
"propertyLabel": "Partner Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSOTrx": true,<br />
"DeliveryRule": {<br />
"propertyLabel": "Delivery Rule",<br />
"id": "A",<br />
"identifier": "Availability",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightCostRule": {<br />
"propertyLabel": "Freight Cost Rule",<br />
"id": "I",<br />
"identifier": "Freight included",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PaymentRule": {<br />
"propertyLabel": "Payment Rule",<br />
"id": "P",<br />
"identifier": "On Credit",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsDiscountPrinted": true,<br />
"IsTaxIncluded": false,<br />
"IsSelected": false,<br />
"SendEMail": false,<br />
"Bill_User_ID": {<br />
"propertyLabel": "Invoice Contact",<br />
"id": 1000011,<br />
"identifier": "Carlitos Boss",<br />
"model-name": "ad_user"<br />
},<br />
"Bill_BPartner_ID": {<br />
"propertyLabel": "Invoice Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"Bill_Location_ID": {<br />
"propertyLabel": "Invoice Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSelfService": false,<br />
"IsDropShip": false,<br />
"Volume": 0.00,<br />
"Weight": 0.00,<br />
"AmountTendered": 0.00,<br />
"AmountRefunded": 0.00,<br />
"ProcessedOn": 0,<br />
"IsPayScheduleValid": false,<br />
"IsPriviledgedRate": false,<br />
"NetAmtToInvoice": 0,<br />
"model-name": "c_order",<br />
"c_orderLine": [<br />
{<br />
"id": 1000033,<br />
"uid": "0b02614d-bdcd-406f-a9e6-5399ed3a9997",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 11,<br />
"identifier": "HQ",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-07-22T17:36:50Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-07-22T17:36:50Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Line": 10,<br />
"DateOrdered": "2021-07-19",<br />
"DatePromised": "2021-07-19",<br />
"M_Product_ID": {<br />
"propertyLabel": "Product",<br />
"id": 1000295,<br />
"identifier": "Poker_Poker",<br />
"model-name": "m_product"<br />
},<br />
"C_UOM_ID": {<br />
"propertyLabel": "UOM",<br />
"id": 109,<br />
"identifier": "6-Pack",<br />
"model-name": "c_uom"<br />
},<br />
"M_Warehouse_ID": {<br />
"propertyLabel": "Warehouse",<br />
"id": 103,<br />
"identifier": "HQ Warehouse",<br />
"model-name": "m_warehouse"<br />
},<br />
"QtyOrdered": 1,<br />
"QtyReserved": 0,<br />
"QtyDelivered": 0,<br />
"QtyInvoiced": 0,<br />
"C_Currency_ID": {<br />
"propertyLabel": "Currency",<br />
"id": 102,<br />
"identifier": "EUR",<br />
"model-name": "c_currency"<br />
},<br />
"PriceList": 14500,<br />
"PriceActual": 14500,<br />
"C_Tax_ID": {<br />
"propertyLabel": "Tax",<br />
"id": 104,<br />
"identifier": "Standard",<br />
"model-name": "c_tax"<br />
},<br />
"C_BPartner_ID": {<br />
"propertyLabel": "Business Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"FreightAmt": 0,<br />
"C_BPartner_Location_ID": {<br />
"propertyLabel": "Partner Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"LineNetAmt": 14500,<br />
"PriceLimit": 14500,<br />
"Discount": 0.00,<br />
"M_AttributeSetInstance_ID": {<br />
"propertyLabel": "Attribute Set Instance",<br />
"id": 0,<br />
"model-name": "m_attributesetinstance"<br />
},<br />
"IsDescription": false,<br />
"Processed": false,<br />
"PriceEntered": 14500,<br />
"QtyEntered": 1,<br />
"PriceCost": 0,<br />
"QtyLostSales": 0,<br />
"RRAmt": 0<br />
}<br />
]<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
You can add query operators ($filter, $orderyby, $top, $skip, $select) to the detail tables by adding the query operators between parentheses separated by ;.<br><br />
<br />
The request below returns Orders and their Lines (Line number and line net amount) from lines with linnetamt > 1000.<br><br />
<br />
<code>GET /api/v1/models/c_order?$select=DocumentNo,Description&$expand=C_OrderLine($select=Line,Linenetamt ; $filter=LineNetAmt gt 1000 ; $orderby=Line)&$top=5</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 14,<br />
"records-size": 5,<br />
"skip-records": 0,<br />
"row-count": 68,<br />
"array-count": 0,<br />
"records": [<br />
{<br />
"id": 1000019,<br />
"uid": "7144b00f-a283-465e-8d2d-1fe89eac5748",<br />
"DocumentNo": "50012",<br />
"Description": "Order Description from Business Partner Definition",<br />
"model-name": "c_order",<br />
"C_OrderLine": [<br />
{<br />
"id": 1000033,<br />
"uid": "0b02614d-bdcd-406f-a9e6-5399ed3a9997",<br />
"Line": 10,<br />
"LineNetAmt": 14500<br />
}<br />
]<br />
},<br />
{<br />
"id": 1000020,<br />
"uid": "470c98e0-5a19-413d-b589-89fc67272823",<br />
"DocumentNo": "50013",<br />
"Description": "MyCanadian Federal Sales Tax",<br />
"model-name": "c_order"<br />
},<br />
{<br />
"id": 1000018,<br />
"uid": "fb485eb0-6e79-439d-926f-cce53d76d806",<br />
"DocumentNo": "50011",<br />
"Description": "Order Description from Business Partner Definition",<br />
"model-name": "c_order"<br />
},<br />
{<br />
"id": 1000015,<br />
"uid": "040ffe18-04ab-4989-ae83-9ed295146042",<br />
"DocumentNo": "50008",<br />
"model-name": "c_order",<br />
"C_OrderLine": [<br />
{<br />
"id": 1000026,<br />
"uid": "d3eac7ec-caf1-473e-8c22-f5b8cee55d30",<br />
"Line": 10,<br />
"LineNetAmt": 4275.00<br />
}<br />
]<br />
},<br />
{<br />
"id": 1000017,<br />
"uid": "ee3a9225-439a-4022-8eaa-1109e5e4f049",<br />
"DocumentNo": "50010",<br />
"Description": "My Sales Tax",<br />
"model-name": "c_order"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
By default expand searches for the primary key column in the master table and tries to create the relation with this column name in the expanded table. /ad_user?$expand=c_order expands using ad_user_id by default. Sometimes you want to specify which column must be used for the expanding. In this case, you need to specify the column name using a dot after the table name.<br><br />
<br />
The request below returns users and their corresponding orders as sales representatives.<br><br />
<br />
<code>/api/v1/models/ad_user?$expand=C_order.salesrep_id($select=documentno)&$select=Name</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 100,<br />
"uid": "986cb4dc-7161-4d77-a7c7-3832d24b19de",<br />
"Name": "SuperUser",<br />
"model-name": "ad_user",<br />
"C_order": [<br />
{<br />
"id": 104,<br />
"uid": "3456b6d0-b911-42e6-8432-f52ded58713f",<br />
"DocumentNo": "800000"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
iDempiere has special tables where record_id is used, for instance, fact_acct. You can expand to this table using the same syntax as explained above. ''The plug-in will automatically set the correct value for AD_Table_ID''<br><br />
<br />
The request below returns the invoice 104 and their corresponding records on fact_acct.<br><br />
<br />
<code>/api/v1/models/c_invoice/104?$expand=fact_acct.record_id($select=fact_acct_id)&$select=DocumentNo</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 104,<br />
"uid": "6d2768c9-b3cc-4820-b903-9748b416b98f",<br />
"DocumentNo": "10000001",<br />
"model-name": "c_invoice",<br />
"fact_acct": [<br />
{<br />
"id": 1001729,<br />
"uid": "cd02c4e7-b386-46aa-b367-f5ec618dccc8"<br />
},<br />
{<br />
"id": 1001730,<br />
"uid": "e8dfd3ec-d5bf-4ded-9646-0a2a8d86a680"<br />
},<br />
{<br />
"id": 1001731,<br />
"uid": "2bf88ace-83bc-4968-abdd-fd211765da92"<br />
},<br />
{<br />
"id": 1001732,<br />
"uid": "26735041-c88e-4670-89e5-95ae49beb4dc"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
Sometimes you want to expand to a master record as well, for instance, from product to product category. You accomplish this by writing expand followed by the column name you want to expand.<br><br />
<br />
The request below returns the product 122 and its corresponding product category.<br><br />
<br />
<code>/api/v1/models/m_product/122?$expand=m_product_category_id($select=Name,IsDefault)&$select=Name,m_product_category_id</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 122,<br />
"uid": "c713192a-9ed3-4740-ad32-9583c30d0206",<br />
"Name": "Standard",<br />
"model-name": "m_product",<br />
"M_Product_Category_ID": {<br />
"id": 105,<br />
"uid": "be686f7e-993f-4162-a02d-ad4bb8c6987b",<br />
"Name": "Standard",<br />
"IsDefault": true,<br />
"model-name": "m_product_category"<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
''Note: For obvious reasons. $select is the only query operator accepted in this case.''<br />
<br />
You can expand on multiple levels by using the $expand operators within the $expand clause. You can only expand deeper on master > detail records. Cases like GET ../orders?$expand=AD_user_ID($expand=C_orderLine) are forbidden.<br />
<br />
== Query Option $orderby ==<br />
The <code>$orderby</code> query option allows developers to request resources in either ascending order using asc or descending order using desc. If asc or desc not specified, then the resources will be ordered in ascending order. <br />
<br />
The request below orders products on property Value in descending order.<br />
<code>GET /api/v1/models/m_product?$orderby=Value desc</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 37,<br />
"records-size": 3,<br />
"skip-records": 0,<br />
"row-count": 111,<br />
"array-count": 3,<br />
"records": [<br />
{<br />
"id": 1000216,<br />
"uid": "e19114c8-86cc-4fb4-b6eb-15f8fa350d38",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 50001,<br />
"identifier": "Fertilizer",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2020-10-05T18:46:14Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2020-11-23T19:45:12Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "Tron",<br />
"IsSummary": false,<br />
"C_UOM_ID": {<br />
"propertyLabel": "UOM",<br />
"id": 100,<br />
"identifier": "Each",<br />
"model-name": "c_uom"<br />
},<br />
"IsStocked": true,<br />
"IsPurchased": false,<br />
"IsSold": false,<br />
"Volume": 0,<br />
"Weight": 0,<br />
"Value": "zas",<br />
"M_Product_Category_ID": {<br />
"propertyLabel": "Product Category",<br />
"id": 105,<br />
"identifier": "Standard",<br />
"model-name": "m_product_category"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Discontinued": false,<br />
"IsBOM": false,<br />
"IsInvoicePrintDetails": false,<br />
"IsPickListPrintDetails": false,<br />
"IsVerified": false,<br />
"ProductType": {<br />
"propertyLabel": "Product Type",<br />
"id": "I",<br />
"identifier": "Item",<br />
"model-name": "ad_ref_list"<br />
},<br />
"M_AttributeSetInstance_ID": {<br />
"propertyLabel": "Attribute Set Instance",<br />
"id": 0,<br />
"model-name": "m_attributesetinstance"<br />
},<br />
"IsWebStoreFeatured": false,<br />
"IsSelfService": false,<br />
"IsDropShip": false,<br />
"IsExcludeAutoDelivery": false,<br />
"UnitsPerPack": 1,<br />
"LowLevel": 0,<br />
"IsKanban": false,<br />
"IsManufactured": false,<br />
"IsPhantom": false,<br />
"IsOwnBox": false,<br />
"IsAutoProduce": false,<br />
"BXS_IsPricePerUOM": false,<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 1000398,<br />
"uid": "d5d1bb16-81b4-429b-86bf-f667f22b93df",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 50001,<br />
"identifier": "Fertilizer",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-01-20T18:52:06Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-01-20T18:52:06Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "yudo mat",<br />
"IsSummary": false,<br />
"C_UOM_ID": {<br />
"propertyLabel": "UOM",<br />
"id": 100,<br />
"identifier": "Each",<br />
"model-name": "c_uom"<br />
},<br />
"IsStocked": true,<br />
"IsPurchased": true,<br />
"IsSold": true,<br />
"Volume": 0,<br />
"Weight": 0,<br />
"Value": "ym",<br />
"M_Product_Category_ID": {<br />
"propertyLabel": "Product Category",<br />
"id": 106,<br />
"identifier": "Trees",<br />
"model-name": "m_product_category"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Discontinued": false,<br />
"IsBOM": false,<br />
"IsInvoicePrintDetails": false,<br />
"IsPickListPrintDetails": false,<br />
"IsVerified": false,<br />
"ProductType": {<br />
"propertyLabel": "Product Type",<br />
"id": "I",<br />
"identifier": "Item",<br />
"model-name": "ad_ref_list"<br />
},<br />
"M_AttributeSetInstance_ID": {<br />
"propertyLabel": "Attribute Set Instance",<br />
"id": 0,<br />
"model-name": "m_attributesetinstance"<br />
},<br />
"IsWebStoreFeatured": false,<br />
"IsSelfService": true,<br />
"IsDropShip": false,<br />
"IsExcludeAutoDelivery": false,<br />
"UnitsPerPack": 1,<br />
"LowLevel": 0,<br />
"IsKanban": false,<br />
"IsManufactured": false,<br />
"IsPhantom": false,<br />
"IsOwnBox": false,<br />
"IsAutoProduce": false,<br />
"BXS_IsPricePerUOM": false,<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 1000299,<br />
"uid": "1726c817-71bc-4abf-8949-0372c9ffb0d3",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2020-10-08T19:04:22Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2020-10-08T19:04:22Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "Xiaomi Redmi Airdots",<br />
"IsSummary": false,<br />
"C_UOM_ID": {<br />
"propertyLabel": "UOM",<br />
"id": 100,<br />
"identifier": "Each",<br />
"model-name": "c_uom"<br />
},<br />
"IsStocked": true,<br />
"IsPurchased": true,<br />
"IsSold": true,<br />
"Volume": 0,<br />
"Weight": 0,<br />
"Value": "Xiaomi Redmi Airdots",<br />
"M_Product_Category_ID": {<br />
"propertyLabel": "Product Category",<br />
"id": 1000015,<br />
"identifier": "Gadgets",<br />
"model-name": "m_product_category"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"ShelfWidth": 0,<br />
"ShelfHeight": 0,<br />
"ShelfDepth": 0,<br />
"UnitsPerPallet": 0,<br />
"Discontinued": false,<br />
"IsBOM": false,<br />
"IsInvoicePrintDetails": false,<br />
"IsPickListPrintDetails": false,<br />
"IsVerified": false,<br />
"ProductType": {<br />
"propertyLabel": "Product Type",<br />
"id": "I",<br />
"identifier": "Item",<br />
"model-name": "ad_ref_list"<br />
},<br />
"GuaranteeDays": 0,<br />
"M_AttributeSetInstance_ID": {<br />
"propertyLabel": "Attribute Set Instance",<br />
"id": 0,<br />
"model-name": "m_attributesetinstance"<br />
},<br />
"GuaranteeDaysMin": 0,<br />
"IsWebStoreFeatured": false,<br />
"IsSelfService": true,<br />
"IsDropShip": false,<br />
"IsExcludeAutoDelivery": false,<br />
"UnitsPerPack": 0,<br />
"LowLevel": 0,<br />
"IsKanban": false,<br />
"IsManufactured": false,<br />
"IsPhantom": false,<br />
"IsOwnBox": false,<br />
"IsAutoProduce": false,<br />
"BXS_IsPricePerUOM": false,<br />
"model-name": "m_product"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Query Options $top and $skip ==<br />
The <code>$top</code> query option requests the number of items in the queried collection to be included in the result. The <code>$skip</code> query option requests the number of items in the queried collection that are to be skipped and not included in the result.<br />
<br />
The request below return the first two Orders starting with other 5th order.<br />
<code>GET /api/v1/models/c_order?$top=2&$skip=5</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 34,<br />
"records-size": 2,<br />
"skip-records": 5,<br />
"row-count": 68,<br />
"array-count": 2,<br />
"records": [<br />
{<br />
"id": 1000022,<br />
"uid": "2238dc66-edda-41f7-8348-d781342f6dfc",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 11,<br />
"identifier": "HQ",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-07-29T15:59:51Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-07-29T15:59:51Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"DocumentNo": "50015",<br />
"DocStatus": {<br />
"propertyLabel": "Document Status",<br />
"id": "DR",<br />
"identifier": "Drafted",<br />
"model-name": "ad_ref_list"<br />
},<br />
"C_DocType_ID": {<br />
"propertyLabel": "Document Type",<br />
"id": 0,<br />
"identifier": "** New **",<br />
"model-name": "c_doctype"<br />
},<br />
"C_DocTypeTarget_ID": {<br />
"propertyLabel": "Target Document Type",<br />
"id": 132,<br />
"identifier": "Standard Order",<br />
"model-name": "c_doctype"<br />
},<br />
"IsApproved": false,<br />
"IsCreditApproved": false,<br />
"IsDelivered": false,<br />
"IsInvoiced": false,<br />
"IsPrinted": false,<br />
"IsTransferred": false,<br />
"DateOrdered": "2021-07-29",<br />
"DatePromised": "2021-07-29",<br />
"DateAcct": "2021-07-29",<br />
"SalesRep_ID": {<br />
"propertyLabel": "Sales Representative",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"C_PaymentTerm_ID": {<br />
"propertyLabel": "Payment Term",<br />
"id": 105,<br />
"identifier": "Immediate",<br />
"model-name": "c_paymentterm"<br />
},<br />
"C_Currency_ID": {<br />
"propertyLabel": "Currency",<br />
"id": 102,<br />
"identifier": "EUR",<br />
"model-name": "c_currency"<br />
},<br />
"InvoiceRule": {<br />
"propertyLabel": "Invoice Rule",<br />
"id": "I",<br />
"identifier": "Immediate",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightAmt": 0.0,<br />
"DeliveryViaRule": {<br />
"propertyLabel": "Delivery Via",<br />
"id": "P",<br />
"identifier": "Pickup",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PriorityRule": {<br />
"propertyLabel": "Priority",<br />
"id": "5",<br />
"identifier": "Medium",<br />
"model-name": "ad_ref_list"<br />
},<br />
"TotalLines": 0.0,<br />
"GrandTotal": 0.0,<br />
"M_Warehouse_ID": {<br />
"propertyLabel": "Warehouse",<br />
"id": 103,<br />
"identifier": "HQ Warehouse",<br />
"model-name": "m_warehouse"<br />
},<br />
"M_PriceList_ID": {<br />
"propertyLabel": "Price List",<br />
"id": 101,<br />
"identifier": "Standard",<br />
"model-name": "m_pricelist"<br />
},<br />
"C_BPartner_ID": {<br />
"propertyLabel": "Business Partner",<br />
"id": 112,<br />
"identifier": "Standard",<br />
"model-name": "c_bpartner"<br />
},<br />
"AD_User_ID": {<br />
"propertyLabel": "User/Contact",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"ChargeAmt": 0.0,<br />
"Processed": false,<br />
"C_BPartner_Location_ID": {<br />
"propertyLabel": "Partner Location",<br />
"id": 108,<br />
"identifier": "Monroe",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSOTrx": true,<br />
"DeliveryRule": {<br />
"propertyLabel": "Delivery Rule",<br />
"id": "A",<br />
"identifier": "Availability",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightCostRule": {<br />
"propertyLabel": "Freight Cost Rule",<br />
"id": "I",<br />
"identifier": "Freight included",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PaymentRule": {<br />
"propertyLabel": "Payment Rule",<br />
"id": "P",<br />
"identifier": "On Credit",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsDiscountPrinted": false,<br />
"IsTaxIncluded": false,<br />
"IsSelected": false,<br />
"SendEMail": false,<br />
"Bill_BPartner_ID": {<br />
"propertyLabel": "Invoice Partner",<br />
"id": 112,<br />
"identifier": "Standard",<br />
"model-name": "c_bpartner"<br />
},<br />
"Bill_Location_ID": {<br />
"propertyLabel": "Invoice Location",<br />
"id": 108,<br />
"identifier": "Monroe",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSelfService": false,<br />
"IsDropShip": false,<br />
"IsPayScheduleValid": false,<br />
"IsPriviledgedRate": false,<br />
"NetAmtToInvoice": 0.0,<br />
"model-name": "c_order"<br />
},<br />
{<br />
"id": 1000016,<br />
"uid": "5565e213-a119-4bcc-beb6-c9f9a4e75dab",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 11,<br />
"identifier": "HQ",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-03-09T14:20:31Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-03-09T14:20:59Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"DocumentNo": "50009",<br />
"DocStatus": {<br />
"propertyLabel": "Document Status",<br />
"id": "CO",<br />
"identifier": "Completed",<br />
"model-name": "ad_ref_list"<br />
},<br />
"C_DocType_ID": {<br />
"propertyLabel": "Document Type",<br />
"id": 132,<br />
"identifier": "Standard Order",<br />
"model-name": "c_doctype"<br />
},<br />
"C_DocTypeTarget_ID": {<br />
"propertyLabel": "Target Document Type",<br />
"id": 132,<br />
"identifier": "Standard Order",<br />
"model-name": "c_doctype"<br />
},<br />
"Description": "Order Description from Business Partner Definition",<br />
"IsApproved": true,<br />
"IsCreditApproved": false,<br />
"IsDelivered": false,<br />
"IsInvoiced": false,<br />
"IsPrinted": false,<br />
"IsTransferred": false,<br />
"DateOrdered": "2021-02-16",<br />
"DatePromised": "2021-02-25",<br />
"DateAcct": "2021-02-16",<br />
"SalesRep_ID": {<br />
"propertyLabel": "Sales Representative",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"C_PaymentTerm_ID": {<br />
"propertyLabel": "Payment Term",<br />
"id": 106,<br />
"identifier": "2%10 Net 30",<br />
"model-name": "c_paymentterm"<br />
},<br />
"C_Currency_ID": {<br />
"propertyLabel": "Currency",<br />
"id": 102,<br />
"identifier": "EUR",<br />
"model-name": "c_currency"<br />
},<br />
"InvoiceRule": {<br />
"propertyLabel": "Invoice Rule",<br />
"id": "I",<br />
"identifier": "Immediate",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightAmt": 0,<br />
"DeliveryViaRule": {<br />
"propertyLabel": "Delivery Via",<br />
"id": "P",<br />
"identifier": "Pickup",<br />
"model-name": "ad_ref_list"<br />
},<br />
"M_Shipper_ID": {<br />
"propertyLabel": "Shipper",<br />
"id": 100,<br />
"identifier": "UPS",<br />
"model-name": "m_shipper"<br />
},<br />
"PriorityRule": {<br />
"propertyLabel": "Priority",<br />
"id": "5",<br />
"identifier": "Medium",<br />
"model-name": "ad_ref_list"<br />
},<br />
"TotalLines": 95.00,<br />
"GrandTotal": 95.00,<br />
"M_Warehouse_ID": {<br />
"propertyLabel": "Warehouse",<br />
"id": 103,<br />
"identifier": "HQ Warehouse",<br />
"model-name": "m_warehouse"<br />
},<br />
"M_PriceList_ID": {<br />
"propertyLabel": "Price List",<br />
"id": 101,<br />
"identifier": "Standard",<br />
"model-name": "m_pricelist"<br />
},<br />
"C_BPartner_ID": {<br />
"propertyLabel": "Business Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"AD_User_ID": {<br />
"propertyLabel": "User/Contact",<br />
"id": 1000011,<br />
"identifier": "Carlitos Boss",<br />
"model-name": "ad_user"<br />
},<br />
"POReference": "Order Reference 1234",<br />
"ChargeAmt": 0,<br />
"Processed": true,<br />
"C_BPartner_Location_ID": {<br />
"propertyLabel": "Partner Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSOTrx": true,<br />
"DeliveryRule": {<br />
"propertyLabel": "Delivery Rule",<br />
"id": "A",<br />
"identifier": "Availability",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightCostRule": {<br />
"propertyLabel": "Freight Cost Rule",<br />
"id": "F",<br />
"identifier": "Fix price",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PaymentRule": {<br />
"propertyLabel": "Payment Rule",<br />
"id": "P",<br />
"identifier": "On Credit",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsDiscountPrinted": true,<br />
"IsTaxIncluded": false,<br />
"IsSelected": false,<br />
"SendEMail": false,<br />
"Bill_User_ID": {<br />
"propertyLabel": "Invoice Contact",<br />
"id": 1000011,<br />
"identifier": "Carlitos Boss",<br />
"model-name": "ad_user"<br />
},<br />
"Bill_BPartner_ID": {<br />
"propertyLabel": "Invoice Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"Bill_Location_ID": {<br />
"propertyLabel": "Invoice Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSelfService": false,<br />
"IsDropShip": false,<br />
"Volume": 0.00,<br />
"Weight": 0.00,<br />
"ProcessedOn": 1615296059621.6216,<br />
"IsPayScheduleValid": false,<br />
"IsPriviledgedRate": false,<br />
"NetAmtToInvoice": 0.00,<br />
"model-name": "c_order"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Query Option $select ==<br />
The <code>$select</code> query option allows the clients to requests a limited set of properties for each entity or complex type. <br />
<br />
The request below returns Name and Value of all products.<br />
<code>GET /api/v1/models/m_product?$select=Name,Value</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 28,<br />
"records-size": 4,<br />
"skip-records": 0,<br />
"row-count": 111,<br />
"array-count": 4,<br />
"records": [<br />
{<br />
"id": 1000322,<br />
"uid": "b0e7e8b6-13ed-406d-a105-bd67ddb7f423",<br />
"Name": "Mug 50",<br />
"Value": "Mug 50",<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 134,<br />
"uid": "01254fee-c75f-42f0-941c-142e27078643",<br />
"Name": "Patio Table",<br />
"Value": "PTable",<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 137,<br />
"uid": "26a7e6d7-e2c1-4c21-97f2-773dc222e6a2",<br />
"Name": "Mulch 10#",<br />
"Value": "Mulch",<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 50003,<br />
"uid": "8a27ac0a-56c0-4a3a-8eb8-ff87c94899c1",<br />
"Name": "Ultra Glue",<br />
"Value": "UltraGlue",<br />
"model-name": "m_product"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== iDempiere specific query Options ==<br />
<br />
=== Query Option $valrule ===<br />
<br />
The query option <code>$valrule</code> can be used to get PO records using a validation rule - AD_ValRule_ID or AD_ValRule_UU<br />
<br />
=== Query Option $context ===<br />
<br />
The query option <code>$context</code> can be used to put variables in context to be parsed by the validation rule<br />
<br />
=== Query Option showsql ===<br />
<br />
The query option <code>showsql</code> can be used to add the SQL query being executed on GET.<br />
<br />
You can also use <code>showsql=nodata</code> to obtain just information about the query without returning the real data.<br />
<br />
The payload will include a JSON element with name <code>sql-command</code> containing the query that is executed in the database to obtain the record(s).<br />
<br />
When <code>showsql</code> is used at the same time with <code>$expand</code>, then the payload will include the <code>sql-command</code> JSON element for the query on the master table, and also it will include the elements with format <code>sql-command-[table]</code> for each expanded table, for example the following query:<br />
<br />
<code>GET .../api/v1/models/c_tax/106?$expand=c_tax_acct&showsql</code><br />
<br />
will return the following elements in the payload:<br />
<br />
<syntaxhighlight lang="json"><br />
"sql-command": "SELECT C_Tax_ID,AD_Client_ID,AD_Org_ID,IsActive,Created,CreatedBy,Name,Description,Parent_Tax_ID,C_Country_ID,C_Region_ID,To_Country_ID,To_Region_ID,C_TaxCategory_ID,Updated,UpdatedBy,IsDocumentLevel,ValidFrom,IsSummary,Rate,RequiresTaxCertificate,TaxIndicator,IsDefault,IsTaxExempt,SOPOType,IsSalesTax,AD_Rule_ID,C_Tax_UU,C_TaxProvider_ID,C_CountryGroupTo_ID,C_CountryGroupFrom_ID FROM C_Tax WHERE (c_tax_ID=?) AND C_Tax.AD_Client_ID IN(0,11) AND (C_Tax.AD_Org_ID IN (0,11,12,50000,1000000,50002,50001,50004,50006,50005,50007))",<br />
"sql-command-c_tax_acct": "SELECT C_Tax_ID,C_AcctSchema_ID,AD_Client_ID,AD_Org_ID,IsActive,Created,CreatedBy,Updated,UpdatedBy,T_Due_Acct,T_Credit_Acct,T_Expense_Acct,C_Tax_Acct_UU FROM C_Tax_Acct WHERE (c_tax_ID=?) AND IsActive=? AND C_Tax_Acct.AD_Client_ID IN(0,11) AND (C_Tax_Acct.AD_Org_ID IN (0,11,12,50000,1000000,50002,50001,50004,50006,50005,50007))",<br />
</syntaxhighlight><br />
<br />
=== Query Option label ===<br />
<br />
The query option <code>label</code> can be used to get PO records by filtering based on labels (i.e. <code>AD_Label</code>). For example, <code>GET /api/v1/models/C_BPartner?label=Name eq '%23Customer'</code> query will return all business partner records where the name of the Assigned Label > Label is '#Customer'.<br />
<br />
iDempiere supports using nested <code>label</code> within the <code>$expand</code> query option.<br />
<br />
Refer to the <code>$filter</code> query option for the supported predicates.<br />
<br />
=== Query Option showlabel ===<br />
<br />
The query option <code>showlabel</code> can be used to include the list of assigned labels in the payload when getting a PO record or records. <br />
<br />
The query below returns the business partner record along with a list of assigned label objects, including all columns.<br />
<br />
<code>GET /api/v1/models/C_BPartner/119?showlabel&$select=Name,IsCustomer,IsVendor</code><br />
<br />
Response payload:<syntaxhighlight lang="json"><br />
{<br />
"id": 119,<br />
"uid": "61a84a1b-37a0-4dda-80a2-3ee218522b32",<br />
"Name": "GardenUser BP",<br />
"IsVendor": true,<br />
"IsCustomer": true,<br />
"model-name": "c_bpartner",<br />
"assigned-labels": [<br />
{<br />
"id": 1000000,<br />
"uid": "6d550225-2e0a-4203-9b82-0f2634f7d079",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Tenant",<br />
"id": 11,<br />
"identifier": "GardenWorld",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"Created": "2025-04-11T13:11:54Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2025-04-16T17:35:43Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"IsActive": true,<br />
"Description": "Customers",<br />
"Name": "#Customer",<br />
"model-name": "ad_label"<br />
},<br />
{<br />
"id": 1000001,<br />
"uid": "87ae21d5-f06a-4cd8-977c-86712cf58da1",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Tenant",<br />
"id": 11,<br />
"identifier": "GardenWorld",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"Created": "2025-04-11T13:13:40Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2025-04-16T17:36:54Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"IsActive": true,<br />
"Description": "Vendors",<br />
"Name": "#Vendor",<br />
"model-name": "ad_label"<br />
}<br />
]<br />
}<br />
</syntaxhighlight>You can use <code>showlabel={columnname list}</code> to retrieve a list of assigned label objects, including the defined column list only. For example, the query below returns the business partner record along with a list of assigned label objects including the name and description.<br />
<br />
<code>GET /api/v1/models/C_BPartner/119?showlabel=Name,Description&$select=Name,IsCustomer,IsVendor</code><br />
<br />
Response payload:<syntaxhighlight lang="json"><br />
{<br />
"id": 119,<br />
"uid": "61a84a1b-37a0-4dda-80a2-3ee218522b32",<br />
"Name": "GardenUser BP",<br />
"IsVendor": true,<br />
"IsCustomer": true,<br />
"model-name": "c_bpartner",<br />
"assigned-labels": [<br />
{<br />
"Name": "#Customer",<br />
"Description": "Customers"<br />
},<br />
{<br />
"Name": "#Vendor",<br />
"Description": "Vendors"<br />
}<br />
]<br />
}<br />
</syntaxhighlight>You can use <code>showlabel={columnname}</code> to retrieve the values of the assigned label column. For example, the query below returns the business partner record along with a list of assigned label names.<br />
<br />
<code>GET /api/v1/models/C_BPartner/119?showlabel=Name&$select=Name,IsCustomer,IsVendor</code><br />
<br />
Response payload:<syntaxhighlight lang="json"><br />
{<br />
"id": 119,<br />
"uid": "61a84a1b-37a0-4dda-80a2-3ee218522b32",<br />
"Name": "GardenUser BP",<br />
"IsVendor": true,<br />
"IsCustomer": true,<br />
"model-name": "c_bpartner",<br />
"assigned-labels": [<br />
"#Customer",<br />
"#Vendor"<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
= Data Modification =<br />
<br />
iDempiere supports Create, Update and Delete operation for some or all exposed POs.<br />
<br />
== Create a PO (POST) ==<br />
To create a PO in a collection, the client sends a POST request to that collection's URL. The POST body MUST contain a single valid entity representation. <br />
<br />
The request below creates a Tax which contains complex type and collection property. <br />
<code>POST api/v1/models/c_tax</code><br />
<br />
Body<br><br />
<syntaxhighlight lang="json"><br />
{<br />
"AD_Org_ID": {<br />
"id": 0,<br />
"tableName": "AD_Org"<br />
},<br />
"isActive": true,<br />
"name": "MyGST",<br />
"description": "MyCanadian Federal Sales Tax",<br />
"Parent_Tax_ID": {<br />
"identifier": "GST/PST",<br />
"tableName": "C_Tax"<br />
},<br />
"C_Country_ID": {<br />
"lookupColumn": "CountryCode",<br />
"lookupValue": "CA"<br />
},<br />
"To_Country_ID": {<br />
"identifier": "Canada",<br />
"tableName": "C_Country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"identifier": "Standard",<br />
"tableName": "C_TaxCategory"<br />
},<br />
"isDocumentLevel": false,<br />
"validFrom": "01/01/2001",<br />
"isSummary": false,<br />
"rate": "7.0",<br />
"requiresTaxCertificate": false,<br />
"taxIndicator": "GST",<br />
"isDefault": false,<br />
"isTaxExempt": false,<br />
"sOPOType": {<br />
"id": "B"<br />
},<br />
"isSalesTax": false,<br />
"tableName": "C_Tax"<br />
}<br />
</syntaxhighlight><br />
<br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 1000005,<br />
"uid": "4e71df80-f3f5-41cd-84cf-2bc8e12322d0",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2022-10-28T15:44:44Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "Standard 19%",<br />
"Description": "MyCanadian Federal Sales Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2022-10-28T15:44:44Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "1990-01-01",<br />
"IsSummary": false,<br />
"Rate": 7.0,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "GST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": false,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
}<br />
</syntaxhighlight><br />
<br />
== Remove a PO (DELETE) ==<br />
The request below deletes the Tax with id '1000005'.<br />
<code>DELETE /api/v1/models/c_tax/1000005</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"msg": "Deleted"<br />
}<br />
</syntaxhighlight><br />
<br />
== Update a PO (PUT) ==<br />
The request below updates the tax with id 1000000 <br />
<code>PUT /api/v1/models/c_tax/1000000</code><br />
<br />
Body:<br />
<syntaxhighlight lang="json"><br />
{<br />
"name": "Standard Tax"<br />
}<br />
</syntaxhighlight><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 1000002,<br />
"uid": "a1c76f9b-30ea-44c1-a8c3-2bc27daa1cd1",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2020-08-21T18:29:28Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "Standard Tax",<br />
"Description": "My Sales Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2022-10-28T15:48:14Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "1990-01-01",<br />
"IsSummary": false,<br />
"Rate": 6.0,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "GST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": true,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
}<br />
</syntaxhighlight><br />
<br />
=== Update/Insert/Delete child records of a PO (PUT) ===<br />
Update the child records of a PO using the child record array in the PUT request Body:<br />
* Without child record id to create<br />
* With child record id to update<br />
* With child record id and the following delete flag to delete a child record.<syntaxhighlight lang="json">"(delete)":true</syntaxhighlight> <br />
<p><br />
Examples to delete, create and update order lines:<br/><br />
PUT /api/v1/models/c_order/1000000<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"C_OrderLine": [<br />
{<br />
"id": 1000000,<br />
"(delete)": true<br />
}<br />
{<br />
"M_Product_ID": 128,<br />
"QtyEntered": 1<br />
},<br />
{<br />
"id": 1000001,<br />
"QtyEntered": 2<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Special Entity Type Representations ==<br />
<br />
=== Image ===<br />
If you are modifying or creating values of an Image type column/field, the json entity representation must be as follows: <br />
* id -> the foreign record ID. If not informed a new foreign record will be created and linked to the main record<br />
* file_name -> the readable file name to be stored at the foreign table<br />
* url -> an optional URL for the image to be stored at the foreign table<br />
* data -> a string with the base64 encoded data for the image<br />
<br />
= Other Resources =<br />
<br />
=== GET api/v1/auth/jwk ===<br />
<br />
Calling this endpoint returns the key used to sign the JWT.<br />
<br />
By default this endpoint returns nothing. It requires the System Configurator IDEMPIERE_REST_EXPOSE_JWK to be set to Y on System tenant.<br />
<br />
<span style="color:red>'''WARNING!'''</span> Exposing the signature key is intended exclusively for integration with API gateways that requires it (like krakend), and this endpoint MUST be hidden from public usage and exposed JUST to the API gateway. Exposing the key publicly open the REST interface to attacks changing the JWT token.<br />
<br />
'''''Returns:'''''<br />
* keys<br />
** alg<br />
** k<br />
** kid<br />
** kty<br />
<br />
=== GET api/v1/models/{tablename}/{recordId}/print ===<br />
This method is used to get the print format from the model's record id.<br />
<br />
'''''URL Parameters:'''''<br />
* $report_type -> optional - ( PDF | HTML | CSV | XLSX | XLS )<br />
<br />
'''''Returns:'''''<br />
* AD_PInstance_ID<br />
* process<br />
* summary<br />
* isError<br />
* reportFile<br />
* reportFileName<br />
* reportFileLength<br />
* nodeId<br />
<br />
== Windows api/v1/windows ==<br />
<br />
working with AD_Window and AD_Tab<br />
<br />
== Forms api/v1/forms ==<br />
<br />
=== GET api/v1/forms ===<br />
<br />
Get Forms available<br />
<br />
'''''URL Parameters:'''''<br />
* $filter -> optional - used to filter the query<br />
<br />
'''''Returns:'''''<br />
* an array of PO json records from the forms (AD_Form) queried<br />
<br />
== Processes api/v1/processes ==<br />
<br />
working with process and reports<br />
<br />
=== GET api/v1/processes ===<br />
<br />
Get Processes available<br />
<br />
'''''URL Parameters:'''''<br />
* $filter -> optional - used to filter the query<br />
<br />
'''''Returns:'''''<br />
* an array of PO json records from the process (AD_Process) queried<br />
<br />
=== GET api/v1/processes/{process_value} ===<br />
<br />
Get Information from a process<br />
<br />
'''''URL Parameters:'''''<br />
* {process_value} -> value of the process (in slug form - lowercase)<br />
<br />
'''''Returns:'''''<br />
* an PO json record from the process (AD_Process) queried<br />
<br />
=== POST api/v1/processes/{process_value} ===<br />
<br />
Run a process<br />
<br />
'''''URL Parameters:'''''<br />
* {process_value} -> value of the process (in slug form - lowercase)<br />
for example <code>https://demo.globalqss.com/api/v1/processes/translationimpexp</code><br />
<br />
'''''Body:'''''<br />
* {process_parameters} -> a JSON representation of the process parameters, for example:<br />
<syntaxhighlight lang=json><br />
{<br />
"ImportOrExport": "export",<br />
"AD_Language": "es_CO",<br />
"IsOnlyCentralizedData": true<br />
}<br />
</syntaxhighlight><br />
<br />
for reports three special parameters can be added:<br />
* report-type: with the possible values HTML, CSV, XLS or PDF (the default)<br />
* is-summary<br />
* print-format-id<br />
<br />
also, for buttons is possible to define two special parameters:<br />
* table-id or model-name<br />
* record-id<br />
<br />
'''''Returns:'''''<br />
* JSON information about the process/report executed:<br />
** AD_PInstance_ID<br />
** process<br />
** summary<br />
** isError<br />
** nodeId<br />
** logs - array containing the logs from the process<br />
<br />
The reports will be returned in an object with name <code>reportFile</code> containing the base64 encoded report, and additionally the objects <code>reportFileName</code> and <code>reportFileLength</code>.<br />
<br />
If the process produces an export file it will be returned in an object <code>exportFile</code>, and additionally the objects <code>exportFileName</code> and <code>exportFileLength</code>.<br />
<br />
=== GET api/v1/processes/jobs ===<br />
<br />
Get information about jobs running<br />
<br />
'''''Returns:'''''<br />
* an array of json records from the process running (AD_PInstance)<br />
<br />
=== GET api/v1/processes/jobs/{ad_pinstance_id} ===<br />
<br />
Get Information from a job<br />
<br />
'''''URL Parameters:'''''<br />
* {ad_pinstance_id}<br />
<br />
'''''Returns:'''''<br />
* a json record from the process (AD_PInstance)<br />
<br />
=== POST api/v1/processes/jobs/{process_value} ===<br />
<br />
Run a process in background (as job)<br />
<br />
'''''URL Parameters:'''''<br />
* {process_value} -> value of the process (in slug form - lowercase)<br />
for example <code>https://demo.globalqss.com/api/v1/processes/jobs/translationimpexp</code><br />
<br />
'''''Body:'''''<br />
* {process_parameters} -> a JSON representation of the process parameters (same as for running the process)<br />
<br />
same special parameters apply as for the reports, and additionally you can define the parameter <code>notification-type</code> with the values E, N or B (EMail, Notification or Both)<br />
<br />
'''''Returns:'''''<br />
* JSON information about the AD_PInstance scheduled<br />
<br />
== Files api/v1/files ==<br />
<br />
to access files created by api/v1/processes<br />
<br />
TBD<br />
<br />
== Caches api/v1/caches ==<br />
<br />
=== GET api/v1/caches ===<br />
<br />
Get caches information. This call is restricted just for administrators.<br />
<br />
'''''URL Parameters:'''''<br />
* table_name -> optional - to filter the list of caches<br />
* name -> optional - to filter the list of caches<br />
<br />
'''''Returns:'''''<br />
* caches (array)<br />
** name<br />
** table_name<br />
** size<br />
** expireMinutes<br />
** maxSize<br />
** distributed (boolean)<br />
<br />
=== DEL api/v1/caches ===<br />
<br />
Reset cache. This call requires the role to have permission to execute "Cache Reset" process.<br />
<br />
When called without parameters it reset the whole cache, or just from a table, or just one record.<br />
<br />
'''''URL Parameters:'''''<br />
* table_name -> optional - to restrict the reset to just one table. Case sensitive.<br />
* record_id -> optional - to restrict the reset to just one record. Zero is the same as not set, it clears the cache of the whole table.<br />
<br />
'''''Returns:'''''<br />
* entriesReset (number of entries cleared)<br />
<br />
== Nodes api/v1/nodes ==<br />
<br />
get nodes info, get log files, reset and rotate logs.<br />
<br />
TBD<br />
<br />
== Servers api/v1/servers ==<br />
<br />
servers and schedulers resource<br />
<br />
TBD<br />
<br />
== Infos api/v1/infos ==<br />
<br />
info windows<br />
<br />
TBD<br />
<br />
== Reference api/v1/reference/{id} ==<br />
<br />
You can get a reference list by id/uuid or name.<br />
<br />
'''GET .../api/v1/reference/152'''<br />
<br />
'''GET .../api/v1/reference/42522223-92ae-4405-92dc-e02e2dea61a7'''<br />
<br />
'''GET .../api/v1/reference/C_Order%20DeliveryViaRule'''<br />
<br />
''* Only list and table validation references are supported''<br />
<br />
== Workflows api/v1/workflow ==<br />
<br />
=== GET api/v1/workflow ===<br />
<br />
'''''Returns:'''''<br />
* all suspended, non-processed nodes of the current user<br />
** id<br />
** uid<br />
** model-name<br />
** node-name<br />
** node-description<br />
** priority<br />
** summary<br />
** node-help<br />
** history-records<br />
** table-name<br />
** ad_table_id<br />
** record_id<br />
** node-approval<br />
** node-confirmation<br />
** created<br />
<br />
=== GET api/v1/workflow/{userid} ===<br />
<br />
'''''Returns:'''''<br />
* all suspended, non-processed nodes of the user id passed in the URL<br />
** id<br />
** uid<br />
** model-name<br />
** node-name<br />
** node-description<br />
** priority<br />
** summary<br />
** node-help<br />
** history-records<br />
** table-name<br />
** ad_table_id<br />
** record_id<br />
** node-approval<br />
** node-confirmation<br />
** created<br />
<br />
'''''Examples:'''''<br />
/api/v1/workflow/100<br />
<br />
=== PUT api/v1/workflow/approve/{nodeid} ===<br />
<br />
Approves the corresponding node. Just for nodes of type = Approval (Column name = IsApproved).<br />
<br />
'''''Body Parameters:'''''<br />
* "message": "This is an example message for approval" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the approval<br />
<br />
=== PUT api/v1/workflow/reject/{nodeid} ===<br />
<br />
Rejects the corresponding node. Just for nodes of type = Approval (Column name = IsApproved).<br />
<br />
'''''Body Parameters:'''''<br />
* "message": "This is an example message for rejection" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the rejection<br />
<br />
=== PUT api/v1/workflow/forward/{nodeid} ===<br />
<br />
Forwards the corresponding node to a specific user. Just for nodes of type = Approval (Column name = IsApproved).<br />
<br />
'''''Body Parameters:'''''<br />
* "userTo": {userToID} '''(Mandatory)'''<br />
* "message": "This is an example message for fowarding" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the forwarding<br />
<br />
=== PUT api/v1/workflow/acknowledge/{nodeid} ===<br />
<br />
Implementation of the workflow nodes where a user gets notified when something happens, it<br />
does not require any action from the user but the user receives a message after a specific<br />
action is performed. This is used when the node is from type Window/form<br />
<br />
'''''Body Parameters:'''''<br />
* "message": "This is an example message for acknowledge" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the acknowledge<br />
<br />
=== PUT api/v1/workflow/setuserchoice/{nodeid} ===<br />
<br />
This is similar to approve and reject but it supports columns with Type List and String.<br />
<br />
'''''Body Parameters:'''''<br />
* "value":"Value to be set in the corresponding column" '''(Mandatory)'''<br />
* "message": "This is an example message for userschoice" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the acknowledge<br />
<br />
== Status lines api/v1/statuslines ==<br />
<br />
=== GET api/v1/statuslines ===<br />
<br />
Retrieve all active status line records configured in the dictionary ordered by Name.<br />
<br />
You can use the query parameters '''$filter''' to filter the records returned.<br />
<br />
Additionally, you can use the query parameter '''with_messages''' to specify that you want the resulting message returned in the payload. This means that the status line will be resolved by REST, and the result will be returned in a ''message'' property in the JSON response.<br />
<br />
'''''Returns:'''''<br />
* all the active status line records configured in the dictionary. <br />
** id<br />
** uid<br />
** model-name<br />
** name<br />
** entity type<br />
** message (optional)<br />
<br />
=== GET api/v1/statuslines/{statuslineid} ===<br />
<br />
'''''Returns:'''''<br />
* The message corresponding to the specific status line<br />
** message<br />
<br />
'''''Examples:'''''<br />
/api/v1/statuslines/200024<br />
<br />
=== GET /api/v1/statuslines/200024 ===<br />
<br />
Returns the Core status line Dashboard_OrderCount.<br />
<br />
'''''Returns:'''''<br />
{<br />
"message": "Order Count\n Top Year (2002): 4 \n Current Year: 3"<br />
}<br />
<br />
== Charts api/v1/charts ==<br />
<br />
=== GET api/v1/charts/{chartid} ===<br />
<br />
'''''URL Parameters:'''''<br />
* height -> optional - height in pixels for the image<br />
** if not provided then it uses the same height defined in the chart, or 100 if not defined in chart<br />
* width -> optional - width in pixels for the image<br />
** if not provided then it uses the height defined in the chart, or 100 if not defined in chart<br />
* json -> optional<br />
** if this parameter is present the image is returned base64 encoded in data element of JSON<br />
** when not present the image file is returned directly in PNG format<br />
<br />
'''''Returns:'''''<br />
* The image generated from the chart.<br />
* NOTE that this image is generated using the old JFreeChart library, not the new billboard, so it can have an outdated look.<br />
<br />
'''''Examples:'''''<br />
/api/v1/charts/50002?width=800&height=600&json<br />
<br />
== Menu tree api/v1/menutree/ ==<br />
<br />
=== GET api/v1/menutree/{id} ===<br />
<br />
Retrieve all the elements from the requested menu tree with id or uuid.<br />
<br />
'''''Returns:'''''<br />
* Name<br />
* Description<br />
* IsSOTrx<br />
* PredefinedContextVariables<br />
* EntityType<br />
* Action<br />
* AD_Window_ID<br />
* AD_Workflow_ID<br />
* AD_Task_ID<br />
* AD_Process_ID<br />
* AD_Form_ID<br />
* AD_InfoWindow_ID<br />
<br />
== REST View api/v1/views ==<br />
[https://github.com/bxservice/idempiere-rest/issues/281 https://github.com/bxservice/idempiere-rest/issues/281]<br />
<p><br />
iDempiere model typically has many columns and is using DB naming convention that's not particularly natural in a Json data schema. A common need is to pick a subset of columns for different use case and uses a more json oriented naming for the selected columns.<br />
<br />
This add a layer of abstraction on top of iDempiere model (term as Rest View) to cater for such need. It can be taken as a way to configure Json schema on top of iDempiere model.<br />
<br />
=== GET api/v1/views ===<br />
Get active REST view definitions (Rest_View, Rest_ViewColumn, Rest_ViewRelated).<br />
<br />
=== Support all requests and methods for api/v1/models/ ===<br />
Supports all requests and methods that are available with '''api/v1/models''', just replace '''models''' with '''views''' and '''{tableName}''' with '''{viewName}''' (i.e api/v1/views/{viewName} for api/v1/models/{tableName}, api/v1/views/{viewName}/{id} for api/v1/models/{tableName}/{id}, etc).<br />
<br />
=== Examples ===<br />
See example at [https://github.com/bxservice/idempiere-rest/issues/281 https://github.com/bxservice/idempiere-rest/issues/281]<br />
<br />
== Uploads api/v1/uploads ==<br />
[https://github.com/bxservice/idempiere-rest/issues/360 https://github.com/bxservice/idempiere-rest/issues/360]<br />
<p><br />
Allow uploading large files for posterior references where base64 files are used (e.g. attachments, images, etc)<br />
<br />
===POST api/v1/uploads===<br />
<br />
Initiates a new upload session for a file<br />
<br />
'''''Body:'''''<br />
* fileName -> The name of the file to be uploaded<br />
*contentType -> The MIME type of the file (e.g., "image/png", "application/pdf")<br />
*fileSize -> The total size of the file in bytes<br />
*chunkSize -> The preferred size of each chunk in the upload, in bytes<br />
*sha256 -> The SHA-256 hash of the file content for integrity verification<br />
*uploadLocation -> "ARCHIVE", "ATTACHMENT" OR "IMAGE"<br />
*expiresInSeconds -> The number of seconds after which the upload session will expire<br />
<br />
'''''Returns:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*chunkSize -> The preferred size of each chunk in the upload, in bytes<br />
*expiresAt -> The expiration time of the upload session<br />
*presignedURL -> The pre-signed URL for PUT<br />
<br />
===PUT api/v1/uploads/{uploadId}/chunks/{chunkOrder}===<br />
<br />
Uploads a chunk of the file to the server<br />
<br />
'''''URL Parameters:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*chunkOrder -> The order of the chunk<br />
<br />
'''''Header Parameter:'''''<br />
*X-Total-Chunks -> mandatory, specific the expected number of chunks<br />
*X-Content-SHA256 -> hash of the chunk data<br />
<br />
'''''Body:'''''<br />
<br />
Chunk data to be uploaded<br />
<br />
'''''Returns:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*chunkOrder -> The order of the chunk in the upload sequence<br />
*receivedSize -> The size of the chunk that has been received<br />
*message -> Additional message or details about the upload processing<br />
*isLastChunk -> True if this is the last chunk receive and will trigger the completion of the upload asynchronously<br />
<br />
===GET api/v1/uploads/{uploadId}===<br />
<br />
Retrieves the current status of an ongoing or completed upload<br />
<br />
'''''URL Parameter:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*expiresInSeconds -> The number of seconds after which the presigned URL will expire. When provided, a presigned URL will be returned for the upload session.<br />
<br />
'''''Returns:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*fileName -> The name of the file being uploaded<br />
*fileSize -> The total size of the file being uploaded<br />
*chunkSize -> The preferred size of each chunk in the upload, in bytes<br />
*status -> Status of the upload processing (INITIATED, UPLOADING, PROCESSING, COMPLETED, CANCELED or FAILED)<br />
*uploadedChunks -> List of chunks that have been successfully uploaded<br />
**chunkOrder -> The order of the chunk in the upload sequence <br />
**receivedSize -> The size of the chunk that has been received<br />
<br />
*totalReceivedSize -> Total size of all received chunks so far<br />
*message -> Additional message or details about the upload processing<br />
*presignedURL -> The pre-signed URL for GET<br />
<br />
===DEL api/v1/uploads/{uploadId} ===<br />
<br />
Cancels an ongoing/completed upload, cleans up any temporarily stored chunks and associated uploaded file<br />
<br />
'''''URL Parameter:'''''<br />
* uploadId -> The unique ID of the upload session<br />
<br />
'''''Returns:'''''<br />
*message -> Message or details about the outcome of the cancellation<br />
<br />
===GET api/v1/uploads/{uploadId}/file ===<br />
<br />
Get uploaded file content as binary stream or json<br />
<br />
'''''URL Parameter:'''''<br />
*uploadId -> The unique ID of the upload session<br />
<br />
'''''Query Parameter:'''''<br />
*asJson -> if provided, the response will be in JSON format with file content as base64 encoded string<br />
<br />
'''''Returns:'''''<br />
<br />
Response may be returned in one of the following media types:<br />
<br />
*application/octet-stream for binary data<br />
*text/html for HTML-formatted content<br />
*text/plain for plain text responses<br />
<br />
===GET api/v1/uploads===<br />
<br />
Get pending uploads from current user<br />
<br />
'''''Returns:'''''<br />
<br />
Status list of pending uploads:<br />
*uploadId -> The unique ID of the upload session<br />
*fileName -> The name of the file being uploaded<br />
*fileSize -> The total size of the file being uploaded<br />
*chunkSize -> The preferred size of each chunk in the upload, in bytes<br />
*status -> Status of the upload processing (INITIATED, UPLOADING, PROCESSING, COMPLETED, CANCELED or FAILED)<br />
*uploadedChunks -> List of chunks that have been successfully uploaded<br />
**chunkOrder -> The order of the chunk in the upload sequence<br />
**receivedSize -> The size of the chunk that has been received<br />
<br />
*totalReceivedSize -> Total size of all received chunks so far<br />
* message -> Additional message or details about the upload processing<br />
<br />
===POST api/v1/uploads/{uploadId}/copy===<br />
<br />
Copy uploaded file to attachment, image or archive (edited)<br />
<br />
'''''URL Parameter:'''''<br />
* uploadId -> The unique ID of the upload session<br />
<br />
'''''Body:'''''<br />
*copyLocation -> The copy location of the destination record (ARCHIVE, IMAGE or ATTACHMENT)<br />
* tableName -> The table name of the destination record (optional)<br />
*recordId -> The record id/uuid of the destination record (optional)<br />
<br />
'''''Returns:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*tableName -> The table name of the destination record<br />
*recordId -> The record id of the destination record<br />
*recordUU -> The record uuid of the destination record<br />
*copyLocation -> The copy location of the destination record, e.g. archive (default), image or attachment<br />
* fileName -> The name of the file being copied<br />
*contentType -> The MIME type of the file being copied (e.g., "image/png", "application/pdf")<br />
* fileSize -> The size of the file being copied<br />
<br />
== Batch request api/v1/batch ==<br />
<br />
===POST api/v1/batch===<br />
<br />
Execute one or more sub-request in single transaction<br />
<br />
'''''Body:'''''<br />
<br />
Arrays of:<br/><br />
*method -> HTTP method "POST", "PUT" or "DEL"<br />
*path -> Sub-request resource path, for e.g "v1/model/C_Order"<br />
*body -> JSON body for the sub-request (if applicable)<br />
<br />
'''''Returns:'''''<br />
<br />
Arrays of:<br/><br />
*status -> HTTP status text (OK, Created, etc) return from sub-request<br />
*statusCode -> HTTP status code (200, 201, 400, etc) return from sub-request<br />
*body -> JSON return from sub-request (if available)<br />
<br />
=SysConfig Keys=<br />
<br />
==IDEMPIERE_REST_EXPOSE_JWK==<br />
<br />
Y/N - defaults to N<br />
<br />
For integration with krakend (see [[Proxy iDempiere-Rest Through KrakenD]]) it is necessary to expose the signing key in the endpoint api/v1/auth/jwk<br />
<br />
Setting this to N (the default) the endpoint is not exposed, changing to Y it will expose the endpoint.<br />
<br />
Scope: System<br />
<br />
==REST_COLUMNNAME_TOLOWERCASE ==<br />
<br />
Y/N - defaults to N<br />
<br />
When set to Y the columnnames are translated to be named as json properties. The first letter is changed to lowercase when the columnname doesn't contain the underline character ( _ )<br />
<br />
When set to N (the default) the columnname is unchanged<br />
<br />
Scope: System<br />
<br />
==REST_MAX_RECORDS_SIZE==<br />
<br />
Numeric, default 100<br />
<br />
This is a System SysConfig defining the maximum number of records returned in a get operation.<br />
<br />
After changing this SysConfig key a server restart is required.<br />
<br />
Note that $top cannot be higher than this configured value.<br />
<br />
Also, REST_MAX_RECORDS_SIZE=0 means unlimited, and in this case the $top takes precedence when defined.<br />
<br />
==REST_USE_SYSCONFIG_SECRET==<br />
<br />
Y/N, defaults to Y (true)<br />
<br />
When set to false (N) iDempiere uses a random key generated every time it is rebooted. Note this creates two problems:<br />
*The tokens generated do not survive a reboot, because the key is changed on every reboot, if there is a valid token, it becomes invalid immediately after the server is rebooted, requiring a new login<br />
*The token is generated per server, so they are not valid in a multi-server environment, load balancing the REST API in a multi-server environment can make the API useless because the token of one server is not valid in the other server<br />
<br />
When set to true (Y), the default, the tokens are generated and signed using a key saved in the System SysConfig REST_TOKEN_SECRET, so they are shared between servers and survive a reboot.<br />
<br />
Scope: System<br />
<br />
== REST_TOKEN_SECRET==<br />
<br />
In this SysConfig is preserved a random key generated, in case they key is compromised, or as a security measure, a new key can be generated using the process ''Expire Server Secret''<br />
<br />
You don't need to touch this SysConfig, it is managed automatically.<br />
<br />
==REST_TOKEN_EXPIRE_IN_MINUTES==<br />
<br />
This Tenant SysConfig set the duration of token expiration in minutes. The default is 60 minutes (1 hour). Zero (0) means no expiration. If you need to change the default number, you can add this to System Configurator and set configured value with your value.<br />
<br />
==REST_REFRESH_TOKEN_EXPIRE_IN_MINUTES==<br />
<br />
This Tenant SysConfig set the duration of refresh token expiration in minutes. This expiration is equivalent to inactivity of the session, every time the token is refreshed is set to expire again to these minutes. The default is 1440 minutes (1 day). Zero (0) means no expiration. If you need to change the default number, you can add this to System Configurator and set configured value with your value.<br />
<br />
== REST_TOKEN_ABSOLUTE_EXPIRE_IN_MINUTES==<br />
<br />
This Tenant SysConfig set the duration of a session, after this expiration the refresh token doesn't work anymore and the user needs to login again using a password. The default is 10080 minutes (1 week). Zero (0) means no expiration. If you need to change the default number, you can add this to System Configurator and set configured value with your value.<br />
<br />
==REST_MANDATORY_CLIENT_ID_ON_REFRESH==<br />
<br />
The auth/refresh endpoint requires a clientId parameter to work correctly. If your application cannot provide clientId you can set this SysConfig to N to make it optional.<br />
<br />
==REST_MANDATORY_USER_ID_ON_REFRESH==<br />
<br />
The auth/refresh endpoint requires an userId parameter to work correctly. If your application cannot provide userId you can set this SysConfig to N to make it optional.<br />
<br />
==REST_ALLOW_UPDATE_SECURE_COLUMN==<br />
<br />
By default REST allows to update columns marked as secure or encrypted. This System SysConfig changes this behavior, if you add it and set it to N, then the secure or encrypted columns cannot be updated.<br />
<br />
==REST_ERROR_ON_NON_EXISTING_COLUMN==<br />
<br />
By default REST throws errors when a column mentioned in JSON does not exist. This System SysConfig changes this behavior, if you add it and set it to N, then the REST will not throw an error.<br />
<br />
==REST_ERROR_ON_NON_UPDATABLE_COLUMN==<br />
<br />
By default REST throws errors when a column mentioned in JSON is not updatable. This System SysConfig changes this behavior, if you add it and set it to N, then the REST will not update the column but it won't throw an error<br />
<br />
==REST_EXPAND_SEPARATOR==<br />
<br />
Character - defaults to ;<br />
<br />
Expand supports sub-operators, f.i. select, expand, order by ... By default, these operators are separated using a semicolon ';'. However, this causes a problem because there are API gateways that do not support semicolons as separators, for example, Traefik by default changes semicolons to ampersands or Krakend throws an error when a URL contains a semicolon.<br />
<br />
If you want to change the separator character to something different than ';', set it using this System Configurator.<br />
<br />
Scope: System<br />
<br />
==REST_TABLES_EXPORT_LOOKUP_UU==<br />
By default, REST returns lookup values and foreign keys (FK) as a JSONObject with id, model-name, etc. Sometimes, you might need the UUID as well, but this is not possible with expand in some cases, for instance, when you are getting an FK from a System table. This SysConfig allows you to configure all tables per tenant from which you want to receive the UUID as well. You can fill this SysConfig with ''"ALL"'' (in uppercase) to specify that all FKs should return the UUID, or with a comma-separated string listing all the tables from which you want to get the UUID, for instance, ''"AD_FieldGroup, AD_Field."''<br />
<br />
*''Setting ALL can impact performance.''<br />
*''The table names'' can be in upper or lower case; it does not make a difference.<br />
<br />
=Server to Server Tokens=<br />
<br />
You can generate server to server tokens in the window ''Rest Auth Token''.<br />
<br />
Simply fill the fields:<br />
*Organization<br />
*User<br />
*Role<br />
*Warehouse<br />
*Language<br />
*Expire in Minutes (0 means no expiration)<br />
<br />
And when saving the token will be generated for these parameters.<br />
<br />
[[Image:01_Rest_Auth_Token.png|800px]]<br />
<br />
When a token is generated, the flag ''Active'' indicates if it is a valid token. To active/inactive a token you can use the process ''Inactive/Active Token''.<br />
<br />
[[Image:02_Activate_Inactivate_Token.png|800px]]<br />
<br />
Also, you can change the server secret key, and this inactivate all the issued tokens, using the process ''Expire Server Secret''<br />
<br />
[[Image:03_Expire_Server_Secret.png|800px]]<br />
<br />
=Refresh Tokens Administration=<br />
<br />
With the window ''Rest Refresh Token'' you can review and administer the refresh tokens issued by the server.<br />
<br />
For security reasons the refresh tokens are not deleted, it is recommended to set up a periodic housekeeping that takes care of deleting obsolete and unnecessary tokens.<br />
<br />
When there is a detected breach (a trial to use a refresh token twice) the token is marked as revoked with cause ''Breach'' and all the tokens related to the breached token are revoked too with cause ''Breach Chain'', including the authorization token, so, in case of a breach is mandatory that the user log in again. It is recommended to verify frequently for breaches and take potential actions (f.e. inform the user), this can be done setting an alert.<br />
<br />
Also, when a user changes his/her password all the refresh tokens are revoked with cause ''Password Change''<br />
<br />
=Role access control for resource endpoint=<br />
https://github.com/bxservice/idempiere-rest/issues/290<br />
<p><br />
Role base access control for resource endpoint path.<br />
By default, all resource endpoint path is not protected. Create a new resource path record (Rest_Resource) to protect one more resource endpoints. The resource path definition is a regular expression so you can use .* to protect all endpoint paths and add new resource path records to open access to selected resources (for e.g '''v1/models\b/?.*''').<br />
<br />
==Tables==<br />
1. Rest_Resource<br />
- Name<br />
- Resource Path (regular expression pattern, without the query parameters)<br />
2. Rest_Resource_Access<br />
- AD_Role_ID <br />
- Rest_Resource_ID<br />
- Http Methods (Multi selection list of GET, POST, PUT and DELETE)<br />
<br />
==Window==<br />
1. Rest Resource Window<br />
2. Role Data Access Window<br />
- Added Rest Resource Access tab<br />
<br />
==AD_SysConfig==<br />
1. REST_RESOURCE_ACCESS_CONTROL<br />
- Y/N, System level, default to Y<br />
<br />
==Examples==<br />
See examples at https://github.com/bxservice/idempiere-rest/issues/290<br />
<br />
=OpenAPI Support=<br />
<br />
Generate OpenAPI 3.0.0 yaml for table and view.<br />
<br />
===GET api/v1/models/{tableName}/yaml===<br />
<br />
Get OpenAPI 3.0.0 yaml schema and request for table<br />
<br />
===GET api/v1/views/{viewName}/yaml===<br />
<br />
Get OpenAPI 3.0.0 yaml schema and request for view<br />
<br />
'''''HTTP Header:'''''<br />
*Accept: application/yaml<br />
<br />
=Add Custom End Point=<br />
<br />
You can add new, custom end point with your own plugin.<br />
<br />
To do that, in your plugin:<br />
<br />
*Create resource classes for your end points using jaxrs annotation (@Path, @GET, @POST, etc).<br />
*Create an OSGi component that implements the ResourceExtension interface (@Component(service = ResourceExtension.class, immediate = true)).<br />
*Override the getResourceClasses() method and return the set of resource classes that you have created.<br />
<br />
[[Category:Available Plugins]]<br />
[[Category:Updated2022]]</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=REST_Web_Services&diff=23433REST Web Services2025-07-22T10:51:54Z<p>Hengsin: </p>
<hr />
<div>* '''Maintainers:''' [http://www.bx-service.com BX Service GmbH] team<br />
* '''Status:''' used in production, up to date with release 11 and master<br />
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2]<br />
* '''Sources:''' https://github.com/bxservice/idempiere-rest<br />
* '''Continuous Integration:''' https://jenkins.idempiere.org/job/idempiere-rest/ (installation instructions)<br />
<br />
= Introduction =<br />
The iDempiere REST API is a plugin that allows developers to communicate with an iDempiere server via a RESTful API. This information is delivered via HTTP using JSON. <br />
<br />
The iDempiere REST API seeks to follow the OData standard and uses the following structure and endpoints.<br />
<br />
You can find examples of every call in the [https://github.com/bxservice/idempiere-rest/tree/master/com.trekglobal.idempiere.rest.api/postman postman collection sample files in the official repository].<br />
<br />
= Global URL parameters =<br />
<br />
* '''locale:''' in any call you can use the URL parameter locale <code>?locale={locale}</code> to define the language. For example adding <code>?locale=es_CO</code> to the login URL <code>api/v1/auth/tokens</code> will return any error message in Spanish.<br />
<br />
= Login in to get your Bearer authorization token =<br />
<br />
'''Properties:'''<br />
<br />
* '''userName:'''The user name being authenticated, here you would need to use the user Name or the EMail depending on the [[System Configurator (Window ID-50006)#USE EMAIL FOR LOGIN|SysConfig USE_EMAIL_FOR_LOGIN]]<br />
* '''password:''' the password of the user being authenticated<br />
* parameters:<br />
** '''clientId:''' the client ID from AD_Client, here you can use the AD_Client_ID or the Value for authentication<br />
** '''roleId:''' the role ID from AD_Role, here you can use the AD_Role_ID or the role Name for authentication<br />
** '''organizationId:''' the organization ID from AD_Org, here you can use the AD_Org_ID or the organization Name for authentication<br />
** '''warehouseId:''' the warehouse ID from M_Warehouse, here you can use the M_Warehouse_ID or the warehouse Name for authentication<br />
** '''language:''' the language for the session, as defined in AD_Language.AD_Language<br />
<br />
<br />
'''IMPORTANT:''' REST API just allows to log in to roles with Role Type = WebService, or without Role Type. This means by default is not possible to login with role System, you need to clear the Role Type in System, or even better create a WebService role for System tenant.<br />
<br />
There are two ways to log in to get your authorization token:<br />
<br />
== One-step log-in ==<br />
<br />
When you know beforehand all the login information needed to get into the system, you need to do a POST request to the following endpoint<br />
<br><br />
<code>.../api/v1/auth/tokens</code><br />
<br />
With a body like this:<br />
<syntaxhighlight lang="json"><br />
{<br />
"userName": "{{userName}}",<br />
"password": "{{password}}",<br />
"parameters": {<br />
"clientId": {{clientId}},<br />
"roleId": {{roleId}},<br />
"organizationId": {{organizationId}},<br />
"warehouseId": {{warehouseId}},<br />
"language": "{{language}}"<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
''Change all the {{propertyname}} values to the ones you want to use in your instance.''<br />
<br />
== Normal log-in ==<br />
<br />
If you want to log in as a user would normally do in iDempiere (choosing a role, warehouse, client, etc), you need to do the following requests<br />
<br />
<code>POST .../api/v1/auth/tokens</code><br />
<br><br />
Body:<br />
<syntaxhighlight lang="json"><br />
{<br />
"userName": "{{userName}}",<br />
"password": "{{password}}"<br />
}<br />
</syntaxhighlight><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"clients": [<br />
{<br />
"id": 11,<br />
"name": "GardenWorld"<br />
}<br />
],<br />
"token": "eyJraWQiOiJpZGVtcGllcmUiLCJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJHYXJkZW5BZG1pbiIsImlzcyI6ImlkZW1waWVyZS5vcmciLCJDbGllbnRzIjoiMTEiLCJleHAiOjE2NjY5NjQ5Mjh9.3t0MuK6ReF7xNmb36ITM36VSKI5QnK3n0ZF_LIgPQSrso4oRhDsL8Mudc0NqH4qjvvKDlYsPquYKtrHnB5UiZg"<br />
}<br />
</syntaxhighlight><br />
<br />
With that token you can request for login information from the user that is being authenticated. You need to add it to the request Header with Key value as:<br><br />
<code> Authorization: Bearer {authToken}</code><br />
<br />
The information you can request is the following, and it needs to be done in this order because each request needs information from the previous call:<br><br />
<code>GET .../api/v1/auth/roles?client={clientId}</code><br />
::Returns an array with the roles that the user has access to<br />
<br><br />
<code>GET .../api/v1/auth/organizations?client={clientId}&role={roleId}</code><br />
::Returns an array with the organizations that the user has access to.<br />
<br><br />
<code>/api/v1/auth/warehouses?client={clientId}&role={roleId}&organization={organizationId}</code><br />
::Returns an array with the warehouses that the user has access to.<br />
<br><br />
<code>GET .../api/v1/auth/language?client={clientId}</code><br />
::Returns an array with the languages the user can login with.<br />
<br><br />
When you have all the data you need to do a final PUT request like this:<br />
<br />
<code>PUT .../api/v1/auth/tokens</code><br />
<br />
Body:<br />
<syntaxhighlight lang="json"><br />
{<br />
"clientId": {clientId},<br />
"roleId": {roleId},<br />
"organizationId": {organizationId},<br />
"warehouseId": {warehouseId},<br />
"language": "{language}"<br />
}<br />
</syntaxhighlight><br />
<br />
* ''The language, organizationId and warehouseId properties are optional, it can be omitted and the system will use the default language and 0 for the organization.''<br />
<br />
* ''If the warehouseId property is omitted the system assigns by default the warehouse defined for the organization, if the warehouse is passed as 0, then the login doesn't assign a default warehouse.''<br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"userId": 101,<br />
"language": "en_US",<br />
"token": "eyJraWQiOiJpZGVtcGllcmUiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHYXJkZW5BZG1pbiIsIkFEX0NsaWVudF9JRCI6MTEsIkFEX1VzZXJfSUQiOjEwMSwiQURfUm9sZV9JRCI6MjAwMDAxLCJBRF9PcmdfSUQiOjExLCJNX1dhcmVob3VzZV9JRCI6MTAzLCJBRF9MYW5ndWFnZSI6ImVuX1VTIiwiQURfU2Vzc2lvbl9JRCI6MTAwMDE2MiwiaXNzIjoiaWRlbXBpZXJlLm9yZyIsImV4cCI6MTcwMTc3NTUzN30.bAUEhPylAQhZjZquJhvLpO9zMZG3g6zlM_IqO9ifeXJpAJBOoJtDqd8CrYPU1PKURzoPRSUglbKqr1LsXdz38A",<br />
"refresh_token": "eyJraWQiOiJpZGVtcGllcmUiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIwODk1OTIyNC1iYzBhLTRkNTQtOTlhZS1jNmRmZjNiOGEwMzUiLCJpc3MiOiJpZGVtcGllcmUub3JnIiwiZXhwIjoxNzAxODU4MzM3fQ.uSE5SOtWgPvReC4JtyV4alHd-ccU0L9QhIpP2TwT7C5TJFeCGVYTdyWc291DaIweyiIGCfWFgQlbe0oH1EEXXg"<br />
}<br />
</syntaxhighlight><br />
<br />
= Abbreviated log-in =<br />
The <code>POST .../api/v1/auth/tokens</code> operation described above can be sufficient for a login when the user has only access to one client, one role and one organization. In this case the POST operation returns immediately the token and refresh_token and the payload includes the values that were assumed for the login.<br />
<br />
= Refresh Token =<br />
<br />
As you see above, the login process returns a token and a refresh_token, normally the token expires in 1 hour and the refresh_token expires in 24 hours. These expiration defaults can be changed using SysConfig keys REST_TOKEN_EXPIRE_IN_MINUTES and REST_REFRESH_TOKEN_EXPIRE_IN_MINUTES.<br />
<br />
It is a common practice in front-end development to store the refresh_token in a cookie or browser data, while keeping the token itself just in memory. This approach is taken due to the sensitive nature of the information contained within the token, which must not be disclosed.<br />
<br />
When the token expires, you can get a new token calling the following request:<br />
<br />
<code>POST .../api/v1/auth/refresh</code><br />
<br><br />
Body:<syntaxhighlight lang="json"><br />
{<br />
"refresh_token": "{{refreshToken}}",<br />
"clientId": {{clientId}},<br />
"userId": 101<br />
}<br />
</syntaxhighlight><br />
<br />
Note that clientId and userId are recommended, but optional, it can be disabled with the SysConfig keys REST_MANDATORY_CLIENT_ID_ON_REFRESH=N and REST_MANDATORY_USER_ID_ON_REFRESH=N<br />
<br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"token": "eyJraWQiOiJpZGVtcGllcmUiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHYXJkZW5BZG1pbiIsIkFEX0NsaWVudF9JRCI6MTEsIkFEX1VzZXJfSUQiOjEwMSwiQURfUm9sZV9JRCI6MTAyLCJBRF9PcmdfSUQiOjExLCJNX1dhcmVob3VzZV9JRCI6MTAzLCJBRF9MYW5ndWFnZSI6ImVuX1VTIiwiQURfU2Vzc2lvbl9JRCI6MTAwMDIyMCwiaXNzIjoiaWRlbXBpZXJlLm9yZyIsImV4cCI6MTczMDgxNTUwM30.MzmpXlpuIUjKkYdKi2G50ORcSt2FcLT4-x-OO1LVzDDoO8lNm7P9ELaWWViKktOzN_pKtocIA59LlXzXBmWVtA",<br />
"refresh_token": "eyJraWQiOiJpZGVtcGllcmUiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiZTQ3Zjg4YjkyMmU5MzU5NzEwNmRlNWIwOGQ1ZDljMjk3OTQxMzNkNjYxMWFjOWZkMmI1NGE5NWExODFjNDIxIiwiaXNzIjoiaWRlbXBpZXJlLm9yZyJ9.efa6M1oOb_QDnSKopNsdDygd1fF3S-ozr3DXjn1qANyPEVK-kg3Y2anGXrqQCtUzmxWBi8eTY4C6r5wXY6jtFA"<br />
}<br />
</syntaxhighlight><br />
<br />
The new tokens are set with new expiration times as configured.<br />
<br />
Refresh tokens can be expired (deleted) using the process "Expire Refresh Tokens"<br />
<br />
A refresh token can be used just one time. If a refresh token tries to be used a second time a potential breach is set on the system and all the tokens associated with the refresh token are invalidated.<br />
<br />
= Logout =<br />
<br />
Logout a session from a token.<br />
<br />
<code>POST .../api/v1/auth/logout</code><br />
<br><br />
Body:<syntaxhighlight lang="json"><br />
{<br />
"token": "{{authToken}}"<br />
}<br />
</syntaxhighlight><br />
<br />
The session associated to the token will be logged out.<br />
<br />
This token cannot be used again, neither the refresh token associated.<br />
<br />
= Common Headers =<br />
<br />
* Content-Type: application/json<br />
* Accept: application/json<br />
* Authorization: Bearer {authToken}<br />
** All calls except the first one (POST/auth) require an authorization bearer that is returned by the /auth APIs from the previous steps.<br />
<br />
= Requesting Data =<br />
<br />
iDempiere supports requests for data via HTTP '''GET''' requests.<br />
<br />
On every get request the response will include this information, in addition to the one requested:<br />
* id: the record ID<br />
* uid: the UUID of the record<br />
* model-name: the table name of the record<br />
* {columnname}: each pair of column/value is represented as a json object with the columnname:<br />
** String: strings are represented directly as a json string quoted value<br />
** Yes/No: these are represented as true/false<br />
** Numbers: numbers are represented as a json number without quotes<br />
** Dates/Times: timestamp values are represented as a json date (quoted string with format [https://en.wikipedia.org/wiki/ISO_8601 ISO_8601]<br />
** Foreign keys: these are represented as a json object with the following values:<br />
*** propertyLabel -> the foreign name<br />
*** id -> the foreign record ID<br />
*** identifier -> the foreign identifier<br />
*** model-name -> the foreign table name<br />
** Binary: binary columns are represented directly as a json string base64 encoded value<br />
** Images: these are represented as a json object with the following values:<br />
*** propertyLabel -> the foreign name<br />
*** id -> the foreign record ID<br />
*** data -> a string containing the base64 encoded data for the image<br />
*** model-name -> the foreign table name<br />
<br />
== Requesting PO Collections ==<br />
The request below returns the collection of taxes.<br />
<code>GET /api/v1/models/c_tax</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 4,<br />
"records-size": 2,<br />
"skip-records": 0,<br />
"row-count": 8,<br />
"array-count": 2,<br />
"records": [<br />
{<br />
"id": 106,<br />
"uid": "315dacb1-415c-45e7-8dac-a9a44fa8aca7",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2003-01-08T13:14:01Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "GST",<br />
"Description": "Canadian Federal Sales Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2003-02-22T02:20:37Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 0,<br />
"identifier": "~System (deprecated)~",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "2001-01-01",<br />
"IsSummary": false,<br />
"Rate": 7,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "GST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": false,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
},<br />
{<br />
"id": 107,<br />
"uid": "d76b09c5-531b-4f98-a8c6-9af848b6697b",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2003-01-08T15:06:11Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "PST",<br />
"Description": "Canadian Provintial Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2003-02-22T02:20:37Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 0,<br />
"identifier": "~System (deprecated)~",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "2002-01-01",<br />
"IsSummary": false,<br />
"Rate": 7.5,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "PST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": false,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Requesting an Individual PO by ID ==<br />
The request below returns an individual PO of type tax by the given id "106".<br />
''* You can use here either record id or the UUID (C_Tax_ID or C_Tax_UU value)''<br />
<br />
<code>GET /api/v1/models/c_tax/106</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 106,<br />
"uid": "315dacb1-415c-45e7-8dac-a9a44fa8aca7",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2003-01-08T13:14:01Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "GST",<br />
"Description": "Canadian Federal Sales Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2003-02-22T02:20:37Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 0,<br />
"identifier": "~System (deprecated)~",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "2001-01-01",<br />
"IsSummary": false,<br />
"Rate": 7,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "GST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": false,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
}<br />
</syntaxhighlight><br />
<br />
== Requesting an Individual Property ==<br />
To address an entity property clients append a path segment containing property name to the URL of the entity.<br />
The request below returns the Rate property of a tax.<br />
<code>GET /api/v1/models/c_tax/106/rate</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 106,<br />
"uid": "315dacb1-415c-45e7-8dac-a9a44fa8aca7",<br />
"Rate": 7,<br />
"model-name": "c_tax"<br />
}<br />
</syntaxhighlight><br />
<br />
= Querying Data =<br />
<br />
iDempiere supports various kinds of query options for querying data. This section will help you go through the common scenarios for these query options.<br />
<br />
== Query Option $filter ==<br />
The <code>$filter</code> query option allows developers to filter a collection of resources that are addressed by a request URL. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. These are the basic predicates that are supported:<br />
<br />
* $filter<br />
** Logical operators<br />
*** eq -> equals =<br />
*** neq -> not equals !=<br />
*** in -> IN<br />
*** gt -> greater than ><br />
*** ge -> greater or equal >=<br />
*** lt -> less than <<br />
*** le -> less or equal <=<br />
*** and -> &<br />
*** or -> |<br />
*** not -> !<br />
** Method operators (WARNING: there must not be spaces before/after the parameters on these functions, strings must be surrounded by single quotes):<br />
*** contains -> if a string contains another string<br />
*** startswith -> if a string starts with another string<br />
*** endswith -> if a string ends with another string<br />
*** tolower -> convert a string to lowercase<br />
*** toupper -> convert a string to uppercase<br />
** Parenthesis are supported<br />
<br />
== Examples ==<br />
The request below using $filter to get business partners where IsCustomer = true and IsActive = true and the name starts with 'Pa'<br />
<code>GET /api/v1/models/c_bpartner?$filter=isCustomer eq true AND isActive eq true AND startswith(name,'Pa') AND C_BPartner_ID in (120,121)</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 1,<br />
"records-size": 3,<br />
"skip-records": 0,<br />
"row-count": 1,<br />
"array-count": 1,<br />
"records": [<br />
{<br />
"id": 121,<br />
"uid": "39e85feb-94a2-4e41-ae45-e7d49d7be077",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2003-01-13T10:14:03Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2020-11-11T13:16:05Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Value": "Patio",<br />
"Name": "Patio Fun, Inc.",<br />
"SalesVolume": 0,<br />
"NumberEmployees": 0,<br />
"IsSummary": false,<br />
"AD_Language": {<br />
"propertyLabel": "Language",<br />
"id": "es_CO",<br />
"identifier": "Spanish (Colombia)",<br />
"model-name": "ad_language"<br />
},<br />
"IsVendor": true,<br />
"IsCustomer": true,<br />
"IsProspect": false,<br />
"FirstSale": "2020-11-05",<br />
"SO_CreditLimit": 0,<br />
"SO_CreditUsed": 588.24,<br />
"AcqusitionCost": 0,<br />
"PotentialLifeTimeValue": 0,<br />
"ActualLifeTimeValue": 588.24,<br />
"ShareOfCustomer": 0,<br />
"IsEmployee": false,<br />
"IsSalesRep": false,<br />
"IsOneTime": false,<br />
"IsTaxExempt": false,<br />
"IsDiscountPrinted": true,<br />
"C_BP_Group_ID": {<br />
"propertyLabel": "Business Partner Group",<br />
"id": 104,<br />
"identifier": "Vendors",<br />
"model-name": "c_bp_group"<br />
},<br />
"SendEMail": false,<br />
"SOCreditStatus": {<br />
"propertyLabel": "Credit Status",<br />
"id": "O",<br />
"identifier": "Credit OK",<br />
"model-name": "ad_ref_list"<br />
},<br />
"TotalOpenBalance": 588.240,<br />
"IsPOTaxExempt": false,<br />
"IsManufacturer": false,<br />
"Is1099Vendor": false,<br />
"IsUseTaxIdDigit": false,<br />
"IsDetailedNames": false,<br />
"model-name": "c_bpartner"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Query Option $expand ==<br />
iDempiere supports nested filters in <code>$expand</code>. <br />
<br />
The request below return Orders and all their Lines and Taxes.<br />
<code>GET /api/v1/models/c_order?$expand=c_orderLine,c_ordertax</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 68,<br />
"records-size": 1,<br />
"skip-records": 0,<br />
"row-count": 68,<br />
"array-count": 1,<br />
"records": [<br />
{<br />
"id": 1000019,<br />
"uid": "7144b00f-a283-465e-8d2d-1fe89eac5748",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 11,<br />
"identifier": "HQ",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-07-22T17:36:20Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-07-22T17:36:20Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"DocumentNo": "50012",<br />
"DocStatus": {<br />
"propertyLabel": "Document Status",<br />
"id": "DR",<br />
"identifier": "Drafted",<br />
"model-name": "ad_ref_list"<br />
},<br />
"C_DocType_ID": {<br />
"propertyLabel": "Document Type",<br />
"id": 0,<br />
"identifier": "** New **",<br />
"model-name": "c_doctype"<br />
},<br />
"C_DocTypeTarget_ID": {<br />
"propertyLabel": "Target Document Type",<br />
"id": 132,<br />
"identifier": "Standard Order",<br />
"model-name": "c_doctype"<br />
},<br />
"Description": "Order Description from Business Partner Definition",<br />
"IsApproved": true,<br />
"IsCreditApproved": false,<br />
"IsDelivered": false,<br />
"IsInvoiced": false,<br />
"IsPrinted": false,<br />
"IsTransferred": false,<br />
"DateOrdered": "2021-07-19",<br />
"DatePromised": "2021-07-19",<br />
"DateAcct": "2021-07-19",<br />
"SalesRep_ID": {<br />
"propertyLabel": "Sales Representative",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"C_PaymentTerm_ID": {<br />
"propertyLabel": "Payment Term",<br />
"id": 106,<br />
"identifier": "2%10 Net 30",<br />
"model-name": "c_paymentterm"<br />
},<br />
"C_Currency_ID": {<br />
"propertyLabel": "Currency",<br />
"id": 102,<br />
"identifier": "EUR",<br />
"model-name": "c_currency"<br />
},<br />
"InvoiceRule": {<br />
"propertyLabel": "Invoice Rule",<br />
"id": "I",<br />
"identifier": "Immediate",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightAmt": 0,<br />
"DeliveryViaRule": {<br />
"propertyLabel": "Delivery Via",<br />
"id": "P",<br />
"identifier": "Pickup",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PriorityRule": {<br />
"propertyLabel": "Priority",<br />
"id": "5",<br />
"identifier": "Medium",<br />
"model-name": "ad_ref_list"<br />
},<br />
"TotalLines": 14500,<br />
"GrandTotal": 14500,<br />
"M_Warehouse_ID": {<br />
"propertyLabel": "Warehouse",<br />
"id": 103,<br />
"identifier": "HQ Warehouse",<br />
"model-name": "m_warehouse"<br />
},<br />
"M_PriceList_ID": {<br />
"propertyLabel": "Price List",<br />
"id": 101,<br />
"identifier": "Standard",<br />
"model-name": "m_pricelist"<br />
},<br />
"C_BPartner_ID": {<br />
"propertyLabel": "Business Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"AD_User_ID": {<br />
"propertyLabel": "User/Contact",<br />
"id": 1000011,<br />
"identifier": "Carlitos Boss",<br />
"model-name": "ad_user"<br />
},<br />
"POReference": "Order Reference 1234",<br />
"ChargeAmt": 0,<br />
"Processed": false,<br />
"C_BPartner_Location_ID": {<br />
"propertyLabel": "Partner Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSOTrx": true,<br />
"DeliveryRule": {<br />
"propertyLabel": "Delivery Rule",<br />
"id": "A",<br />
"identifier": "Availability",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightCostRule": {<br />
"propertyLabel": "Freight Cost Rule",<br />
"id": "I",<br />
"identifier": "Freight included",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PaymentRule": {<br />
"propertyLabel": "Payment Rule",<br />
"id": "P",<br />
"identifier": "On Credit",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsDiscountPrinted": true,<br />
"IsTaxIncluded": false,<br />
"IsSelected": false,<br />
"SendEMail": false,<br />
"Bill_User_ID": {<br />
"propertyLabel": "Invoice Contact",<br />
"id": 1000011,<br />
"identifier": "Carlitos Boss",<br />
"model-name": "ad_user"<br />
},<br />
"Bill_BPartner_ID": {<br />
"propertyLabel": "Invoice Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"Bill_Location_ID": {<br />
"propertyLabel": "Invoice Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSelfService": false,<br />
"IsDropShip": false,<br />
"Volume": 0.00,<br />
"Weight": 0.00,<br />
"AmountTendered": 0.00,<br />
"AmountRefunded": 0.00,<br />
"ProcessedOn": 0,<br />
"IsPayScheduleValid": false,<br />
"IsPriviledgedRate": false,<br />
"NetAmtToInvoice": 0,<br />
"model-name": "c_order",<br />
"c_orderLine": [<br />
{<br />
"id": 1000033,<br />
"uid": "0b02614d-bdcd-406f-a9e6-5399ed3a9997",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 11,<br />
"identifier": "HQ",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-07-22T17:36:50Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-07-22T17:36:50Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Line": 10,<br />
"DateOrdered": "2021-07-19",<br />
"DatePromised": "2021-07-19",<br />
"M_Product_ID": {<br />
"propertyLabel": "Product",<br />
"id": 1000295,<br />
"identifier": "Poker_Poker",<br />
"model-name": "m_product"<br />
},<br />
"C_UOM_ID": {<br />
"propertyLabel": "UOM",<br />
"id": 109,<br />
"identifier": "6-Pack",<br />
"model-name": "c_uom"<br />
},<br />
"M_Warehouse_ID": {<br />
"propertyLabel": "Warehouse",<br />
"id": 103,<br />
"identifier": "HQ Warehouse",<br />
"model-name": "m_warehouse"<br />
},<br />
"QtyOrdered": 1,<br />
"QtyReserved": 0,<br />
"QtyDelivered": 0,<br />
"QtyInvoiced": 0,<br />
"C_Currency_ID": {<br />
"propertyLabel": "Currency",<br />
"id": 102,<br />
"identifier": "EUR",<br />
"model-name": "c_currency"<br />
},<br />
"PriceList": 14500,<br />
"PriceActual": 14500,<br />
"C_Tax_ID": {<br />
"propertyLabel": "Tax",<br />
"id": 104,<br />
"identifier": "Standard",<br />
"model-name": "c_tax"<br />
},<br />
"C_BPartner_ID": {<br />
"propertyLabel": "Business Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"FreightAmt": 0,<br />
"C_BPartner_Location_ID": {<br />
"propertyLabel": "Partner Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"LineNetAmt": 14500,<br />
"PriceLimit": 14500,<br />
"Discount": 0.00,<br />
"M_AttributeSetInstance_ID": {<br />
"propertyLabel": "Attribute Set Instance",<br />
"id": 0,<br />
"model-name": "m_attributesetinstance"<br />
},<br />
"IsDescription": false,<br />
"Processed": false,<br />
"PriceEntered": 14500,<br />
"QtyEntered": 1,<br />
"PriceCost": 0,<br />
"QtyLostSales": 0,<br />
"RRAmt": 0<br />
}<br />
]<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
You can add query operators ($filter, $orderyby, $top, $skip, $select) to the detail tables by adding the query operators between parentheses separated by ;.<br><br />
<br />
The request below returns Orders and their Lines (Line number and line net amount) from lines with linnetamt > 1000.<br><br />
<br />
<code>GET /api/v1/models/c_order?$select=DocumentNo,Description&$expand=C_OrderLine($select=Line,Linenetamt ; $filter=LineNetAmt gt 1000 ; $orderby=Line)&$top=5</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 14,<br />
"records-size": 5,<br />
"skip-records": 0,<br />
"row-count": 68,<br />
"array-count": 0,<br />
"records": [<br />
{<br />
"id": 1000019,<br />
"uid": "7144b00f-a283-465e-8d2d-1fe89eac5748",<br />
"DocumentNo": "50012",<br />
"Description": "Order Description from Business Partner Definition",<br />
"model-name": "c_order",<br />
"C_OrderLine": [<br />
{<br />
"id": 1000033,<br />
"uid": "0b02614d-bdcd-406f-a9e6-5399ed3a9997",<br />
"Line": 10,<br />
"LineNetAmt": 14500<br />
}<br />
]<br />
},<br />
{<br />
"id": 1000020,<br />
"uid": "470c98e0-5a19-413d-b589-89fc67272823",<br />
"DocumentNo": "50013",<br />
"Description": "MyCanadian Federal Sales Tax",<br />
"model-name": "c_order"<br />
},<br />
{<br />
"id": 1000018,<br />
"uid": "fb485eb0-6e79-439d-926f-cce53d76d806",<br />
"DocumentNo": "50011",<br />
"Description": "Order Description from Business Partner Definition",<br />
"model-name": "c_order"<br />
},<br />
{<br />
"id": 1000015,<br />
"uid": "040ffe18-04ab-4989-ae83-9ed295146042",<br />
"DocumentNo": "50008",<br />
"model-name": "c_order",<br />
"C_OrderLine": [<br />
{<br />
"id": 1000026,<br />
"uid": "d3eac7ec-caf1-473e-8c22-f5b8cee55d30",<br />
"Line": 10,<br />
"LineNetAmt": 4275.00<br />
}<br />
]<br />
},<br />
{<br />
"id": 1000017,<br />
"uid": "ee3a9225-439a-4022-8eaa-1109e5e4f049",<br />
"DocumentNo": "50010",<br />
"Description": "My Sales Tax",<br />
"model-name": "c_order"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
By default expand searches for the primary key column in the master table and tries to create the relation with this column name in the expanded table. /ad_user?$expand=c_order expands using ad_user_id by default. Sometimes you want to specify which column must be used for the expanding. In this case, you need to specify the column name using a dot after the table name.<br><br />
<br />
The request below returns users and their corresponding orders as sales representatives.<br><br />
<br />
<code>/api/v1/models/ad_user?$expand=C_order.salesrep_id($select=documentno)&$select=Name</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 100,<br />
"uid": "986cb4dc-7161-4d77-a7c7-3832d24b19de",<br />
"Name": "SuperUser",<br />
"model-name": "ad_user",<br />
"C_order": [<br />
{<br />
"id": 104,<br />
"uid": "3456b6d0-b911-42e6-8432-f52ded58713f",<br />
"DocumentNo": "800000"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
iDempiere has special tables where record_id is used, for instance, fact_acct. You can expand to this table using the same syntax as explained above. ''The plug-in will automatically set the correct value for AD_Table_ID''<br><br />
<br />
The request below returns the invoice 104 and their corresponding records on fact_acct.<br><br />
<br />
<code>/api/v1/models/c_invoice/104?$expand=fact_acct.record_id($select=fact_acct_id)&$select=DocumentNo</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 104,<br />
"uid": "6d2768c9-b3cc-4820-b903-9748b416b98f",<br />
"DocumentNo": "10000001",<br />
"model-name": "c_invoice",<br />
"fact_acct": [<br />
{<br />
"id": 1001729,<br />
"uid": "cd02c4e7-b386-46aa-b367-f5ec618dccc8"<br />
},<br />
{<br />
"id": 1001730,<br />
"uid": "e8dfd3ec-d5bf-4ded-9646-0a2a8d86a680"<br />
},<br />
{<br />
"id": 1001731,<br />
"uid": "2bf88ace-83bc-4968-abdd-fd211765da92"<br />
},<br />
{<br />
"id": 1001732,<br />
"uid": "26735041-c88e-4670-89e5-95ae49beb4dc"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
Sometimes you want to expand to a master record as well, for instance, from product to product category. You accomplish this by writing expand followed by the column name you want to expand.<br><br />
<br />
The request below returns the product 122 and its corresponding product category.<br><br />
<br />
<code>/api/v1/models/m_product/122?$expand=m_product_category_id($select=Name,IsDefault)&$select=Name,m_product_category_id</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 122,<br />
"uid": "c713192a-9ed3-4740-ad32-9583c30d0206",<br />
"Name": "Standard",<br />
"model-name": "m_product",<br />
"M_Product_Category_ID": {<br />
"id": 105,<br />
"uid": "be686f7e-993f-4162-a02d-ad4bb8c6987b",<br />
"Name": "Standard",<br />
"IsDefault": true,<br />
"model-name": "m_product_category"<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
''Note: For obvious reasons. $select is the only query operator accepted in this case.''<br />
<br />
You can expand on multiple levels by using the $expand operators within the $expand clause. You can only expand deeper on master > detail records. Cases like GET ../orders?$expand=AD_user_ID($expand=C_orderLine) are forbidden.<br />
<br />
== Query Option $orderby ==<br />
The <code>$orderby</code> query option allows developers to request resources in either ascending order using asc or descending order using desc. If asc or desc not specified, then the resources will be ordered in ascending order. <br />
<br />
The request below orders products on property Value in descending order.<br />
<code>GET /api/v1/models/m_product?$orderby=Value desc</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 37,<br />
"records-size": 3,<br />
"skip-records": 0,<br />
"row-count": 111,<br />
"array-count": 3,<br />
"records": [<br />
{<br />
"id": 1000216,<br />
"uid": "e19114c8-86cc-4fb4-b6eb-15f8fa350d38",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 50001,<br />
"identifier": "Fertilizer",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2020-10-05T18:46:14Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2020-11-23T19:45:12Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "Tron",<br />
"IsSummary": false,<br />
"C_UOM_ID": {<br />
"propertyLabel": "UOM",<br />
"id": 100,<br />
"identifier": "Each",<br />
"model-name": "c_uom"<br />
},<br />
"IsStocked": true,<br />
"IsPurchased": false,<br />
"IsSold": false,<br />
"Volume": 0,<br />
"Weight": 0,<br />
"Value": "zas",<br />
"M_Product_Category_ID": {<br />
"propertyLabel": "Product Category",<br />
"id": 105,<br />
"identifier": "Standard",<br />
"model-name": "m_product_category"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Discontinued": false,<br />
"IsBOM": false,<br />
"IsInvoicePrintDetails": false,<br />
"IsPickListPrintDetails": false,<br />
"IsVerified": false,<br />
"ProductType": {<br />
"propertyLabel": "Product Type",<br />
"id": "I",<br />
"identifier": "Item",<br />
"model-name": "ad_ref_list"<br />
},<br />
"M_AttributeSetInstance_ID": {<br />
"propertyLabel": "Attribute Set Instance",<br />
"id": 0,<br />
"model-name": "m_attributesetinstance"<br />
},<br />
"IsWebStoreFeatured": false,<br />
"IsSelfService": false,<br />
"IsDropShip": false,<br />
"IsExcludeAutoDelivery": false,<br />
"UnitsPerPack": 1,<br />
"LowLevel": 0,<br />
"IsKanban": false,<br />
"IsManufactured": false,<br />
"IsPhantom": false,<br />
"IsOwnBox": false,<br />
"IsAutoProduce": false,<br />
"BXS_IsPricePerUOM": false,<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 1000398,<br />
"uid": "d5d1bb16-81b4-429b-86bf-f667f22b93df",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 50001,<br />
"identifier": "Fertilizer",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-01-20T18:52:06Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-01-20T18:52:06Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "yudo mat",<br />
"IsSummary": false,<br />
"C_UOM_ID": {<br />
"propertyLabel": "UOM",<br />
"id": 100,<br />
"identifier": "Each",<br />
"model-name": "c_uom"<br />
},<br />
"IsStocked": true,<br />
"IsPurchased": true,<br />
"IsSold": true,<br />
"Volume": 0,<br />
"Weight": 0,<br />
"Value": "ym",<br />
"M_Product_Category_ID": {<br />
"propertyLabel": "Product Category",<br />
"id": 106,<br />
"identifier": "Trees",<br />
"model-name": "m_product_category"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Discontinued": false,<br />
"IsBOM": false,<br />
"IsInvoicePrintDetails": false,<br />
"IsPickListPrintDetails": false,<br />
"IsVerified": false,<br />
"ProductType": {<br />
"propertyLabel": "Product Type",<br />
"id": "I",<br />
"identifier": "Item",<br />
"model-name": "ad_ref_list"<br />
},<br />
"M_AttributeSetInstance_ID": {<br />
"propertyLabel": "Attribute Set Instance",<br />
"id": 0,<br />
"model-name": "m_attributesetinstance"<br />
},<br />
"IsWebStoreFeatured": false,<br />
"IsSelfService": true,<br />
"IsDropShip": false,<br />
"IsExcludeAutoDelivery": false,<br />
"UnitsPerPack": 1,<br />
"LowLevel": 0,<br />
"IsKanban": false,<br />
"IsManufactured": false,<br />
"IsPhantom": false,<br />
"IsOwnBox": false,<br />
"IsAutoProduce": false,<br />
"BXS_IsPricePerUOM": false,<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 1000299,<br />
"uid": "1726c817-71bc-4abf-8949-0372c9ffb0d3",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2020-10-08T19:04:22Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2020-10-08T19:04:22Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "Xiaomi Redmi Airdots",<br />
"IsSummary": false,<br />
"C_UOM_ID": {<br />
"propertyLabel": "UOM",<br />
"id": 100,<br />
"identifier": "Each",<br />
"model-name": "c_uom"<br />
},<br />
"IsStocked": true,<br />
"IsPurchased": true,<br />
"IsSold": true,<br />
"Volume": 0,<br />
"Weight": 0,<br />
"Value": "Xiaomi Redmi Airdots",<br />
"M_Product_Category_ID": {<br />
"propertyLabel": "Product Category",<br />
"id": 1000015,<br />
"identifier": "Gadgets",<br />
"model-name": "m_product_category"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"ShelfWidth": 0,<br />
"ShelfHeight": 0,<br />
"ShelfDepth": 0,<br />
"UnitsPerPallet": 0,<br />
"Discontinued": false,<br />
"IsBOM": false,<br />
"IsInvoicePrintDetails": false,<br />
"IsPickListPrintDetails": false,<br />
"IsVerified": false,<br />
"ProductType": {<br />
"propertyLabel": "Product Type",<br />
"id": "I",<br />
"identifier": "Item",<br />
"model-name": "ad_ref_list"<br />
},<br />
"GuaranteeDays": 0,<br />
"M_AttributeSetInstance_ID": {<br />
"propertyLabel": "Attribute Set Instance",<br />
"id": 0,<br />
"model-name": "m_attributesetinstance"<br />
},<br />
"GuaranteeDaysMin": 0,<br />
"IsWebStoreFeatured": false,<br />
"IsSelfService": true,<br />
"IsDropShip": false,<br />
"IsExcludeAutoDelivery": false,<br />
"UnitsPerPack": 0,<br />
"LowLevel": 0,<br />
"IsKanban": false,<br />
"IsManufactured": false,<br />
"IsPhantom": false,<br />
"IsOwnBox": false,<br />
"IsAutoProduce": false,<br />
"BXS_IsPricePerUOM": false,<br />
"model-name": "m_product"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Query Options $top and $skip ==<br />
The <code>$top</code> query option requests the number of items in the queried collection to be included in the result. The <code>$skip</code> query option requests the number of items in the queried collection that are to be skipped and not included in the result.<br />
<br />
The request below return the first two Orders starting with other 5th order.<br />
<code>GET /api/v1/models/c_order?$top=2&$skip=5</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 34,<br />
"records-size": 2,<br />
"skip-records": 5,<br />
"row-count": 68,<br />
"array-count": 2,<br />
"records": [<br />
{<br />
"id": 1000022,<br />
"uid": "2238dc66-edda-41f7-8348-d781342f6dfc",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 11,<br />
"identifier": "HQ",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-07-29T15:59:51Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-07-29T15:59:51Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"DocumentNo": "50015",<br />
"DocStatus": {<br />
"propertyLabel": "Document Status",<br />
"id": "DR",<br />
"identifier": "Drafted",<br />
"model-name": "ad_ref_list"<br />
},<br />
"C_DocType_ID": {<br />
"propertyLabel": "Document Type",<br />
"id": 0,<br />
"identifier": "** New **",<br />
"model-name": "c_doctype"<br />
},<br />
"C_DocTypeTarget_ID": {<br />
"propertyLabel": "Target Document Type",<br />
"id": 132,<br />
"identifier": "Standard Order",<br />
"model-name": "c_doctype"<br />
},<br />
"IsApproved": false,<br />
"IsCreditApproved": false,<br />
"IsDelivered": false,<br />
"IsInvoiced": false,<br />
"IsPrinted": false,<br />
"IsTransferred": false,<br />
"DateOrdered": "2021-07-29",<br />
"DatePromised": "2021-07-29",<br />
"DateAcct": "2021-07-29",<br />
"SalesRep_ID": {<br />
"propertyLabel": "Sales Representative",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"C_PaymentTerm_ID": {<br />
"propertyLabel": "Payment Term",<br />
"id": 105,<br />
"identifier": "Immediate",<br />
"model-name": "c_paymentterm"<br />
},<br />
"C_Currency_ID": {<br />
"propertyLabel": "Currency",<br />
"id": 102,<br />
"identifier": "EUR",<br />
"model-name": "c_currency"<br />
},<br />
"InvoiceRule": {<br />
"propertyLabel": "Invoice Rule",<br />
"id": "I",<br />
"identifier": "Immediate",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightAmt": 0.0,<br />
"DeliveryViaRule": {<br />
"propertyLabel": "Delivery Via",<br />
"id": "P",<br />
"identifier": "Pickup",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PriorityRule": {<br />
"propertyLabel": "Priority",<br />
"id": "5",<br />
"identifier": "Medium",<br />
"model-name": "ad_ref_list"<br />
},<br />
"TotalLines": 0.0,<br />
"GrandTotal": 0.0,<br />
"M_Warehouse_ID": {<br />
"propertyLabel": "Warehouse",<br />
"id": 103,<br />
"identifier": "HQ Warehouse",<br />
"model-name": "m_warehouse"<br />
},<br />
"M_PriceList_ID": {<br />
"propertyLabel": "Price List",<br />
"id": 101,<br />
"identifier": "Standard",<br />
"model-name": "m_pricelist"<br />
},<br />
"C_BPartner_ID": {<br />
"propertyLabel": "Business Partner",<br />
"id": 112,<br />
"identifier": "Standard",<br />
"model-name": "c_bpartner"<br />
},<br />
"AD_User_ID": {<br />
"propertyLabel": "User/Contact",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"ChargeAmt": 0.0,<br />
"Processed": false,<br />
"C_BPartner_Location_ID": {<br />
"propertyLabel": "Partner Location",<br />
"id": 108,<br />
"identifier": "Monroe",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSOTrx": true,<br />
"DeliveryRule": {<br />
"propertyLabel": "Delivery Rule",<br />
"id": "A",<br />
"identifier": "Availability",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightCostRule": {<br />
"propertyLabel": "Freight Cost Rule",<br />
"id": "I",<br />
"identifier": "Freight included",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PaymentRule": {<br />
"propertyLabel": "Payment Rule",<br />
"id": "P",<br />
"identifier": "On Credit",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsDiscountPrinted": false,<br />
"IsTaxIncluded": false,<br />
"IsSelected": false,<br />
"SendEMail": false,<br />
"Bill_BPartner_ID": {<br />
"propertyLabel": "Invoice Partner",<br />
"id": 112,<br />
"identifier": "Standard",<br />
"model-name": "c_bpartner"<br />
},<br />
"Bill_Location_ID": {<br />
"propertyLabel": "Invoice Location",<br />
"id": 108,<br />
"identifier": "Monroe",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSelfService": false,<br />
"IsDropShip": false,<br />
"IsPayScheduleValid": false,<br />
"IsPriviledgedRate": false,<br />
"NetAmtToInvoice": 0.0,<br />
"model-name": "c_order"<br />
},<br />
{<br />
"id": 1000016,<br />
"uid": "5565e213-a119-4bcc-beb6-c9f9a4e75dab",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 11,<br />
"identifier": "HQ",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-03-09T14:20:31Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-03-09T14:20:59Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"DocumentNo": "50009",<br />
"DocStatus": {<br />
"propertyLabel": "Document Status",<br />
"id": "CO",<br />
"identifier": "Completed",<br />
"model-name": "ad_ref_list"<br />
},<br />
"C_DocType_ID": {<br />
"propertyLabel": "Document Type",<br />
"id": 132,<br />
"identifier": "Standard Order",<br />
"model-name": "c_doctype"<br />
},<br />
"C_DocTypeTarget_ID": {<br />
"propertyLabel": "Target Document Type",<br />
"id": 132,<br />
"identifier": "Standard Order",<br />
"model-name": "c_doctype"<br />
},<br />
"Description": "Order Description from Business Partner Definition",<br />
"IsApproved": true,<br />
"IsCreditApproved": false,<br />
"IsDelivered": false,<br />
"IsInvoiced": false,<br />
"IsPrinted": false,<br />
"IsTransferred": false,<br />
"DateOrdered": "2021-02-16",<br />
"DatePromised": "2021-02-25",<br />
"DateAcct": "2021-02-16",<br />
"SalesRep_ID": {<br />
"propertyLabel": "Sales Representative",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"C_PaymentTerm_ID": {<br />
"propertyLabel": "Payment Term",<br />
"id": 106,<br />
"identifier": "2%10 Net 30",<br />
"model-name": "c_paymentterm"<br />
},<br />
"C_Currency_ID": {<br />
"propertyLabel": "Currency",<br />
"id": 102,<br />
"identifier": "EUR",<br />
"model-name": "c_currency"<br />
},<br />
"InvoiceRule": {<br />
"propertyLabel": "Invoice Rule",<br />
"id": "I",<br />
"identifier": "Immediate",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightAmt": 0,<br />
"DeliveryViaRule": {<br />
"propertyLabel": "Delivery Via",<br />
"id": "P",<br />
"identifier": "Pickup",<br />
"model-name": "ad_ref_list"<br />
},<br />
"M_Shipper_ID": {<br />
"propertyLabel": "Shipper",<br />
"id": 100,<br />
"identifier": "UPS",<br />
"model-name": "m_shipper"<br />
},<br />
"PriorityRule": {<br />
"propertyLabel": "Priority",<br />
"id": "5",<br />
"identifier": "Medium",<br />
"model-name": "ad_ref_list"<br />
},<br />
"TotalLines": 95.00,<br />
"GrandTotal": 95.00,<br />
"M_Warehouse_ID": {<br />
"propertyLabel": "Warehouse",<br />
"id": 103,<br />
"identifier": "HQ Warehouse",<br />
"model-name": "m_warehouse"<br />
},<br />
"M_PriceList_ID": {<br />
"propertyLabel": "Price List",<br />
"id": 101,<br />
"identifier": "Standard",<br />
"model-name": "m_pricelist"<br />
},<br />
"C_BPartner_ID": {<br />
"propertyLabel": "Business Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"AD_User_ID": {<br />
"propertyLabel": "User/Contact",<br />
"id": 1000011,<br />
"identifier": "Carlitos Boss",<br />
"model-name": "ad_user"<br />
},<br />
"POReference": "Order Reference 1234",<br />
"ChargeAmt": 0,<br />
"Processed": true,<br />
"C_BPartner_Location_ID": {<br />
"propertyLabel": "Partner Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSOTrx": true,<br />
"DeliveryRule": {<br />
"propertyLabel": "Delivery Rule",<br />
"id": "A",<br />
"identifier": "Availability",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightCostRule": {<br />
"propertyLabel": "Freight Cost Rule",<br />
"id": "F",<br />
"identifier": "Fix price",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PaymentRule": {<br />
"propertyLabel": "Payment Rule",<br />
"id": "P",<br />
"identifier": "On Credit",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsDiscountPrinted": true,<br />
"IsTaxIncluded": false,<br />
"IsSelected": false,<br />
"SendEMail": false,<br />
"Bill_User_ID": {<br />
"propertyLabel": "Invoice Contact",<br />
"id": 1000011,<br />
"identifier": "Carlitos Boss",<br />
"model-name": "ad_user"<br />
},<br />
"Bill_BPartner_ID": {<br />
"propertyLabel": "Invoice Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"Bill_Location_ID": {<br />
"propertyLabel": "Invoice Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSelfService": false,<br />
"IsDropShip": false,<br />
"Volume": 0.00,<br />
"Weight": 0.00,<br />
"ProcessedOn": 1615296059621.6216,<br />
"IsPayScheduleValid": false,<br />
"IsPriviledgedRate": false,<br />
"NetAmtToInvoice": 0.00,<br />
"model-name": "c_order"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Query Option $select ==<br />
The <code>$select</code> query option allows the clients to requests a limited set of properties for each entity or complex type. <br />
<br />
The request below returns Name and Value of all products.<br />
<code>GET /api/v1/models/m_product?$select=Name,Value</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 28,<br />
"records-size": 4,<br />
"skip-records": 0,<br />
"row-count": 111,<br />
"array-count": 4,<br />
"records": [<br />
{<br />
"id": 1000322,<br />
"uid": "b0e7e8b6-13ed-406d-a105-bd67ddb7f423",<br />
"Name": "Mug 50",<br />
"Value": "Mug 50",<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 134,<br />
"uid": "01254fee-c75f-42f0-941c-142e27078643",<br />
"Name": "Patio Table",<br />
"Value": "PTable",<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 137,<br />
"uid": "26a7e6d7-e2c1-4c21-97f2-773dc222e6a2",<br />
"Name": "Mulch 10#",<br />
"Value": "Mulch",<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 50003,<br />
"uid": "8a27ac0a-56c0-4a3a-8eb8-ff87c94899c1",<br />
"Name": "Ultra Glue",<br />
"Value": "UltraGlue",<br />
"model-name": "m_product"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== iDempiere specific query Options ==<br />
<br />
=== Query Option $valrule ===<br />
<br />
The query option <code>$valrule</code> can be used to get PO records using a validation rule - AD_ValRule_ID or AD_ValRule_UU<br />
<br />
=== Query Option $context ===<br />
<br />
The query option <code>$context</code> can be used to put variables in context to be parsed by the validation rule<br />
<br />
=== Query Option showsql ===<br />
<br />
The query option <code>showsql</code> can be used to add the SQL query being executed on GET.<br />
<br />
You can also use <code>showsql=nodata</code> to obtain just information about the query without returning the real data.<br />
<br />
The payload will include a JSON element with name <code>sql-command</code> containing the query that is executed in the database to obtain the record(s).<br />
<br />
When <code>showsql</code> is used at the same time with <code>$expand</code>, then the payload will include the <code>sql-command</code> JSON element for the query on the master table, and also it will include the elements with format <code>sql-command-[table]</code> for each expanded table, for example the following query:<br />
<br />
<code>GET .../api/v1/models/c_tax/106?$expand=c_tax_acct&showsql</code><br />
<br />
will return the following elements in the payload:<br />
<br />
<syntaxhighlight lang="json"><br />
"sql-command": "SELECT C_Tax_ID,AD_Client_ID,AD_Org_ID,IsActive,Created,CreatedBy,Name,Description,Parent_Tax_ID,C_Country_ID,C_Region_ID,To_Country_ID,To_Region_ID,C_TaxCategory_ID,Updated,UpdatedBy,IsDocumentLevel,ValidFrom,IsSummary,Rate,RequiresTaxCertificate,TaxIndicator,IsDefault,IsTaxExempt,SOPOType,IsSalesTax,AD_Rule_ID,C_Tax_UU,C_TaxProvider_ID,C_CountryGroupTo_ID,C_CountryGroupFrom_ID FROM C_Tax WHERE (c_tax_ID=?) AND C_Tax.AD_Client_ID IN(0,11) AND (C_Tax.AD_Org_ID IN (0,11,12,50000,1000000,50002,50001,50004,50006,50005,50007))",<br />
"sql-command-c_tax_acct": "SELECT C_Tax_ID,C_AcctSchema_ID,AD_Client_ID,AD_Org_ID,IsActive,Created,CreatedBy,Updated,UpdatedBy,T_Due_Acct,T_Credit_Acct,T_Expense_Acct,C_Tax_Acct_UU FROM C_Tax_Acct WHERE (c_tax_ID=?) AND IsActive=? AND C_Tax_Acct.AD_Client_ID IN(0,11) AND (C_Tax_Acct.AD_Org_ID IN (0,11,12,50000,1000000,50002,50001,50004,50006,50005,50007))",<br />
</syntaxhighlight><br />
<br />
=== Query Option label ===<br />
<br />
The query option <code>label</code> can be used to get PO records by filtering based on labels (i.e. <code>AD_Label</code>). For example, <code>GET /api/v1/models/C_BPartner?label=Name eq '%23Customer'</code> query will return all business partner records where the name of the Assigned Label > Label is '#Customer'.<br />
<br />
iDempiere supports using nested <code>label</code> within the <code>$expand</code> query option.<br />
<br />
Refer to the <code>$filter</code> query option for the supported predicates.<br />
<br />
=== Query Option showlabel ===<br />
<br />
The query option <code>showlabel</code> can be used to include the list of assigned labels in the payload when getting a PO record or records. <br />
<br />
The query below returns the business partner record along with a list of assigned label objects, including all columns.<br />
<br />
<code>GET /api/v1/models/C_BPartner/119?showlabel&$select=Name,IsCustomer,IsVendor</code><br />
<br />
Response payload:<syntaxhighlight lang="json"><br />
{<br />
"id": 119,<br />
"uid": "61a84a1b-37a0-4dda-80a2-3ee218522b32",<br />
"Name": "GardenUser BP",<br />
"IsVendor": true,<br />
"IsCustomer": true,<br />
"model-name": "c_bpartner",<br />
"assigned-labels": [<br />
{<br />
"id": 1000000,<br />
"uid": "6d550225-2e0a-4203-9b82-0f2634f7d079",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Tenant",<br />
"id": 11,<br />
"identifier": "GardenWorld",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"Created": "2025-04-11T13:11:54Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2025-04-16T17:35:43Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"IsActive": true,<br />
"Description": "Customers",<br />
"Name": "#Customer",<br />
"model-name": "ad_label"<br />
},<br />
{<br />
"id": 1000001,<br />
"uid": "87ae21d5-f06a-4cd8-977c-86712cf58da1",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Tenant",<br />
"id": 11,<br />
"identifier": "GardenWorld",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"Created": "2025-04-11T13:13:40Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2025-04-16T17:36:54Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"IsActive": true,<br />
"Description": "Vendors",<br />
"Name": "#Vendor",<br />
"model-name": "ad_label"<br />
}<br />
]<br />
}<br />
</syntaxhighlight>You can use <code>showlabel={columnname list}</code> to retrieve a list of assigned label objects, including the defined column list only. For example, the query below returns the business partner record along with a list of assigned label objects including the name and description.<br />
<br />
<code>GET /api/v1/models/C_BPartner/119?showlabel=Name,Description&$select=Name,IsCustomer,IsVendor</code><br />
<br />
Response payload:<syntaxhighlight lang="json"><br />
{<br />
"id": 119,<br />
"uid": "61a84a1b-37a0-4dda-80a2-3ee218522b32",<br />
"Name": "GardenUser BP",<br />
"IsVendor": true,<br />
"IsCustomer": true,<br />
"model-name": "c_bpartner",<br />
"assigned-labels": [<br />
{<br />
"Name": "#Customer",<br />
"Description": "Customers"<br />
},<br />
{<br />
"Name": "#Vendor",<br />
"Description": "Vendors"<br />
}<br />
]<br />
}<br />
</syntaxhighlight>You can use <code>showlabel={columnname}</code> to retrieve the values of the assigned label column. For example, the query below returns the business partner record along with a list of assigned label names.<br />
<br />
<code>GET /api/v1/models/C_BPartner/119?showlabel=Name&$select=Name,IsCustomer,IsVendor</code><br />
<br />
Response payload:<syntaxhighlight lang="json"><br />
{<br />
"id": 119,<br />
"uid": "61a84a1b-37a0-4dda-80a2-3ee218522b32",<br />
"Name": "GardenUser BP",<br />
"IsVendor": true,<br />
"IsCustomer": true,<br />
"model-name": "c_bpartner",<br />
"assigned-labels": [<br />
"#Customer",<br />
"#Vendor"<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
= Data Modification =<br />
<br />
iDempiere supports Create, Update and Delete operation for some or all exposed POs.<br />
<br />
== Create a PO (POST) ==<br />
To create a PO in a collection, the client sends a POST request to that collection's URL. The POST body MUST contain a single valid entity representation. <br />
<br />
The request below creates a Tax which contains complex type and collection property. <br />
<code>POST api/v1/models/c_tax</code><br />
<br />
Body<br><br />
<syntaxhighlight lang="json"><br />
{<br />
"AD_Org_ID": {<br />
"id": 0,<br />
"tableName": "AD_Org"<br />
},<br />
"isActive": true,<br />
"name": "MyGST",<br />
"description": "MyCanadian Federal Sales Tax",<br />
"Parent_Tax_ID": {<br />
"identifier": "GST/PST",<br />
"tableName": "C_Tax"<br />
},<br />
"C_Country_ID": {<br />
"lookupColumn": "CountryCode",<br />
"lookupValue": "CA"<br />
},<br />
"To_Country_ID": {<br />
"identifier": "Canada",<br />
"tableName": "C_Country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"identifier": "Standard",<br />
"tableName": "C_TaxCategory"<br />
},<br />
"isDocumentLevel": false,<br />
"validFrom": "01/01/2001",<br />
"isSummary": false,<br />
"rate": "7.0",<br />
"requiresTaxCertificate": false,<br />
"taxIndicator": "GST",<br />
"isDefault": false,<br />
"isTaxExempt": false,<br />
"sOPOType": {<br />
"id": "B"<br />
},<br />
"isSalesTax": false,<br />
"tableName": "C_Tax"<br />
}<br />
</syntaxhighlight><br />
<br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 1000005,<br />
"uid": "4e71df80-f3f5-41cd-84cf-2bc8e12322d0",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2022-10-28T15:44:44Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "Standard 19%",<br />
"Description": "MyCanadian Federal Sales Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2022-10-28T15:44:44Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "1990-01-01",<br />
"IsSummary": false,<br />
"Rate": 7.0,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "GST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": false,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
}<br />
</syntaxhighlight><br />
<br />
== Remove a PO (DELETE) ==<br />
The request below deletes the Tax with id '1000005'.<br />
<code>DELETE /api/v1/models/c_tax/1000005</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"msg": "Deleted"<br />
}<br />
</syntaxhighlight><br />
<br />
== Update a PO (PUT) ==<br />
The request below updates the tax with id 1000000 <br />
<code>PUT /api/v1/models/c_tax/1000000</code><br />
<br />
Body:<br />
<syntaxhighlight lang="json"><br />
{<br />
"name": "Standard Tax"<br />
}<br />
</syntaxhighlight><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 1000002,<br />
"uid": "a1c76f9b-30ea-44c1-a8c3-2bc27daa1cd1",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2020-08-21T18:29:28Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "Standard Tax",<br />
"Description": "My Sales Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2022-10-28T15:48:14Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "1990-01-01",<br />
"IsSummary": false,<br />
"Rate": 6.0,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "GST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": true,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
}<br />
</syntaxhighlight><br />
<br />
=== Update/Insert/Delete child records of a PO (PUT) ===<br />
Update the child records of a PO using the child record array in the PUT request Body:<br />
* Without child record id to create<br />
* With child record id to update<br />
* With child record id and the following delete flag to delete a child record.<syntaxhighlight lang="json">"(delete)":true</syntaxhighlight> <br />
<p><br />
Examples to delete, create and update order lines:<br/><br />
PUT /api/v1/models/c_order/1000000<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"C_OrderLine": [<br />
{<br />
"id": 1000000,<br />
"(delete)": true<br />
}<br />
{<br />
"M_Product_ID": 128,<br />
"QtyEntered": 1<br />
},<br />
{<br />
"id": 1000001,<br />
"QtyEntered": 2<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Special Entity Type Representations ==<br />
<br />
=== Image ===<br />
If you are modifying or creating values of an Image type column/field, the json entity representation must be as follows: <br />
* id -> the foreign record ID. If not informed a new foreign record will be created and linked to the main record<br />
* file_name -> the readable file name to be stored at the foreign table<br />
* url -> an optional URL for the image to be stored at the foreign table<br />
* data -> a string with the base64 encoded data for the image<br />
<br />
= Other Resources =<br />
<br />
=== GET api/v1/auth/jwk ===<br />
<br />
Calling this endpoint returns the key used to sign the JWT.<br />
<br />
By default this endpoint returns nothing. It requires the System Configurator IDEMPIERE_REST_EXPOSE_JWK to be set to Y on System tenant.<br />
<br />
<span style="color:red>'''WARNING!'''</span> Exposing the signature key is intended exclusively for integration with API gateways that requires it (like krakend), and this endpoint MUST be hidden from public usage and exposed JUST to the API gateway. Exposing the key publicly open the REST interface to attacks changing the JWT token.<br />
<br />
'''''Returns:'''''<br />
* keys<br />
** alg<br />
** k<br />
** kid<br />
** kty<br />
<br />
=== GET api/v1/models/{tablename}/{recordId}/print ===<br />
This method is used to get the print format from the model's record id.<br />
<br />
'''''URL Parameters:'''''<br />
* $report_type -> optional - ( PDF | HTML | CSV | XLSX | XLS )<br />
<br />
'''''Returns:'''''<br />
* AD_PInstance_ID<br />
* process<br />
* summary<br />
* isError<br />
* reportFile<br />
* reportFileName<br />
* reportFileLength<br />
* nodeId<br />
<br />
== Windows api/v1/windows ==<br />
<br />
working with AD_Window and AD_Tab<br />
<br />
== Forms api/v1/forms ==<br />
<br />
=== GET api/v1/forms ===<br />
<br />
Get Forms available<br />
<br />
'''''URL Parameters:'''''<br />
* $filter -> optional - used to filter the query<br />
<br />
'''''Returns:'''''<br />
* an array of PO json records from the forms (AD_Form) queried<br />
<br />
== Processes api/v1/processes ==<br />
<br />
working with process and reports<br />
<br />
=== GET api/v1/processes ===<br />
<br />
Get Processes available<br />
<br />
'''''URL Parameters:'''''<br />
* $filter -> optional - used to filter the query<br />
<br />
'''''Returns:'''''<br />
* an array of PO json records from the process (AD_Process) queried<br />
<br />
=== GET api/v1/processes/{process_value} ===<br />
<br />
Get Information from a process<br />
<br />
'''''URL Parameters:'''''<br />
* {process_value} -> value of the process (in slug form - lowercase)<br />
<br />
'''''Returns:'''''<br />
* an PO json record from the process (AD_Process) queried<br />
<br />
=== POST api/v1/processes/{process_value} ===<br />
<br />
Run a process<br />
<br />
'''''URL Parameters:'''''<br />
* {process_value} -> value of the process (in slug form - lowercase)<br />
for example <code>https://demo.globalqss.com/api/v1/processes/translationimpexp</code><br />
<br />
'''''Body:'''''<br />
* {process_parameters} -> a JSON representation of the process parameters, for example:<br />
<syntaxhighlight lang=json><br />
{<br />
"ImportOrExport": "export",<br />
"AD_Language": "es_CO",<br />
"IsOnlyCentralizedData": true<br />
}<br />
</syntaxhighlight><br />
<br />
for reports three special parameters can be added:<br />
* report-type: with the possible values HTML, CSV, XLS or PDF (the default)<br />
* is-summary<br />
* print-format-id<br />
<br />
also, for buttons is possible to define two special parameters:<br />
* table-id or model-name<br />
* record-id<br />
<br />
'''''Returns:'''''<br />
* JSON information about the process/report executed:<br />
** AD_PInstance_ID<br />
** process<br />
** summary<br />
** isError<br />
** nodeId<br />
** logs - array containing the logs from the process<br />
<br />
The reports will be returned in an object with name <code>reportFile</code> containing the base64 encoded report, and additionally the objects <code>reportFileName</code> and <code>reportFileLength</code>.<br />
<br />
If the process produces an export file it will be returned in an object <code>exportFile</code>, and additionally the objects <code>exportFileName</code> and <code>exportFileLength</code>.<br />
<br />
=== GET api/v1/processes/jobs ===<br />
<br />
Get information about jobs running<br />
<br />
'''''Returns:'''''<br />
* an array of json records from the process running (AD_PInstance)<br />
<br />
=== GET api/v1/processes/jobs/{ad_pinstance_id} ===<br />
<br />
Get Information from a job<br />
<br />
'''''URL Parameters:'''''<br />
* {ad_pinstance_id}<br />
<br />
'''''Returns:'''''<br />
* a json record from the process (AD_PInstance)<br />
<br />
=== POST api/v1/processes/jobs/{process_value} ===<br />
<br />
Run a process in background (as job)<br />
<br />
'''''URL Parameters:'''''<br />
* {process_value} -> value of the process (in slug form - lowercase)<br />
for example <code>https://demo.globalqss.com/api/v1/processes/jobs/translationimpexp</code><br />
<br />
'''''Body:'''''<br />
* {process_parameters} -> a JSON representation of the process parameters (same as for running the process)<br />
<br />
same special parameters apply as for the reports, and additionally you can define the parameter <code>notification-type</code> with the values E, N or B (EMail, Notification or Both)<br />
<br />
'''''Returns:'''''<br />
* JSON information about the AD_PInstance scheduled<br />
<br />
== Files api/v1/files ==<br />
<br />
to access files created by api/v1/processes<br />
<br />
TBD<br />
<br />
== Caches api/v1/caches ==<br />
<br />
=== GET api/v1/caches ===<br />
<br />
Get caches information. This call is restricted just for administrators.<br />
<br />
'''''URL Parameters:'''''<br />
* table_name -> optional - to filter the list of caches<br />
* name -> optional - to filter the list of caches<br />
<br />
'''''Returns:'''''<br />
* caches (array)<br />
** name<br />
** table_name<br />
** size<br />
** expireMinutes<br />
** maxSize<br />
** distributed (boolean)<br />
<br />
=== DEL api/v1/caches ===<br />
<br />
Reset cache. This call requires the role to have permission to execute "Cache Reset" process.<br />
<br />
When called without parameters it reset the whole cache, or just from a table, or just one record.<br />
<br />
'''''URL Parameters:'''''<br />
* table_name -> optional - to restrict the reset to just one table. Case sensitive.<br />
* record_id -> optional - to restrict the reset to just one record. Zero is the same as not set, it clears the cache of the whole table.<br />
<br />
'''''Returns:'''''<br />
* entriesReset (number of entries cleared)<br />
<br />
== Nodes api/v1/nodes ==<br />
<br />
get nodes info, get log files, reset and rotate logs.<br />
<br />
TBD<br />
<br />
== Servers api/v1/servers ==<br />
<br />
servers and schedulers resource<br />
<br />
TBD<br />
<br />
== Infos api/v1/infos ==<br />
<br />
info windows<br />
<br />
TBD<br />
<br />
== Reference api/v1/reference/{id} ==<br />
<br />
You can get a reference list by id/uuid or name.<br />
<br />
'''GET .../api/v1/reference/152'''<br />
<br />
'''GET .../api/v1/reference/42522223-92ae-4405-92dc-e02e2dea61a7'''<br />
<br />
'''GET .../api/v1/reference/C_Order%20DeliveryViaRule'''<br />
<br />
''* Only list and table validation references are supported''<br />
<br />
== Workflows api/v1/workflow ==<br />
<br />
=== GET api/v1/workflow ===<br />
<br />
'''''Returns:'''''<br />
* all suspended, non-processed nodes of the current user<br />
** id<br />
** uid<br />
** model-name<br />
** node-name<br />
** node-description<br />
** priority<br />
** summary<br />
** node-help<br />
** history-records<br />
** table-name<br />
** ad_table_id<br />
** record_id<br />
** node-approval<br />
** node-confirmation<br />
** created<br />
<br />
=== GET api/v1/workflow/{userid} ===<br />
<br />
'''''Returns:'''''<br />
* all suspended, non-processed nodes of the user id passed in the URL<br />
** id<br />
** uid<br />
** model-name<br />
** node-name<br />
** node-description<br />
** priority<br />
** summary<br />
** node-help<br />
** history-records<br />
** table-name<br />
** ad_table_id<br />
** record_id<br />
** node-approval<br />
** node-confirmation<br />
** created<br />
<br />
'''''Examples:'''''<br />
/api/v1/workflow/100<br />
<br />
=== PUT api/v1/workflow/approve/{nodeid} ===<br />
<br />
Approves the corresponding node. Just for nodes of type = Approval (Column name = IsApproved).<br />
<br />
'''''Body Parameters:'''''<br />
* "message": "This is an example message for approval" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the approval<br />
<br />
=== PUT api/v1/workflow/reject/{nodeid} ===<br />
<br />
Rejects the corresponding node. Just for nodes of type = Approval (Column name = IsApproved).<br />
<br />
'''''Body Parameters:'''''<br />
* "message": "This is an example message for rejection" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the rejection<br />
<br />
=== PUT api/v1/workflow/forward/{nodeid} ===<br />
<br />
Forwards the corresponding node to a specific user. Just for nodes of type = Approval (Column name = IsApproved).<br />
<br />
'''''Body Parameters:'''''<br />
* "userTo": {userToID} '''(Mandatory)'''<br />
* "message": "This is an example message for fowarding" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the forwarding<br />
<br />
=== PUT api/v1/workflow/acknowledge/{nodeid} ===<br />
<br />
Implementation of the workflow nodes where a user gets notified when something happens, it<br />
does not require any action from the user but the user receives a message after a specific<br />
action is performed. This is used when the node is from type Window/form<br />
<br />
'''''Body Parameters:'''''<br />
* "message": "This is an example message for acknowledge" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the acknowledge<br />
<br />
=== PUT api/v1/workflow/setuserchoice/{nodeid} ===<br />
<br />
This is similar to approve and reject but it supports columns with Type List and String.<br />
<br />
'''''Body Parameters:'''''<br />
* "value":"Value to be set in the corresponding column" '''(Mandatory)'''<br />
* "message": "This is an example message for userschoice" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the acknowledge<br />
<br />
== Status lines api/v1/statuslines ==<br />
<br />
=== GET api/v1/statuslines ===<br />
<br />
Retrieve all active status line records configured in the dictionary ordered by Name.<br />
<br />
You can use the query parameters '''$filter''' to filter the records returned.<br />
<br />
Additionally, you can use the query parameter '''with_messages''' to specify that you want the resulting message returned in the payload. This means that the status line will be resolved by REST, and the result will be returned in a ''message'' property in the JSON response.<br />
<br />
'''''Returns:'''''<br />
* all the active status line records configured in the dictionary. <br />
** id<br />
** uid<br />
** model-name<br />
** name<br />
** entity type<br />
** message (optional)<br />
<br />
=== GET api/v1/statuslines/{statuslineid} ===<br />
<br />
'''''Returns:'''''<br />
* The message corresponding to the specific status line<br />
** message<br />
<br />
'''''Examples:'''''<br />
/api/v1/statuslines/200024<br />
<br />
=== GET /api/v1/statuslines/200024 ===<br />
<br />
Returns the Core status line Dashboard_OrderCount.<br />
<br />
'''''Returns:'''''<br />
{<br />
"message": "Order Count\n Top Year (2002): 4 \n Current Year: 3"<br />
}<br />
<br />
== Charts api/v1/charts ==<br />
<br />
=== GET api/v1/charts/{chartid} ===<br />
<br />
'''''URL Parameters:'''''<br />
* height -> optional - height in pixels for the image<br />
** if not provided then it uses the same height defined in the chart, or 100 if not defined in chart<br />
* width -> optional - width in pixels for the image<br />
** if not provided then it uses the height defined in the chart, or 100 if not defined in chart<br />
* json -> optional<br />
** if this parameter is present the image is returned base64 encoded in data element of JSON<br />
** when not present the image file is returned directly in PNG format<br />
<br />
'''''Returns:'''''<br />
* The image generated from the chart.<br />
* NOTE that this image is generated using the old JFreeChart library, not the new billboard, so it can have an outdated look.<br />
<br />
'''''Examples:'''''<br />
/api/v1/charts/50002?width=800&height=600&json<br />
<br />
== Menu tree api/v1/menutree/ ==<br />
<br />
=== GET api/v1/menutree/{id} ===<br />
<br />
Retrieve all the elements from the requested menu tree with id or uuid.<br />
<br />
'''''Returns:'''''<br />
* Name<br />
* Description<br />
* IsSOTrx<br />
* PredefinedContextVariables<br />
* EntityType<br />
* Action<br />
* AD_Window_ID<br />
* AD_Workflow_ID<br />
* AD_Task_ID<br />
* AD_Process_ID<br />
* AD_Form_ID<br />
* AD_InfoWindow_ID<br />
<br />
== REST View api/v1/views ==<br />
[https://github.com/bxservice/idempiere-rest/issues/281 https://github.com/bxservice/idempiere-rest/issues/281]<br />
<p><br />
iDempiere model typically has many columns and is using DB naming convention that's not particularly natural in a Json data schema. A common need is to pick a subset of columns for different use case and uses a more json oriented naming for the selected columns.<br />
<br />
This add a layer of abstraction on top of iDempiere model (term as Rest View) to cater for such need. It can be taken as a way to configure Json schema on top of iDempiere model.<br />
<br />
=== GET api/v1/views ===<br />
Get active REST view definitions (Rest_View, Rest_ViewColumn, Rest_ViewRelated).<br />
<br />
=== Support all requests and methods for api/v1/models/ ===<br />
Supports all requests and methods that are available with '''api/v1/models''', just replace '''models''' with '''views''' and '''{tableName}''' with '''{viewName}''' (i.e api/v1/views/{viewName} for api/v1/models/{tableName}, api/v1/views/{viewName}/{id} for api/v1/models/{tableName}/{id}, etc).<br />
<br />
=== Examples ===<br />
See example at [https://github.com/bxservice/idempiere-rest/issues/281 https://github.com/bxservice/idempiere-rest/issues/281]<br />
<br />
== Uploads api/v1/uploads ==<br />
[https://github.com/bxservice/idempiere-rest/issues/360 https://github.com/bxservice/idempiere-rest/issues/360]<br />
<p><br />
Allow uploading large files for posterior references where base64 files are used (e.g. attachments, images, etc)<br />
<br />
===POST api/v1/uploads===<br />
<br />
Initiates a new upload session for a file<br />
<br />
'''''Body:'''''<br />
* fileName -> The name of the file to be uploaded<br />
*contentType -> The MIME type of the file (e.g., "image/png", "application/pdf")<br />
*fileSize -> The total size of the file in bytes<br />
*chunkSize -> The preferred size of each chunk in the upload, in bytes<br />
*sha256 -> The SHA-256 hash of the file content for integrity verification<br />
*uploadLocation -> "ARCHIVE", "ATTACHMENT" OR "IMAGE"<br />
*expiresInSeconds -> The number of seconds after which the upload session will expire<br />
<br />
'''''Returns:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*chunkSize -> The preferred size of each chunk in the upload, in bytes<br />
*expiresAt -> The expiration time of the upload session<br />
*presignedURL -> The pre-signed URL for PUT<br />
<br />
===PUT api/v1/uploads/{uploadId}/chunks/{chunkOrder}===<br />
<br />
Uploads a chunk of the file to the server<br />
<br />
'''''URL Parameters:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*chunkOrder -> The order of the chunk<br />
<br />
'''''Header Parameter:'''''<br />
*X-Total-Chunks -> mandatory, specific the expected number of chunks<br />
*X-Content-SHA256 -> hash of the chunk data<br />
<br />
'''''Body:'''''<br />
<br />
Chunk data to be uploaded<br />
<br />
'''''Returns:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*chunkOrder -> The order of the chunk in the upload sequence<br />
*receivedSize -> The size of the chunk that has been received<br />
*message -> Additional message or details about the upload processing<br />
*isLastChunk -> True if this is the last chunk receive and will trigger the completion of the upload asynchronously<br />
<br />
===GET api/v1/uploads/{uploadId}===<br />
<br />
Retrieves the current status of an ongoing or completed upload<br />
<br />
'''''URL Parameter:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*expiresInSeconds -> The number of seconds after which the presigned URL will expire. When provided, a presigned URL will be returned for the upload session.<br />
<br />
'''''Returns:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*fileName -> The name of the file being uploaded<br />
*fileSize -> The total size of the file being uploaded<br />
*chunkSize -> The preferred size of each chunk in the upload, in bytes<br />
*status -> Status of the upload processing (INITIATED, UPLOADING, PROCESSING, COMPLETED, CANCELED or FAILED)<br />
*uploadedChunks -> List of chunks that have been successfully uploaded<br />
**chunkOrder -> The order of the chunk in the upload sequence <br />
**receivedSize -> The size of the chunk that has been received<br />
<br />
*totalReceivedSize -> Total size of all received chunks so far<br />
*message -> Additional message or details about the upload processing<br />
*presignedURL -> The pre-signed URL for GET<br />
<br />
===DEL api/v1/uploads/{uploadId} ===<br />
<br />
Cancels an ongoing/completed upload, cleans up any temporarily stored chunks and associated uploaded file<br />
<br />
'''''URL Parameter:'''''<br />
* uploadId -> The unique ID of the upload session<br />
<br />
'''''Returns:'''''<br />
*message -> Message or details about the outcome of the cancellation<br />
<br />
===GET api/v1/uploads/{uploadId}/file ===<br />
<br />
Get uploaded file content as binary stream or json<br />
<br />
'''''URL Parameter:'''''<br />
*uploadId -> The unique ID of the upload session<br />
<br />
'''''Query Parameter:'''''<br />
*asJson -> if provided, the response will be in JSON format with file content as base64 encoded string<br />
<br />
'''''Returns:'''''<br />
<br />
Response may be returned in one of the following media types:<br />
<br />
*application/octet-stream for binary data<br />
*text/html for HTML-formatted content<br />
*text/plain for plain text responses<br />
<br />
===GET api/v1/uploads===<br />
<br />
Get pending uploads from current user<br />
<br />
'''''Returns:'''''<br />
<br />
Status list of pending uploads:<br />
*uploadId -> The unique ID of the upload session<br />
*fileName -> The name of the file being uploaded<br />
*fileSize -> The total size of the file being uploaded<br />
*chunkSize -> The preferred size of each chunk in the upload, in bytes<br />
*status -> Status of the upload processing (INITIATED, UPLOADING, PROCESSING, COMPLETED, CANCELED or FAILED)<br />
*uploadedChunks -> List of chunks that have been successfully uploaded<br />
**chunkOrder -> The order of the chunk in the upload sequence<br />
**receivedSize -> The size of the chunk that has been received<br />
<br />
*totalReceivedSize -> Total size of all received chunks so far<br />
* message -> Additional message or details about the upload processing<br />
<br />
===POST api/v1/uploads/{uploadId}/copy===<br />
<br />
Copy uploaded file to attachment, image or archive (edited)<br />
<br />
'''''URL Parameter:'''''<br />
* uploadId -> The unique ID of the upload session<br />
<br />
'''''Body:'''''<br />
*copyLocation -> The copy location of the destination record (ARCHIVE, IMAGE or ATTACHMENT)<br />
* tableName -> The table name of the destination record (optional)<br />
*recordId -> The record id/uuid of the destination record (optional)<br />
<br />
'''''Returns:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*tableName -> The table name of the destination record<br />
*recordId -> The record id of the destination record<br />
*recordUU -> The record uuid of the destination record<br />
*copyLocation -> The copy location of the destination record, e.g. archive (default), image or attachment<br />
* fileName -> The name of the file being copied<br />
*contentType -> The MIME type of the file being copied (e.g., "image/png", "application/pdf")<br />
* fileSize -> The size of the file being copied<br />
<br />
== Batch request api/v1/batch ==<br />
<br />
===POST api/v1/batch===<br />
<br />
Execute one or more sub-request in single transaction<br />
<br />
'''''Body:'''''<br />
<br />
Arrays of:<br/><br />
*method -> HTTP method "POST", "PUT" or "DEL"<br />
*path -> Sub-request resource path, for e.g "v1/model/C_Order"<br />
*body -> JSON body for the sub-request (if applicable)<br />
<br />
'''''Returns:'''''<br />
<br />
Arrays of:<br/><br />
*status -> HTTP status text (OK, Created, etc) return from sub-request<br />
*statusCode -> HTTP status code (200, 201, 400, etc) return from sub-request<br />
*body -> JSON return from sub-request (if available)<br />
<br />
=SysConfig Keys=<br />
<br />
==IDEMPIERE_REST_EXPOSE_JWK==<br />
<br />
Y/N - defaults to N<br />
<br />
For integration with krakend (see [[Proxy iDempiere-Rest Through KrakenD]]) it is necessary to expose the signing key in the endpoint api/v1/auth/jwk<br />
<br />
Setting this to N (the default) the endpoint is not exposed, changing to Y it will expose the endpoint.<br />
<br />
Scope: System<br />
<br />
==REST_COLUMNNAME_TOLOWERCASE ==<br />
<br />
Y/N - defaults to N<br />
<br />
When set to Y the columnnames are translated to be named as json properties. The first letter is changed to lowercase when the columnname doesn't contain the underline character ( _ )<br />
<br />
When set to N (the default) the columnname is unchanged<br />
<br />
Scope: System<br />
<br />
==REST_MAX_RECORDS_SIZE==<br />
<br />
Numeric, default 100<br />
<br />
This is a System SysConfig defining the maximum number of records returned in a get operation.<br />
<br />
After changing this SysConfig key a server restart is required.<br />
<br />
Note that $top cannot be higher than this configured value.<br />
<br />
Also, REST_MAX_RECORDS_SIZE=0 means unlimited, and in this case the $top takes precedence when defined.<br />
<br />
==REST_USE_SYSCONFIG_SECRET==<br />
<br />
Y/N, defaults to Y (true)<br />
<br />
When set to false (N) iDempiere uses a random key generated every time it is rebooted. Note this creates two problems:<br />
*The tokens generated do not survive a reboot, because the key is changed on every reboot, if there is a valid token, it becomes invalid immediately after the server is rebooted, requiring a new login<br />
*The token is generated per server, so they are not valid in a multi-server environment, load balancing the REST API in a multi-server environment can make the API useless because the token of one server is not valid in the other server<br />
<br />
When set to true (Y), the default, the tokens are generated and signed using a key saved in the System SysConfig REST_TOKEN_SECRET, so they are shared between servers and survive a reboot.<br />
<br />
Scope: System<br />
<br />
== REST_TOKEN_SECRET==<br />
<br />
In this SysConfig is preserved a random key generated, in case they key is compromised, or as a security measure, a new key can be generated using the process ''Expire Server Secret''<br />
<br />
You don't need to touch this SysConfig, it is managed automatically.<br />
<br />
==REST_TOKEN_EXPIRE_IN_MINUTES==<br />
<br />
This Tenant SysConfig set the duration of token expiration in minutes. The default is 60 minutes (1 hour). Zero (0) means no expiration. If you need to change the default number, you can add this to System Configurator and set configured value with your value.<br />
<br />
==REST_REFRESH_TOKEN_EXPIRE_IN_MINUTES==<br />
<br />
This Tenant SysConfig set the duration of refresh token expiration in minutes. This expiration is equivalent to inactivity of the session, every time the token is refreshed is set to expire again to these minutes. The default is 1440 minutes (1 day). Zero (0) means no expiration. If you need to change the default number, you can add this to System Configurator and set configured value with your value.<br />
<br />
== REST_TOKEN_ABSOLUTE_EXPIRE_IN_MINUTES==<br />
<br />
This Tenant SysConfig set the duration of a session, after this expiration the refresh token doesn't work anymore and the user needs to login again using a password. The default is 10080 minutes (1 week). Zero (0) means no expiration. If you need to change the default number, you can add this to System Configurator and set configured value with your value.<br />
<br />
==REST_MANDATORY_CLIENT_ID_ON_REFRESH==<br />
<br />
The auth/refresh endpoint requires a clientId parameter to work correctly. If your application cannot provide clientId you can set this SysConfig to N to make it optional.<br />
<br />
==REST_MANDATORY_USER_ID_ON_REFRESH==<br />
<br />
The auth/refresh endpoint requires an userId parameter to work correctly. If your application cannot provide userId you can set this SysConfig to N to make it optional.<br />
<br />
==REST_ALLOW_UPDATE_SECURE_COLUMN==<br />
<br />
By default REST allows to update columns marked as secure or encrypted. This System SysConfig changes this behavior, if you add it and set it to N, then the secure or encrypted columns cannot be updated.<br />
<br />
==REST_ERROR_ON_NON_EXISTING_COLUMN==<br />
<br />
By default REST throws errors when a column mentioned in JSON does not exist. This System SysConfig changes this behavior, if you add it and set it to N, then the REST will not throw an error.<br />
<br />
==REST_ERROR_ON_NON_UPDATABLE_COLUMN==<br />
<br />
By default REST throws errors when a column mentioned in JSON is not updatable. This System SysConfig changes this behavior, if you add it and set it to N, then the REST will not update the column but it won't throw an error<br />
<br />
==REST_EXPAND_SEPARATOR==<br />
<br />
Character - defaults to ;<br />
<br />
Expand supports sub-operators, f.i. select, expand, order by ... By default, these operators are separated using a semicolon ';'. However, this causes a problem because there are API gateways that do not support semicolons as separators, for example, Traefik by default changes semicolons to ampersands or Krakend throws an error when a URL contains a semicolon.<br />
<br />
If you want to change the separator character to something different than ';', set it using this System Configurator.<br />
<br />
Scope: System<br />
<br />
==REST_TABLES_EXPORT_LOOKUP_UU==<br />
By default, REST returns lookup values and foreign keys (FK) as a JSONObject with id, model-name, etc. Sometimes, you might need the UUID as well, but this is not possible with expand in some cases, for instance, when you are getting an FK from a System table. This SysConfig allows you to configure all tables per tenant from which you want to receive the UUID as well. You can fill this SysConfig with ''"ALL"'' (in uppercase) to specify that all FKs should return the UUID, or with a comma-separated string listing all the tables from which you want to get the UUID, for instance, ''"AD_FieldGroup, AD_Field."''<br />
<br />
*''Setting ALL can impact performance.''<br />
*''The table names'' can be in upper or lower case; it does not make a difference.<br />
<br />
=Server to Server Tokens=<br />
<br />
You can generate server to server tokens in the window ''Rest Auth Token''.<br />
<br />
Simply fill the fields:<br />
*Organization<br />
*User<br />
*Role<br />
*Warehouse<br />
*Language<br />
*Expire in Minutes (0 means no expiration)<br />
<br />
And when saving the token will be generated for these parameters.<br />
<br />
[[Image:01_Rest_Auth_Token.png|800px]]<br />
<br />
When a token is generated, the flag ''Active'' indicates if it is a valid token. To active/inactive a token you can use the process ''Inactive/Active Token''.<br />
<br />
[[Image:02_Activate_Inactivate_Token.png|800px]]<br />
<br />
Also, you can change the server secret key, and this inactivate all the issued tokens, using the process ''Expire Server Secret''<br />
<br />
[[Image:03_Expire_Server_Secret.png|800px]]<br />
<br />
=Refresh Tokens Administration=<br />
<br />
With the window ''Rest Refresh Token'' you can review and administer the refresh tokens issued by the server.<br />
<br />
For security reasons the refresh tokens are not deleted, it is recommended to set up a periodic housekeeping that takes care of deleting obsolete and unnecessary tokens.<br />
<br />
When there is a detected breach (a trial to use a refresh token twice) the token is marked as revoked with cause ''Breach'' and all the tokens related to the breached token are revoked too with cause ''Breach Chain'', including the authorization token, so, in case of a breach is mandatory that the user log in again. It is recommended to verify frequently for breaches and take potential actions (f.e. inform the user), this can be done setting an alert.<br />
<br />
Also, when a user changes his/her password all the refresh tokens are revoked with cause ''Password Change''<br />
<br />
=Role access control for resource endpoint=<br />
https://github.com/bxservice/idempiere-rest/issues/290<br />
<p><br />
Role base access control for resource endpoint path.<br />
By default, all resource endpoint path is not protected. Create a new resource path record (Rest_Resource) to protect one more resource endpoints. The resource path definition is a regular expression so you can use .* to protect all endpoint paths and add new resource path records to open access to selected resources (for e.g '''v1/models\b/?.*''').<br />
<br />
==Tables==<br />
1. Rest_Resource<br />
- Name<br />
- Resource Path (regular expression pattern, without the query parameters)<br />
2. Rest_Resource_Access<br />
- AD_Role_ID <br />
- Rest_Resource_ID<br />
- Http Methods (Multi selection list of GET, POST, PUT and DELETE)<br />
<br />
==Window==<br />
1. Rest Resource Window<br />
2. Role Data Access Window<br />
- Added Rest Resource Access tab<br />
<br />
==AD_SysConfig==<br />
1. REST_RESOURCE_ACCESS_CONTROL<br />
- Y/N, System level, default to Y<br />
<br />
==Examples==<br />
See examples at https://github.com/bxservice/idempiere-rest/issues/290<br />
<br />
=OpenAPI Support=<br />
<br />
Generate OpenAPI 3.0.0 yaml for table and view.<br />
<br />
===GET api/v1/models/{tableName}/yaml===<br />
<br />
Get OpenAPI 3.0.0 yaml schema and request for table<br />
<br />
===GET api/v1/views/{viewName}/yaml===<br />
<br />
Get OpenAPI 3.0.0 yaml schema and request for view<br />
<br />
'''''HTTP Header:'''''<br />
*Accept: application/yaml<br />
<br />
=Add Custom End Point=<br />
<br />
You can add new, custom end point with your own plugin.<br />
<br />
To do that, in your plugin:<br />
<br />
*Create resource classes for your end points using jaxrs annotation (@Path, @GET, @POST, etc).<br />
*Create an OSGi component that implements the ResourceExtension interface (@Component(service = ResourceExtension.class, immediate = true)).<br />
*Override the getResourceClasses() method and return the set of resource classes that you have created.<br />
<br />
[[Category:Available Plugins]]<br />
[[Category:Updated2022]]</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=REST_Web_Services&diff=23432REST Web Services2025-07-22T03:55:17Z<p>Hengsin: </p>
<hr />
<div>* '''Maintainers:''' [http://www.bx-service.com BX Service GmbH] team<br />
* '''Status:''' used in production, up to date with release 11 and master<br />
* '''License:''' [http://www.gnu.org/licenses/gpl-2.0.html GPLv2]<br />
* '''Sources:''' https://github.com/bxservice/idempiere-rest<br />
* '''Continuous Integration:''' https://jenkins.idempiere.org/job/idempiere-rest/ (installation instructions)<br />
<br />
= Introduction =<br />
The iDempiere REST API is a plugin that allows developers to communicate with an iDempiere server via a RESTful API. This information is delivered via HTTP using JSON. <br />
<br />
The iDempiere REST API seeks to follow the OData standard and uses the following structure and endpoints.<br />
<br />
You can find examples of every call in the [https://github.com/bxservice/idempiere-rest/tree/master/com.trekglobal.idempiere.rest.api/postman postman collection sample files in the official repository].<br />
<br />
= Global URL parameters =<br />
<br />
* '''locale:''' in any call you can use the URL parameter locale <code>?locale={locale}</code> to define the language. For example adding <code>?locale=es_CO</code> to the login URL <code>api/v1/auth/tokens</code> will return any error message in Spanish.<br />
<br />
= Login in to get your Bearer authorization token =<br />
<br />
'''Properties:'''<br />
<br />
* '''userName:'''The user name being authenticated, here you would need to use the user Name or the EMail depending on the [[System Configurator (Window ID-50006)#USE EMAIL FOR LOGIN|SysConfig USE_EMAIL_FOR_LOGIN]]<br />
* '''password:''' the password of the user being authenticated<br />
* parameters:<br />
** '''clientId:''' the client ID from AD_Client, here you can use the AD_Client_ID or the Value for authentication<br />
** '''roleId:''' the role ID from AD_Role, here you can use the AD_Role_ID or the role Name for authentication<br />
** '''organizationId:''' the organization ID from AD_Org, here you can use the AD_Org_ID or the organization Name for authentication<br />
** '''warehouseId:''' the warehouse ID from M_Warehouse, here you can use the M_Warehouse_ID or the warehouse Name for authentication<br />
** '''language:''' the language for the session, as defined in AD_Language.AD_Language<br />
<br />
<br />
'''IMPORTANT:''' REST API just allows to log in to roles with Role Type = WebService, or without Role Type. This means by default is not possible to login with role System, you need to clear the Role Type in System, or even better create a WebService role for System tenant.<br />
<br />
There are two ways to log in to get your authorization token:<br />
<br />
== One-step log-in ==<br />
<br />
When you know beforehand all the login information needed to get into the system, you need to do a POST request to the following endpoint<br />
<br><br />
<code>.../api/v1/auth/tokens</code><br />
<br />
With a body like this:<br />
<syntaxhighlight lang="json"><br />
{<br />
"userName": "{{userName}}",<br />
"password": "{{password}}",<br />
"parameters": {<br />
"clientId": {{clientId}},<br />
"roleId": {{roleId}},<br />
"organizationId": {{organizationId}},<br />
"warehouseId": {{warehouseId}},<br />
"language": "{{language}}"<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
''Change all the {{propertyname}} values to the ones you want to use in your instance.''<br />
<br />
== Normal log-in ==<br />
<br />
If you want to log in as a user would normally do in iDempiere (choosing a role, warehouse, client, etc), you need to do the following requests<br />
<br />
<code>POST .../api/v1/auth/tokens</code><br />
<br><br />
Body:<br />
<syntaxhighlight lang="json"><br />
{<br />
"userName": "{{userName}}",<br />
"password": "{{password}}"<br />
}<br />
</syntaxhighlight><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"clients": [<br />
{<br />
"id": 11,<br />
"name": "GardenWorld"<br />
}<br />
],<br />
"token": "eyJraWQiOiJpZGVtcGllcmUiLCJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJHYXJkZW5BZG1pbiIsImlzcyI6ImlkZW1waWVyZS5vcmciLCJDbGllbnRzIjoiMTEiLCJleHAiOjE2NjY5NjQ5Mjh9.3t0MuK6ReF7xNmb36ITM36VSKI5QnK3n0ZF_LIgPQSrso4oRhDsL8Mudc0NqH4qjvvKDlYsPquYKtrHnB5UiZg"<br />
}<br />
</syntaxhighlight><br />
<br />
With that token you can request for login information from the user that is being authenticated. You need to add it to the request Header with Key value as:<br><br />
<code> Authorization: Bearer {authToken}</code><br />
<br />
The information you can request is the following, and it needs to be done in this order because each request needs information from the previous call:<br><br />
<code>GET .../api/v1/auth/roles?client={clientId}</code><br />
::Returns an array with the roles that the user has access to<br />
<br><br />
<code>GET .../api/v1/auth/organizations?client={clientId}&role={roleId}</code><br />
::Returns an array with the organizations that the user has access to.<br />
<br><br />
<code>/api/v1/auth/warehouses?client={clientId}&role={roleId}&organization={organizationId}</code><br />
::Returns an array with the warehouses that the user has access to.<br />
<br><br />
<code>GET .../api/v1/auth/language?client={clientId}</code><br />
::Returns an array with the languages the user can login with.<br />
<br><br />
When you have all the data you need to do a final PUT request like this:<br />
<br />
<code>PUT .../api/v1/auth/tokens</code><br />
<br />
Body:<br />
<syntaxhighlight lang="json"><br />
{<br />
"clientId": {clientId},<br />
"roleId": {roleId},<br />
"organizationId": {organizationId},<br />
"warehouseId": {warehouseId},<br />
"language": "{language}"<br />
}<br />
</syntaxhighlight><br />
<br />
* ''The language, organizationId and warehouseId properties are optional, it can be omitted and the system will use the default language and 0 for the organization.''<br />
<br />
* ''If the warehouseId property is omitted the system assigns by default the warehouse defined for the organization, if the warehouse is passed as 0, then the login doesn't assign a default warehouse.''<br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"userId": 101,<br />
"language": "en_US",<br />
"token": "eyJraWQiOiJpZGVtcGllcmUiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHYXJkZW5BZG1pbiIsIkFEX0NsaWVudF9JRCI6MTEsIkFEX1VzZXJfSUQiOjEwMSwiQURfUm9sZV9JRCI6MjAwMDAxLCJBRF9PcmdfSUQiOjExLCJNX1dhcmVob3VzZV9JRCI6MTAzLCJBRF9MYW5ndWFnZSI6ImVuX1VTIiwiQURfU2Vzc2lvbl9JRCI6MTAwMDE2MiwiaXNzIjoiaWRlbXBpZXJlLm9yZyIsImV4cCI6MTcwMTc3NTUzN30.bAUEhPylAQhZjZquJhvLpO9zMZG3g6zlM_IqO9ifeXJpAJBOoJtDqd8CrYPU1PKURzoPRSUglbKqr1LsXdz38A",<br />
"refresh_token": "eyJraWQiOiJpZGVtcGllcmUiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiIwODk1OTIyNC1iYzBhLTRkNTQtOTlhZS1jNmRmZjNiOGEwMzUiLCJpc3MiOiJpZGVtcGllcmUub3JnIiwiZXhwIjoxNzAxODU4MzM3fQ.uSE5SOtWgPvReC4JtyV4alHd-ccU0L9QhIpP2TwT7C5TJFeCGVYTdyWc291DaIweyiIGCfWFgQlbe0oH1EEXXg"<br />
}<br />
</syntaxhighlight><br />
<br />
= Abbreviated log-in =<br />
The <code>POST .../api/v1/auth/tokens</code> operation described above can be sufficient for a login when the user has only access to one client, one role and one organization. In this case the POST operation returns immediately the token and refresh_token and the payload includes the values that were assumed for the login.<br />
<br />
= Refresh Token =<br />
<br />
As you see above, the login process returns a token and a refresh_token, normally the token expires in 1 hour and the refresh_token expires in 24 hours. These expiration defaults can be changed using SysConfig keys REST_TOKEN_EXPIRE_IN_MINUTES and REST_REFRESH_TOKEN_EXPIRE_IN_MINUTES.<br />
<br />
It is a common practice in front-end development to store the refresh_token in a cookie or browser data, while keeping the token itself just in memory. This approach is taken due to the sensitive nature of the information contained within the token, which must not be disclosed.<br />
<br />
When the token expires, you can get a new token calling the following request:<br />
<br />
<code>POST .../api/v1/auth/refresh</code><br />
<br><br />
Body:<syntaxhighlight lang="json"><br />
{<br />
"refresh_token": "{{refreshToken}}",<br />
"clientId": {{clientId}},<br />
"userId": 101<br />
}<br />
</syntaxhighlight><br />
<br />
Note that clientId and userId are recommended, but optional, it can be disabled with the SysConfig keys REST_MANDATORY_CLIENT_ID_ON_REFRESH=N and REST_MANDATORY_USER_ID_ON_REFRESH=N<br />
<br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"token": "eyJraWQiOiJpZGVtcGllcmUiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJHYXJkZW5BZG1pbiIsIkFEX0NsaWVudF9JRCI6MTEsIkFEX1VzZXJfSUQiOjEwMSwiQURfUm9sZV9JRCI6MTAyLCJBRF9PcmdfSUQiOjExLCJNX1dhcmVob3VzZV9JRCI6MTAzLCJBRF9MYW5ndWFnZSI6ImVuX1VTIiwiQURfU2Vzc2lvbl9JRCI6MTAwMDIyMCwiaXNzIjoiaWRlbXBpZXJlLm9yZyIsImV4cCI6MTczMDgxNTUwM30.MzmpXlpuIUjKkYdKi2G50ORcSt2FcLT4-x-OO1LVzDDoO8lNm7P9ELaWWViKktOzN_pKtocIA59LlXzXBmWVtA",<br />
"refresh_token": "eyJraWQiOiJpZGVtcGllcmUiLCJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiZTQ3Zjg4YjkyMmU5MzU5NzEwNmRlNWIwOGQ1ZDljMjk3OTQxMzNkNjYxMWFjOWZkMmI1NGE5NWExODFjNDIxIiwiaXNzIjoiaWRlbXBpZXJlLm9yZyJ9.efa6M1oOb_QDnSKopNsdDygd1fF3S-ozr3DXjn1qANyPEVK-kg3Y2anGXrqQCtUzmxWBi8eTY4C6r5wXY6jtFA"<br />
}<br />
</syntaxhighlight><br />
<br />
The new tokens are set with new expiration times as configured.<br />
<br />
Refresh tokens can be expired (deleted) using the process "Expire Refresh Tokens"<br />
<br />
A refresh token can be used just one time. If a refresh token tries to be used a second time a potential breach is set on the system and all the tokens associated with the refresh token are invalidated.<br />
<br />
= Logout =<br />
<br />
Logout a session from a token.<br />
<br />
<code>POST .../api/v1/auth/logout</code><br />
<br><br />
Body:<syntaxhighlight lang="json"><br />
{<br />
"token": "{{authToken}}"<br />
}<br />
</syntaxhighlight><br />
<br />
The session associated to the token will be logged out.<br />
<br />
This token cannot be used again, neither the refresh token associated.<br />
<br />
= Common Headers =<br />
<br />
* Content-Type: application/json<br />
* Accept: application/json<br />
* Authorization: Bearer {authToken}<br />
** All calls except the first one (POST/auth) require an authorization bearer that is returned by the /auth APIs from the previous steps.<br />
<br />
= Requesting Data =<br />
<br />
iDempiere supports requests for data via HTTP '''GET''' requests.<br />
<br />
On every get request the response will include this information, in addition to the one requested:<br />
* id: the record ID<br />
* uid: the UUID of the record<br />
* model-name: the table name of the record<br />
* {columnname}: each pair of column/value is represented as a json object with the columnname:<br />
** String: strings are represented directly as a json string quoted value<br />
** Yes/No: these are represented as true/false<br />
** Numbers: numbers are represented as a json number without quotes<br />
** Dates/Times: timestamp values are represented as a json date (quoted string with format [https://en.wikipedia.org/wiki/ISO_8601 ISO_8601]<br />
** Foreign keys: these are represented as a json object with the following values:<br />
*** propertyLabel -> the foreign name<br />
*** id -> the foreign record ID<br />
*** identifier -> the foreign identifier<br />
*** model-name -> the foreign table name<br />
** Binary: binary columns are represented directly as a json string base64 encoded value<br />
** Images: these are represented as a json object with the following values:<br />
*** propertyLabel -> the foreign name<br />
*** id -> the foreign record ID<br />
*** data -> a string containing the base64 encoded data for the image<br />
*** model-name -> the foreign table name<br />
<br />
== Requesting PO Collections ==<br />
The request below returns the collection of taxes.<br />
<code>GET /api/v1/models/c_tax</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 4,<br />
"records-size": 2,<br />
"skip-records": 0,<br />
"row-count": 8,<br />
"array-count": 2,<br />
"records": [<br />
{<br />
"id": 106,<br />
"uid": "315dacb1-415c-45e7-8dac-a9a44fa8aca7",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2003-01-08T13:14:01Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "GST",<br />
"Description": "Canadian Federal Sales Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2003-02-22T02:20:37Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 0,<br />
"identifier": "~System (deprecated)~",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "2001-01-01",<br />
"IsSummary": false,<br />
"Rate": 7,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "GST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": false,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
},<br />
{<br />
"id": 107,<br />
"uid": "d76b09c5-531b-4f98-a8c6-9af848b6697b",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2003-01-08T15:06:11Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "PST",<br />
"Description": "Canadian Provintial Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2003-02-22T02:20:37Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 0,<br />
"identifier": "~System (deprecated)~",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "2002-01-01",<br />
"IsSummary": false,<br />
"Rate": 7.5,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "PST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": false,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Requesting an Individual PO by ID ==<br />
The request below returns an individual PO of type tax by the given id "106".<br />
''* You can use here either record id or the UUID (C_Tax_ID or C_Tax_UU value)''<br />
<br />
<code>GET /api/v1/models/c_tax/106</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 106,<br />
"uid": "315dacb1-415c-45e7-8dac-a9a44fa8aca7",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2003-01-08T13:14:01Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "GST",<br />
"Description": "Canadian Federal Sales Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2003-02-22T02:20:37Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 0,<br />
"identifier": "~System (deprecated)~",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "2001-01-01",<br />
"IsSummary": false,<br />
"Rate": 7,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "GST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": false,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
}<br />
</syntaxhighlight><br />
<br />
== Requesting an Individual Property ==<br />
To address an entity property clients append a path segment containing property name to the URL of the entity.<br />
The request below returns the Rate property of a tax.<br />
<code>GET /api/v1/models/c_tax/106/rate</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 106,<br />
"uid": "315dacb1-415c-45e7-8dac-a9a44fa8aca7",<br />
"Rate": 7,<br />
"model-name": "c_tax"<br />
}<br />
</syntaxhighlight><br />
<br />
= Querying Data =<br />
<br />
iDempiere supports various kinds of query options for querying data. This section will help you go through the common scenarios for these query options.<br />
<br />
== Query Option $filter ==<br />
The <code>$filter</code> query option allows developers to filter a collection of resources that are addressed by a request URL. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. These are the basic predicates that are supported:<br />
<br />
* $filter<br />
** Logical operators<br />
*** eq -> equals =<br />
*** neq -> not equals !=<br />
*** in -> IN<br />
*** gt -> greater than ><br />
*** ge -> greater or equal >=<br />
*** lt -> less than <<br />
*** le -> less or equal <=<br />
*** and -> &<br />
*** or -> |<br />
*** not -> !<br />
** Method operators (WARNING: there must not be spaces before/after the parameters on these functions, strings must be surrounded by single quotes):<br />
*** contains -> if a string contains another string<br />
*** startswith -> if a string starts with another string<br />
*** endswith -> if a string ends with another string<br />
*** tolower -> convert a string to lowercase<br />
*** toupper -> convert a string to uppercase<br />
** Parenthesis are supported<br />
<br />
== Examples ==<br />
The request below using $filter to get business partners where IsCustomer = true and IsActive = true and the name starts with 'Pa'<br />
<code>GET /api/v1/models/c_bpartner?$filter=isCustomer eq true AND isActive eq true AND startswith(name,'Pa') AND C_BPartner_ID in (120,121)</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 1,<br />
"records-size": 3,<br />
"skip-records": 0,<br />
"row-count": 1,<br />
"array-count": 1,<br />
"records": [<br />
{<br />
"id": 121,<br />
"uid": "39e85feb-94a2-4e41-ae45-e7d49d7be077",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2003-01-13T10:14:03Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2020-11-11T13:16:05Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Value": "Patio",<br />
"Name": "Patio Fun, Inc.",<br />
"SalesVolume": 0,<br />
"NumberEmployees": 0,<br />
"IsSummary": false,<br />
"AD_Language": {<br />
"propertyLabel": "Language",<br />
"id": "es_CO",<br />
"identifier": "Spanish (Colombia)",<br />
"model-name": "ad_language"<br />
},<br />
"IsVendor": true,<br />
"IsCustomer": true,<br />
"IsProspect": false,<br />
"FirstSale": "2020-11-05",<br />
"SO_CreditLimit": 0,<br />
"SO_CreditUsed": 588.24,<br />
"AcqusitionCost": 0,<br />
"PotentialLifeTimeValue": 0,<br />
"ActualLifeTimeValue": 588.24,<br />
"ShareOfCustomer": 0,<br />
"IsEmployee": false,<br />
"IsSalesRep": false,<br />
"IsOneTime": false,<br />
"IsTaxExempt": false,<br />
"IsDiscountPrinted": true,<br />
"C_BP_Group_ID": {<br />
"propertyLabel": "Business Partner Group",<br />
"id": 104,<br />
"identifier": "Vendors",<br />
"model-name": "c_bp_group"<br />
},<br />
"SendEMail": false,<br />
"SOCreditStatus": {<br />
"propertyLabel": "Credit Status",<br />
"id": "O",<br />
"identifier": "Credit OK",<br />
"model-name": "ad_ref_list"<br />
},<br />
"TotalOpenBalance": 588.240,<br />
"IsPOTaxExempt": false,<br />
"IsManufacturer": false,<br />
"Is1099Vendor": false,<br />
"IsUseTaxIdDigit": false,<br />
"IsDetailedNames": false,<br />
"model-name": "c_bpartner"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Query Option $expand ==<br />
iDempiere supports nested filters in <code>$expand</code>. <br />
<br />
The request below return Orders and all their Lines and Taxes.<br />
<code>GET /api/v1/models/c_order?$expand=c_orderLine,c_ordertax</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 68,<br />
"records-size": 1,<br />
"skip-records": 0,<br />
"row-count": 68,<br />
"array-count": 1,<br />
"records": [<br />
{<br />
"id": 1000019,<br />
"uid": "7144b00f-a283-465e-8d2d-1fe89eac5748",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 11,<br />
"identifier": "HQ",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-07-22T17:36:20Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-07-22T17:36:20Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"DocumentNo": "50012",<br />
"DocStatus": {<br />
"propertyLabel": "Document Status",<br />
"id": "DR",<br />
"identifier": "Drafted",<br />
"model-name": "ad_ref_list"<br />
},<br />
"C_DocType_ID": {<br />
"propertyLabel": "Document Type",<br />
"id": 0,<br />
"identifier": "** New **",<br />
"model-name": "c_doctype"<br />
},<br />
"C_DocTypeTarget_ID": {<br />
"propertyLabel": "Target Document Type",<br />
"id": 132,<br />
"identifier": "Standard Order",<br />
"model-name": "c_doctype"<br />
},<br />
"Description": "Order Description from Business Partner Definition",<br />
"IsApproved": true,<br />
"IsCreditApproved": false,<br />
"IsDelivered": false,<br />
"IsInvoiced": false,<br />
"IsPrinted": false,<br />
"IsTransferred": false,<br />
"DateOrdered": "2021-07-19",<br />
"DatePromised": "2021-07-19",<br />
"DateAcct": "2021-07-19",<br />
"SalesRep_ID": {<br />
"propertyLabel": "Sales Representative",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"C_PaymentTerm_ID": {<br />
"propertyLabel": "Payment Term",<br />
"id": 106,<br />
"identifier": "2%10 Net 30",<br />
"model-name": "c_paymentterm"<br />
},<br />
"C_Currency_ID": {<br />
"propertyLabel": "Currency",<br />
"id": 102,<br />
"identifier": "EUR",<br />
"model-name": "c_currency"<br />
},<br />
"InvoiceRule": {<br />
"propertyLabel": "Invoice Rule",<br />
"id": "I",<br />
"identifier": "Immediate",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightAmt": 0,<br />
"DeliveryViaRule": {<br />
"propertyLabel": "Delivery Via",<br />
"id": "P",<br />
"identifier": "Pickup",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PriorityRule": {<br />
"propertyLabel": "Priority",<br />
"id": "5",<br />
"identifier": "Medium",<br />
"model-name": "ad_ref_list"<br />
},<br />
"TotalLines": 14500,<br />
"GrandTotal": 14500,<br />
"M_Warehouse_ID": {<br />
"propertyLabel": "Warehouse",<br />
"id": 103,<br />
"identifier": "HQ Warehouse",<br />
"model-name": "m_warehouse"<br />
},<br />
"M_PriceList_ID": {<br />
"propertyLabel": "Price List",<br />
"id": 101,<br />
"identifier": "Standard",<br />
"model-name": "m_pricelist"<br />
},<br />
"C_BPartner_ID": {<br />
"propertyLabel": "Business Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"AD_User_ID": {<br />
"propertyLabel": "User/Contact",<br />
"id": 1000011,<br />
"identifier": "Carlitos Boss",<br />
"model-name": "ad_user"<br />
},<br />
"POReference": "Order Reference 1234",<br />
"ChargeAmt": 0,<br />
"Processed": false,<br />
"C_BPartner_Location_ID": {<br />
"propertyLabel": "Partner Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSOTrx": true,<br />
"DeliveryRule": {<br />
"propertyLabel": "Delivery Rule",<br />
"id": "A",<br />
"identifier": "Availability",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightCostRule": {<br />
"propertyLabel": "Freight Cost Rule",<br />
"id": "I",<br />
"identifier": "Freight included",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PaymentRule": {<br />
"propertyLabel": "Payment Rule",<br />
"id": "P",<br />
"identifier": "On Credit",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsDiscountPrinted": true,<br />
"IsTaxIncluded": false,<br />
"IsSelected": false,<br />
"SendEMail": false,<br />
"Bill_User_ID": {<br />
"propertyLabel": "Invoice Contact",<br />
"id": 1000011,<br />
"identifier": "Carlitos Boss",<br />
"model-name": "ad_user"<br />
},<br />
"Bill_BPartner_ID": {<br />
"propertyLabel": "Invoice Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"Bill_Location_ID": {<br />
"propertyLabel": "Invoice Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSelfService": false,<br />
"IsDropShip": false,<br />
"Volume": 0.00,<br />
"Weight": 0.00,<br />
"AmountTendered": 0.00,<br />
"AmountRefunded": 0.00,<br />
"ProcessedOn": 0,<br />
"IsPayScheduleValid": false,<br />
"IsPriviledgedRate": false,<br />
"NetAmtToInvoice": 0,<br />
"model-name": "c_order",<br />
"c_orderLine": [<br />
{<br />
"id": 1000033,<br />
"uid": "0b02614d-bdcd-406f-a9e6-5399ed3a9997",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 11,<br />
"identifier": "HQ",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-07-22T17:36:50Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-07-22T17:36:50Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Line": 10,<br />
"DateOrdered": "2021-07-19",<br />
"DatePromised": "2021-07-19",<br />
"M_Product_ID": {<br />
"propertyLabel": "Product",<br />
"id": 1000295,<br />
"identifier": "Poker_Poker",<br />
"model-name": "m_product"<br />
},<br />
"C_UOM_ID": {<br />
"propertyLabel": "UOM",<br />
"id": 109,<br />
"identifier": "6-Pack",<br />
"model-name": "c_uom"<br />
},<br />
"M_Warehouse_ID": {<br />
"propertyLabel": "Warehouse",<br />
"id": 103,<br />
"identifier": "HQ Warehouse",<br />
"model-name": "m_warehouse"<br />
},<br />
"QtyOrdered": 1,<br />
"QtyReserved": 0,<br />
"QtyDelivered": 0,<br />
"QtyInvoiced": 0,<br />
"C_Currency_ID": {<br />
"propertyLabel": "Currency",<br />
"id": 102,<br />
"identifier": "EUR",<br />
"model-name": "c_currency"<br />
},<br />
"PriceList": 14500,<br />
"PriceActual": 14500,<br />
"C_Tax_ID": {<br />
"propertyLabel": "Tax",<br />
"id": 104,<br />
"identifier": "Standard",<br />
"model-name": "c_tax"<br />
},<br />
"C_BPartner_ID": {<br />
"propertyLabel": "Business Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"FreightAmt": 0,<br />
"C_BPartner_Location_ID": {<br />
"propertyLabel": "Partner Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"LineNetAmt": 14500,<br />
"PriceLimit": 14500,<br />
"Discount": 0.00,<br />
"M_AttributeSetInstance_ID": {<br />
"propertyLabel": "Attribute Set Instance",<br />
"id": 0,<br />
"model-name": "m_attributesetinstance"<br />
},<br />
"IsDescription": false,<br />
"Processed": false,<br />
"PriceEntered": 14500,<br />
"QtyEntered": 1,<br />
"PriceCost": 0,<br />
"QtyLostSales": 0,<br />
"RRAmt": 0<br />
}<br />
]<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
You can add query operators ($filter, $orderyby, $top, $skip, $select) to the detail tables by adding the query operators between parentheses separated by ;.<br><br />
<br />
The request below returns Orders and their Lines (Line number and line net amount) from lines with linnetamt > 1000.<br><br />
<br />
<code>GET /api/v1/models/c_order?$select=DocumentNo,Description&$expand=C_OrderLine($select=Line,Linenetamt ; $filter=LineNetAmt gt 1000 ; $orderby=Line)&$top=5</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 14,<br />
"records-size": 5,<br />
"skip-records": 0,<br />
"row-count": 68,<br />
"array-count": 0,<br />
"records": [<br />
{<br />
"id": 1000019,<br />
"uid": "7144b00f-a283-465e-8d2d-1fe89eac5748",<br />
"DocumentNo": "50012",<br />
"Description": "Order Description from Business Partner Definition",<br />
"model-name": "c_order",<br />
"C_OrderLine": [<br />
{<br />
"id": 1000033,<br />
"uid": "0b02614d-bdcd-406f-a9e6-5399ed3a9997",<br />
"Line": 10,<br />
"LineNetAmt": 14500<br />
}<br />
]<br />
},<br />
{<br />
"id": 1000020,<br />
"uid": "470c98e0-5a19-413d-b589-89fc67272823",<br />
"DocumentNo": "50013",<br />
"Description": "MyCanadian Federal Sales Tax",<br />
"model-name": "c_order"<br />
},<br />
{<br />
"id": 1000018,<br />
"uid": "fb485eb0-6e79-439d-926f-cce53d76d806",<br />
"DocumentNo": "50011",<br />
"Description": "Order Description from Business Partner Definition",<br />
"model-name": "c_order"<br />
},<br />
{<br />
"id": 1000015,<br />
"uid": "040ffe18-04ab-4989-ae83-9ed295146042",<br />
"DocumentNo": "50008",<br />
"model-name": "c_order",<br />
"C_OrderLine": [<br />
{<br />
"id": 1000026,<br />
"uid": "d3eac7ec-caf1-473e-8c22-f5b8cee55d30",<br />
"Line": 10,<br />
"LineNetAmt": 4275.00<br />
}<br />
]<br />
},<br />
{<br />
"id": 1000017,<br />
"uid": "ee3a9225-439a-4022-8eaa-1109e5e4f049",<br />
"DocumentNo": "50010",<br />
"Description": "My Sales Tax",<br />
"model-name": "c_order"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
By default expand searches for the primary key column in the master table and tries to create the relation with this column name in the expanded table. /ad_user?$expand=c_order expands using ad_user_id by default. Sometimes you want to specify which column must be used for the expanding. In this case, you need to specify the column name using a dot after the table name.<br><br />
<br />
The request below returns users and their corresponding orders as sales representatives.<br><br />
<br />
<code>/api/v1/models/ad_user?$expand=C_order.salesrep_id($select=documentno)&$select=Name</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 100,<br />
"uid": "986cb4dc-7161-4d77-a7c7-3832d24b19de",<br />
"Name": "SuperUser",<br />
"model-name": "ad_user",<br />
"C_order": [<br />
{<br />
"id": 104,<br />
"uid": "3456b6d0-b911-42e6-8432-f52ded58713f",<br />
"DocumentNo": "800000"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
iDempiere has special tables where record_id is used, for instance, fact_acct. You can expand to this table using the same syntax as explained above. ''The plug-in will automatically set the correct value for AD_Table_ID''<br><br />
<br />
The request below returns the invoice 104 and their corresponding records on fact_acct.<br><br />
<br />
<code>/api/v1/models/c_invoice/104?$expand=fact_acct.record_id($select=fact_acct_id)&$select=DocumentNo</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 104,<br />
"uid": "6d2768c9-b3cc-4820-b903-9748b416b98f",<br />
"DocumentNo": "10000001",<br />
"model-name": "c_invoice",<br />
"fact_acct": [<br />
{<br />
"id": 1001729,<br />
"uid": "cd02c4e7-b386-46aa-b367-f5ec618dccc8"<br />
},<br />
{<br />
"id": 1001730,<br />
"uid": "e8dfd3ec-d5bf-4ded-9646-0a2a8d86a680"<br />
},<br />
{<br />
"id": 1001731,<br />
"uid": "2bf88ace-83bc-4968-abdd-fd211765da92"<br />
},<br />
{<br />
"id": 1001732,<br />
"uid": "26735041-c88e-4670-89e5-95ae49beb4dc"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
Sometimes you want to expand to a master record as well, for instance, from product to product category. You accomplish this by writing expand followed by the column name you want to expand.<br><br />
<br />
The request below returns the product 122 and its corresponding product category.<br><br />
<br />
<code>/api/v1/models/m_product/122?$expand=m_product_category_id($select=Name,IsDefault)&$select=Name,m_product_category_id</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 122,<br />
"uid": "c713192a-9ed3-4740-ad32-9583c30d0206",<br />
"Name": "Standard",<br />
"model-name": "m_product",<br />
"M_Product_Category_ID": {<br />
"id": 105,<br />
"uid": "be686f7e-993f-4162-a02d-ad4bb8c6987b",<br />
"Name": "Standard",<br />
"IsDefault": true,<br />
"model-name": "m_product_category"<br />
}<br />
}<br />
</syntaxhighlight><br />
<br />
''Note: For obvious reasons. $select is the only query operator accepted in this case.''<br />
<br />
You can expand on multiple levels by using the $expand operators within the $expand clause. You can only expand deeper on master > detail records. Cases like GET ../orders?$expand=AD_user_ID($expand=C_orderLine) are forbidden.<br />
<br />
== Query Option $orderby ==<br />
The <code>$orderby</code> query option allows developers to request resources in either ascending order using asc or descending order using desc. If asc or desc not specified, then the resources will be ordered in ascending order. <br />
<br />
The request below orders products on property Value in descending order.<br />
<code>GET /api/v1/models/m_product?$orderby=Value desc</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 37,<br />
"records-size": 3,<br />
"skip-records": 0,<br />
"row-count": 111,<br />
"array-count": 3,<br />
"records": [<br />
{<br />
"id": 1000216,<br />
"uid": "e19114c8-86cc-4fb4-b6eb-15f8fa350d38",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 50001,<br />
"identifier": "Fertilizer",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2020-10-05T18:46:14Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2020-11-23T19:45:12Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "Tron",<br />
"IsSummary": false,<br />
"C_UOM_ID": {<br />
"propertyLabel": "UOM",<br />
"id": 100,<br />
"identifier": "Each",<br />
"model-name": "c_uom"<br />
},<br />
"IsStocked": true,<br />
"IsPurchased": false,<br />
"IsSold": false,<br />
"Volume": 0,<br />
"Weight": 0,<br />
"Value": "zas",<br />
"M_Product_Category_ID": {<br />
"propertyLabel": "Product Category",<br />
"id": 105,<br />
"identifier": "Standard",<br />
"model-name": "m_product_category"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Discontinued": false,<br />
"IsBOM": false,<br />
"IsInvoicePrintDetails": false,<br />
"IsPickListPrintDetails": false,<br />
"IsVerified": false,<br />
"ProductType": {<br />
"propertyLabel": "Product Type",<br />
"id": "I",<br />
"identifier": "Item",<br />
"model-name": "ad_ref_list"<br />
},<br />
"M_AttributeSetInstance_ID": {<br />
"propertyLabel": "Attribute Set Instance",<br />
"id": 0,<br />
"model-name": "m_attributesetinstance"<br />
},<br />
"IsWebStoreFeatured": false,<br />
"IsSelfService": false,<br />
"IsDropShip": false,<br />
"IsExcludeAutoDelivery": false,<br />
"UnitsPerPack": 1,<br />
"LowLevel": 0,<br />
"IsKanban": false,<br />
"IsManufactured": false,<br />
"IsPhantom": false,<br />
"IsOwnBox": false,<br />
"IsAutoProduce": false,<br />
"BXS_IsPricePerUOM": false,<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 1000398,<br />
"uid": "d5d1bb16-81b4-429b-86bf-f667f22b93df",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 50001,<br />
"identifier": "Fertilizer",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-01-20T18:52:06Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-01-20T18:52:06Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "yudo mat",<br />
"IsSummary": false,<br />
"C_UOM_ID": {<br />
"propertyLabel": "UOM",<br />
"id": 100,<br />
"identifier": "Each",<br />
"model-name": "c_uom"<br />
},<br />
"IsStocked": true,<br />
"IsPurchased": true,<br />
"IsSold": true,<br />
"Volume": 0,<br />
"Weight": 0,<br />
"Value": "ym",<br />
"M_Product_Category_ID": {<br />
"propertyLabel": "Product Category",<br />
"id": 106,<br />
"identifier": "Trees",<br />
"model-name": "m_product_category"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Discontinued": false,<br />
"IsBOM": false,<br />
"IsInvoicePrintDetails": false,<br />
"IsPickListPrintDetails": false,<br />
"IsVerified": false,<br />
"ProductType": {<br />
"propertyLabel": "Product Type",<br />
"id": "I",<br />
"identifier": "Item",<br />
"model-name": "ad_ref_list"<br />
},<br />
"M_AttributeSetInstance_ID": {<br />
"propertyLabel": "Attribute Set Instance",<br />
"id": 0,<br />
"model-name": "m_attributesetinstance"<br />
},<br />
"IsWebStoreFeatured": false,<br />
"IsSelfService": true,<br />
"IsDropShip": false,<br />
"IsExcludeAutoDelivery": false,<br />
"UnitsPerPack": 1,<br />
"LowLevel": 0,<br />
"IsKanban": false,<br />
"IsManufactured": false,<br />
"IsPhantom": false,<br />
"IsOwnBox": false,<br />
"IsAutoProduce": false,<br />
"BXS_IsPricePerUOM": false,<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 1000299,<br />
"uid": "1726c817-71bc-4abf-8949-0372c9ffb0d3",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2020-10-08T19:04:22Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2020-10-08T19:04:22Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "Xiaomi Redmi Airdots",<br />
"IsSummary": false,<br />
"C_UOM_ID": {<br />
"propertyLabel": "UOM",<br />
"id": 100,<br />
"identifier": "Each",<br />
"model-name": "c_uom"<br />
},<br />
"IsStocked": true,<br />
"IsPurchased": true,<br />
"IsSold": true,<br />
"Volume": 0,<br />
"Weight": 0,<br />
"Value": "Xiaomi Redmi Airdots",<br />
"M_Product_Category_ID": {<br />
"propertyLabel": "Product Category",<br />
"id": 1000015,<br />
"identifier": "Gadgets",<br />
"model-name": "m_product_category"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"ShelfWidth": 0,<br />
"ShelfHeight": 0,<br />
"ShelfDepth": 0,<br />
"UnitsPerPallet": 0,<br />
"Discontinued": false,<br />
"IsBOM": false,<br />
"IsInvoicePrintDetails": false,<br />
"IsPickListPrintDetails": false,<br />
"IsVerified": false,<br />
"ProductType": {<br />
"propertyLabel": "Product Type",<br />
"id": "I",<br />
"identifier": "Item",<br />
"model-name": "ad_ref_list"<br />
},<br />
"GuaranteeDays": 0,<br />
"M_AttributeSetInstance_ID": {<br />
"propertyLabel": "Attribute Set Instance",<br />
"id": 0,<br />
"model-name": "m_attributesetinstance"<br />
},<br />
"GuaranteeDaysMin": 0,<br />
"IsWebStoreFeatured": false,<br />
"IsSelfService": true,<br />
"IsDropShip": false,<br />
"IsExcludeAutoDelivery": false,<br />
"UnitsPerPack": 0,<br />
"LowLevel": 0,<br />
"IsKanban": false,<br />
"IsManufactured": false,<br />
"IsPhantom": false,<br />
"IsOwnBox": false,<br />
"IsAutoProduce": false,<br />
"BXS_IsPricePerUOM": false,<br />
"model-name": "m_product"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Query Options $top and $skip ==<br />
The <code>$top</code> query option requests the number of items in the queried collection to be included in the result. The <code>$skip</code> query option requests the number of items in the queried collection that are to be skipped and not included in the result.<br />
<br />
The request below return the first two Orders starting with other 5th order.<br />
<code>GET /api/v1/models/c_order?$top=2&$skip=5</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 34,<br />
"records-size": 2,<br />
"skip-records": 5,<br />
"row-count": 68,<br />
"array-count": 2,<br />
"records": [<br />
{<br />
"id": 1000022,<br />
"uid": "2238dc66-edda-41f7-8348-d781342f6dfc",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 11,<br />
"identifier": "HQ",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-07-29T15:59:51Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-07-29T15:59:51Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"DocumentNo": "50015",<br />
"DocStatus": {<br />
"propertyLabel": "Document Status",<br />
"id": "DR",<br />
"identifier": "Drafted",<br />
"model-name": "ad_ref_list"<br />
},<br />
"C_DocType_ID": {<br />
"propertyLabel": "Document Type",<br />
"id": 0,<br />
"identifier": "** New **",<br />
"model-name": "c_doctype"<br />
},<br />
"C_DocTypeTarget_ID": {<br />
"propertyLabel": "Target Document Type",<br />
"id": 132,<br />
"identifier": "Standard Order",<br />
"model-name": "c_doctype"<br />
},<br />
"IsApproved": false,<br />
"IsCreditApproved": false,<br />
"IsDelivered": false,<br />
"IsInvoiced": false,<br />
"IsPrinted": false,<br />
"IsTransferred": false,<br />
"DateOrdered": "2021-07-29",<br />
"DatePromised": "2021-07-29",<br />
"DateAcct": "2021-07-29",<br />
"SalesRep_ID": {<br />
"propertyLabel": "Sales Representative",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"C_PaymentTerm_ID": {<br />
"propertyLabel": "Payment Term",<br />
"id": 105,<br />
"identifier": "Immediate",<br />
"model-name": "c_paymentterm"<br />
},<br />
"C_Currency_ID": {<br />
"propertyLabel": "Currency",<br />
"id": 102,<br />
"identifier": "EUR",<br />
"model-name": "c_currency"<br />
},<br />
"InvoiceRule": {<br />
"propertyLabel": "Invoice Rule",<br />
"id": "I",<br />
"identifier": "Immediate",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightAmt": 0.0,<br />
"DeliveryViaRule": {<br />
"propertyLabel": "Delivery Via",<br />
"id": "P",<br />
"identifier": "Pickup",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PriorityRule": {<br />
"propertyLabel": "Priority",<br />
"id": "5",<br />
"identifier": "Medium",<br />
"model-name": "ad_ref_list"<br />
},<br />
"TotalLines": 0.0,<br />
"GrandTotal": 0.0,<br />
"M_Warehouse_ID": {<br />
"propertyLabel": "Warehouse",<br />
"id": 103,<br />
"identifier": "HQ Warehouse",<br />
"model-name": "m_warehouse"<br />
},<br />
"M_PriceList_ID": {<br />
"propertyLabel": "Price List",<br />
"id": 101,<br />
"identifier": "Standard",<br />
"model-name": "m_pricelist"<br />
},<br />
"C_BPartner_ID": {<br />
"propertyLabel": "Business Partner",<br />
"id": 112,<br />
"identifier": "Standard",<br />
"model-name": "c_bpartner"<br />
},<br />
"AD_User_ID": {<br />
"propertyLabel": "User/Contact",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"ChargeAmt": 0.0,<br />
"Processed": false,<br />
"C_BPartner_Location_ID": {<br />
"propertyLabel": "Partner Location",<br />
"id": 108,<br />
"identifier": "Monroe",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSOTrx": true,<br />
"DeliveryRule": {<br />
"propertyLabel": "Delivery Rule",<br />
"id": "A",<br />
"identifier": "Availability",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightCostRule": {<br />
"propertyLabel": "Freight Cost Rule",<br />
"id": "I",<br />
"identifier": "Freight included",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PaymentRule": {<br />
"propertyLabel": "Payment Rule",<br />
"id": "P",<br />
"identifier": "On Credit",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsDiscountPrinted": false,<br />
"IsTaxIncluded": false,<br />
"IsSelected": false,<br />
"SendEMail": false,<br />
"Bill_BPartner_ID": {<br />
"propertyLabel": "Invoice Partner",<br />
"id": 112,<br />
"identifier": "Standard",<br />
"model-name": "c_bpartner"<br />
},<br />
"Bill_Location_ID": {<br />
"propertyLabel": "Invoice Location",<br />
"id": 108,<br />
"identifier": "Monroe",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSelfService": false,<br />
"IsDropShip": false,<br />
"IsPayScheduleValid": false,<br />
"IsPriviledgedRate": false,<br />
"NetAmtToInvoice": 0.0,<br />
"model-name": "c_order"<br />
},<br />
{<br />
"id": 1000016,<br />
"uid": "5565e213-a119-4bcc-beb6-c9f9a4e75dab",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 11,<br />
"identifier": "HQ",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2021-03-09T14:20:31Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2021-03-09T14:20:59Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"DocumentNo": "50009",<br />
"DocStatus": {<br />
"propertyLabel": "Document Status",<br />
"id": "CO",<br />
"identifier": "Completed",<br />
"model-name": "ad_ref_list"<br />
},<br />
"C_DocType_ID": {<br />
"propertyLabel": "Document Type",<br />
"id": 132,<br />
"identifier": "Standard Order",<br />
"model-name": "c_doctype"<br />
},<br />
"C_DocTypeTarget_ID": {<br />
"propertyLabel": "Target Document Type",<br />
"id": 132,<br />
"identifier": "Standard Order",<br />
"model-name": "c_doctype"<br />
},<br />
"Description": "Order Description from Business Partner Definition",<br />
"IsApproved": true,<br />
"IsCreditApproved": false,<br />
"IsDelivered": false,<br />
"IsInvoiced": false,<br />
"IsPrinted": false,<br />
"IsTransferred": false,<br />
"DateOrdered": "2021-02-16",<br />
"DatePromised": "2021-02-25",<br />
"DateAcct": "2021-02-16",<br />
"SalesRep_ID": {<br />
"propertyLabel": "Sales Representative",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"C_PaymentTerm_ID": {<br />
"propertyLabel": "Payment Term",<br />
"id": 106,<br />
"identifier": "2%10 Net 30",<br />
"model-name": "c_paymentterm"<br />
},<br />
"C_Currency_ID": {<br />
"propertyLabel": "Currency",<br />
"id": 102,<br />
"identifier": "EUR",<br />
"model-name": "c_currency"<br />
},<br />
"InvoiceRule": {<br />
"propertyLabel": "Invoice Rule",<br />
"id": "I",<br />
"identifier": "Immediate",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightAmt": 0,<br />
"DeliveryViaRule": {<br />
"propertyLabel": "Delivery Via",<br />
"id": "P",<br />
"identifier": "Pickup",<br />
"model-name": "ad_ref_list"<br />
},<br />
"M_Shipper_ID": {<br />
"propertyLabel": "Shipper",<br />
"id": 100,<br />
"identifier": "UPS",<br />
"model-name": "m_shipper"<br />
},<br />
"PriorityRule": {<br />
"propertyLabel": "Priority",<br />
"id": "5",<br />
"identifier": "Medium",<br />
"model-name": "ad_ref_list"<br />
},<br />
"TotalLines": 95.00,<br />
"GrandTotal": 95.00,<br />
"M_Warehouse_ID": {<br />
"propertyLabel": "Warehouse",<br />
"id": 103,<br />
"identifier": "HQ Warehouse",<br />
"model-name": "m_warehouse"<br />
},<br />
"M_PriceList_ID": {<br />
"propertyLabel": "Price List",<br />
"id": 101,<br />
"identifier": "Standard",<br />
"model-name": "m_pricelist"<br />
},<br />
"C_BPartner_ID": {<br />
"propertyLabel": "Business Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"AD_User_ID": {<br />
"propertyLabel": "User/Contact",<br />
"id": 1000011,<br />
"identifier": "Carlitos Boss",<br />
"model-name": "ad_user"<br />
},<br />
"POReference": "Order Reference 1234",<br />
"ChargeAmt": 0,<br />
"Processed": true,<br />
"C_BPartner_Location_ID": {<br />
"propertyLabel": "Partner Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSOTrx": true,<br />
"DeliveryRule": {<br />
"propertyLabel": "Delivery Rule",<br />
"id": "A",<br />
"identifier": "Availability",<br />
"model-name": "ad_ref_list"<br />
},<br />
"FreightCostRule": {<br />
"propertyLabel": "Freight Cost Rule",<br />
"id": "F",<br />
"identifier": "Fix price",<br />
"model-name": "ad_ref_list"<br />
},<br />
"PaymentRule": {<br />
"propertyLabel": "Payment Rule",<br />
"id": "P",<br />
"identifier": "On Credit",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsDiscountPrinted": true,<br />
"IsTaxIncluded": false,<br />
"IsSelected": false,<br />
"SendEMail": false,<br />
"Bill_User_ID": {<br />
"propertyLabel": "Invoice Contact",<br />
"id": 1000011,<br />
"identifier": "Carlitos Boss",<br />
"model-name": "ad_user"<br />
},<br />
"Bill_BPartner_ID": {<br />
"propertyLabel": "Invoice Partner",<br />
"id": 117,<br />
"identifier": "C&W Construction",<br />
"model-name": "c_bpartner"<br />
},<br />
"Bill_Location_ID": {<br />
"propertyLabel": "Invoice Location",<br />
"id": 112,<br />
"identifier": "Stamford",<br />
"model-name": "c_bpartner_location"<br />
},<br />
"IsSelfService": false,<br />
"IsDropShip": false,<br />
"Volume": 0.00,<br />
"Weight": 0.00,<br />
"ProcessedOn": 1615296059621.6216,<br />
"IsPayScheduleValid": false,<br />
"IsPriviledgedRate": false,<br />
"NetAmtToInvoice": 0.00,<br />
"model-name": "c_order"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Query Option $select ==<br />
The <code>$select</code> query option allows the clients to requests a limited set of properties for each entity or complex type. <br />
<br />
The request below returns Name and Value of all products.<br />
<code>GET /api/v1/models/m_product?$select=Name,Value</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"page-count": 28,<br />
"records-size": 4,<br />
"skip-records": 0,<br />
"row-count": 111,<br />
"array-count": 4,<br />
"records": [<br />
{<br />
"id": 1000322,<br />
"uid": "b0e7e8b6-13ed-406d-a105-bd67ddb7f423",<br />
"Name": "Mug 50",<br />
"Value": "Mug 50",<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 134,<br />
"uid": "01254fee-c75f-42f0-941c-142e27078643",<br />
"Name": "Patio Table",<br />
"Value": "PTable",<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 137,<br />
"uid": "26a7e6d7-e2c1-4c21-97f2-773dc222e6a2",<br />
"Name": "Mulch 10#",<br />
"Value": "Mulch",<br />
"model-name": "m_product"<br />
},<br />
{<br />
"id": 50003,<br />
"uid": "8a27ac0a-56c0-4a3a-8eb8-ff87c94899c1",<br />
"Name": "Ultra Glue",<br />
"Value": "UltraGlue",<br />
"model-name": "m_product"<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== iDempiere specific query Options ==<br />
<br />
=== Query Option $valrule ===<br />
<br />
The query option <code>$valrule</code> can be used to get PO records using a validation rule - AD_ValRule_ID or AD_ValRule_UU<br />
<br />
=== Query Option $context ===<br />
<br />
The query option <code>$context</code> can be used to put variables in context to be parsed by the validation rule<br />
<br />
=== Query Option showsql ===<br />
<br />
The query option <code>showsql</code> can be used to add the SQL query being executed on GET.<br />
<br />
You can also use <code>showsql=nodata</code> to obtain just information about the query without returning the real data.<br />
<br />
The payload will include a JSON element with name <code>sql-command</code> containing the query that is executed in the database to obtain the record(s).<br />
<br />
When <code>showsql</code> is used at the same time with <code>$expand</code>, then the payload will include the <code>sql-command</code> JSON element for the query on the master table, and also it will include the elements with format <code>sql-command-[table]</code> for each expanded table, for example the following query:<br />
<br />
<code>GET .../api/v1/models/c_tax/106?$expand=c_tax_acct&showsql</code><br />
<br />
will return the following elements in the payload:<br />
<br />
<syntaxhighlight lang="json"><br />
"sql-command": "SELECT C_Tax_ID,AD_Client_ID,AD_Org_ID,IsActive,Created,CreatedBy,Name,Description,Parent_Tax_ID,C_Country_ID,C_Region_ID,To_Country_ID,To_Region_ID,C_TaxCategory_ID,Updated,UpdatedBy,IsDocumentLevel,ValidFrom,IsSummary,Rate,RequiresTaxCertificate,TaxIndicator,IsDefault,IsTaxExempt,SOPOType,IsSalesTax,AD_Rule_ID,C_Tax_UU,C_TaxProvider_ID,C_CountryGroupTo_ID,C_CountryGroupFrom_ID FROM C_Tax WHERE (c_tax_ID=?) AND C_Tax.AD_Client_ID IN(0,11) AND (C_Tax.AD_Org_ID IN (0,11,12,50000,1000000,50002,50001,50004,50006,50005,50007))",<br />
"sql-command-c_tax_acct": "SELECT C_Tax_ID,C_AcctSchema_ID,AD_Client_ID,AD_Org_ID,IsActive,Created,CreatedBy,Updated,UpdatedBy,T_Due_Acct,T_Credit_Acct,T_Expense_Acct,C_Tax_Acct_UU FROM C_Tax_Acct WHERE (c_tax_ID=?) AND IsActive=? AND C_Tax_Acct.AD_Client_ID IN(0,11) AND (C_Tax_Acct.AD_Org_ID IN (0,11,12,50000,1000000,50002,50001,50004,50006,50005,50007))",<br />
</syntaxhighlight><br />
<br />
=== Query Option label ===<br />
<br />
The query option <code>label</code> can be used to get PO records by filtering based on labels (i.e. <code>AD_Label</code>). For example, <code>GET /api/v1/models/C_BPartner?label=Name eq '%23Customer'</code> query will return all business partner records where the name of the Assigned Label > Label is '#Customer'.<br />
<br />
iDempiere supports using nested <code>label</code> within the <code>$expand</code> query option.<br />
<br />
Refer to the <code>$filter</code> query option for the supported predicates.<br />
<br />
=== Query Option showlabel ===<br />
<br />
The query option <code>showlabel</code> can be used to include the list of assigned labels in the payload when getting a PO record or records. <br />
<br />
The query below returns the business partner record along with a list of assigned label objects, including all columns.<br />
<br />
<code>GET /api/v1/models/C_BPartner/119?showlabel&$select=Name,IsCustomer,IsVendor</code><br />
<br />
Response payload:<syntaxhighlight lang="json"><br />
{<br />
"id": 119,<br />
"uid": "61a84a1b-37a0-4dda-80a2-3ee218522b32",<br />
"Name": "GardenUser BP",<br />
"IsVendor": true,<br />
"IsCustomer": true,<br />
"model-name": "c_bpartner",<br />
"assigned-labels": [<br />
{<br />
"id": 1000000,<br />
"uid": "6d550225-2e0a-4203-9b82-0f2634f7d079",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Tenant",<br />
"id": 11,<br />
"identifier": "GardenWorld",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"Created": "2025-04-11T13:11:54Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2025-04-16T17:35:43Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"IsActive": true,<br />
"Description": "Customers",<br />
"Name": "#Customer",<br />
"model-name": "ad_label"<br />
},<br />
{<br />
"id": 1000001,<br />
"uid": "87ae21d5-f06a-4cd8-977c-86712cf58da1",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Tenant",<br />
"id": 11,<br />
"identifier": "GardenWorld",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"Created": "2025-04-11T13:13:40Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"Updated": "2025-04-16T17:36:54Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 100,<br />
"identifier": "SuperUser",<br />
"model-name": "ad_user"<br />
},<br />
"IsActive": true,<br />
"Description": "Vendors",<br />
"Name": "#Vendor",<br />
"model-name": "ad_label"<br />
}<br />
]<br />
}<br />
</syntaxhighlight>You can use <code>showlabel={columnname list}</code> to retrieve a list of assigned label objects, including the defined column list only. For example, the query below returns the business partner record along with a list of assigned label objects including the name and description.<br />
<br />
<code>GET /api/v1/models/C_BPartner/119?showlabel=Name,Description&$select=Name,IsCustomer,IsVendor</code><br />
<br />
Response payload:<syntaxhighlight lang="json"><br />
{<br />
"id": 119,<br />
"uid": "61a84a1b-37a0-4dda-80a2-3ee218522b32",<br />
"Name": "GardenUser BP",<br />
"IsVendor": true,<br />
"IsCustomer": true,<br />
"model-name": "c_bpartner",<br />
"assigned-labels": [<br />
{<br />
"Name": "#Customer",<br />
"Description": "Customers"<br />
},<br />
{<br />
"Name": "#Vendor",<br />
"Description": "Vendors"<br />
}<br />
]<br />
}<br />
</syntaxhighlight>You can use <code>showlabel={columnname}</code> to retrieve the values of the assigned label column. For example, the query below returns the business partner record along with a list of assigned label names.<br />
<br />
<code>GET /api/v1/models/C_BPartner/119?showlabel=Name&$select=Name,IsCustomer,IsVendor</code><br />
<br />
Response payload:<syntaxhighlight lang="json"><br />
{<br />
"id": 119,<br />
"uid": "61a84a1b-37a0-4dda-80a2-3ee218522b32",<br />
"Name": "GardenUser BP",<br />
"IsVendor": true,<br />
"IsCustomer": true,<br />
"model-name": "c_bpartner",<br />
"assigned-labels": [<br />
"#Customer",<br />
"#Vendor"<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
= Data Modification =<br />
<br />
iDempiere supports Create, Update and Delete operation for some or all exposed POs.<br />
<br />
== Create a PO (POST) ==<br />
To create a PO in a collection, the client sends a POST request to that collection's URL. The POST body MUST contain a single valid entity representation. <br />
<br />
The request below creates a Tax which contains complex type and collection property. <br />
<code>POST api/v1/models/c_tax</code><br />
<br />
Body<br><br />
<syntaxhighlight lang="json"><br />
{<br />
"AD_Org_ID": {<br />
"id": 0,<br />
"tableName": "AD_Org"<br />
},<br />
"isActive": true,<br />
"name": "MyGST",<br />
"description": "MyCanadian Federal Sales Tax",<br />
"Parent_Tax_ID": {<br />
"identifier": "GST/PST",<br />
"tableName": "C_Tax"<br />
},<br />
"C_Country_ID": {<br />
"lookupColumn": "CountryCode",<br />
"lookupValue": "CA"<br />
},<br />
"To_Country_ID": {<br />
"identifier": "Canada",<br />
"tableName": "C_Country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"identifier": "Standard",<br />
"tableName": "C_TaxCategory"<br />
},<br />
"isDocumentLevel": false,<br />
"validFrom": "01/01/2001",<br />
"isSummary": false,<br />
"rate": "7.0",<br />
"requiresTaxCertificate": false,<br />
"taxIndicator": "GST",<br />
"isDefault": false,<br />
"isTaxExempt": false,<br />
"sOPOType": {<br />
"id": "B"<br />
},<br />
"isSalesTax": false,<br />
"tableName": "C_Tax"<br />
}<br />
</syntaxhighlight><br />
<br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 1000005,<br />
"uid": "4e71df80-f3f5-41cd-84cf-2bc8e12322d0",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2022-10-28T15:44:44Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "Standard 19%",<br />
"Description": "MyCanadian Federal Sales Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2022-10-28T15:44:44Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "1990-01-01",<br />
"IsSummary": false,<br />
"Rate": 7.0,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "GST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": false,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
}<br />
</syntaxhighlight><br />
<br />
== Remove a PO (DELETE) ==<br />
The request below deletes the Tax with id '1000005'.<br />
<code>DELETE /api/v1/models/c_tax/1000005</code><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"msg": "Deleted"<br />
}<br />
</syntaxhighlight><br />
<br />
== Update a PO (PUT) ==<br />
The request below updates the tax with id 1000000 <br />
<code>PUT /api/v1/models/c_tax/1000000</code><br />
<br />
Body:<br />
<syntaxhighlight lang="json"><br />
{<br />
"name": "Standard Tax"<br />
}<br />
</syntaxhighlight><br />
<br />
Response Payload<br />
<syntaxhighlight lang="json"><br />
{<br />
"id": 1000002,<br />
"uid": "a1c76f9b-30ea-44c1-a8c3-2bc27daa1cd1",<br />
"AD_Client_ID": {<br />
"propertyLabel": "Client",<br />
"id": 11,<br />
"identifier": "MyGST",<br />
"model-name": "ad_client"<br />
},<br />
"AD_Org_ID": {<br />
"propertyLabel": "Organization",<br />
"id": 0,<br />
"identifier": "*",<br />
"model-name": "ad_org"<br />
},<br />
"IsActive": true,<br />
"Created": "2020-08-21T18:29:28Z",<br />
"CreatedBy": {<br />
"propertyLabel": "Created By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"Name": "Standard Tax",<br />
"Description": "My Sales Tax",<br />
"Parent_Tax_ID": {<br />
"propertyLabel": "Parent Tax",<br />
"id": 108,<br />
"identifier": "GST/PST",<br />
"model-name": "c_tax"<br />
},<br />
"C_Country_ID": {<br />
"propertyLabel": "Country",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"To_Country_ID": {<br />
"propertyLabel": "To",<br />
"id": 109,<br />
"identifier": "Canada",<br />
"model-name": "c_country"<br />
},<br />
"C_TaxCategory_ID": {<br />
"propertyLabel": "Tax Category",<br />
"id": 107,<br />
"identifier": "Standard",<br />
"model-name": "c_taxcategory"<br />
},<br />
"Updated": "2022-10-28T15:48:14Z",<br />
"UpdatedBy": {<br />
"propertyLabel": "Updated By",<br />
"id": 101,<br />
"identifier": "GardenAdmin",<br />
"model-name": "ad_user"<br />
},<br />
"IsDocumentLevel": false,<br />
"ValidFrom": "1990-01-01",<br />
"IsSummary": false,<br />
"Rate": 6.0,<br />
"RequiresTaxCertificate": false,<br />
"TaxIndicator": "GST",<br />
"IsDefault": false,<br />
"IsTaxExempt": false,<br />
"SOPOType": {<br />
"propertyLabel": "SO/PO Type",<br />
"id": "B",<br />
"identifier": "Both",<br />
"model-name": "ad_ref_list"<br />
},<br />
"IsSalesTax": true,<br />
"TaxPostingIndicator": {<br />
"propertyLabel": "Posting Indicator",<br />
"id": "0",<br />
"identifier": "Separate Tax Posting",<br />
"model-name": "ad_ref_list"<br />
},<br />
"model-name": "c_tax"<br />
}<br />
</syntaxhighlight><br />
<br />
=== Update/Insert/Delete child records of a PO (PUT) ===<br />
Update the child records of a PO using the child record array in the PUT request Body:<br />
* Without child record id to create<br />
* With child record id to update<br />
* With child record id and the following delete flag to delete a child record.<syntaxhighlight lang="json">"(delete)":true</syntaxhighlight> <br />
<p><br />
Examples to delete, create and update order lines:<br/><br />
PUT /api/v1/models/c_order/1000000<br />
<br />
<syntaxhighlight lang="json"><br />
{<br />
"C_OrderLine": [<br />
{<br />
"id": 1000000,<br />
"(delete)": true<br />
}<br />
{<br />
"M_Product_ID": 128,<br />
"QtyEntered": 1<br />
},<br />
{<br />
"id": 1000001,<br />
"QtyEntered": 2<br />
}<br />
]<br />
}<br />
</syntaxhighlight><br />
<br />
== Special Entity Type Representations ==<br />
<br />
=== Image ===<br />
If you are modifying or creating values of an Image type column/field, the json entity representation must be as follows: <br />
* id -> the foreign record ID. If not informed a new foreign record will be created and linked to the main record<br />
* file_name -> the readable file name to be stored at the foreign table<br />
* url -> an optional URL for the image to be stored at the foreign table<br />
* data -> a string with the base64 encoded data for the image<br />
<br />
= Other Resources =<br />
<br />
=== GET api/v1/auth/jwk ===<br />
<br />
Calling this endpoint returns the key used to sign the JWT.<br />
<br />
By default this endpoint returns nothing. It requires the System Configurator IDEMPIERE_REST_EXPOSE_JWK to be set to Y on System tenant.<br />
<br />
<span style="color:red>'''WARNING!'''</span> Exposing the signature key is intended exclusively for integration with API gateways that requires it (like krakend), and this endpoint MUST be hidden from public usage and exposed JUST to the API gateway. Exposing the key publicly open the REST interface to attacks changing the JWT token.<br />
<br />
'''''Returns:'''''<br />
* keys<br />
** alg<br />
** k<br />
** kid<br />
** kty<br />
<br />
=== GET api/v1/models/{tablename}/{recordId}/print ===<br />
This method is used to get the print format from the model's record id.<br />
<br />
'''''URL Parameters:'''''<br />
* $report_type -> optional - ( PDF | HTML | CSV | XLSX | XLS )<br />
<br />
'''''Returns:'''''<br />
* AD_PInstance_ID<br />
* process<br />
* summary<br />
* isError<br />
* reportFile<br />
* reportFileName<br />
* reportFileLength<br />
* nodeId<br />
<br />
== Windows api/v1/windows ==<br />
<br />
working with AD_Window and AD_Tab<br />
<br />
== Forms api/v1/forms ==<br />
<br />
=== GET api/v1/forms ===<br />
<br />
Get Forms available<br />
<br />
'''''URL Parameters:'''''<br />
* $filter -> optional - used to filter the query<br />
<br />
'''''Returns:'''''<br />
* an array of PO json records from the forms (AD_Form) queried<br />
<br />
== Processes api/v1/processes ==<br />
<br />
working with process and reports<br />
<br />
=== GET api/v1/processes ===<br />
<br />
Get Processes available<br />
<br />
'''''URL Parameters:'''''<br />
* $filter -> optional - used to filter the query<br />
<br />
'''''Returns:'''''<br />
* an array of PO json records from the process (AD_Process) queried<br />
<br />
=== GET api/v1/processes/{process_value} ===<br />
<br />
Get Information from a process<br />
<br />
'''''URL Parameters:'''''<br />
* {process_value} -> value of the process (in slug form - lowercase)<br />
<br />
'''''Returns:'''''<br />
* an PO json record from the process (AD_Process) queried<br />
<br />
=== POST api/v1/processes/{process_value} ===<br />
<br />
Run a process<br />
<br />
'''''URL Parameters:'''''<br />
* {process_value} -> value of the process (in slug form - lowercase)<br />
for example <code>https://demo.globalqss.com/api/v1/processes/translationimpexp</code><br />
<br />
'''''Body:'''''<br />
* {process_parameters} -> a JSON representation of the process parameters, for example:<br />
<syntaxhighlight lang=json><br />
{<br />
"ImportOrExport": "export",<br />
"AD_Language": "es_CO",<br />
"IsOnlyCentralizedData": true<br />
}<br />
</syntaxhighlight><br />
<br />
for reports three special parameters can be added:<br />
* report-type: with the possible values HTML, CSV, XLS or PDF (the default)<br />
* is-summary<br />
* print-format-id<br />
<br />
also, for buttons is possible to define two special parameters:<br />
* table-id or model-name<br />
* record-id<br />
<br />
'''''Returns:'''''<br />
* JSON information about the process/report executed:<br />
** AD_PInstance_ID<br />
** process<br />
** summary<br />
** isError<br />
** nodeId<br />
** logs - array containing the logs from the process<br />
<br />
The reports will be returned in an object with name <code>reportFile</code> containing the base64 encoded report, and additionally the objects <code>reportFileName</code> and <code>reportFileLength</code>.<br />
<br />
If the process produces an export file it will be returned in an object <code>exportFile</code>, and additionally the objects <code>exportFileName</code> and <code>exportFileLength</code>.<br />
<br />
=== GET api/v1/processes/jobs ===<br />
<br />
Get information about jobs running<br />
<br />
'''''Returns:'''''<br />
* an array of json records from the process running (AD_PInstance)<br />
<br />
=== GET api/v1/processes/jobs/{ad_pinstance_id} ===<br />
<br />
Get Information from a job<br />
<br />
'''''URL Parameters:'''''<br />
* {ad_pinstance_id}<br />
<br />
'''''Returns:'''''<br />
* a json record from the process (AD_PInstance)<br />
<br />
=== POST api/v1/processes/jobs/{process_value} ===<br />
<br />
Run a process in background (as job)<br />
<br />
'''''URL Parameters:'''''<br />
* {process_value} -> value of the process (in slug form - lowercase)<br />
for example <code>https://demo.globalqss.com/api/v1/processes/jobs/translationimpexp</code><br />
<br />
'''''Body:'''''<br />
* {process_parameters} -> a JSON representation of the process parameters (same as for running the process)<br />
<br />
same special parameters apply as for the reports, and additionally you can define the parameter <code>notification-type</code> with the values E, N or B (EMail, Notification or Both)<br />
<br />
'''''Returns:'''''<br />
* JSON information about the AD_PInstance scheduled<br />
<br />
== Files api/v1/files ==<br />
<br />
to access files created by api/v1/processes<br />
<br />
TBD<br />
<br />
== Caches api/v1/caches ==<br />
<br />
=== GET api/v1/caches ===<br />
<br />
Get caches information. This call is restricted just for administrators.<br />
<br />
'''''URL Parameters:'''''<br />
* table_name -> optional - to filter the list of caches<br />
* name -> optional - to filter the list of caches<br />
<br />
'''''Returns:'''''<br />
* caches (array)<br />
** name<br />
** table_name<br />
** size<br />
** expireMinutes<br />
** maxSize<br />
** distributed (boolean)<br />
<br />
=== DEL api/v1/caches ===<br />
<br />
Reset cache. This call requires the role to have permission to execute "Cache Reset" process.<br />
<br />
When called without parameters it reset the whole cache, or just from a table, or just one record.<br />
<br />
'''''URL Parameters:'''''<br />
* table_name -> optional - to restrict the reset to just one table. Case sensitive.<br />
* record_id -> optional - to restrict the reset to just one record. Zero is the same as not set, it clears the cache of the whole table.<br />
<br />
'''''Returns:'''''<br />
* entriesReset (number of entries cleared)<br />
<br />
== Nodes api/v1/nodes ==<br />
<br />
get nodes info, get log files, reset and rotate logs.<br />
<br />
TBD<br />
<br />
== Servers api/v1/servers ==<br />
<br />
servers and schedulers resource<br />
<br />
TBD<br />
<br />
== Infos api/v1/infos ==<br />
<br />
info windows<br />
<br />
TBD<br />
<br />
== Reference api/v1/reference/{id} ==<br />
<br />
You can get a reference list by id/uuid or name.<br />
<br />
'''GET .../api/v1/reference/152'''<br />
<br />
'''GET .../api/v1/reference/42522223-92ae-4405-92dc-e02e2dea61a7'''<br />
<br />
'''GET .../api/v1/reference/C_Order%20DeliveryViaRule'''<br />
<br />
''* Only list and table validation references are supported''<br />
<br />
== Workflows api/v1/workflow ==<br />
<br />
=== GET api/v1/workflow ===<br />
<br />
'''''Returns:'''''<br />
* all suspended, non-processed nodes of the current user<br />
** id<br />
** uid<br />
** model-name<br />
** node-name<br />
** node-description<br />
** priority<br />
** summary<br />
** node-help<br />
** history-records<br />
** table-name<br />
** ad_table_id<br />
** record_id<br />
** node-approval<br />
** node-confirmation<br />
** created<br />
<br />
=== GET api/v1/workflow/{userid} ===<br />
<br />
'''''Returns:'''''<br />
* all suspended, non-processed nodes of the user id passed in the URL<br />
** id<br />
** uid<br />
** model-name<br />
** node-name<br />
** node-description<br />
** priority<br />
** summary<br />
** node-help<br />
** history-records<br />
** table-name<br />
** ad_table_id<br />
** record_id<br />
** node-approval<br />
** node-confirmation<br />
** created<br />
<br />
'''''Examples:'''''<br />
/api/v1/workflow/100<br />
<br />
=== PUT api/v1/workflow/approve/{nodeid} ===<br />
<br />
Approves the corresponding node. Just for nodes of type = Approval (Column name = IsApproved).<br />
<br />
'''''Body Parameters:'''''<br />
* "message": "This is an example message for approval" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the approval<br />
<br />
=== PUT api/v1/workflow/reject/{nodeid} ===<br />
<br />
Rejects the corresponding node. Just for nodes of type = Approval (Column name = IsApproved).<br />
<br />
'''''Body Parameters:'''''<br />
* "message": "This is an example message for rejection" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the rejection<br />
<br />
=== PUT api/v1/workflow/forward/{nodeid} ===<br />
<br />
Forwards the corresponding node to a specific user. Just for nodes of type = Approval (Column name = IsApproved).<br />
<br />
'''''Body Parameters:'''''<br />
* "userTo": {userToID} '''(Mandatory)'''<br />
* "message": "This is an example message for fowarding" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the forwarding<br />
<br />
=== PUT api/v1/workflow/acknowledge/{nodeid} ===<br />
<br />
Implementation of the workflow nodes where a user gets notified when something happens, it<br />
does not require any action from the user but the user receives a message after a specific<br />
action is performed. This is used when the node is from type Window/form<br />
<br />
'''''Body Parameters:'''''<br />
* "message": "This is an example message for acknowledge" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the acknowledge<br />
<br />
=== PUT api/v1/workflow/setuserchoice/{nodeid} ===<br />
<br />
This is similar to approve and reject but it supports columns with Type List and String.<br />
<br />
'''''Body Parameters:'''''<br />
* "value":"Value to be set in the corresponding column" '''(Mandatory)'''<br />
* "message": "This is an example message for userschoice" ''(Optional)''<br />
<br />
'''''Returns:'''''<br />
* Confirmation of the acknowledge<br />
<br />
== Status lines api/v1/statuslines ==<br />
<br />
=== GET api/v1/statuslines ===<br />
<br />
Retrieve all active status line records configured in the dictionary ordered by Name.<br />
<br />
You can use the query parameters '''$filter''' to filter the records returned.<br />
<br />
Additionally, you can use the query parameter '''with_messages''' to specify that you want the resulting message returned in the payload. This means that the status line will be resolved by REST, and the result will be returned in a ''message'' property in the JSON response.<br />
<br />
'''''Returns:'''''<br />
* all the active status line records configured in the dictionary. <br />
** id<br />
** uid<br />
** model-name<br />
** name<br />
** entity type<br />
** message (optional)<br />
<br />
=== GET api/v1/statuslines/{statuslineid} ===<br />
<br />
'''''Returns:'''''<br />
* The message corresponding to the specific status line<br />
** message<br />
<br />
'''''Examples:'''''<br />
/api/v1/statuslines/200024<br />
<br />
=== GET /api/v1/statuslines/200024 ===<br />
<br />
Returns the Core status line Dashboard_OrderCount.<br />
<br />
'''''Returns:'''''<br />
{<br />
"message": "Order Count\n Top Year (2002): 4 \n Current Year: 3"<br />
}<br />
<br />
== Charts api/v1/charts ==<br />
<br />
=== GET api/v1/charts/{chartid} ===<br />
<br />
'''''URL Parameters:'''''<br />
* height -> optional - height in pixels for the image<br />
** if not provided then it uses the same height defined in the chart, or 100 if not defined in chart<br />
* width -> optional - width in pixels for the image<br />
** if not provided then it uses the height defined in the chart, or 100 if not defined in chart<br />
* json -> optional<br />
** if this parameter is present the image is returned base64 encoded in data element of JSON<br />
** when not present the image file is returned directly in PNG format<br />
<br />
'''''Returns:'''''<br />
* The image generated from the chart.<br />
* NOTE that this image is generated using the old JFreeChart library, not the new billboard, so it can have an outdated look.<br />
<br />
'''''Examples:'''''<br />
/api/v1/charts/50002?width=800&height=600&json<br />
<br />
== Menu tree api/v1/menutree/ ==<br />
<br />
=== GET api/v1/menutree/{id} ===<br />
<br />
Retrieve all the elements from the requested menu tree with id or uuid.<br />
<br />
'''''Returns:'''''<br />
* Name<br />
* Description<br />
* IsSOTrx<br />
* PredefinedContextVariables<br />
* EntityType<br />
* Action<br />
* AD_Window_ID<br />
* AD_Workflow_ID<br />
* AD_Task_ID<br />
* AD_Process_ID<br />
* AD_Form_ID<br />
* AD_InfoWindow_ID<br />
<br />
== REST View api/v1/views ==<br />
[https://github.com/bxservice/idempiere-rest/issues/281 https://github.com/bxservice/idempiere-rest/issues/281]<br />
<p><br />
iDempiere model typically has many columns and is using DB naming convention that's not particularly natural in a Json data schema. A common need is to pick a subset of columns for different use case and uses a more json oriented naming for the selected columns.<br />
<br />
This add a layer of abstraction on top of iDempiere model (term as Rest View) to cater for such need. It can be taken as a way to configure Json schema on top of iDempiere model.<br />
<br />
=== GET api/v1/views ===<br />
Get active REST view definitions (Rest_View, Rest_ViewColumn, Rest_ViewRelated).<br />
<br />
=== Support all requests and methods for api/v1/models/ ===<br />
Supports all requests and methods that are available with '''api/v1/models''', just replace '''models''' with '''views''' and '''{tableName}''' with '''{viewName}''' (i.e api/v1/views/{viewName} for api/v1/models/{tableName}, api/v1/views/{viewName}/{id} for api/v1/models/{tableName}/{id}, etc).<br />
<br />
=== Examples ===<br />
See example at [https://github.com/bxservice/idempiere-rest/issues/281 https://github.com/bxservice/idempiere-rest/issues/281]<br />
<br />
== Uploads api/v1/uploads ==<br />
[https://github.com/bxservice/idempiere-rest/issues/360 https://github.com/bxservice/idempiere-rest/issues/360]<br />
<p><br />
Allow uploading large files for posterior references where base64 files are used (e.g. attachments, images, etc)<br />
<br />
===POST api/v1/uploads===<br />
<br />
Initiates a new upload session for a file<br />
<br />
'''''Body:'''''<br />
* fileName -> The name of the file to be uploaded<br />
*contentType -> The MIME type of the file (e.g., "image/png", "application/pdf")<br />
*fileSize -> The total size of the file in bytes<br />
*chunkSize -> The preferred size of each chunk in the upload, in bytes<br />
*sha256 -> The SHA-256 hash of the file content for integrity verification<br />
<br />
'''''Returns:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*chunkSize -> The preferred size of each chunk in the upload, in bytes<br />
*expiresAt -> The expiration time of the upload session<br />
<br />
===PUT api/v1/uploads/{uploadId}/chunks/{chunkOrder}===<br />
<br />
Uploads a chunk of the file to the server<br />
<br />
'''''URL Parameters:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*chunkOrder -> The order of the chunk<br />
<br />
'''''Header Parameter:'''''<br />
*X-Content-SHA256 -> hash of the chunk data<br />
<br />
'''''Body:'''''<br />
<br />
Chunk data to be uploaded<br />
<br />
'''''Returns:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*chunkOrder -> The order of the chunk in the upload sequence<br />
*receivedSize -> The size of the chunk that has been received<br />
*message -> Additional message or details about the upload processing<br />
<br />
===GET api/v1/uploads/{uploadId}===<br />
<br />
Retrieves the current status of an ongoing or completed upload<br />
<br />
'''''URL Parameter:'''''<br />
*uploadId -> The unique ID of the upload session<br />
<br />
'''''Returns:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*fileName -> The name of the file being uploaded<br />
*fileSize -> The total size of the file being uploaded<br />
* chunkSize -> The preferred size of each chunk in the upload, in bytes<br />
*status -> Status of the upload processing (INITIATED, UPLOADING, PROCESSING, COMPLETED, CANCELED or FAILED)<br />
*uploadedChunks -> List of chunks that have been successfully uploaded<br />
**chunkOrder -> The order of the chunk in the upload sequence <br />
**receivedSize -> The size of the chunk that has been received<br />
<br />
*totalReceivedSize -> Total size of all received chunks so far<br />
*message -> Additional message or details about the upload processing<br />
<br />
===POST api/v1/uploads/{uploadId}/complete===<br />
<br />
Notifies the server that all chunks have been uploaded and the file should be reassembled<br />
<br />
'''''URL Parameter:'''''<br />
*uploadId -> The unique ID of the upload session<br />
<br />
'''''Body:'''''<br />
*fileName -> The final name of the file being uploaded (optional)<br />
*totalChunks -> The total number of chunks expected for the file upload<br />
*uploadLocation -> The upload location for the file upload (ARCHIVE, IMAGE or ATTACHMENT) (optional)<br />
<br />
'''''Returns:'''''<br />
*uploadId -> The unique ID of the upload session<br />
* status -> Status of the upload processing (INITIATED, UPLOADING, PROCESSING, COMPLETED, CANCELED or FAILED)<br />
*message -> Additional message or details about the upload processing<br />
<br />
===DEL api/v1/uploads/{uploadId} ===<br />
<br />
Cancels an ongoing/completed upload, cleans up any temporarily stored chunks and associated uploaded file<br />
<br />
'''''URL Parameter:'''''<br />
* uploadId -> The unique ID of the upload session<br />
<br />
'''''Returns:'''''<br />
*message -> Message or details about the outcome of the cancellation<br />
<br />
===GET api/v1/uploads/{uploadId}/file ===<br />
<br />
Get uploaded file content as binary stream or json<br />
<br />
'''''URL Parameter:'''''<br />
*uploadId -> The unique ID of the upload session<br />
<br />
'''''Query Parameter:'''''<br />
*asJson -> if provided, the response will be in JSON format with file content as base64 encoded string<br />
<br />
'''''Returns:'''''<br />
<br />
Response may be returned in one of the following media types:<br />
<br />
*application/octet-stream for binary data<br />
*text/html for HTML-formatted content<br />
*text/plain for plain text responses<br />
<br />
===GET api/v1/uploads===<br />
<br />
Get pending uploads from current user<br />
<br />
'''''Returns:'''''<br />
<br />
Status list of pending uploads:<br />
*uploadId -> The unique ID of the upload session<br />
*fileName -> The name of the file being uploaded<br />
*fileSize -> The total size of the file being uploaded<br />
*chunkSize -> The preferred size of each chunk in the upload, in bytes<br />
*status -> Status of the upload processing (INITIATED, UPLOADING, PROCESSING, COMPLETED, CANCELED or FAILED)<br />
*uploadedChunks -> List of chunks that have been successfully uploaded<br />
**chunkOrder -> The order of the chunk in the upload sequence<br />
**receivedSize -> The size of the chunk that has been received<br />
<br />
*totalReceivedSize -> Total size of all received chunks so far<br />
* message -> Additional message or details about the upload processing<br />
<br />
===POST api/v1/uploads/{uploadId}/copy===<br />
<br />
Copy uploaded file to attachment, image or archive (edited)<br />
<br />
'''''URL Parameter:'''''<br />
* uploadId -> The unique ID of the upload session<br />
<br />
'''''Body:'''''<br />
*copyLocation -> The copy location of the destination record (ARCHIVE, IMAGE or ATTACHMENT)<br />
* tableName -> The table name of the destination record (optional)<br />
*recordId -> The record id/uuid of the destination record (optional)<br />
<br />
'''''Returns:'''''<br />
*uploadId -> The unique ID of the upload session<br />
*tableName -> The table name of the destination record<br />
*recordId -> The record id of the destination record<br />
*recordUU -> The record uuid of the destination record<br />
*copyLocation -> The copy location of the destination record, e.g. archive (default), image or attachment<br />
* fileName -> The name of the file being copied<br />
*contentType -> The MIME type of the file being copied (e.g., "image/png", "application/pdf")<br />
* fileSize -> The size of the file being copied<br />
<br />
== Batch request api/v1/batch ==<br />
<br />
===POST api/v1/batch===<br />
<br />
Execute one or more sub-request in single transaction<br />
<br />
'''''Body:'''''<br />
<br />
Arrays of:<br/><br />
*method -> HTTP method "POST", "PUT" or "DEL"<br />
*path -> Sub-request resource path, for e.g "v1/model/C_Order"<br />
*body -> JSON body for the sub-request (if applicable)<br />
<br />
'''''Returns:'''''<br />
<br />
Arrays of:<br/><br />
*status -> HTTP status text (OK, Created, etc) return from sub-request<br />
*statusCode -> HTTP status code (200, 201, 400, etc) return from sub-request<br />
*body -> JSON return from sub-request (if available)<br />
<br />
=SysConfig Keys=<br />
<br />
==IDEMPIERE_REST_EXPOSE_JWK==<br />
<br />
Y/N - defaults to N<br />
<br />
For integration with krakend (see [[Proxy iDempiere-Rest Through KrakenD]]) it is necessary to expose the signing key in the endpoint api/v1/auth/jwk<br />
<br />
Setting this to N (the default) the endpoint is not exposed, changing to Y it will expose the endpoint.<br />
<br />
Scope: System<br />
<br />
==REST_COLUMNNAME_TOLOWERCASE ==<br />
<br />
Y/N - defaults to N<br />
<br />
When set to Y the columnnames are translated to be named as json properties. The first letter is changed to lowercase when the columnname doesn't contain the underline character ( _ )<br />
<br />
When set to N (the default) the columnname is unchanged<br />
<br />
Scope: System<br />
<br />
==REST_MAX_RECORDS_SIZE==<br />
<br />
Numeric, default 100<br />
<br />
This is a System SysConfig defining the maximum number of records returned in a get operation.<br />
<br />
After changing this SysConfig key a server restart is required.<br />
<br />
Note that $top cannot be higher than this configured value.<br />
<br />
Also, REST_MAX_RECORDS_SIZE=0 means unlimited, and in this case the $top takes precedence when defined.<br />
<br />
==REST_USE_SYSCONFIG_SECRET==<br />
<br />
Y/N, defaults to Y (true)<br />
<br />
When set to false (N) iDempiere uses a random key generated every time it is rebooted. Note this creates two problems:<br />
*The tokens generated do not survive a reboot, because the key is changed on every reboot, if there is a valid token, it becomes invalid immediately after the server is rebooted, requiring a new login<br />
*The token is generated per server, so they are not valid in a multi-server environment, load balancing the REST API in a multi-server environment can make the API useless because the token of one server is not valid in the other server<br />
<br />
When set to true (Y), the default, the tokens are generated and signed using a key saved in the System SysConfig REST_TOKEN_SECRET, so they are shared between servers and survive a reboot.<br />
<br />
Scope: System<br />
<br />
== REST_TOKEN_SECRET==<br />
<br />
In this SysConfig is preserved a random key generated, in case they key is compromised, or as a security measure, a new key can be generated using the process ''Expire Server Secret''<br />
<br />
You don't need to touch this SysConfig, it is managed automatically.<br />
<br />
==REST_TOKEN_EXPIRE_IN_MINUTES==<br />
<br />
This Tenant SysConfig set the duration of token expiration in minutes. The default is 60 minutes (1 hour). Zero (0) means no expiration. If you need to change the default number, you can add this to System Configurator and set configured value with your value.<br />
<br />
==REST_REFRESH_TOKEN_EXPIRE_IN_MINUTES==<br />
<br />
This Tenant SysConfig set the duration of refresh token expiration in minutes. This expiration is equivalent to inactivity of the session, every time the token is refreshed is set to expire again to these minutes. The default is 1440 minutes (1 day). Zero (0) means no expiration. If you need to change the default number, you can add this to System Configurator and set configured value with your value.<br />
<br />
== REST_TOKEN_ABSOLUTE_EXPIRE_IN_MINUTES==<br />
<br />
This Tenant SysConfig set the duration of a session, after this expiration the refresh token doesn't work anymore and the user needs to login again using a password. The default is 10080 minutes (1 week). Zero (0) means no expiration. If you need to change the default number, you can add this to System Configurator and set configured value with your value.<br />
<br />
==REST_MANDATORY_CLIENT_ID_ON_REFRESH==<br />
<br />
The auth/refresh endpoint requires a clientId parameter to work correctly. If your application cannot provide clientId you can set this SysConfig to N to make it optional.<br />
<br />
==REST_MANDATORY_USER_ID_ON_REFRESH==<br />
<br />
The auth/refresh endpoint requires an userId parameter to work correctly. If your application cannot provide userId you can set this SysConfig to N to make it optional.<br />
<br />
==REST_ALLOW_UPDATE_SECURE_COLUMN==<br />
<br />
By default REST allows to update columns marked as secure or encrypted. This System SysConfig changes this behavior, if you add it and set it to N, then the secure or encrypted columns cannot be updated.<br />
<br />
==REST_ERROR_ON_NON_EXISTING_COLUMN==<br />
<br />
By default REST throws errors when a column mentioned in JSON does not exist. This System SysConfig changes this behavior, if you add it and set it to N, then the REST will not throw an error.<br />
<br />
==REST_ERROR_ON_NON_UPDATABLE_COLUMN==<br />
<br />
By default REST throws errors when a column mentioned in JSON is not updatable. This System SysConfig changes this behavior, if you add it and set it to N, then the REST will not update the column but it won't throw an error<br />
<br />
==REST_EXPAND_SEPARATOR==<br />
<br />
Character - defaults to ;<br />
<br />
Expand supports sub-operators, f.i. select, expand, order by ... By default, these operators are separated using a semicolon ';'. However, this causes a problem because there are API gateways that do not support semicolons as separators, for example, Traefik by default changes semicolons to ampersands or Krakend throws an error when a URL contains a semicolon.<br />
<br />
If you want to change the separator character to something different than ';', set it using this System Configurator.<br />
<br />
Scope: System<br />
<br />
==REST_TABLES_EXPORT_LOOKUP_UU==<br />
By default, REST returns lookup values and foreign keys (FK) as a JSONObject with id, model-name, etc. Sometimes, you might need the UUID as well, but this is not possible with expand in some cases, for instance, when you are getting an FK from a System table. This SysConfig allows you to configure all tables per tenant from which you want to receive the UUID as well. You can fill this SysConfig with ''"ALL"'' (in uppercase) to specify that all FKs should return the UUID, or with a comma-separated string listing all the tables from which you want to get the UUID, for instance, ''"AD_FieldGroup, AD_Field."''<br />
<br />
*''Setting ALL can impact performance.''<br />
*''The table names'' can be in upper or lower case; it does not make a difference.<br />
<br />
=Server to Server Tokens=<br />
<br />
You can generate server to server tokens in the window ''Rest Auth Token''.<br />
<br />
Simply fill the fields:<br />
*Organization<br />
*User<br />
*Role<br />
*Warehouse<br />
*Language<br />
*Expire in Minutes (0 means no expiration)<br />
<br />
And when saving the token will be generated for these parameters.<br />
<br />
[[Image:01_Rest_Auth_Token.png|800px]]<br />
<br />
When a token is generated, the flag ''Active'' indicates if it is a valid token. To active/inactive a token you can use the process ''Inactive/Active Token''.<br />
<br />
[[Image:02_Activate_Inactivate_Token.png|800px]]<br />
<br />
Also, you can change the server secret key, and this inactivate all the issued tokens, using the process ''Expire Server Secret''<br />
<br />
[[Image:03_Expire_Server_Secret.png|800px]]<br />
<br />
=Refresh Tokens Administration=<br />
<br />
With the window ''Rest Refresh Token'' you can review and administer the refresh tokens issued by the server.<br />
<br />
For security reasons the refresh tokens are not deleted, it is recommended to set up a periodic housekeeping that takes care of deleting obsolete and unnecessary tokens.<br />
<br />
When there is a detected breach (a trial to use a refresh token twice) the token is marked as revoked with cause ''Breach'' and all the tokens related to the breached token are revoked too with cause ''Breach Chain'', including the authorization token, so, in case of a breach is mandatory that the user log in again. It is recommended to verify frequently for breaches and take potential actions (f.e. inform the user), this can be done setting an alert.<br />
<br />
Also, when a user changes his/her password all the refresh tokens are revoked with cause ''Password Change''<br />
<br />
=Role access control for resource endpoint=<br />
https://github.com/bxservice/idempiere-rest/issues/290<br />
<p><br />
Role base access control for resource endpoint path.<br />
By default, all resource endpoint path is not protected. Create a new resource path record (Rest_Resource) to protect one more resource endpoints. The resource path definition is a regular expression so you can use .* to protect all endpoint paths and add new resource path records to open access to selected resources (for e.g '''v1/models\b/?.*''').<br />
<br />
==Tables==<br />
1. Rest_Resource<br />
- Name<br />
- Resource Path (regular expression pattern, without the query parameters)<br />
2. Rest_Resource_Access<br />
- AD_Role_ID <br />
- Rest_Resource_ID<br />
- Http Methods (Multi selection list of GET, POST, PUT and DELETE)<br />
<br />
==Window==<br />
1. Rest Resource Window<br />
2. Role Data Access Window<br />
- Added Rest Resource Access tab<br />
<br />
==AD_SysConfig==<br />
1. REST_RESOURCE_ACCESS_CONTROL<br />
- Y/N, System level, default to Y<br />
<br />
==Examples==<br />
See examples at https://github.com/bxservice/idempiere-rest/issues/290<br />
<br />
=OpenAPI Support=<br />
<br />
Generate OpenAPI 3.0.0 yaml for table and view.<br />
<br />
===GET api/v1/models/{tableName}/yaml===<br />
<br />
Get OpenAPI 3.0.0 yaml schema and request for table<br />
<br />
===GET api/v1/views/{viewName}/yaml===<br />
<br />
Get OpenAPI 3.0.0 yaml schema and request for view<br />
<br />
'''''HTTP Header:'''''<br />
*Accept: application/yaml<br />
<br />
=Add Custom End Point=<br />
<br />
You can add new, custom end point with your own plugin.<br />
<br />
To do that, in your plugin:<br />
<br />
*Create resource classes for your end points using jaxrs annotation (@Path, @GET, @POST, etc).<br />
*Create an OSGi component that implements the ResourceExtension interface (@Component(service = ResourceExtension.class, immediate = true)).<br />
*Override the getResourceClasses() method and return the set of resource classes that you have created.<br />
<br />
[[Category:Available Plugins]]<br />
[[Category:Updated2022]]</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Development_With_Intellij&diff=23117Development With Intellij2025-05-03T07:44:11Z<p>Hengsin: /* Steps */</p>
<hr />
<div>'''Goal:''' Development<br />
<br />
'''Developer:''' Hengsin<br />
<br />
'''Feature''' '''Ticket:''' [https://idempiere.atlassian.net/browse/IDEMPIERE-5150 IDEMPIERE-5150]<br />
<br />
__TOC__<br />
<br />
===Description===<br />
With the help of the '''Eclipse PDE Partial''' plugin, use IntelliJ for iDempiere development.<br />
<br />
===Steps===<br />
* Install '''Intellij 2024.3.5''' or '''Intellij 2025.1'''<br />
* Install '''Eclipse PDE Partial''' plugin '''1.6.8''' from Intellij Marketplace<br />
* At the '''Projects''' window, select '''Open''' and pick the root iDempiere source folder. Make sure you have run '''mvn verify''' successfully before doing this.<br />
* The '''Eclipse PDE Partial''' plugin should be able to setup everything without further input from user.<br />
* The '''Eclipse PDE Partial''' plugin doesn't works well with Maven build files. Select '''Skip''' if the Intellij IDE shows the '''Load Maven Projects''' popup dialog.<br />
* Run or debug with Maven Run Configuration:<br />
** '''iDempiere Setup''': run the '''org.adempiere.app.install''' Maven run configuration.<br />
** '''Generate Model''': run the '''org.adempiere.modelgenerator.app''' Maven run configuration.<br />
** '''iDempiere Server''': run the '''org.adempiere.server.application''' Maven run configuration.<br />
** To debug, run one of the Maven run configuration above, click the '''Attach debugger''' link in the Run output panel or use '''Run > Attach to process...'''. <br />
** Due to the use of Equinox launcher, the Debug Maven run configuration menu wouldn't work.<br />
** To setup new maven run configuration, please refer to one of the pre-setup Maven run configuration. You can setup the '''bundles.info''' and '''dev.properties''' manually or copy it from Eclipse launch configuration (<workspace>/.metadata/.plugins/org.eclipse.pde.core/<launch configuration name>/). For the copy over bundles.info, you need to replace all occurrence of '''<home folder>''' with '''${user.home}'''.<br />
* Run or debug with '''Eclipse Application Partial''' Configuration:<br />
** '''iDempiere Setup''': run or debug the '''Install''' configuration<br />
** '''Generate Model''': run or debug the '''Model Generator''' configuration<br />
** '''iDempiere Server''': run or debug the '''iDempiere Server''' configuration<br />
* Run or debug plugin unit test (required '''Eclipse PDE Partial''' plugin '''1.6.8''' and above):<br />
** '''org.idempiere.test''': run all unit test inside the '''org.idempiere.test''' project<br />
** '''org.idempiere.test.SelectedClass''': run all unit test methods inside the currently selected class at the '''Project''' view (the class must belongs to the '''org.idempiere.test''' project).<br />
** '''org.idempiere.test.SelectedClass.Method''': run single unit test methods inside the currently selected class at the '''Project''' view (the class must belongs to the '''org.idempiere.test''' project). The run configuration will prompt for the unit test method name (you can copy the method name using the '''Structure''' view).<br />
<br />
===Maintenance of .iml file and run configurations===<br />
* We need to update the .iml files and run configurations if there are changes in project modules and/or target platform.<br />
* To update .iml files, right click on '''idempiere''' project, select '''Resolve Workspace'''. Push the updated .iml files to repository.<br />
* For Eclipse PDE Partial run configurations, update selection of target modules and run it. Push the updated configurations to repository.<br />
* For Maven run configurations, get the updated dev.properties and bundles.info from your Eclipse installation (<workspace>/.metadata/.plugins/org.eclipse.pde.core/<launch configuration name>/). For the copy over bundles.info, you need to replace all occurrence of '''<home folder>''' with '''${user.home}'''.<br />
<br />
===Working with idempiere-rest module===<br />
1. Import '''com.trekglobal.idempiere.rest.api''' module<br />
* Step 1<br/><br />
[[File:Import com.trekglobal.idempiere.rest.api Step 1.png|800x600px|frameless|Import com.trekglobal.idempiere.rest.api - Step 1]]<br />
* Step 2<br/><br />
[[File:Import com.trekglobal.idempiere.rest.api Step 2.png|800x600px|frameless|Import com.trekglobal.idempiere.rest.api - Step 2]]<br />
* Step 3<br/><br />
[[File:Import com.trekglobal.idempiere.rest.api Step 3.png|800x600px|frameless|Import com.trekglobal.idempiere.rest.api - Step 3]]<br />
* Step 4<br/><br />
[[File:Import com.trekglobal.idempiere.rest.api Step 4.png|800x600px|frameless|Import com.trekglobal.idempiere.rest.api - Step 4]]<br />
* Step 5<br/><br />
[[File:Import com.trekglobal.idempiere.rest.api Step 5.png|800x600px|frameless|Import com.trekglobal.idempiere.rest.api - Step 5]]<br />
* Step 6<br/><br />
[[File:Import com.trekglobal.idempiere.rest.api Step 6.png|800x600px|frameless|Import com.trekglobal.idempiere.rest.api - Step 6]]<br />
<p><br />
2. Configure Imported com.trekglobal.idempiere.rest.api Module<br />
* Exclude Target Folder<br/><br />
[[File:Exclude Rest API Module Target Folder.png|800x600px|frameless|Exclude com.trekglobal.idempiere.rest.api target folder]]<br />
* Set Compile Output Path<br/><br />
[[File:Com.trekglobal.idempiere.rest.api compile output path.png|800x600px|frameless|Compile output path of com.trekglobal.idempiere.rest.api]]<br />
* Set Eclipse PDE Partial Settings<br/><br />
[[File:Com.trekglobal.idempiere.rest.api facet output path.png|800x600px|frameless|com.trekglobal.idempiere.rest.api output path for Eclipse PDE Partial facet]]<br />
<p><br />
3. Close and re-open module setting to verify that the module's dependencies have been updated by the Eclipse PDE Partial plugin.<br />
[[File:Com.trekglobal.idempiere.rest.api Module Dependencies.png|800x600px|frameless|Updated module dependencies of com.trekglobal.idempiere.rest.api ]]<br />
<p><br />
4. Create a duplicate copy of '''iDempiere Server''' run configuration. Change runtime data directory path and select the '''com.trekglobal.idempiere.rest.api''' module<br />
[[File:Com.trekglobal.idempiere.rest.api Run Configuration.png|800x600px|frameless|Run configuration for com.trekglobal.idempiere.rest.api]]<br />
<p><br />
5. Run/Debug the newly created run configuration to test<br />
<br />
[[Category:New Features|D]]<br />
[[Category:New Features w13|D]]<br />
[[Category:New Features Development]]</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Development_With_Intellij&diff=23116Development With Intellij2025-05-03T07:32:44Z<p>Hengsin: /* Steps */</p>
<hr />
<div>'''Goal:''' Development<br />
<br />
'''Developer:''' Hengsin<br />
<br />
'''Feature''' '''Ticket:''' [https://idempiere.atlassian.net/browse/IDEMPIERE-5150 IDEMPIERE-5150]<br />
<br />
__TOC__<br />
<br />
===Description===<br />
With the help of the '''Eclipse PDE Partial''' plugin, use IntelliJ for iDempiere development.<br />
<br />
===Steps===<br />
* Install '''Intellij 2024.3.5''' or '''Intellij 2025.1'''<br />
* Install '''Eclipse PDE Partial''' plugin '''1.6.8''' from Intellij Marketplace<br />
* At the '''Projects''' window, select '''Open''' and pick the root iDempiere source folder. Make sure you have run '''mvn verify''' successfully before doing this.<br />
* The '''Eclipse PDE Partial''' plugin should be able to setup everything without further input from user.<br />
* The '''Eclipse PDE Partial''' plugin doesn't works well with Maven build files. Select '''Skip''' if the Intellij IDE shows the '''Load Maven Projects''' popup dialog.<br />
* Run or debug with Maven Run Configuration:<br />
** '''iDempiere Setup''': run the '''org.adempiere.app.install''' Maven run configuration.<br />
** '''Generate Model''': run the '''org.adempiere.modelgenerator.app''' Maven run configuration.<br />
** '''iDempiere Server''': run the '''org.adempiere.server.application''' Maven run configuration.<br />
** To debug, run one of the Maven run configuration above, click the '''Attach debugger''' link in the Run output panel or use '''Run > Attach to process...'''. <br />
** Due to the use of Equinox launcher, the Debug Maven run configuration menu wouldn't work.<br />
** To setup new maven run configuration, please refer to one of the pre-setup Maven run configuration. You can setup the '''bundles.info''' and '''dev.properties''' manually or copy it from Eclipse launch configuration (<workspace>/.metadata/.plugins/org.eclipse.pde.core/<launch configuration name>/). For the copy over bundles.info, you need to replace all occurrence of '''<home folder>''' with '''${user.home}'''.<br />
* Run or debug with '''Eclipse Application Partial''' Configuration:<br />
** '''iDempiere Setup''': run or debug the '''Install''' configuration<br />
** '''Generate Model''': run or debug the '''Model Generator''' configuration<br />
** '''iDempiere Server''': run or debug the '''iDempiere Server''' configuration<br />
<br />
===Maintenance of .iml file and run configurations===<br />
* We need to update the .iml files and run configurations if there are changes in project modules and/or target platform.<br />
* To update .iml files, right click on '''idempiere''' project, select '''Resolve Workspace'''. Push the updated .iml files to repository.<br />
* For Eclipse PDE Partial run configurations, update selection of target modules and run it. Push the updated configurations to repository.<br />
* For Maven run configurations, get the updated dev.properties and bundles.info from your Eclipse installation (<workspace>/.metadata/.plugins/org.eclipse.pde.core/<launch configuration name>/). For the copy over bundles.info, you need to replace all occurrence of '''<home folder>''' with '''${user.home}'''.<br />
<br />
===Working with idempiere-rest module===<br />
1. Import '''com.trekglobal.idempiere.rest.api''' module<br />
* Step 1<br/><br />
[[File:Import com.trekglobal.idempiere.rest.api Step 1.png|800x600px|frameless|Import com.trekglobal.idempiere.rest.api - Step 1]]<br />
* Step 2<br/><br />
[[File:Import com.trekglobal.idempiere.rest.api Step 2.png|800x600px|frameless|Import com.trekglobal.idempiere.rest.api - Step 2]]<br />
* Step 3<br/><br />
[[File:Import com.trekglobal.idempiere.rest.api Step 3.png|800x600px|frameless|Import com.trekglobal.idempiere.rest.api - Step 3]]<br />
* Step 4<br/><br />
[[File:Import com.trekglobal.idempiere.rest.api Step 4.png|800x600px|frameless|Import com.trekglobal.idempiere.rest.api - Step 4]]<br />
* Step 5<br/><br />
[[File:Import com.trekglobal.idempiere.rest.api Step 5.png|800x600px|frameless|Import com.trekglobal.idempiere.rest.api - Step 5]]<br />
* Step 6<br/><br />
[[File:Import com.trekglobal.idempiere.rest.api Step 6.png|800x600px|frameless|Import com.trekglobal.idempiere.rest.api - Step 6]]<br />
<p><br />
2. Configure Imported com.trekglobal.idempiere.rest.api Module<br />
* Exclude Target Folder<br/><br />
[[File:Exclude Rest API Module Target Folder.png|800x600px|frameless|Exclude com.trekglobal.idempiere.rest.api target folder]]<br />
* Set Compile Output Path<br/><br />
[[File:Com.trekglobal.idempiere.rest.api compile output path.png|800x600px|frameless|Compile output path of com.trekglobal.idempiere.rest.api]]<br />
* Set Eclipse PDE Partial Settings<br/><br />
[[File:Com.trekglobal.idempiere.rest.api facet output path.png|800x600px|frameless|com.trekglobal.idempiere.rest.api output path for Eclipse PDE Partial facet]]<br />
<p><br />
3. Close and re-open module setting to verify that the module's dependencies have been updated by the Eclipse PDE Partial plugin.<br />
[[File:Com.trekglobal.idempiere.rest.api Module Dependencies.png|800x600px|frameless|Updated module dependencies of com.trekglobal.idempiere.rest.api ]]<br />
<p><br />
4. Create a duplicate copy of '''iDempiere Server''' run configuration. Change runtime data directory path and select the '''com.trekglobal.idempiere.rest.api''' module<br />
[[File:Com.trekglobal.idempiere.rest.api Run Configuration.png|800x600px|frameless|Run configuration for com.trekglobal.idempiere.rest.api]]<br />
<p><br />
5. Run/Debug the newly created run configuration to test<br />
<br />
[[Category:New Features|D]]<br />
[[Category:New Features w13|D]]<br />
[[Category:New Features Development]]</div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Setting_up_Eclipse&diff=23115Setting up Eclipse2025-05-03T07:08:25Z<p>Hengsin: /* Eclipse version */</p>
<hr />
<div><!-- breadcrumb --><br />
<font size=-2><br />
&lArr;<br />
[[Installing_iDempiere|Table of Contents]] |<br />
[[Download the Code]] |<br />
Setting up Eclipse |<br />
[[Importing DB Seed Manually]]<br />
&rArr;<br />
</font><br />
<br />
== Materialize and build ==<br />
<br />
On the operating system navigate to the folder where you cloned the code, named below as $IDEMPIERE_REPOSITORY (f.e. /home/carlos/sources/idempiere), and run the next command:<br />
cd $HOME/sources/idempiere<br />
mvn verify<br />
This command download all libraries on Bundle-ClassPath, build all projects and output binaries to org.idempiere.p2/target/products. If not, verify with mvn -version that maven is using the correct java-version.<br />
<br />
== Setup workspace in Eclipse ==<br />
<br />
* Open again the eclipse you configured with the workspace pointing to the folder where you cloned the code<br />
** Following the example here this folder would be '''$HOME/sources/idempiere''' - this is just an example recommendation, not a must, you can use any folder as your workspace<br />
* Turn off '''Project > Build automatically'''<br />
* Navigate to '''Window > Preferences > General > Workspace'''<br />
** set '''Text file encoding''' to '''UTF-8''' (if default is different)<br />
** set '''New text file line delimiter''' to '''Unix''' (if the default is different)<br />
* Not required, this is a personal preference, but normally I switch here to Java perspective and choose Working Sets as the Top Level Elements<br />
**[[User:Hengsin|Hengsin]] ([[User talk:Hengsin|talk]]) : My preference is the Plug-in Development perspective for easy access to plugin and target platform state.<br />
<br />
* In '''Java > Installed JREs''', add the java-17-openjdk JRE if not present and select it as the active JRE:<br />
** click the '''Add''' button, then<br />
** select '''Standard VM''', click '''Next'''<br />
** enter "/usr/lib/jvm/java-17-openjdk-amd64" as JRE Home (or click the '''Directory...''' button to find the JRE/JDK 17 root folder) , click '''Finish'''<br />
** click the Checkbox next to the new entry to apply the changes.<br />
* Navigate to '''Window > Preferences > Java > Compiler'''<br />
** set '''Java > Compiler > Compiler compliance level''' to '''17'''<br />
<br />
== Import projects in Eclipse ==<br />
<br />
* Navigate to '''File > Import'''<br />
* Navigate to '''Maven > Existing Maven Projects'''<br />
* Click '''Next''' and click '''Browse...''' to select the cloned idempiere source folder<br />
** Following the example above, this folder would be '''$HOME/sources/idempiere'''<br />
* All projects must appear selected, click '''Finish''' to complete the import<br />
** At the end all projects are loaded into the workspace<br />
* Sometimes eclipse creates changes to the workspace, you can discard those changes at this point via right click on the projects and select '''Replace With > HEAD Revision'''<br />
<br />
== Set target platform ==<br />
<br />
* Now open the '''org.idempiere.p2.targetplatform.target''' file inside the '''org.idempiere.p2.targetplatform''' project<br />
** This is the default target platform definition with remote url<br />
** Here eclipse takes some time downloading the required dependencies, you can prepare some Colombian coffee and wait patiently :)<br />
* For fast setup of target platform, use '''org.idempiere.p2.targetplatform.mirror.target''' (inside the same project) instead. The downside is this doesn't comes with source code for the target platform contents and you will have to manually set it up if you need to debug into the target platform plugin (which is rare anyway).<br />
* At '''Target Editor''', click the '''Set as Active Target Platform''' link<br />
* Wait for Eclipse to finish downloading bundles onto target platform (No waiting for download if using org.idempiere.p2.targetplatform.mirror.target)<br />
** Click the "Reload" button if some download fail, until there are no red errors on the Locations list<br />
<br />
* At the end you should enable back '''Project > Build automatically'''<br />
* In case there are files with compilation errors you can right click on the iDempiere project and select '''Maven > Update Projects''', then press '''OK'''<br />
* When everything is good, close the target editor for '''org.idempiere.p2.targetplatform.target'''. Keeping it open makes Eclipse produce erratic behavior (especially after you restart your Eclipse).<br />
<br />
== Eclipse version ==<br />
As explained in the [[Install_Development_Prerequisites#Install_Eclipse|prerequisites]] the minimum version to run iDempiere is '''Eclipse 2024-03''', and specifically the version '''Eclipse IDE for Enterprise Java and Web Developers'''.<br />
<br />
In case you decided to go against the recommendation and use instead '''Eclipse IDE for Java Developers''' you'll find some problems when compiling, to overcome that you must install the '''m2e PDE - Maven Integration for Eclipse Plugin Development''' plugin (check at '''Help > About Eclipse IDE > Installation Details > Installed Software''' tab), you have to install it from https://download.eclipse.org/releases/latest (Help > Install New Software...). This plugin sits inside the '''General Purpose Tools''' category.<br />
<br />
== Notes about target platform ==<br />
* If you want to make changes to the target platform, you might want to install the Target Platform DSL Editor from https://download.eclipse.org/cbi/tpd/3.0.0-SNAPSHOT/ (Help > Install New Software... and enter the URL into the "Work with:" field). This plugin allows you to generate new org.idempiere.p2.targetplatform.target file from org.idempiere.p2.targetplatform.tpd. Note that after you have generated a new org.idempiere.p2.targetplatform.target file, you need to manually copy the maven locations from maven.locations.xml into it.<br />
<br />
<br />
''This How-To is brought to you by [[User:CarlosRuiz|Carlos Ruiz]] from [https://www.bx-service.com/ BX Service GmbH]. Feel free to improve directly or suggest using the Discussion tab.<br />
<br />
<br />
<br />
[[Category:User Manual|I]]<br />
[[Category:Installation|E]] <br />
[[Category:Installation Eclipse]] <br />
[[Category:Development]]<br />
[[Category:Developer documentation]]<br />
[[Category:HowTo]]<br />
[[Category:Updated2022]]<br />
<br />
<!-- breadcrumb --><br />
<font size=-2><br />
&lArr;<br />
[[Installing_iDempiere|Table of Contents]] |<br />
[[Download the Code]] |<br />
Setting up Eclipse |<br />
[[Importing DB Seed Manually]]<br />
&rArr;<br />
</font></div>Hengsinhttps://wiki.idempiere.org/w-en/index.php?title=Setting_up_Eclipse&diff=23114Setting up Eclipse2025-05-03T07:04:44Z<p>Hengsin: /* Set target platform */</p>
<hr />
<div><!-- breadcrumb --><br />
<font size=-2><br />
&lArr;<br />
[[Installing_iDempiere|Table of Contents]] |<br />
[[Download the Code]] |<br />
Setting up Eclipse |<br />
[[Importing DB Seed Manually]]<br />
&rArr;<br />
</font><br />
<br />
== Materialize and build ==<br />
<br />
On the operating system navigate to the folder where you cloned the code, named below as $IDEMPIERE_REPOSITORY (f.e. /home/carlos/sources/idempiere), and run the next command:<br />
cd $HOME/sources/idempiere<br />
mvn verify<br />
This command download all libraries on Bundle-ClassPath, build all projects and output binaries to org.idempiere.p2/target/products. If not, verify with mvn -version that maven is using the correct java-version.<br />
<br />
== Setup workspace in Eclipse ==<br />
<br />
* Open again the eclipse you configured with the workspace pointing to the folder where you cloned the code<br />
** Following the example here this folder would be '''$HOME/sources/idempiere''' - this is just an example recommendation, not a must, you can use any folder as your workspace<br />
* Turn off '''Project > Build automatically'''<br />
* Navigate to '''Window > Preferences > General > Workspace'''<br />
** set '''Text file encoding''' to '''UTF-8''' (if default is different)<br />
** set '''New text file line delimiter''' to '''Unix''' (if the default is different)<br />
* Not required, this is a personal preference, but normally I switch here to Java perspective and choose Working Sets as the Top Level Elements<br />
**[[User:Hengsin|Hengsin]] ([[User talk:Hengsin|talk]]) : My preference is the Plug-in Development perspective for easy access to plugin and target platform state.<br />
<br />
* In '''Java > Installed JREs''', add the java-17-openjdk JRE if not present and select it as the active JRE:<br />
** click the '''Add''' button, then<br />
** select '''Standard VM''', click '''Next'''<br />
** enter "/usr/lib/jvm/java-17-openjdk-amd64" as JRE Home (or click the '''Directory...''' button to find the JRE/JDK 17 root folder) , click '''Finish'''<br />
** click the Checkbox next to the new entry to apply the changes.<br />
* Navigate to '''Window > Preferences > Java > Compiler'''<br />
** set '''Java > Compiler > Compiler compliance level''' to '''17'''<br />
<br />
== Import projects in Eclipse ==<br />
<br />
* Navigate to '''File > Import'''<br />
* Navigate to '''Maven > Existing Maven Projects'''<br />
* Click '''Next''' and click '''Browse...''' to select the cloned idempiere source folder<br />
** Following the example above, this folder would be '''$HOME/sources/idempiere'''<br />
* All projects must appear selected, click '''Finish''' to complete the import<br />
** At the end all projects are loaded into the workspace<br />
* Sometimes eclipse creates changes to the workspace, you can discard those changes at this point via right click on the projects and select '''Replace With > HEAD Revision'''<br />
<br />
== Set target platform ==<br />
<br />
* Now open the '''org.idempiere.p2.targetplatform.target''' file inside the '''org.idempiere.p2.targetplatform''' project<br />
** This is the default target platform definition with remote url<br />
** Here eclipse takes some time downloading the required dependencies, you can prepare some Colombian coffee and wait patiently :)<br />
* For fast setup of target platform, use '''org.idempiere.p2.targetplatform.mirror.target''' (inside the same project) instead. The downside is this doesn't comes with source code for the target platform contents and you will have to manually set it up if you need to debug into the target platform plugin (which is rare anyway).<br />
* At '''Target Editor''', click the '''Set as Active Target Platform''' link<br />
* Wait for Eclipse to finish downloading bundles onto target platform (No waiting for download if using org.idempiere.p2.targetplatform.mirror.target)<br />
** Click the "Reload" button if some download fail, until there are no red errors on the Locations list<br />
<br />
* At the end you should enable back '''Project > Build automatically'''<br />
* In case there are files with compilation errors you can right click on the iDempiere project and select '''Maven > Update Projects''', then press '''OK'''<br />
* When everything is good, close the target editor for '''org.idempiere.p2.targetplatform.target'''. Keeping it open makes Eclipse produce erratic behavior (especially after you restart your Eclipse).<br />
<br />
== Eclipse version ==<br />
As explained in the [[Install_Development_Prerequisites#Install_Eclipse|prerequisites]] the minimum version to run iDempiere is Eclipse 2024-03, and specifically the version "Eclipse IDE for Enterprise Java and Web Developers".<br />
<br />
In case you decided to go against the recommendation and use instead "Eclipse IDE for Java Developers" you'll find some problems when compiling, to overcome that you must install the "m2e PDE - Maven Integration for Eclipse Plugin Development" plugin (check at Help > About Eclipse IDE > Installation Details > Installed Software tab), you have to install it from https://download.eclipse.org/releases/latest (Help > Install New Software...). This plugin sits inside the "General Purpose Tools" category.<br />
<br />
== Notes about target platform ==<br />
* If you want to make changes to the target platform, you might want to install the Target Platform DSL Editor from https://download.eclipse.org/cbi/tpd/3.0.0-SNAPSHOT/ (Help > Install New Software... and enter the URL into the "Work with:" field). This plugin allows you to generate new org.idempiere.p2.targetplatform.target file from org.idempiere.p2.targetplatform.tpd. Note that after you have generated a new org.idempiere.p2.targetplatform.target file, you need to manually copy the maven locations from maven.locations.xml into it.<br />
<br />
<br />
''This How-To is brought to you by [[User:CarlosRuiz|Carlos Ruiz]] from [https://www.bx-service.com/ BX Service GmbH]. Feel free to improve directly or suggest using the Discussion tab.<br />
<br />
<br />
<br />
[[Category:User Manual|I]]<br />
[[Category:Installation|E]] <br />
[[Category:Installation Eclipse]] <br />
[[Category:Development]]<br />
[[Category:Developer documentation]]<br />
[[Category:HowTo]]<br />
[[Category:Updated2022]]<br />
<br />
<!-- breadcrumb --><br />
<font size=-2><br />
&lArr;<br />
[[Installing_iDempiere|Table of Contents]] |<br />
[[Download the Code]] |<br />
Setting up Eclipse |<br />
[[Importing DB Seed Manually]]<br />
&rArr;<br />
</font></div>Hengsin