{
"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."
]
}
}
}
Invoice payments
Record a payment
Records a payment against an invoice, typically after you have received the money in your accounting system.
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/invoice-payments/record-a-payment","slug":"/api-reference/invoice-payments/record-a-payment","pageMetadata":{"title":"Record a payment","description":"Records a payment against an invoice, typically after you have received the money in your accounting system.\nRequires the `documents:write` scope.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /invoices/{id}/payments","href":"/api-reference/invoice-payments/record-a-payment","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: [\"Records a payment against an invoice, typically after you have received the money in your accounting system.\\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":"Record a payment","description":"Records a payment against an invoice, typically after you have received the money in your accounting system.\nRequires the `documents:write` scope.\n","deprecated":null,"version":null,"openapi":"/openapi.yaml post /invoices/{id}/payments","href":"/api-reference/invoice-payments/record-a-payment","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createInvoicePayment","tags":["Invoice payments"],"summary":"Record a payment","description":"Records a payment against an invoice, typically after you have received the money in your accounting system.\nRequires the `documents:write` scope.\n","requestBody":"e792abe5-c78e-41e5-afb7-b57bd28fdaac","responses":{"200":"244c8754-c05a-424b-bd92-6f6fb1f695f0","401":"ff8e27be-a117-48bb-8954-a2b57d4104f5","403":"1a734078-8b18-49fd-a6f5-cc5bb7d3894f","404":"99a5b752-a974-431b-9c43-e0926a315020","422":"8640069d-6648-41b1-a21b-31f174665171","429":"487c2983-d0c8-4319-828a-f3555d2d799f"},"method":"post","type":"path","servers":["154004c9-e4f6-442a-8e2b-c0d42ed2a198"],"security":["0ecb1668-118c-4938-a713-ce130e4d64dd"],"path":"/invoices/{id}/payments","baseUrlOptions":["https://{host}/api/public/v1"],"title":"Record a payment","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"e13902a9-8422-4b08-934c-e73ec84b0c50":{"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":["amount_paid","payment_method","payment_date"],"properties":{"amount_paid":{"type":"number","minimum":0,"description":"In major currency units, for example `250.00`.","isRequired":true,"uniqueKey":"amount_paid","typeLabel":"number"},"payment_method":{"type":"string","enum":["cash","bank_draft","qr_code","credit_card","cheque","online_transfer","telegraphic"],"isRequired":true,"uniqueKey":"payment_method","typeLabel":"enum\u003cstring>"},"payment_date":{"type":"string","format":"date","description":"`YYYY-MM-DD`.","isRequired":true,"uniqueKey":"payment_date","typeLabel":"string\u003cdate>"},"status":{"type":"string","enum":["pending","success","failed","cancelled","in_progress","refunded","authorized","declined","expired","under_review"],"description":"Defaults to `success`.","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"ref_transaction_id":{"type":"string","maxLength":255,"description":"Your own reference, such as a bank transaction ID.","uniqueKey":"ref_transaction_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"amount_paid":250,"payment_method":"online_transfer","payment_date":"2026-11-05","ref_transaction_id":"BANK-REF-8841"},"examples":{"Example":{"title":"Example","value":{"amount_paid":250,"payment_method":"online_transfer","payment_date":"2026-11-05","ref_transaction_id":"BANK-REF-8841"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"244c8754-c05a-424b-bd92-6f6fb1f695f0":{"description":"The recorded payment.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"integer","uniqueKey":"data.id","typeLabel":"integer"},"document_id":{"type":"integer","uniqueKey":"data.document_id","typeLabel":"integer"},"amount_paid":{"type":"number","description":"In major currency units.","uniqueKey":"data.amount_paid","typeLabel":"number"},"payment_method":{"type":"string","enum":["cash","bank_draft","qr_code","credit_card","cheque","online_transfer","telegraphic"],"uniqueKey":"data.payment_method","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["pending","success","failed","cancelled","in_progress","refunded","authorized","declined","expired","under_review"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"payment_date":{"type":"string","uniqueKey":"data.payment_date","typeLabel":"string"},"ref_transaction_id":{"oneOf":[{"type":"string","uniqueKey":"data.ref_transaction_id.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.ref_transaction_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.ref_transaction_id","typeLabel":"string | null"},"collected_by_vehicle":{"oneOf":[{"type":"string","uniqueKey":"data.collected_by_vehicle.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.collected_by_vehicle.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.collected_by_vehicle","typeLabel":"string | null"},"created_at":{"type":"string","uniqueKey":"data.created_at","typeLabel":"string"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":123,"document_id":123,"amount_paid":123,"payment_method":"cash","status":"pending","payment_date":"\u003cstring>","ref_transaction_id":"\u003cstring>","collected_by_vehicle":"\u003cstring>","created_at":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"ff8e27be-a117-48bb-8954-a2b57d4104f5":{"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"},"1a734078-8b18-49fd-a6f5-cc5bb7d3894f":{"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"},"99a5b752-a974-431b-9c43-e0926a315020":{"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"},"8640069d-6648-41b1-a21b-31f174665171":{"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"},"487c2983-d0c8-4319-828a-f3555d2d799f":{"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":"Record a payment - BeanRails","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T06:42:45.401Z","originalFileLocation":"api-reference/invoice-payments/record-a-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=\"Records a payment against an invoice, typically after you have received the money in your accounting system. 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=\"Record a payment - BeanRails\">\u003cmeta data-mint-head property=\"og:description\" content=\"Records a payment against an invoice, typically after you have received the money in your accounting system. 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/invoice-payments/record-a-payment\">\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=Invoice+payments\u0026amp;title=Record+a+payment\u0026amp;description=Records+a+payment+against+an+invoice%2C+typically+after+you+have+received+the+money+in+your+accounting+system.%0ARequires+the+%60documents%3Awrite%60+scope.%0A\u0026amp;theme=984b51d104ebf20e438c23c4\u0026amp;signature=8def23a7d08d19022218cf127df01cbe6f7f7046de1e056009708029d0e18984\">\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=\"Record a payment - BeanRails\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Records a payment against an invoice, typically after you have received the money in your accounting system. Requires the documents:write scope.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bean-rails.mintlify.app/_mintlify/api/og/v2?division=Invoice+payments\u0026amp;title=Record+a+payment\u0026amp;description=Records+a+payment+against+an+invoice%2C+typically+after+you+have+received+the+money+in+your+accounting+system.%0ARequires+the+%60documents%3Awrite%60+scope.%0A\u0026amp;theme=984b51d104ebf20e438c23c4\u0026amp;signature=8def23a7d08d19022218cf127df01cbe6f7f7046de1e056009708029d0e18984\">\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/invoice-payments/record-a-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/invoice-payments/record-a-payment.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/invoice-payments/record-a-payment#webpage\",\"url\":\"https://api-docs.beanrails.com/api-reference/invoice-payments/record-a-payment\",\"name\":\"Record a payment\",\"description\":\"Records a payment against an invoice, typically after you have received the money in your accounting system. Requires the documents:write scope.\",\"dateModified\":\"2026-10-28T06:42:45.401Z\",\"isPartOf\":{\"@id\":\"https://api-docs.beanrails.com#website\"},\"breadcrumb\":{\"@id\":\"https://api-docs.beanrails.com/api-reference/invoice-payments/record-a-payment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://api-docs.beanrails.com/api-reference/invoice-payments/record-a-payment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Invoice payments\",\"item\":\"https://api-docs.beanrails.com/api-reference/invoice-payments/list-payments-of-an-invoice\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Record a payment\",\"item\":\"https://api-docs.beanrails.com/api-reference/invoice-payments/record-a-payment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://api-docs.beanrails.com/api-reference/invoice-payments/record-a-payment#apireference\",\"headline\":\"Record a payment\",\"name\":\"Record a payment\",\"description\":\"Records a payment against an invoice, typically after you have received the money in your accounting system. Requires the documents:write scope.\",\"url\":\"https://api-docs.beanrails.com/api-reference/invoice-payments/record-a-payment\",\"mainEntityOfPage\":{\"@id\":\"https://api-docs.beanrails.com/api-reference/invoice-payments/record-a-payment#webpage\"},\"dateModified\":\"2026-10-28T06:42:45.401Z\",\"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","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","description":"Requires the `documents:read` scope.","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":"Record a payment - 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"]}