{
"error": {
"code": "STALE_REVISION",
"message": "The visit changed; read it again before editing",
"request_id": "example-request",
"details": []
}
}
{
"error": {
"code": "STALE_REVISION",
"message": "The visit changed; read it again before editing",
"request_id": "example-request",
"details": []
}
}
Generation time and company timezone. generated_at is not a snapshot or synchronization token.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Breezy FSM API","description":"Build operational and financial reports with the Breezy field service management API.","colors":{"primary":"#0958D9","light":"#4096FF","dark":"#0958D9"},"logo":{"light":"https://mintcdn.com/breezy-fsm/oiZqxfHjJWgR4SxV/logo/breezy-light.svg?fit=max\u0026auto=format\u0026n=oiZqxfHjJWgR4SxV\u0026q=85\u0026s=0d4ab09c4ec7a4400a349d0f2977aab8","dark":"https://mintcdn.com/breezy-fsm/oiZqxfHjJWgR4SxV/logo/breezy-dark.svg?fit=max\u0026auto=format\u0026n=oiZqxfHjJWgR4SxV\u0026q=85\u0026s=4321d61497647cf95bd6a5699e865094"},"favicon":"https://mintcdn.com/breezy-fsm/oiZqxfHjJWgR4SxV/favicon.png?fit=max\u0026auto=format\u0026n=oiZqxfHjJWgR4SxV\u0026q=85\u0026s=b8d4bc0727520f5ee0ddbada48d37ce4","api":{"playground":{"display":"interactive","proxy":false,"credentials":false},"examples":{"defaults":"required","languages":["curl","python","javascript"],"prefill":false}},"appearance":{"default":"system","strict":false},"navbar":{"links":[{"href":"https://getbreezyapp.com","label":"Breezy"}],"primary":{"type":"button","label":"Open FSM","href":"https://dashboard.getbreezyapp.com"}},"seo":{"metatags":{"og:title":"Breezy FSM API","og:description":"Scheduling and operational and financial reporting: resources, pagination, business measures, and examples.","og:type":"website","twitter:card":"summary_large_image"},"indexing":"navigable"},"fonts":{"heading":{"family":"Poppins","weight":600}},"icons":{"library":"lucide"},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"breezy-fsm","hasAudioNarration":false,"actualSubdomain":"breezy-fsm","customDomains":["developers.getbreezyapp.com"],"gitSource":{"type":"github","owner":"breezy-software-inc","repo":"platform","deployBranch":"public-api-docs","contentDirectory":"docs/public-api","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ab55e44a89dca91c2c0530c","collectionId":"ef0d6133-1f75-47c3-a721-8ee620608de6","liveDeploymentHistoryId":"6ab55e44a89dca91c2c0530c","schemaVersion":"v3"},"entitlements":{},"buildId":"6ab55e44a89dca91c2c0530c","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"API reference","count":64},{"language":"default","tag":"Reporting guides","count":11},{"language":"default","tag":"Business measures","count":9},{"language":"default","tag":"Scheduling","count":9},{"language":"default","tag":"Start here","count":6},{"language":"default","tag":"Get started","count":6},{"language":"default","tag":"Reports","count":6},{"language":"default","tag":"Plan your reports","count":2},{"language":"default","tag":"Accounts","count":2},{"language":"default","tag":"BusinessUnits","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/payments/read-one-payment","slug":"/api-reference/payments/read-one-payment","pageMetadata":{"title":"Read one payment","description":"Read only within the company associated with the validated key.","deprecated":null,"version":null,"openapi":"/openapi.json get /payments/{payment_id}","href":"/api-reference/payments/read-one-payment","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Read only within the company associated with the validated key.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"title":"Read one payment","description":"Read only within the company associated with the validated key.","deprecated":null,"version":null,"openapi":"/openapi.json get /payments/{payment_id}","href":"/api-reference/payments/read-one-payment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getPayment","tags":["Payments"],"summary":"Read one payment","description":"Read only within the company associated with the validated key.","security":["f843047b-b2d1-4309-bde1-b18fdbd3faea"],"parameters":["1cc153d8-127a-4fa2-ad49-0b0b820d3ae0"],"responses":{"200":"21661efb-c95b-4788-99f8-17c93426cbbe","400":"832a7af1-8607-4364-a18a-5c6eeee61fda","401":"fafaa74b-d7cd-45cb-91a6-6815ead0dd12","404":"6de70acc-f69c-4905-ba02-123eeeed1b37","405":"45b2f45b-f95c-4217-b301-ea8f571022af","409":"aec8c57f-2bc1-4a2a-a48f-98a098fc490a","413":"23cd474e-dd92-48e4-a3ae-a82efc5d0218","429":"9487e46e-d8b8-4bb5-a9da-64c1b37a3fd9","500":"f17999a6-1034-4548-9369-add272182430"},"method":"get","type":"path","servers":["d4239c0d-e8dd-49f6-b7f4-2b5a3ad6583c"],"path":"/payments/{payment_id}","baseUrlOptions":["https://api.getbreezyapp.com/v1"],"title":"Read one payment","codeSamples":[],"requestExampleLanguages":["bash","python","javascript"],"requiredOnlyExamples":true,"requestExampleType":"generated","responseExampleType":"generated","disableProxy":true},"dependencies":{"parameters":{"1cc153d8-127a-4fa2-ad49-0b0b820d3ae0":{"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"required":true,"name":"payment_id","in":"path"}},"responses":{"21661efb-c95b-4788-99f8-17c93426cbbe":{"description":"Successful read. Clients ignore unrecognized response fields.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"number":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"data.number.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"data.number.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.number","typeLabel":"string | null"},"account":{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.account.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.account.name","typeLabel":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.account","typeLabel":"object"},"status":{"oneOf":[{"type":"string","description":"Null when no status has been recorded; contributes no received amount.","enum":["SUBMITTING","PENDING","PAID","FAILED","CANCELED","PROCESSING",null],"isRequired":true,"uniqueKey":"data.status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Null when no status has been recorded; contributes no received amount.","enum":["SUBMITTING","PENDING","PAID","FAILED","CANCELED","PROCESSING",null],"isRequired":true,"uniqueKey":"data.status.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.status","typeLabel":"enum\u003cstring> | null"},"method":{"type":"string","enum":["CARD","ACH","CASH","CHECK","PAYPAL","VENMO","CASHAPP","OTHER","WISETACK_LOAN"],"isRequired":true,"uniqueKey":"data.method","typeLabel":"enum\u003cstring>"},"amount_cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Integer USD cents; signed where adjustments or balances permit.","isRequired":true,"uniqueKey":"data.amount_cents","typeLabel":"integer"},"currency":{"type":"string","enum":["USD"],"isRequired":true,"uniqueKey":"data.currency","typeLabel":"enum\u003cstring>"},"occurred_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.occurred_at","typeLabel":"string\u003cdate-time>"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"Recorded parent edit time, null when unavailable; payment status and allocation changes may not advance it.","isRequired":true,"uniqueKey":"data.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Recorded parent edit time, null when unavailable; payment status and allocation changes may not advance it.","isRequired":true,"uniqueKey":"data.updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time> | null"},"collected_by":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.collected_by.oneOf.0.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.collected_by.oneOf.0.name","typeLabel":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.collected_by.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["id","name"],"isRequired":true,"uniqueKey":"data.collected_by.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.collected_by","typeLabel":"object | null"},"invoice_allocations":{"type":"array","items":{"type":"object","properties":{"invoice_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"data.invoice_allocations.items.[INDEX].invoice_id","typeLabel":"string\u003cuuid>"},"applied_cents":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Integer USD cents; signed where adjustments or balances permit.","isRequired":true,"uniqueKey":"data.invoice_allocations.items.[INDEX].applied_cents","typeLabel":"integer"}},"required":["invoice_id","applied_cents"],"description":"Identity is (payment ID, invoice_id). Applications need not consume the entire payment.","uniqueKey":"data.invoice_allocations.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"data.invoice_allocations","typeLabel":"object[]"}},"required":["id","number","account","status","method","amount_cents","currency","occurred_at","created_at","updated_at","collected_by","invoice_allocations"],"description":"One payment counted once, even if applied to multiple invoices. Occurrence date supports backdating and is not bank settlement.","isRequired":true,"uniqueKey":"data","typeLabel":"object"},"meta":{"type":"object","properties":{"request_id":{"type":"string","isRequired":true,"uniqueKey":"meta.request_id","typeLabel":"string"},"generated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"meta.generated_at","typeLabel":"string\u003cdate-time>"},"timezone":{"type":"string","isRequired":true,"uniqueKey":"meta.timezone","typeLabel":"string"}},"required":["request_id","generated_at","timezone"],"description":"Generation time and company timezone. generated_at is not a snapshot or synchronization token.","isRequired":true,"uniqueKey":"meta","typeLabel":"object"}},"required":["data","meta"],"uniqueKey":"","typeLabel":"object"},"example":{"data":{"id":"11111111-1111-4111-8111-000000000701","number":"P-1001","account":{"id":"11111111-1111-4111-8111-000000000101","name":"Example Household"},"status":"PAID","method":"CARD","amount_cents":80000,"currency":"USD","occurred_at":"2026-09-02T18:00:00Z","created_at":"2026-09-02T18:00:00Z","updated_at":"2026-09-02T18:00:00Z","collected_by":{"id":"11111111-1111-4111-8111-000000000401","name":"Alex Example"},"invoice_allocations":[{"invoice_id":"11111111-1111-4111-8111-000000000601","applied_cents":50000},{"invoice_id":"11111111-1111-4111-8111-000000000602","applied_cents":30000}]},"meta":{"request_id":"example-request","generated_at":"2026-09-08T19:00:00Z","timezone":"America/Los_Angeles"}},"examples":{"Example":{"title":"Example","value":{"data":{"id":"11111111-1111-4111-8111-000000000701","number":"P-1001","account":{"id":"11111111-1111-4111-8111-000000000101","name":"Example Household"},"status":"PAID","method":"CARD","amount_cents":80000,"currency":"USD","occurred_at":"2026-09-02T18:00:00Z","created_at":"2026-09-02T18:00:00Z","updated_at":"2026-09-02T18:00:00Z","collected_by":{"id":"11111111-1111-4111-8111-000000000401","name":"Alex Example"},"invoice_allocations":[{"invoice_id":"11111111-1111-4111-8111-000000000601","applied_cents":50000},{"invoice_id":"11111111-1111-4111-8111-000000000602","applied_cents":30000}]},"meta":{"request_id":"example-request","generated_at":"2026-09-08T19:00:00Z","timezone":"America/Los_Angeles"}}}},"exampleType":"examples"}},"exampleType":"examples"},"832a7af1-8607-4364-a18a-5c6eeee61fda":{"description":"Malformed input, unknown query parameter, unsupported combination or invalid cursor.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INVALID_REQUEST","message":"end_date must be later than start_date","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_REQUEST","message":"end_date must be later than start_date","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"fafaa74b-d7cd-45cb-91a6-6815ead0dd12":{"description":"Missing, invalid or expired key, or invalid linked identity.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"},"WWW-Authenticate":{"schema":{"type":"string"},"example":"Bearer"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNAUTHENTICATED","message":"A valid API key is required","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHENTICATED","message":"A valid API key is required","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"6de70acc-f69c-4905-ba02-123eeeed1b37":{"description":"Missing resource or resource outside the authenticated company. Same response for both.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"NOT_FOUND","message":"Resource not found","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"Resource not found","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"45b2f45b-f95c-4217-b301-ea8f571022af":{"description":"Unsupported methods return 405. See the operation list for supported scheduling writes.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"},"Allow":{"schema":{"type":"string"},"example":"GET, HEAD, OPTIONS"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"METHOD_NOT_ALLOWED","message":"This resource supports GET","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"METHOD_NOT_ALLOWED","message":"This resource supports GET","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"aec8c57f-2bc1-4a2a-a48f-98a098fc490a":{"description":"Stale revision, idempotency-key reuse with different input, scheduling conflict, or unsupported stored recurrence. Inspect error.code.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"STALE_REVISION","message":"The visit changed; read it again before editing","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"STALE_REVISION","message":"The visit changed; read it again before editing","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"23cd474e-dd92-48e4-a3ae-a82efc5d0218":{"description":"Request body is too large.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INVALID_REQUEST","message":"Request body exceeds 64 KB","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_REQUEST","message":"Request body exceeds 64 KB","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"9487e46e-d8b8-4bb5-a9da-64c1b37a3fd9":{"description":"Company request budget exhausted; retry after the indicated delay.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"},"Retry-After":{"schema":{"type":"integer","minimum":1},"description":"Seconds before retrying.","example":30}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMITED","message":"Request limit exceeded","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMITED","message":"Request limit exceeded","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"},"f17999a6-1034-4548-9369-add272182430":{"description":"Unexpected failure. Share request_id with support; no stack or provider secrets in response.","headers":{"Cache-Control":{"schema":{"type":"string"},"example":"private, no-store"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["INVALID_REQUEST","INVALID_CURSOR","SCHEDULE_TOO_LARGE","INVALID_SCHEDULE_EVENT","SCHEDULE_CONFLICT","STALE_REVISION","IDEMPOTENCY_CONFLICT","UNAUTHENTICATED","NOT_FOUND","METHOD_NOT_ALLOWED","RATE_LIMITED","INTERNAL_ERROR"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"request_id":{"type":"string","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string"},"details":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.items.[INDEX].message","typeLabel":"string"}},"required":["field","message"],"uniqueKey":"error.details.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[]"}},"required":["code","message","request_id","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INTERNAL_ERROR","message":"Unable to complete request","request_id":"example-request","details":[]}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INTERNAL_ERROR","message":"Unable to complete request","request_id":"example-request","details":[]}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"f843047b-b2d1-4309-bde1-b18fdbd3faea":{"apiKey":{"type":"http","scheme":"bearer","description":"Existing Breezy API key. Grants all published reads and scheduling writes in its associated company. No app permission scopes.","scopes":[]}}},"servers":{"d4239c0d-e8dd-49f6-b7f4-2b5a3ad6583c":{"url":"https://api.getbreezyapp.com/v1","description":"Breezy FSM production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Existing Breezy API key. Grants all published reads and scheduling writes in its associated company. No app permission scopes.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Existing Breezy API key. Grants all published reads and scheduling writes in its associated company. No app permission scopes.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"breezy-fsm","siteName":"Breezy FSM API","title":"Breezy FSM API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-24T17:30:52.204Z","originalFileLocation":"api-reference/payments/read-one-payment.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Read only within the company associated with the validated key.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Breezy FSM API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Breezy FSM API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Scheduling and operational and financial reporting: resources, pagination, business measures, and examples.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Breezy FSM API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.getbreezyapp.com/api-reference/payments/read-one-payment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://breezy-fsm.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Read+one+payment\u0026amp;description=Read+only+within+the+company+associated+with+the+validated+key.\u0026amp;theme=eaf35dcff08c044ed1225cc1\u0026amp;signature=0a7b1595dca2100caa0140fbb832a6f3ed7d1443ed24b39f5117b6e2542b201f\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Breezy FSM API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Scheduling and operational and financial reporting: resources, pagination, business measures, and examples.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://breezy-fsm.mintlify.app/_mintlify/api/og/v2?division=Payments\u0026amp;title=Read+one+payment\u0026amp;description=Read+only+within+the+company+associated+with+the+validated+key.\u0026amp;theme=eaf35dcff08c044ed1225cc1\u0026amp;signature=0a7b1595dca2100caa0140fbb832a6f3ed7d1443ed24b39f5117b6e2542b201f\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/breezy-fsm/dnF4NhhH8j4iUnof/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Breezy FSM API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0958D9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.getbreezyapp.com/api-reference/payments/read-one-payment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/payments/read-one-payment.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.getbreezyapp.com/#organization\",\"name\":\"Breezy FSM API\",\"url\":\"https://developers.getbreezyapp.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/breezy-fsm/oiZqxfHjJWgR4SxV/logo/breezy-light.svg?fit=max\u0026auto=format\u0026n=oiZqxfHjJWgR4SxV\u0026q=85\u0026s=0d4ab09c4ec7a4400a349d0f2977aab8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.getbreezyapp.com#website\",\"name\":\"Breezy FSM API\",\"url\":\"https://developers.getbreezyapp.com\",\"publisher\":{\"@id\":\"https://developers.getbreezyapp.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.getbreezyapp.com/api-reference/payments/read-one-payment#webpage\",\"url\":\"https://developers.getbreezyapp.com/api-reference/payments/read-one-payment\",\"name\":\"Read one payment\",\"description\":\"Read only within the company associated with the validated key.\",\"dateModified\":\"2026-09-24T17:30:52.204Z\",\"isPartOf\":{\"@id\":\"https://developers.getbreezyapp.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.getbreezyapp.com/api-reference/payments/read-one-payment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.getbreezyapp.com/api-reference/payments/read-one-payment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Payments\",\"item\":\"https://developers.getbreezyapp.com/api-reference/payments/page-payments-with-their-invoice-allocations\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Read one payment\",\"item\":\"https://developers.getbreezyapp.com/api-reference/payments/read-one-payment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.getbreezyapp.com/api-reference/payments/read-one-payment#apireference\",\"headline\":\"Read one payment\",\"name\":\"Read one payment\",\"description\":\"Read only within the company associated with the validated key.\",\"url\":\"https://developers.getbreezyapp.com/api-reference/payments/read-one-payment\",\"mainEntityOfPage\":{\"@id\":\"https://developers.getbreezyapp.com/api-reference/payments/read-one-payment#webpage\"},\"dateModified\":\"2026-09-24T17:30:52.204Z\",\"publisher\":{\"@id\":\"https://developers.getbreezyapp.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.getbreezyapp.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Breezy FSM API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Breezy FSM API","nav":{"global":null,"tabs":[{"tab":"Start here","pages":[{"title":"Start here","href":"/quickstart"}]},{"tab":"Reporting guides","pages":[{"title":"Reporting guides","href":"/choose-your-data"}]},{"tab":"API reference","groups":[{"group":"Scheduling","pages":[{"title":"Read a complete operational schedule","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule","href":"/api-reference/scheduling/read-a-complete-operational-schedule"},{"title":"Read members, arrival windows and calendar display bounds","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule/settings","href":"/api-reference/scheduling/read-members-arrival-windows-and-calendar-display-bounds"},{"title":"Read one visit with all assignments and its write revision","deprecated":null,"version":null,"openapi":"/openapi.json get /schedule/appointments/{id}","href":"/api-reference/scheduling/read-one-visit-with-all-assignments-and-its-write-revision"},{"title":"Create a visit for an existing job","deprecated":null,"version":null,"openapi":"/openapi.json post /job-appointments","href":"/api-reference/scheduling/create-a-visit-for-an-existing-job"},{"title":"Edit or reschedule a visit and its assignments atomically","deprecated":null,"version":null,"openapi":"/openapi.json patch /job-appointments/{id}","href":"/api-reference/scheduling/edit-or-reschedule-a-visit-and-its-assignments-atomically"},{"title":"Add one technician to a visit","deprecated":null,"version":null,"openapi":"/openapi.json post /job-assignments","href":"/api-reference/scheduling/add-one-technician-to-a-visit"},{"title":"Remove one assignment while retaining the visit","deprecated":null,"version":null,"openapi":"/openapi.json delete /job-assignments/{id}","href":"/api-reference/scheduling/remove-one-assignment-while-retaining-the-visit"},{"title":"Move or reassign one technician without replacing the visit","deprecated":null,"version":null,"openapi":"/openapi.json patch /job-assignments/{id}","href":"/api-reference/scheduling/move-or-reassign-one-technician-without-replacing-the-visit"},{"title":"Cancel a visit and remove its assignments","deprecated":null,"version":null,"openapi":"/openapi.json post /job-appointments/{id}/cancel","href":"/api-reference/scheduling/cancel-a-visit-and-remove-its-assignments"}]},{"group":"Company","pages":[{"title":"Read the company associated with this key","deprecated":null,"version":null,"openapi":"/openapi.json get /company","href":"/api-reference/company/read-the-company-associated-with-this-key"}]},{"group":"Invoices","pages":[{"title":"Page complete invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /invoices","href":"/api-reference/invoices/page-complete-invoices"},{"title":"Read one complete invoice","deprecated":null,"version":null,"openapi":"/openapi.json get /invoices/{invoice_id}","href":"/api-reference/invoices/read-one-complete-invoice"}]},{"group":"Payments","pages":[{"title":"Page payments with their invoice allocations","description":"All statuses by default. Orders by created_at then id ascending. A payment amount is counted once regardless of its invoice allocations.","deprecated":null,"version":null,"openapi":"/openapi.json get /payments","href":"/api-reference/payments/page-payments-with-their-invoice-allocations"},{"title":"Read one payment","deprecated":null,"version":null,"openapi":"/openapi.json get /payments/{payment_id}","href":"/api-reference/payments/read-one-payment"}]},{"group":"Refunds","pages":[{"title":"Page refunds using their own occurrence dates","description":"All statuses by default. Orders by created_at then id ascending. Date filters refer to this refund, even if its payment occurred in an earlier period.","deprecated":null,"version":null,"openapi":"/openapi.json get /refunds","href":"/api-reference/refunds/page-refunds-using-their-own-occurrence-dates"},{"title":"Read one refund","deprecated":null,"version":null,"openapi":"/openapi.json get /refunds/{refund_id}","href":"/api-reference/refunds/read-one-refund"}]},{"group":"Reports","pages":[{"title":"Summarize invoice activity by issue date","deprecated":null,"version":null,"openapi":"/openapi.json get /reports/invoice-activity","href":"/api-reference/reports/summarize-invoice-activity-by-issue-date"},{"title":"Summarize successful payments and refunds","deprecated":null,"version":null,"openapi":"/openapi.json get /reports/collections","href":"/api-reference/reports/summarize-successful-payments-and-refunds"},{"title":"Read current account aging","deprecated":null,"version":null,"openapi":"/openapi.json get /reports/receivables-aging","href":"/api-reference/reports/read-current-account-aging"},{"title":"Summarize recorded job profitability","deprecated":null,"version":null,"openapi":"/openapi.json get /reports/job-profitability","href":"/api-reference/reports/summarize-recorded-job-profitability"},{"title":"Summarize full-job profitability for assigned members","deprecated":null,"version":null,"openapi":"/openapi.json get /reports/technician-participation-profitability","href":"/api-reference/reports/summarize-full-job-profitability-for-assigned-members"},{"title":"Summarize recorded sold and earned credits by member","deprecated":null,"version":null,"openapi":"/openapi.json get /reports/revenue-attribution","href":"/api-reference/reports/summarize-recorded-sold-and-earned-credits-by-member"}]},{"group":"TeamMembers","pages":[{"title":"Page team members","deprecated":null,"version":null,"openapi":"/openapi.json get /team-members","href":"/api-reference/teammembers/page-team-members"},{"title":"Read one team member","deprecated":null,"version":null,"openapi":"/openapi.json get /team-members/{id}","href":"/api-reference/teammembers/read-one-team-member"}]},{"group":"Accounts","pages":[{"title":"Page accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts","href":"/api-reference/accounts/page-accounts"},{"title":"Read one account","deprecated":null,"version":null,"openapi":"/openapi.json get /accounts/{id}","href":"/api-reference/accounts/read-one-account"}]},{"group":"Contacts","pages":[{"title":"Page contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts","href":"/api-reference/contacts/page-contacts"},{"title":"Read one contact","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{id}","href":"/api-reference/contacts/read-one-contact"}]},{"group":"Locations","pages":[{"title":"Page locations","deprecated":null,"version":null,"openapi":"/openapi.json get /locations","href":"/api-reference/locations/page-locations"},{"title":"Read one location","deprecated":null,"version":null,"openapi":"/openapi.json get /locations/{id}","href":"/api-reference/locations/read-one-location"}]},{"group":"Jobs","pages":[{"title":"Page jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /jobs","href":"/api-reference/jobs/page-jobs"},{"title":"Read one job","deprecated":null,"version":null,"openapi":"/openapi.json get /jobs/{id}","href":"/api-reference/jobs/read-one-job"}]},{"group":"JobAppointments","pages":[{"title":"Page job appointments","deprecated":null,"version":null,"openapi":"/openapi.json get /job-appointments","href":"/api-reference/jobappointments/page-job-appointments"},{"title":"Read one job appointment","deprecated":null,"version":null,"openapi":"/openapi.json get /job-appointments/{id}","href":"/api-reference/jobappointments/read-one-job-appointment"}]},{"group":"JobAssignments","pages":[{"title":"Page job assignments","deprecated":null,"version":null,"openapi":"/openapi.json get /job-assignments","href":"/api-reference/jobassignments/page-job-assignments"},{"title":"Read one job assignment","deprecated":null,"version":null,"openapi":"/openapi.json get /job-assignments/{id}","href":"/api-reference/jobassignments/read-one-job-assignment"}]},{"group":"BusinessUnits","pages":[{"title":"Page business units","deprecated":null,"version":null,"openapi":"/openapi.json get /business-units","href":"/api-reference/businessunits/page-business-units"},{"title":"Read one business unit","deprecated":null,"version":null,"openapi":"/openapi.json get /business-units/{id}","href":"/api-reference/businessunits/read-one-business-unit"}]},{"group":"JobTypes","pages":[{"title":"Page job types","deprecated":null,"version":null,"openapi":"/openapi.json get /job-types","href":"/api-reference/jobtypes/page-job-types"},{"title":"Read one job type","deprecated":null,"version":null,"openapi":"/openapi.json get /job-types/{id}","href":"/api-reference/jobtypes/read-one-job-type"}]},{"group":"JobClasses","pages":[{"title":"Page job classes","deprecated":null,"version":null,"openapi":"/openapi.json get /job-classes","href":"/api-reference/jobclasses/page-job-classes"},{"title":"Read one job class","deprecated":null,"version":null,"openapi":"/openapi.json get /job-classes/{id}","href":"/api-reference/jobclasses/read-one-job-class"}]},{"group":"JobLifecycles","pages":[{"title":"Page job lifecycles","deprecated":null,"version":null,"openapi":"/openapi.json get /job-lifecycles","href":"/api-reference/joblifecycles/page-job-lifecycles"},{"title":"Read one job lifecycle","deprecated":null,"version":null,"openapi":"/openapi.json get /job-lifecycles/{id}","href":"/api-reference/joblifecycles/read-one-job-lifecycle"}]},{"group":"LeadSources","pages":[{"title":"Page lead sources","deprecated":null,"version":null,"openapi":"/openapi.json get /lead-sources","href":"/api-reference/leadsources/page-lead-sources"},{"title":"Read one lead source","deprecated":null,"version":null,"openapi":"/openapi.json get /lead-sources/{id}","href":"/api-reference/leadsources/read-one-lead-source"}]},{"group":"Tags","pages":[{"title":"Page tags","deprecated":null,"version":null,"openapi":"/openapi.json get /tags","href":"/api-reference/tags/page-tags"},{"title":"Read one tag","deprecated":null,"version":null,"openapi":"/openapi.json get /tags/{id}","href":"/api-reference/tags/read-one-tag"}]},{"group":"Estimates","pages":[{"title":"Page estimates","deprecated":null,"version":null,"openapi":"/openapi.json get /estimates","href":"/api-reference/estimates/page-estimates"},{"title":"Read one estimate","deprecated":null,"version":null,"openapi":"/openapi.json get /estimates/{id}","href":"/api-reference/estimates/read-one-estimate"}]},{"group":"JobLeads","pages":[{"title":"Page job leads","deprecated":null,"version":null,"openapi":"/openapi.json get /job-leads","href":"/api-reference/jobleads/page-job-leads"},{"title":"Read one job lead","deprecated":null,"version":null,"openapi":"/openapi.json get /job-leads/{id}","href":"/api-reference/jobleads/read-one-job-lead"}]},{"group":"Equipment","pages":[{"title":"Page equipment","deprecated":null,"version":null,"openapi":"/openapi.json get /equipment","href":"/api-reference/equipment/page-equipment"},{"title":"Read one equipment","deprecated":null,"version":null,"openapi":"/openapi.json get /equipment/{id}","href":"/api-reference/equipment/read-one-equipment"}]},{"group":"FormResponses","pages":[{"title":"Page form responses","deprecated":null,"version":null,"openapi":"/openapi.json get /form-responses","href":"/api-reference/formresponses/page-form-responses"},{"title":"Read one form response","deprecated":null,"version":null,"openapi":"/openapi.json get /form-responses/{id}","href":"/api-reference/formresponses/read-one-form-response"}]},{"group":"TimeEntries","pages":[{"title":"Page recorded time entries","deprecated":null,"version":null,"openapi":"/openapi.json get /time-entries","href":"/api-reference/timeentries/page-recorded-time-entries"},{"title":"Read one time entry","deprecated":null,"version":null,"openapi":"/openapi.json get /time-entries/{id}","href":"/api-reference/timeentries/read-one-time-entry"}]},{"group":"Timesheets","pages":[{"title":"Page members in a configured timesheet period","deprecated":null,"version":null,"openapi":"/openapi.json get /timesheets","href":"/api-reference/timesheets/page-members-in-a-configured-timesheet-period"},{"title":"Read one member’s configured-period timesheet","deprecated":null,"version":null,"openapi":"/openapi.json get /timesheets/{team_member_id}","href":"/api-reference/timesheets/read-one-member’s-configured-period-timesheet"}]},{"group":"JobFinancials","pages":[{"title":"Page jobs with recorded costs and costing revenue","deprecated":null,"version":null,"openapi":"/openapi.json get /job-financials","href":"/api-reference/jobfinancials/page-jobs-with-recorded-costs-and-costing-revenue"},{"title":"Read the recorded financials of one job","deprecated":null,"version":null,"openapi":"/openapi.json get /job-financials/{id}","href":"/api-reference/jobfinancials/read-the-recorded-financials-of-one-job"}]},{"group":"RevenueAttributions","pages":[{"title":"Page jobs with complete saved sold and earned credits","deprecated":null,"version":null,"openapi":"/openapi.json get /revenue-attributions","href":"/api-reference/revenueattributions/page-jobs-with-complete-saved-sold-and-earned-credits"},{"title":"Read the complete saved revenue credits of one job","deprecated":null,"version":null,"openapi":"/openapi.json get /revenue-attributions/{id}","href":"/api-reference/revenueattributions/read-the-complete-saved-revenue-credits-of-one-job"}]}]}]},"title":"Breezy FSM API","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}