Available Operations

POST /quotes- Create a new quote
GET /quotes- Get quotes
GET /quotes/{id} - Get quote by ID
PATCH /quotes/{id} - Update quote
DELETE /quotes/{id} - Delete quote
GET /quotes/external-id/{externalId} - Get quote by external Id

Data Models & Schemas

Quote Entity

{
  "id": "string",
  "quoteId": "string",
  "metadata": {},
  "author": "string",
  "contractId": "string",
  "bookingIds": [
    "string"
  ],
  "updatedAt": "date-time",
  "organization": "string",
  "createdAt": "date-time",
  "clientId": "string",
  "externalId": "string",
  "startDate": "date-time",
  "endDate": "date-time",
  "date": "date",
  "deadline": "date",
  "amount": "number",
  "mediaId": "string",
  "mediaName": "string",
  "status": "enum",
  "isExpired": "boolean",
  "bookingsSnapshot": []
}

Field Descriptions:

id - A unique identifier (UUID) for the record
quoteId - Quote number or identifier from the invoicing system
metadata - A flexible key-value object for storing client-specific information
author - A unique identifier (string) representing the user who created it
contractId - A unique identifier (UUID) for the contract associated with it. Links this to a specific contract for tracking and management purposes
bookingIds - An array of unique identifiers (UUIDs) for the bookings associated with it. Allows linking multiple bookings to a single entity.
updatedAt - Timestamp indicating when entity was last updated, formatted in ISO 8601 standard (UTC)
organization - A unique identifier (string) for the organization that owns this entity
createdAt - Timestamp indicating when the entity was created, formatted in ISO 8601 standard (UTC)
clientId - A unique identifier (UUID) for the client associated with this entity. Required field that links the entity to a specific client
externalId - An optional identifier that connects this entity record to external systems or databases, facilitating integration with other platforms
startDate - Represents the start date of the billing period for this entity. Formatted in ISO 8601 standard (UTC)
endDate - Represents the end date of the billing period for this entity. Formatted in ISO 8601 standard (UTC)
date - The date when the entity was issued, formatted as a date (YYYY-MM-DD)
deadline - The payment deadline date for the entity, formatted as a date (YYYY-MM-DD)
amount - A numerical value representing the total amount of the entity. Maximum value is 100,000,000
mediaId - A unique identifier (UUID) for the associated media file (e.g., PDF of the entity)
mediaName - The name of the associated media file
status - Current status of the entity (See available options here: QuoteStatus)
isExpired - Indicates whether the validity period has ended
bookingsSnapshot - A point-in-time snapshot of the bookings linked to this entity, captured at entity creation ( BookingEntity )

Enum Fields

QuoteStatus:

OPEN
ACCEPTED
REJECTED

Error Response DTO

Standard error response format.

{
  "status": "number",
  "success": "boolean",
  "message": "string",
  "error": "string"
}

Field Descriptions:

status - HTTP status code (400-503)
success - Boolean indicating the operation failed (false)
message - Human-readable error message
error - Error code identifier