{"contractVersion":"ttyinv-agent/v1","$id":"https://app.ttyinv.com/api/v1/invoices/schema","title":"ttyinv agent transport contract","description":"Authoritative success input and output schemas shared by the ttyinv REST API and MCP tools.","operations":{"create":{"rest":{"method":"POST","path":"/api/v1/invoices"},"mcp":{"tool":"create_invoice"},"input":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"invoice":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":80},"title":{"default":"Invoice","type":"string","minLength":1,"maxLength":200},"issued":{"allOf":[{"type":"string","format":"date","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])))$"},{"type":"string","pattern":"^(?!0000-)"}]},"due":{"allOf":[{"type":"string","format":"date","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])))$"},{"type":"string","pattern":"^(?!0000-)"}]},"terms":{"type":"string","maxLength":200},"currency":{"type":"string"},"locale":{"default":"en-GB","type":"string","maxLength":35},"kind":{"default":"standard","type":"string","enum":["standard","gst"]}},"required":["number","title","issued","currency","locale","kind"],"additionalProperties":false},"from":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"address":{"default":[],"maxItems":10,"type":"array","items":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"}]}},"identifiers":{"default":{},"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":60},"additionalProperties":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"}]}},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"website":{"type":"string","maxLength":500,"format":"uri"},"logo":{"type":"string","minLength":1,"maxLength":500}},"required":["name","address","identifiers"],"additionalProperties":false},"to":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"address":{"default":[],"maxItems":10,"type":"array","items":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"}]}},"identifiers":{"default":{},"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":60},"additionalProperties":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"}]}},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"website":{"type":"string","maxLength":500,"format":"uri"},"logo":{"type":"string","minLength":1,"maxLength":500}},"required":["name","address","identifiers"],"additionalProperties":false},"payment":{"type":"object","properties":{"title":{"default":"Payment Methods","type":"string","minLength":1,"maxLength":120},"methods":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"fields":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":60},"additionalProperties":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"}]}}},"required":["title","fields"],"additionalProperties":false}},"pageBreakBefore":{"type":"boolean"}},"required":["title","methods"],"additionalProperties":false},"settlements":{"default":[],"maxItems":100,"type":"array","items":{"type":"object","properties":{"date":{"allOf":[{"type":"string","format":"date","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])))$"},{"type":"string","pattern":"^(?!0000-)"}]},"paid":{"type":"object","properties":{"amount":{"anyOf":[{"type":"string","pattern":"^(?:0|[1-9]\\d*)(?:\\.\\d{1,4})?$"},{"type":"number","minimum":0,"maximum":1000000000}]},"currency":{"type":"string"}},"required":["amount","currency"],"additionalProperties":false},"received":{"type":"object","properties":{"amount":{"anyOf":[{"type":"string","pattern":"^(?:0|[1-9]\\d*)(?:\\.\\d{1,4})?$"},{"type":"number","minimum":0,"maximum":1000000000}]},"currency":{"type":"string"}},"required":["amount","currency"],"additionalProperties":false}},"required":["date","paid"],"additionalProperties":false}},"signature":{"type":"object","properties":{"image":{"type":"string","minLength":1,"maxLength":500},"name":{"type":"string","maxLength":200},"label":{"type":"string","maxLength":200}},"additionalProperties":false},"appearance":{"type":"object","properties":{"density":{"type":"string","enum":["comfortable","compact"]},"paper":{"type":"string","minLength":1,"maxLength":100},"ink":{"type":"string","minLength":1,"maxLength":100},"muted":{"type":"string","minLength":1,"maxLength":100},"rule":{"type":"string","minLength":1,"maxLength":100},"accent":{"type":"string","minLength":1,"maxLength":100},"font":{"type":"object","properties":{"family":{"type":"string","minLength":1,"maxLength":100},"regular":{"type":"string","minLength":1,"maxLength":500},"bold":{"type":"string","minLength":1,"maxLength":500}},"additionalProperties":false}},"additionalProperties":false},"sections":{"minItems":1,"maxItems":50,"type":"array","items":{"anyOf":[{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"pageBreakBefore":{"type":"boolean"},"summaryOnly":{"type":"boolean"},"table":{"type":"object","properties":{"headers":{"minItems":2,"maxItems":12,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"align":{"type":"string","enum":["left","center","right"]}},"required":["label"],"additionalProperties":false}},"rows":{"minItems":1,"maxItems":500,"type":"array","items":{"minItems":2,"maxItems":12,"type":"array","items":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"}]}}}},"required":["headers","rows"],"additionalProperties":false}},"required":["title","table"],"additionalProperties":false},{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"pageBreakBefore":{"type":"boolean"},"summaryOnly":{"type":"boolean"},"prose":{"type":"string","minLength":1,"maxLength":10000}},"required":["title","prose"],"additionalProperties":false}]}}},"required":["invoice","from","to","settlements","sections"],"additionalProperties":false,"$id":"https://app.ttyinv.com/api/v1/invoices/schema#/create-input","title":"ttyinv create input"},"output":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"source":{"type":"string"},"document":{"type":"object","properties":{"schema":{"type":"string","const":"ttyinv/v1"},"invoice":{"type":"object","properties":{"number":{"type":"string","minLength":1,"maxLength":80},"title":{"default":"Invoice","type":"string","minLength":1,"maxLength":200},"issued":{"allOf":[{"type":"string","format":"date","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])))$"},{"type":"string","pattern":"^(?!0000-)"}]},"due":{"allOf":[{"type":"string","format":"date","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])))$"},{"type":"string","pattern":"^(?!0000-)"}]},"terms":{"type":"string","maxLength":200},"currency":{"type":"string"},"locale":{"default":"en-GB","type":"string","maxLength":35},"kind":{"default":"standard","type":"string","enum":["standard","gst"]}},"required":["number","title","issued","currency","locale","kind"],"additionalProperties":false},"from":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"address":{"default":[],"maxItems":10,"type":"array","items":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"}]}},"identifiers":{"default":{},"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":60},"additionalProperties":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"}]}},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"website":{"type":"string","maxLength":500,"format":"uri"},"logo":{"type":"string","minLength":1,"maxLength":500}},"required":["name","address","identifiers"],"additionalProperties":false},"to":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"address":{"default":[],"maxItems":10,"type":"array","items":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"}]}},"identifiers":{"default":{},"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":60},"additionalProperties":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"}]}},"email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"website":{"type":"string","maxLength":500,"format":"uri"},"logo":{"type":"string","minLength":1,"maxLength":500}},"required":["name","address","identifiers"],"additionalProperties":false},"payment":{"type":"object","properties":{"title":{"default":"Payment Methods","type":"string","minLength":1,"maxLength":120},"methods":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":200},"fields":{"type":"object","propertyNames":{"type":"string","minLength":1,"maxLength":60},"additionalProperties":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"}]}}},"required":["title","fields"],"additionalProperties":false}},"pageBreakBefore":{"type":"boolean"}},"required":["title","methods"],"additionalProperties":false},"settlements":{"default":[],"maxItems":100,"type":"array","items":{"type":"object","properties":{"date":{"allOf":[{"type":"string","format":"date","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])))$"},{"type":"string","pattern":"^(?!0000-)"}]},"paid":{"type":"object","properties":{"amount":{"anyOf":[{"type":"string","pattern":"^(?:0|[1-9]\\d*)(?:\\.\\d{1,4})?$"},{"type":"number","minimum":0,"maximum":1000000000}]},"currency":{"type":"string"}},"required":["amount","currency"],"additionalProperties":false},"received":{"type":"object","properties":{"amount":{"anyOf":[{"type":"string","pattern":"^(?:0|[1-9]\\d*)(?:\\.\\d{1,4})?$"},{"type":"number","minimum":0,"maximum":1000000000}]},"currency":{"type":"string"}},"required":["amount","currency"],"additionalProperties":false}},"required":["date","paid"],"additionalProperties":false}},"signature":{"type":"object","properties":{"image":{"type":"string","minLength":1,"maxLength":500},"name":{"type":"string","maxLength":200},"label":{"type":"string","maxLength":200}},"additionalProperties":false},"appearance":{"type":"object","properties":{"density":{"type":"string","enum":["comfortable","compact"]},"paper":{"type":"string","minLength":1,"maxLength":100},"ink":{"type":"string","minLength":1,"maxLength":100},"muted":{"type":"string","minLength":1,"maxLength":100},"rule":{"type":"string","minLength":1,"maxLength":100},"accent":{"type":"string","minLength":1,"maxLength":100},"font":{"type":"object","properties":{"family":{"type":"string","minLength":1,"maxLength":100},"regular":{"type":"string","minLength":1,"maxLength":500},"bold":{"type":"string","minLength":1,"maxLength":500}},"additionalProperties":false}},"additionalProperties":false},"sections":{"minItems":1,"maxItems":50,"type":"array","items":{"anyOf":[{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"pageBreakBefore":{"type":"boolean"},"summaryOnly":{"type":"boolean"},"table":{"type":"object","properties":{"headers":{"minItems":2,"maxItems":12,"type":"array","items":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":120},"align":{"type":"string","enum":["left","center","right"]}},"required":["label"],"additionalProperties":false}},"rows":{"minItems":1,"maxItems":500,"type":"array","items":{"minItems":2,"maxItems":12,"type":"array","items":{"anyOf":[{"type":"string","maxLength":2000},{"type":"number"}]}}}},"required":["headers","rows"],"additionalProperties":false}},"required":["title","table"],"additionalProperties":false},{"type":"object","properties":{"title":{"type":"string","minLength":1,"maxLength":120},"pageBreakBefore":{"type":"boolean"},"summaryOnly":{"type":"boolean"},"prose":{"type":"string","minLength":1,"maxLength":10000}},"required":["title","prose"],"additionalProperties":false}]}}},"required":["schema","invoice","from","to","settlements","sections"],"additionalProperties":false},"summary":{"type":"object","properties":{"number":{"type":"string"},"currency":{"type":"string"},"locale":{"type":"string"},"sectionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"totalCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["number","currency","locale","sectionCount","rowCount","totalCents"],"additionalProperties":false},"warnings":{"type":"array","items":{"type":"string"}}},"required":["source","document","summary","warnings"],"additionalProperties":false,"$id":"https://app.ttyinv.com/api/v1/invoices/schema#/create-output","title":"ttyinv create output"}},"validate":{"rest":{"method":"POST","path":"/api/v1/invoices/validate"},"mcp":{"tool":"validate_invoice"},"input":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"source":{"type":"string","minLength":1,"maxLength":131072}},"required":["source"],"additionalProperties":false,"$id":"https://app.ttyinv.com/api/v1/invoices/schema#/validate-input","title":"ttyinv validate input"},"output":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"valid":{"type":"boolean"},"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"summary":{"type":"object","properties":{"number":{"type":"string"},"currency":{"type":"string"},"locale":{"type":"string"},"sectionCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"rowCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"totalCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["number","currency","locale","sectionCount","rowCount","totalCents"],"additionalProperties":false},"document":{"type":"object","properties":{"frontmatter":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"sections":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"pageBreakBefore":{"type":"boolean"},"summaryOnly":{"type":"boolean"},"prose":{"type":"string"},"headers":{"type":"array","items":{"type":"string"}},"align":{"type":"array","items":{"type":"string","enum":["left","center","right"]}},"rows":{"type":"array","items":{"type":"object","properties":{"cells":{"type":"array","items":{"type":"string"}},"amountCents":{"type":"string","pattern":"^-?\\d+$"},"summary":{"type":"string","enum":["subtotal","total","grand total"]}},"required":["cells"],"additionalProperties":false}},"payableIndex":{"type":"integer","minimum":0,"maximum":9007199254740991},"totalCents":{"type":"string","pattern":"^-?\\d+$"}},"required":["title"],"additionalProperties":false}}},"required":["frontmatter","sections"],"additionalProperties":false}},"required":["valid","errors","warnings"],"additionalProperties":false,"$id":"https://app.ttyinv.com/api/v1/invoices/schema#/validate-output","title":"ttyinv validate output"}},"render":{"rest":{"method":"POST","path":"/api/v1/invoices/render"},"mcp":{"tool":"render_invoice"},"input":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"source":{"type":"string","minLength":1,"maxLength":131072},"format":{"type":"string","enum":["html","pdf","png"]},"theme":{"default":"light","type":"string","enum":["light","dark"]}},"required":["source","format","theme"],"additionalProperties":false,"$id":"https://app.ttyinv.com/api/v1/invoices/schema#/render-input","title":"ttyinv render input"},"output":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"format":{"type":"string","enum":["html","pdf","png"]},"pageCount":{"type":"integer","minimum":1,"maximum":10},"warnings":{"type":"array","items":{"type":"string"}},"files":{"minItems":1,"maxItems":10,"type":"array","items":{"type":"object","properties":{"filename":{"type":"string","pattern":"^invoice(?:-\\d+)?\\.(?:html|pdf|png)$"},"mimeType":{"type":"string","enum":["text/html; charset=utf-8","application/pdf","image/png"]},"bytes":{"type":"integer","minimum":0,"maximum":8388608},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"},"base64":{"type":"string"}},"required":["filename","mimeType","bytes","sha256","base64"],"additionalProperties":false}}},"required":["format","pageCount","warnings","files"],"additionalProperties":false,"$id":"https://app.ttyinv.com/api/v1/invoices/schema#/render-output","title":"ttyinv render output"}}}}