BalancingService

Perform balancing operations.

Symitar eDocs References: Coming soon.

Operations

resetCashValueBalances

post

Resets cash value balances.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

BalanceReportFlagbooleanRequired

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

post

/resetCashValueBalances

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/balancing/resetCashValueBalances HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "BalanceReportFlag": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CashValueReport": {
    "BalanceDispenser": [
      {
        "DispenserId": 1,
        "TranGlCode": 1,
        "SourceGlCode": 1,
        "Denomination": 1,
        "BeginAmount": 1,
        "DispenseAmount": 1,
        "ReverseAmount": 1,
        "AdjustAmount": 1,
        "ReplenishAmount": 1,
        "RevTotalAmount": 1,
        "CurrentAmount": 1,
        "WarningAmount": 1
      }
    ]
  }
}

resetDepositBalances

post

Resets deposit balances.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

BalanceReportFlagbooleanRequired

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

post

/resetDepositBalances

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/balancing/resetDepositBalances HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "BalanceReportFlag": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "DepositReport": {
    "Count": 1,
    "Amount": 1,
    "GlCode": 1,
    "GlTranCount": 1
  }
}

resetSecondPartyCheckBalances

post

Resets second-party check balances.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

BalanceReportFlagbooleanRequired

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

post

/resetSecondPartyCheckBalances

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/balancing/resetSecondPartyCheckBalances HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 164

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "BalanceReportFlag": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CheckDisbursedReport": {
    "FirstPartyCount": 1,
    "FirstPartyAmount": 1,
    "BalancePrinter": [
      {
        "PrinterId": 1,
        "TranGlCode": 1,
        "CheckAcctNumber": "text",
        "BeginCount": 1,
        "DispenseCount": 1,
        "DispenseAmount": 1,
        "ReverseCount": 1,
        "ReverseAmount": 1,
        "AdjustCount": 1,
        "ReplenishCount": 1,
        "CurrentCount": 1,
        "RevTotalCount": 1,
        "WarnCount": 1
      }
    ],
    "ThirdPartyCount": 1,
    "ThirdPartyAmount": 1
  }
}

cashValueAdjust

post

Adjusts cash values.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

BalanceReportFlagbooleanOptional

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

post

/cashValueAdjust

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/balancing/cashValueAdjust HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 343

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "CashValueAdjustInput": {
    "DispenserAdjust": [
      {
        "GlCode": 1,
        "SrcGlCode": 1,
        "Denomination": 1,
        "AdjustAmount": 1,
        "ReplenishAmount": 1,
        "WarnAmount": 1,
        "ResetDispenser": true,
        "DispenserId": 1
      }
    ]
  },
  "BalanceReportFlag": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CashValueReport": {
    "BalanceDispenser": [
      {
        "DispenserId": 1,
        "TranGlCode": 1,
        "SourceGlCode": 1,
        "Denomination": 1,
        "BeginAmount": 1,
        "DispenseAmount": 1,
        "ReverseAmount": 1,
        "AdjustAmount": 1,
        "ReplenishAmount": 1,
        "RevTotalAmount": 1,
        "CurrentAmount": 1,
        "WarningAmount": 1
      }
    ]
  }
}

secondPartyCheckAdjust

post

Adjusts second-party checks.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

BalanceReportFlagbooleanOptional

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

post

/secondPartyCheckAdjust

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/balancing/secondPartyCheckAdjust HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 324

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "SecondPartyCheckAdjust": {
    "PrinterAdjust": [
      {
        "PrinterId": 1,
        "GlCode": 1,
        "CheckAcct": "text",
        "AdjustCount": 1,
        "ReplenishCount": 1,
        "WarnCount": 1,
        "ResetPrinter": true
      }
    ]
  },
  "BalanceReportFlag": true,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CheckDisbursedReport": {
    "FirstPartyCount": 1,
    "FirstPartyAmount": 1,
    "BalancePrinter": [
      {
        "PrinterId": 1,
        "TranGlCode": 1,
        "CheckAcctNumber": "text",
        "BeginCount": 1,
        "DispenseCount": 1,
        "DispenseAmount": 1,
        "ReverseCount": 1,
        "ReverseAmount": 1,
        "AdjustCount": 1,
        "ReplenishCount": 1,
        "CurrentCount": 1,
        "RevTotalCount": 1,
        "WarnCount": 1
      }
    ],
    "ThirdPartyCount": 1,
    "ThirdPartyAmount": 1
  }
}

cashValueReport

post

Generates a report on cash values.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

post

/cashValueReport

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/balancing/cashValueReport HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CashValueReport": {
    "BalanceDispenser": [
      {
        "DispenserId": 1,
        "TranGlCode": 1,
        "SourceGlCode": 1,
        "Denomination": 1,
        "BeginAmount": 1,
        "DispenseAmount": 1,
        "ReverseAmount": 1,
        "AdjustAmount": 1,
        "ReplenishAmount": 1,
        "RevTotalAmount": 1,
        "CurrentAmount": 1,
        "WarningAmount": 1
      }
    ]
  }
}

verifyDepositReport

post

Verifies deposit reports.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

post

/verifyDepositReport

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/balancing/verifyDepositReport HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "DepositReport": {
    "Count": 1,
    "Amount": 1,
    "GlCode": 1,
    "GlTranCount": 1
  }
}

checkDisbursedReport

post

Generates a report on disbursed checks.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

StatusMessagestringOptional

post

/checkDisbursedReport

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/balancing/checkDisbursedReport HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "Credentials": {
    "UserNumberCredentials": {
      "UserNumber": 1995,
      "Password": "2dfKQYR!TeXJwe"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "StatusMessage": "text",
  "CheckDisbursedReport": {
    "FirstPartyCount": 1,
    "FirstPartyAmount": 1,
    "BalancePrinter": [
      {
        "PrinterId": 1,
        "TranGlCode": 1,
        "CheckAcctNumber": "text",
        "BeginCount": 1,
        "DispenseCount": 1,
        "DispenseAmount": 1,
        "ReverseCount": 1,
        "ReverseAmount": 1,
        "AdjustCount": 1,
        "ReplenishCount": 1,
        "CurrentCount": 1,
        "RevTotalCount": 1,
        "WarnCount": 1
      }
    ],
    "ThirdPartyCount": 1,
    "ThirdPartyAmount": 1
  }
}