paymentcertificates
- gustav.hagstrom
List paymentcertificates
Retrieves a paymentcertificate for a subscription beloninging to the logged in user. If a key of level 3 is used, parameter "personid" should be sent in.
Request
HTTP GET /paymentcertificates
Parameters
Name | Required | Value | Description | Defaultvalues |
|---|---|---|---|---|
periodstartdate | Yes | periodstartdate=2014-01-01 | Start date for period | - |
periodenddate | Yes | periodenddate=2014-12-31 | End date for period | - |
| subscriptionid | Yes | subscriptionid=3 | Subscription id for which a paymentcertificate should be retrieved | - |
| personid | Yes (If a key of level 3 is used). | personid=1 | Id of the payer for the subscription. |
Example:
APIURL/paymentcertificates.xml?periodstartdate=2014-01-01&periodenddate=2014-12-31&subscriptionid=12&personid=12
Response
Tag | Format | Example | Description |
|---|---|---|---|
paymentcertificate |
| <paymentcertificate> | Represents a paymentcertificate |
periodstartdate | Date | <start>2009-01-25</start> | Start date for paymentcertificateperiod |
periodenddate | Date | <end>2009-06-21</end> | End date paymentcertificateperiod |
businessunit |
| <businessunit><id>11</id><name>Center</name></businessunit> | Facility |
| company | <company><id>133</id><name>Company 1</name><orgnumber>90890898-999</orgnumber></company> | Company | |
product |
| <product><id>25</id><name>Training</name></product> | The product the subscription was created from |
person |
| <person><id>1334</id><name>John Doe</name><personnumber>750402-2121</personnumber><customernumber>123456</customernumber></person> | Payerinformation |
payments |
|
| List of payments. Empty if no payments done during paymentcertificateperiod. |
| payment | Payment information. Payment is confirmed either by an invoice or a receipt. | ||
| invoice | <invoice><id>1334</id><number>321321</number></invoice> | Invoice information. | |
| receipt | <receipt><id>1334</id><number>321321</number></receipt> | Receipt information | |
| vatrate | <vatrate>25</vatrate> | Vatrate | |
| duedate | <duedate>2014-01-31</duerate> | Duedate | |
| paymentdate | <paymentdate>2014-01-25</paymentdate> | Payment date | |
| totalamount | <totalamount>1500</totalamount> | Amount payed in cents (ören) |
<paymentcertificate>
<periodstartdate>2014-01-01</periodstartdate>
<periodenddate>2014-12-31</periodenddate>
<businessunit>
<id>12</id>
<name>Center</name>
</businessunit>
<company>
<id>12</id>
<name>Center</name>
<orgnumber>551010-1111</orgnumber>
</company>
<product>
<id>25</id>
<name>Training</name>
</product>
<person>
<id>45</id>
<name>John Doe</name>
<personnumber>750331-2458</name>
<customernumber>750331-2458</name>
</person>
<payments>
<payment>
<invoice>
<id>33</id>
<number>454545<number/>
</invoice>
<receipt>
<id>44</id>
<number>343434<number/>
</receipt>
<vatrate>25</vatrate>
<duedate>2014-01-31</duedate>
<paymentdate>2014-01-26</paymentdate>
<totalamount>17000</totalamount>
</payment>
</payments>
</paymentcertificate>