{ "openapi": "3.1.0", "info": { "title": "TAYO.pro API", "version": "1.0.0", "description": "The TAYO.pro public API. Authenticate with a Bearer key: a `tay_live_*` key operates on your real data, a `tay_test_*` key runs the same authentication and the same request validation and then returns a fixture without touching anything." }, "servers": [ { "url": "https://app.tayo.pro/api/v1", "description": "Production" } ], "tags": [ { "name": "Invoices" }, { "name": "Jobs" }, { "name": "Projects" }, { "name": "Quotes" }, { "name": "Service" }, { "name": "Webhooks" } ], "paths": { "/invoices": { "get": { "operationId": "invoices.list", "summary": "List the company's invoices, newest first", "tags": [ "Invoices" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "updatedSince", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceList" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "The API key is missing, malformed or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The API key may not perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limit or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/invoices/{invoiceId}": { "get": { "operationId": "invoices.get", "summary": "Read one invoice", "tags": [ "Invoices" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^(?!__.*__$)[A-Za-z0-9_-]+$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "The API key is missing, malformed or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The API key may not perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "The resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limit or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/invoices/{invoiceId}/reminders": { "get": { "operationId": "invoices.reminders.list", "summary": "List the payment reminders of one invoice, newest first", "tags": [ "Invoices" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "invoiceId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^(?!__.*__$)[A-Za-z0-9_-]+$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "updatedSince", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceReminderList" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "The API key is missing, malformed or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The API key may not perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "The resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limit or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/jobs": { "get": { "operationId": "jobs.list", "summary": "List the company's jobs, newest first", "tags": [ "Jobs" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "updatedSince", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobList" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "The API key is missing, malformed or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The API key may not perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limit or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/jobs/{jobId}": { "get": { "operationId": "jobs.get", "summary": "Read one job", "tags": [ "Jobs" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^(?!__.*__$)[A-Za-z0-9_-]+$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "The API key is missing, malformed or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The API key may not perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "The resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limit or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/me": { "get": { "operationId": "me", "summary": "Identify the company and mode of the presented API key", "tags": [ "Service" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Me" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "The API key is missing, malformed or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The API key may not perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limit or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/ping": { "get": { "operationId": "ping", "summary": "Check that the API is reachable", "tags": [ "Service" ], "security": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ping" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/projects": { "get": { "operationId": "projects.list", "summary": "List the company's projects, newest first", "tags": [ "Projects" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "updatedSince", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectList" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "The API key is missing, malformed or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The API key may not perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limit or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/projects/{projectId}": { "get": { "operationId": "projects.get", "summary": "Read one project", "tags": [ "Projects" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^(?!__.*__$)[A-Za-z0-9_-]+$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "The API key is missing, malformed or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The API key may not perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "The resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limit or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/quotes": { "get": { "operationId": "quotes.list", "summary": "List the company's quotes, newest first", "tags": [ "Quotes" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1 } }, { "name": "updatedSince", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteList" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "The API key is missing, malformed or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The API key may not perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limit or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/quotes/{quoteId}": { "get": { "operationId": "quotes.get", "summary": "Read one quote", "tags": [ "Quotes" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "quoteId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^(?!__.*__$)[A-Za-z0-9_-]+$" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Quote" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "The API key is missing, malformed or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The API key may not perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "The resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limit or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/test/webhooks/send": { "post": { "operationId": "test.webhooks.send", "summary": "Send a test webhook event to one of your test-mode endpoints", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "endpointId": { "type": "string", "minLength": 1 }, "event": { "type": "string", "enum": [ "projectCreated", "projectUpdated", "projectShared", "projectClientValidationRequested", "projectAccepted", "projectDeclined", "projectCanceled", "projectDone", "projectRated", "projectReminderCreated", "projectReminderUpdated", "projectReminderDeleted", "projectReminderSent", "jobCreated", "jobUpdated", "jobScheduled", "jobRescheduled", "jobDone", "jobNoShow", "jobCanceled", "messageCreated", "quoteCreated", "quoteUpdated", "quoteDeleted", "quoteSent", "quoteAccepted", "quoteDeclined", "invoiceCreated", "invoiceUpdated", "invoiceDeleted", "invoiceSent", "invoiceAccepted", "invoiceDeclined", "invoiceAutoMarkPaidFailed", "invoiceReminderCreated", "invoiceReminderUpdated", "invoiceReminderDeleted", "invoiceReminderSent", "invoiceReminderFailed" ] } }, "required": [ "endpointId", "event" ], "additionalProperties": false } } } }, "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookTestSend" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "The API key is missing, malformed or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The API key may not perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limit or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/usage": { "get": { "operationId": "usage", "summary": "Report the current month's API usage and the limits in force", "tags": [ "Service" ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Usage" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "The API key is missing, malformed or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The API key may not perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limit or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } }, "/webhook-deliveries/{deliveryId}/retry": { "post": { "operationId": "webhookDeliveries.retry", "summary": "Re-queue a webhook delivery, keeping the same event id", "tags": [ "Webhooks" ], "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "deliveryId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200, "pattern": "^[A-Za-z0-9_-]+$" } } ], "responses": { "202": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryRetry" } } } }, "400": { "description": "The request failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "401": { "description": "The API key is missing, malformed or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "403": { "description": "The API key may not perform this action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "404": { "description": "The resource does not exist.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "429": { "description": "Rate limit or quota exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "description": "An unexpected error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Your API key, sent as `Authorization: Bearer tay_live_…`." } }, "schemas": { "Actor": { "description": "Who did something.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "actAs": { "anyOf": [ { "type": "string", "enum": [ "user", "client", "system" ] }, { "type": "null" } ] }, "appType": { "anyOf": [ { "type": "string", "enum": [ "tayo" ] }, { "type": "null" } ] } }, "required": [ "name", "actAs", "appType" ], "additionalProperties": false }, "Address": { "description": "A postal address.", "type": "object", "properties": { "formattedAddress": { "type": [ "string", "null" ] }, "complete": { "type": "boolean" } }, "required": [ "formattedAddress", "complete" ], "additionalProperties": false }, "ApiError": { "description": "The error envelope returned by every failing request.", "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/ApiErrorDetail" } } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false }, "ApiErrorDetail": { "description": "One field-level problem with a request.", "type": "object", "properties": { "field": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "field", "code", "message" ], "additionalProperties": false }, "ClientRef": { "description": "The client a resource belongs to.", "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": [ "string", "null" ] } }, "required": [ "id", "name", "email" ], "additionalProperties": false }, "Contact": { "description": "A person to reach about a project.", "type": "object", "properties": { "type": { "type": "string", "enum": [ "client", "siteManager", "tenant", "other" ] }, "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "mobilePhone": { "type": [ "string", "null" ] }, "privatePhone": { "type": [ "string", "null" ] }, "proPhone": { "type": [ "string", "null" ] } }, "required": [ "type", "name", "email", "mobilePhone", "privatePhone", "proPhone" ], "additionalProperties": false }, "ExternalRef": { "description": "Where a resource comes from in Tayo.", "type": "object", "properties": { "appType": { "type": "string", "enum": [ "tayo" ] }, "extId": { "type": "string" } }, "required": [ "appType", "extId" ], "additionalProperties": false }, "Invoice": { "description": "An invoice sent to a client.", "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "status": { "anyOf": [ { "type": "string", "enum": [ "draft", "sent", "accepted", "rejected", "paidUnverified", "paid" ] }, { "type": "null" } ] }, "refNumber": { "type": [ "string", "null" ] }, "isFinalInvoice": { "type": "boolean" }, "amount": { "type": "number" }, "paymentMethod": { "anyOf": [ { "type": "string", "enum": [ "qrcode", "iban" ] }, { "type": "null" } ] }, "iban": { "type": [ "string", "null" ] }, "fileUrl": { "type": [ "string", "null" ] }, "appendixUrls": { "type": "array", "items": { "type": "string" } }, "clientRef": { "$ref": "#/components/schemas/ClientRef" }, "sentAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "status", "refNumber", "isFinalInvoice", "amount", "paymentMethod", "iban", "fileUrl", "appendixUrls", "clientRef", "sentAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "InvoiceList": { "description": "A page of invoices.", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] } }, "required": [ "data", "hasMore", "nextCursor" ], "additionalProperties": false }, "InvoiceReminder": { "description": "A payment reminder scheduled or sent for an invoice.", "type": "object", "properties": { "id": { "type": "string" }, "invoiceId": { "type": "string" }, "projectId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "sent", "canceled", "failed" ] }, "message": { "type": "string" }, "reminderDate": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "sentAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "invoiceId", "projectId", "status", "message", "reminderDate", "sentAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "InvoiceReminderList": { "description": "A page of an invoice's payment reminders.", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceReminder" } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] } }, "required": [ "data", "hasMore", "nextCursor" ], "additionalProperties": false }, "Job": { "description": "A scheduled visit on a project.", "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "status": { "type": "string", "enum": [ "scheduled", "done", "noShow", "canceled" ] }, "title": { "type": "string" }, "startsAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "endsAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "clientRef": { "$ref": "#/components/schemas/ClientRef" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "status", "title", "startsAt", "endsAt", "clientRef", "createdAt", "updatedAt" ], "additionalProperties": false }, "JobList": { "description": "A page of jobs.", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Job" } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] } }, "required": [ "data", "hasMore", "nextCursor" ], "additionalProperties": false }, "Me": { "description": "The company and mode the presented API key resolves to.", "type": "object", "properties": { "companyId": { "type": "string" }, "mode": { "type": "string", "enum": [ "live", "test" ] } }, "required": [ "companyId", "mode" ], "additionalProperties": false }, "Ping": { "description": "Liveness probe response.", "type": "object", "properties": { "status": { "type": "string", "const": "ok" }, "version": { "type": "string", "const": "v1" } }, "required": [ "status", "version" ], "additionalProperties": false }, "Project": { "description": "A project.", "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": [ "newRequest", "clientValidationRequested", "requestDeclined", "toQuote", "quoted", "quoteDeclined", "toSchedule", "scheduled", "toInvoice", "invoiced", "done", "canceled" ] }, "requestType": { "type": "string", "enum": [ "spontaneousQuote", "spontaneousInvoice", "workOrder", "quoteRequest" ] }, "description": { "type": [ "string", "null" ] }, "clientReference": { "type": [ "string", "null" ] }, "tag": { "type": [ "string", "null" ] }, "clientRef": { "$ref": "#/components/schemas/ClientRef" }, "site": { "anyOf": [ { "$ref": "#/components/schemas/Site" }, { "type": "null" } ] }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "notes": { "type": [ "string", "null" ] }, "digicode": { "type": [ "string", "null" ] }, "keyAvailability": { "type": [ "string", "null" ] }, "generalLocation": { "type": [ "string", "null" ] }, "locations": { "type": "array", "items": { "type": "string" } }, "interventionCanStartFrom": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "deadline": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "requestedDeadline": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "limitForQuote": { "type": [ "number", "null" ] }, "app": { "anyOf": [ { "$ref": "#/components/schemas/ExternalRef" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "status", "requestType", "description", "clientReference", "tag", "clientRef", "site", "contacts", "notes", "digicode", "keyAvailability", "generalLocation", "locations", "interventionCanStartFrom", "deadline", "requestedDeadline", "limitForQuote", "app", "createdAt", "updatedAt" ], "additionalProperties": false }, "ProjectList": { "description": "A page of projects.", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] } }, "required": [ "data", "hasMore", "nextCursor" ], "additionalProperties": false }, "Quote": { "description": "A quote sent to a client.", "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "status": { "anyOf": [ { "type": "string", "enum": [ "draft", "sent", "accepted", "rejected" ] }, { "type": "null" } ] }, "refNumber": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "variants": { "type": "array", "items": { "$ref": "#/components/schemas/QuoteVariant" } }, "acceptedVariantId": { "type": [ "string", "null" ] }, "awardedAmount": { "type": [ "number", "null" ] }, "accepted": { "anyOf": [ { "type": "object", "properties": { "at": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "by": { "anyOf": [ { "$ref": "#/components/schemas/Actor" }, { "type": "null" } ] } }, "required": [ "at", "by" ], "additionalProperties": false }, { "type": "null" } ] }, "fileUrl": { "type": [ "string", "null" ] }, "appendixUrls": { "type": "array", "items": { "type": "string" } }, "clientRef": { "$ref": "#/components/schemas/ClientRef" }, "sentAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, { "type": "null" } ] } }, "required": [ "id", "projectId", "status", "refNumber", "amount", "variants", "acceptedVariantId", "awardedAmount", "accepted", "fileUrl", "appendixUrls", "clientRef", "sentAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "QuoteList": { "description": "A page of quotes.", "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] } }, "required": [ "data", "hasMore", "nextCursor" ], "additionalProperties": false }, "QuoteVariant": { "description": "One pricing option of a quote.", "type": "object", "properties": { "id": { "type": "string" }, "amount": { "type": "number" }, "comment": { "type": [ "string", "null" ] } }, "required": [ "id", "amount", "comment" ], "additionalProperties": false }, "Site": { "description": "Where a project takes place.", "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "clientId": { "type": [ "string", "null" ] }, "type": { "type": "string", "enum": [ "building", "unit" ] }, "address": { "anyOf": [ { "$ref": "#/components/schemas/Address" }, { "type": "null" } ] }, "additionalAddressInfo": { "type": [ "string", "null" ] }, "billingAddress": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "app": { "anyOf": [ { "$ref": "#/components/schemas/ExternalRef" }, { "type": "null" } ] } }, "required": [ "id", "clientId", "type", "address", "additionalAddressInfo", "billingAddress", "notes", "app" ], "additionalProperties": false }, "Usage": { "description": "Current month's API usage for the presented key's mode.", "type": "object", "properties": { "mode": { "type": "string", "enum": [ "live", "test" ] }, "period": { "type": "string" }, "resetAt": { "type": "string" }, "limits": { "type": "object", "properties": { "monthlyRequests": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "burstPerMinute": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "source": { "type": "string", "enum": [ "default", "override" ] } }, "required": [ "monthlyRequests", "burstPerMinute", "source" ], "additionalProperties": false }, "month": { "type": "object", "properties": { "used": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "remaining": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "state": { "type": "string", "enum": [ "within", "overage", "exhausted" ] } }, "required": [ "used", "remaining", "state" ], "additionalProperties": false } }, "required": [ "mode", "period", "resetAt", "limits", "month" ], "additionalProperties": false }, "WebhookDeliveryRetry": { "description": "A webhook delivery that has been re-queued for one more attempt.", "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "const": "pending" }, "attemptCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "manualRetryCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "manualRetriesRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "queuedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": [ "id", "status", "attemptCount", "manualRetryCount", "manualRetriesRemaining", "queuedAt" ], "additionalProperties": false }, "WebhookTestSend": { "description": "A webhook test event that has been queued for delivery.", "type": "object", "properties": { "eventId": { "type": "string" }, "endpointId": { "type": "string" }, "event": { "type": "string", "enum": [ "projectCreated", "projectUpdated", "projectShared", "projectClientValidationRequested", "projectAccepted", "projectDeclined", "projectCanceled", "projectDone", "projectRated", "projectReminderCreated", "projectReminderUpdated", "projectReminderDeleted", "projectReminderSent", "jobCreated", "jobUpdated", "jobScheduled", "jobRescheduled", "jobDone", "jobNoShow", "jobCanceled", "messageCreated", "quoteCreated", "quoteUpdated", "quoteDeleted", "quoteSent", "quoteAccepted", "quoteDeclined", "invoiceCreated", "invoiceUpdated", "invoiceDeleted", "invoiceSent", "invoiceAccepted", "invoiceDeclined", "invoiceAutoMarkPaidFailed", "invoiceReminderCreated", "invoiceReminderUpdated", "invoiceReminderDeleted", "invoiceReminderSent", "invoiceReminderFailed" ] }, "status": { "type": "string", "const": "pending" } }, "required": [ "eventId", "endpointId", "event", "status" ], "additionalProperties": false } } } }