Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -103,27 +103,27 @@
103	103	**Resource properties**
104	104
105	105	(% class="table-bordered table-striped" %)
106		-|=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 161px;" %)Format|=(% style="width: 112px;" %)Modify (patch)|=(% style="width: 1039px;" %)Description
107		-|(% style="width:215px" %)@id |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: |(% style="width:112px" %) |(% style="width:1039px" %)Uri of the specific account
108		-|(% style="width:215px" %)accountNo |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:112px" %) |(% style="width:1039px" %)The identifier of the account
109		-|(% style="width:215px" %)startDate |(% style="width:114px" %)date|(% style="width:161px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:112px" %) |(% style="width:1039px" %)Date when the account was started
110		-|(% style="width:215px" %)description |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 200|(% style="width:112px" %) |(% style="width:1039px" %)A description of the type of account
111		-|(% style="width:215px" %)accountProfileType |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:112px" %) |(% style="width:1039px" %)The defined code of the accounttype, //Examples: kontodebet, kontokredit, kontofaktura//
112		-|(% style="width:215px" %)accountAlias |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:112px" %) |(% style="width:1039px" %)A descriptive name for the account type, //Examples: kontokredit1, matkonto1//
113		-|(% style="width:215px" %)customerNo |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:112px" %) |(% style="width:1039px" %)Identifier of the customer (account owner)
114		-|(% style="width:215px" %)status |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 25|(% style="width:112px" %) |(% style="width:1039px" %)Status of the account(((
	106	+|=(% style="width: 215px;" %)Property|=(% style="width: 114px;" %)Data type|=(% style="width: 161px;" %)Format|=(% style="width: 61px;" %)Modify (patch)|=(% style="width: 877px;" %)Description
	107	+|(% style="width:215px" %)@id |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: |(% style="width:61px" %) |(% style="width:877px" %)Uri of the specific account
	108	+|(% style="width:215px" %)accountNo |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:61px" %) |(% style="width:877px" %)The identifier of the account
	109	+|(% style="width:215px" %)startDate |(% style="width:114px" %)date|(% style="width:161px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:61px" %) |(% style="width:877px" %)Date when the account was started
	110	+|(% style="width:215px" %)description |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 200|(% style="width:61px" %) |(% style="width:877px" %)A description of the type of account
	111	+|(% style="width:215px" %)accountProfileType |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:61px" %) |(% style="width:877px" %)The defined code of the accounttype, //Examples: kontodebet, kontokredit, kontofaktura//
	112	+|(% style="width:215px" %)accountAlias |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:61px" %) |(% style="width:877px" %)A descriptive name for the account type, //Examples: kontokredit1, matkonto1//
	113	+|(% style="width:215px" %)customerNo |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 50|(% style="width:61px" %) |(% style="width:877px" %)Identifier of the customer (account owner)
	114	+|(% style="width:215px" %)status |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 25|(% style="width:61px" %) |(% style="width:877px" %)Status of the account(((
115	115	* **pending-close**: the customer has requested the account to be closed, the account will be closed when possible.
116	116	* **open**: the account is open and active
117	117	* **closed**: the account has been closed
118	118	)))
119		-|(% style="width:215px" %)creditLimit |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="background-color:palegreen; width:112px" %) |(% style="width:1039px" %)The creditlimit of the account, support patch operation but only lower
120		-|(% style="width:215px" %)totalBalance|(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:112px" %) |(% style="width:1039px" %)Total current sum of all balances (including capital / interest / fees, etc.)
121		-|(% style="width:215px" %)reservedAmount |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:112px" %) |(% style="width:1039px" %)Sum of all outstanding reservations (which are valid and not captured)
122		-|(% style="width:215px" %)availableAmount |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:112px" %) |(% style="width:1039px" %)Available credit (cannot be calculated from the above amounts as fees can be included there, which does not affect available credit)
123		-|(% style="width:215px" %)openBill.amountToPay |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:112px" %) |(% style="width:1039px" %)The minimum amount to pay on the currently open bill
124		-|(% style="width:215px" %)openBill.bill |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:112px" %) |(% style="width:1039px" %)
125		-|(% style="width:215px" %)openBill.dueDate |(% style="width:114px" %)date|(% style="width:161px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:112px" %) |(% style="width:1039px" %)
126		-|(% style="width:215px" %)openBill.billType |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 25|(% style="width:112px" %) |(% style="width:1039px" %)(((
	119	+|(% style="width:215px" %)creditLimit |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="background-color:palegreen; width:61px" %) |(% style="width:877px" %)The creditlimit of the account, support patch operation but only lower
	120	+|(% style="width:215px" %)totalBalance|(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Total current sum of all balances (including capital / interest / fees, etc.)
	121	+|(% style="width:215px" %)reservedAmount |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Sum of all outstanding reservations (which are valid and not captured)
	122	+|(% style="width:215px" %)availableAmount |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)Available credit (cannot be calculated from the above amounts as fees can be included there, which does not affect available credit)
	123	+|(% style="width:215px" %)openBill.amountToPay |(% style="width:114px" %)decimal|(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)The minimum amount to pay on the currently open bill
	124	+|(% style="width:215px" %)openBill.bill |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
	125	+|(% style="width:215px" %)openBill.dueDate |(% style="width:114px" %)date|(% style="width:161px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:61px" %) |(% style="width:877px" %)
	126	+|(% style="width:215px" %)openBill.billType |(% style="width:114px" %)string|(% style="width:161px" %)Maxlength: 25|(% style="width:61px" %) |(% style="width:877px" %)(((
127	127	BillTypes:
128	128
129	129	* Bill
...	...	@@ -131,18 +131,27 @@
131	131	* Reminder2
132	132	* Collection
133	133	)))
134		-|(% style="width:215px" %)charityDonation |(% style="width:114px" %)bool|(% style="width:161px" %) |(% style="background-color:palegreen; width:112px" %) |(% style="width:1039px" %)If donations should be made from the account
135		-|(% style="width:215px" %)interestRate.debtInterest|(% style="width:114px" %)decimal|(% style="width:161px" %)Percentage|(% style="width:112px" %) |(% style="width:1039px" %)yearly debt interestrate
136		-|(% style="width:215px" %)interestRate.penaltyInterest|(% style="width:114px" %)decimal|(% style="width:161px" %)Percentage|(% style="width:112px" %) |(% style="width:1039px" %)yearly penalty interestrate
137		-|(% style="width:215px" %)offer |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:112px" %) |(% style="width:1039px" %)
138		-|(% style="width:215px" %)recurringPaymentConsent|(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:112px" %) |(% style="width:1039px" %)
139		-|(% style="width:215px" %)cards |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:112px" %) |(% style="width:1039px" %)
140		-|(% style="width:215px" %)transactions |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:112px" %) |(% style="width:1039px" %)
141		-|(% style="width:215px" %)currency |(% style="width:114px" %)string|(% style="width:161px" %)[[ISO 4217>>https://sv.wikipedia.org/wiki/ISO_4217]]|(% style="width:112px" %) |(% style="width:1039px" %)
142		-|(% style="width:215px" %)bills |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:112px" %) |(% style="width:1039px" %)
143		-|(% style="width:215px" %)customer |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:112px" %) |(% style="width:1039px" %)
144		-|(% style="width:215px" %)activePaymentOrder|(% style="width:114px" %) |(% style="width:161px" %) |(% style="width:112px" %) |(% style="width:1039px" %)
	134	+|(% style="width:215px" %)charityDonation |(% style="width:114px" %)bool|(% style="width:161px" %) |(% style="background-color:palegreen; width:61px" %) |(% style="width:877px" %)If donations should be made from the account
	135	+|(% style="width:215px" %)interestRate.debtInterest|(% style="width:114px" %)decimal|(% style="width:161px" %)Percentage|(% style="width:61px" %) |(% style="width:877px" %)yearly debt interestrate
	136	+|(% style="width:215px" %)interestRate.penaltyInterest|(% style="width:114px" %)decimal|(% style="width:161px" %)Percentage|(% style="width:61px" %) |(% style="width:877px" %)yearly penalty interestrate
	137	+|(% style="width:215px" %)offer |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
	138	+|(% style="width:215px" %)recurringPaymentConsent|(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
	139	+|(% style="width:215px" %)cards |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
	140	+|(% style="width:215px" %)transactions |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
	141	+|(% style="width:215px" %)currency |(% style="width:114px" %)string|(% style="width:161px" %)[[ISO 4217>>https://sv.wikipedia.org/wiki/ISO_4217]]|(% style="width:61px" %) |(% style="width:877px" %)
	142	+|(% style="width:215px" %)bills |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
	143	+|(% style="width:215px" %)customer |(% style="width:114px" %)string|(% style="width:161px" %)Uri|(% style="width:61px" %) |(% style="width:877px" %)
	144	+|(% style="width:337px" %)activePaymentOrder.paymentMethod|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 15|(% style="width:61px" %)(((
	145	+
	146	+)))|(% style="width:877px" %)(((
	147	+PaymentTypes:
145	145
	149	+* AUTOGIRO
	150	+)))
	151	+|(% style="width:337px" %)activePaymentOrder.executionDate|(% style="width:205px" %)date|(% style="width:208px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:61px" %) |(% style="width:877px" %)Date when the paymentorder will be executed (when end-customer will be debited)
	152	+|(% style="width:337px" %)activePaymentOrder.amount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:61px" %) |(% style="width:877px" %)Amount that will be charged, this amount may be adjusted when the payment order is executed, if the "amount to pay" on the bill has decreased
	153	+|(% style="width:215px" %) |(% style="width:114px" %) |(% style="width:161px" %) |(% style="width:61px" %) |(% style="width:877px" %)
	154	+
146	146	=== Bills ===
147	147
148	148	The bills resources contains all the documents produced in the accounts billing cycle.
...	...	@@ -165,10 +165,49 @@
165	165	Content-Type: application/json
166	166
167	167	{
168		- "bills" : [
169		- { "billDate" : "2018-09-01", "status" : "open", "billAmount" : 374.10, "@id" : "/ledger/credit-account/v1/501/accounts/123456/bills/963" },
170		- { "billDate" : "2018-08-01", "status" : "closed", "billAmount" : 374.10, "@id" : "/ledger/credit-account/v1/501/accounts/123456/bills/852" },
171		- { "billDate" : "2018-07-01", "status" : "closed", "billAmount" : 374.10, "@id" : "/ledger/credit-account/v1/501/accounts/123456/bills/741" }
	177	+ "@id": "/ledger/credit-account/v1/501/accounts/123456/bills?status=open",
	178	+ "items" : [
	179	+ {
	180	+ "@id": "/ledger/credit-account/v1/501/accounts/123456/bills/reminder-123645",
	181	+ "dueDate": "2018-12-05",
	182	+ "billDate": "2018-11-15",
	183	+ "billNo": "124645",
	184	+ "billAmount": 240.00,
	185	+ "billType" : "reminder",
	186	+ "status": "open",
	187	+ "activePaymentDetails": {
	188	+ "minimumAmountToBePayed": 240.00,
	189	+ "bankAccountNo": "123",
	190	+ "bankAccountType": "BGSE",
	191	+ "bic": "123456",
	192	+ "iban": "SE12345678945631",
	193	+ "paymentReference": "5465164654663",
	194	+ "paymentOrdersExists": true,
	195	+ },
	196	+ "document": "/ledger/credit-account/v1/501/accounts/123456/bills/reminder-124645/document"
	197	+ },
	198	+ {
	199	+ "@id": "/ledger/credit-account/v1/501/accounts/123456/bills/reminder-123645",
	200	+ "dueDate": "2018-12-05",
	201	+ "billDate": "2018-11-15",
	202	+ "billNo": "124645",
	203	+ "billAmount": 240.00,
	204	+ "billType" : "bill",
	205	+ "status": "closed",
	206	+ "activePaymentDetails": null,
	207	+ "document": "/ledger/credit-account/v1/501/accounts/123456/bills/reminder-124645/document"
	208	+ },
	209	+ {
	210	+ "@id": "/ledger/credit-account/v1/501/accounts/123456/bills/bill-123645",
	211	+ "dueDate": "2018-12-05",
	212	+ "billDate": "2018-11-15",
	213	+ "billNo": "124645",
	214	+ "billAmount": 240.00,
	215	+ "billType" : "bill",
	216	+ "status": "closed",
	217	+ "activePaymentDetails": null,
	218	+ "document": "/ledger/credit-account/v1/501/accounts/123456/bills/reminder-124645/document"
	219	+ }
172	172	]
173	173	}
174	174	{{/code}}
...	...	@@ -192,21 +192,23 @@
192	192	Content-Type: application/json
193	193
194	194	{
195		- "@id": "/ledger/credit-account/v1/501/accounts/123456/bills/124645",
	243	+ "@id": "/ledger/credit-account/v1/501/accounts/123456/bills/reminder-123645",
196	196	"dueDate": "2018-12-05",
	245	+ "billDate": "2018-11-15",
197	197	"billNo": "124645",
198		- "billAmount": 240.00,
199		- "minimumAmountToBePayed": 240.00,
200		- "billType" : "Bill",
201		- "bankPayment": {
	247	+ "billAmount": 240.00,
	248	+ "billType" : "reminder",
	249	+ "status": "open",
	250	+ "activePaymentDetails": {
	251	+ "minimumAmountToBePayed": 240.00,
202	202	"bankAccountNo": "123",
203	203	"bankAccountType": "BGSE",
204	204	"bic": "123456",
205	205	"iban": "SE12345678945631",
206		- "paymentReference": "5465164654663"
207		- },
208		- "activePaymentOrder": "/ledger/credit-account/v1/501/accounts/123456/payment-order",
209		- "pdf": "/ledger/credit-account/v1/501/accounts/123456/bills/963/pdf"
	256	+ "paymentReference": "5465164654663",
	257	+ "paymentOrdersExists": true,
	258	+ },
	259	+ "document": "/ledger/credit-account/v1/501/accounts/123456/bills/reminder-124645/document"
210	210	}
211	211	{{/code}}
212	212
...	...	@@ -216,9 +216,9 @@
216	216	|=(% style="width: 337px;" %)Property|=(% style="width: 205px;" %)Data type|=(% style="width: 208px;" %)Format|=(% style="width: 621px;" %)Description
217	217	|(% style="width:337px" %)@id|(% style="width:205px" %)string|(% style="width:208px" %)Uri|(% style="width:621px" %)
218	218	|(% style="width:337px" %)dueDate|(% style="width:205px" %)date|(% style="width:208px" %)[[ISO 8601>>url:http://en.wikipedia.org/wiki/ISO_8601||rel="noreferrer" title="ISO8601 on Wikipedia"]]|(% style="width:621px" %)
	269	+|(% style="width:337px" %)billDate|(% style="width:205px" %)date|(% style="width:208px" %) |(% style="width:621px" %)
219	219	|(% style="width:337px" %)billNo|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 50|(% style="width:621px" %)The identifier of the bill
220	220	|(% style="width:337px" %)billAmount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %)the amount that is stated on the actual bill/document
221		-|(% style="width:337px" %)minimumAmountToBePayed|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %)currently the minimum amount to pay on the bill
222	222	|(% style="width:337px" %)billType|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 25|(% style="width:621px" %)(((
223	223	BillTypes:
224	224
...	...	@@ -227,16 +227,20 @@
227	227	* Reminder2
228	228	* Collection
229	229	)))
230		-|(% style="width:337px" %)bankPayment.bankAccountNo|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 15|(% style="width:621px" %)
231		-|(% style="width:337px" %)bankPayment.bankAccountType|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 10|(% style="width:621px" %)BankAccountTypes:(((
	280	+|(% style="width:337px" %)status|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)"open" / "closed"
	281	+|(% style="width:337px" %)activePaymentDetails|(% style="width:205px" %)object|(% style="width:208px" %) |(% style="width:621px" %)only set if status of bill is "open"
	282	+|(% style="width:337px" %)activePaymentDetails.minimumAmountToBePayed|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %)
	283	+|(% style="width:337px" %)activePaymentDetails.bankAccountNo|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 15|(% style="width:621px" %)
	284	+|(% style="width:337px" %)activePaymentDetails.bankAccountType|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 10|(% style="width:621px" %)BankAccountTypes:(((
232	232	* BKSE (swedish bankaccount)
233	233	* PKSE (swedish plusgiro)
234	234	* BGSE (swedish bankgiro)
235	235	* PGSE (swedish plusgiro OCR)
236	236	)))
237		-|(% style="width:337px" %)bankPayment.bic|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 11|(% style="width:621px" %)
238		-|(% style="width:337px" %)bankPayment.iban|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 34|(% style="width:621px" %)
239		-|(% style="width:337px" %)bankPayment.paymentReference|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 50|(% style="width:621px" %)
	290	+|(% style="width:337px" %)activePaymentDetails.bic|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 11|(% style="width:621px" %)
	291	+|(% style="width:337px" %)activePaymentDetails.iban|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 34|(% style="width:621px" %)
	292	+|(% style="width:337px" %)activePaymentDetails.paymentReference|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 50|(% style="width:621px" %)
	293	+|(% style="width:337px" %)activePaymentDetails.paymentOrdersExists|(% style="width:205px" %)bool|(% style="width:208px" %) |(% style="width:621px" %)
240	240	|(% style="width:337px" %)activePaymentOrder.paymentMethod|(% style="width:205px" %)string|(% style="width:208px" %)Maxlength: 15|(% style="width:621px" %)(((
241	241	PaymentTypes:
242	242