meta data for this page
  •  

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
api:api_invoices_id [2014/07/12 13:23]
Lauri Elevant created
api:api_invoices_id [2018/11/16 18:03] (current)
Lauri Elevant
Line 15: Line 15:
   Content-Type:​ application/​json   Content-Type:​ application/​json
   Content-Length:​ 1234   Content-Length:​ 1234
 +
 +
 +==== Response example ====
 +
 +  {
 +        "​nr":​ "​TUIT-123/​2014",​
 +        "​applicant":​ "/​api/​applicants/​65",​
 +        "​issued":​ "​2014-07-12T12:​09:​42+00:​00",​
 +        "​delivered":​ "​2014-07-12T12:​09:​57+00:​00",​
 +        "​reminded":​ null,
 +        "​collected":​ null,
 +        "​items":​ [
 +            {
 +                "​item":​ "​Tuition fee",
 +                "​price":​ "​1899",​
 +                "​qty":​ "​1",​
 +                "​unit":​ "​-"​
 +            }
 +        ],
 +        "​collections":​ [
 +            {
 +                "​inserted":​ "​2014-07-12T12:​09:​42+00:​00",​
 +                "​collected":​ "​2014-07-12",​
 +                "​amount":​ "​50.55",​
 +                "​administrator":​ "/​api/​administrators/​123"​
 +            }
 +        ],
 +        "​currency":​ "​EUR",​
 +        "​instructions":​ "​dfgsdfgs dfgs\r\ndfg\r\nsdfg\r\nsd\r\nfgsdfgsdfgsdfg",​
 +        "​smallprint":​ "​Please make sure that you include the invoice number in the payment transaction. Otherwise the payment may not get properly processed.\r\n\r\nThis invoice has been issued electronically and is valid without a signature. The invoice is issued in accordance to the region that you specified during your registration. If the region (and the currency) is not correct, please contact us for re-issuance."​
 +  }
 +
 +
 +===== DELETE =====
 +
 +Delete an invoice.
 +
 +==== Syntax ====
 +
 +  DELETE /​api/​invoices/​123
 +  Host: apply.example.edu
 +  Authorization:​ DREAM apikey="​..."​
 +
 +==== Response headers ====
 +
 +  Content-Type:​ text/plain
 +  Content-Length:​ 0
 +
 +==== Response codes ====
 +
 +| ''​204 No Content''​ | Invoice was successfully deleted |
 +