{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/cashmanagement/overview/","result":{"data":{"contentItem":{"type":"redoc-info","link":"/cashmanagement/overview/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"version\":\"1.1.0\",\"title\":\"Cash Management API\",\"description\":\"Provides information about cash operations that add cash to or \\nremove cash from a restaurant cash drawer, separately from cash\\ntransaction payments (customer payments for individual checks). \\nCash entries are different than cash transactions, and affect \\nthe overall amount of cash that the Toast POS accounts for in \\na restaurant.\\n\",\"termsOfService\":\"https://pos.toasttab.com/api-terms-of-use\"},\"externalDocs\":{\"description\":\"Cash management API documentation\",\"url\":\"https://doc.toasttab.com/doc/devguide/apiWorkingWithCashEntriesAndDeposits.html\"},\"paths\":{\"/entries\":{\"get\":{\"summary\":\"Get cash entries\\n\",\"description\":\"Returns information about cash added to or removed from a cash\\ndrawer or other cash storage device. Returns an array of \\n`CashEntry` objects.\\n\",\"operationId\":\"entriesGet\",\"externalDocs\":{\"description\":\"Getting cash entries\",\"url\":\"https://dev.toasttab.com/doc/devguide/apiUsingCashManagementApi.html\"},\"security\":[{\"cashMgmtRead\":[\"cashmgmt:read\"]}],\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The GUID of the restaurant that is the context of the\\nrequest.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"yyyymmdd\",\"description\":\"Deprecated. Use the `businessDate` parameter. The business\\ndate the cash entries were created, in the format\\n`yyyymmdd`. For example, `20180228`.\\n\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"calendar-date\"}},{\"name\":\"businessDate\",\"description\":\"The business date the cash entries were created, in the\\nformat `yyyymmdd`. For example, `20180228`.\\n\",\"in\":\"query\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"calendar-date\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `CashEntry` objects.\\n\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/CashEntry\"}}}}},\"default\":{\"description\":\"Unexpected error\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}},\"/deposits\":{\"get\":{\"summary\":\"Get deposits\\n\",\"description\":\"Returns an array of `Deposit` objects containing information about\\ncash removed from a restaurant to be deposited in a bank or \\nother financial institution during one business day.\\n\",\"operationId\":\"depositsGet\",\"externalDocs\":{\"description\":\"Getting cash deposit entries\",\"url\":\"https://dev.toasttab.com/doc/devguide/apiGetCashDeposits.html\"},\"security\":[{\"cashMgmtRead\":[\"cashmgmt:read\"]}],\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"description\":\"The GUID of the restaurant that is the context of the\\nrequest.\\n\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"string\"}},{\"name\":\"businessDate\",\"description\":\"The business date the deposits were created, in the\\nformat `yyyymmdd`. For example, `20180228`.\\n\",\"in\":\"query\",\"required\":true,\"schema\":{\"type\":\"string\",\"format\":\"calendar-date\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `Deposit` objects.\\n\",\"content\":{\"application/json\":{\"schema\":{\"title\":\"Response\",\"type\":\"array\",\"minItems\":0,\"items\":{\"$ref\":\"#/components/schemas/Deposit\"}}}}},\"default\":{\"description\":\"An unexpected error.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Error\"}}}}}}}},\"servers\":[{\"url\":\"https://toast-api-server/cashmgmt/v1\"}],\"components\":{\"securitySchemes\":{\"cashMgmtRead\":{\"type\":\"oauth2\",\"flows\":{\"implicit\":{\"authorizationUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"cashmgmt:read\":\"Read cash transactions\"}}}}},\"schemas\":{\"ToastReference\":{\"type\":\"object\",\"description\":\"Identifying information about a Toast POS entity.\\n\",\"required\":[\"guid\",\"entityType\"],\"properties\":{\"guid\":{\"description\":\"The GUID assigned to the entity by the Toast POS.\",\"type\":\"string\"},\"entityType\":{\"description\":\"The category of the Toast POS object.\",\"type\":\"string\"}}},\"ExternalReference\":{\"type\":\"object\",\"description\":\"A wrapper object with fields that allow reference to a Toast entity by Toast GUID or a partner's identifier.\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"externalId\":{\"description\":\"External identifier string that is prefixed by the naming authority.\",\"type\":\"string\"}}}]},\"CashEntry\":{\"type\":\"object\",\"description\":\"Information about an event in which a restaurant employee puts\\ncash into a cash drawer or removes cash from a cash drawer.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"required\":[\"amount\",\"reason\",\"date\",\"type\"],\"properties\":{\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The currency amount of the cash that an employee adds to\\nor removes from a cash drawer. This value is positive\\nwhen an employee adds cash and negative when an employee\\nremoves cash.\\n\"},\"reason\":{\"type\":\"string\",\"description\":\"A short description of why this cash entry was created,\\nwritten by the restaurant employee.\\n\"},\"date\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date and time that the cash entry occurred.\\n\"},\"type\":{\"type\":\"string\",\"description\":\"The type of the cash entry.\\n<ul>\\n  <li><code>CASH_IN</code> - cash added to a cash\\n  drawer.</li>\\n\\n  <li><code>CASH_COLLECTED</code> - cash added to a cash\\n  drawer at the end of an employee shift.</li>\\n\\n  <li><code>CASH_OUT</code> - cash removed from a cash\\n  drawer and stored in a different restaurant location.\\n  The Toast POS does track cash after it is removed by a\\n  <code>CASH_OUT</code> entry.</li>\\n\\n  <li><code>NO_SALE</code> - cash drawer opened with no\\n  change to the cash balance. For example, a restaurant\\n  employee might perform a no sale transaction to make\\n  change for a customer.</li>\\n\\n  <li><code>PAY_OUT</code> - cash removed from a cash\\n  drawer to pay for a pre-configured restaurant\\n  expense.</li>\\n\\n  <li><code>TIP_OUT</code> - cash removed from a cash\\n  drawer to distribute tips or gratuities to restaurant\\n  employees.</li>\\n\\n  <li><code>UNDO_PAY_OUT</code> - cash added to a cash\\n  drawer to undo a previous <code>PAY_OUT</code> cash\\n  entry.</li>\\n\\n  <li><code>DRIVER_REIMBURSEMENT</code> - cash removed\\n  from a cash drawer to repay delivery drivers for\\n  delivery driving expenses.</li>\\n\\n  <li><code>CLOSE_OUT_EXACT</code> - an employee closes\\n  a cash drawer and the closing balance is equal to the\\n  expected balance.</li>\\n\\n  <li><code>CLOSE_OUT_OVERAGE</code> - an employee\\n  closes a cash drawer and the closing balance is greater\\n  than the expected balance.</li>\\n\\n  <li><code>CLOSE_OUT_SHORTAGE</code> - an employee\\n  closes a cash drawer and the closing balance is less\\n  than the expected balance.</li>\\n</ul>\\n\",\"enum\":[\"CASH_IN\",\"CASH_COLLECTED\",\"CASH_OUT\",\"PAY_OUT\",\"UNDO_PAY_OUT\",\"TIP_OUT\",\"NO_SALE\",\"DRIVER_REIMBURSEMENT\",\"CLOSE_OUT_EXACT\",\"CLOSE_OUT_OVERAGE\",\"CLOSE_OUT_SHORTAGE\"]},\"cashDrawer\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"payoutReason\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"noSaleReason\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"undoes\":{\"description\":\"The Toast GUID of the cash entry that is being undone.\\nThis value is null if the cash entry does not undo a\\nprevious entry.\\n\",\"type\":\"string\"},\"employee1\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"employee2\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"creatorOrShiftReviewSubject\":{\"$ref\":\"#/components/schemas/ToastReference\"},\"approverOrShiftReviewSubject\":{\"$ref\":\"#/components/schemas/ToastReference\"}}}]},\"Deposit\":{\"type\":\"object\",\"description\":\"Information about an event in which a restaurant employee removes\\ncash from a restaurant and deposits it in a bank or other\\nfinancial institution.\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"required\":[\"amount\",\"date\"],\"properties\":{\"amount\":{\"type\":\"number\",\"format\":\"double\",\"description\":\"The amount of the deposit. The `amount` value must be greater than zero. \\n\"},\"date\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"The date that the deposit was registered in the POS and\\nthe deposit slip was printed.\\n\"},\"undoes\":{\"type\":\"string\",\"format\":\"string\",\"description\":\"The Toast GUID of the deposit entry that is being undone. This value is null if the deposit entry does not undo a previous entry.\\n\"},\"employee\":{\"$ref\":\"#/components/schemas/ExternalReference\"},\"creator\":{\"$ref\":\"#/components/schemas/ToastReference\"}}}]},\"Error\":{\"required\":[\"status\",\"message\"],\"properties\":{\"status\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"An HTTP status code.\"},\"message\":{\"type\":\"string\",\"description\":\"A message that describes the error.\"}}}}}}},\"options\":{\"hideTryItPanel\":true,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"Node.js\"},{\"lang\":\"C#\"}]},\"showConsole\":false,\"hideHostname\":true,\"hideDownloadButton\":false,\"sortPropsAlphabetically\":true,\"schemaDefinitionsTagName\":\"Data definitions\",\"showAccessMode\":true,\"downloadDefinitionUrl\":\"https://doc.toasttab.com/toast-api-specifications/toast-cashmgmt-api.yaml\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"","redocItemId":"overview","redocHasInfoPage":true,"settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"},{"lang":"Node.js"},{"lang":"C#"}]},"showConsole":false,"hideHostname":true,"hideDownloadButton":false,"sortPropsAlphabetically":true,"schemaDefinitionsTagName":"Data definitions","hideTryItPanel":true,"showAccessMode":true,"downloadDefinitionUrl":"https://doc.toasttab.com/toast-api-specifications/toast-cashmgmt-api.yaml"},"requestLogin":false,"lastModified":"2024-09-05T12:56:37.000Z"},"seo":{"title":"Cash Management"}}},"pageContext":{"id":"00c98516-7014-53ca-9900-b6b874acd9caoverview__redocly content/cashmanagement/overview/","seo":{"title":"Cash Management","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"cashmanagement.reference.page.yaml#overview","pageBaseUrl":"/cashmanagement","type":"redoc-info","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/cashmanagement/overview/","sidebarName":"api-reference","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"cashManagement","id":"cashManagement","title":"cashManagement","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}