{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
Purchasing
Retrieve a vendor prepayment and where it went
Returns one vendor prepayment of the key’s entity with its list fields plus: kind (po_deposit, landed_cost, advance or overpayment), imported (its recording entry came in with the company’s history), totals (amount, applied_to_bills, refunded, open), applications (each bill it was applied to: bill, amount, the day, the entry and who posted it), refunds (each live refund entry), purchase_order, source_payment (an overpayment’s payment), recording_entry, bank_line (the bank line holding the recording entry) and bank_account. Read only. Requires ap:read scope. Refused 400 missing_entity_id or invalid_prepayment_id; 404 prepayment_not_found (including a prepayment of another entity).
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
API key issued per entity via Settings > Developers > API Keys.
Each key carries scopes (e.g. orders:read, products:write).
Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Arcus ERP Docs","colors":{"primary":"#0466EE","light":"#4C94FF","dark":"#0355C6"},"logo":{"light":"https://mintcdn.com/arcuserp/pTLxSU3S7vcf6riI/logo/light.png?fit=max\u0026auto=format\u0026n=pTLxSU3S7vcf6riI\u0026q=85\u0026s=89c11f2d6e4a30803fc92eaf61b26656","dark":"https://mintcdn.com/arcuserp/pTLxSU3S7vcf6riI/logo/dark.png?fit=max\u0026auto=format\u0026n=pTLxSU3S7vcf6riI\u0026q=85\u0026s=63cf21bd9efa729f5eefd1e9a958cb2e"},"favicon":"https://mintcdn.com/arcuserp/pTLxSU3S7vcf6riI/logo/favicon.png?fit=max\u0026auto=format\u0026n=pTLxSU3S7vcf6riI\u0026q=85\u0026s=7c5ab5af10e264f583a7c5a27691de80","api":{"openapi":"openapi.yaml","playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer","name":"Authorization"},"server":["https://api.arcuserp.com/v1"]}},"appearance":{"default":"light","strict":true},"background":{"color":{"light":"#FFFFFF","dark":"#0F172A"}},"navbar":{"links":[{"href":"/support","label":"Support"},{"href":"/introduction","label":"API Docs"},{"href":"https://statuspage.incident.io/arcuserp","label":"Status"}],"primary":{"type":"button","label":"Sign In","href":"https://app.arcuserp.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/arcuserp"}},"search":{"prompt":"Ask anything about Arcus workflows, setup, and the API..."},"integrations":{"ga4":{"measurementId":"G-XXXXXXXXXX"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"arcuserp","hasAudioNarration":false,"actualSubdomain":"arcuserp","customDomains":["docs.arcuserp.com"],"gitSource":{"type":"github","owner":"reubenbroussard","repo":"arcus-erp-aws","deployBranch":"main","contentDirectory":"mintlify-docs","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adeaa61cc4d8fc7f4e68055","collectionId":"ef3a27f4-6466-4178-9fa2-cd5aedca8e1d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adeaa61cc4d8fc7f4e68055"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6adeb2356700f7f38149e48a","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"API Reference","count":681},{"language":"default","tag":"All Endpoints","count":680},{"language":"default","tag":"Help Center","count":260},{"language":"default","tag":"Accounting","count":137},{"language":"default","tag":"Purchasing","count":77},{"language":"default","tag":"Products","count":66},{"language":"default","tag":"Orders","count":65},{"language":"default","tag":"Settings and Administration","count":58},{"language":"default","tag":"Masters","count":55},{"language":"default","tag":"API Docs","count":37}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".is-center~[class*=max-w-3xl]{max-width:76rem!important}"}],"page":{"pagePath":"api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went","slug":"/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went","pageMetadata":{"title":"Retrieve a vendor prepayment and where it went","description":"Returns one vendor prepayment of the key's entity with its list fields plus: `kind` (`po_deposit`, `landed_cost`, `advance` or `overpayment`), `imported` (its recording entry came in with the company's history), `totals` (`amount`, `applied_to_bills`, `refunded`, `open`), `applications` (each bill it was applied to: bill, amount, the day, the entry and who posted it), `refunds` (each live refund entry), `purchase_order`, `source_payment` (an overpayment's payment), `recording_entry`, `bank_line` (the bank line holding the recording entry) and `bank_account`. Read only. Requires `ap:read` scope. Refused 400 `missing_entity_id` or `invalid_prepayment_id`; 404 `prepayment_not_found` (including a prepayment of another entity).","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-prepayments/{id}","href":"/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns one vendor prepayment of the key’s entity with its list fields plus: \", _jsx(_components.code, {\n children: \"kind\"\n }), \" (\", _jsx(_components.code, {\n children: \"po_deposit\"\n }), \", \", _jsx(_components.code, {\n children: \"landed_cost\"\n }), \", \", _jsx(_components.code, {\n children: \"advance\"\n }), \" or \", _jsx(_components.code, {\n children: \"overpayment\"\n }), \"), \", _jsx(_components.code, {\n children: \"imported\"\n }), \" (its recording entry came in with the company’s history), \", _jsx(_components.code, {\n children: \"totals\"\n }), \" (\", _jsx(_components.code, {\n children: \"amount\"\n }), \", \", _jsx(_components.code, {\n children: \"applied_to_bills\"\n }), \", \", _jsx(_components.code, {\n children: \"refunded\"\n }), \", \", _jsx(_components.code, {\n children: \"open\"\n }), \"), \", _jsx(_components.code, {\n children: \"applications\"\n }), \" (each bill it was applied to: bill, amount, the day, the entry and who posted it), \", _jsx(_components.code, {\n children: \"refunds\"\n }), \" (each live refund entry), \", _jsx(_components.code, {\n children: \"purchase_order\"\n }), \", \", _jsx(_components.code, {\n children: \"source_payment\"\n }), \" (an overpayment’s payment), \", _jsx(_components.code, {\n children: \"recording_entry\"\n }), \", \", _jsx(_components.code, {\n children: \"bank_line\"\n }), \" (the bank line holding the recording entry) and \", _jsx(_components.code, {\n children: \"bank_account\"\n }), \". Read only. Requires \", _jsx(_components.code, {\n children: \"ap:read\"\n }), \" scope. Refused 400 \", _jsx(_components.code, {\n children: \"missing_entity_id\"\n }), \" or \", _jsx(_components.code, {\n children: \"invalid_prepayment_id\"\n }), \"; 404 \", _jsx(_components.code, {\n children: \"prepayment_not_found\"\n }), \" (including a prepayment of another entity).\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve a vendor prepayment and where it went","description":"Returns one vendor prepayment of the key's entity with its list fields plus: `kind` (`po_deposit`, `landed_cost`, `advance` or `overpayment`), `imported` (its recording entry came in with the company's history), `totals` (`amount`, `applied_to_bills`, `refunded`, `open`), `applications` (each bill it was applied to: bill, amount, the day, the entry and who posted it), `refunds` (each live refund entry), `purchase_order`, `source_payment` (an overpayment's payment), `recording_entry`, `bank_line` (the bank line holding the recording entry) and `bank_account`. Read only. Requires `ap:read` scope. Refused 400 `missing_entity_id` or `invalid_prepayment_id`; 404 `prepayment_not_found` (including a prepayment of another entity).","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-prepayments/{id}","href":"/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getVendorPrepaymentV1","summary":"Retrieve a vendor prepayment and where it went","description":"Returns one vendor prepayment of the key's entity with its list fields plus: `kind` (`po_deposit`, `landed_cost`, `advance` or `overpayment`), `imported` (its recording entry came in with the company's history), `totals` (`amount`, `applied_to_bills`, `refunded`, `open`), `applications` (each bill it was applied to: bill, amount, the day, the entry and who posted it), `refunds` (each live refund entry), `purchase_order`, `source_payment` (an overpayment's payment), `recording_entry`, `bank_line` (the bank line holding the recording entry) and `bank_account`. Read only. Requires `ap:read` scope. Refused 400 `missing_entity_id` or `invalid_prepayment_id`; 404 `prepayment_not_found` (including a prepayment of another entity).","x-required-scope":"ap:read","tags":["Purchasing"],"security":["c3164879-e4f1-423e-8700-1b6daca4f23f"],"responses":{"200":"b4e2bfb5-d274-44d3-aecc-17f5dad9411f","400":"03ef5680-82b9-4fc3-a746-9eeedc9991e2","401":"5bfdce84-8792-4957-80e2-161f4164bb9e","403":"a15f3e20-436a-4d33-8d9c-a73ee2f08dbb","404":"f34ed5e7-765d-43dc-b856-4103f97bb170","500":"26c150f2-02a0-4343-aff1-10bda4eef388"},"method":"get","type":"path","servers":["98271c09-040d-4d4f-96fd-abf6ebaf768a","27697832-8081-484b-92a1-6dfcfc5fe443"],"path":"/vendor-prepayments/{id}","baseUrlOptions":["https://api.arcuserp.com/v1","https://dev-api.arcuserp.com/v1"],"title":"Retrieve a vendor prepayment and where it went","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9ea69adb-3668-4186-8a2c-35a47a5a4ec6":{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Vendor prepayment UUID.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Vendor prepayment UUID."}},"responses":{"b4e2bfb5-d274-44d3-aecc-17f5dad9411f":{"description":"The prepayment, its applications, refunds and linked documents.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"prepayment_number":{"type":"string","uniqueKey":"data.prepayment_number","typeLabel":"string"},"vendor_id":{"type":"string","format":"uuid","uniqueKey":"data.vendor_id","typeLabel":"string\u003cuuid>"},"vendor_name":{"type":"string","uniqueKey":"data.vendor_name","typeLabel":"string"},"amount":{"type":"number","uniqueKey":"data.amount","typeLabel":"number"},"applied_amount":{"type":"number","description":"Applications plus refunds (the refund door raises it).","uniqueKey":"data.applied_amount","typeLabel":"number"},"balance":{"type":"number","uniqueKey":"data.balance","typeLabel":"number"},"open_balance":{"type":"number","description":"The stored balance while the prepayment is open, else 0.","uniqueKey":"data.open_balance","typeLabel":"number"},"status":{"type":"string","enum":["active","partially_applied","fully_applied","refunded","voided"],"uniqueKey":"data.status","typeLabel":"enum\u003cstring>"},"payment_method":{"type":"string","uniqueKey":"data.payment_method","typeLabel":"string"},"payment_date":{"type":"string","format":"date-time","uniqueKey":"data.payment_date","typeLabel":"string\u003cdate-time>"},"po_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.po_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.po_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.po_id","typeLabel":"string\u003cuuid> | null"},"po_number":{"oneOf":[{"type":"string","uniqueKey":"data.po_number.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.po_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.po_number","typeLabel":"string | null"},"po_link_kind":{"oneOf":[{"type":"string","enum":["goods","landed"],"uniqueKey":"data.po_link_kind.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["goods","landed"],"uniqueKey":"data.po_link_kind.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.po_link_kind","typeLabel":"enum\u003cstring> | null"},"source_ap_payment_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.source_ap_payment_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.source_ap_payment_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.source_ap_payment_id","typeLabel":"string\u003cuuid> | null"},"kind":{"type":"string","enum":["po_deposit","landed_cost","advance","overpayment"],"uniqueKey":"data.kind","typeLabel":"enum\u003cstring>"},"imported":{"type":"boolean","uniqueKey":"data.imported","typeLabel":"boolean"},"totals":{"type":"object","properties":{"amount":{"type":"number","uniqueKey":"data.totals.amount","typeLabel":"number"},"applied_to_bills":{"type":"number","uniqueKey":"data.totals.applied_to_bills","typeLabel":"number"},"refunded":{"type":"number","uniqueKey":"data.totals.refunded","typeLabel":"number"},"open":{"type":"number","uniqueKey":"data.totals.open","typeLabel":"number"}},"uniqueKey":"data.totals","typeLabel":"object"},"applications":{"type":"array","items":{"type":"object","properties":{"application_id":{"type":"string","format":"uuid","uniqueKey":"data.applications.items.[INDEX].application_id","typeLabel":"string\u003cuuid>"},"bill_id":{"type":"string","format":"uuid","uniqueKey":"data.applications.items.[INDEX].bill_id","typeLabel":"string\u003cuuid>"},"bill_number":{"oneOf":[{"type":"string","uniqueKey":"data.applications.items.[INDEX].bill_number.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.applications.items.[INDEX].bill_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.applications.items.[INDEX].bill_number","typeLabel":"string | null"},"vendor_invoice_number":{"oneOf":[{"type":"string","uniqueKey":"data.applications.items.[INDEX].vendor_invoice_number.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.applications.items.[INDEX].vendor_invoice_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.applications.items.[INDEX].vendor_invoice_number","typeLabel":"string | null"},"amount_applied":{"type":"number","uniqueKey":"data.applications.items.[INDEX].amount_applied","typeLabel":"number"},"applied_at":{"type":"string","format":"date-time","uniqueKey":"data.applications.items.[INDEX].applied_at","typeLabel":"string\u003cdate-time>"},"journal_entry_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"data.applications.items.[INDEX].journal_entry_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"data.applications.items.[INDEX].journal_entry_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.applications.items.[INDEX].journal_entry_id","typeLabel":"string\u003cuuid> | null"},"journal_entry_number":{"oneOf":[{"type":"string","uniqueKey":"data.applications.items.[INDEX].journal_entry_number.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.applications.items.[INDEX].journal_entry_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.applications.items.[INDEX].journal_entry_number","typeLabel":"string | null"},"applied_by_name":{"oneOf":[{"type":"string","uniqueKey":"data.applications.items.[INDEX].applied_by_name.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.applications.items.[INDEX].applied_by_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.applications.items.[INDEX].applied_by_name","typeLabel":"string | null"},"imported":{"type":"boolean","uniqueKey":"data.applications.items.[INDEX].imported","typeLabel":"boolean"}},"uniqueKey":"data.applications.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.applications","typeLabel":"object[]"},"refunds":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"data.refunds.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"entry_number":{"oneOf":[{"type":"string","uniqueKey":"data.refunds.items.[INDEX].entry_number.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.refunds.items.[INDEX].entry_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.refunds.items.[INDEX].entry_number","typeLabel":"string | null"},"entry_date":{"oneOf":[{"type":"string","format":"date","uniqueKey":"data.refunds.items.[INDEX].entry_date.oneOf.0","typeLabel":"string\u003cdate>"},{"type":"null","format":"date","uniqueKey":"data.refunds.items.[INDEX].entry_date.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.refunds.items.[INDEX].entry_date","typeLabel":"string\u003cdate> | null"},"amount":{"type":"number","uniqueKey":"data.refunds.items.[INDEX].amount","typeLabel":"number"}},"uniqueKey":"data.refunds.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.refunds","typeLabel":"object[]"},"purchase_order":{"oneOf":[{"type":"object","uniqueKey":"data.purchase_order.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.purchase_order.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.purchase_order","typeLabel":"object | null"},"source_payment":{"oneOf":[{"type":"object","uniqueKey":"data.source_payment.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.source_payment.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.source_payment","typeLabel":"object | null"},"recording_entry":{"oneOf":[{"type":"object","uniqueKey":"data.recording_entry.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.recording_entry.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.recording_entry","typeLabel":"object | null"},"bank_line":{"oneOf":[{"type":"object","uniqueKey":"data.bank_line.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.bank_line.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bank_line","typeLabel":"object | null"},"bank_account":{"oneOf":[{"type":"object","uniqueKey":"data.bank_account.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"data.bank_account.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.bank_account","typeLabel":"object | null"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","prepayment_number":"\u003cstring>","vendor_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","vendor_name":"\u003cstring>","amount":123,"applied_amount":123,"balance":123,"open_balance":123,"status":"active","payment_method":"\u003cstring>","payment_date":"2023-11-07T05:31:56Z","po_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","po_number":"\u003cstring>","po_link_kind":"goods","source_ap_payment_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","kind":"po_deposit","imported":true,"totals":{"amount":123,"applied_to_bills":123,"refunded":123,"open":123},"applications":[{"application_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","bill_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","bill_number":"\u003cstring>","vendor_invoice_number":"\u003cstring>","amount_applied":123,"applied_at":"2023-11-07T05:31:56Z","journal_entry_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","journal_entry_number":"\u003cstring>","applied_by_name":"\u003cstring>","imported":true}],"refunds":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","entry_number":"\u003cstring>","entry_date":"2023-12-25","amount":123}],"purchase_order":{},"source_payment":{},"recording_entry":{},"bank_line":{},"bank_account":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"03ef5680-82b9-4fc3-a746-9eeedc9991e2":{"description":"Error response (400/401/403/404/409/422/429/500)","content":{"application/json":{"schema":{"type":"object","description":"Canonical error response envelope. All API errors use this shape.\n","required":["error","code"],"properties":{"error":{"type":"string","description":"Machine-readable error key","example":"not_found","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code (often same as error)","example":"not_found","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"type":{"type":"string","enum":["validation_error","permission_error","not_found","conflict","rate_limit","internal","expand_error","not_implemented"],"example":"not_found","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"hint":{"type":"string","description":"Human-readable one-sentence explanation (English)","example":"The requested order does not exist or does not belong to this entity.","uniqueKey":"hint","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error, if applicable","example":"expand[0]","uniqueKey":"param","typeLabel":"string"},"required":{"type":"string","description":"The scope required (only on insufficient_scope errors)","example":"accounts:read","uniqueKey":"required","typeLabel":"string"},"request_id":{"type":"string","description":"Unique request ID for support tracing (maps to CloudWatch log stream)","example":"req_abc123","uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"not_found","code":"not_found","type":"not_found","hint":"The requested order does not exist or does not belong to this entity.","param":"expand[0]","required":"accounts:read","request_id":"req_abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"5bfdce84-8792-4957-80e2-161f4164bb9e":{"description":"Error response (400/401/403/404/409/422/429/500)","content":{"application/json":{"schema":{"type":"object","description":"Canonical error response envelope. All API errors use this shape.\n","required":["error","code"],"properties":{"error":{"type":"string","description":"Machine-readable error key","example":"not_found","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code (often same as error)","example":"not_found","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"type":{"type":"string","enum":["validation_error","permission_error","not_found","conflict","rate_limit","internal","expand_error","not_implemented"],"example":"not_found","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"hint":{"type":"string","description":"Human-readable one-sentence explanation (English)","example":"The requested order does not exist or does not belong to this entity.","uniqueKey":"hint","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error, if applicable","example":"expand[0]","uniqueKey":"param","typeLabel":"string"},"required":{"type":"string","description":"The scope required (only on insufficient_scope errors)","example":"accounts:read","uniqueKey":"required","typeLabel":"string"},"request_id":{"type":"string","description":"Unique request ID for support tracing (maps to CloudWatch log stream)","example":"req_abc123","uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"not_found","code":"not_found","type":"not_found","hint":"The requested order does not exist or does not belong to this entity.","param":"expand[0]","required":"accounts:read","request_id":"req_abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"a15f3e20-436a-4d33-8d9c-a73ee2f08dbb":{"description":"Error response (400/401/403/404/409/422/429/500)","content":{"application/json":{"schema":{"type":"object","description":"Canonical error response envelope. All API errors use this shape.\n","required":["error","code"],"properties":{"error":{"type":"string","description":"Machine-readable error key","example":"not_found","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code (often same as error)","example":"not_found","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"type":{"type":"string","enum":["validation_error","permission_error","not_found","conflict","rate_limit","internal","expand_error","not_implemented"],"example":"not_found","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"hint":{"type":"string","description":"Human-readable one-sentence explanation (English)","example":"The requested order does not exist or does not belong to this entity.","uniqueKey":"hint","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error, if applicable","example":"expand[0]","uniqueKey":"param","typeLabel":"string"},"required":{"type":"string","description":"The scope required (only on insufficient_scope errors)","example":"accounts:read","uniqueKey":"required","typeLabel":"string"},"request_id":{"type":"string","description":"Unique request ID for support tracing (maps to CloudWatch log stream)","example":"req_abc123","uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"not_found","code":"not_found","type":"not_found","hint":"The requested order does not exist or does not belong to this entity.","param":"expand[0]","required":"accounts:read","request_id":"req_abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"f34ed5e7-765d-43dc-b856-4103f97bb170":{"description":"Error response (400/401/403/404/409/422/429/500)","content":{"application/json":{"schema":{"type":"object","description":"Canonical error response envelope. All API errors use this shape.\n","required":["error","code"],"properties":{"error":{"type":"string","description":"Machine-readable error key","example":"not_found","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code (often same as error)","example":"not_found","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"type":{"type":"string","enum":["validation_error","permission_error","not_found","conflict","rate_limit","internal","expand_error","not_implemented"],"example":"not_found","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"hint":{"type":"string","description":"Human-readable one-sentence explanation (English)","example":"The requested order does not exist or does not belong to this entity.","uniqueKey":"hint","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error, if applicable","example":"expand[0]","uniqueKey":"param","typeLabel":"string"},"required":{"type":"string","description":"The scope required (only on insufficient_scope errors)","example":"accounts:read","uniqueKey":"required","typeLabel":"string"},"request_id":{"type":"string","description":"Unique request ID for support tracing (maps to CloudWatch log stream)","example":"req_abc123","uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"not_found","code":"not_found","type":"not_found","hint":"The requested order does not exist or does not belong to this entity.","param":"expand[0]","required":"accounts:read","request_id":"req_abc123"}}},"exampleType":"generated"}},"exampleType":"generated"},"26c150f2-02a0-4343-aff1-10bda4eef388":{"description":"Error response (400/401/403/404/409/422/429/500)","content":{"application/json":{"schema":{"type":"object","description":"Canonical error response envelope. All API errors use this shape.\n","required":["error","code"],"properties":{"error":{"type":"string","description":"Machine-readable error key","example":"not_found","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable error code (often same as error)","example":"not_found","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"type":{"type":"string","enum":["validation_error","permission_error","not_found","conflict","rate_limit","internal","expand_error","not_implemented"],"example":"not_found","uniqueKey":"type","typeLabel":"enum\u003cstring>"},"hint":{"type":"string","description":"Human-readable one-sentence explanation (English)","example":"The requested order does not exist or does not belong to this entity.","uniqueKey":"hint","typeLabel":"string"},"param":{"type":"string","description":"The parameter that caused the error, if applicable","example":"expand[0]","uniqueKey":"param","typeLabel":"string"},"required":{"type":"string","description":"The scope required (only on insufficient_scope errors)","example":"accounts:read","uniqueKey":"required","typeLabel":"string"},"request_id":{"type":"string","description":"Unique request ID for support tracing (maps to CloudWatch log stream)","example":"req_abc123","uniqueKey":"request_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"not_found","code":"not_found","type":"not_found","hint":"The requested order does not exist or does not belong to this entity.","param":"expand[0]","required":"accounts:read","request_id":"req_abc123"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c3164879-e4f1-423e-8700-1b6daca4f23f":{"ApiKeyAuth":{"type":"http","scheme":"bearer","description":"API key issued per entity via Settings > Developers > API Keys.\nEach key carries scopes (e.g. orders:read, products:write).\nBearer token format: Authorization: Bearer ark_live_ent_\u003ccode>_\u003crandom>\nTest keys use ark_test_ent_\u003ccode>_\u003crandom>. Both are issued per entity\nvia Settings > Developers > API Keys.\n","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"98271c09-040d-4d4f-96fd-abf6ebaf768a":{"url":"https://api.arcuserp.com/v1","description":"Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys)"},"27697832-8081-484b-92a1-6dfcfc5fe443":{"url":"https://dev-api.arcuserp.com/v1","description":"Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev RDS)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key issued per entity via Settings > Developers > API Keys.\nEach key carries scopes (e.g. orders:read, products:write).\nBearer token format: Authorization: Bearer ark_live_ent_\u003ccode>_\u003crandom>\nTest keys use ark_test_ent_\u003ccode>_\u003crandom>. Both are issued per entity\nvia Settings > Developers > API Keys.\n","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key issued per entity via Settings > Developers > API Keys.\nEach key carries scopes (e.g. orders:read, products:write).\nBearer token format: Authorization: Bearer ark_live_ent_\u003ccode>_\u003crandom>\nTest keys use ark_test_ent_\u003ccode>_\u003crandom>. Both are issued per entity\nvia Settings > Developers > API Keys.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"arcuserp","siteName":"Arcus ERP Docs","title":"Retrieve a vendor prepayment and where it went - Arcus ERP Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-26T02:28:43.160Z","originalFileLocation":"api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";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=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns one vendor prepayment of the key\u0026#x27;s entity with its list fields plus: kind (po_deposit, landed_cost, advance or overpayment), imported (its recording entry came in with the company\u0026#x27;s history), totals (amount, applied_to_bills, refunded, open), applications (each bill it was applied to: bill, amount, the day, the entry and who posted it), refunds (each live refund entry), purchase_order, source_payment (an overpayment\u0026#x27;s payment), recording_entry, bank_line (the bank line holding the recording entry) and bank_account. Read only. Requires ap:read scope. Refused 400 missing_entity_id or invalid_prepayment_id; 404 prepayment_not_found (including a prepayment of another entity).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Arcus ERP 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/arcuserp/iGGcQO3UCgP8tozJ/_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/arcuserp/iGGcQO3UCgP8tozJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/arcuserp/iGGcQO3UCgP8tozJ/_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/arcuserp/iGGcQO3UCgP8tozJ/_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/arcuserp/iGGcQO3UCgP8tozJ/_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/arcuserp/iGGcQO3UCgP8tozJ/_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/arcuserp/iGGcQO3UCgP8tozJ/_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/arcuserp/iGGcQO3UCgP8tozJ/_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/arcuserp/iGGcQO3UCgP8tozJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a vendor prepayment and where it went - Arcus ERP Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns one vendor prepayment of the key\u0026#x27;s entity with its list fields plus: kind (po_deposit, landed_cost, advance or overpayment), imported (its recording entry came in with the company\u0026#x27;s history), totals (amount, applied_to_bills, refunded, open), applications (each bill it was applied to: bill, amount, the day, the entry and who posted it), refunds (each live refund entry), purchase_order, source_payment (an overpayment\u0026#x27;s payment), recording_entry, bank_line (the bank line holding the recording entry) and bank_account. Read only. Requires ap:read scope. Refused 400 missing_entity_id or invalid_prepayment_id; 404 prepayment_not_found (including a prepayment of another entity).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Arcus ERP Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.arcuserp.com/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://arcuserp.mintlify.app/_mintlify/api/og/v2?division=Purchasing\u0026amp;title=Retrieve+a+vendor+prepayment+and+where+it+went\u0026amp;description=Returns+one+vendor+prepayment+of+the+key%27s+entity+with+its+list+fields+plus%3A+%60kind%60+%28%60po_deposit%60%2C+%60landed_cost%60%2C+%60advance%60+or+%60overpayment%60%29%2C+%60imported%60+%28its+r\u0026amp;theme=76d7ae334cac71a2adaf164a\u0026amp;signature=7473b50a0f97442de4d4395b09857f86518c7b0733d675fc4b6b4909e2750721\">\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=\"Retrieve a vendor prepayment and where it went - Arcus ERP Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns one vendor prepayment of the key\u0026#x27;s entity with its list fields plus: kind (po_deposit, landed_cost, advance or overpayment), imported (its recording entry came in with the company\u0026#x27;s history), totals (amount, applied_to_bills, refunded, open), applications (each bill it was applied to: bill, amount, the day, the entry and who posted it), refunds (each live refund entry), purchase_order, source_payment (an overpayment\u0026#x27;s payment), recording_entry, bank_line (the bank line holding the recording entry) and bank_account. Read only. Requires ap:read scope. Refused 400 missing_entity_id or invalid_prepayment_id; 404 prepayment_not_found (including a prepayment of another entity).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://arcuserp.mintlify.app/_mintlify/api/og/v2?division=Purchasing\u0026amp;title=Retrieve+a+vendor+prepayment+and+where+it+went\u0026amp;description=Returns+one+vendor+prepayment+of+the+key%27s+entity+with+its+list+fields+plus%3A+%60kind%60+%28%60po_deposit%60%2C+%60landed_cost%60%2C+%60advance%60+or+%60overpayment%60%29%2C+%60imported%60+%28its+r\u0026amp;theme=76d7ae334cac71a2adaf164a\u0026amp;signature=7473b50a0f97442de4d4395b09857f86518c7b0733d675fc4b6b4909e2750721\">\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/arcuserp/iGGcQO3UCgP8tozJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Arcus ERP Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0466EE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.arcuserp.com/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.arcuserp.com/#organization\",\"name\":\"Arcus ERP Docs\",\"url\":\"https://docs.arcuserp.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/arcuserp/pTLxSU3S7vcf6riI/logo/light.png?fit=max\u0026auto=format\u0026n=pTLxSU3S7vcf6riI\u0026q=85\u0026s=89c11f2d6e4a30803fc92eaf61b26656\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.arcuserp.com#website\",\"name\":\"Arcus ERP Docs\",\"url\":\"https://docs.arcuserp.com\",\"publisher\":{\"@id\":\"https://docs.arcuserp.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.arcuserp.com/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went#webpage\",\"url\":\"https://docs.arcuserp.com/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went\",\"name\":\"Retrieve a vendor prepayment and where it went\",\"description\":\"Returns one vendor prepayment of the key's entity with its list fields plus: kind (po_deposit, landed_cost, advance or overpayment), imported (its recording entry came in with the company's history), totals (amount, applied_to_bills, refunded, open), applications (each bill it was applied to: bill, amount, the day, the entry and who posted it), refunds (each live refund entry), purchase_order, source_payment (an overpayment's payment), recording_entry, bank_line (the bank line holding the recording entry) and bank_account. Read only. Requires ap:read scope. Refused 400 missing_entity_id or invalid_prepayment_id; 404 prepayment_not_found (including a prepayment of another entity).\",\"dateModified\":\"2026-10-26T02:28:43.160Z\",\"isPartOf\":{\"@id\":\"https://docs.arcuserp.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.arcuserp.com/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.arcuserp.com/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"All Endpoints\",\"item\":\"https://docs.arcuserp.com/api-reference/payments/list-installment-payment-plans\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Purchasing\",\"item\":\"https://docs.arcuserp.com/api-reference/purchasing/retrieve-the-reorder-report\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Retrieve a vendor prepayment and where it went\",\"item\":\"https://docs.arcuserp.com/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.arcuserp.com/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went#apireference\",\"headline\":\"Retrieve a vendor prepayment and where it went\",\"name\":\"Retrieve a vendor prepayment and where it went\",\"description\":\"Returns one vendor prepayment of the key's entity with its list fields plus: kind (po_deposit, landed_cost, advance or overpayment), imported (its recording entry came in with the company's history), totals (amount, applied_to_bills, refunded, open), applications (each bill it was applied to: bill, amount, the day, the entry and who posted it), refunds (each live refund entry), purchase_order, source_payment (an overpayment's payment), recording_entry, bank_line (the bank line holding the recording entry) and bank_account. Read only. Requires ap:read scope. Refused 400 missing_entity_id or invalid_prepayment_id; 404 prepayment_not_found (including a prepayment of another entity).\",\"url\":\"https://docs.arcuserp.com/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went\",\"mainEntityOfPage\":{\"@id\":\"https://docs.arcuserp.com/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went#webpage\"},\"dateModified\":\"2026-10-26T02:28:43.160Z\",\"publisher\":{\"@id\":\"https://docs.arcuserp.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.arcuserp.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Arcus ERP Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Arcus ERP Docs","nav":{"global":null,"tabs":[{"tab":"Help Center","pages":[{"title":"Help Center","href":"/support"}]},{"tab":"Report a Bug","pages":[{"title":"Report a Bug","href":"/support/bug-report"}]},{"tab":"Feature Request","pages":[{"title":"Feature Request","href":"/support/feature-request"}]},{"tab":"API Docs","pages":[{"title":"API Docs","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"group":"All Endpoints","pages":[{"group":"Payments","pages":[{"title":"List installment payment plans","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payment-plans","href":"/api-reference/payments/list-installment-payment-plans"},{"title":"Create an installment payment plan","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payment-plans","href":"/api-reference/payments/create-an-installment-payment-plan"},{"title":"Retrieve a payment plan","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payment-plans/{id}","href":"/api-reference/payments/retrieve-a-payment-plan"},{"title":"Cancel a payment plan","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /payment-plans/{id}","href":"/api-reference/payments/cancel-a-payment-plan"},{"title":"Update a payment plan","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /payment-plans/{id}","href":"/api-reference/payments/update-a-payment-plan"},{"title":"Charge a payment plan installment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payment-plans/{id}/installments/{seq}/charge","href":"/api-reference/payments/charge-a-payment-plan-installment"},{"title":"List payments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payments","href":"/api-reference/payments/list-payments"},{"title":"Create a payment batch","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payments/batch","href":"/api-reference/payments/create-a-payment-batch"},{"title":"List a receipt's invoice applications","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customer-payments/{id}/applications","href":"/api-reference/payments/list-a-receipts-invoice-applications"},{"title":"Reapply a receipt to different invoices","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /customer-payments/{id}/applications","href":"/api-reference/payments/reapply-a-receipt-to-different-invoices"},{"title":"Void a posted customer receipt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customer-payments/{id}/void","href":"/api-reference/payments/void-a-posted-customer-receipt"},{"title":"Apply a payment to multiple invoices","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payments/multi-invoice-apply","href":"/api-reference/payments/apply-a-payment-to-multiple-invoices"},{"title":"List open receivable invoices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payments/multi-invoice-candidates","href":"/api-reference/payments/list-open-receivable-invoices"},{"title":"Deprecated. Response names the operation to use instead.","deprecated":true,"version":null,"openapi":"/openapi.yaml post /payments/{payment_id}/apply","href":"/api-reference/payments/deprecated-response-names-the-operation-to-use-instead"},{"title":"Retrieve a payment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payments/{payment_id}","href":"/api-reference/payments/retrieve-a-payment"},{"title":"Void an uncaptured payment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payments/{payment_id}/void","href":"/api-reference/payments/void-an-uncaptured-payment"},{"title":"Refund a payment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/payments/{payment_id}/refund","href":"/api-reference/payments/refund-a-payment"},{"title":"List credit memos","deprecated":null,"version":null,"openapi":"/openapi.yaml get /credits","href":"/api-reference/payments/list-credit-memos"},{"title":"Create a credit memo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /credits","href":"/api-reference/payments/create-a-credit-memo"},{"title":"Apply a credit memo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /credits/{credit_id}/apply","href":"/api-reference/payments/apply-a-credit-memo"},{"title":"Apply a customer deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customer-deposits/{id}/apply","href":"/api-reference/payments/apply-a-customer-deposit"},{"title":"Refund a customer deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customer-deposits/{id}/refund","href":"/api-reference/payments/refund-a-customer-deposit"}]},{"group":"Reports","pages":[{"title":"List scheduled report deliveries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reporting-schedules","href":"/api-reference/reports/list-scheduled-report-deliveries"},{"title":"Create a scheduled report delivery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /reporting-schedules","href":"/api-reference/reports/create-a-scheduled-report-delivery"},{"title":"Retrieve a reporting schedule","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reporting-schedules/{id}","href":"/api-reference/reports/retrieve-a-reporting-schedule"},{"title":"Delete a reporting schedule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /reporting-schedules/{id}","href":"/api-reference/reports/delete-a-reporting-schedule"},{"title":"Update a reporting schedule","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /reporting-schedules/{id}","href":"/api-reference/reports/update-a-reporting-schedule"},{"title":"Trigger a reporting schedule now","deprecated":null,"version":null,"openapi":"/openapi.yaml post /reporting-schedules/{id}/run","href":"/api-reference/reports/trigger-a-reporting-schedule-now"},{"title":"Retrieve the shipping margin report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/shipping-margin","href":"/api-reference/reports/retrieve-the-shipping-margin-report"},{"title":"List report jobs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports","href":"/api-reference/reports/list-report-jobs"},{"title":"Create an async report job","deprecated":null,"version":null,"openapi":"/openapi.yaml post /reports","href":"/api-reference/reports/create-an-async-report-job"},{"title":"List built-in report types","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/types","href":"/api-reference/reports/list-built-in-report-types"},{"title":"Retrieve a report job","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/{id}","href":"/api-reference/reports/retrieve-a-report-job"},{"title":"Cancel a report job","deprecated":null,"version":null,"openapi":"/openapi.yaml post /reports/{id}/cancel","href":"/api-reference/reports/cancel-a-report-job"},{"title":"Download a report job's result","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/{id}/download","href":"/api-reference/reports/download-a-report-jobs-result"}]},{"group":"Serials","pages":[{"title":"Trace a serial number's history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /serials/trace","href":"/api-reference/serials/trace-a-serial-numbers-history"},{"title":"List serials","deprecated":null,"version":null,"openapi":"/openapi.yaml get /serials","href":"/api-reference/serials/list-serials"},{"title":"Generate serials in bulk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /serials","href":"/api-reference/serials/generate-serials-in-bulk"},{"title":"Validate a serial for return","deprecated":null,"version":null,"openapi":"/openapi.yaml post /serials/validate-for-return","href":"/api-reference/serials/validate-a-serial-for-return"},{"title":"Preview a barcode parse","deprecated":null,"version":null,"openapi":"/openapi.yaml post /serials/parse-test","href":"/api-reference/serials/preview-a-barcode-parse"},{"title":"Capture serials for a package","deprecated":null,"version":null,"openapi":"/openapi.yaml post /serials/capture-partial","href":"/api-reference/serials/capture-serials-for-a-package"},{"title":"Retrieve a serial","deprecated":null,"version":null,"openapi":"/openapi.yaml get /serials/{id}","href":"/api-reference/serials/retrieve-a-serial"},{"title":"Delete a serial","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /serials/{id}","href":"/api-reference/serials/delete-a-serial"},{"title":"Update a serial","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /serials/{id}","href":"/api-reference/serials/update-a-serial"},{"title":"Restore a soft-deleted serial","deprecated":null,"version":null,"openapi":"/openapi.yaml post /serials/{id}/restore","href":"/api-reference/serials/restore-a-soft-deleted-serial"},{"title":"Record a serial's disposition","deprecated":null,"version":null,"openapi":"/openapi.yaml post /serials/{id}/disposition","href":"/api-reference/serials/record-a-serials-disposition"},{"title":"Link a serial to a lot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /serials/{id}/link-lot","href":"/api-reference/serials/link-a-serial-to-a-lot"}]},{"group":"Accounting","pages":[{"title":"Post a GL opening balance","deprecated":null,"version":null,"openapi":"/openapi.yaml post /gl-accounts/{id}/opening-balance","href":"/api-reference/accounting/post-a-gl-opening-balance"},{"title":"List AR remittance imports","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounting/ar/remittance","href":"/api-reference/accounting/list-ar-remittance-imports"},{"title":"Import an AR remittance file","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounting/ar/remittance/import","href":"/api-reference/accounting/import-an-ar-remittance-file"},{"title":"Retrieve an AR remittance import","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounting/ar/remittance/{id}","href":"/api-reference/accounting/retrieve-an-ar-remittance-import"},{"title":"Confirm an AR remittance import","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounting/ar/remittance/{id}/confirm","href":"/api-reference/accounting/confirm-an-ar-remittance-import"},{"title":"Suggest open invoices for a deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounting/bank-transactions/{id}/open-invoice-candidates","href":"/api-reference/accounting/suggest-open-invoices-for-a-deposit"},{"title":"Match a deposit to invoices","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounting/bank-transactions/{id}/match-deposit-to-invoices","href":"/api-reference/accounting/match-a-deposit-to-invoices"},{"title":"List GL accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /gl-accounts","href":"/api-reference/accounting/list-gl-accounts"},{"title":"Create a custom GL account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /gl-accounts","href":"/api-reference/accounting/create-a-custom-gl-account"},{"title":"Retrieve a GL account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /gl-accounts/{id}","href":"/api-reference/accounting/retrieve-a-gl-account"},{"title":"Deactivate a GL account","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /gl-accounts/{id}","href":"/api-reference/accounting/deactivate-a-gl-account"},{"title":"Update a GL account","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /gl-accounts/{id}","href":"/api-reference/accounting/update-a-gl-account"},{"title":"List journal entries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /journal-entries","href":"/api-reference/accounting/list-journal-entries"},{"title":"Create a manual journal entry","deprecated":null,"version":null,"openapi":"/openapi.yaml post /journal-entries","href":"/api-reference/accounting/create-a-manual-journal-entry"},{"title":"Retrieve a journal entry with lines","deprecated":null,"version":null,"openapi":"/openapi.yaml get /journal-entries/{id}","href":"/api-reference/accounting/retrieve-a-journal-entry-with-lines"},{"title":"Approve a pending journal entry","deprecated":null,"version":null,"openapi":"/openapi.yaml post /journal-entries/{id}/approve","href":"/api-reference/accounting/approve-a-pending-journal-entry"},{"title":"Reject a pending journal entry","deprecated":null,"version":null,"openapi":"/openapi.yaml post /journal-entries/{id}/reject","href":"/api-reference/accounting/reject-a-pending-journal-entry"},{"title":"Reverse a posted journal entry","deprecated":null,"version":null,"openapi":"/openapi.yaml post /journal-entries/{id}/reverse","href":"/api-reference/accounting/reverse-a-posted-journal-entry"},{"title":"List accounting periods","deprecated":null,"version":null,"openapi":"/openapi.yaml get /periods","href":"/api-reference/accounting/list-accounting-periods"},{"title":"Retrieve a period close checklist","deprecated":null,"version":null,"openapi":"/openapi.yaml get /periods/{id}/close-checklist","href":"/api-reference/accounting/retrieve-a-period-close-checklist"},{"title":"Create accounting periods for a range","deprecated":null,"version":null,"openapi":"/openapi.yaml post /periods/ensure-range","href":"/api-reference/accounting/create-accounting-periods-for-a-range"},{"title":"Close an accounting period","deprecated":null,"version":null,"openapi":"/openapi.yaml post /periods/{id}/close","href":"/api-reference/accounting/close-an-accounting-period"},{"title":"Initiate a period close","deprecated":null,"version":null,"openapi":"/openapi.yaml post /periods/{id}/request-close","href":"/api-reference/accounting/initiate-a-period-close"},{"title":"Approve a pending period close","deprecated":null,"version":null,"openapi":"/openapi.yaml post /periods/{id}/approve-close","href":"/api-reference/accounting/approve-a-pending-period-close"},{"title":"Cancel a pending period close","deprecated":null,"version":null,"openapi":"/openapi.yaml post /periods/{id}/withdraw-close-request","href":"/api-reference/accounting/cancel-a-pending-period-close"},{"title":"Reopen a closed accounting period","deprecated":null,"version":null,"openapi":"/openapi.yaml post /periods/{id}/reopen","href":"/api-reference/accounting/reopen-a-closed-accounting-period"},{"title":"List bank accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /bank-accounts","href":"/api-reference/accounting/list-bank-accounts"},{"title":"Create a bank account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /bank-accounts","href":"/api-reference/accounting/create-a-bank-account"},{"title":"Retrieve a bank account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /bank-accounts/{id}","href":"/api-reference/accounting/retrieve-a-bank-account"},{"title":"Update a bank account","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /bank-accounts/{id}","href":"/api-reference/accounting/update-a-bank-account"},{"title":"List recurring journal entry templates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /recurring-journal-entries","href":"/api-reference/accounting/list-recurring-journal-entry-templates"},{"title":"Create a recurring journal entry template","deprecated":null,"version":null,"openapi":"/openapi.yaml post /recurring-journal-entries","href":"/api-reference/accounting/create-a-recurring-journal-entry-template"},{"title":"Deactivate a recurring journal template","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /recurring-journal-entries/{id}","href":"/api-reference/accounting/deactivate-a-recurring-journal-template"},{"title":"Update a recurring journal entry template","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /recurring-journal-entries/{id}","href":"/api-reference/accounting/update-a-recurring-journal-entry-template"},{"title":"Post a recurring journal entry","deprecated":null,"version":null,"openapi":"/openapi.yaml post /recurring-journal-entries/{id}/run","href":"/api-reference/accounting/post-a-recurring-journal-entry"},{"title":"Retrieve a trial balance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/trial-balance","href":"/api-reference/accounting/retrieve-a-trial-balance"},{"title":"Retrieve an income statement","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/profit-loss","href":"/api-reference/accounting/retrieve-an-income-statement"},{"title":"Retrieve a balance sheet","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/balance-sheet","href":"/api-reference/accounting/retrieve-a-balance-sheet"},{"title":"Retrieve a cash flow statement","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/cash-flow","href":"/api-reference/accounting/retrieve-a-cash-flow-statement"},{"title":"Retrieve a GL account ledger","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/account-ledger","href":"/api-reference/accounting/retrieve-a-gl-account-ledger"},{"title":"Retrieve AR aging by customer","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/ar-aging","href":"/api-reference/accounting/retrieve-ar-aging-by-customer"},{"title":"Retrieve AP aging by vendor","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/ap-aging","href":"/api-reference/accounting/retrieve-ap-aging-by-vendor"},{"title":"Retrieve the AR aging summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /dashboard/ar-aging-summary","href":"/api-reference/accounting/retrieve-the-ar-aging-summary"},{"title":"Retrieve the AP aging summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /dashboard/ap-aging-summary","href":"/api-reference/accounting/retrieve-the-ap-aging-summary"},{"title":"Compare subledger balances to GL","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reports/subledger-reconciliation","href":"/api-reference/accounting/compare-subledger-balances-to-gl"},{"title":"Charge late fees","deprecated":null,"version":null,"openapi":"/openapi.yaml post /ar/assess-late-fees","href":"/api-reference/accounting/charge-late-fees"},{"title":"Send AR statements in bulk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounting/statements/bulk-send","href":"/api-reference/accounting/send-ar-statements-in-bulk"},{"title":"Send an AR statement","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounting/statements/{account_id}/send","href":"/api-reference/accounting/send-an-ar-statement"},{"title":"List chart of accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /chart-of-accounts","href":"/api-reference/accounting/list-chart-of-accounts"},{"title":"Retrieve the chart of accounts tree","deprecated":null,"version":null,"openapi":"/openapi.yaml get /chart-of-accounts/tree","href":"/api-reference/accounting/retrieve-the-chart-of-accounts-tree"},{"title":"List system-keyed accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /chart-of-accounts/system-keys","href":"/api-reference/accounting/list-system-keyed-accounts"},{"title":"List a journal entry's lines","deprecated":null,"version":null,"openapi":"/openapi.yaml get /journal-entries/{id}/lines","href":"/api-reference/accounting/list-a-journal-entrys-lines"},{"title":"Retrieve a journal entry line","deprecated":null,"version":null,"openapi":"/openapi.yaml get /journal-entries/{id}/lines/{line_id}","href":"/api-reference/accounting/retrieve-a-journal-entry-line"},{"title":"Update a journal entry line","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /journal-entries/{id}/lines/{line_id}","href":"/api-reference/accounting/update-a-journal-entry-line"},{"title":"List fiscal periods","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fiscal-periods","href":"/api-reference/accounting/list-fiscal-periods"},{"title":"Retrieve a fiscal period","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fiscal-periods/{id}","href":"/api-reference/accounting/retrieve-a-fiscal-period"},{"title":"Close a fiscal year","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fiscal-periods/{id}/close-fiscal-year","href":"/api-reference/accounting/close-a-fiscal-year"},{"title":"Close a period's fiscal year","deprecated":null,"version":null,"openapi":"/openapi.yaml post /periods/{id}/close-fiscal-year","href":"/api-reference/accounting/close-a-periods-fiscal-year"},{"title":"Close an accounting period's fiscal year","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounting_periods/{id}/close-fiscal-year","href":"/api-reference/accounting/close-an-accounting-periods-fiscal-year"},{"title":"Reopen a closed fiscal year","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fiscal-periods/{id}/reopen-fiscal-year","href":"/api-reference/accounting/reopen-a-closed-fiscal-year"},{"title":"Reopen a period's fiscal year","deprecated":null,"version":null,"openapi":"/openapi.yaml post /periods/{id}/reopen-fiscal-year","href":"/api-reference/accounting/reopen-a-periods-fiscal-year"},{"title":"Reopen an accounting period's fiscal year","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounting_periods/{id}/reopen-fiscal-year","href":"/api-reference/accounting/reopen-an-accounting-periods-fiscal-year"},{"title":"List bank deposits","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deposits","href":"/api-reference/accounting/list-bank-deposits"},{"title":"Create a bank deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deposits","href":"/api-reference/accounting/create-a-bank-deposit"},{"title":"Retrieve a bank deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deposits/{id}","href":"/api-reference/accounting/retrieve-a-bank-deposit"},{"title":"Update a posted bank deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /deposits/{id}","href":"/api-reference/accounting/update-a-posted-bank-deposit"},{"title":"Preview an edit of a posted bank deposit ticket","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deposits/{id}/edit-preview","href":"/api-reference/accounting/preview-an-edit-of-a-posted-bank-deposit-ticket"},{"title":"Match deposit tickets to one bank's lines for a month","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deposits/match-view","href":"/api-reference/accounting/match-deposit-tickets-to-one-banks-lines-for-a-month"},{"title":"Void a bank deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deposits/{id}/void","href":"/api-reference/accounting/void-a-bank-deposit"},{"title":"Reconcile a bank deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deposits/{id}/clear","href":"/api-reference/accounting/reconcile-a-bank-deposit"},{"title":"Preview a bank deposit before posting","deprecated":null,"version":null,"openapi":"/openapi.yaml post /deposits/preview","href":"/api-reference/accounting/preview-a-bank-deposit-before-posting"},{"title":"Retrieve a bank account's Plaid status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /bank-accounts/{id}/plaid-status","href":"/api-reference/accounting/retrieve-a-bank-accounts-plaid-status"},{"title":"Apply a reconciliation baseline","deprecated":null,"version":null,"openapi":"/openapi.yaml post /bank-accounts/{id}/reconciliation-baseline","href":"/api-reference/accounting/apply-a-reconciliation-baseline"},{"title":"Suggest payment matches for a deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounting/bank-transactions/{bank_transaction_id}/customer-payment-candidates","href":"/api-reference/accounting/suggest-payment-matches-for-a-deposit"},{"title":"Match a deposit to a payment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounting/bank-transactions/{bank_transaction_id}/match-customer-payment","href":"/api-reference/accounting/match-a-deposit-to-a-payment"},{"title":"Exclude a bank feed transaction","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounting/bank-transactions/{bank_transaction_id}/exclude","href":"/api-reference/accounting/exclude-a-bank-feed-transaction"},{"title":"Restore an excluded bank transaction","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounting/bank-transactions/{bank_transaction_id}/restore","href":"/api-reference/accounting/restore-an-excluded-bank-transaction"},{"title":"Exclude bank feed transactions in bulk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounting/bank-transactions/bulk-exclude","href":"/api-reference/accounting/exclude-bank-feed-transactions-in-bulk"},{"title":"Approve bank feed matches in bulk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounting/bank-transactions/bulk-approve-matches","href":"/api-reference/accounting/approve-bank-feed-matches-in-bulk"},{"title":"Link a bank line to transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounting/bank-transactions/{id}/link-transfer","href":"/api-reference/accounting/link-a-bank-line-to-transfer"},{"title":"Update a reconciliation session","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /accounting/reconciliations/{id}","href":"/api-reference/accounting/update-a-reconciliation-session"},{"title":"List unmatched customer payment receipts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounting/unmatched-receipts","href":"/api-reference/accounting/list-unmatched-customer-payment-receipts"},{"title":"List adjustments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /adjustments","href":"/api-reference/accounting/list-adjustments"},{"title":"Create an adjustment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /adjustments","href":"/api-reference/accounting/create-an-adjustment"},{"title":"List suspense adjustments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /adjustments/suspense","href":"/api-reference/accounting/list-suspense-adjustments"},{"title":"Retrieve a single adjustment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /adjustments/{id}","href":"/api-reference/accounting/retrieve-a-single-adjustment"},{"title":"Reclassify a suspense adjustment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /adjustments/{id}/reclassify","href":"/api-reference/accounting/reclassify-a-suspense-adjustment"},{"title":"List expanded journal entries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /journal-entries/expand","href":"/api-reference/accounting/list-expanded-journal-entries"},{"title":"Retrieve an expanded journal entry","deprecated":null,"version":null,"openapi":"/openapi.yaml get /journal-entries/{id}/expand","href":"/api-reference/accounting/retrieve-an-expanded-journal-entry"},{"title":"Initiate a fiscal period close","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fiscal-periods/{id}/request-close","href":"/api-reference/accounting/initiate-a-fiscal-period-close"},{"title":"Approve a fiscal period close","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fiscal-periods/{id}/approve-close","href":"/api-reference/accounting/approve-a-fiscal-period-close"},{"title":"Close a fiscal period","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fiscal-periods/{id}/close","href":"/api-reference/accounting/close-a-fiscal-period"},{"title":"Retrieve a fiscal period close checklist","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fiscal-periods/{id}/close-checklist","href":"/api-reference/accounting/retrieve-a-fiscal-period-close-checklist"},{"title":"Reopen a fiscal period","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fiscal-periods/{id}/reopen","href":"/api-reference/accounting/reopen-a-fiscal-period"},{"title":"Generate a deposit slip PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /deposits/{id}/print","href":"/api-reference/accounting/generate-a-deposit-slip-pdf"}]},{"group":"Entities","pages":[{"title":"Retrieve entity metadata and settings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{id}","href":"/api-reference/entities/retrieve-entity-metadata-and-settings"}]},{"group":"Orders","pages":[{"title":"List orders currently on hold","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/holds","href":"/api-reference/orders/list-orders-currently-on-hold"},{"title":"List order approval rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/approval-rules","href":"/api-reference/orders/list-order-approval-rules"},{"title":"Create an order approval rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/approval-rules","href":"/api-reference/orders/create-an-order-approval-rule"},{"title":"Delete an order approval rule","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /orders/approval-rules/{id}","href":"/api-reference/orders/delete-an-order-approval-rule"},{"title":"Update an order approval rule","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/approval-rules/{id}","href":"/api-reference/orders/update-an-order-approval-rule"},{"title":"Resolve an order overpayment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/overpayment/resolve","href":"/api-reference/orders/resolve-an-order-overpayment"},{"title":"List orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders","href":"/api-reference/orders/list-orders"},{"title":"Create an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders","href":"/api-reference/orders/create-an-order"},{"title":"Retrieve an order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{id}","href":"/api-reference/orders/retrieve-an-order"},{"title":"Delete an order","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /orders/{id}","href":"/api-reference/orders/delete-an-order"},{"title":"Update an order","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}","href":"/api-reference/orders/update-an-order"},{"title":"Create drop-ship purchase orders","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/dropship-pos","href":"/api-reference/orders/create-drop-ship-purchase-orders"},{"title":"Confirm an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/confirm","href":"/api-reference/orders/confirm-an-order"},{"title":"Preview an order cancellation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{id}/cancel-preview","href":"/api-reference/orders/preview-an-order-cancellation"},{"title":"Unlink a drop-ship sales-order line","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/lines/{lineId}/unlink-drop-ship","href":"/api-reference/orders/unlink-a-drop-ship-sales-order-line"},{"title":"Preview an order's allocation plan","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/allocation-plan","href":"/api-reference/orders/preview-an-orders-allocation-plan"},{"title":"Allocate an order across locations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/allocate","href":"/api-reference/orders/allocate-an-order-across-locations"},{"title":"Cancel an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/cancel","href":"/api-reference/orders/cancel-an-order"},{"title":"Unpack an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/unpack","href":"/api-reference/orders/unpack-an-order"},{"title":"Reverse an order fulfillment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/undo-fulfillment","href":"/api-reference/orders/reverse-an-order-fulfillment"},{"title":"Correct a misshipment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/correct-misshipment","href":"/api-reference/orders/correct-a-misshipment"},{"title":"Void a posted order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/void","href":"/api-reference/orders/void-a-posted-order"},{"title":"Fulfill an order automatically","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/fulfill","href":"/api-reference/orders/fulfill-an-order-automatically"},{"title":"Confirm order pickup","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/confirm-pickup","href":"/api-reference/orders/confirm-order-pickup"},{"title":"Mark a pickup order no-show","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/mark-no-show","href":"/api-reference/orders/mark-a-pickup-order-no-show"},{"title":"Send an order email","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/email","href":"/api-reference/orders/send-an-order-email"},{"title":"List an order's line items","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{id}/items","href":"/api-reference/orders/list-an-orders-line-items"},{"title":"Add a line item","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/items","href":"/api-reference/orders/add-a-line-item"},{"title":"Add line items in bulk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/items/bulk","href":"/api-reference/orders/add-line-items-in-bulk"},{"title":"Remove a line item","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /orders/{id}/items/{item_id}","href":"/api-reference/orders/remove-a-line-item"},{"title":"Update a line item","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /orders/{id}/items/{item_id}","href":"/api-reference/orders/update-a-line-item"},{"title":"Swap a line item's product","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/items/{item_id}/swap","href":"/api-reference/orders/swap-a-line-items-product"},{"title":"Retrieve an order's timeline","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{id}/timeline","href":"/api-reference/orders/retrieve-an-orders-timeline"},{"title":"Add a timeline event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/timeline","href":"/api-reference/orders/add-a-timeline-event"},{"title":"List an order's payments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{id}/payments","href":"/api-reference/orders/list-an-orders-payments"},{"title":"Create an order payment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/payments","href":"/api-reference/orders/create-an-order-payment"},{"title":"Duplicate an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/duplicate","href":"/api-reference/orders/duplicate-an-order"},{"title":"Convert a quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/convert","href":"/api-reference/orders/convert-a-quote"},{"title":"Hold an order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/hold","href":"/api-reference/orders/hold-an-order"},{"title":"Release an order hold","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/release-hold","href":"/api-reference/orders/release-an-order-hold"},{"title":"Preview a ship-to change","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/change-ship-to/preview","href":"/api-reference/orders/preview-a-ship-to-change"},{"title":"Change an order's ship-to address","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/change-ship-to","href":"/api-reference/orders/change-an-orders-ship-to-address"},{"title":"Apply an order adjustment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/adjustments","href":"/api-reference/orders/apply-an-order-adjustment"},{"title":"List quotes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/quotes","href":"/api-reference/orders/list-quotes"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/invoices","href":"/api-reference/orders/list-invoices"},{"title":"List purchase orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/purchase-orders","href":"/api-reference/orders/list-purchase-orders"},{"title":"Approve a pending order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/approve","href":"/api-reference/orders/approve-a-pending-order"},{"title":"Archive a terminal order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/archive","href":"/api-reference/orders/archive-a-terminal-order"},{"title":"Recalculate order totals","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/recalculate","href":"/api-reference/orders/recalculate-order-totals"},{"title":"Retrieve an order's eligible actions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{id}/eligibility","href":"/api-reference/orders/retrieve-an-orders-eligible-actions"},{"title":"Create an invoice","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/invoice","href":"/api-reference/orders/create-an-invoice"},{"title":"Reopen an order's bill","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/invoice/reopen","href":"/api-reference/orders/reopen-an-orders-bill"},{"title":"Retrieve an order's invoice history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /orders/{id}/invoice/corrections","href":"/api-reference/orders/retrieve-an-orders-invoice-history"},{"title":"Acknowledge an order revision","deprecated":null,"version":null,"openapi":"/openapi.yaml post /orders/{id}/customer-acknowledge-revision","href":"/api-reference/orders/acknowledge-an-order-revision"}]},{"group":"Reconciliation","pages":[{"title":"Retrieve a trial balance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{entity_id}/reconciliation/trial-balance","href":"/api-reference/reconciliation/retrieve-a-trial-balance"},{"title":"Retrieve AR aging by customer","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{entity_id}/reconciliation/ar-aging","href":"/api-reference/reconciliation/retrieve-ar-aging-by-customer"},{"title":"Retrieve AP aging by vendor","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{entity_id}/reconciliation/ap-aging","href":"/api-reference/reconciliation/retrieve-ap-aging-by-vendor"},{"title":"Retrieve an inventory valuation snapshot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{entity_id}/reconciliation/inventory-valuation","href":"/api-reference/reconciliation/retrieve-an-inventory-valuation-snapshot"},{"title":"Retrieve cash and bank balances","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{entity_id}/reconciliation/cash-balance","href":"/api-reference/reconciliation/retrieve-cash-and-bank-balances"},{"title":"Retrieve a bank balance as of a date","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{entity_id}/reconciliation/bank-balance-as-of","href":"/api-reference/reconciliation/retrieve-a-bank-balance-as-of-a-date"},{"title":"Retrieve a bank account's reconciliation audit","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{entity_id}/reconciliation/account-audit","href":"/api-reference/reconciliation/retrieve-a-bank-accounts-reconciliation-audit"},{"title":"Retrieve entity resource counts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{entity_id}/reconciliation/counts","href":"/api-reference/reconciliation/retrieve-entity-resource-counts"},{"title":"Compare external records against Arcus","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/reconciliation/compare","href":"/api-reference/reconciliation/compare-external-records-against-arcus"},{"title":"Suggest marketplace payout matches","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{entity_id}/reconciliation/marketplace-payout-candidates","href":"/api-reference/reconciliation/suggest-marketplace-payout-matches"},{"title":"Match a payout to a deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/reconciliation/match-marketplace-payout","href":"/api-reference/reconciliation/match-a-payout-to-a-deposit"},{"title":"Match a bank line to a journal entry","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/reconciliation/match-journal-entry","href":"/api-reference/reconciliation/match-a-bank-line-to-a-journal-entry"}]},{"group":"Migration","pages":[{"title":"Import bulk records","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/migration/{resource}/bulk","href":"/api-reference/migration/import-bulk-records"},{"title":"List migration jobs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{entity_id}/migration/jobs","href":"/api-reference/migration/list-migration-jobs"},{"title":"Retrieve a migration job","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{entity_id}/migration/jobs/{job_id}","href":"/api-reference/migration/retrieve-a-migration-job"},{"title":"Advance a migration counter","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/migration/counters/advance","href":"/api-reference/migration/advance-a-migration-counter"},{"title":"Cancel migration jobs","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/migration/jobs/cancel","href":"/api-reference/migration/cancel-migration-jobs"},{"title":"Relink migrated journal entry sources","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/migration/journal-entries/relink-source","href":"/api-reference/migration/relink-migrated-journal-entry-sources"},{"title":"Remap migrated GL accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/migration/gl-accounts/remap","href":"/api-reference/migration/remap-migrated-gl-accounts"},{"title":"Relink migrated inventory transaction sources","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/migration/inventory-transactions/relink-source","href":"/api-reference/migration/relink-migrated-inventory-transaction-sources"},{"title":"Set a migrated purchase order's balance","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/migration/purchase-orders/set-historical-balance","href":"/api-reference/migration/set-a-migrated-purchase-orders-balance"},{"title":"Freeze an entity for cutover","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/migration/cutover/freeze","href":"/api-reference/migration/freeze-an-entity-for-cutover"},{"title":"Initiate a cutover snapshot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/migration/cutover/snapshot","href":"/api-reference/migration/initiate-a-cutover-snapshot"},{"title":"Emit cutover swap commands","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/migration/cutover/swap","href":"/api-reference/migration/emit-cutover-swap-commands"},{"title":"Verify cutover readiness","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/migration/cutover/verify","href":"/api-reference/migration/verify-cutover-readiness"},{"title":"Unfreeze an entity after cutover","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/migration/cutover/unfreeze","href":"/api-reference/migration/unfreeze-an-entity-after-cutover"},{"title":"Emit cutover rollback commands","deprecated":null,"version":null,"openapi":"/openapi.yaml post /entities/{entity_id}/migration/cutover/rollback","href":"/api-reference/migration/emit-cutover-rollback-commands"},{"title":"Retrieve cutover status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{entity_id}/migration/cutover/status","href":"/api-reference/migration/retrieve-cutover-status"},{"title":"List cutover log entries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /entities/{entity_id}/migration/cutover/log","href":"/api-reference/migration/list-cutover-log-entries"}]},{"group":"Entity Settings","pages":[{"title":"Merge entity settings","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /entities/{entity_id}/settings","href":"/api-reference/entity-settings/merge-entity-settings"}]},{"group":"Accounts","pages":[{"title":"List addresses across all accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /account-addresses","href":"/api-reference/accounts/list-addresses-across-all-accounts"},{"title":"List contacts across all accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /account-contacts","href":"/api-reference/accounts/list-contacts-across-all-accounts"},{"title":"List payment methods across accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /account-payment-methods","href":"/api-reference/accounts/list-payment-methods-across-accounts"},{"title":"List accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts","href":"/api-reference/accounts/list-accounts"},{"title":"Create an account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts","href":"/api-reference/accounts/create-an-account"},{"title":"Retrieve an account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{id}","href":"/api-reference/accounts/retrieve-an-account"},{"title":"Delete an account","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /accounts/{id}","href":"/api-reference/accounts/delete-an-account"},{"title":"Update an account","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /accounts/{id}","href":"/api-reference/accounts/update-an-account"},{"title":"Deactivate an account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{id}/deactivate","href":"/api-reference/accounts/deactivate-an-account"},{"title":"Restore a deactivated account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{id}/restore","href":"/api-reference/accounts/restore-a-deactivated-account"},{"title":"Apply or release credit hold","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{id}/credit-hold","href":"/api-reference/accounts/apply-or-release-credit-hold"},{"title":"Merge two accounts","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{id}/merge","href":"/api-reference/accounts/merge-two-accounts"},{"title":"Retrieve an account's analytics summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{id}/analytics/summary","href":"/api-reference/accounts/retrieve-an-accounts-analytics-summary"},{"title":"List addresses for an account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{id}/addresses","href":"/api-reference/accounts/list-addresses-for-an-account"},{"title":"Add an address to an account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{id}/addresses","href":"/api-reference/accounts/add-an-address-to-an-account"},{"title":"Remove an address from an account","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /accounts/{id}/addresses/{addr_id}","href":"/api-reference/accounts/remove-an-address-from-an-account"},{"title":"Update an address","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /accounts/{id}/addresses/{addr_id}","href":"/api-reference/accounts/update-an-address"},{"title":"Set an address as default","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{id}/addresses/{addr_id}/set-default","href":"/api-reference/accounts/set-an-address-as-default"},{"title":"List contacts for an account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{id}/contacts","href":"/api-reference/accounts/list-contacts-for-an-account"},{"title":"Add a contact to an account","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{id}/contacts","href":"/api-reference/accounts/add-a-contact-to-an-account"},{"title":"Remove a contact from an account","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /accounts/{id}/contacts/{cnt_id}","href":"/api-reference/accounts/remove-a-contact-from-an-account"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /accounts/{id}/contacts/{cnt_id}","href":"/api-reference/accounts/update-a-contact"},{"title":"Set a contact as primary","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{id}/contacts/{cnt_id}/set-primary","href":"/api-reference/accounts/set-a-contact-as-primary"},{"title":"List an account's payment methods","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{id}/payment-methods","href":"/api-reference/accounts/list-an-accounts-payment-methods"},{"title":"Attach a payment method","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{id}/payment-methods","href":"/api-reference/accounts/attach-a-payment-method"},{"title":"Attach a confirmed payment method","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{id}/payment-methods/{pm_id}/attach","href":"/api-reference/accounts/attach-a-confirmed-payment-method"},{"title":"Remove an account's payment method","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /accounts/{id}/payment-methods/{pm_id}","href":"/api-reference/accounts/remove-an-accounts-payment-method"},{"title":"Set a payment method as default","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /accounts/{id}/payment-methods/{pm_id}","href":"/api-reference/accounts/set-a-payment-method-as-default"},{"title":"Verify micro-deposits for a payment method","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{id}/payment-methods/{pm_id}/verify-microdeposits","href":"/api-reference/accounts/verify-micro-deposits-for-a-payment-method"},{"title":"List customer deposits for an account","deprecated":null,"version":null,"openapi":"/openapi.yaml get /accounts/{id}/deposits","href":"/api-reference/accounts/list-customer-deposits-for-an-account"},{"title":"Record a customer deposit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{id}/deposits","href":"/api-reference/accounts/record-a-customer-deposit"},{"title":"Create a payment method setup intent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /accounts/{id}/payment-methods/setup","href":"/api-reference/accounts/create-a-payment-method-setup-intent"}]},{"group":"Products","pages":[{"title":"List products","deprecated":null,"version":null,"openapi":"/openapi.yaml get /products","href":"/api-reference/products/list-products"},{"title":"Create a product","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products","href":"/api-reference/products/create-a-product"},{"title":"Retrieve a product","deprecated":null,"version":null,"openapi":"/openapi.yaml get /products/{id}","href":"/api-reference/products/retrieve-a-product"},{"title":"Delete a product","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /products/{id}","href":"/api-reference/products/delete-a-product"},{"title":"Update a product","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /products/{id}","href":"/api-reference/products/update-a-product"},{"title":"List a product's available locations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /products/{id}/locations","href":"/api-reference/products/list-a-products-available-locations"},{"title":"Set a product's available locations","deprecated":null,"version":null,"openapi":"/openapi.yaml put /products/{id}/locations","href":"/api-reference/products/set-a-products-available-locations"},{"title":"Restore a deactivated product","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products/{id}/restore","href":"/api-reference/products/restore-a-deactivated-product"},{"title":"List a product's prepackaged presets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /products/{id}/prepackaged-presets","href":"/api-reference/products/list-a-products-prepackaged-presets"},{"title":"Create a prepackaged preset","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products/{id}/prepackaged-presets","href":"/api-reference/products/create-a-prepackaged-preset"},{"title":"Delete a prepackaged preset","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /products/{id}/prepackaged-presets/{preset_id}","href":"/api-reference/products/delete-a-prepackaged-preset"},{"title":"Update a prepackaged preset","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /products/{id}/prepackaged-presets/{preset_id}","href":"/api-reference/products/update-a-prepackaged-preset"},{"title":"Deactivate a product","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products/{id}/deactivate","href":"/api-reference/products/deactivate-a-product"},{"title":"List a product's kit components","deprecated":null,"version":null,"openapi":"/openapi.yaml get /products/{id}/components","href":"/api-reference/products/list-a-products-kit-components"},{"title":"Add a product's kit component","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products/{id}/components","href":"/api-reference/products/add-a-products-kit-component"},{"title":"Add a product image","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products/{id}/images","href":"/api-reference/products/add-a-product-image"},{"title":"Remove a product's kit component","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /products/{id}/components/{cid}","href":"/api-reference/products/remove-a-products-kit-component"},{"title":"List a product's variants","deprecated":null,"version":null,"openapi":"/openapi.yaml get /products/{id}/variants","href":"/api-reference/products/list-a-products-variants"},{"title":"Add a variant","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products/{id}/variants","href":"/api-reference/products/add-a-variant"},{"title":"Update a product variant","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /products/{id}/variants/{vid}","href":"/api-reference/products/update-a-product-variant"},{"title":"List a product's pricing policies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /products/{id}/pricing","href":"/api-reference/products/list-a-products-pricing-policies"},{"title":"Add a pricing policy","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products/{id}/pricing","href":"/api-reference/products/add-a-pricing-policy"},{"title":"List a product's vendor relationships","deprecated":null,"version":null,"openapi":"/openapi.yaml get /products/{id}/vendors","href":"/api-reference/products/list-a-products-vendor-relationships"},{"title":"Add a vendor relationship","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products/{id}/vendors","href":"/api-reference/products/add-a-vendor-relationship"},{"title":"Remove a vendor relationship","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /products/{id}/vendors/{pvid}","href":"/api-reference/products/remove-a-vendor-relationship"},{"title":"Update a vendor relationship","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /products/{id}/vendors/{pvid}","href":"/api-reference/products/update-a-vendor-relationship"},{"title":"List a product's marketplace listings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /products/{id}/listings","href":"/api-reference/products/list-a-products-marketplace-listings"},{"title":"Add a marketplace listing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products/{id}/listings","href":"/api-reference/products/add-a-marketplace-listing"},{"title":"Retrieve a product's inventory","deprecated":null,"version":null,"openapi":"/openapi.yaml get /products/{id}/inventory","href":"/api-reference/products/retrieve-a-products-inventory"},{"title":"List pricing policies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /pricing-policies","href":"/api-reference/products/list-pricing-policies"},{"title":"Create a pricing policy","deprecated":null,"version":null,"openapi":"/openapi.yaml post /pricing-policies","href":"/api-reference/products/create-a-pricing-policy"},{"title":"Retrieve a pricing policy","deprecated":null,"version":null,"openapi":"/openapi.yaml get /pricing-policies/{id}","href":"/api-reference/products/retrieve-a-pricing-policy"},{"title":"Delete a pricing policy","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /pricing-policies/{id}","href":"/api-reference/products/delete-a-pricing-policy"},{"title":"Update a pricing policy","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /pricing-policies/{id}","href":"/api-reference/products/update-a-pricing-policy"},{"title":"List kits and bundles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /kits","href":"/api-reference/products/list-kits-and-bundles"},{"title":"Create a kit or bundle","deprecated":null,"version":null,"openapi":"/openapi.yaml post /kits","href":"/api-reference/products/create-a-kit-or-bundle"},{"title":"Retrieve a kit","deprecated":null,"version":null,"openapi":"/openapi.yaml get /kits/{id}","href":"/api-reference/products/retrieve-a-kit"},{"title":"Update a kit","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /kits/{id}","href":"/api-reference/products/update-a-kit"},{"title":"List kit components","deprecated":null,"version":null,"openapi":"/openapi.yaml get /kits/{id}/components","href":"/api-reference/products/list-kit-components"},{"title":"Add a kit component","deprecated":null,"version":null,"openapi":"/openapi.yaml post /kits/{id}/components","href":"/api-reference/products/add-a-kit-component"},{"title":"Remove a kit component","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /kits/{id}/components/{cid}","href":"/api-reference/products/remove-a-kit-component"},{"title":"Update a kit component","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /kits/{id}/components/{cid}","href":"/api-reference/products/update-a-kit-component"},{"title":"List all variants","deprecated":null,"version":null,"openapi":"/openapi.yaml get /variants","href":"/api-reference/products/list-all-variants"},{"title":"Create a product variant","deprecated":null,"version":null,"openapi":"/openapi.yaml post /variants","href":"/api-reference/products/create-a-product-variant"},{"title":"Retrieve a variant","deprecated":null,"version":null,"openapi":"/openapi.yaml get /variants/{id}","href":"/api-reference/products/retrieve-a-variant"},{"title":"Delete a variant","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /variants/{id}","href":"/api-reference/products/delete-a-variant"},{"title":"Update a variant","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /variants/{id}","href":"/api-reference/products/update-a-variant"},{"title":"Add a variant component","deprecated":null,"version":null,"openapi":"/openapi.yaml post /variants/{id}/components","href":"/api-reference/products/add-a-variant-component"},{"title":"Remove a variant component","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /variants/{id}/components/{cid}","href":"/api-reference/products/remove-a-variant-component"},{"title":"Update a variant component","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /variants/{id}/components/{cid}","href":"/api-reference/products/update-a-variant-component"},{"title":"List a product's options","deprecated":null,"version":null,"openapi":"/openapi.yaml get /products/{id}/options","href":"/api-reference/products/list-a-products-options"},{"title":"Create a product option","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products/{id}/options","href":"/api-reference/products/create-a-product-option"},{"title":"Delete a product option","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /products/{id}/options/{oid}","href":"/api-reference/products/delete-a-product-option"},{"title":"Update a product option","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /products/{id}/options/{oid}","href":"/api-reference/products/update-a-product-option"},{"title":"Reorder product options","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products/{id}/options/reorder","href":"/api-reference/products/reorder-product-options"},{"title":"Generate variants from options","deprecated":null,"version":null,"openapi":"/openapi.yaml post /products/{id}/variants/generate","href":"/api-reference/products/generate-variants-from-options"}]},{"group":"Inventory","pages":[{"title":"List inventory balances","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory/balances","href":"/api-reference/inventory/list-inventory-balances"},{"title":"Retrieve an inventory balance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory/balances/{id}","href":"/api-reference/inventory/retrieve-an-inventory-balance"},{"title":"List inventory movement history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory/transactions","href":"/api-reference/inventory/list-inventory-movement-history"},{"title":"Retrieve a transaction's cost layers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory/transactions/{id}/layers","href":"/api-reference/inventory/retrieve-a-transactions-cost-layers"},{"title":"Receive inventory outside a purchase order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory/receive","href":"/api-reference/inventory/receive-inventory-outside-a-purchase-order"},{"title":"Adjust inventory quantities","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory/adjustments","href":"/api-reference/inventory/adjust-inventory-quantities"},{"title":"Set an opening inventory balance","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory/opening-stock","href":"/api-reference/inventory/set-an-opening-inventory-balance"},{"title":"Move inventory between locations","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory/transfers","href":"/api-reference/inventory/move-inventory-between-locations"},{"title":"List serial numbers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory/serials","href":"/api-reference/inventory/list-serial-numbers"},{"title":"Create serial numbers in bulk","deprecated":null,"version":null,"openapi":"/openapi.yaml post /inventory/serials","href":"/api-reference/inventory/create-serial-numbers-in-bulk"},{"title":"Retrieve a serial number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory/serials/{id}","href":"/api-reference/inventory/retrieve-a-serial-number"},{"title":"Update a serial number's status","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /inventory/serials/{id}","href":"/api-reference/inventory/update-a-serial-numbers-status"},{"title":"List a product's FIFO layers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /inventory/fifo-layers","href":"/api-reference/inventory/list-a-products-fifo-layers"},{"title":"List inventory transfers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /transfers","href":"/api-reference/inventory/list-inventory-transfers"},{"title":"Create an inventory transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transfers","href":"/api-reference/inventory/create-an-inventory-transfer"},{"title":"Retrieve a transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml get /transfers/{id}","href":"/api-reference/inventory/retrieve-a-transfer"},{"title":"Update a transfer's header fields","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /transfers/{id}","href":"/api-reference/inventory/update-a-transfers-header-fields"},{"title":"Submit a draft transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transfers/{id}/submit","href":"/api-reference/inventory/submit-a-draft-transfer"},{"title":"Approve an intercompany transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transfers/{id}/approve","href":"/api-reference/inventory/approve-an-intercompany-transfer"},{"title":"Reject an intercompany transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transfers/{id}/reject","href":"/api-reference/inventory/reject-an-intercompany-transfer"},{"title":"Ship an approved transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transfers/{id}/ship","href":"/api-reference/inventory/ship-an-approved-transfer"},{"title":"Receive a transfer's items","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transfers/{id}/receive","href":"/api-reference/inventory/receive-a-transfers-items"},{"title":"Cancel a transfer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /transfers/{id}/cancel","href":"/api-reference/inventory/cancel-a-transfer"},{"title":"Retrieve a transfer's shipping label","deprecated":null,"version":null,"openapi":"/openapi.yaml get /transfers/{id}/labels","href":"/api-reference/inventory/retrieve-a-transfers-shipping-label"}]},{"group":"Returns","pages":[{"title":"List returns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /returns","href":"/api-reference/returns/list-returns"},{"title":"Create a return","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns","href":"/api-reference/returns/create-a-return"},{"title":"Retrieve a return","deprecated":null,"version":null,"openapi":"/openapi.yaml get /returns/{id}","href":"/api-reference/returns/retrieve-a-return"},{"title":"Update a return","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /returns/{id}","href":"/api-reference/returns/update-a-return"},{"title":"Add items to a return","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{id}/items","href":"/api-reference/returns/add-items-to-a-return"},{"title":"Receive return items","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{id}/receive","href":"/api-reference/returns/receive-return-items"},{"title":"Record a return inspection","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{id}/inspect","href":"/api-reference/returns/record-a-return-inspection"},{"title":"Disposition returned items","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{id}/disposition","href":"/api-reference/returns/disposition-returned-items"},{"title":"Resolve quarantined return units","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{id}/quarantine/resolve","href":"/api-reference/returns/resolve-quarantined-return-units"},{"title":"Receive and disposition a return","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{id}/receive-and-dispose","href":"/api-reference/returns/receive-and-disposition-a-return"},{"title":"Refund a return","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{id}/refund","href":"/api-reference/returns/refund-a-return"},{"title":"Cancel a return","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{id}/cancel","href":"/api-reference/returns/cancel-a-return"},{"title":"Estimate return label rates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /returns/{id}/return-label/rates","href":"/api-reference/returns/estimate-return-label-rates"},{"title":"Create a return shipping label","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{id}/return-label","href":"/api-reference/returns/create-a-return-shipping-label"},{"title":"Create an exchange order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{id}/exchange","href":"/api-reference/returns/create-an-exchange-order"},{"title":"Create an advance replacement order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{id}/advance-replacement","href":"/api-reference/returns/create-an-advance-replacement-order"},{"title":"Create vendor return from an RMA","deprecated":null,"version":null,"openapi":"/openapi.yaml post /returns/{id}/vendor-return","href":"/api-reference/returns/create-vendor-return-from-an-rma"},{"title":"List vendor returns","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-returns","href":"/api-reference/returns/list-vendor-returns"},{"title":"Create a vendor return","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-returns","href":"/api-reference/returns/create-a-vendor-return"},{"title":"Retrieve a vendor return","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-returns/{id}","href":"/api-reference/returns/retrieve-a-vendor-return"},{"title":"Delete a vendor return","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /vendor-returns/{id}","href":"/api-reference/returns/delete-a-vendor-return"},{"title":"Update a vendor return","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /vendor-returns/{id}","href":"/api-reference/returns/update-a-vendor-return"},{"title":"Retrieve a vendor return PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-returns/{id}/pdf","href":"/api-reference/returns/retrieve-a-vendor-return-pdf"},{"title":"Ship a vendor return","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-returns/{id}/ship","href":"/api-reference/returns/ship-a-vendor-return"},{"title":"Record a vendor return credit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-returns/{id}/receive-credit","href":"/api-reference/returns/record-a-vendor-return-credit"},{"title":"Cancel a vendor return","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-returns/{id}/cancel","href":"/api-reference/returns/cancel-a-vendor-return"},{"title":"Estimate vendor return label rates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-returns/{id}/return-label/rates","href":"/api-reference/returns/estimate-vendor-return-label-rates"}]},{"group":"Fulfillment","pages":[{"title":"List packages","deprecated":null,"version":null,"openapi":"/openapi.yaml get /packages","href":"/api-reference/fulfillment/list-packages"},{"title":"Create a package","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages","href":"/api-reference/fulfillment/create-a-package"},{"title":"Retrieve a package","deprecated":null,"version":null,"openapi":"/openapi.yaml get /packages/{id}","href":"/api-reference/fulfillment/retrieve-a-package"},{"title":"Delete a package","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /packages/{id}","href":"/api-reference/fulfillment/delete-a-package"},{"title":"Update a package","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /packages/{id}","href":"/api-reference/fulfillment/update-a-package"},{"title":"Add an item to a package","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/items","href":"/api-reference/fulfillment/add-an-item-to-a-package"},{"title":"Remove a package item","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /packages/{id}/items/{item_id}","href":"/api-reference/fulfillment/remove-a-package-item"},{"title":"Update a package item","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /packages/{id}/items/{item_id}","href":"/api-reference/fulfillment/update-a-package-item"},{"title":"Move a package item","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/items/{item_id}/move","href":"/api-reference/fulfillment/move-a-package-item"},{"title":"Update a package's box type","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/change-box","href":"/api-reference/fulfillment/update-a-packages-box-type"},{"title":"Update a package's carrier","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/change-carrier","href":"/api-reference/fulfillment/update-a-packages-carrier"},{"title":"Retrieve package shipping rates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /packages/{id}/rates","href":"/api-reference/fulfillment/retrieve-package-shipping-rates"},{"title":"Purchase a package shipping label","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/buy-label","href":"/api-reference/fulfillment/purchase-a-package-shipping-label"},{"title":"Void a package label","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/void-label","href":"/api-reference/fulfillment/void-a-package-label"},{"title":"Adjust a package's shipping cost","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/recharge-label","href":"/api-reference/fulfillment/adjust-a-packages-shipping-cost"},{"title":"Print a package's shipping label","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/print-label","href":"/api-reference/fulfillment/print-a-packages-shipping-label"},{"title":"Fulfill a package","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/fulfill","href":"/api-reference/fulfillment/fulfill-a-package"},{"title":"Recalculate a package's delivery estimate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/recalc-eta","href":"/api-reference/fulfillment/recalculate-a-packages-delivery-estimate"},{"title":"Record a package's PRO number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/pro-number","href":"/api-reference/fulfillment/record-a-packages-pro-number"},{"title":"Retrieve a packing slip","deprecated":null,"version":null,"openapi":"/openapi.yaml get /packages/{id}/packing-slip","href":"/api-reference/fulfillment/retrieve-a-packing-slip"},{"title":"Send a shipment notification","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/email","href":"/api-reference/fulfillment/send-a-shipment-notification"},{"title":"List tracking events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tracking-events","href":"/api-reference/fulfillment/list-tracking-events"},{"title":"Retrieve a tracking event","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tracking-events/{id}","href":"/api-reference/fulfillment/retrieve-a-tracking-event"},{"title":"List shipping labels","deprecated":null,"version":null,"openapi":"/openapi.yaml get /labels","href":"/api-reference/fulfillment/list-shipping-labels"},{"title":"Retrieve a shipping label","deprecated":null,"version":null,"openapi":"/openapi.yaml get /labels/{id}","href":"/api-reference/fulfillment/retrieve-a-shipping-label"},{"title":"Pack an order automatically","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fulfillment/pack-order","href":"/api-reference/fulfillment/pack-an-order-automatically"},{"title":"Calculate a package's delivery estimate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/recalculate-eta","href":"/api-reference/fulfillment/calculate-a-packages-delivery-estimate"},{"title":"Set a package's PRO number","deprecated":null,"version":null,"openapi":"/openapi.yaml post /packages/{id}/set-pro-number","href":"/api-reference/fulfillment/set-a-packages-pro-number"}]},{"group":"Purchasing","pages":[{"title":"Retrieve the reorder report","deprecated":null,"version":null,"openapi":"/openapi.yaml get /purchasing/reorder-report","href":"/api-reference/purchasing/retrieve-the-reorder-report"},{"title":"List purchase orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /purchase-orders","href":"/api-reference/purchasing/list-purchase-orders"},{"title":"Create a purchase order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /purchase-orders","href":"/api-reference/purchasing/create-a-purchase-order"},{"title":"Retrieve a purchase order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /purchase-orders/{id}","href":"/api-reference/purchasing/retrieve-a-purchase-order"},{"title":"Update a purchase order","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /purchase-orders/{id}","href":"/api-reference/purchasing/update-a-purchase-order"},{"title":"Cancel a purchase order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /purchase-orders/{id}/cancel","href":"/api-reference/purchasing/cancel-a-purchase-order"},{"title":"Restore a cancelled purchase order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /purchase-orders/{id}/restore","href":"/api-reference/purchasing/restore-a-cancelled-purchase-order"},{"title":"Restate a purchase order loaded from the previous system as fulfilled","deprecated":null,"version":null,"openapi":"/openapi.yaml post /purchase-orders/{id}/restate-fulfilled","href":"/api-reference/purchasing/restate-a-purchase-order-loaded-from-the-previous-system-as-fulfilled"},{"title":"Approve a purchase order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /purchase-orders/{id}/approve","href":"/api-reference/purchasing/approve-a-purchase-order"},{"title":"Receive a purchase order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /purchase-orders/{id}/receive","href":"/api-reference/purchasing/receive-a-purchase-order"},{"title":"Check drop-ship undo eligibility","deprecated":null,"version":null,"openapi":"/openapi.yaml get /purchase-receipts/{id}/dropship-undo-eligibility","href":"/api-reference/purchasing/check-drop-ship-undo-eligibility"},{"title":"Undo a drop-ship receipt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /purchase-receipts/{id}/undo-dropship","href":"/api-reference/purchasing/undo-a-drop-ship-receipt"},{"title":"Add a purchase order line","deprecated":null,"version":null,"openapi":"/openapi.yaml post /purchase-orders/{id}/items","href":"/api-reference/purchasing/add-a-purchase-order-line"},{"title":"Delete a purchase order line item","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /purchase-orders/{id}/items/{itemId}","href":"/api-reference/purchasing/delete-a-purchase-order-line-item"},{"title":"Update a purchase order line","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /purchase-orders/{id}/items/{itemId}","href":"/api-reference/purchasing/update-a-purchase-order-line"},{"title":"Send a purchase order to vendor","deprecated":null,"version":null,"openapi":"/openapi.yaml post /purchase-orders/{id}/send-to-vendor","href":"/api-reference/purchasing/send-a-purchase-order-to-vendor"},{"title":"Record a PO revision decision","deprecated":null,"version":null,"openapi":"/openapi.yaml post /purchase-orders/{id}/notify-revision","href":"/api-reference/purchasing/record-a-po-revision-decision"},{"title":"List vendor bills","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-bills","href":"/api-reference/purchasing/list-vendor-bills"},{"title":"Create a vendor bill","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-bills","href":"/api-reference/purchasing/create-a-vendor-bill"},{"title":"List receipts available for landed bills","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-bills/landed-receipts","href":"/api-reference/purchasing/list-receipts-available-for-landed-bills"},{"title":"Update a vendor bill's lines","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-bills/{id}/edit-lines","href":"/api-reference/purchasing/update-a-vendor-bills-lines"},{"title":"Retrieve a vendor bill","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-bills/{id}","href":"/api-reference/purchasing/retrieve-a-vendor-bill"},{"title":"Void a vendor bill","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /vendor-bills/{id}","href":"/api-reference/purchasing/void-a-vendor-bill"},{"title":"Update a vendor bill","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /vendor-bills/{id}","href":"/api-reference/purchasing/update-a-vendor-bill"},{"title":"Approve a vendor bill","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-bills/{id}/approve","href":"/api-reference/purchasing/approve-a-vendor-bill"},{"title":"Reject a vendor bill","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-bills/{id}/reject","href":"/api-reference/purchasing/reject-a-vendor-bill"},{"title":"Record a vendor bill write-off","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-bills/{id}/write-off","href":"/api-reference/purchasing/record-a-vendor-bill-write-off"},{"title":"Correct a bill's landed cost","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-bills/{id}/correct-landed-cost","href":"/api-reference/purchasing/correct-a-bills-landed-cost"},{"title":"Preview what voiding a vendor bill would move","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-bills/{id}/void-preview","href":"/api-reference/purchasing/preview-what-voiding-a-vendor-bill-would-move"},{"title":"List vendor prepayments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendors/{id}/prepayments","href":"/api-reference/purchasing/list-vendor-prepayments"},{"title":"Record a vendor prepayment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendors/{id}/prepayments","href":"/api-reference/purchasing/record-a-vendor-prepayment"},{"title":"List the entity's vendor prepayments","description":"Lists the entity's vendor prepayments, by default the open ones (active or partially applied, the money still out with vendors), or one status, or `all` (voided included), filtered by vendor, by purchase order and by `q` (a case-insensitive search of the prepayment number, the vendor's name and the note). `segment_counts` counts every status over the same vendor, purchase-order and search filters but not the status filter, and `meta.total_open_balance` is the open sum. Paginated with `page` and `per_page` (up to 100); requires `ap:read` scope.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-prepayments","href":"/api-reference/purchasing/list-the-entitys-vendor-prepayments"},{"title":"Retrieve a vendor prepayment and where it went","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-prepayments/{id}","href":"/api-reference/purchasing/retrieve-a-vendor-prepayment-and-where-it-went"},{"title":"Set or clear a vendor prepayment's purchase order","description":"Points an open prepayment at a purchase order of the entity, or clears it with `po_id: null`. The order is checked by the same rule as recording a prepayment: a live purchase order of this entity that is not cancelled, archived, expired, closed short or fully billed. `po_link_kind` is `goods` (an advance on its own vendor's order) or `landed` (a freight, customs or duty advance on another vendor's order); omitted, it is computed from the order's vendor (`landed` when the order's vendor is not the prepayment's vendor). Nothing is posted: no journal entry, no balance or application changes. The automatic `unrelieved_prepayment` holds of the old and the new order's bills follow the pointer (`holds_plan`, `released_bill_holds`, `held_bill_holds`). Sending the state the prepayment already has answers `unchanged: true` and writes nothing. Requires `ap:write` scope. Refused 400 `missing_po_id` (the body names no `po_id`), `invalid_po_id`, `invalid_po_link_kind`, `po_link_kind_requires_po`, `invalid_prepayment_id`, `missing_prepayment_id` or `missing_entity_id`; 404 `prepayment_not_found` or `purchase_order_not_found`; 409 `prepayment_not_open` (refunded, voided or fully applied); 422 `purchase_order_not_prepayable` (with a `reason`) or `purchase_order_not_this_vendors` (a `goods` kind on another vendor's order).","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /vendor-prepayments/{id}","href":"/api-reference/purchasing/set-or-clear-a-vendor-prepayments-purchase-order"},{"title":"Apply a vendor prepayment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-prepayments/{id}/apply","href":"/api-reference/purchasing/apply-a-vendor-prepayment"},{"title":"Refund a vendor prepayment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-prepayments/{id}/refund","href":"/api-reference/purchasing/refund-a-vendor-prepayment"},{"title":"Reverse a vendor prepayment application","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-prepayments/{id}/unapply","href":"/api-reference/purchasing/reverse-a-vendor-prepayment-application"},{"title":"Void a vendor prepayment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-prepayments/{id}/void","href":"/api-reference/purchasing/void-a-vendor-prepayment"},{"title":"List AP payments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /ap-payments","href":"/api-reference/purchasing/list-ap-payments"},{"title":"Create an AP payment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /ap-payments","href":"/api-reference/purchasing/create-an-ap-payment"},{"title":"Retrieve an AP payment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /ap-payments/{id}","href":"/api-reference/purchasing/retrieve-an-ap-payment"},{"title":"Void an AP payment","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /ap-payments/{id}","href":"/api-reference/purchasing/void-an-ap-payment"},{"title":"List AP payment batches","deprecated":null,"version":null,"openapi":"/openapi.yaml get /ap-payments/batches","href":"/api-reference/purchasing/list-ap-payment-batches"},{"title":"Create an AP payment batch","deprecated":null,"version":null,"openapi":"/openapi.yaml post /ap-payments/batch","href":"/api-reference/purchasing/create-an-ap-payment-batch"},{"title":"Retrieve a payment batch","deprecated":null,"version":null,"openapi":"/openapi.yaml get /ap-payments/batches/{batchId}","href":"/api-reference/purchasing/retrieve-a-payment-batch"},{"title":"Void a payment batch","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /ap-payments/batches/{batchId}","href":"/api-reference/purchasing/void-a-payment-batch"},{"title":"Download a batch's NACHA file","deprecated":null,"version":null,"openapi":"/openapi.yaml get /ap-payments/batches/{batchId}/nacha","href":"/api-reference/purchasing/download-a-batchs-nacha-file"},{"title":"Generate a batch's NACHA file","deprecated":null,"version":null,"openapi":"/openapi.yaml post /ap-payments/batches/{batchId}/nacha","href":"/api-reference/purchasing/generate-a-batchs-nacha-file"},{"title":"Confirm NACHA batch sent","deprecated":null,"version":null,"openapi":"/openapi.yaml post /ap-payments/batches/{batchId}/confirm-sent","href":"/api-reference/purchasing/confirm-nacha-batch-sent"},{"title":"List printed checks","deprecated":null,"version":null,"openapi":"/openapi.yaml get /printed-checks","href":"/api-reference/purchasing/list-printed-checks"},{"title":"Retrieve a printed check","deprecated":null,"version":null,"openapi":"/openapi.yaml get /printed-checks/{id}","href":"/api-reference/purchasing/retrieve-a-printed-check"},{"title":"Void a printed check","deprecated":null,"version":null,"openapi":"/openapi.yaml post /printed-checks/{id}/void","href":"/api-reference/purchasing/void-a-printed-check"},{"title":"Reprint a check","deprecated":null,"version":null,"openapi":"/openapi.yaml post /printed-checks/{id}/reprint","href":"/api-reference/purchasing/reprint-a-check"},{"title":"Retrieve the next check number","deprecated":null,"version":null,"openapi":"/openapi.yaml get /printed-checks/next-number","href":"/api-reference/purchasing/retrieve-the-next-check-number"},{"title":"Generate a check batch","deprecated":null,"version":null,"openapi":"/openapi.yaml post /printed-checks/batch-print","href":"/api-reference/purchasing/generate-a-check-batch"},{"title":"Create a quick check","deprecated":null,"version":null,"openapi":"/openapi.yaml post /quick-check","href":"/api-reference/purchasing/create-a-quick-check"},{"title":"List vendor credits","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-credits","href":"/api-reference/purchasing/list-vendor-credits"},{"title":"Create a vendor credit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-credits","href":"/api-reference/purchasing/create-a-vendor-credit"},{"title":"Retrieve a vendor credit","deprecated":null,"version":null,"openapi":"/openapi.yaml get /vendor-credits/{id}","href":"/api-reference/purchasing/retrieve-a-vendor-credit"},{"title":"Void a vendor credit","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /vendor-credits/{id}","href":"/api-reference/purchasing/void-a-vendor-credit"},{"title":"Un-apply one application of a vendor credit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-credits/{id}/unapply","href":"/api-reference/purchasing/un-apply-one-application-of-a-vendor-credit"},{"title":"Apply a vendor credit","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-credits/{id}/apply","href":"/api-reference/purchasing/apply-a-vendor-credit"},{"title":"Post a vendor bill","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-bills/{id}/post","href":"/api-reference/purchasing/post-a-vendor-bill"},{"title":"Post a price variance revaluation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /vendor-bills/{id}/post-revaluation","href":"/api-reference/purchasing/post-a-price-variance-revaluation"},{"title":"Generate a check PDF","deprecated":null,"version":null,"openapi":"/openapi.yaml post /printed-checks/{id}/print","href":"/api-reference/purchasing/generate-a-check-pdf"},{"title":"Reconcile a printed check","deprecated":null,"version":null,"openapi":"/openapi.yaml post /printed-checks/{id}/clear","href":"/api-reference/purchasing/reconcile-a-printed-check"},{"title":"Set a check's drawee bank","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /printed-checks/{id}/bank","href":"/api-reference/purchasing/set-a-checks-drawee-bank"},{"title":"List receipts for a purchase order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /purchase-orders/{id}/receipts","href":"/api-reference/purchasing/list-receipts-for-a-purchase-order"},{"title":"Retrieve a purchase order's landed costs","deprecated":null,"version":null,"openapi":"/openapi.yaml get /purchase-orders/{id}/landed-costs","href":"/api-reference/purchasing/retrieve-a-purchase-orders-landed-costs"}]},{"group":"Activity","pages":[{"title":"List activity events","deprecated":null,"version":null,"openapi":"/openapi.yaml get /activity","href":"/api-reference/activity/list-activity-events"},{"title":"Reject direct activity creation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /activity","href":"/api-reference/activity/reject-direct-activity-creation"},{"title":"Retrieve an activity event","deprecated":null,"version":null,"openapi":"/openapi.yaml get /activity/{id}","href":"/api-reference/activity/retrieve-an-activity-event"},{"title":"List activity for a resource","deprecated":null,"version":null,"openapi":"/openapi.yaml get /resources/{type}/{id}/activity","href":"/api-reference/activity/list-activity-for-a-resource"}]},{"group":"Integrations","pages":[{"title":"List configured connectors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations","href":"/api-reference/integrations/list-configured-connectors"},{"title":"Retrieve a connector","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{connector_type}","href":"/api-reference/integrations/retrieve-a-connector"},{"title":"Connect an integration","deprecated":null,"version":null,"openapi":"/openapi.yaml post /integrations/{connector_type}","href":"/api-reference/integrations/connect-an-integration"},{"title":"Disconnect a connector","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /integrations/{connector_type}","href":"/api-reference/integrations/disconnect-a-connector"},{"title":"Update a connector","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /integrations/{connector_type}","href":"/api-reference/integrations/update-a-connector"},{"title":"Verify a connector connection","deprecated":null,"version":null,"openapi":"/openapi.yaml post /integrations/{connector_type}/test","href":"/api-reference/integrations/verify-a-connector-connection"},{"title":"List a connector's sync attempts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /integrations/{connector_type}/sync-log","href":"/api-reference/integrations/list-a-connectors-sync-attempts"}]},{"group":"Masters","pages":[{"title":"List locations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /locations","href":"/api-reference/masters/list-locations"},{"title":"Create location","deprecated":null,"version":null,"openapi":"/openapi.yaml post /locations","href":"/api-reference/masters/create-location"},{"title":"Retrieve a location","deprecated":null,"version":null,"openapi":"/openapi.yaml get /locations/{id}","href":"/api-reference/masters/retrieve-a-location"},{"title":"Deactivate a location","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /locations/{id}","href":"/api-reference/masters/deactivate-a-location"},{"title":"Update location","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /locations/{id}","href":"/api-reference/masters/update-location"},{"title":"Set default location","deprecated":null,"version":null,"openapi":"/openapi.yaml post /locations/{id}/set-default","href":"/api-reference/masters/set-default-location"},{"title":"List payment terms","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payment-terms","href":"/api-reference/masters/list-payment-terms"},{"title":"Create payment term","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payment-terms","href":"/api-reference/masters/create-payment-term"},{"title":"Retrieve a payment term","deprecated":null,"version":null,"openapi":"/openapi.yaml get /payment-terms/{id}","href":"/api-reference/masters/retrieve-a-payment-term"},{"title":"Delete payment term","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /payment-terms/{id}","href":"/api-reference/masters/delete-payment-term"},{"title":"Update payment term","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /payment-terms/{id}","href":"/api-reference/masters/update-payment-term"},{"title":"Set default payment term","deprecated":null,"version":null,"openapi":"/openapi.yaml post /payment-terms/{id}/set-default","href":"/api-reference/masters/set-default-payment-term"},{"title":"List units of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml get /units-of-measure","href":"/api-reference/masters/list-units-of-measure"},{"title":"Create unit of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml post /units-of-measure","href":"/api-reference/masters/create-unit-of-measure"},{"title":"List units of measure by type","deprecated":null,"version":null,"openapi":"/openapi.yaml get /units-of-measure/by-type/{type}","href":"/api-reference/masters/list-units-of-measure-by-type"},{"title":"Convert between units of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml post /units-of-measure/convert","href":"/api-reference/masters/convert-between-units-of-measure"},{"title":"Delete unit of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /units-of-measure/{id}","href":"/api-reference/masters/delete-unit-of-measure"},{"title":"Update unit of measure","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /units-of-measure/{id}","href":"/api-reference/masters/update-unit-of-measure"},{"title":"List sales channels","deprecated":null,"version":null,"openapi":"/openapi.yaml get /sales-channels","href":"/api-reference/masters/list-sales-channels"},{"title":"Create sales channel","deprecated":null,"version":null,"openapi":"/openapi.yaml post /sales-channels","href":"/api-reference/masters/create-sales-channel"},{"title":"Delete sales channel","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /sales-channels/{id}","href":"/api-reference/masters/delete-sales-channel"},{"title":"Update sales channel","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /sales-channels/{id}","href":"/api-reference/masters/update-sales-channel"},{"title":"List pricing levels","deprecated":null,"version":null,"openapi":"/openapi.yaml get /pricing-levels","href":"/api-reference/masters/list-pricing-levels"},{"title":"Create pricing level","deprecated":null,"version":null,"openapi":"/openapi.yaml post /pricing-levels","href":"/api-reference/masters/create-pricing-level"},{"title":"Retrieve a pricing level","deprecated":null,"version":null,"openapi":"/openapi.yaml get /pricing-levels/{id}","href":"/api-reference/masters/retrieve-a-pricing-level"},{"title":"Delete pricing level","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /pricing-levels/{id}","href":"/api-reference/masters/delete-pricing-level"},{"title":"Update pricing level","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /pricing-levels/{id}","href":"/api-reference/masters/update-pricing-level"},{"title":"List product categories","deprecated":null,"version":null,"openapi":"/openapi.yaml get /product-categories","href":"/api-reference/masters/list-product-categories"},{"title":"Create product category","deprecated":null,"version":null,"openapi":"/openapi.yaml post /product-categories","href":"/api-reference/masters/create-product-category"},{"title":"Delete product category","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /product-categories/{id}","href":"/api-reference/masters/delete-product-category"},{"title":"Update product category","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /product-categories/{id}","href":"/api-reference/masters/update-product-category"},{"title":"List manufacturers","deprecated":null,"version":null,"openapi":"/openapi.yaml get /manufacturers","href":"/api-reference/masters/list-manufacturers"},{"title":"Create a manufacturer","deprecated":null,"version":null,"openapi":"/openapi.yaml post /manufacturers","href":"/api-reference/masters/create-a-manufacturer"},{"title":"Delete a manufacturer","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /manufacturers/{id}","href":"/api-reference/masters/delete-a-manufacturer"},{"title":"Update a manufacturer","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /manufacturers/{id}","href":"/api-reference/masters/update-a-manufacturer"},{"title":"List tax rates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tax-rates","href":"/api-reference/masters/list-tax-rates"},{"title":"Create tax rate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /tax-rates","href":"/api-reference/masters/create-tax-rate"},{"title":"Retrieve a tax rate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tax-rates/{id}","href":"/api-reference/masters/retrieve-a-tax-rate"},{"title":"Deactivate a tax rate","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /tax-rates/{id}","href":"/api-reference/masters/deactivate-a-tax-rate"},{"title":"Update tax rate","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /tax-rates/{id}","href":"/api-reference/masters/update-tax-rate"},{"title":"Restore a soft-deleted tax rate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /tax-rates/{id}/restore","href":"/api-reference/masters/restore-a-soft-deleted-tax-rate"},{"title":"List exchange rates","deprecated":null,"version":null,"openapi":"/openapi.yaml get /exchange-rates","href":"/api-reference/masters/list-exchange-rates"},{"title":"Create exchange rate","deprecated":null,"version":null,"openapi":"/openapi.yaml post /exchange-rates","href":"/api-reference/masters/create-exchange-rate"},{"title":"Retrieve an exchange rate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /exchange-rates/{id}","href":"/api-reference/masters/retrieve-an-exchange-rate"},{"title":"Delete an exchange rate","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /exchange-rates/{id}","href":"/api-reference/masters/delete-an-exchange-rate"},{"title":"Update an exchange rate","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /exchange-rates/{id}","href":"/api-reference/masters/update-an-exchange-rate"},{"title":"List tags","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tags","href":"/api-reference/masters/list-tags"},{"title":"Create tag","deprecated":null,"version":null,"openapi":"/openapi.yaml post /tags","href":"/api-reference/masters/create-tag"},{"title":"Delete tag","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /tags/{id}","href":"/api-reference/masters/delete-tag"},{"title":"Update tag","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /tags/{id}","href":"/api-reference/masters/update-tag"},{"title":"List tags attached to a resource","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tags/{resourceType}/{resourceId}","href":"/api-reference/masters/list-tags-attached-to-a-resource"},{"title":"Attach tags to a resource","deprecated":null,"version":null,"openapi":"/openapi.yaml post /tags/{resourceType}/{resourceId}","href":"/api-reference/masters/attach-tags-to-a-resource"},{"title":"Detach a tag from a resource","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /tags/{resourceType}/{resourceId}/{tagId}","href":"/api-reference/masters/detach-a-tag-from-a-resource"},{"title":"List shipping rules","deprecated":null,"version":null,"openapi":"/openapi.yaml get /shipping-rules","href":"/api-reference/masters/list-shipping-rules"},{"title":"Create a shipping rule","deprecated":null,"version":null,"openapi":"/openapi.yaml post /shipping-rules","href":"/api-reference/masters/create-a-shipping-rule"}]},{"group":"Search","pages":[{"title":"Search across resource types","deprecated":null,"version":null,"openapi":"/openapi.yaml get /search","href":"/api-reference/search/search-across-resource-types"},{"title":"Search within one resource type","deprecated":null,"version":null,"openapi":"/openapi.yaml get /search/{object}","href":"/api-reference/search/search-within-one-resource-type"}]},{"group":"AuditLog","pages":[{"title":"List audit log entries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /audit_log_entries","href":"/api-reference/auditlog/list-audit-log-entries"},{"title":"Create an audit log entry","deprecated":null,"version":null,"openapi":"/openapi.yaml post /audit_log_entries","href":"/api-reference/auditlog/create-an-audit-log-entry"},{"title":"Retrieve audit log statistics","deprecated":null,"version":null,"openapi":"/openapi.yaml get /audit_log_entries/stats","href":"/api-reference/auditlog/retrieve-audit-log-statistics"},{"title":"Retrieve audit event trends","deprecated":null,"version":null,"openapi":"/openapi.yaml get /audit_log_entries/sparkline","href":"/api-reference/auditlog/retrieve-audit-event-trends"},{"title":"List audit log resource types","deprecated":null,"version":null,"openapi":"/openapi.yaml get /audit_log_entries/resource_types","href":"/api-reference/auditlog/list-audit-log-resource-types"},{"title":"Verify audit log integrity","deprecated":null,"version":null,"openapi":"/openapi.yaml post /audit_log_entries/verify","href":"/api-reference/auditlog/verify-audit-log-integrity"},{"title":"Retrieve an audit log entry","deprecated":null,"version":null,"openapi":"/openapi.yaml get /audit_log_entries/{id}","href":"/api-reference/auditlog/retrieve-an-audit-log-entry"}]},{"group":"Channel Listings","pages":[{"title":"List channel listings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /channel_listings","href":"/api-reference/channel-listings/list-channel-listings"},{"title":"Create a channel listing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /channel_listings","href":"/api-reference/channel-listings/create-a-channel-listing"},{"title":"Retrieve a channel listing","deprecated":null,"version":null,"openapi":"/openapi.yaml get /channel_listings/{id}","href":"/api-reference/channel-listings/retrieve-a-channel-listing"},{"title":"Delete a channel listing","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /channel_listings/{id}","href":"/api-reference/channel-listings/delete-a-channel-listing"},{"title":"Update a channel listing","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /channel_listings/{id}","href":"/api-reference/channel-listings/update-a-channel-listing"},{"title":"Pause a channel listing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /channel_listings/{id}/pause","href":"/api-reference/channel-listings/pause-a-channel-listing"},{"title":"Resume a paused channel listing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /channel_listings/{id}/resume","href":"/api-reference/channel-listings/resume-a-paused-channel-listing"},{"title":"Sync a channel listing","deprecated":null,"version":null,"openapi":"/openapi.yaml post /channel_listings/{id}/sync","href":"/api-reference/channel-listings/sync-a-channel-listing"}]},{"group":"Marketplace Orders","pages":[{"title":"List marketplace orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /marketplace_orders","href":"/api-reference/marketplace-orders/list-marketplace-orders"},{"title":"Retrieve a marketplace order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /marketplace_orders/{id}","href":"/api-reference/marketplace-orders/retrieve-a-marketplace-order"},{"title":"Resync a marketplace order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /marketplace_orders/{id}/resync","href":"/api-reference/marketplace-orders/resync-a-marketplace-order"},{"title":"Refund a marketplace order","deprecated":null,"version":null,"openapi":"/openapi.yaml post /marketplace_orders/{id}/refund","href":"/api-reference/marketplace-orders/refund-a-marketplace-order"}]},{"group":"Accounts Receivable","pages":[{"title":"List customer credit memos","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customer-credits","href":"/api-reference/accounts-receivable/list-customer-credit-memos"},{"title":"Create a customer credit memo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customer-credits","href":"/api-reference/accounts-receivable/create-a-customer-credit-memo"},{"title":"Retrieve a customer credit memo","deprecated":null,"version":null,"openapi":"/openapi.yaml get /customer-credits/{id}","href":"/api-reference/accounts-receivable/retrieve-a-customer-credit-memo"},{"title":"Apply a credit memo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customer-credits/{id}/apply","href":"/api-reference/accounts-receivable/apply-a-credit-memo"},{"title":"Void a customer credit memo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customer-credits/{id}/void","href":"/api-reference/accounts-receivable/void-a-customer-credit-memo"},{"title":"Restore a voided credit memo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /customer-credits/{id}/reactivate","href":"/api-reference/accounts-receivable/restore-a-voided-credit-memo"}]},{"group":"Dimensions","pages":[{"title":"List GL departments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /departments","href":"/api-reference/dimensions/list-gl-departments"},{"title":"Create a department","deprecated":null,"version":null,"openapi":"/openapi.yaml post /departments","href":"/api-reference/dimensions/create-a-department"},{"title":"Retrieve a department","deprecated":null,"version":null,"openapi":"/openapi.yaml get /departments/{id}","href":"/api-reference/dimensions/retrieve-a-department"},{"title":"Delete a department","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /departments/{id}","href":"/api-reference/dimensions/delete-a-department"},{"title":"Update a department","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /departments/{id}","href":"/api-reference/dimensions/update-a-department"},{"title":"List GL classes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /classes","href":"/api-reference/dimensions/list-gl-classes"},{"title":"Create a class","deprecated":null,"version":null,"openapi":"/openapi.yaml post /classes","href":"/api-reference/dimensions/create-a-class"},{"title":"Retrieve a class","deprecated":null,"version":null,"openapi":"/openapi.yaml get /classes/{id}","href":"/api-reference/dimensions/retrieve-a-class"},{"title":"Delete a class","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /classes/{id}","href":"/api-reference/dimensions/delete-a-class"},{"title":"Update a class","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /classes/{id}","href":"/api-reference/dimensions/update-a-class"},{"title":"List GL projects","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects","href":"/api-reference/dimensions/list-gl-projects"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"/openapi.yaml post /projects","href":"/api-reference/dimensions/create-a-project"},{"title":"Retrieve a project","deprecated":null,"version":null,"openapi":"/openapi.yaml get /projects/{id}","href":"/api-reference/dimensions/retrieve-a-project"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /projects/{id}","href":"/api-reference/dimensions/delete-a-project"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /projects/{id}","href":"/api-reference/dimensions/update-a-project"}]},{"group":"Webhooks","pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhook_endpoints","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhook_endpoints","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Retrieve a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhook_endpoints/{id}","href":"/api-reference/webhooks/retrieve-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /webhook_endpoints/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /webhook_endpoints/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Rotate a webhook signing secret","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhook_endpoints/{id}/rotate_secret","href":"/api-reference/webhooks/rotate-a-webhook-signing-secret"},{"title":"Send a webhook test event","deprecated":null,"version":null,"openapi":"/openapi.yaml post /webhook_endpoints/{id}/test","href":"/api-reference/webhooks/send-a-webhook-test-event"},{"title":"List webhook delivery attempts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /webhook_endpoints/{id}/deliveries","href":"/api-reference/webhooks/list-webhook-delivery-attempts"}]},{"group":"Addresses","pages":[{"title":"List addresses","deprecated":null,"version":null,"openapi":"/openapi.yaml get /addresses","href":"/api-reference/addresses/list-addresses"},{"title":"Create an address","deprecated":null,"version":null,"openapi":"/openapi.yaml post /addresses","href":"/api-reference/addresses/create-an-address"},{"title":"Retrieve an address","deprecated":null,"version":null,"openapi":"/openapi.yaml get /addresses/{id}","href":"/api-reference/addresses/retrieve-an-address"},{"title":"Delete an address","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /addresses/{id}","href":"/api-reference/addresses/delete-an-address"},{"title":"Update an address","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /addresses/{id}","href":"/api-reference/addresses/update-an-address"},{"title":"Restore a soft-deleted address","deprecated":null,"version":null,"openapi":"/openapi.yaml post /addresses/{id}/restore","href":"/api-reference/addresses/restore-a-soft-deleted-address"}]},{"group":"Contacts","pages":[{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /contacts","href":"/api-reference/contacts/create-a-contact"},{"title":"Retrieve a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /contacts/{id}","href":"/api-reference/contacts/retrieve-a-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /contacts/{id}","href":"/api-reference/contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /contacts/{id}","href":"/api-reference/contacts/update-a-contact"},{"title":"Set a contact as primary","deprecated":null,"version":null,"openapi":"/openapi.yaml post /contacts/{id}/set-primary","href":"/api-reference/contacts/set-a-contact-as-primary"},{"title":"Restore a soft-deleted contact","deprecated":null,"version":null,"openapi":"/openapi.yaml post /contacts/{id}/restore","href":"/api-reference/contacts/restore-a-soft-deleted-contact"}]},{"group":"Notes","pages":[{"title":"List notes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /notes","href":"/api-reference/notes/list-notes"},{"title":"Create a note","deprecated":null,"version":null,"openapi":"/openapi.yaml post /notes","href":"/api-reference/notes/create-a-note"},{"title":"Retrieve a note","deprecated":null,"version":null,"openapi":"/openapi.yaml get /notes/{id}","href":"/api-reference/notes/retrieve-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /notes/{id}","href":"/api-reference/notes/delete-a-note"},{"title":"Update a note","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /notes/{id}","href":"/api-reference/notes/update-a-note"},{"title":"Restore a soft-deleted note","deprecated":null,"version":null,"openapi":"/openapi.yaml post /notes/{id}/restore","href":"/api-reference/notes/restore-a-soft-deleted-note"},{"title":"Pin a note","deprecated":null,"version":null,"openapi":"/openapi.yaml post /notes/{id}/pin","href":"/api-reference/notes/pin-a-note"},{"title":"Unpin a note","deprecated":null,"version":null,"openapi":"/openapi.yaml post /notes/{id}/unpin","href":"/api-reference/notes/unpin-a-note"}]},{"group":"Attachments","pages":[{"title":"Generate an attachment upload URL","deprecated":null,"version":null,"openapi":"/openapi.yaml post /attachments/upload-url","href":"/api-reference/attachments/generate-an-attachment-upload-url"},{"title":"Generate an attachment download URL","deprecated":null,"version":null,"openapi":"/openapi.yaml get /attachments/{id}/download-url","href":"/api-reference/attachments/generate-an-attachment-download-url"},{"title":"List attachments","deprecated":null,"version":null,"openapi":"/openapi.yaml get /attachments","href":"/api-reference/attachments/list-attachments"},{"title":"Create an attachment","deprecated":null,"version":null,"openapi":"/openapi.yaml post /attachments","href":"/api-reference/attachments/create-an-attachment"},{"title":"Retrieve an attachment","deprecated":null,"version":null,"openapi":"/openapi.yaml get /attachments/{id}","href":"/api-reference/attachments/retrieve-an-attachment"},{"title":"Delete an attachment","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /attachments/{id}","href":"/api-reference/attachments/delete-an-attachment"},{"title":"Update an attachment","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /attachments/{id}","href":"/api-reference/attachments/update-an-attachment"}]},{"group":"Fixed Assets","pages":[{"title":"List fixed-asset categories","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fixed_asset_categories","href":"/api-reference/fixed-assets/list-fixed-asset-categories"},{"title":"Create a fixed-asset category","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fixed_asset_categories","href":"/api-reference/fixed-assets/create-a-fixed-asset-category"},{"title":"Retrieve a fixed-asset category","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fixed_asset_categories/{id}","href":"/api-reference/fixed-assets/retrieve-a-fixed-asset-category"},{"title":"Delete a fixed-asset category","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /fixed_asset_categories/{id}","href":"/api-reference/fixed-assets/delete-a-fixed-asset-category"},{"title":"Update a fixed-asset category","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /fixed_asset_categories/{id}","href":"/api-reference/fixed-assets/update-a-fixed-asset-category"},{"title":"List fixed assets","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fixed_assets","href":"/api-reference/fixed-assets/list-fixed-assets"},{"title":"Create a fixed asset","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fixed_assets","href":"/api-reference/fixed-assets/create-a-fixed-asset"},{"title":"Retrieve the fixed assets summary","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fixed_assets/summary","href":"/api-reference/fixed-assets/retrieve-the-fixed-assets-summary"},{"title":"Retrieve a fixed asset","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fixed_assets/{id}","href":"/api-reference/fixed-assets/retrieve-a-fixed-asset"},{"title":"Update a fixed asset","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /fixed_assets/{id}","href":"/api-reference/fixed-assets/update-a-fixed-asset"},{"title":"Place a fixed asset in service","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fixed_assets/{id}/place_in_service","href":"/api-reference/fixed-assets/place-a-fixed-asset-in-service"},{"title":"Post a depreciation period","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fixed_assets/{id}/depreciate","href":"/api-reference/fixed-assets/post-a-depreciation-period"},{"title":"Retrieve the depreciation schedule","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fixed_assets/{id}/depreciation_schedule","href":"/api-reference/fixed-assets/retrieve-the-depreciation-schedule"},{"title":"Suspend an asset's depreciation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fixed_assets/{id}/suspend_depreciation","href":"/api-reference/fixed-assets/suspend-an-assets-depreciation"},{"title":"Resume an asset's depreciation","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fixed_assets/{id}/resume_depreciation","href":"/api-reference/fixed-assets/resume-an-assets-depreciation"},{"title":"Revalue a fixed asset","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fixed_assets/{id}/revalue","href":"/api-reference/fixed-assets/revalue-a-fixed-asset"},{"title":"Move a fixed asset","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fixed_assets/{id}/transfer","href":"/api-reference/fixed-assets/move-a-fixed-asset"},{"title":"Dispose of a fixed asset","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fixed_assets/{id}/dispose","href":"/api-reference/fixed-assets/dispose-of-a-fixed-asset"},{"title":"Record an impairment loss","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fixed_assets/{id}/impair","href":"/api-reference/fixed-assets/record-an-impairment-loss"},{"title":"Record an impairment recovery","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fixed_assets/{id}/recover_impairment","href":"/api-reference/fixed-assets/record-an-impairment-recovery"},{"title":"Retrieve an asset's impairment history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fixed_assets/{id}/impairment_history","href":"/api-reference/fixed-assets/retrieve-an-assets-impairment-history"},{"title":"Record units produced","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fixed_assets/{id}/record_units_produced","href":"/api-reference/fixed-assets/record-units-produced"},{"title":"List an asset's maintenance log","deprecated":null,"version":null,"openapi":"/openapi.yaml get /fixed_assets/{id}/maintenance_log","href":"/api-reference/fixed-assets/list-an-assets-maintenance-log"},{"title":"Add a maintenance log entry","deprecated":null,"version":null,"openapi":"/openapi.yaml post /fixed_assets/{id}/maintenance_log","href":"/api-reference/fixed-assets/add-a-maintenance-log-entry"}]},{"group":"Freight","pages":[{"title":"List the freight fulfillment queue","deprecated":null,"version":null,"openapi":"/openapi.yaml get /freight_fulfillment_queue","href":"/api-reference/freight/list-the-freight-fulfillment-queue"},{"title":"List freight orders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /freight_orders","href":"/api-reference/freight/list-freight-orders"},{"title":"Retrieve a freight order","deprecated":null,"version":null,"openapi":"/openapi.yaml get /freight_orders/{id}","href":"/api-reference/freight/retrieve-a-freight-order"},{"title":"Generate a bill of lading","deprecated":null,"version":null,"openapi":"/openapi.yaml post /freight_orders/{id}/bol","href":"/api-reference/freight/generate-a-bill-of-lading"},{"title":"Override an order's shipping mode","deprecated":null,"version":null,"openapi":"/openapi.yaml post /freight_orders/{id}/override_mode","href":"/api-reference/freight/override-an-orders-shipping-mode"},{"title":"Create a freight package","deprecated":null,"version":null,"openapi":"/openapi.yaml post /freight_orders/{id}/packages","href":"/api-reference/freight/create-a-freight-package"},{"title":"List an order's freight quotes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /freight_orders/{id}/quotes","href":"/api-reference/freight/list-an-orders-freight-quotes"},{"title":"Record a manual freight quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /freight_orders/{id}/quotes","href":"/api-reference/freight/record-a-manual-freight-quote"},{"title":"Retrieve live LTL rates from Shippo","deprecated":null,"version":null,"openapi":"/openapi.yaml post /freight_orders/{id}/quotes/shippo","href":"/api-reference/freight/retrieve-live-ltl-rates-from-shippo"},{"title":"Delete a freight quote","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /freight_quotes/{id}","href":"/api-reference/freight/delete-a-freight-quote"},{"title":"Accept a freight quote","deprecated":null,"version":null,"openapi":"/openapi.yaml post /freight_quotes/{id}/accept","href":"/api-reference/freight/accept-a-freight-quote"}]},{"group":"CustomFields","pages":[{"title":"List custom field definitions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /custom_fields","href":"/api-reference/customfields/list-custom-field-definitions"},{"title":"Create a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.yaml post /custom_fields","href":"/api-reference/customfields/create-a-custom-field-definition"},{"title":"Retrieve a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.yaml get /custom_fields/{id}","href":"/api-reference/customfields/retrieve-a-custom-field-definition"},{"title":"Delete a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /custom_fields/{id}","href":"/api-reference/customfields/delete-a-custom-field-definition"},{"title":"Update a custom field definition","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /custom_fields/{id}","href":"/api-reference/customfields/update-a-custom-field-definition"},{"title":"Restore a soft-deleted custom field","deprecated":null,"version":null,"openapi":"/openapi.yaml post /custom_fields/{id}/restore","href":"/api-reference/customfields/restore-a-soft-deleted-custom-field"},{"title":"List custom field values","deprecated":null,"version":null,"openapi":"/openapi.yaml get /custom_fields/{parent_type}/{record_id}/values","href":"/api-reference/customfields/list-custom-field-values"},{"title":"Set a custom field value","deprecated":null,"version":null,"openapi":"/openapi.yaml put /custom_fields/{id}/values/{record_id}","href":"/api-reference/customfields/set-a-custom-field-value"}]},{"group":"Bins","pages":[{"title":"List bins","deprecated":null,"version":null,"openapi":"/openapi.yaml get /bins","href":"/api-reference/bins/list-bins"},{"title":"Create a bin","deprecated":null,"version":null,"openapi":"/openapi.yaml post /bins","href":"/api-reference/bins/create-a-bin"},{"title":"Retrieve a bin","deprecated":null,"version":null,"openapi":"/openapi.yaml get /bins/{id}","href":"/api-reference/bins/retrieve-a-bin"},{"title":"Update a bin","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /bins/{id}","href":"/api-reference/bins/update-a-bin"},{"title":"Deactivate a bin","deprecated":null,"version":null,"openapi":"/openapi.yaml post /bins/{id}/deactivate","href":"/api-reference/bins/deactivate-a-bin"},{"title":"Restore a deactivated bin","deprecated":null,"version":null,"openapi":"/openapi.yaml post /bins/{id}/restore","href":"/api-reference/bins/restore-a-deactivated-bin"},{"title":"List a bin's products","deprecated":null,"version":null,"openapi":"/openapi.yaml get /bins/{id}/products","href":"/api-reference/bins/list-a-bins-products"},{"title":"Assign a product to a bin","deprecated":null,"version":null,"openapi":"/openapi.yaml post /bins/{id}/products","href":"/api-reference/bins/assign-a-product-to-a-bin"}]},{"group":"Lots","pages":[{"title":"List lots","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lots","href":"/api-reference/lots/list-lots"},{"title":"Create a lot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lots","href":"/api-reference/lots/create-a-lot"},{"title":"Retrieve a lot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /lots/{id}","href":"/api-reference/lots/retrieve-a-lot"},{"title":"Delete a lot","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /lots/{id}","href":"/api-reference/lots/delete-a-lot"},{"title":"Update a lot","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /lots/{id}","href":"/api-reference/lots/update-a-lot"},{"title":"Restore a soft-deleted lot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lots/{id}/restore","href":"/api-reference/lots/restore-a-soft-deleted-lot"},{"title":"Change a lot's status","deprecated":null,"version":null,"openapi":"/openapi.yaml post /lots/{id}/change-status","href":"/api-reference/lots/change-a-lots-status"}]},{"group":"Documents","pages":[{"title":"Create a document","deprecated":null,"version":null,"openapi":"/openapi.yaml post /documents","href":"/api-reference/documents/create-a-document"},{"title":"Confirm a document upload","deprecated":null,"version":null,"openapi":"/openapi.yaml post /documents/confirm","href":"/api-reference/documents/confirm-a-document-upload"}]},{"group":"Currencies","pages":[{"title":"List currencies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /currencies","href":"/api-reference/currencies/list-currencies"},{"title":"Create a currency","deprecated":null,"version":null,"openapi":"/openapi.yaml post /currencies","href":"/api-reference/currencies/create-a-currency"},{"title":"Retrieve a currency","deprecated":null,"version":null,"openapi":"/openapi.yaml get /currencies/{id}","href":"/api-reference/currencies/retrieve-a-currency"},{"title":"Delete a currency","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /currencies/{id}","href":"/api-reference/currencies/delete-a-currency"},{"title":"Update a currency","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /currencies/{id}","href":"/api-reference/currencies/update-a-currency"},{"title":"Restore a soft-deleted currency","deprecated":null,"version":null,"openapi":"/openapi.yaml post /currencies/{id}/restore","href":"/api-reference/currencies/restore-a-soft-deleted-currency"},{"title":"Set the base currency","deprecated":null,"version":null,"openapi":"/openapi.yaml post /currencies/{id}/set-base","href":"/api-reference/currencies/set-the-base-currency"}]},{"group":"Tax Codes","pages":[{"title":"List tax codes","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tax-codes","href":"/api-reference/tax-codes/list-tax-codes"},{"title":"Create a tax code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /tax-codes","href":"/api-reference/tax-codes/create-a-tax-code"},{"title":"Retrieve a tax code","deprecated":null,"version":null,"openapi":"/openapi.yaml get /tax-codes/{id}","href":"/api-reference/tax-codes/retrieve-a-tax-code"},{"title":"Delete a tax code","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /tax-codes/{id}","href":"/api-reference/tax-codes/delete-a-tax-code"},{"title":"Update a tax code","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /tax-codes/{id}","href":"/api-reference/tax-codes/update-a-tax-code"},{"title":"Restore a soft-deleted tax code","deprecated":null,"version":null,"openapi":"/openapi.yaml post /tax-codes/{id}/restore","href":"/api-reference/tax-codes/restore-a-soft-deleted-tax-code"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"title":"Retrieve a vendor prepayment and where it went - Arcus ERP Docs","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}