GlCode

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getGlCode

post

Retrieve GL code data.

Authorizations
Body
GlCodePrimaryGlCodeintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

{
  "GlCode": {
    "BRXlate": 1,
    "Description": "text",
    "PrimaryGlCode": 1,
    "XlateCount": 1,
    "XlateDetail": 1,
    "XlateGroup": 1,
    "XlateType": 1
  }
}

getGlCodeSelectFields

post

Retrieve select fields for GL code data.

Authorizations
Body
GlCodePrimaryGlCodeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "GlCodePrimaryGlCode": 1,
  "SelectableFields": {
    "IncludeAllGlCodeFields": true,
    "GlCodeFields": {
      "BRXlate": true,
      "Description": true,
      "PrimaryGlCode": true,
      "XlateCount": true,
      "XlateDetail": true,
      "XlateGroup": true,
      "XlateType": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCode": {
    "BRXlate": 1,
    "Description": "text",
    "PrimaryGlCode": 1,
    "XlateCount": 1,
    "XlateDetail": 1,
    "XlateGroup": 1,
    "XlateType": 1
  }
}

getGlCodePagedList

post

Retrieve paged GL code data.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getGlCodePagedList
POST /nexum/627/2022.01/parameter/getGlCodePagedList 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.

{
  "GlCode": [
    {
      "BRXlate": 1,
      "Description": "text",
      "PrimaryGlCode": 1,
      "XlateCount": 1,
      "XlateDetail": 1,
      "XlateGroup": 1,
      "XlateType": 1
    }
  ],
  "Token": "text"
}

getGlCodeListSelectFields

post

Retrieve select fields for a list of GL code data.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllGlCodeFields": true,
    "GlCodeFields": {
      "BRXlate": true,
      "Description": true,
      "PrimaryGlCode": true,
      "XlateCount": true,
      "XlateDetail": true,
      "XlateGroup": true,
      "XlateType": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCodeList": {
    "hasReachedMaximumListSize": true,
    "GlCode": [
      {
        "BRXlate": 1,
        "Description": "text",
        "PrimaryGlCode": 1,
        "XlateCount": 1,
        "XlateDetail": 1,
        "XlateGroup": 1,
        "XlateType": 1
      }
    ]
  }
}

searchGlCodeSelectFields

post

Field for selecting various options related to searchglcodeselectfields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllGlCodeFields": true,
    "GlCodeFields": {
      "BRXlate": true,
      "Description": true,
      "PrimaryGlCode": true,
      "XlateCount": true,
      "XlateDetail": true,
      "XlateGroup": true,
      "XlateType": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCodeList": {
    "hasReachedMaximumListSize": true,
    "GlCode": [
      {
        "BRXlate": 1,
        "Description": "text",
        "PrimaryGlCode": 1,
        "XlateCount": 1,
        "XlateDetail": 1,
        "XlateGroup": 1,
        "XlateType": 1
      }
    ]
  }
}

getGlCodePagedListSelectFields

post

Retrieve select fields for paged GL code data.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllGlCodeFields": true,
    "GlCodeFields": {
      "BRXlate": true,
      "Description": true,
      "PrimaryGlCode": true,
      "XlateCount": true,
      "XlateDetail": true,
      "XlateGroup": true,
      "XlateType": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCode": [
    {
      "BRXlate": 1,
      "Description": "text",
      "PrimaryGlCode": 1,
      "XlateCount": 1,
      "XlateDetail": 1,
      "XlateGroup": 1,
      "XlateType": 1
    }
  ],
  "Token": "text"
}

searchGlCodePagedSelectFields

post

Field for selecting various options related to searchglcodepagedselectfields

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllGlCodeFields": true,
    "GlCodeFields": {
      "BRXlate": true,
      "Description": true,
      "PrimaryGlCode": true,
      "XlateCount": true,
      "XlateDetail": true,
      "XlateGroup": true,
      "XlateType": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "GlCode": [
    {
      "BRXlate": 1,
      "Description": "text",
      "PrimaryGlCode": 1,
      "XlateCount": 1,
      "XlateDetail": 1,
      "XlateGroup": 1,
      "XlateType": 1
    }
  ],
  "Token": "text"
}

updateGlCodeByID

post
Authorizations
Body
GlCodePrimaryGlCodeintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "GlCodePrimaryGlCode": 1,
  "GlCodeUpdatableFields": {
    "BRXlate": 1,
    "Description": "text",
    "XlateDetail": 1,
    "XlateGroup": 1,
    "XlateType": 1
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?