Changes for page ../credit-account

Last modified by David Persson on 2022/08/11 10:52
From version 136.5
edited by David Persson
on 2020/04/21 13:14
To version 136.6
edited by David Persson
on 2020/04/21 13:22
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -518,7 +518,33 @@
518 518  
519 519  ==== List transactions on an account ====
520 520  
521 +You can filter transactions by date in two different ways. Either filtering can be done by date range or by listing transactions by month.
522 +
523 +**Date range example**
524 +
521 521  {{code language="http" title="**Request**"}}
526 +GET /ledger/credit-account/v1/XXX/accounts/NNN/transactions?fromDate=2020-02-10&todate=2020-06-01 HTTP/1.1
527 +Host: -
528 +Authorization: Bearer <Token>
529 +Content-Type: application/json
530 +
531 +
532 +{{/code}}
533 +
534 +**Monthly example**
535 +
536 +{{code language="http" title="**Request**"}}
537 +GET /ledger/credit-account/v1/XXX/accounts/NNN/transactions?month=2020-04 HTTP/1.1
538 +Host: -
539 +Authorization: Bearer <Token>
540 +Content-Type: application/json
541 +
542 +
543 +{{/code}}
544 +
545 +**Standard (default last 30 days) **
546 +
547 +{{code language="http" title="**Request**"}}
522 522  GET /ledger/credit-account/v1/XXX/accounts/NNN/transactions HTTP/1.1
523 523  Host: -
524 524  Authorization: Bearer <Token>
... ... @@ -557,11 +557,7 @@
557 557   "date": "2019-10-09"
558 558   }
559 559   ],
560 - "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/transactions?fromDate=2019-10-01",
561 - "view": {
562 - "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/transactions?fromDate=2019-10-01&$top=2&$skip=0",
563 - "next": "/ledger/credit-account/v1/XXX/accounts/NNN/transactions?fromDate=2019-10-01&$top=2&$skip=2"
564 - }
586 + "@id": "/ledger/credit-account/v1/XXX/accounts/NNN/transactions"
565 565  }
566 566  {{/code}}
567 567  
... ... @@ -575,10 +575,20 @@
575 575  * Payment
576 576  * Purchase
577 577  * Credit
600 +* AdministrationFee
601 +* BillingFee
602 +* CollectionFee
603 +* Deduction
604 +* Disbursement
605 +* DisbursementReturned
606 +* Interest
607 +* LateFee
608 +* ReminderFee
609 +* MigratedBalance// (Amount of the initially migrated balance on the account)//
578 578  )))
579 579  |(% style="width:337px" %)description|(% style="width:205px" %)string|(% style="width:208px" %) |(% style="width:621px" %)Description of the transaction, for purchases it usually includes "point of sale" and "receipt reference"
580 580  |(% style="width:337px" %)amount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:621px" %)
581 -|(% style="width:337px" %)initiatedFromPointOfSale|(% style="width:205px" %)bool|(% style="width:208px" %) |(% style="width:621px" %)
613 +|(% style="width:337px" %)initiatedFromPointOfSale|(% style="width:205px" %)bool|(% style="width:208px" %) |(% style="width:621px" %)Indicates whether the transaction was initiated from point of sale, or else it is a "ledger" transaction that was initiated internally in the ledgersystem.
582 582  |(% style="width:337px" %)date|(% style="width:205px" %)date|(% style="width:208px" %) |(% style="width:621px" %)Date when the transaction was initiated (Authorization date)
583 583  
584 584  == Reservations ==
... ... @@ -747,66 +747,8 @@
747 747  )))
748 748  |(% style="width:337px" %)amount|(% style="width:205px" %)decimal|(% style="width:208px" %) |(% style="width:58px" %) |(% style="width:1176px" %)The amount to debit the owner of the consent
749 749  
750 -=== Problems ===
782 +=== ===
751 751  
752 -If an error occur or any validation failed, a "problem" response will be returned.
753 -Below is a list of problems that can occur:
754 -
755 -**HttpStatus 401 Unauthorized**
756 -
757 -* Token expired
758 -* Token invalid
759 -* SellerNumber does not match token
760 -* CompanyNumber does not match token
761 -
762 -**HttpStatus 400 Error**
763 -
764 -* Validation: Argument required
765 -* Validation: Invalid value
766 -
767 -**HttpStatus 422 Unprocessable entity**
768 -
769 -* Authorization declined
770 -
771 -**HttpStatus 409 Conflict**
772 -
773 -* Invoice already authorized
774 -* Duplicate InvoiceNumber
775 -* Authorization is cancelled
776 -* Authorization already captured
777 -* Authorization has expired
778 -* Insufficient debited amount XXX
779 -
780 -**HttpStatus 501 NotImplemented**
781 -
782 -* CompanyNumber XXX not configured
783 -* SellerNumber XXX not configured at PayEx
784 -
785 -**HttpStatus 404 NotFound**
786 -
787 -* Authorization not found
788 -
789 -Below is an example of a problem that will be returned if buyer##.nationalConsumerIdentifier.value## is not valid in the authorization post request.
790 -
791 -{{code language="http" title="**Response**"}}
792 -HTTP/1.1 400 Error
793 -Content-Type: application/problem+json
794 -
795 -{
796 - "Type": "http://[DNS]/ledger/invoice-purchase/problems/validation",
797 - "Title": "A validation error occurred",
798 - "Status": 400,
799 - "Instance": null,
800 - "Detail": "A validation error occurred. Please fix the problems mentioned in the 'problems' property below.",
801 - "Problems": [
802 - {
803 - "buyer.nationalConsumerIdentifier.value": "Not a valid SE nationalConsumerIdentifier"
804 - }
805 - ]
806 -}
807 -{{/code}}
808 -
809 -
810 810  == Problems ==
811 811  
812 812  All errors from the api are returned in the form of "problems" (response body), except for the http status code itself.