Alpha Portal Finance
Client portal finance endpoints (orders, invoices, estimates)
List client's estimates
AuthorizationBearer <token>
In: header
Query Parameters
pageable*
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/portal/estimates?page=0&size=1&sort=string"{
"content": [
{
"currency": "string",
"estimateDate": "2019-08-24T14:15:22Z",
"estimateNumber": "string",
"id": "string",
"isExpired": true,
"status": "DRAFT",
"totalAmount": 0.1,
"validUntil": "2019-08-24T14:15:22Z"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get estimate detail
AuthorizationBearer <token>
In: header
Path Parameters
estimateId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/portal/estimates/string"{
"canAccept": true,
"canReject": true,
"created": "2019-08-24T14:15:22Z",
"currency": "string",
"estimateDate": "2019-08-24T14:15:22Z",
"estimateNumber": "string",
"id": "string",
"isExpired": true,
"items": [
{
"description": "string",
"quantity": 0.1,
"taxRate": 0.1,
"totalPrice": 0.1,
"type": "string",
"unitPrice": 0.1
}
],
"pdfAvailable": true,
"preferredLanguage": "string",
"rejectionReason": "string",
"signatureBlobId": "string",
"signedAt": "2019-08-24T14:15:22Z",
"signedBy": "string",
"status": "DRAFT",
"totalAmount": 0.1,
"totalAmountExcludingTax": 0.1,
"totalTax": 0.1,
"validUntil": "2019-08-24T14:15:22Z"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}List client's invoices
AuthorizationBearer <token>
In: header
Query Parameters
pageable*
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/portal/invoices?page=0&size=1&sort=string"{
"content": [
{
"currency": "string",
"dueDate": "2019-08-24T14:15:22Z",
"id": "string",
"invoiceDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"paidAmount": 0.1,
"status": "DRAFT",
"totalAmount": 0.1
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get invoice detail
AuthorizationBearer <token>
In: header
Path Parameters
invoiceId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/portal/invoices/string"{
"created": "2019-08-24T14:15:22Z",
"currency": "string",
"dueDate": "2019-08-24T14:15:22Z",
"id": "string",
"invoiceDate": "2019-08-24T14:15:22Z",
"invoiceNumber": "string",
"items": [
{
"description": "string",
"quantity": 0.1,
"taxRate": 0.1,
"totalPrice": 0.1,
"unitPrice": 0.1
}
],
"paidAmount": 0.1,
"pdfAvailable": true,
"status": "DRAFT",
"totalAmount": 0.1,
"totalAmountExcludingTax": 0.1,
"totalTax": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}List client's orders
AuthorizationBearer <token>
In: header
Query Parameters
pageable*
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/portal/orders?page=0&size=1&sort=string"{
"content": [
{
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"itemCount": 0,
"orderDate": "2019-08-24T14:15:22Z",
"paidAmount": 0.1,
"reference": "string",
"status": "DRAFT",
"totalAmount": 0.1
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get order detail
AuthorizationBearer <token>
In: header
Path Parameters
orderId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/portal/orders/string"{
"created": "2019-08-24T14:15:22Z",
"currency": "string",
"deliveryAddress": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"expectedDeliveryDate": "2019-08-24T14:15:22Z",
"id": "string",
"items": [
{
"productId": "string",
"productName": "string",
"quantity": 0.1,
"totalPrice": 0.1,
"unit": "string",
"unitPrice": 0.1
}
],
"orderDate": "2019-08-24T14:15:22Z",
"paidAmount": 0.1,
"paymentPercentage": 0.1,
"reference": "string",
"status": "DRAFT",
"totalAmount": 0.1
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}