{
"error": {
"code": "invalid_api_key",
"message": "The API key is invalid, revoked, or expired."
}
}
{
"error": {
"code": "insufficient_scope",
"message": "This API key does not have the required scope."
}
}
{
"error": {
"code": "not_found",
"message": "The requested resource was not found."
}
}
{
"error": {
"code": "validation_failed",
"message": "The attention field is required.",
"fields": {
"attention": [
"The attention field is required."
]
}
}
}
Invoices
Change an invoice status
Moves an invoice to another status. Refunded and voided invoices can no longer change.
Setting paid records a payment for the full amount.
If the workspace requires a reason for voiding or cancelling, include reason_code.
Requires the documents:write scope.
{
"error": {
"code": "invalid_api_key",
"message": "The API key is invalid, revoked, or expired."
}
}
{
"error": {
"code": "insufficient_scope",
"message": "This API key does not have the required scope."
}
}
{
"error": {
"code": "not_found",
"message": "The requested resource was not found."
}
}
{
"error": {
"code": "validation_failed",
"message": "The attention field is required.",
"fields": {
"attention": [
"The attention field is required."
]
}
}
}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"BeanRails","colors":{"primary":"#e63946","light":"#f87171","dark":"#e63946"},"logo":{"light":"https://mintcdn.com/bean-rails/aersrqnfsnXWFgKp/logo/beanrails.png?fit=max\u0026auto=format\u0026n=aersrqnfsnXWFgKp\u0026q=85\u0026s=59834d15582b2afc555f9f332844b53c","dark":"https://mintcdn.com/bean-rails/aersrqnfsnXWFgKp/logo/beanrails.png?fit=max\u0026auto=format\u0026n=aersrqnfsnXWFgKp\u0026q=85\u0026s=59834d15582b2afc555f9f332844b53c"},"favicon":"https://mintcdn.com/bean-rails/aersrqnfsnXWFgKp/favicon.png?fit=max\u0026auto=format\u0026n=aersrqnfsnXWFgKp\u0026q=85\u0026s=f3ae0fa7813d867f2ea9c6a3b88d5153","navbar":{"links":[{"href":"mailto:support@beanrails.com","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.beanrails.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bean-rails","hasAudioNarration":false,"actualSubdomain":"bean-rails","customDomains":["api-docs.beanrails.com"],"gitSource":{"type":"github","owner":"alex-shum-cw","repo":"beanrails-public-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6ae18dc2b52ab2decbda34f9"},"chroma":{"latestBuiltDeploymentHistoryId":"6ae19c7157e72f17a84a914d","collectionId":"1ae7657f-aee0-41b9-ab88-3c6d0a1ef004","liveDeploymentHistoryId":"6ae19c7157e72f17a84a914d","schemaVersion":"v3"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae19de30ab3938238c89d46","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"API reference","count":26},{"language":"default","tag":"Works","count":6},{"language":"default","tag":"Guides","count":5},{"language":"default","tag":"Contacts","count":4},{"language":"default","tag":"Invoices","count":4},{"language":"default","tag":"Quotations","count":4},{"language":"default","tag":"Essentials","count":3},{"language":"default","tag":"Contact addresses","count":3},{"language":"default","tag":"Invoice payments","count":3},{"language":"default","tag":"Getting started","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/invoices/change-an-invoice-status","slug":"/api-reference/invoices/change-an-invoice-status","pageMetadata":{"title":"Change an invoice status","description":"Moves an invoice to another status. Refunded and voided invoices can no longer change.\nSetting `paid` records a payment for the full amount.\nIf the workspace requires a reason for voiding or cancelling, include `reason_code`.\nRequires the `documents:write` scope.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml put /invoices/{id}/status","href":"/api-reference/invoices/change-an-invoice-status","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Moves an invoice to another status. Refunded and voided invoices can no longer change.\\nSetting \", _jsx(_components.code, {\n children: \"paid\"\n }), \" records a payment for the full amount.\\nIf the workspace requires a reason for voiding or cancelling, include \", _jsx(_components.code, {\n children: \"reason_code\"\n }), \".\\nRequires the \", _jsx(_components.code, {\n children: \"documents:write\"\n }), \" scope.\"]\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":{"config":{},"pageMetadata":{"title":"Change an invoice status","description":"Moves an invoice to another status. Refunded and voided invoices can no longer change.\nSetting `paid` records a payment for the full amount.\nIf the workspace requires a reason for voiding or cancelling, include `reason_code`.\nRequires the `documents:write` scope.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml put /invoices/{id}/status","href":"/api-reference/invoices/change-an-invoice-status","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"updateInvoiceStatus","tags":["Invoices"],"summary":"Change an invoice status","description":"Moves an invoice to another status. Refunded and voided invoices can no longer change.\nSetting `paid` records a payment for the full amount.\nIf the workspace requires a reason for voiding or cancelling, include `reason_code`.\nRequires the `documents:write` scope.\n","requestBody":"b47db09d-8d59-4db4-9811-0baa3b249a4a","responses":{"200":"bf4873a1-0812-4ded-ae78-78d7ad529c36","401":"3ca21f38-7362-469d-86da-d84be2c898d3","403":"7f2e709d-4b4d-4783-8535-532a34ae44e6","404":"58bcad85-f107-42a6-9202-e2a8d164f8ce","422":"3693e228-3f3f-40f3-a6ef-3ccfc7a10fff","429":"99da3710-b20f-4942-b63f-9370178615cc"},"method":"put","type":"path","servers":["154004c9-e4f6-442a-8e2b-c0d42ed2a198"],"security":["0ecb1668-118c-4938-a713-ce130e4d64dd"],"path":"/invoices/{id}/status","baseUrlOptions":["https://{host}/api/public/v1"],"title":"Change an invoice status","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ca2b1f43-6abd-4d93-be7d-5f183667599d":{"name":"id","in":"path","required":true,"description":"The record ID.","schema":{"type":"integer","isRequired":true,"description":"The record ID.","uniqueKey":"","typeLabel":"integer"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","description":"A status value valid for this document type.","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"reason_code":{"type":"string","description":"A reason code from the workspace. Required when voiding or cancelling if the workspace enforces reasons.","uniqueKey":"reason_code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"unpaid"},"examples":{"Example":{"title":"Example","value":{"status":"unpaid"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"bf4873a1-0812-4ded-ae78-78d7ad529c36":{"description":"The updated invoice.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"integer","uniqueKey":"data.id","typeLabel":"integer"},"document_type":{"type":"string","enum":["invoice","quotation"],"uniqueKey":"data.document_type","typeLabel":"enum\u003cstring>"},"document_number":{"type":"string","uniqueKey":"data.document_number","typeLabel":"string"},"document_date":{"type":"string","uniqueKey":"data.document_date","typeLabel":"string"},"document_due_date":{"oneOf":[{"type":"string","uniqueKey":"data.document_due_date.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.document_due_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.document_due_date","typeLabel":"string | null"},"status":{"type":"string","description":"Invoices: `draft`, `unpaid`, `partially_paid`, `paid`, `voided`, `refunded`.\nQuotations: `draft`, `pending`, `invoiced`, `completed`, `cancelled`.\nWorkspaces can rename and add statuses.\n","uniqueKey":"data.status","typeLabel":"string"},"status_name":{"oneOf":[{"type":"string","uniqueKey":"data.status_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.status_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.status_name","typeLabel":"string | null"},"currency":{"type":"string","description":"Three letter currency code.","uniqueKey":"data.currency","typeLabel":"string"},"contact":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"data.contact.oneOf.0.id","typeLabel":"integer"},"contact_number":{"type":"string","uniqueKey":"data.contact.oneOf.0.contact_number","typeLabel":"string"},"company_name":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.company_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.company_name","typeLabel":"string | null"},"first_name":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.first_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.first_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.first_name","typeLabel":"string | null"},"last_name":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.last_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.last_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.last_name","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.email","typeLabel":"string | null"},"phone":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.phone","typeLabel":"string | null"},"lifecycle_stage":{"type":"string","enum":["lead","customer"],"uniqueKey":"data.contact.oneOf.0.lifecycle_stage","typeLabel":"enum\u003cstring>"},"status":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.status.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.status.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.status","typeLabel":"string | null"},"status_name":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.status_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.status_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.status_name","typeLabel":"string | null"},"user":{"oneOf":[{"type":"object","description":"The assigned user.","properties":{"id":{"type":"integer","uniqueKey":"data.contact.oneOf.0.user.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"data.contact.oneOf.0.user.oneOf.0.name","typeLabel":"string"},"email":{"type":"string","uniqueKey":"data.contact.oneOf.0.user.oneOf.0.email","typeLabel":"string"}},"uniqueKey":"data.contact.oneOf.0.user.oneOf.0","typeLabel":"object"},{"type":"null","description":"The assigned user.","properties":{"id":{"type":"integer"},"name":{"type":"string"},"email":{"type":"string"}},"uniqueKey":"data.contact.oneOf.0.user.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.user","typeLabel":"object | null"},"groups":{"type":"array","items":{"type":"object","additionalProperties":true,"uniqueKey":"data.contact.oneOf.0.groups.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.contact.oneOf.0.groups","typeLabel":"object[]"},"primary_address":{"oneOf":[{"type":"object","properties":{"id":{"type":"integer","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.name","typeLabel":"string"},"attention":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.attention.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.attention.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.attention","typeLabel":"string | null"},"email":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.email.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.email","typeLabel":"string | null"},"company_name":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.company_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.company_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.company_name","typeLabel":"string | null"},"mobile_no":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.mobile_no.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.mobile_no.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.mobile_no","typeLabel":"string | null"},"office_no":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.office_no.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.office_no.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.office_no","typeLabel":"string | null"},"address1":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.address1.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.address1.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.address1","typeLabel":"string | null"},"address2":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.address2.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.address2","typeLabel":"string | null"},"city":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.city.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.city","typeLabel":"string | null"},"state":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.state.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.state.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.state","typeLabel":"string | null"},"postcode":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.postcode.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.postcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.postcode","typeLabel":"string | null"},"country":{"oneOf":[{"type":"string","description":"Two letter country code.","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.country.oneOf.0","typeLabel":"string"},{"type":"null","description":"Two letter country code.","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.country.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.country","typeLabel":"string | null"},"country_name":{"oneOf":[{"type":"string","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.country_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.country_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.country_name","typeLabel":"string | null"},"zone_id":{"oneOf":[{"type":"integer","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.zone_id.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.zone_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.zone_id","typeLabel":"integer | null"},"is_primary":{"type":"boolean","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0.is_primary","typeLabel":"boolean"}},"additionalProperties":true,"uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.contact.oneOf.0.primary_address.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.primary_address","typeLabel":"object | null"},"works_count":{"oneOf":[{"type":"integer","uniqueKey":"data.contact.oneOf.0.works_count.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"data.contact.oneOf.0.works_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.works_count","typeLabel":"integer | null"},"quotations_count":{"oneOf":[{"type":"integer","uniqueKey":"data.contact.oneOf.0.quotations_count.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"data.contact.oneOf.0.quotations_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.quotations_count","typeLabel":"integer | null"},"invoices_count":{"oneOf":[{"type":"integer","uniqueKey":"data.contact.oneOf.0.invoices_count.oneOf.0","typeLabel":"integer"},{"type":"null","uniqueKey":"data.contact.oneOf.0.invoices_count.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact.oneOf.0.invoices_count","typeLabel":"integer | null"},"created_at":{"type":"string","uniqueKey":"data.contact.oneOf.0.created_at","typeLabel":"string"},"updated_at":{"type":"string","uniqueKey":"data.contact.oneOf.0.updated_at","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"data.contact.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.contact.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.contact","typeLabel":"object | null"},"sub_total":{"type":"number","uniqueKey":"data.sub_total","typeLabel":"number"},"total_discount":{"type":"number","uniqueKey":"data.total_discount","typeLabel":"number"},"total_tax":{"type":"number","uniqueKey":"data.total_tax","typeLabel":"number"},"total_amount":{"type":"number","uniqueKey":"data.total_amount","typeLabel":"number"},"final_amount":{"type":"number","description":"The amount due after adjustments.","uniqueKey":"data.final_amount","typeLabel":"number"},"amount_paid":{"type":"number","uniqueKey":"data.amount_paid","typeLabel":"number"},"remaining_amount":{"type":"number","uniqueKey":"data.remaining_amount","typeLabel":"number"},"pdf_url":{"oneOf":[{"type":"string","uniqueKey":"data.pdf_url.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.pdf_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.pdf_url","typeLabel":"string | null"},"remarks":{"oneOf":[{"type":"string","uniqueKey":"data.remarks.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.remarks.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.remarks","typeLabel":"string | null"},"items":{"type":"array","description":"Only on the retrieve endpoints.","items":{"type":"object","additionalProperties":true,"uniqueKey":"data.\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.\\items","typeLabel":"object[]"},"taxes":{"type":"array","description":"Only on the retrieve endpoints.","items":{"type":"object","additionalProperties":true,"uniqueKey":"data.taxes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.taxes","typeLabel":"object[]"},"discounts":{"type":"array","description":"Only on the retrieve endpoints.","items":{"type":"object","additionalProperties":true,"uniqueKey":"data.discounts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.discounts","typeLabel":"object[]"},"addresses":{"type":"object","description":"Only on the retrieve endpoints.","properties":{"billing":{"oneOf":[{"type":"object","additionalProperties":true,"uniqueKey":"data.addresses.billing.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"uniqueKey":"data.addresses.billing.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.addresses.billing","typeLabel":"object | null"},"shipping":{"oneOf":[{"type":"object","additionalProperties":true,"uniqueKey":"data.addresses.shipping.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"uniqueKey":"data.addresses.shipping.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.addresses.shipping","typeLabel":"object | null"}},"uniqueKey":"data.addresses","typeLabel":"object"},"created_at":{"type":"string","uniqueKey":"data.created_at","typeLabel":"string"},"updated_at":{"type":"string","uniqueKey":"data.updated_at","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":123,"document_type":"invoice","document_number":"\u003cstring>","document_date":"\u003cstring>","document_due_date":"\u003cstring>","status":"\u003cstring>","status_name":"\u003cstring>","currency":"\u003cstring>","contact":{"id":123,"contact_number":"\u003cstring>","company_name":"\u003cstring>","first_name":"\u003cstring>","last_name":"\u003cstring>","email":"\u003cstring>","phone":"\u003cstring>","lifecycle_stage":"lead","status":"\u003cstring>","status_name":"\u003cstring>","user":{"id":123,"name":"\u003cstring>","email":"\u003cstring>"},"groups":[{}],"primary_address":{"id":123,"name":"\u003cstring>","attention":"\u003cstring>","email":"\u003cstring>","company_name":"\u003cstring>","mobile_no":"\u003cstring>","office_no":"\u003cstring>","address1":"\u003cstring>","address2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","postcode":"\u003cstring>","country":"\u003cstring>","country_name":"\u003cstring>","zone_id":123,"is_primary":true},"works_count":123,"quotations_count":123,"invoices_count":123,"created_at":"\u003cstring>","updated_at":"\u003cstring>"},"sub_total":123,"total_discount":123,"total_tax":123,"total_amount":123,"final_amount":123,"amount_paid":123,"remaining_amount":123,"pdf_url":"\u003cstring>","remarks":"\u003cstring>","items":[{}],"taxes":[{}],"discounts":[{}],"addresses":{"billing":{},"shipping":{}},"created_at":"\u003cstring>","updated_at":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"3ca21f38-7362-469d-86da-d84be2c898d3":{"description":"The API key is missing, invalid, revoked or expired.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"A stable, machine readable code.","examples":["not_found"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"invalid_api_key","message":"The API key is invalid, revoked, or expired."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_api_key","message":"The API key is invalid, revoked, or expired."}}}},"exampleType":"examples"}},"exampleType":"examples"},"7f2e709d-4b4d-4783-8535-532a34ae44e6":{"description":"The key lacks the required scope, the key owner's role no longer allows it, or the owner's account is suspended.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"A stable, machine readable code.","examples":["not_found"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"insufficient_scope","message":"This API key does not have the required scope."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"insufficient_scope","message":"This API key does not have the required scope."}}}},"exampleType":"examples"}},"exampleType":"examples"},"58bcad85-f107-42a6-9202-e2a8d164f8ce":{"description":"The record does not exist, or your key is not allowed to see it.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"A stable, machine readable code.","examples":["not_found"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"A human readable explanation.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"not_found","message":"The requested resource was not found."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"not_found","message":"The requested resource was not found."}}}},"exampleType":"examples"}},"exampleType":"examples"},"3693e228-3f3f-40f3-a6ef-3ccfc7a10fff":{"description":"The request body failed validation. `error.fields` lists the problems per field.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","fields"],"properties":{"code":{"type":"string","enum":["validation_failed"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"fields":{"type":"object","description":"Field names mapped to a list of messages.","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"error.fields.additionalProperties.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.fields.additionalProperties","typeLabel":"string[]"},"isRequired":true,"uniqueKey":"error.fields","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"validation_failed","message":"The attention field is required.","fields":{"attention":["The attention field is required."]}}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"validation_failed","message":"The attention field is required.","fields":{"attention":["The attention field is required."]}}}}},"exampleType":"examples"}},"exampleType":"examples"},"99da3710-b20f-4942-b63f-9370178615cc":{"description":"You exceeded the key's requests per minute. Wait for the number of seconds in the `Retry-After` header.","headers":{"Retry-After":{"description":"Seconds until you can retry.","schema":{"type":"integer"}}},"content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"0ecb1668-118c-4938-a713-ce130e4d64dd":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key created in BeanRails, for example `brk_live_...`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"154004c9-e4f6-442a-8e2b-c0d42ed2a198":{"url":"https://{host}/api/public/v1","description":"Public API v1","variables":{"host":{"default":"app.beanrails.com","description":"The host your BeanRails workspace is served from."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key created in BeanRails, for example `brk_live_...`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key created in BeanRails, for example `brk_live_...`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"bean-rails","siteName":"BeanRails","title":"Change an invoice status - BeanRails","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T06:42:45.377Z","originalFileLocation":"api-reference/invoices/change-an-invoice-status.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=\"Moves an invoice to another status. Refunded and voided invoices can no longer change. Setting paid records a payment for the full amount. If the workspace requires a reason for voiding or cancelling, include reason_code. Requires the documents:write scope.\">\u003cmeta data-mint-head name=\"application-name\" content=\"BeanRails\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bean-rails/zIzNo9L5TTMgVXBM/_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/bean-rails/zIzNo9L5TTMgVXBM/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bean-rails/zIzNo9L5TTMgVXBM/_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/bean-rails/zIzNo9L5TTMgVXBM/_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/bean-rails/zIzNo9L5TTMgVXBM/_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/bean-rails/zIzNo9L5TTMgVXBM/_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/bean-rails/zIzNo9L5TTMgVXBM/_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/bean-rails/zIzNo9L5TTMgVXBM/_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/bean-rails/zIzNo9L5TTMgVXBM/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Change an invoice status - BeanRails\">\u003cmeta data-mint-head property=\"og:description\" content=\"Moves an invoice to another status. Refunded and voided invoices can no longer change. Setting paid records a payment for the full amount. If the workspace requires a reason for voiding or cancelling, include reason_code. Requires the documents:write scope.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"BeanRails\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://api-docs.beanrails.com/api-reference/invoices/change-an-invoice-status\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bean-rails.mintlify.app/_mintlify/api/og/v2?division=Invoices\u0026amp;title=Change+an+invoice+status\u0026amp;description=Moves+an+invoice+to+another+status.+Refunded+and+voided+invoices+can+no+longer+change.%0ASetting+%60paid%60+records+a+payment+for+the+full+amount.%0AIf+the+workspace+re\u0026amp;theme=984b51d104ebf20e438c23c4\u0026amp;signature=fd6c2b84e5e786b86d5eded096555d75027b3e0e39755e1f7459ffa9bf3967ce\">\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=\"Change an invoice status - BeanRails\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Moves an invoice to another status. Refunded and voided invoices can no longer change. Setting paid records a payment for the full amount. If the workspace requires a reason for voiding or cancelling, include reason_code. Requires the documents:write scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bean-rails.mintlify.app/_mintlify/api/og/v2?division=Invoices\u0026amp;title=Change+an+invoice+status\u0026amp;description=Moves+an+invoice+to+another+status.+Refunded+and+voided+invoices+can+no+longer+change.%0ASetting+%60paid%60+records+a+payment+for+the+full+amount.%0AIf+the+workspace+re\u0026amp;theme=984b51d104ebf20e438c23c4\u0026amp;signature=fd6c2b84e5e786b86d5eded096555d75027b3e0e39755e1f7459ffa9bf3967ce\">\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/bean-rails/zIzNo9L5TTMgVXBM/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"BeanRails\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#e63946\">\u003clink data-mint-head rel=\"canonical\" href=\"https://api-docs.beanrails.com/api-reference/invoices/change-an-invoice-status\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/invoices/change-an-invoice-status.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://api-docs.beanrails.com/#organization\",\"name\":\"BeanRails\",\"url\":\"https://api-docs.beanrails.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bean-rails/aersrqnfsnXWFgKp/logo/beanrails.png?fit=max\u0026auto=format\u0026n=aersrqnfsnXWFgKp\u0026q=85\u0026s=59834d15582b2afc555f9f332844b53c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://api-docs.beanrails.com#website\",\"name\":\"BeanRails\",\"url\":\"https://api-docs.beanrails.com\",\"publisher\":{\"@id\":\"https://api-docs.beanrails.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://api-docs.beanrails.com/api-reference/invoices/change-an-invoice-status#webpage\",\"url\":\"https://api-docs.beanrails.com/api-reference/invoices/change-an-invoice-status\",\"name\":\"Change an invoice status\",\"description\":\"Moves an invoice to another status. Refunded and voided invoices can no longer change. Setting paid records a payment for the full amount. If the workspace requires a reason for voiding or cancelling, include reason_code. Requires the documents:write scope.\",\"dateModified\":\"2026-10-28T06:42:45.377Z\",\"isPartOf\":{\"@id\":\"https://api-docs.beanrails.com#website\"},\"breadcrumb\":{\"@id\":\"https://api-docs.beanrails.com/api-reference/invoices/change-an-invoice-status#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api-docs.beanrails.com/api-reference/invoices/change-an-invoice-status#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Invoices\",\"item\":\"https://api-docs.beanrails.com/api-reference/invoices/list-invoices\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Change an invoice status\",\"item\":\"https://api-docs.beanrails.com/api-reference/invoices/change-an-invoice-status\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api-docs.beanrails.com/api-reference/invoices/change-an-invoice-status#apireference\",\"headline\":\"Change an invoice status\",\"name\":\"Change an invoice status\",\"description\":\"Moves an invoice to another status. Refunded and voided invoices can no longer change. Setting paid records a payment for the full amount. If the workspace requires a reason for voiding or cancelling, include reason_code. Requires the documents:write scope.\",\"url\":\"https://api-docs.beanrails.com/api-reference/invoices/change-an-invoice-status\",\"mainEntityOfPage\":{\"@id\":\"https://api-docs.beanrails.com/api-reference/invoices/change-an-invoice-status#webpage\"},\"dateModified\":\"2026-10-28T06:42:45.377Z\",\"publisher\":{\"@id\":\"https://api-docs.beanrails.com/#organization\"},\"isPartOf\":{\"@id\":\"https://api-docs.beanrails.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"BeanRails\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"BeanRails","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Retrieve a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contacts/{id}","href":"/api-reference/contacts/retrieve-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml put /contacts/{id}","href":"/api-reference/contacts/update-a-contact"}]},{"group":"Contact addresses","pages":[{"title":"List a contact's addresses","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contacts/{contactId}/addresses","href":"/api-reference/contact-addresses/list-a-contacts-addresses"},{"title":"Add an address to a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /contacts/{contactId}/addresses","href":"/api-reference/contact-addresses/add-an-address-to-a-contact"},{"title":"Update a contact address","deprecated":null,"version":null,"openapi":"/openapi.yaml put /contacts/{contactId}/addresses/{id}","href":"/api-reference/contact-addresses/update-a-contact-address"}]},{"group":"Works","pages":[{"title":"List works","deprecated":null,"version":null,"openapi":"/openapi.yaml get /works","href":"/api-reference/works/list-works"},{"title":"Create a work","deprecated":null,"version":null,"openapi":"/openapi.yaml post /works","href":"/api-reference/works/create-a-work"},{"title":"Retrieve a work","deprecated":null,"version":null,"openapi":"/openapi.yaml get /works/{id}","href":"/api-reference/works/retrieve-a-work"},{"title":"Update a work","deprecated":null,"version":null,"openapi":"/openapi.yaml put /works/{id}","href":"/api-reference/works/update-a-work"},{"title":"Cancel or reopen a work","deprecated":null,"version":null,"openapi":"/openapi.yaml put /works/{id}/status","href":"/api-reference/works/cancel-or-reopen-a-work"},{"title":"Reschedule a work","deprecated":null,"version":null,"openapi":"/openapi.yaml put /works/{id}/schedule","href":"/api-reference/works/reschedule-a-work"}]},{"group":"Work PODs","pages":[{"title":"List proof of delivery records of a work","deprecated":null,"version":null,"openapi":"/openapi.yaml get /works/{id}/pods","href":"/api-reference/work-pods/list-proof-of-delivery-records-of-a-work"},{"title":"Retrieve a proof of delivery record","deprecated":null,"version":null,"openapi":"/openapi.yaml get /works/{id}/pods/{podId}","href":"/api-reference/work-pods/retrieve-a-proof-of-delivery-record"}]},{"group":"Invoices","pages":[{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /invoices","href":"/api-reference/invoices/list-invoices"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /invoices","href":"/api-reference/invoices/create-an-invoice"},{"title":"Retrieve an invoice","description":"Requires the `documents:read` scope.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /invoices/{id}","href":"/api-reference/invoices/retrieve-an-invoice"},{"title":"Change an invoice status","deprecated":null,"version":null,"openapi":"/openapi.yaml put /invoices/{id}/status","href":"/api-reference/invoices/change-an-invoice-status"}]},{"group":"Invoice payments","pages":[{"title":"List payments of an invoice","description":"Requires the `documents:read` scope.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /invoices/{id}/payments","href":"/api-reference/invoice-payments/list-payments-of-an-invoice"},{"title":"Record a payment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /invoices/{id}/payments","href":"/api-reference/invoice-payments/record-a-payment"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /invoices/{id}/payments/{paymentId}","href":"/api-reference/invoice-payments/retrieve-a-payment"}]},{"group":"Quotations","pages":[{"title":"List quotations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /quotations","href":"/api-reference/quotations/list-quotations"},{"title":"Create a quotation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /quotations","href":"/api-reference/quotations/create-a-quotation"},{"title":"Retrieve a quotation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /quotations/{id}","href":"/api-reference/quotations/retrieve-a-quotation"},{"title":"Change a quotation status","deprecated":null,"version":null,"openapi":"/openapi.yaml put /quotations/{id}/status","href":"/api-reference/quotations/change-a-quotation-status"}]}]}]},"title":"Change an invoice status - BeanRails","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}