AlphaAlpha Docs

Public Estimates

Public estimate endpoints (token-based, no authentication required)

View estimate detail (public, token-based)

GET
/public/estimates/{id}
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

token*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/public/estimates/string?token=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"
}

Accept estimate with signature (public, token-based)

POST
/public/estimates/{id}/accept
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/public/estimates/string/accept" \  -H "Content-Type: application/json" \  -d '{    "signature": "string",    "signedBy": "string",    "token": "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"
}

Download estimate PDF (public, token-based)

GET
/public/estimates/{id}/pdf
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

token*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/public/estimates/string/pdf?token=string"
"string"
{
  "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"
}

Reject estimate (public, token-based)

POST
/public/estimates/{id}/reject
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/public/estimates/string/reject" \  -H "Content-Type: application/json" \  -d '{    "token": "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"
}

Download estimate signature image (public, token-based)

GET
/public/estimates/{id}/signature
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Query Parameters

token*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/public/estimates/string/signature?token=string"
"string"
{
  "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"
}