Create FinCalc session

POST /api/v2/user/session
Bearer auth

This endpoint creates a new FinCalc user session. Different optional parameters can be passed.

application/json

Body

  • ClientGUID string(uuid) | null

    This field is required if PresentationMode is set to 2 and/or Area is set To Client or FactFind, and BackOfficeID is not set

  • BackOfficeID string | null

    This field is required if PresentationMode is set to 2 and/or Area is set to Client or FactFind, and ClientGUID is not set. If ClientGUID and BackOfficeID are both set, this field will be used to locate the client. If BackOfficeID is set and the client does NOT yet exist in FinCalc, we will create a shell of the client by getting basic information from the back office; a full sync is then done once logged in. Currently only Curo is supported if BackOfficeID is set.

  • PresentationMode integer | null

    Create a presentation mode session. An integer representing the status of presentation mode:

    • 1: On.
    • 2: On but search disabled (Client area).

    If PresentationMode is set, this mode will be loaded regardless of what has been specified as the Area field.

  • Area string | null

    A string representing the area:

    • Dashboard
    • Client
    • FactFind
  • Sync string | null

    An integer representing the sync status:

    • Omitted: Respect the cashflow sync setting so may do a full sync or only clients.
    • 1: Yes (do a full sync regardless of cashflow setting).
    • 2: No (do not sync anything including clients).

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
  • 404 application/json

    Client not found.

    Hide response attributes Show response attributes object
  • 422 application/json

    Validation error.

    Hide response attributes Show response attributes object
    • success boolean

      Default value is false.

    • message string
    • data object

      Example validation error message.

      Hide data attribute Show data attribute object
  • 500 application/json

    Internal Server Error.

    Hide response attributes Show response attributes object
POST /api/v2/user/session 
curl \
 -X POST https://api.fincalc.co.uk/api/v2/user/session \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"ClientGUID":"9AF4C4F2-1F8D-4C6F-98A1-4C893EC8C8C8","BackOfficeID":"2C3F750E-0304-4FC3-82B9-66F280267F05","PresentationMode":1,"Area":"Dashboard","Sync":1}'
Request examples 
{
  "ClientGUID": "9AF4C4F2-1F8D-4C6F-98A1-4C893EC8C8C8",
  "BackOfficeID": "2C3F750E-0304-4FC3-82B9-66F280267F05",
  "PresentationMode": 1,
  "Area": "Dashboard",
  "Sync": 1
}
Response examples (200) 
{
  "success": true,
  "data": {
    "URL": "https://fincalc.co.uk/login/session/AB8A075D-F481-4056-AF3D-67C75F4600B2/256",
    "ExpiryDate": "2023-05-04 12:10:01"
  }
}
Response examples (404) 
{
  "success": false,
  "message": "Client not found"
}
Response examples (422) 
{
  "success": false,
  "message": "Validation Error",
  "data": {
    "Sync": [
      "The selected sync is invalid."
    ]
  }
}
Response examples (500) 
{
  "success": false,
  "message": "Failed to connect to Curo."
}