{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Bigcapital Docs","colors":{"primary":"#76A1FF","light":"#76A1FF","dark":"#000"},"logo":{"light":"https://mintcdn.com/bigcapital/WVY5ORu6xzXKmdxI/logo/light.svg?fit=max\u0026auto=format\u0026n=WVY5ORu6xzXKmdxI\u0026q=85\u0026s=bb81eb8e5af2fb5e066a47522688beb8","dark":"https://mintcdn.com/bigcapital/8aPCQyR4cPWP5gfj/logo/dark.svg?fit=max\u0026auto=format\u0026n=8aPCQyR4cPWP5gfj\u0026q=85\u0026s=78d9ccccea4e56cf20fd75142036be5d"},"favicon":"/favicon.png","appearance":{"default":"dark"},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Github","href":"https://github.com/bigcapitalhq/bigcapital"}},"footer":{"socials":{"x":"https://x.com/bigcapitalhq","github":"https://github.com/bigcapitalhq/bigcapital"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.com/invite/c8nPBJafeb"},{"anchor":"Blog","icon":"newspaper","href":"https://bigcapital.app/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bigcapital","hasAudioNarration":false,"actualSubdomain":"bigcapital","customDomains":["docs.bigcapital.app"],"gitSource":{"type":"github","owner":"bigcapitalhq","repo":"docs-v2","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a2201485cac5fa6292a51fe","collectionId":"367f51da-8d9c-420d-8dcb-198f7bf4470b","schemaVersion":"v2"},"entitlements":{},"buildId":"6a2201485cac5fa6292a51fe:success","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API Reference","count":702},{"language":"default","tag":"Reports","count":18},{"language":"default","tag":"Sale Invoices","count":17},{"language":"default","tag":"Sale Estimates","count":15},{"language":"default","tag":"Items","count":13},{"language":"default","tag":"Payments Received","count":12},{"language":"default","tag":"Guides","count":11},{"language":"default","tag":"Accounts","count":11},{"language":"default","tag":"Sale Receipts","count":11},{"language":"default","tag":"Bills","count":10}]},"assistantConfig":{},"basePath":"","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":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-logo{width:140px}"}],"page":{"pagePath":"api-reference/sale-invoices/edit-the-given-sale-invoice","slug":"/api-reference/sale-invoices/edit-the-given-sale-invoice","pageMetadata":{"title":"Edit the given sale invoice.","description":null,"deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/sale-invoices/{id}","href":"/api-reference/sale-invoices/edit-the-given-sale-invoice","autogeneratedByOpenApi":true,"hidden":false},"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":"Edit the given sale invoice.","description":null,"deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/sale-invoices/{id}","href":"/api-reference/sale-invoices/edit-the-given-sale-invoice","autogeneratedByOpenApi":true,"hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"SaleInvoicesController_editSaleInvoice","summary":"Edit the given sale invoice.","parameters":["58403b8d-01b3-4e9b-a018-c3de02d91243","97c2497e-442d-4bbd-8e72-e2a12b24a636","6e2e9ed1-b968-4849-a0a5-1a13358bab3e"],"requestBody":"c657c3e9-cd8b-4c45-8985-56e3113209ae","responses":{"200":"d6572574-758a-452e-94ba-8bec34bacdfd","404":"2a079ca0-0eee-411f-9261-be805d9ffc01"},"tags":["Sale Invoices"],"method":"put","type":"path","servers":[],"security":[],"path":"/api/sale-invoices/{id}","baseUrlOptions":[],"title":"Edit the given sale invoice.","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"58403b8d-01b3-4e9b-a018-c3de02d91243":{"name":"Authorization","in":"header","description":"Value must be 'Bearer \u003ctoken>' where \u003ctoken> is an API key prefixed with 'bc_' or a JWT token.","required":true,"schema":{"type":"string","example":"Bearer bc_1234567890abcdef","isRequired":true,"description":"Value must be 'Bearer \u003ctoken>' where \u003ctoken> is an API key prefixed with 'bc_' or a JWT token.","uniqueKey":"","typeLabel":"string"}},"97c2497e-442d-4bbd-8e72-e2a12b24a636":{"name":"organization-id","in":"header","description":"Required if Authorization is a JWT token. The organization ID to operate within.","required":true,"schema":{"type":"string","isRequired":true,"description":"Required if Authorization is a JWT token. The organization ID to operate within.","uniqueKey":"","typeLabel":"string"}},"6e2e9ed1-b968-4849-a0a5-1a13358bab3e":{"name":"id","required":true,"in":"path","description":"The sale invoice id","schema":{"type":"number","isRequired":true,"description":"The sale invoice id","uniqueKey":"","typeLabel":"number"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"customerId":{"type":"number","description":"Customer ID","example":1,"isRequired":true,"uniqueKey":"customerId","typeLabel":"number"},"invoiceDate":{"format":"date-time","type":"string","description":"Invoice date","example":"2023-01-01T00:00:00Z","isRequired":true,"uniqueKey":"invoiceDate","typeLabel":"string\u003cdate-time>"},"dueDate":{"format":"date-time","type":"string","description":"Due date","example":"2023-01-15T00:00:00Z","isRequired":true,"uniqueKey":"dueDate","typeLabel":"string\u003cdate-time>"},"entries":{"description":"Invoice line items","minItems":1,"type":"array","items":{"type":"object","properties":{"index":{"type":"number","description":"The index of the item entry","example":1,"isRequired":true,"uniqueKey":"entries.items.[INDEX].index","typeLabel":"number"},"itemId":{"type":"number","description":"The id of the item","example":1,"isRequired":true,"uniqueKey":"entries.items.[INDEX].itemId","typeLabel":"number"},"rate":{"type":"number","description":"The rate of the item entry","example":1,"isRequired":true,"uniqueKey":"entries.items.[INDEX].rate","typeLabel":"number"},"quantity":{"type":"number","description":"The quantity of the item entry","example":1,"isRequired":true,"uniqueKey":"entries.items.[INDEX].quantity","typeLabel":"number"},"discount":{"type":"number","description":"The discount of the item entry","example":1,"isRequired":true,"uniqueKey":"entries.items.[INDEX].discount","typeLabel":"number"},"discountType":{"type":"string","description":"The type of the discount","example":"percentage","isRequired":true,"uniqueKey":"entries.items.[INDEX].discountType","typeLabel":"string"},"description":{"type":"string","description":"The description of the item entry","example":"This is a description","isRequired":true,"uniqueKey":"entries.items.[INDEX].description","typeLabel":"string"},"taxCode":{"type":"string","description":"The tax code of the item entry","example":"123456","isRequired":true,"uniqueKey":"entries.items.[INDEX].taxCode","typeLabel":"string"},"taxRateId":{"type":"number","description":"The tax rate id of the item entry","example":1,"isRequired":true,"uniqueKey":"entries.items.[INDEX].taxRateId","typeLabel":"number"},"warehouseId":{"type":"number","description":"The warehouse id of the item entry","example":1,"isRequired":true,"uniqueKey":"entries.items.[INDEX].warehouseId","typeLabel":"number"},"projectId":{"type":"number","description":"The project id of the item entry","example":1,"isRequired":true,"uniqueKey":"entries.items.[INDEX].projectId","typeLabel":"number"},"projectRefId":{"type":"number","description":"The project ref id of the item entry","example":1,"isRequired":true,"uniqueKey":"entries.items.[INDEX].projectRefId","typeLabel":"number"},"projectRefType":{"type":"string","description":"The project ref type of the item entry","example":"TASK","isRequired":true,"uniqueKey":"entries.items.[INDEX].projectRefType","typeLabel":"string"},"projectRefInvoicedAmount":{"type":"number","description":"The project ref invoiced amount of the item entry","example":100,"isRequired":true,"uniqueKey":"entries.items.[INDEX].projectRefInvoicedAmount","typeLabel":"number"},"sellAccountId":{"type":"number","description":"The sell account id of the item entry","example":1020,"isRequired":true,"uniqueKey":"entries.items.[INDEX].sellAccountId","typeLabel":"number"},"costAccountId":{"type":"number","description":"The cost account id of the item entry","example":1021,"isRequired":true,"uniqueKey":"entries.items.[INDEX].costAccountId","typeLabel":"number"}},"required":["index","itemId","rate","quantity","discount","discountType","description","taxCode","taxRateId","warehouseId","projectId","projectRefId","projectRefType","projectRefInvoicedAmount","sellAccountId","costAccountId"],"uniqueKey":"entries.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"entries","typeLabel":"object[]"},"attachments":{"description":"The attachments of the sale receipt","example":[{"key":"123456"}],"type":"array","items":{"type":"string","uniqueKey":"attachments.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"attachments","typeLabel":"string[]"},"invoiceNo":{"type":"string","description":"Invoice number","example":"INV-001","uniqueKey":"invoiceNo","typeLabel":"string"},"referenceNo":{"type":"string","description":"Reference number","example":"REF-001","uniqueKey":"referenceNo","typeLabel":"string"},"delivered":{"type":"boolean","description":"Whether the invoice is delivered","default":false,"uniqueKey":"delivered","typeLabel":"boolean"},"invoiceMessage":{"type":"string","description":"Invoice message","example":"Thank you for your business","uniqueKey":"invoiceMessage","typeLabel":"string"},"termsConditions":{"type":"string","description":"Terms and conditions","example":"Payment due within 14 days","uniqueKey":"termsConditions","typeLabel":"string"},"exchangeRate":{"type":"number","description":"Exchange rate","minimum":0,"example":1,"uniqueKey":"exchangeRate","typeLabel":"number"},"warehouseId":{"type":"number","description":"Warehouse ID","example":1,"uniqueKey":"warehouseId","typeLabel":"number"},"branchId":{"type":"number","description":"Branch ID","example":1,"uniqueKey":"branchId","typeLabel":"number"},"projectId":{"type":"number","description":"Project ID","example":1,"uniqueKey":"projectId","typeLabel":"number"},"isInclusiveTax":{"type":"boolean","description":"Whether tax is inclusive","example":false,"uniqueKey":"isInclusiveTax","typeLabel":"boolean"},"pdfTemplateId":{"type":"number","description":"PDF template ID","example":1,"uniqueKey":"pdfTemplateId","typeLabel":"number"},"paymentMethods":{"description":"Payment methods","type":"array","items":{"type":"object","properties":{"paymentIntegrationId":{"type":"number","description":"The ID of the payment integration","example":1,"isRequired":true,"uniqueKey":"paymentMethods.items.[INDEX].paymentIntegrationId","typeLabel":"number"},"enable":{"type":"boolean","description":"Whether the payment method is enabled","example":true,"isRequired":true,"uniqueKey":"paymentMethods.items.[INDEX].enable","typeLabel":"boolean"}},"required":["paymentIntegrationId","enable"],"uniqueKey":"paymentMethods.items.[INDEX]","typeLabel":"object"},"uniqueKey":"paymentMethods","typeLabel":"object[]"},"discount":{"type":"number","description":"Discount value","example":10,"uniqueKey":"discount","typeLabel":"number"},"discountType":{"type":"string","description":"Discount type","enum":["percentage","amount"],"example":"percentage","uniqueKey":"discountType","typeLabel":"enum\u003cstring>"},"adjustment":{"type":"number","description":"Adjustment amount","example":5,"uniqueKey":"adjustment","typeLabel":"number"},"fromEstimateId":{"type":"number","description":"ID of the estimate this invoice is created from","example":1,"uniqueKey":"fromEstimateId","typeLabel":"number"}},"required":["customerId","invoiceDate","dueDate","entries","attachments"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"customerId":1,"invoiceDate":"2023-01-01T00:00:00Z","dueDate":"2023-01-15T00:00:00Z","entries":[{"index":1,"itemId":1,"rate":1,"quantity":1,"discount":1,"discountType":"percentage","description":"This is a description","taxCode":"123456","taxRateId":1,"warehouseId":1,"projectId":1,"projectRefId":1,"projectRefType":"TASK","projectRefInvoicedAmount":100,"sellAccountId":1020,"costAccountId":1021}],"attachments":[{"key":"123456"}],"invoiceNo":"INV-001","referenceNo":"REF-001","delivered":false,"invoiceMessage":"Thank you for your business","termsConditions":"Payment due within 14 days","exchangeRate":1,"warehouseId":1,"branchId":1,"projectId":1,"isInclusiveTax":false,"pdfTemplateId":1,"paymentMethods":[{"paymentIntegrationId":1,"enable":true}],"discount":10,"discountType":"percentage","adjustment":5,"fromEstimateId":1}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"d6572574-758a-452e-94ba-8bec34bacdfd":{"description":"Sale invoice edited successfully","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"2a079ca0-0eee-411f-9261-be805d9ffc01":{"description":"The sale invoice not found.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{},"servers":{}},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"bigcapital","siteName":"Bigcapital Docs","title":"Edit the given sale invoice. - Bigcapital Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-06T03:21:24.674Z","originalFileLocation":"api-reference/sale-invoices/edit-the-given-sale-invoice.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=\"dark\"}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=\"application-name\" content=\"Bigcapital Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bigcapital/mM0OGJJEhXNBXmeE/_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/bigcapital/mM0OGJJEhXNBXmeE/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bigcapital/mM0OGJJEhXNBXmeE/_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/bigcapital/mM0OGJJEhXNBXmeE/_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/bigcapital/mM0OGJJEhXNBXmeE/_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/bigcapital/mM0OGJJEhXNBXmeE/_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/bigcapital/mM0OGJJEhXNBXmeE/_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/bigcapital/mM0OGJJEhXNBXmeE/_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/bigcapital/mM0OGJJEhXNBXmeE/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Edit the given sale invoice. - Bigcapital Docs\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bigcapital Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.bigcapital.app/api-reference/sale-invoices/edit-the-given-sale-invoice\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bigcapital.mintlify.app/_mintlify/api/og/v2?division=Sale+Invoices\u0026amp;title=Edit+the+given+sale+invoice.\u0026amp;theme=27be8ea02fd0c64f8a62df23\u0026amp;signature=4f7843e1bc4896eb20a3795c7b0bdee19bf615de6842d5824707738499e4fe2d\">\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=\"Edit the given sale invoice. - Bigcapital Docs\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bigcapital.mintlify.app/_mintlify/api/og/v2?division=Sale+Invoices\u0026amp;title=Edit+the+given+sale+invoice.\u0026amp;theme=27be8ea02fd0c64f8a62df23\u0026amp;signature=4f7843e1bc4896eb20a3795c7b0bdee19bf615de6842d5824707738499e4fe2d\">\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/bigcapital/mM0OGJJEhXNBXmeE/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bigcapital Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#76A1FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.bigcapital.app/api-reference/sale-invoices/edit-the-given-sale-invoice\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/sale-invoices/edit-the-given-sale-invoice.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.bigcapital.app/#organization\",\"name\":\"Bigcapital Docs\",\"url\":\"https://docs.bigcapital.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bigcapital/WVY5ORu6xzXKmdxI/logo/light.svg?fit=max\u0026auto=format\u0026n=WVY5ORu6xzXKmdxI\u0026q=85\u0026s=bb81eb8e5af2fb5e066a47522688beb8\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.bigcapital.app#website\",\"name\":\"Bigcapital Docs\",\"url\":\"https://docs.bigcapital.app\",\"publisher\":{\"@id\":\"https://docs.bigcapital.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.bigcapital.app/api-reference/sale-invoices/edit-the-given-sale-invoice#webpage\",\"url\":\"https://docs.bigcapital.app/api-reference/sale-invoices/edit-the-given-sale-invoice\",\"name\":\"Edit the given sale invoice.\",\"dateModified\":\"2026-03-06T03:21:24.674Z\",\"isPartOf\":{\"@id\":\"https://docs.bigcapital.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bigcapital.app/api-reference/sale-invoices/edit-the-given-sale-invoice#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bigcapital.app/api-reference/sale-invoices/edit-the-given-sale-invoice#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.bigcapital.app/api-reference/get-apisystem_db\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Sale Invoices\",\"item\":\"https://docs.bigcapital.app/api-reference/sale-invoices/validates-which-sale-invoices-can-be-deleted-and-returns-the-results\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Edit the given sale invoice.\",\"item\":\"https://docs.bigcapital.app/api-reference/sale-invoices/edit-the-given-sale-invoice\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.bigcapital.app/api-reference/sale-invoices/edit-the-given-sale-invoice#apireference\",\"headline\":\"Edit the given sale invoice.\",\"name\":\"Edit the given sale invoice.\",\"url\":\"https://docs.bigcapital.app/api-reference/sale-invoices/edit-the-given-sale-invoice\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bigcapital.app/api-reference/sale-invoices/edit-the-given-sale-invoice#webpage\"},\"dateModified\":\"2026-03-06T03:21:24.674Z\",\"publisher\":{\"@id\":\"https://docs.bigcapital.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.bigcapital.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bigcapital Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Bigcapital Docs","nav":{"global":{"anchors":[{"anchor":"Community","icon":"discord","href":"https://discord.com/invite/c8nPBJafeb"},{"anchor":"Blog","icon":"newspaper","href":"https://bigcapital.app/blog"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"API Reference","pages":[{"group":"API Reference","pages":[{"title":"Get apisystem db","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/system_db","href":"/api-reference/get-apisystem_db"}]},{"group":"Auth","pages":[{"title":"Sign in a user","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/auth/signin","href":"/api-reference/auth/sign-in-a-user"},{"title":"Sign up a new user","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/auth/signup","href":"/api-reference/auth/sign-up-a-new-user"},{"title":"Confirm user signup","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/auth/signup/verify","href":"/api-reference/auth/confirm-user-signup"},{"title":"Send reset password email","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/auth/send_reset_password","href":"/api-reference/auth/send-reset-password-email"},{"title":"Reset password using token","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/auth/reset_password/{token}","href":"/api-reference/auth/reset-password-using-token"},{"title":"Get auth metadata (e.g. signup disabled)","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/auth/meta","href":"/api-reference/auth/get-auth-metadata-eg-signup-disabled"},{"title":"Resend the signup confirmation message","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/auth/signup/verify/resend","href":"/api-reference/auth/resend-the-signup-confirmation-message"},{"title":"Retrieve the authenticated account","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/auth/account","href":"/api-reference/auth/retrieve-the-authenticated-account"}]},{"group":"Api keys","pages":[{"title":"Generate a new API key","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/api-keys/generate","href":"/api-reference/api-keys/generate-a-new-api-key"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/api-keys/{id}/revoke","href":"/api-reference/api-keys/revoke-an-api-key"},{"title":"Get all API keys for the current tenant","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/api-keys","href":"/api-reference/api-keys/get-all-api-keys-for-the-current-tenant"}]},{"group":"Items","pages":[{"title":"Retrieves the item list.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/items","href":"/api-reference/items/retrieves-the-item-list"},{"title":"Create a new item (product or service).","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/items","href":"/api-reference/items/create-a-new-item-product-or-service"},{"title":"Get the given item (product or service).","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/items/{id}","href":"/api-reference/items/get-the-given-item-product-or-service"},{"title":"Edit the given item (product or service).","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/items/{id}","href":"/api-reference/items/edit-the-given-item-product-or-service"},{"title":"Delete the given item (product or service).","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/items/{id}","href":"/api-reference/items/delete-the-given-item-product-or-service"},{"title":"Validates which items can be deleted and returns counts of deletable and non-deletable items.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/items/validate-bulk-delete","href":"/api-reference/items/validates-which-items-can-be-deleted-and-returns-counts-of-deletable-and-non-deletable-items"},{"title":"Deletes multiple items in bulk.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/items/bulk-delete","href":"/api-reference/items/deletes-multiple-items-in-bulk"},{"title":"Inactivate the given item (product or service).","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /api/items/{id}/inactivate","href":"/api-reference/items/inactivate-the-given-item-product-or-service"},{"title":"Activate the given item (product or service).","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /api/items/{id}/activate","href":"/api-reference/items/activate-the-given-item-product-or-service"},{"title":"Retrieves the item associated invoices transactions.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/items/{id}/invoices","href":"/api-reference/items/retrieves-the-item-associated-invoices-transactions"},{"title":"Retrieves the item associated bills transactions.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/items/{id}/bills","href":"/api-reference/items/retrieves-the-item-associated-bills-transactions"},{"title":"Retrieves the item associated estimates transactions.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/items/{id}/estimates","href":"/api-reference/items/retrieves-the-item-associated-estimates-transactions"},{"title":"Retrieves the item associated receipts transactions.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/items/{id}/receipts","href":"/api-reference/items/retrieves-the-item-associated-receipts-transactions"}]},{"group":"Inventory Adjustments","pages":[{"title":"Create a quick inventory adjustment.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/inventory-adjustments/quick","href":"/api-reference/inventory-adjustments/create-a-quick-inventory-adjustment"},{"title":"Retrieves the inventory adjustment details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/inventory-adjustments/{id}","href":"/api-reference/inventory-adjustments/retrieves-the-inventory-adjustment-details"},{"title":"Delete the given inventory adjustment.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/inventory-adjustments/{id}","href":"/api-reference/inventory-adjustments/delete-the-given-inventory-adjustment"},{"title":"Retrieves the inventory adjustments.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/inventory-adjustments","href":"/api-reference/inventory-adjustments/retrieves-the-inventory-adjustments"},{"title":"Publish the given inventory adjustment.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/inventory-adjustments/{id}/publish","href":"/api-reference/inventory-adjustments/publish-the-given-inventory-adjustment"}]},{"group":"Branches","pages":[{"title":"Retrieves the branches.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/branches","href":"/api-reference/branches/retrieves-the-branches"},{"title":"Create a new branch.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/branches","href":"/api-reference/branches/create-a-new-branch"},{"title":"Retrieves the branch details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/branches/{id}","href":"/api-reference/branches/retrieves-the-branch-details"},{"title":"Edit the given branch.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/branches/{id}","href":"/api-reference/branches/edit-the-given-branch"},{"title":"Delete the given branch.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/branches/{id}","href":"/api-reference/branches/delete-the-given-branch"},{"title":"Activate the branches feature.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/branches/activate","href":"/api-reference/branches/activate-the-branches-feature"},{"title":"Mark the given branch as primary.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/branches/{id}/mark-as-primary","href":"/api-reference/branches/mark-the-given-branch-as-primary"}]},{"group":"Warehouses","pages":[{"title":"Get all warehouses","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/warehouses","href":"/api-reference/warehouses/get-all-warehouses"},{"title":"Create a warehouse","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/warehouses","href":"/api-reference/warehouses/create-a-warehouse"},{"title":"Get a warehouse","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/warehouses/{id}","href":"/api-reference/warehouses/get-a-warehouse"},{"title":"Put apiwarehouses","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/warehouses/{id}","href":"/api-reference/warehouses/put-apiwarehouses"},{"title":"Delete a warehouse","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/warehouses/{id}","href":"/api-reference/warehouses/delete-a-warehouse"},{"title":"Activate a warehouse","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/warehouses/activate","href":"/api-reference/warehouses/activate-a-warehouse"},{"title":"Mark a warehouse as primary","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/warehouses/{id}/mark-primary","href":"/api-reference/warehouses/mark-a-warehouse-as-primary"},{"title":"Retrieves the item associated warehouses.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/items/{id}/warehouses","href":"/api-reference/warehouses/retrieves-the-item-associated-warehouses"}]},{"group":"Accounts","pages":[{"title":"Validates which accounts can be deleted and returns counts of deletable and non-deletable accounts.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/accounts/validate-bulk-delete","href":"/api-reference/accounts/validates-which-accounts-can-be-deleted-and-returns-counts-of-deletable-and-non-deletable-accounts"},{"title":"Deletes multiple accounts in bulk.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/accounts/bulk-delete","href":"/api-reference/accounts/deletes-multiple-accounts-in-bulk"},{"title":"Retrieves the accounts.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/accounts","href":"/api-reference/accounts/retrieves-the-accounts"},{"title":"Create an account","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/accounts","href":"/api-reference/accounts/create-an-account"},{"title":"Retrieves the account details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/accounts/{id}","href":"/api-reference/accounts/retrieves-the-account-details"},{"title":"Edit the given account.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/accounts/{id}","href":"/api-reference/accounts/edit-the-given-account"},{"title":"Delete the given account.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/accounts/{id}","href":"/api-reference/accounts/delete-the-given-account"},{"title":"Activate the given account.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/accounts/{id}/activate","href":"/api-reference/accounts/activate-the-given-account"},{"title":"Inactivate the given account.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/accounts/{id}/inactivate","href":"/api-reference/accounts/inactivate-the-given-account"},{"title":"Retrieves the account types.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/accounts/types","href":"/api-reference/accounts/retrieves-the-account-types"},{"title":"Retrieves the account transactions.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/accounts/transactions","href":"/api-reference/accounts/retrieves-the-account-transactions"}]},{"group":"Inventory Cost","pages":[{"title":"Get items inventory valuation list","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/inventory-cost/items","href":"/api-reference/inventory-cost/get-items-inventory-valuation-list"}]},{"group":"Sale Invoices","pages":[{"title":"Validates which sale invoices can be deleted and returns the results.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-invoices/validate-bulk-delete","href":"/api-reference/sale-invoices/validates-which-sale-invoices-can-be-deleted-and-returns-the-results"},{"title":"Deletes multiple sale invoices.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-invoices/bulk-delete","href":"/api-reference/sale-invoices/deletes-multiple-sale-invoices"},{"title":"Retrieves the sale invoices.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-invoices","href":"/api-reference/sale-invoices/retrieves-the-sale-invoices"},{"title":"Create a new sale invoice.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-invoices","href":"/api-reference/sale-invoices/create-a-new-sale-invoice"},{"title":"Retrieves the sale invoice mail state.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-invoices/{id}/mail","href":"/api-reference/sale-invoices/retrieves-the-sale-invoice-mail-state"},{"title":"Send the sale invoice mail.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-invoices/{id}/mail","href":"/api-reference/sale-invoices/send-the-sale-invoice-mail"},{"title":"Retrieves the sale invoice details.","description":null,"deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-invoices/{id}","href":"/api-reference/sale-invoices/retrieves-the-sale-invoice-details"},{"title":"Edit the given sale invoice.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/sale-invoices/{id}","href":"/api-reference/sale-invoices/edit-the-given-sale-invoice"},{"title":"Delete the given sale invoice.","description":null,"deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/sale-invoices/{id}","href":"/api-reference/sale-invoices/delete-the-given-sale-invoice"},{"title":"Retrieves the receivable sale invoices.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-invoices/receivable","href":"/api-reference/sale-invoices/retrieves-the-receivable-sale-invoices"},{"title":"Retrieves the sale invoice state.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-invoices/state","href":"/api-reference/sale-invoices/retrieves-the-sale-invoice-state"},{"title":"Deliver the given sale invoice.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/sale-invoices/{id}/deliver","href":"/api-reference/sale-invoices/deliver-the-given-sale-invoice"},{"title":"Write off the given sale invoice.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-invoices/{id}/writeoff","href":"/api-reference/sale-invoices/write-off-the-given-sale-invoice"},{"title":"Cancel the written off sale invoice.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-invoices/{id}/cancel-writeoff","href":"/api-reference/sale-invoices/cancel-the-written-off-sale-invoice"},{"title":"Retrieves the sale invoice payments.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-invoices/{id}/payments","href":"/api-reference/sale-invoices/retrieves-the-sale-invoice-payments"},{"title":"Retrieves the sale invoice HTML.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-invoices/{id}/html","href":"/api-reference/sale-invoices/retrieves-the-sale-invoice-html"},{"title":"Generate sharable sale invoice link (private or public)","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-invoices/{id}/generate-link","href":"/api-reference/sale-invoices/generate-sharable-sale-invoice-link-private-or-public"}]},{"group":"Pdf Templates","pages":[{"title":"Retrieves the PDF templates.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/pdf-templates","href":"/api-reference/pdf-templates/retrieves-the-pdf-templates"},{"title":"Create a new PDF template.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/pdf-templates","href":"/api-reference/pdf-templates/create-a-new-pdf-template"},{"title":"Retrieves the PDF template details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/pdf-templates/{id}","href":"/api-reference/pdf-templates/retrieves-the-pdf-template-details"},{"title":"Edit the given PDF template.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/pdf-templates/{id}","href":"/api-reference/pdf-templates/edit-the-given-pdf-template"},{"title":"Delete the given PDF template.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/pdf-templates/{id}","href":"/api-reference/pdf-templates/delete-the-given-pdf-template"},{"title":"Retrieves the PDF template branding state.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/pdf-templates/state","href":"/api-reference/pdf-templates/retrieves-the-pdf-template-branding-state"},{"title":"Assign the given PDF template as default.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/pdf-templates/{id}/assign-default","href":"/api-reference/pdf-templates/assign-the-given-pdf-template-as-default"}]},{"group":"Attachments","pages":[{"title":"Upload attachment to S3","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/attachments","href":"/api-reference/attachments/upload-attachment-to-s3"},{"title":"Get attachment by ID","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/attachments/{id}","href":"/api-reference/attachments/get-attachment-by-id"},{"title":"Delete attachment by ID","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/attachments/{id}","href":"/api-reference/attachments/delete-attachment-by-id"},{"title":"Link attachment to a model","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/attachments/{id}/link","href":"/api-reference/attachments/link-attachment-to-a-model"},{"title":"Unlink attachment from a model","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/attachments/{id}/unlink","href":"/api-reference/attachments/unlink-attachment-from-a-model"},{"title":"Get presigned URL for attachment","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/attachments/{id}/presigned-url","href":"/api-reference/attachments/get-presigned-url-for-attachment"}]},{"group":"Tax Rates","pages":[{"title":"Retrieves the tax rates.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/tax-rates","href":"/api-reference/tax-rates/retrieves-the-tax-rates"},{"title":"Create a new tax rate.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/tax-rates","href":"/api-reference/tax-rates/create-a-new-tax-rate"},{"title":"Retrieves the tax rate details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/tax-rates/{id}","href":"/api-reference/tax-rates/retrieves-the-tax-rate-details"},{"title":"Edit the given tax rate.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/tax-rates/{id}","href":"/api-reference/tax-rates/edit-the-given-tax-rate"},{"title":"Delete the given tax rate.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/tax-rates/{id}","href":"/api-reference/tax-rates/delete-the-given-tax-rate"},{"title":"Activate the given tax rate.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/tax-rates/{id}/activate","href":"/api-reference/tax-rates/activate-the-given-tax-rate"},{"title":"Inactivate the given tax rate.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/tax-rates/{id}/inactivate","href":"/api-reference/tax-rates/inactivate-the-given-tax-rate"}]},{"group":"Payments Received","pages":[{"title":"Get apipayments received mail","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/payments-received/{id}/mail","href":"/api-reference/payments-received/get-apipayments-received-mail"},{"title":"Post apipayments received mail","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/payments-received/{id}/mail","href":"/api-reference/payments-received/post-apipayments-received-mail"},{"title":"Get apipayments received edit page","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/payments-received/{id}/edit-page","href":"/api-reference/payments-received/get-apipayments-received-edit-page"},{"title":"Retrieves the payment received list.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/payments-received","href":"/api-reference/payments-received/retrieves-the-payment-received-list"},{"title":"Create a new payment received.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/payments-received","href":"/api-reference/payments-received/create-a-new-payment-received"},{"title":"Retrieves the payment received details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/payments-received/{id}","href":"/api-reference/payments-received/retrieves-the-payment-received-details"},{"title":"Edit the given payment received.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/payments-received/{id}","href":"/api-reference/payments-received/edit-the-given-payment-received"},{"title":"Delete the given payment received.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/payments-received/{id}","href":"/api-reference/payments-received/delete-the-given-payment-received"},{"title":"Validates which payments received can be deleted and returns the results.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/payments-received/validate-bulk-delete","href":"/api-reference/payments-received/validates-which-payments-received-can-be-deleted-and-returns-the-results"},{"title":"Deletes multiple payments received.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/payments-received/bulk-delete","href":"/api-reference/payments-received/deletes-multiple-payments-received"},{"title":"Retrieves the payment received state.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/payments-received/state","href":"/api-reference/payments-received/retrieves-the-payment-received-state"},{"title":"Retrieves the payment received invoices.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/payments-received/{id}/invoices","href":"/api-reference/payments-received/retrieves-the-payment-received-invoices"}]},{"group":"Import","pages":[{"title":"Upload import file","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/import/file","href":"/api-reference/import/upload-import-file"},{"title":"Map import columns","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/import/{import_id}/mapping","href":"/api-reference/import/map-import-columns"},{"title":"Preview import data","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/import/{import_id}/preview","href":"/api-reference/import/preview-import-data"},{"title":"Process import","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/import/{import_id}/import","href":"/api-reference/import/process-import"},{"title":"Get import sample","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/import/sample","href":"/api-reference/import/get-import-sample"},{"title":"Get import metadata","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/import/{import_id}","href":"/api-reference/import/get-import-metadata"}]},{"group":"resources","pages":[{"title":"Retrieves the resource meta","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/resources/{resourceModel}/meta","href":"/api-reference/resources/retrieves-the-resource-meta"}]},{"group":"Payment Links","pages":[{"title":"Get payment link public metadata","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/payment-links/{paymentLinkId}/invoice","href":"/api-reference/payment-links/get-payment-link-public-metadata"},{"title":"Create Stripe checkout session","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/payment-links/{paymentLinkId}/stripe_checkout_session","href":"/api-reference/payment-links/create-stripe-checkout-session"},{"title":"Get payment link invoice PDF","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/payment-links/{paymentLinkId}/invoice/pdf","href":"/api-reference/payment-links/get-payment-link-invoice-pdf"}]},{"group":"stripe","pages":[{"title":"Get apistripelink","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/stripe/link","href":"/api-reference/stripe/get-apistripelink"},{"title":"Post apistripecallback","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/stripe/callback","href":"/api-reference/stripe/post-apistripecallback"},{"title":"Post apistripeaccount link","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/stripe/account_link","href":"/api-reference/stripe/post-apistripeaccount_link"},{"title":"Listen to Stripe webhooks","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/webhooks/stripe","href":"/api-reference/stripe/listen-to-stripe-webhooks"}]},{"group":"Item Categories","pages":[{"title":"Retrieves the item categories.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/item-categories","href":"/api-reference/item-categories/retrieves-the-item-categories"},{"title":"Create a new item category.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/item-categories","href":"/api-reference/item-categories/create-a-new-item-category"},{"title":"Retrieves the item category details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/item-categories/{id}","href":"/api-reference/item-categories/retrieves-the-item-category-details"},{"title":"Edit the given item category.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/item-categories/{id}","href":"/api-reference/item-categories/edit-the-given-item-category"},{"title":"Delete the given item category.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/item-categories/{id}","href":"/api-reference/item-categories/delete-the-given-item-category"}]},{"group":"Expenses","pages":[{"title":"Validate which expenses can be deleted and return the results.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/expenses/validate-bulk-delete","href":"/api-reference/expenses/validate-which-expenses-can-be-deleted-and-return-the-results"},{"title":"Deletes multiple expenses.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/expenses/bulk-delete","href":"/api-reference/expenses/deletes-multiple-expenses"},{"title":"Get the expense transactions.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/expenses","href":"/api-reference/expenses/get-the-expense-transactions"},{"title":"Create a new expense transaction.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/expenses","href":"/api-reference/expenses/create-a-new-expense-transaction"},{"title":"Get the expense transaction details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/expenses/{id}","href":"/api-reference/expenses/get-the-expense-transaction-details"},{"title":"Edit the given expense transaction.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/expenses/{id}","href":"/api-reference/expenses/edit-the-given-expense-transaction"},{"title":"Delete the given expense transaction.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/expenses/{id}","href":"/api-reference/expenses/delete-the-given-expense-transaction"},{"title":"Publish the given expense transaction.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/expenses/{id}/publish","href":"/api-reference/expenses/publish-the-given-expense-transaction"}]},{"group":"Warehouse Transfers","pages":[{"title":"Retrieve warehouse transfer transactions with pagination.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/warehouse-transfers","href":"/api-reference/warehouse-transfers/retrieve-warehouse-transfer-transactions-with-pagination"},{"title":"Create a new warehouse transfer transaction.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/warehouse-transfers","href":"/api-reference/warehouse-transfers/create-a-new-warehouse-transfer-transaction"},{"title":"Retrieve warehouse transfer transaction details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/warehouse-transfers/{id}","href":"/api-reference/warehouse-transfers/retrieve-warehouse-transfer-transaction-details"},{"title":"Edit the given warehouse transfer transaction.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/warehouse-transfers/{id}","href":"/api-reference/warehouse-transfers/edit-the-given-warehouse-transfer-transaction"},{"title":"Delete the given warehouse transfer transaction.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/warehouse-transfers/{id}","href":"/api-reference/warehouse-transfers/delete-the-given-warehouse-transfer-transaction"},{"title":"Initiate the given warehouse transfer.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/warehouse-transfers/{id}/initiate","href":"/api-reference/warehouse-transfers/initiate-the-given-warehouse-transfer"},{"title":"Mark the given warehouse transfer as transferred.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/warehouse-transfers/{id}/transferred","href":"/api-reference/warehouse-transfers/mark-the-given-warehouse-transfer-as-transferred"}]},{"group":"Customers","pages":[{"title":"Retrieves the customer details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/customers/{id}","href":"/api-reference/customers/retrieves-the-customer-details"},{"title":"Edit the given customer.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/customers/{id}","href":"/api-reference/customers/edit-the-given-customer"},{"title":"Delete the given customer.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/customers/{id}","href":"/api-reference/customers/delete-the-given-customer"},{"title":"Retrieves the customers paginated list.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/customers","href":"/api-reference/customers/retrieves-the-customers-paginated-list"},{"title":"Create a new customer.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/customers","href":"/api-reference/customers/create-a-new-customer"},{"title":"Edit the opening balance of the given customer.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/customers/{id}/opening-balance","href":"/api-reference/customers/edit-the-opening-balance-of-the-given-customer"},{"title":"Validates which customers can be deleted and returns counts of deletable and non-deletable customers.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/customers/validate-bulk-delete","href":"/api-reference/customers/validates-which-customers-can-be-deleted-and-returns-counts-of-deletable-and-non-deletable-customers"},{"title":"Deletes multiple customers in bulk.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/customers/bulk-delete","href":"/api-reference/customers/deletes-multiple-customers-in-bulk"}]},{"group":"Vendors","pages":[{"title":"Retrieves the vendors.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/vendors","href":"/api-reference/vendors/retrieves-the-vendors"},{"title":"Create a new vendor.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/vendors","href":"/api-reference/vendors/create-a-new-vendor"},{"title":"Retrieves the vendor details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/vendors/{id}","href":"/api-reference/vendors/retrieves-the-vendor-details"},{"title":"Edit the given vendor.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/vendors/{id}","href":"/api-reference/vendors/edit-the-given-vendor"},{"title":"Delete the given vendor.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/vendors/{id}","href":"/api-reference/vendors/delete-the-given-vendor"},{"title":"Edit the given vendor opening balance.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/vendors/{id}/opening-balance","href":"/api-reference/vendors/edit-the-given-vendor-opening-balance"},{"title":"Validates which vendors can be deleted and returns counts of deletable and non-deletable vendors.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/vendors/validate-bulk-delete","href":"/api-reference/vendors/validates-which-vendors-can-be-deleted-and-returns-counts-of-deletable-and-non-deletable-vendors"},{"title":"Deletes multiple vendors in bulk.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/vendors/bulk-delete","href":"/api-reference/vendors/deletes-multiple-vendors-in-bulk"}]},{"group":"Sale Estimates","pages":[{"title":"Validates which sale estimates can be deleted and returns the results.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-estimates/validate-bulk-delete","href":"/api-reference/sale-estimates/validates-which-sale-estimates-can-be-deleted-and-returns-the-results"},{"title":"Deletes multiple sale estimates.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-estimates/bulk-delete","href":"/api-reference/sale-estimates/deletes-multiple-sale-estimates"},{"title":"Retrieves the sale estimates.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-estimates","href":"/api-reference/sale-estimates/retrieves-the-sale-estimates"},{"title":"Create a new sale estimate.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-estimates","href":"/api-reference/sale-estimates/create-a-new-sale-estimate"},{"title":"Retrieves the sale estimate details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-estimates/{id}","href":"/api-reference/sale-estimates/retrieves-the-sale-estimate-details"},{"title":"Edit the given sale estimate.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/sale-estimates/{id}","href":"/api-reference/sale-estimates/edit-the-given-sale-estimate"},{"title":"Delete the given sale estimate.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/sale-estimates/{id}","href":"/api-reference/sale-estimates/delete-the-given-sale-estimate"},{"title":"Retrieves the sale estimate state.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-estimates/state","href":"/api-reference/sale-estimates/retrieves-the-sale-estimate-state"},{"title":"Deliver the given sale estimate.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-estimates/{id}/deliver","href":"/api-reference/sale-estimates/deliver-the-given-sale-estimate"},{"title":"Approve the given sale estimate.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/sale-estimates/{id}/approve","href":"/api-reference/sale-estimates/approve-the-given-sale-estimate"},{"title":"Reject the given sale estimate.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/sale-estimates/{id}/reject","href":"/api-reference/sale-estimates/reject-the-given-sale-estimate"},{"title":"Notify the given sale estimate by SMS.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-estimates/{id}/notify-sms","href":"/api-reference/sale-estimates/notify-the-given-sale-estimate-by-sms"},{"title":"Retrieves the sale estimate SMS details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-estimates/{id}/sms-details","href":"/api-reference/sale-estimates/retrieves-the-sale-estimate-sms-details"},{"title":"Retrieves the sale estimate mail state.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-estimates/{id}/mail","href":"/api-reference/sale-estimates/retrieves-the-sale-estimate-mail-state"},{"title":"Send the given sale estimate by mail.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-estimates/{id}/mail","href":"/api-reference/sale-estimates/send-the-given-sale-estimate-by-mail"}]},{"group":"Sale Receipts","pages":[{"title":"Validates which sale receipts can be deleted and returns the results.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-receipts/validate-bulk-delete","href":"/api-reference/sale-receipts/validates-which-sale-receipts-can-be-deleted-and-returns-the-results"},{"title":"Deletes multiple sale receipts.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-receipts/bulk-delete","href":"/api-reference/sale-receipts/deletes-multiple-sale-receipts"},{"title":"Retrieves the sale receipts paginated list","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-receipts","href":"/api-reference/sale-receipts/retrieves-the-sale-receipts-paginated-list"},{"title":"Create a new sale receipt.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-receipts","href":"/api-reference/sale-receipts/create-a-new-sale-receipt"},{"title":"Retrieves the sale receipt mail.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-receipts/{id}/mail","href":"/api-reference/sale-receipts/retrieves-the-sale-receipt-mail"},{"title":"Send the sale receipt mail.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-receipts/{id}/mail","href":"/api-reference/sale-receipts/send-the-sale-receipt-mail"},{"title":"Retrieves the sale receipt state.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-receipts/state","href":"/api-reference/sale-receipts/retrieves-the-sale-receipt-state"},{"title":"Retrieves the sale receipt details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/sale-receipts/{id}","href":"/api-reference/sale-receipts/retrieves-the-sale-receipt-details"},{"title":"Edit the given sale receipt.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/sale-receipts/{id}","href":"/api-reference/sale-receipts/edit-the-given-sale-receipt"},{"title":"Delete the given sale receipt.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/sale-receipts/{id}","href":"/api-reference/sale-receipts/delete-the-given-sale-receipt"},{"title":"Close the given sale receipt.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/sale-receipts/{id}/close","href":"/api-reference/sale-receipts/close-the-given-sale-receipt"}]},{"group":"Bills","pages":[{"title":"Validate which bills can be deleted and return the results.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/bills/validate-bulk-delete","href":"/api-reference/bills/validate-which-bills-can-be-deleted-and-return-the-results"},{"title":"Deletes multiple bills.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/bills/bulk-delete","href":"/api-reference/bills/deletes-multiple-bills"},{"title":"Retrieves the bills.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/bills","href":"/api-reference/bills/retrieves-the-bills"},{"title":"Create a new bill.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/bills","href":"/api-reference/bills/create-a-new-bill"},{"title":"Retrieves the bill details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/bills/{id}","href":"/api-reference/bills/retrieves-the-bill-details"},{"title":"Edit the given bill.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/bills/{id}","href":"/api-reference/bills/edit-the-given-bill"},{"title":"Delete the given bill.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/bills/{id}","href":"/api-reference/bills/delete-the-given-bill"},{"title":"Retrieve the specific bill associated payment transactions.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/bills/{id}/payment-transactions","href":"/api-reference/bills/retrieve-the-specific-bill-associated-payment-transactions"},{"title":"Open the given bill.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /api/bills/{id}/open","href":"/api-reference/bills/open-the-given-bill"},{"title":"Retrieves the due bills.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/bills/due","href":"/api-reference/bills/retrieves-the-due-bills"}]},{"group":"Landed Cost","pages":[{"title":"Get landed cost transactions","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/landed-cost/transactions","href":"/api-reference/landed-cost/get-landed-cost-transactions"},{"title":"Allocate landed cost to bill items","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/landed-cost/bills/{billId}/allocate","href":"/api-reference/landed-cost/allocate-landed-cost-to-bill-items"},{"title":"Delete allocated landed cost","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/landed-cost/{allocatedLandedCostId}","href":"/api-reference/landed-cost/delete-allocated-landed-cost"},{"title":"Get bill landed cost transactions","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/landed-cost/bills/{billId}/transactions","href":"/api-reference/landed-cost/get-bill-landed-cost-transactions"}]},{"group":"Manual Journals","pages":[{"title":"Validate which manual journals can be deleted and return the results.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/manual-journals/validate-bulk-delete","href":"/api-reference/manual-journals/validate-which-manual-journals-can-be-deleted-and-return-the-results"},{"title":"Deletes multiple manual journals.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/manual-journals/bulk-delete","href":"/api-reference/manual-journals/deletes-multiple-manual-journals"},{"title":"Retrieves the manual journals paginated list.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/manual-journals","href":"/api-reference/manual-journals/retrieves-the-manual-journals-paginated-list"},{"title":"Create a new manual journal.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/manual-journals","href":"/api-reference/manual-journals/create-a-new-manual-journal"},{"title":"Retrieves the manual journal details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/manual-journals/{id}","href":"/api-reference/manual-journals/retrieves-the-manual-journal-details"},{"title":"Edit the given manual journal.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/manual-journals/{id}","href":"/api-reference/manual-journals/edit-the-given-manual-journal"},{"title":"Delete the given manual journal.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/manual-journals/{id}","href":"/api-reference/manual-journals/delete-the-given-manual-journal"},{"title":"Publish the given manual journal.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /api/manual-journals/{id}/publish","href":"/api-reference/manual-journals/publish-the-given-manual-journal"}]},{"group":"Credit Notes","pages":[{"title":"Get all credit notes","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/credit-notes","href":"/api-reference/credit-notes/get-all-credit-notes"},{"title":"Create a new credit note","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/credit-notes","href":"/api-reference/credit-notes/create-a-new-credit-note"},{"title":"Get credit note state","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/credit-notes/state","href":"/api-reference/credit-notes/get-credit-note-state"},{"title":"Get a specific credit note by ID","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/credit-notes/{id}","href":"/api-reference/credit-notes/get-a-specific-credit-note-by-id"},{"title":"Update a credit note","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/credit-notes/{id}","href":"/api-reference/credit-notes/update-a-credit-note"},{"title":"Delete a credit note","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/credit-notes/{id}","href":"/api-reference/credit-notes/delete-a-credit-note"},{"title":"Open a credit note","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/credit-notes/{id}/open","href":"/api-reference/credit-notes/open-a-credit-note"},{"title":"Validates which credit notes can be deleted and returns the results.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/credit-notes/validate-bulk-delete","href":"/api-reference/credit-notes/validates-which-credit-notes-can-be-deleted-and-returns-the-results"},{"title":"Deletes multiple credit notes.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/credit-notes/bulk-delete","href":"/api-reference/credit-notes/deletes-multiple-credit-notes"}]},{"group":"Credit Note Refunds","pages":[{"title":"Retrieve the credit note graph.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/credit-notes/{creditNoteId}/refunds","href":"/api-reference/credit-note-refunds/retrieve-the-credit-note-graph"},{"title":"Create a refund for the given credit note.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/credit-notes/{creditNoteId}/refunds","href":"/api-reference/credit-note-refunds/create-a-refund-for-the-given-credit-note"},{"title":"Delete a refund for the given credit note.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/credit-notes/refunds/{refundCreditId}","href":"/api-reference/credit-note-refunds/delete-a-refund-for-the-given-credit-note"}]},{"group":"Credit Notes Apply Invoice","pages":[{"title":"Applied credit note to invoices","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/credit-notes/{creditNoteId}/applied-invoices","href":"/api-reference/credit-notes-apply-invoice/applied-credit-note-to-invoices"},{"title":"Get credit note associated invoices to apply","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/credit-notes/{creditNoteId}/apply-invoices","href":"/api-reference/credit-notes-apply-invoice/get-credit-note-associated-invoices-to-apply"},{"title":"Apply credit note to invoices","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/credit-notes/{creditNoteId}/apply-invoices","href":"/api-reference/credit-notes-apply-invoice/apply-credit-note-to-invoices"},{"title":"Delete applied credit note to invoice","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/credit-notes/applied-invoices/{applyCreditToInvoicesId}","href":"/api-reference/credit-notes-apply-invoice/delete-applied-credit-note-to-invoice"}]},{"group":"Vendor Credits","pages":[{"title":"Validates which vendor credits can be deleted and returns the results.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/vendor-credits/validate-bulk-delete","href":"/api-reference/vendor-credits/validates-which-vendor-credits-can-be-deleted-and-returns-the-results"},{"title":"Deletes multiple vendor credits.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/vendor-credits/bulk-delete","href":"/api-reference/vendor-credits/deletes-multiple-vendor-credits"},{"title":"Retrieves the vendor credits.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/vendor-credits","href":"/api-reference/vendor-credits/retrieves-the-vendor-credits"},{"title":"Create a new vendor credit.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/vendor-credits","href":"/api-reference/vendor-credits/create-a-new-vendor-credit"},{"title":"Open the given vendor credit.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/vendor-credits/{id}/open","href":"/api-reference/vendor-credits/open-the-given-vendor-credit"},{"title":"Retrieves the vendor credit details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/vendor-credits/{id}","href":"/api-reference/vendor-credits/retrieves-the-vendor-credit-details"},{"title":"Edit the given vendor credit.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/vendor-credits/{id}","href":"/api-reference/vendor-credits/edit-the-given-vendor-credit"},{"title":"Delete the given vendor credit.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/vendor-credits/{id}","href":"/api-reference/vendor-credits/delete-the-given-vendor-credit"}]},{"group":"Vendor Credits Apply Bills","pages":[{"title":"Get bills that can be applied with this vendor credit.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/vendor-credits/{vendorCreditId}/bills-to-apply","href":"/api-reference/vendor-credits-apply-bills/get-bills-that-can-be-applied-with-this-vendor-credit"},{"title":"Apply vendor credit to the given bills.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/vendor-credits/{vendorCreditId}/apply-to-bills","href":"/api-reference/vendor-credits-apply-bills/apply-vendor-credit-to-the-given-bills"},{"title":"Remove an applied bill from the vendor credit.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/vendor-credits/applied-bills/{vendorCreditAppliedBillId}","href":"/api-reference/vendor-credits-apply-bills/remove-an-applied-bill-from-the-vendor-credit"},{"title":"Get bills already applied to this vendor credit.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/vendor-credits/{vendorCreditId}/applied-bills","href":"/api-reference/vendor-credits-apply-bills/get-bills-already-applied-to-this-vendor-credit"}]},{"group":"Bill Payments","pages":[{"title":"Retrieves the bill payments list.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/bill-payments","href":"/api-reference/bill-payments/retrieves-the-bill-payments-list"},{"title":"Create a new bill payment.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/bill-payments","href":"/api-reference/bill-payments/create-a-new-bill-payment"},{"title":"Retrieves the bill payment details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/bill-payments/{billPaymentId}","href":"/api-reference/bill-payments/retrieves-the-bill-payment-details"},{"title":"Edit the given bill payment.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/bill-payments/{billPaymentId}","href":"/api-reference/bill-payments/edit-the-given-bill-payment"},{"title":"Delete the given bill payment.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/bill-payments/{billPaymentId}","href":"/api-reference/bill-payments/delete-the-given-bill-payment"},{"title":"Retrieves the payable entries of the new page once vendor be selected.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/bill-payments/new-page/entries","href":"/api-reference/bill-payments/retrieves-the-payable-entries-of-the-new-page-once-vendor-be-selected"},{"title":"Retrieves the bills of the given bill payment.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/bill-payments/{billPaymentId}/bills","href":"/api-reference/bill-payments/retrieves-the-bills-of-the-given-bill-payment"},{"title":"Retrieves the edit page of the given bill payment.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/bill-payments/{billPaymentId}/edit-page","href":"/api-reference/bill-payments/retrieves-the-edit-page-of-the-given-bill-payment"}]},{"group":"Vendor Credits Refunds","pages":[{"title":"Retrieve a refund vendor credit transaction by id.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/vendor-credits/refunds/{refundCreditId}","href":"/api-reference/vendor-credits-refunds/retrieve-a-refund-vendor-credit-transaction-by-id"},{"title":"Delete a refund for the given vendor credit.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/vendor-credits/refunds/{refundCreditId}","href":"/api-reference/vendor-credits-refunds/delete-a-refund-for-the-given-vendor-credit"},{"title":"Retrieve the vendor credit refunds graph.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/vendor-credits/{vendorCreditId}/refund","href":"/api-reference/vendor-credits-refunds/retrieve-the-vendor-credit-refunds-graph"},{"title":"Create a refund for the given vendor credit.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/vendor-credits/{vendorCreditId}/refund","href":"/api-reference/vendor-credits-refunds/create-a-refund-for-the-given-vendor-credit"}]},{"group":"Bank Accounts","pages":[{"title":"Retrieve the bank accounts.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/accounts","href":"/api-reference/bank-accounts/retrieve-the-bank-accounts"},{"title":"Retrieve the bank account summary.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/accounts/{bankAccountId}/summary","href":"/api-reference/bank-accounts/retrieve-the-bank-account-summary"},{"title":"Disconnect the bank connection of the given bank account.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/banking/accounts/{id}/disconnect","href":"/api-reference/bank-accounts/disconnect-the-bank-connection-of-the-given-bank-account"},{"title":"Refresh the bank account transactions.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/banking/accounts/{id}/refresh","href":"/api-reference/bank-accounts/refresh-the-bank-account-transactions"},{"title":"Pause transactions syncing of the given bank account.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/banking/accounts/{id}/pause","href":"/api-reference/bank-accounts/pause-transactions-syncing-of-the-given-bank-account"},{"title":"Resume transactions syncing of the given bank account.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/banking/accounts/{id}/resume","href":"/api-reference/bank-accounts/resume-transactions-syncing-of-the-given-bank-account"}]},{"group":"Banking Plaid","pages":[{"title":"Get Plaid link token","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/banking/plaid/link-token","href":"/api-reference/banking-plaid/get-plaid-link-token"},{"title":"Exchange Plaid access token","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/banking/plaid/exchange-token","href":"/api-reference/banking-plaid/exchange-plaid-access-token"}]},{"group":"banking-plaid","pages":[{"title":"Listen to Plaid webhooks","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/banking/plaid/webhooks","href":"/api-reference/banking-plaid/listen-to-plaid-webhooks"}]},{"group":"Banking Categorization","pages":[{"title":"Categorize bank transactions.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/banking/categorize","href":"/api-reference/banking-categorization/categorize-bank-transactions"},{"title":"Uncategorize bank transactions in bulk.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/banking/categorize/bulk","href":"/api-reference/banking-categorization/uncategorize-bank-transactions-in-bulk"},{"title":"Uncategorize a bank transaction.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/banking/categorize/{id}","href":"/api-reference/banking-categorization/uncategorize-a-bank-transaction"}]},{"group":"Banking Transactions","pages":[{"title":"Get bank account transactions","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/transactions","href":"/api-reference/banking-transactions/get-bank-account-transactions"},{"title":"Create a new bank transaction","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/banking/transactions","href":"/api-reference/banking-transactions/create-a-new-bank-transaction"},{"title":"Get a specific bank transaction by ID","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/transactions/{id}","href":"/api-reference/banking-transactions/get-a-specific-bank-transaction-by-id"},{"title":"Delete a bank transaction","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/banking/transactions/{id}","href":"/api-reference/banking-transactions/delete-a-bank-transaction"},{"title":"Exclude the given bank transactions.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/banking/exclude/bulk","href":"/api-reference/banking-transactions/exclude-the-given-bank-transactions"},{"title":"Unexclude the given bank transactions.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/banking/exclude/bulk","href":"/api-reference/banking-transactions/unexclude-the-given-bank-transactions"},{"title":"Retrieves the excluded bank transactions.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/exclude","href":"/api-reference/banking-transactions/retrieves-the-excluded-bank-transactions"},{"title":"Exclude the given bank transaction.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/banking/exclude/{id}","href":"/api-reference/banking-transactions/exclude-the-given-bank-transaction"},{"title":"Unexclude the given bank transaction.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/banking/exclude/{id}","href":"/api-reference/banking-transactions/unexclude-the-given-bank-transaction"}]},{"group":"Banking Uncategorized Transactions","pages":[{"title":"Get autofill values for categorize transactions","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/uncategorized/autofill","href":"/api-reference/banking-uncategorized-transactions/get-autofill-values-for-categorize-transactions"},{"title":"Get uncategorized transactions for a specific bank account","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/uncategorized/accounts/{accountId}","href":"/api-reference/banking-uncategorized-transactions/get-uncategorized-transactions-for-a-specific-bank-account"},{"title":"Get a specific uncategorized transaction by ID","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/uncategorized/{uncategorizedTransactionId}","href":"/api-reference/banking-uncategorized-transactions/get-a-specific-uncategorized-transaction-by-id"}]},{"group":"Banking Pending Transactions","pages":[{"title":"Get pending bank account transactions","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/pending","href":"/api-reference/banking-pending-transactions/get-pending-bank-account-transactions"}]},{"group":"Bank Rules","pages":[{"title":"Retrieves the bank rules.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/rules","href":"/api-reference/bank-rules/retrieves-the-bank-rules"},{"title":"Create a new bank rule.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/banking/rules","href":"/api-reference/bank-rules/create-a-new-bank-rule"},{"title":"Retrieves the bank rule details.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/rules/{id}","href":"/api-reference/bank-rules/retrieves-the-bank-rule-details"},{"title":"Edit the given bank rule.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/banking/rules/{id}","href":"/api-reference/bank-rules/edit-the-given-bank-rule"},{"title":"Delete the given bank rule.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/banking/rules/{id}","href":"/api-reference/bank-rules/delete-the-given-bank-rule"}]},{"group":"Banking Recognized Transactions","pages":[{"title":"Get recognized transaction","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/recognized/{recognizedTransactionId}","href":"/api-reference/banking-recognized-transactions/get-recognized-transaction"},{"title":"Get a list of recognized transactions","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/recognized","href":"/api-reference/banking-recognized-transactions/get-a-list-of-recognized-transactions"}]},{"group":"Banking Transactions Matching","pages":[{"title":"Retrieves the matched transactions.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/banking/matching/matched","href":"/api-reference/banking-transactions-matching/retrieves-the-matched-transactions"},{"title":"Match the given uncategorized transaction.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/banking/matching/match","href":"/api-reference/banking-transactions-matching/match-the-given-uncategorized-transaction"},{"title":"Unmatch the given uncategorized transaction.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /api/banking/matching/unmatch/{uncategorizedTransactionId}","href":"/api-reference/banking-transactions-matching/unmatch-the-given-uncategorized-transaction"}]},{"group":"Transactions Locking","pages":[{"title":"Lock all transactions for a module or all modules","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/transactions-locking/lock","href":"/api-reference/transactions-locking/lock-all-transactions-for-a-module-or-all-modules"},{"title":"Cancel all transactions locking for a module or all modules","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/transactions-locking/cancel-lock","href":"/api-reference/transactions-locking/cancel-all-transactions-locking-for-a-module-or-all-modules"},{"title":"Partial unlock all transactions locking for a module or all modules","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/transactions-locking/unlock-partial","href":"/api-reference/transactions-locking/partial-unlock-all-transactions-locking-for-a-module-or-all-modules"},{"title":"Cancel partial unlocking all transactions locking for a module or all modules","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/transactions-locking/cancel-unlock-partial","href":"/api-reference/transactions-locking/cancel-partial-unlocking-all-transactions-locking-for-a-module-or-all-modules"},{"title":"Get all transactions locking meta","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/transactions-locking","href":"/api-reference/transactions-locking/get-all-transactions-locking-meta"},{"title":"Get transactions locking meta for a module","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/transactions-locking/{module}","href":"/api-reference/transactions-locking/get-transactions-locking-meta-for-a-module"}]},{"group":"Settings","pages":[{"title":"Retrieves the settings.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/settings","href":"/api-reference/settings/retrieves-the-settings"},{"title":"Save the given settings.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/settings","href":"/api-reference/settings/save-the-given-settings"}]},{"group":"Reports","pages":[{"title":"Get balance sheet statement","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/balance-sheet","href":"/api-reference/reports/get-balance-sheet-statement"},{"title":"Get purchases by items report","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/purchases-by-items","href":"/api-reference/reports/get-purchases-by-items-report"},{"title":"Get customer balance summary report","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/customer-balance-summary","href":"/api-reference/reports/get-customer-balance-summary-report"},{"title":"Get vendor balance summary","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/vendor-balance-summary","href":"/api-reference/reports/get-vendor-balance-summary"},{"title":"Sales by items report","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/sales-by-items","href":"/api-reference/reports/sales-by-items-report"},{"title":"Get general ledger report","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/general-ledger","href":"/api-reference/reports/get-general-ledger-report"},{"title":"Get trial balance sheet","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/trial-balance-sheet","href":"/api-reference/reports/get-trial-balance-sheet"},{"title":"Get transactions by vendor","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/transactions-by-vendors","href":"/api-reference/reports/get-transactions-by-vendor"},{"title":"Get transactions by customer","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/transactions-by-customers","href":"/api-reference/reports/get-transactions-by-customer"},{"title":"Get transactions by reference","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/transactions-by-reference","href":"/api-reference/reports/get-transactions-by-reference"},{"title":"Get receivable aging summary","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/receivable-aging-summary","href":"/api-reference/reports/get-receivable-aging-summary"},{"title":"Get payable aging summary","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/payable-aging-summary","href":"/api-reference/reports/get-payable-aging-summary"},{"title":"Get inventory item details","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/inventory-item-details","href":"/api-reference/reports/get-inventory-item-details"},{"title":"Retrieves the inventory valuation sheet","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/inventory-valuation","href":"/api-reference/reports/retrieves-the-inventory-valuation-sheet"},{"title":"Get sales tax liability summary report","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/sales-tax-liability-summary","href":"/api-reference/reports/get-sales-tax-liability-summary-report"},{"title":"Journal report","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/journal","href":"/api-reference/reports/journal-report"},{"title":"Get profit/loss statement report","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/profit-loss-sheet","href":"/api-reference/reports/get-profitloss-statement-report"},{"title":"Get cashflow statement report","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/reports/cashflow-statement","href":"/api-reference/reports/get-cashflow-statement-report"}]},{"group":"Dashboard","pages":[{"title":"Get dashboard boot metadata","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/dashboard/boot","href":"/api-reference/dashboard/get-dashboard-boot-metadata"}]},{"group":"Roles","pages":[{"title":"Get all roles","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/roles","href":"/api-reference/roles/get-all-roles"},{"title":"Create a new role","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/roles","href":"/api-reference/roles/create-a-new-role"},{"title":"Get a specific role by ID","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/roles/{id}","href":"/api-reference/roles/get-a-specific-role-by-id"},{"title":"Edit an existing role","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/roles/{id}","href":"/api-reference/roles/edit-an-existing-role"},{"title":"Delete a role","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/roles/{id}","href":"/api-reference/roles/delete-a-role"},{"title":"Get role permissions schema","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/roles/permissions/schema","href":"/api-reference/roles/get-role-permissions-schema"}]},{"group":"Subscriptions","pages":[{"title":"Get all subscriptions for the current tenant","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/subscription","href":"/api-reference/subscriptions/get-all-subscriptions-for-the-current-tenant"},{"title":"Get LemonSqueezy checkout URL","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/subscription/lemon/checkout_url","href":"/api-reference/subscriptions/get-lemonsqueezy-checkout-url"},{"title":"Cancel the current organization subscription","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/subscription/cancel","href":"/api-reference/subscriptions/cancel-the-current-organization-subscription"},{"title":"Resume the current organization subscription","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/subscription/resume","href":"/api-reference/subscriptions/resume-the-current-organization-subscription"},{"title":"Change the subscription plan of the current organization","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/subscription/change","href":"/api-reference/subscriptions/change-the-subscription-plan-of-the-current-organization"},{"title":"Post apiwebhookslemon","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/webhooks/lemon","href":"/api-reference/subscriptions/post-apiwebhookslemon"}]},{"group":"Organization","pages":[{"title":"Build organization database","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/organization/build","href":"/api-reference/organization/build-organization-database"},{"title":"Gets the organization build job details","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/organization/build/{buildJobId}","href":"/api-reference/organization/gets-the-organization-build-job-details"},{"title":"Get current organization","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/organization/current","href":"/api-reference/organization/get-current-organization"},{"title":"Get apiorganizationbase currency mutate","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/organization/base-currency-mutate","href":"/api-reference/organization/get-apiorganizationbase-currency-mutate"},{"title":"Update organization information","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/organization","href":"/api-reference/organization/update-organization-information"}]},{"group":"Payment Services","pages":[{"title":"Get apipayment services","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/payment-services","href":"/api-reference/payment-services/get-apipayment-services"},{"title":"Get apipayment servicesstate","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/payment-services/state","href":"/api-reference/payment-services/get-apipayment-servicesstate"},{"title":"Get apipayment services 1","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/payment-services/{paymentServiceId}","href":"/api-reference/payment-services/get-apipayment-services-1"},{"title":"Post apipayment services","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/payment-services/{paymentMethodId}","href":"/api-reference/payment-services/post-apipayment-services"},{"title":"Delete apipayment services","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/payment-services/{paymentMethodId}","href":"/api-reference/payment-services/delete-apipayment-services"}]},{"group":"Export","pages":[{"title":"Retrieves exported the given resource.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/export","href":"/api-reference/export/retrieves-exported-the-given-resource"}]},{"group":"Views","pages":[{"title":"Get the given resource views","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/views/resource/{resourceModel}","href":"/api-reference/views/get-the-given-resource-views"}]},{"group":"Currencies","pages":[{"title":"Get all currencies","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/currencies","href":"/api-reference/currencies/get-all-currencies"},{"title":"Create a new currency","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/currencies","href":"/api-reference/currencies/create-a-new-currency"},{"title":"Edit an existing currency","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/currencies/{id}","href":"/api-reference/currencies/edit-an-existing-currency"},{"title":"Delete a currency by code","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/currencies/{code}","href":"/api-reference/currencies/delete-a-currency-by-code"},{"title":"Get a currency by code","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/currencies/{currencyCode}","href":"/api-reference/currencies/get-a-currency-by-code"}]},{"group":"misc","pages":[{"title":"Get apidate formats","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/date-formats","href":"/api-reference/misc/get-apidate-formats"}]},{"group":"Users","pages":[{"title":"Retrieve user details of the given user id.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/users/{id}","href":"/api-reference/users/retrieve-user-details-of-the-given-user-id"},{"title":"Edit details of the given user.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/users/{id}","href":"/api-reference/users/edit-details-of-the-given-user"},{"title":"Soft deleting the given user.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json delete /api/users/{id}","href":"/api-reference/users/soft-deleting-the-given-user"},{"title":"Retrieve the list of users.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/users","href":"/api-reference/users/retrieve-the-list-of-users"},{"title":"Activate the given user.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/users/{id}/activate","href":"/api-reference/users/activate-the-given-user"},{"title":"Inactivate the given user.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json put /api/users/{id}/inactivate","href":"/api-reference/users/inactivate-the-given-user"},{"title":"Send an invitation to a new user.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /api/invite","href":"/api-reference/users/send-an-invitation-to-a-new-user"},{"title":"Resend an invitation to an existing user.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/invite/users/{id}/resend","href":"/api-reference/users/resend-an-invitation-to-an-existing-user"},{"title":"Accept a user invitation.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json post /api/invite/accept/{token}","href":"/api-reference/users/accept-a-user-invitation"},{"title":"Check if an invitation token is valid.","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/invite/check/{token}","href":"/api-reference/users/check-if-an-invitation-token-is-valid"}]},{"group":"Contacts","pages":[{"title":"Get the auto-complete contacts","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/contacts/auto-complete","href":"/api-reference/contacts/get-the-auto-complete-contacts"},{"title":"Get contact by ID (customer or vendor)","deprecated":null,"version":null,"openapi":"api-reference/openapi.json get /api/contacts/{id}","href":"/api-reference/contacts/get-contact-by-id-customer-or-vendor"},{"title":"Activate a contact","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /api/contacts/{id}/activate","href":"/api-reference/contacts/activate-a-contact"},{"title":"Inactivate a contact","deprecated":null,"version":null,"openapi":"api-reference/openapi.json patch /api/contacts/{id}/inactivate","href":"/api-reference/contacts/inactivate-a-contact"}]}]}]}]},"title":"Edit the given sale invoice. - Bigcapital Docs","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}