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/2022.01/balancing/resetCashValueBalances HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182

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

200

Successful operation.

{
  "StatusMessage": "Request accepted",
  "MessageId": "resetCashValueBalances"
}

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/2022.01/balancing/resetDepositBalances HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182

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

200

Successful operation.

{
  "StatusMessage": "Request accepted",
  "MessageId": "resetDepositBalances"
}

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/2022.01/balancing/resetSecondPartyCheckBalances HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 182

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

200

Successful operation.

{
  "StatusMessage": "Request accepted",
  "MessageId": "resetSecondPartyCheckBalances"
}

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/2022.01/balancing/cashValueAdjust HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 208

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

200

Successful operation.

{
  "StatusMessage": "Request accepted",
  "MessageId": "cashValueAdjust"
}

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/2022.01/balancing/secondPartyCheckAdjust HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 210

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

200

Successful operation.

{
  "StatusMessage": "Request accepted",
  "MessageId": "secondPartyCheckAdjust"
}

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/2022.01/balancing/cashValueReport 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.

{
  "StatusMessage": "Request accepted",
  "MessageId": "cashValueReport"
}

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/2022.01/balancing/verifyDepositReport 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.

{
  "StatusMessage": "Request accepted",
  "MessageId": "verifyDepositReport"
}

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/2022.01/balancing/checkDisbursedReport 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.

{
  "StatusMessage": "Request accepted",
  "MessageId": "checkDisbursedReport"
}