Integration Request
How to use Integration Request in Integrations & API Docs: access, working steps, fields, related records and troubleshooting.
Purpose and access
Use the API documentation at api.nexcommand.ai, obtain the required authorized credentials and use the deployment-specific service URLs. SaaS tenants and on-premises installations must retain their own endpoints and access boundaries.
This page is a record page in System Admin → Integrations & API Docs. Use the link above to open the configured destination; permissions are checked by the destination service.
Before you start
Review the current settings or existing records and prepare the information needed for the change.
Confirm the company, party, dates, units and source references that apply. Select existing links carefully and check for an existing record before creating a duplicate.
Working steps
- Open Integration Request from System Admin → Integrations & API Docs, or use ERP Search.
- Filter the list and open the relevant record. To add a record, use Add/New when your role provides that action.
- Complete the editable fields described below. Required fields and validation conditions must be satisfied; read-only values are set by the system or their source records.
- Save the record and address validation messages. Reload and verify the saved values and relationships.
- Use any additional workflow actions only when the record and your role provide them. Saving this record does not automatically complete a related transaction or external action.
Field reference
These fields come from the installed ERP definition. Hidden fields and password inputs are omitted. Additional conditions, custom scripts and workflow rules can make a field required or read-only in a particular context.
| Field | Type / behavior | How to use it |
|---|---|---|
Request IDrequest_id | Data Optional · Read-only | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Serviceintegration_request_service | Data Optional · Read-only | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Is Remote Request?is_remote_request | Check Optional · Read-only | Enable or disable the named option only when it matches the intended record behavior. |
Request Descriptionrequest_description | Data Optional · Read-only | Enter the identifier or short text requested by the label. Preserve external reference numbers accurately. |
Statusstatus | Select Optional · Read-only | Choose one of the configured list values. Status fields may be controlled by the record workflow.Available choices
|
URLurl | Small Text Optional · Read-only | Provide concise contextual information relevant to the record. Avoid unrelated personal or confidential data. |
Request Headersrequest_headers | Code Optional · Read-only | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Request Datadata | Code Optional · Read-only | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Response Headersresponse_headers | Code Optional · Read-only | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Outputoutput | Code Optional · Read-only | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Errorerror | Code Optional · Read-only | Administrator/integration field. Use a validated configuration or supported script and test its impact before deployment. |
Reference Document Typereference_doctype | Link Optional · Read-only | Choose an existing linked record. Check its company and ownership; typing a label alone does not create a new relationship. Linked record: DocType |
Reference Document Namereference_docname | Dynamic Link Optional · Read-only | Select the record identified by the associated document-type field. Verify both the type and the linked record. |
Troubleshooting
- Not permitted: verify the account, role and source-document permission. Do not share an administrator login.
- Missing record or address: inspect the relevant Link or Dynamic Link fields; a matching title alone does not establish a relationship.
- Cannot save or change status: review required fields, read-only values, document status and the configured approval transition.
- Unexpected report or portal result: review company/date filters, source-document submission and the approved party or Employee link.