AlbaApi

<back to all web services

PowensConnectionSyncRequest

The following routes are available for this service:
POST/ext/powens/connection_synced

export class Stability
{
    public status?: string;
    public lastUpdate?: string;

    public constructor(init?: Partial<Stability>) { (Object as any).assign(this, init); }
}

export enum AuthMechanism
{
    Credentials = 'credentials',
    WebAuth = 'webauth',
}

// @DataContract
export class ConnectorReq
{
    // @DataMember(Name="id")
    public id?: number;

    // @DataMember(Name="name")
    public name?: string;

    // @DataMember(Name="hidden")
    public hidden?: boolean;

    // @DataMember(Name="charged")
    public charged?: boolean;

    // @DataMember(Name="code")
    public code?: string;

    // @DataMember(Name="beta")
    public beta?: boolean;

    // @DataMember(Name="color")
    public color?: string;

    // @DataMember(Name="slug")
    public slug?: string;

    // @DataMember(Name="sync_periodicity")
    public sync_periodicity?: number;

    // @DataMember(Name="months_to_fetch")
    public months_to_fetch?: number;

    // @DataMember(Name="siret")
    public siret?: string;

    // @DataMember(Name="uuid")
    public uuid?: string;

    // @DataMember(Name="restricted")
    public restricted?: boolean;

    // @DataMember(Name="stability")
    public stability?: Stability;

    // @DataMember(Name="capabilities")
    public capabilities?: string[];

    // @DataMember(Name="available_auth_mechanisms")
    public available_auth_mechanisms?: AuthMechanism[];

    // @DataMember(Name="categories")
    public categories?: string[];

    // @DataMember(Name="auth_mechanism")
    public auth_mechanism?: AuthMechanism;

    // @DataMember(Name="account_types")
    public account_types?: Object[];

    // @DataMember(Name="account_usage")
    public account_usage?: Object[];

    // @DataMember(Name="documents_type")
    public documents_type?: string[];

    // @DataMember(Name="products")
    public products?: Object[];

    public constructor(init?: Partial<ConnectorReq>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ConnectionRequest
{
    // @DataMember(Name="id")
    public id?: number;

    // @DataMember(Name="id_user")
    public id_user?: number;

    // @DataMember(Name="id_connector")
    public id_connector?: number;

    // @DataMember(Name="last_update")
    public last_update?: string;

    // @DataMember(Name="created")
    public created?: string;

    // @DataMember(Name="active")
    public active?: boolean;

    // @DataMember(Name="last_push")
    public last_push?: string;

    // @DataMember(Name="next_try")
    public next_try?: string;

    // @DataMember(Name="connector")
    public connector?: ConnectorReq;

    // @DataMember(Name="accounts")
    public accounts?: PowensAccount[];

    // @DataMember(Name="state")
    public state?: string;

    // @DataMember(Name="error")
    public error?: string;

    // @DataMember(Name="error_message")
    public error_message?: string;

    // @DataMember(Name="expire")
    public expire?: string;

    // @DataMember(Name="id_provider")
    public id_provider?: number;

    // @DataMember(Name="id_bank")
    public id_bank?: number;

    // @DataMember(Name="bank")
    public bank?: ConnectorReq;

    // @DataMember(Name="connector_uuid")
    public connector_uuid?: string;

    // @DataMember(Name="informations")
    public informations?: Object;

    public constructor(init?: Partial<ConnectionRequest>) { (Object as any).assign(this, init); }
}

export class PowensConnectionSyncRequest
{
    public connection?: ConnectionRequest;
    // @DataMember(Name="push_type")
    public push_type?: string;

    // @DataMember(Name="id_webhook_data")
    public id_webhook_data?: number;

    public constructor(init?: Partial<PowensConnectionSyncRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PowensCurrency
{
    // @DataMember(Name="id")
    public id?: string;

    // @DataMember(Name="name")
    public name?: string;

    // @DataMember(Name="symbol")
    public symbol?: string;

    // @DataMember(Name="crypto")
    public crypto?: boolean;

    // @DataMember(Name="precision")
    public precision?: number;

    // @DataMember(Name="prefix")
    public prefix?: boolean;

    // @DataMember(Name="marketcap")
    public marketcap?: Object;

    // @DataMember(Name="datetime")
    public datetime?: string;

    public constructor(init?: Partial<PowensCurrency>) { (Object as any).assign(this, init); }
}

export enum AccountUsage
{
    PRIV = 1,
    ORGA = 2,
}

// @DataContract
export class PowensInformation
{
    // @DataMember(Name="version")
    public version?: string;

    // @DataMember(Name="provider_type")
    public provider_type?: string;

    public constructor(init?: Partial<PowensInformation>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PowensLoan
{
    // @DataMember(Name="total_amount")
    public total_amount?: number;

    // @DataMember(Name="available_amount")
    public available_amount?: number;

    // @DataMember(Name="used_amount")
    public used_amount?: number;

    // @DataMember(Name="subscription_date")
    public subscription_date?: string;

    // @DataMember(Name="maturity_date")
    public maturity_date?: string;

    // @DataMember(Name="next_payment_amount")
    public next_payment_amount?: number;

    // @DataMember(Name="next_payment_date")
    public next_payment_date?: string;

    // @DataMember(Name="rate")
    public rate?: number;

    // @DataMember(Name="nb_payments_left")
    public nb_payments_left?: number;

    // @DataMember(Name="nb_payments_done")
    public nb_payments_done?: number;

    // @DataMember(Name="nb_payments_total")
    public nb_payments_total?: number;

    // @DataMember(Name="last_payment_amount")
    public last_payment_amount?: number;

    // @DataMember(Name="last_payment_date")
    public last_payment_date?: string;

    // @DataMember(Name="account_label")
    public account_label?: string;

    // @DataMember(Name="insurance_label")
    public insurance_label?: string;

    // @DataMember(Name="insurance_amount")
    public insurance_amount?: number;

    // @DataMember(Name="insurance_rate")
    public insurance_rate?: number;

    // @DataMember(Name="duration")
    public duration?: number;

    // @DataMember(Name="type")
    public type?: string;

    public constructor(init?: Partial<PowensLoan>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PowensAccount
{
    // @DataMember(Name="investments")
    public investments?: PowensInvestment[];

    // @DataMember(Name="id")
    public id?: number;

    // @DataMember(Name="id_connection")
    public id_connection?: number;

    // @DataMember(Name="id_user")
    public id_user?: number;

    // @DataMember(Name="id_source")
    public id_source?: number;

    // @DataMember(Name="id_parent")
    public id_parent?: number;

    // @DataMember(Name="number")
    public number?: string;

    // @DataMember(Name="webid")
    public webid?: string;

    // @DataMember(Name="original_name")
    public original_name?: string;

    // @DataMember(Name="balance")
    public balance?: number;

    // @DataMember(Name="coming")
    public coming?: number;

    // @DataMember(Name="display")
    public display?: boolean;

    // @DataMember(Name="last_update")
    public last_update?: string;

    // @DataMember(Name="deleted")
    public deleted?: string;

    // @DataMember(Name="disabled")
    public disabled?: string;

    // @DataMember(Name="iban")
    public iban?: string;

    // @DataMember(Name="currency")
    public currency?: PowensCurrency;

    // @DataMember(Name="id_type")
    public id_type?: number;

    // @DataMember(Name="bookmarked")
    public bookmarked?: number;

    // @DataMember(Name="name")
    public name?: string;

    // @DataMember(Name="error")
    public error?: string;

    // @DataMember(Name="usage")
    public usage?: AccountUsage;

    // @DataMember(Name="company_name")
    public company_name?: string;

    // @DataMember(Name="opening_date")
    public opening_date?: string;

    // @DataMember(Name="bic")
    public bic?: Object;

    // @DataMember(Name="coming_balance")
    public coming_balance?: number;

    // @DataMember(Name="formatted_balance")
    public formatted_balance?: string;

    // @DataMember(Name="type")
    public type?: string;

    // @DataMember(Name="calculated")
    public calculated?: string[];

    // @DataMember(Name="valuation")
    public valuation?: number;

    // @DataMember(Name="diff")
    public diff?: number;

    // @DataMember(Name="diff_percent")
    public diff_percent?: number;

    // @DataMember(Name="prev_diff")
    public prev_diff?: number;

    // @DataMember(Name="prev_diff_percent")
    public prev_diff_percent?: number;

    // @DataMember(Name="information")
    public information?: PowensInformation;

    // @DataMember(Name="loan")
    public loan?: PowensLoan;

    public constructor(init?: Partial<PowensAccount>) { (Object as any).assign(this, init); }
}

export class Currency
{
    public id?: string;
    public name?: string;
    public symbol?: string;
    public crypto?: boolean;
    public precision?: number;
    public prefix?: boolean;
    public marketcap?: Object;
    public datetime?: string;

    public constructor(init?: Partial<Currency>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PowensInvestment
{
    // @DataMember(Name="id")
    public id?: number;

    // @DataMember(Name="id_account")
    public id_account?: number;

    // @DataMember(Name="label")
    public label?: string;

    // @DataMember(Name="code")
    public code?: string;

    // @DataMember(Name="code_type")
    public code_type?: string;

    // @DataMember(Name="stock_symbol")
    public stock_symbol?: string;

    // @DataMember(Name="stock_market")
    public stock_market?: Object;

    // @DataMember(Name="source")
    public source?: string;

    // @DataMember(Name="description")
    public description?: string;

    // @DataMember(Name="quantity")
    public quantity?: number;

    // @DataMember(Name="unitprice")
    public unitprice?: number;

    // @DataMember(Name="unitvalue")
    public unitvalue?: number;

    // @DataMember(Name="valuation")
    public valuation?: number;

    // @DataMember(Name="diff")
    public diff?: number;

    // @DataMember(Name="diff_percent")
    public diff_percent?: number;

    // @DataMember(Name="prev_diff")
    public prev_diff?: number;

    // @DataMember(Name="portfolio_share")
    public portfolio_share?: number;

    // @DataMember(Name="vdate")
    public vdate?: string;

    // @DataMember(Name="prev_vdate")
    public prev_vdate?: string;

    // @DataMember(Name="id_security")
    public id_security?: number;

    // @DataMember(Name="original_currency")
    public original_currency?: Currency;

    // @DataMember(Name="original_valuation")
    public original_valuation?: number;

    // @DataMember(Name="original_unitvalue")
    public original_unitvalue?: number;

    // @DataMember(Name="original_unitprice")
    public original_unitprice?: number;

    // @DataMember(Name="original_diff")
    public original_diff?: number;

    // @DataMember(Name="last_update")
    public last_update?: string;

    // @DataMember(Name="deleted")
    public deleted?: string;

    // @DataMember(Name="calculated")
    public calculated?: string[];

    // @DataMember(Name="id_type")
    public id_type?: number;

    public constructor(init?: Partial<PowensInvestment>) { (Object as any).assign(this, init); }
}

TypeScript PowensConnectionSyncRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /ext/powens/connection_synced HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	connection: 
	{
		id: 0,
		id_user: 0,
		id_connector: 0,
		last_update: 0001-01-01,
		created: 0001-01-01,
		active: False,
		last_push: 0001-01-01,
		next_try: 0001-01-01,
		connector: 
		{
			id: 0,
			name: String,
			hidden: False,
			charged: False,
			code: String,
			beta: False,
			color: String,
			slug: String,
			sync_periodicity: 0,
			months_to_fetch: 0,
			siret: String,
			uuid: String,
			restricted: False,
			stability: 
			{
				status: String,
				lastUpdate: 0001-01-01
			},
			capabilities: 
			[
				String
			],
			available_auth_mechanisms: 
			[
				credentials
			],
			categories: 
			[
				String
			],
			auth_mechanism: credentials,
			account_types: 
			[
				{
					
				}
			],
			account_usage: 
			[
				{
					
				}
			],
			documents_type: 
			[
				String
			],
			products: 
			[
				{
					
				}
			]
		},
		accounts: 
		[
			{
				investments: 
				[
					{
						id: 0,
						id_account: 0,
						label: String,
						code: String,
						code_type: String,
						stock_symbol: String,
						stock_market: {},
						source: String,
						description: String,
						quantity: 0,
						unitprice: 0,
						unitvalue: 0,
						valuation: 0,
						diff: 0,
						diff_percent: 0,
						prev_diff: 0,
						portfolio_share: 0,
						vdate: 0001-01-01,
						prev_vdate: 0001-01-01,
						id_security: 0,
						original_currency: 
						{
							id: String,
							name: String,
							symbol: String,
							crypto: False,
							precision: 0,
							prefix: False,
							marketcap: {},
							datetime: 0001-01-01
						},
						original_valuation: 0,
						original_unitvalue: 0,
						original_unitprice: 0,
						original_diff: 0,
						last_update: 0001-01-01,
						deleted: 0001-01-01,
						calculated: 
						[
							String
						],
						id_type: 0
					}
				],
				id: 0,
				id_connection: 0,
				id_user: 0,
				id_source: 0,
				id_parent: 0,
				number: String,
				webid: String,
				original_name: String,
				balance: 0,
				coming: 0,
				display: False,
				last_update: 0001-01-01,
				deleted: 0001-01-01,
				disabled: 0001-01-01,
				iban: String,
				currency: 
				{
					id: String,
					name: String,
					symbol: String,
					crypto: False,
					precision: 0,
					prefix: False,
					marketcap: {},
					datetime: 0001-01-01
				},
				id_type: 0,
				bookmarked: 0,
				name: String,
				error: String,
				usage: 0,
				company_name: String,
				opening_date: 0001-01-01,
				bic: {},
				coming_balance: 0,
				formatted_balance: String,
				type: String,
				calculated: 
				[
					String
				],
				valuation: 0,
				diff: 0,
				diff_percent: 0,
				prev_diff: 0,
				prev_diff_percent: 0,
				information: 
				{
					version: String,
					provider_type: String
				},
				loan: 
				{
					total_amount: 0,
					available_amount: 0,
					used_amount: 0,
					subscription_date: 0001-01-01,
					maturity_date: 0001-01-01,
					next_payment_amount: 0,
					next_payment_date: 0001-01-01,
					rate: 0,
					nb_payments_left: 0,
					nb_payments_done: 0,
					nb_payments_total: 0,
					last_payment_amount: 0,
					last_payment_date: 0001-01-01,
					account_label: String,
					insurance_label: String,
					insurance_amount: 0,
					insurance_rate: 0,
					duration: 0,
					type: String
				}
			}
		],
		state: String,
		error: String,
		error_message: String,
		expire: 0001-01-01,
		id_provider: 0,
		id_bank: 0,
		bank: 
		{
			id: 0,
			name: String,
			hidden: False,
			charged: False,
			code: String,
			beta: False,
			color: String,
			slug: String,
			sync_periodicity: 0,
			months_to_fetch: 0,
			siret: String,
			uuid: String,
			restricted: False,
			stability: 
			{
				status: String,
				lastUpdate: 0001-01-01
			},
			capabilities: 
			[
				String
			],
			available_auth_mechanisms: 
			[
				credentials
			],
			categories: 
			[
				String
			],
			auth_mechanism: credentials,
			account_types: 
			[
				{
					
				}
			],
			account_usage: 
			[
				{
					
				}
			],
			documents_type: 
			[
				String
			],
			products: 
			[
				{
					
				}
			]
		},
		connector_uuid: String,
		informations: {}
	},
	push_type: String,
	id_webhook_data: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	version: 
	{
		major: 0,
		minor: 0,
		build: -1,
		revision: -1,
		majorRevision: -1,
		minorRevision: -1
	},
	content: 
	{
		__type: "System.Net.Http.EmptyContent, System.Net.Http",
		headers: []
	},
	statusCode: Continue,
	reasonPhrase: String,
	headers: [],
	trailingHeaders: [],
	requestMessage: 
	{
		version: 
		{
			major: 0,
			minor: 0,
			build: -1,
			revision: -1,
			majorRevision: -1,
			minorRevision: -1
		},
		versionPolicy: RequestVersionOrLower,
		method: 
		{
			method: GET
		},
		headers: [],
		properties: {},
		options: {}
	},
	isSuccessStatusCode: False
}