Sensibill Rest API/com.getsensibill.rest.generated.v2.model/UserRequestDto

UserRequestDto

data class UserRequestDto(val receiptAccountEmail: String? = null, val firstName: String? = null, val lastName: String? = null, val defaultCurrency: String? = null, val folders: List<CommonRegistrationParametersFoldersInner>? = arrayListOf(), val createTestReceipts: Boolean? = null, val credentialType: String? = "sensibill", val accessID: String? = null, val accessSecret: String? = null, val email: String? = null, val password: String? = null)

Parameters

receiptAccountEmail

The email address to the users receipt account. This must be unique across all users registered with Sensibill, including both Sensibill accounts and third - party single - sign - on accounts.This will always be converted to a lower case value. Your client can be set up based on whether this parameter is required during registration, or if it is optional so that it can be specified later.The email address must use a permitted domain for your client.

firstName

The first name of the user. It is strongly encouraged that this be set to provide a more personalized experience for users.

lastName

The last name of the user.

defaultCurrency

Provides the default currency for the user. Must be an currency-code on the supported list of currencies, which can be obtained by going to /lookups/currencies

folders

Every element of the array should be an object with the folder's name, color (as six hex digits) and id.

createTestReceipts

Can be either \"true\" or \"false\". This parameter can be used by early integration partners during testing to create a number of ake testing receipts for the accounts they create.

credentialType

This is the type of credentials that will be used to identify the newly created user uniquely to Sensibill. If a user is logging in with their account on Sensibill, this parameter should be \"sensibill\". If you are implementing a third-party single-sign-on based solution, this should be set to the credentialType that you were issued with your client credentials.

accessID

If you are using third-party single-sign-on, then this parameter is what is used to uniquely identify this user account to Sensibill systems. It is equivalent to a username.

accessSecret

If you are using third-party single-sign-on, then this parameter is what is used to verify that you are the owner of this Sensibill account. It is equivalent to a password.

The email address of the user. Typically only used by clients who want to allow sending email notifications directly from Sensibill. May be required, depending on your client configuration.

password

The password for the user account. If you are creating a Sensibill account, this parameter is required. If you are using third-party single-sign-on, this parameter is optional

Constructors

UserRequestDto

constructor(receiptAccountEmail: String? = null, firstName: String? = null, lastName: String? = null, defaultCurrency: String? = null, folders: List<CommonRegistrationParametersFoldersInner>? = arrayListOf(), createTestReceipts: Boolean? = null, credentialType: String? = "sensibill", accessID: String? = null, accessSecret: String? = null, email: String? = null, password: String? = null)