DocumentNumber

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getDocumentNumber

post

Retrieve DocumentNumber parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getDocumentNumber

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getDocumentNumber HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 157

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "DocumentNumber": "NEXW45",
  "MessageId": "getDocumentNumber"
}

getDocumentNumberSelectFields

post

Retrieve DocumentNumber parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getDocumentNumberSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getDocumentNumberSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "DocumentNumberFields": {
      "Certificate": true,
      "Receipt": true,
      "Check": [
        1
      ]
    }
  }
}

200

Successful operation.

{
  "DocumentNumber": {
    "Certificate": "0.00",
    "Check": [
      {
        "EntryId": 1,
        "Check": "100016.00"
      }
    ],
    "Receipt": "0.00"
  },
  "MessageId": "getDocumentNumberSelectFields"
}

updateDocumentNumberByID

post

Update DocumentNumber parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/updateDocumentNumberByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/updateDocumentNumberByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "DocumentNumberUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateDocumentNumberByID"
}