GlCategory

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getGlCategory

post

Retrieve GL category data.

Authorizations
Body
GlCategoryGlCategoryintegerRequired
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "GlCategoryGlCategory": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCategory": {
    "GlCategory": 1,
    "GlCategoryDescription": "text"
  }
}

getGlCategorySelectFields

post

Retrieve select fields for GL category data.

Authorizations
Body
GlCategoryGlCategoryintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "GlCategoryGlCategory": 1,
  "SelectableFields": {
    "IncludeAllGlCategoryFields": true,
    "GlCategoryFields": {
      "GlCategory": true,
      "GlCategoryDescription": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCategory": {
    "GlCategory": 1,
    "GlCategoryDescription": "text"
  }
}

getGlCategoryPagedList

post

Retrieve paged GL category data.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCategory": [
    {
      "GlCategory": 1,
      "GlCategoryDescription": "text"
    }
  ],
  "Token": "text"
}

getGlCategoryListSelectFields

post

Retrieve select fields for a list of GL category data.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllGlCategoryFields": true,
    "GlCategoryFields": {
      "GlCategory": true,
      "GlCategoryDescription": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCategoryList": {
    "hasReachedMaximumListSize": true,
    "GlCategory": [
      {
        "GlCategory": 1,
        "GlCategoryDescription": "text"
      }
    ]
  }
}

searchGlCategorySelectFields

post

Field for selecting various options related to searchglcategoryselectfields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllGlCategoryFields": true,
    "GlCategoryFields": {
      "GlCategory": true,
      "GlCategoryDescription": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCategoryList": {
    "hasReachedMaximumListSize": true,
    "GlCategory": [
      {
        "GlCategory": 1,
        "GlCategoryDescription": "text"
      }
    ]
  }
}

getGlCategoryPagedListSelectFields

post

Retrieve select fields for paged GL category data.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllGlCategoryFields": true,
    "GlCategoryFields": {
      "GlCategory": true,
      "GlCategoryDescription": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCategory": [
    {
      "GlCategory": 1,
      "GlCategoryDescription": "text"
    }
  ],
  "Token": "text"
}

searchGlCategoryPagedSelectFields

post

Field for selecting various options related to searchglcategorypagedselectfields

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllGlCategoryFields": true,
    "GlCategoryFields": {
      "GlCategory": true,
      "GlCategoryDescription": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCategory": [
    {
      "GlCategory": 1,
      "GlCategoryDescription": "text"
    }
  ],
  "Token": "text"
}

updateGlCategoryByID

post
Authorizations
Body
GlCategoryGlCategoryintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "GlCategoryGlCategory": 1,
  "GlCategoryUpdatableFields": {
    "GlCategoryDescription": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}
PreviousExtLoanNextGlCode

Last updated

Was this helpful?