| Required role: | Tartarus.Read |
| GET,POST | /api/citi-bank-statement |
|---|
"use strict";
/** @typedef {number} */
export var BankEntryType;
(function (BankEntryType) {
BankEntryType[BankEntryType["Balance"] = 1] = "Balance"
BankEntryType[BankEntryType["Transaction"] = 2] = "Transaction"
})(BankEntryType || (BankEntryType = {}));
export class CitiBankAccountEntry {
/** @param {{entryType?:BankEntryType,description?:string,amount?:number,currencyCode?:string,creditDebitIndicator?:string,entryDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {BankEntryType} */
entryType;
/** @type {?string} */
description;
/** @type {?number} */
amount;
/** @type {?string} */
currencyCode;
/** @type {?string} */
creditDebitIndicator;
/** @type {?string} */
entryDate;
}
export class CitiBankEntriesResponse {
/** @param {{responseStatus?:ResponseStatus,statementIsStillGenerating?:boolean,entries?:CitiBankAccountEntry[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?ResponseStatus} */
responseStatus;
/** @type {boolean} */
statementIsStillGenerating;
/** @type {CitiBankAccountEntry[]} */
entries = [];
}
export class RetrieveCitiBankStatementRequest {
/** @param {{statementId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
statementId;
}
JavaScript RetrieveCitiBankStatementRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/citi-bank-statement HTTP/1.1
Host: tartarus.nephila.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
statementId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
},
statementIsStillGenerating: False,
entries:
[
{
entryType: Balance,
description: String,
amount: 0,
currencyCode: String,
creditDebitIndicator: String,
entryDate: 0001-01-01
}
]
}