AlphaAlpha Docs
API Reference

Estimates

API calls for estimates

Create a new estimate

POST
/estimates

Authorization

AuthorizationBearer <token>

In: header

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/estimates" \  -H "Content-Type: application/json" \  -d '{    "clientId": "string",    "currency": "string",    "expirationDays": 0,    "rows": [      {        "quantity": 0.1,        "type": "ITEM",        "unitPrice": 0.1      }    ]  }'
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Get estimates by opportunity

GET
/estimates/by-opportunity/{opportunityId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

opportunityId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/estimates/by-opportunity/string"
[
  {
    "accessTokenHash": "string",
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "clientId": "string",
    "contact": {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    },
    "contactEmail": "string",
    "convertedInvoiceId": "string",
    "convertedOrderId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "estimateDate": "2019-08-24T14:15:22Z",
    "estimateNumber": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "expirationDays": 0,
    "id": "string",
    "mailBody": "string",
    "note": "string",
    "opportunityId": "string",
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "rejectionReason": "string",
    "rows": [
      {
        "description": "string",
        "id": "string",
        "productId": "string",
        "quantity": 0.1,
        "taxAmount": 0.1,
        "taxRate": 0.1,
        "total": 0.1,
        "totalWithTax": 0.1,
        "type": "ITEM",
        "unitPrice": 0.1
      }
    ],
    "sentBy": "string",
    "sentMails": [
      "string"
    ],
    "signature": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "signedAt": "2019-08-24T14:15:22Z",
    "signedBy": "string",
    "status": "DRAFT",
    "subsidiaryId": "string",
    "tenantId": "string",
    "totalExcludingTax": 0.1,
    "totalTax": 0.1,
    "totalWithTax": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "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"
}

Count estimates by status

GET
/estimates/count-by-status

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/estimates/count-by-status"
{
  "property1": 0,
  "property2": 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"
}

Download Csv_ Estimate

GET
/estimates/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/estimates/csv-export"
"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"
}

Delete a list of estimates by their IDs

DELETE
/estimates/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/estimates/delete-list"
Empty
{
  "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"
}

Dynamic Search_ Estimate

GET
/estimates/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/estimates/dynamic-search"
{
  "content": [
    {
      "accessTokenHash": "string",
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "clientId": "string",
      "contact": {
        "department": "string",
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "phone": "string"
      },
      "contactEmail": "string",
      "convertedInvoiceId": "string",
      "convertedOrderId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "estimateDate": "2019-08-24T14:15:22Z",
      "estimateNumber": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "expirationDays": 0,
      "id": "string",
      "mailBody": "string",
      "note": "string",
      "opportunityId": "string",
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "rejectionReason": "string",
      "rows": [
        {
          "description": "string",
          "id": "string",
          "productId": "string",
          "quantity": 0.1,
          "taxAmount": 0.1,
          "taxRate": 0.1,
          "total": 0.1,
          "totalWithTax": 0.1,
          "type": "ITEM",
          "unitPrice": 0.1
        }
      ],
      "sentBy": "string",
      "sentMails": [
        "string"
      ],
      "signature": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "signedAt": "2019-08-24T14:15:22Z",
      "signedBy": "string",
      "status": "DRAFT",
      "subsidiaryId": "string",
      "tenantId": "string",
      "totalExcludingTax": 0.1,
      "totalTax": 0.1,
      "totalWithTax": 0.1,
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "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"
}

Dynamic Search Post_ Estimate

POST
/estimates/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

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/estimates/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "accessTokenHash": "string",
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "clientId": "string",
      "contact": {
        "department": "string",
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "phone": "string"
      },
      "contactEmail": "string",
      "convertedInvoiceId": "string",
      "convertedOrderId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "estimateDate": "2019-08-24T14:15:22Z",
      "estimateNumber": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "expirationDays": 0,
      "id": "string",
      "mailBody": "string",
      "note": "string",
      "opportunityId": "string",
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "rejectionReason": "string",
      "rows": [
        {
          "description": "string",
          "id": "string",
          "productId": "string",
          "quantity": 0.1,
          "taxAmount": 0.1,
          "taxRate": 0.1,
          "total": 0.1,
          "totalWithTax": 0.1,
          "type": "ITEM",
          "unitPrice": 0.1
        }
      ],
      "sentBy": "string",
      "sentMails": [
        "string"
      ],
      "signature": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "signedAt": "2019-08-24T14:15:22Z",
      "signedBy": "string",
      "status": "DRAFT",
      "subsidiaryId": "string",
      "tenantId": "string",
      "totalExcludingTax": 0.1,
      "totalTax": 0.1,
      "totalWithTax": 0.1,
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "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"
}

Create a draft estimate

POST
/estimates/empty

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/estimates/empty"
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Find by list of ids in current tenant

GET
/estimates/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/estimates/find?ids=string"
[
  {
    "accessTokenHash": "string",
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "clientId": "string",
    "contact": {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    },
    "contactEmail": "string",
    "convertedInvoiceId": "string",
    "convertedOrderId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "estimateDate": "2019-08-24T14:15:22Z",
    "estimateNumber": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "expirationDays": 0,
    "id": "string",
    "mailBody": "string",
    "note": "string",
    "opportunityId": "string",
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "rejectionReason": "string",
    "rows": [
      {
        "description": "string",
        "id": "string",
        "productId": "string",
        "quantity": 0.1,
        "taxAmount": 0.1,
        "taxRate": 0.1,
        "total": 0.1,
        "totalWithTax": 0.1,
        "type": "ITEM",
        "unitPrice": 0.1
      }
    ],
    "sentBy": "string",
    "sentMails": [
      "string"
    ],
    "signature": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "signedAt": "2019-08-24T14:15:22Z",
    "signedBy": "string",
    "status": "DRAFT",
    "subsidiaryId": "string",
    "tenantId": "string",
    "totalExcludingTax": 0.1,
    "totalTax": 0.1,
    "totalWithTax": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "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"
}

Find all for current tenant

GET
/estimates/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/estimates/find-all"
[
  {
    "accessTokenHash": "string",
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "clientId": "string",
    "contact": {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    },
    "contactEmail": "string",
    "convertedInvoiceId": "string",
    "convertedOrderId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "estimateDate": "2019-08-24T14:15:22Z",
    "estimateNumber": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "expirationDays": 0,
    "id": "string",
    "mailBody": "string",
    "note": "string",
    "opportunityId": "string",
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "rejectionReason": "string",
    "rows": [
      {
        "description": "string",
        "id": "string",
        "productId": "string",
        "quantity": 0.1,
        "taxAmount": 0.1,
        "taxRate": 0.1,
        "total": 0.1,
        "totalWithTax": 0.1,
        "type": "ITEM",
        "unitPrice": 0.1
      }
    ],
    "sentBy": "string",
    "sentMails": [
      "string"
    ],
    "signature": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "signedAt": "2019-08-24T14:15:22Z",
    "signedBy": "string",
    "status": "DRAFT",
    "subsidiaryId": "string",
    "tenantId": "string",
    "totalExcludingTax": 0.1,
    "totalTax": 0.1,
    "totalWithTax": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "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"
}

Find a list of entities by their IDs

GET
/estimates/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/estimates/find-list"
[
  {
    "accessTokenHash": "string",
    "attachments": [
      {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      }
    ],
    "clientId": "string",
    "contact": {
      "department": "string",
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string",
      "phone": "string"
    },
    "contactEmail": "string",
    "convertedInvoiceId": "string",
    "convertedOrderId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "currency": "string",
    "estimateDate": "2019-08-24T14:15:22Z",
    "estimateNumber": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "expirationDays": 0,
    "id": "string",
    "mailBody": "string",
    "note": "string",
    "opportunityId": "string",
    "pdf": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "rejectionReason": "string",
    "rows": [
      {
        "description": "string",
        "id": "string",
        "productId": "string",
        "quantity": 0.1,
        "taxAmount": 0.1,
        "taxRate": 0.1,
        "total": 0.1,
        "totalWithTax": 0.1,
        "type": "ITEM",
        "unitPrice": 0.1
      }
    ],
    "sentBy": "string",
    "sentMails": [
      "string"
    ],
    "signature": {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    },
    "signedAt": "2019-08-24T14:15:22Z",
    "signedBy": "string",
    "status": "DRAFT",
    "subsidiaryId": "string",
    "tenantId": "string",
    "totalExcludingTax": 0.1,
    "totalTax": 0.1,
    "totalWithTax": 0.1,
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "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"
}

Find by id in current tenant

GET
/estimates/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/estimates/find/string"
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Create an estimate from a configuration

POST
/estimates/from-configuration/{configurationId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

configurationId*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/estimates/from-configuration/string"
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/estimates/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/estimates/page"
{
  "content": [
    {
      "accessTokenHash": "string",
      "attachments": [
        {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      ],
      "clientId": "string",
      "contact": {
        "department": "string",
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "phone": "string"
      },
      "contactEmail": "string",
      "convertedInvoiceId": "string",
      "convertedOrderId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "currency": "string",
      "estimateDate": "2019-08-24T14:15:22Z",
      "estimateNumber": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "expirationDays": 0,
      "id": "string",
      "mailBody": "string",
      "note": "string",
      "opportunityId": "string",
      "pdf": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "rejectionReason": "string",
      "rows": [
        {
          "description": "string",
          "id": "string",
          "productId": "string",
          "quantity": 0.1,
          "taxAmount": 0.1,
          "taxRate": 0.1,
          "total": 0.1,
          "totalWithTax": 0.1,
          "type": "ITEM",
          "unitPrice": 0.1
        }
      ],
      "sentBy": "string",
      "sentMails": [
        "string"
      ],
      "signature": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "signedAt": "2019-08-24T14:15:22Z",
      "signedBy": "string",
      "status": "DRAFT",
      "subsidiaryId": "string",
      "tenantId": "string",
      "totalExcludingTax": 0.1,
      "totalTax": 0.1,
      "totalWithTax": 0.1,
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "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 statistics

GET
/estimates/stats

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/estimates/stats"
{
  "countByStatus": {
    "property1": 0,
    "property2": 0
  },
  "totalAccepted": 0.1,
  "totalPending": 0.1,
  "totalRejected": 0.1,
  "totalValue": 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"
}

Delete by id in current tenant

DELETE
/estimates/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/estimates/string"
Empty
{
  "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 an estimate

PATCH
/estimates/{id}/accept

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/estimates/string/accept"
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Delete an attachment from an estimate

DELETE
/estimates/{id}/attachments/{blobId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string
blobId*string

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/estimates/string/attachments/string"
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Add a comment to an entity

POST
/estimates/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/estimates/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Convert an accepted estimate to an invoice

POST
/estimates/{id}/convert-to-invoice

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/estimates/string/convert-to-invoice"
{
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contactEmail": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "datePaid": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "invoiceDate": "2019-08-24T14:15:22Z",
  "invoiceNumber": "string",
  "mailBody": "string",
  "milestoneId": "string",
  "note": "string",
  "opportunityId": "string",
  "overdueNotifiedAt": "2019-08-24T14:15:22Z",
  "paid": 0.1,
  "paidExcludingTax": 0.1,
  "paymentReference": "string",
  "paymentTermDays": 0,
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "recurringAgreement": {
    "autoSend": true,
    "endDate": "2019-08-24T14:15:22Z",
    "intervalDays": 0,
    "intervalMonths": 0,
    "nextInvoiceDate": "2019-08-24T14:15:22Z"
  },
  "reminderBody": "string",
  "reminders": [
    {
      "createdBy": "string",
      "sentOn": "2019-08-24T14:15:22Z"
    }
  ],
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "quantityType": "AMOUNT",
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "salesOrderId": "string",
  "sentMails": [
    "string"
  ],
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "total": 0.1,
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "transactions": [
    {
      "accountId": "string",
      "amount": 0.1,
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "paymentMethod": "CREDIT_CARD",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "type": "MANUAL",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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"
}

Convert an accepted estimate to a sales order

POST
/estimates/{id}/convert-to-order

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/estimates/string/convert-to-order"
{
  "amountOfProducts": 0.1,
  "cachedInvoicePaidAmount": 0.1,
  "cachedInvoicedAmount": 0.1,
  "cancelledProducts": {
    "isNotEmpty": true,
    "products": [
      {
        "productId": "string",
        "quantity": 0.1,
        "unit": "string"
      }
    ]
  },
  "clientId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "deliveryAddress": {
    "city": "string",
    "country": "string",
    "houseNumber": "string",
    "id": "string",
    "latitude": 0.1,
    "longitude": 0.1,
    "postalCode": "string",
    "street": "string"
  },
  "directPaymentAmount": 0.1,
  "directPayments": [
    {
      "amount": 0.1,
      "createdBy": "string",
      "currency": "string",
      "id": "string",
      "note": "string",
      "paymentDate": "2019-08-24T14:15:22Z",
      "paymentMethod": "CREDIT_CARD",
      "receiptAsset": {
        "blobId": "string",
        "created": "2019-08-24T14:15:22Z",
        "extension": "string",
        "fileSize": 0,
        "name": "string",
        "type": "IMAGE"
      },
      "receiptGenerated": true,
      "reference": "string"
    }
  ],
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expectedDeliveryDate": "2019-08-24T14:15:22Z",
  "id": "string",
  "internalCancellationReason": "string",
  "internalReview": {
    "approved": true,
    "by": "string",
    "on": "2019-08-24T14:15:22Z",
    "reason": "string"
  },
  "invoiceIds": [
    "string"
  ],
  "invoicedProducts": [
    {
      "invoiceId": "string",
      "productId": "string",
      "quantityInvoiced": 0.1,
      "unit": "string"
    }
  ],
  "isFullyCancelled": true,
  "isOverdue": true,
  "orderDate": "2019-08-24T14:15:22Z",
  "packages": [
    {
      "dimension": {
        "height": 0.1,
        "length": 0.1,
        "width": 0.1
      },
      "location": {
        "address": {
          "city": "string",
          "country": "string",
          "houseNumber": "string",
          "id": "string",
          "latitude": 0.1,
          "longitude": 0.1,
          "postalCode": "string",
          "street": "string"
        },
        "coordinate": {
          "latitude": -90,
          "longitude": -180
        },
        "name": "string"
      },
      "picklistId": "string",
      "weight": 0.1
    }
  ],
  "paymentAmount": 0.1,
  "paymentMethod": "CREDIT_CARD",
  "paymentPercentage": 0.1,
  "paymentStatus": "UNPAID",
  "paymentTerm": 0,
  "picklistIds": [
    "string"
  ],
  "products": [
    {
      "baseUnitConversion": 0.1,
      "baseUnitQuantity": 0.1,
      "pricePerBaseUnit": 0.1,
      "pricePerUnit": 0.1,
      "productId": "string",
      "quantity": 0.1,
      "totalPrice": 0.1,
      "unit": "string"
    }
  ],
  "reference": "string",
  "reservedProducts": [
    {
      "productId": "string",
      "quantity": 0.1,
      "siteId": "string"
    }
  ],
  "salesValue": 0.1,
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalAmount": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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"
}

Generate a PDF for an estimate (server-side)

POST
/estimates/{id}/generate-pdf

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/estimates/string/generate-pdf"
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}
PATCH
/estimates/{id}/link-opportunity/{opportunityId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string
opportunityId*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/estimates/string/link-opportunity/string"
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Mark an estimate as sent

PATCH
/estimates/{id}/mark-as-sent

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/estimates/string/mark-as-sent"
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Reject an estimate

PATCH
/estimates/{id}/reject

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/estimates/string/reject"
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Add a new row to an estimate

POST
/estimates/{id}/rows

Authorization

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/estimates/string/rows" \  -H "Content-Type: application/json" \  -d '{    "quantity": 0.1,    "type": "ITEM",    "unitPrice": 0.1  }'
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Remove a row from an estimate

DELETE
/estimates/{id}/rows/{rowId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string
rowId*string

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/estimates/string/rows/string"
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Send an estimate via email

POST
/estimates/{id}/send

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

multipart/form-data

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/estimates/string/send" \  -F pdf="string"
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Sign an estimate with signature capture (authenticated)

POST
/estimates/{id}/sign

Authorization

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/estimates/string/sign" \  -H "Content-Type: application/json" \  -d '{    "signature": "string",    "signedBy": "string"  }'
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}
POST
/estimates/{id}/signing-link

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/estimates/string/signing-link"
{
  "property1": "string",
  "property2": "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"
}

Update an existing estimate

PATCH
/estimates/{id}/update

Authorization

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 PATCH "http://localhost:18080/api/v1/estimates/string/update" \  -H "Content-Type: application/json" \  -d '{    "clientId": "string",    "currency": "string",    "expirationDays": 0,    "rows": [      {        "quantity": 0.1,        "type": "ITEM",        "unitPrice": 0.1      }    ]  }'
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Upload attachments to an estimate

POST
/estimates/{id}/upload-attachments

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

multipart/form-data

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/estimates/string/upload-attachments" \  -F files="[\n  \"string\"\n]"
{
  "accessTokenHash": "string",
  "attachments": [
    {
      "blobId": "string",
      "created": "2019-08-24T14:15:22Z",
      "extension": "string",
      "fileSize": 0,
      "name": "string",
      "type": "IMAGE"
    }
  ],
  "clientId": "string",
  "contact": {
    "department": "string",
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string",
    "phone": "string"
  },
  "contactEmail": "string",
  "convertedInvoiceId": "string",
  "convertedOrderId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "currency": "string",
  "estimateDate": "2019-08-24T14:15:22Z",
  "estimateNumber": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "expirationDays": 0,
  "id": "string",
  "mailBody": "string",
  "note": "string",
  "opportunityId": "string",
  "pdf": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "rejectionReason": "string",
  "rows": [
    {
      "description": "string",
      "id": "string",
      "productId": "string",
      "quantity": 0.1,
      "taxAmount": 0.1,
      "taxRate": 0.1,
      "total": 0.1,
      "totalWithTax": 0.1,
      "type": "ITEM",
      "unitPrice": 0.1
    }
  ],
  "sentBy": "string",
  "sentMails": [
    "string"
  ],
  "signature": {
    "blobId": "string",
    "created": "2019-08-24T14:15:22Z",
    "extension": "string",
    "fileSize": 0,
    "name": "string",
    "type": "IMAGE"
  },
  "signedAt": "2019-08-24T14:15:22Z",
  "signedBy": "string",
  "status": "DRAFT",
  "subsidiaryId": "string",
  "tenantId": "string",
  "totalExcludingTax": 0.1,
  "totalTax": 0.1,
  "totalWithTax": 0.1,
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "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"
}

Email Templates

Previous Page

Facade Configurations

Next Page