{"items":[{"type":"link","label":"Weel OpenAPI","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"Weel OpenAPI"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://help.letsweel.com","url":"https://help.letsweel.com"},{"kind":"email","title":"Contact our support","email":"help@letsweel.com","label":"help@letsweel.com","withCopyButton":true,"copyContent":"help@letsweel.com"},{"kind":"externallink","label":"Terms of Service","labelTranslationKey":"info.termsOfService","url":"https://letsweel.com/terms/"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://public.letsweel.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Weel OpenAPI (v1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The Weel OpenAPI empowers businesses with seamless expense management and real-time insights. Our platform makes it easy to integrate and automate expense workflows, manage receipts, and keep track of spending across your organization."}],"sectionId":"/openapi"}],"sectionId":"/openapi"}]}]}},{"type":"separator","label":"Users","content":null},{"type":"group","label":"Invites","link":"/openapi/invites","routeSlug":"/openapi/invites","items":[{"label":"List invites","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/invites/listinvites","routeSlug":"/openapi/invites/listinvites","metadata":{"seo":{"title":"List invites","description":"Returns a paginated list of invites for the given business. Includes both pending and accepted invites; excludes cancelled invites."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInvites","name":"List invites","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1invites/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List invites","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of invites for the given business. Includes both pending and accepted invites; excludes cancelled invites."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1invites/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Offset to retrieve items from."},{"name":"limit","in":"query","schemaId":"schema_18","description":"Number of items per page."}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1invites/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/invites","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[{"name":"offset","in":"query","example":50,"schemaId":"schema_17"},{"name":"limit","in":"query","example":50,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v1/businesses/{client_id}/invites","href":"invites/listinvites","openApiOperationId":"listInvites","summary":"List invites"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InviteListResponse"}},"schemaId":"components/schemas/InviteListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1invites/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InviteListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InviteListResponse"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invites/listinvites"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/invites"},{"label":"Create invite","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/invites/createinvite","routeSlug":"/openapi/invites/createinvite","metadata":{"seo":{"title":"Create invite","description":"Creates and sends an invite to the given email address. Returns the created invite, including its ID for use in the cancel endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInvite","name":"Create invite","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1invites/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create invite","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Creates and sends an invite to the given email address. Returns the created invite, including its ID for use in the cancel endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1invites/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InviteCreateRequest"}},"schemaId":"components/schemas/InviteCreateRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1invites/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/businesses/{client_id}/invites","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InviteCreateRequest"}},"responseCodes":["201","400","401","403"],"pointer":"/v1/businesses/{client_id}/invites","href":"invites/createinvite","openApiOperationId":"createInvite","summary":"Create invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/InviteCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InviteCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invite"}},"schemaId":"components/schemas/Invite"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1invites/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Invite","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invite"}}},{"code":"400"},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invites/createinvite"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/invites"},{"label":"Cancel invite","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/invites/cancelinvite","routeSlug":"/openapi/invites/cancelinvite","metadata":{"seo":{"title":"Cancel invite","description":"Cancels a pending invite. Returns 400 if the invite has already been accepted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelInvite","name":"Cancel invite","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1invites~1{invite_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel invite","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Cancels a pending invite. Returns 400 if the invite has already been accepted."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"invite_id","in":"path","schemaId":"schema_19","description":"The ID of the invite.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1invites~1{invite_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/businesses/{client_id}/invites/{invite_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"invite_id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/invites/{invite_id}","href":"invites/cancelinvite","openApiOperationId":"cancelInvite","summary":"Cancel invite"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Bad Request — invite has already been accepted"},"children":[]}]}]}]},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1invites~1{invite_id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invites/cancelinvite"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/invites/{invite_id}"}],"content":{"contentType":"group","meta":{"name":"Invites"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invites","showPageActions":true},{"nodeType":"markdoc","content":"This group of endpoints allows you to create, list, and cancel pending user invitations. An invite exists until the recipient accepts it, at which point they appear as a user in the Users endpoints."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/businesses/{client_id}/invites","summary":"List invites","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invites/listinvites","deprecated":false},{"title":"/v1/businesses/{client_id}/invites","summary":"Create invite","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invites/createinvite","deprecated":false},{"title":"/v1/businesses/{client_id}/invites/{invite_id}","summary":"Cancel invite","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invites/cancelinvite","deprecated":false}]}]}]}]}},{"type":"group","label":"Users","link":"/openapi/users","routeSlug":"/openapi/users","items":[{"label":"List users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/listusers","routeSlug":"/openapi/users/listusers","metadata":{"seo":{"title":"List users","description":"This endpoint allows you to retrieve a list of users for a given business."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUsers","name":"List users","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List users","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to retrieve a list of users for a given business."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1users/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Offset to retrieve items from."},{"name":"limit","in":"query","schemaId":"schema_18","description":"Number of items per page."}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/users","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[{"name":"offset","in":"query","example":50,"schemaId":"schema_17"},{"name":"limit","in":"query","example":50,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v1/businesses/{client_id}/users","href":"users/listusers","openApiOperationId":"listUsers","summary":"List users"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserListResponse"}},"schemaId":"components/schemas/UserListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserListResponse"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/listusers"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/users"},{"label":"Get user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/getuser","routeSlug":"/openapi/users/getuser","metadata":{"seo":{"title":"Get user","description":"This endpoint allows you to retrieve a user by their ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUser","name":"Get user","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1users~1{user_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to retrieve a user by their ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"user_id","in":"path","schemaId":"schema_19","description":"The ID of the user.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1users~1{user_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/users/{user_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"user_id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/businesses/{client_id}/users/{user_id}","href":"users/getuser","openApiOperationId":"getUser","summary":"Get user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1users~1{user_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/getuser"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/users/{user_id}"},{"label":"Update user","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/updateuser","routeSlug":"/openapi/users/updateuser","metadata":{"seo":{"title":"Update user","description":"Update role, payment types, and/or delegation settings for an active employee. All fields in the request body are optional."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateUser","name":"Update user","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1users~1{user_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update role, payment types, and/or delegation settings for an active employee.\nAll fields in the request body are optional.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"user_id","in":"path","schemaId":"schema_19","description":"The ID of the user.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1users~1{user_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserUpdate"}},"schemaId":"components/schemas/UserUpdate","pointer":"/paths/~1v1~1businesses~1{client_id}~1users~1{user_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/businesses/{client_id}/users/{user_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"user_id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UserUpdate"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/users/{user_id}","href":"users/updateuser","openApiOperationId":"updateUser","summary":"Update user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/UserUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UserUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}},"schemaId":"components/schemas/User"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1users~1{user_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/User","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/User"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/updateuser"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/users/{user_id}"},{"label":"Delete user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/deleteuser","routeSlug":"/openapi/users/deleteuser","metadata":{"seo":{"title":"Delete user","description":"Deletes an active employee."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteUser","name":"Delete user","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1users~1{user_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an active employee."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"user_id","in":"path","schemaId":"schema_19","description":"The ID of the user.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1users~1{user_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/businesses/{client_id}/users/{user_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"user_id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404","503"],"pointer":"/v1/businesses/{client_id}/users/{user_id}","href":"users/deleteuser","openApiOperationId":"deleteUser","summary":"Delete user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"},{"code":"503","description":"Service Unavailable"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1users~1{user_id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/deleteuser"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/users/{user_id}"},{"label":"List budget members by user ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/users/listbudgetmembersbyuser","routeSlug":"/openapi/users/listbudgetmembersbyuser","metadata":{"seo":{"title":"List budget members by user ID","description":"This endpoint allows you to retrieve budget members by their user ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBudgetMembersByUser","name":"List budget members by user ID","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1users~1{user_id}~1budget-members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List budget members by user ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to retrieve budget members by their user ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"user_id","in":"path","schemaId":"schema_19","description":"The ID of the user.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1users~1{user_id}~1budget-members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/users/{user_id}/budget-members","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"user_id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/businesses/{client_id}/users/{user_id}/budget-members","href":"users/listbudgetmembersbyuser","openApiOperationId":"listBudgetMembersByUser","summary":"List budget members by user ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserBudgetMemberListResponse"}},"schemaId":"components/schemas/UserBudgetMemberListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1users~1{user_id}~1budget-members/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UserBudgetMemberListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UserBudgetMemberListResponse"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/users/listbudgetmembersbyuser"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/users/{user_id}/budget-members"}],"content":{"contentType":"group","meta":{"name":"Users"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Users","showPageActions":true},{"nodeType":"markdoc","content":"This group of endpoints allows you to retrieve and manage user data, including listing users and fetching individual user details."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/businesses/{client_id}/users","summary":"List users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/listusers","deprecated":false},{"title":"/v1/businesses/{client_id}/users/{user_id}","summary":"Get user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/getuser","deprecated":false},{"title":"/v1/businesses/{client_id}/users/{user_id}","summary":"Update user","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/users/updateuser","deprecated":false},{"title":"/v1/businesses/{client_id}/users/{user_id}","summary":"Delete user","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/users/deleteuser","deprecated":false},{"title":"/v1/businesses/{client_id}/users/{user_id}/budget-members","summary":"List budget members by user ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/users/listbudgetmembersbyuser","deprecated":false}]}]}]}]}},{"type":"group","label":"Roles","link":"/openapi/roles","routeSlug":"/openapi/roles","items":[{"label":"List roles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/roles/listroles","routeSlug":"/openapi/roles/listroles","metadata":{"seo":{"title":"List roles","description":"Returns the available roles that can be assigned to users within a business."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRoles","name":"List roles","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1roles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List roles","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the available roles that can be assigned to users within a business."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1roles/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Offset to retrieve items from."},{"name":"limit","in":"query","schemaId":"schema_18","description":"Number of items per page."}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1roles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/roles","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[{"name":"offset","in":"query","example":50,"schemaId":"schema_17"},{"name":"limit","in":"query","example":50,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v1/businesses/{client_id}/roles","href":"roles/listroles","openApiOperationId":"listRoles","summary":"List roles"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleListResponse"}},"schemaId":"components/schemas/RoleListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1roles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/RoleListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RoleListResponse"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/roles/listroles"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/roles"}],"content":{"contentType":"group","meta":{"name":"Roles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Roles","showPageActions":true},{"nodeType":"markdoc","content":"This group of endpoints allows you to retrieve the roles available within a business and the permissions assigned to each role."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/businesses/{client_id}/roles","summary":"List roles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/roles/listroles","deprecated":false}]}]}]}]}},{"type":"separator","label":"Transactions","content":null},{"type":"group","label":"Transactions","link":"/openapi/transactions","routeSlug":"/openapi/transactions","items":[{"label":"List transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/transactions/listtransactions","routeSlug":"/openapi/transactions/listtransactions","metadata":{"seo":{"title":"List transactions","description":"This endpoint allows you to retrieve a list of transactions for a given business. You can filter the transactions by date range, status, and expense completion status."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTransactions","name":"List transactions","isWebhook":false,"pointer":"/paths/~1v2~1businesses~1{client_id}~1transactions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to retrieve a list of transactions for a given business. You can filter the transactions by date range, status, and expense completion status.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v2~1businesses~1{client_id}~1transactions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Offset to retrieve items from."},{"name":"limit","in":"query","schemaId":"schema_18","description":"Number of items per page."},{"name":"min_auth_date","in":"query","schemaId":"schema_20","description":"The minimum authorised date for the transactions in UTC."},{"name":"max_auth_date","in":"query","schemaId":"schema_20","description":"The maximum authorised date for the transactions in UTC."},{"name":"min_cleared_date","in":"query","schemaId":"schema_20","description":"The minimum cleared date for the transactions in UTC."},{"name":"max_cleared_date","in":"query","schemaId":"schema_20","description":"The maximum cleared date for the transactions in UTC."},{"name":"expense_status","in":"query","schemaId":"schema_21","description":"The expense completion status of the transactions."},{"name":"status","in":"query","schemaId":"schema_22","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the transactions. Repeat the parameter to match more than one status, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?status=AUTHED&status=CLEARED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1businesses~1{client_id}~1transactions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/businesses/{client_id}/transactions","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[{"name":"offset","in":"query","example":50,"schemaId":"schema_17"},{"name":"limit","in":"query","example":50,"schemaId":"schema_18"},{"name":"min_auth_date","in":"query","required":false,"schemaId":"schema_20"},{"name":"max_auth_date","in":"query","required":false,"schemaId":"schema_20"},{"name":"min_cleared_date","in":"query","required":false,"schemaId":"schema_20"},{"name":"max_cleared_date","in":"query","required":false,"schemaId":"schema_20"},{"name":"expense_status","in":"query","required":false,"example":"COMPLETE","schemaId":"schema_21"},{"name":"status","in":"query","required":false,"example":"CLEARED","schemaId":"components/schemas/TransactionStatus"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v2/businesses/{client_id}/transactions","href":"transactions/listtransactions","openApiOperationId":"listTransactions","summary":"List transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionListResponse"}},"schemaId":"components/schemas/TransactionListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v2~1businesses~1{client_id}~1transactions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TransactionListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TransactionListResponse"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/listtransactions"}],"panels":[]}]},"httpPath":"/v2/businesses/{client_id}/transactions"},{"label":"Get transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/transactions/gettransaction","routeSlug":"/openapi/transactions/gettransaction","metadata":{"seo":{"title":"Get transaction","description":"Get transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTransaction","name":"Get transaction","isWebhook":false,"pointer":"/paths/~1v2~1businesses~1{client_id}~1transactions~1{transaction_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"transaction_id","in":"path","schemaId":"schema_23","description":"The ID of the transaction.","required":true}],"pointer":"/paths/~1v2~1businesses~1{client_id}~1transactions~1{transaction_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/businesses/{client_id}/transactions/{transaction_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"transaction_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v2/businesses/{client_id}/transactions/{transaction_id}","href":"transactions/gettransaction","openApiOperationId":"getTransaction","summary":"Get transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"}},"schemaId":"components/schemas/Transaction"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v2~1businesses~1{client_id}~1transactions~1{transaction_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Transaction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Transaction"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/transactions/gettransaction"}],"panels":[]}]},"httpPath":"/v2/businesses/{client_id}/transactions/{transaction_id}"}],"content":{"contentType":"group","meta":{"name":"Transactions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Transactions","showPageActions":true},{"nodeType":"markdoc","content":"This group of endpoints allows you to retrieve and manage transaction data, including listing transactions with various filters and fetching individual transaction details."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/businesses/{client_id}/transactions","summary":"List transactions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/listtransactions","deprecated":false},{"title":"/v2/businesses/{client_id}/transactions/{transaction_id}","summary":"Get transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/transactions/gettransaction","deprecated":false}]}]}]}]}},{"type":"separator","label":"Budgets","content":null},{"type":"group","label":"Budgets","link":"/openapi/budgets","routeSlug":"/openapi/budgets","items":[{"label":"List budgets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budgets/listbudgets","routeSlug":"/openapi/budgets/listbudgets","metadata":{"seo":{"title":"List budgets","description":"List budgets"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBudgets","name":"List budgets","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List budgets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Offset to retrieve items from."},{"name":"limit","in":"query","schemaId":"schema_18","description":"Number of items per page."},{"name":"is_deleted","in":"query","schemaId":"schema_24","description":"Whether the resource is deleted."},{"name":"budget_type","in":"query","schemaId":"schema_25","description":"The type of budget."},{"name":"has_member_limits","in":"query","schemaId":"schema_24","description":"Whether the budget has member limits."}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/budgets","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[{"name":"offset","in":"query","example":50,"schemaId":"schema_17"},{"name":"limit","in":"query","example":50,"schemaId":"schema_18"},{"name":"is_deleted","in":"query","example":false,"schemaId":"schema_24"},{"name":"budget_type","in":"query","required":false,"example":"BUDGET","schemaId":"schema_25"},{"name":"has_member_limits","in":"query","required":false,"example":false,"schemaId":"schema_24"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v1/businesses/{client_id}/budgets","href":"budgets/listbudgets","openApiOperationId":"listBudgets","summary":"List budgets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetListResponse"}},"schemaId":"components/schemas/BudgetListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BudgetListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetListResponse"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budgets/listbudgets"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets"},{"label":"Create a budget","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budgets/createbudget","routeSlug":"/openapi/budgets/createbudget","metadata":{"seo":{"title":"Create a budget","description":"Creates a budget with the given configuration, initial members, andowners. All top-level configuration fields are required — no silentdefaults."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBudget","name":"Create a budget","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a budget","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a budget with the given configuration, initial members, and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"owners. All top-level configuration fields are required — no silent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"defaults."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BudgetCreateRequest"}},"schemaId":"components/schemas/BudgetCreateRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/businesses/{client_id}/budgets","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BudgetCreateRequest"}},"responseCodes":["201","400","401","403","429"],"pointer":"/v1/businesses/{client_id}/budgets","href":"budgets/createbudget","openApiOperationId":"createBudget","summary":"Create a budget"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/BudgetCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BudgetCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Budget"}},"schemaId":"components/schemas/Budget"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"429","description":"Too Many Requests"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Budget","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Budget"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"429"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budgets/createbudget"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets"},{"label":"Get budget","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budgets/getbudget","routeSlug":"/openapi/budgets/getbudget","metadata":{"seo":{"title":"Get budget","description":"Get budget"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBudget","name":"Get budget","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get budget","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/budgets/{budget_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}","href":"budgets/getbudget","openApiOperationId":"getBudget","summary":"Get budget"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Budget"}},"schemaId":"components/schemas/Budget"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Budget","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Budget"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budgets/getbudget"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}"},{"label":"Update a budget","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budgets/updatebudget","routeSlug":"/openapi/budgets/updatebudget","metadata":{"seo":{"title":"Update a budget","description":"Updates a budget's top-level configuration. To change members orowners, use their respective endpoints —budget members andbudget owners."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBudget","name":"Update a budget","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a budget","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a budget's top-level configuration. To change members or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"owners, use their respective endpoints —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Budget-Members"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"budget members"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Budget-Owners"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"budget owners"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BudgetUpdateRequest"}},"schemaId":"components/schemas/BudgetUpdateRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/businesses/{client_id}/budgets/{budget_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BudgetUpdateRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}","href":"budgets/updatebudget","openApiOperationId":"updateBudget","summary":"Update a budget"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/BudgetUpdateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BudgetUpdateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Budget"}},"schemaId":"components/schemas/Budget"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Budget","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Budget"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budgets/updatebudget"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}"},{"label":"Delete a budget","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budgets/deletebudget","routeSlug":"/openapi/budgets/deletebudget","metadata":{"seo":{"title":"Delete a budget","description":"Deletes a budget. Cascades to members and owners."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBudget","name":"Delete a budget","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a budget","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a budget. Cascades to members and owners."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/businesses/{client_id}/budgets/{budget_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}","href":"budgets/deletebudget","openApiOperationId":"deleteBudget","summary":"Delete a budget"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budgets/deletebudget"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}"}],"content":{"contentType":"group","meta":{"name":"Budgets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Budgets","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This group of endpoints allows you to retrieve and manage budget data, including listing budgets and fetching individual budget details."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Budgets are organised in a hierarchy where a budget can have multiple members. Each member is associated with a user. Funds can be allocated at the budget level or at the member level, using the flag "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_member_limits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"Budget Hierachy","src":"/assets/budget-hierarchy.ad47a27b9d2d408155b4275dac4fda8c6be900d26953c8b8258c483d7fa9572e.c5aff763.png"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/businesses/{client_id}/budgets","summary":"List budgets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/budgets/listbudgets","deprecated":false},{"title":"/v1/businesses/{client_id}/budgets","summary":"Create a budget","prefix":{"name":"post","color":"post"},"badges":[],"link":"/budgets/createbudget","deprecated":false},{"title":"/v1/businesses/{client_id}/budgets/{budget_id}","summary":"Get budget","prefix":{"name":"get","color":"get"},"badges":[],"link":"/budgets/getbudget","deprecated":false},{"title":"/v1/businesses/{client_id}/budgets/{budget_id}","summary":"Update a budget","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/budgets/updatebudget","deprecated":false},{"title":"/v1/businesses/{client_id}/budgets/{budget_id}","summary":"Delete a budget","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/budgets/deletebudget","deprecated":false}]}]}]}]}},{"type":"group","label":"Budget Members","link":"/openapi/budget-members","routeSlug":"/openapi/budget-members","items":[{"label":"List budget members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budget-members/listbudgetmembers","routeSlug":"/openapi/budget-members/listbudgetmembers","metadata":{"seo":{"title":"List budget members","description":"A budget member is a user who has been invited to a budget."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBudgetMembers","name":"List budget members","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List budget members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"A budget member is a user who has been invited to a budget."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Offset to retrieve items from."},{"name":"limit","in":"query","schemaId":"schema_18","description":"Number of items per page."},{"name":"is_deleted","in":"query","schemaId":"schema_24","description":"Whether the resource is deleted."},{"name":"user_id","in":"query","schemaId":"schema_16","description":"The ID of the user to filter by."}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/budgets/{budget_id}/members","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[{"name":"offset","in":"query","example":50,"schemaId":"schema_17"},{"name":"limit","in":"query","example":50,"schemaId":"schema_18"},{"name":"is_deleted","in":"query","example":false,"schemaId":"schema_24"},{"name":"user_id","in":"query","required":false,"example":123,"schemaId":"schema_16"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}/members","href":"budget-members/listbudgetmembers","openApiOperationId":"listBudgetMembers","summary":"List budget members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetMemberListResponse"}},"schemaId":"components/schemas/BudgetMemberListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BudgetMemberListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetMemberListResponse"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budget-members/listbudgetmembers"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}/members"},{"label":"Add budget member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budget-members/createbudgetmember","routeSlug":"/openapi/budget-members/createbudgetmember","metadata":{"seo":{"title":"Add budget member","description":"Adds a user (or pending invite) as a member of the budget. Provideexactly one of user or invite. If an invite has already beenaccepted, the response will contain user rather than invite."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBudgetMember","name":"Add budget member","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add budget member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a user (or pending invite) as a member of the budget. Provide"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If an invite has already been"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepted, the response will contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side effect:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" On budgets with per-member limits, adding a member"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"increases the budget's total limit and available amount by the new"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"member's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Re-fetch the budget if you need the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"updated totals. Shared-pot budgets are unaffected."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBudgetMemberRequest"}},"schemaId":"components/schemas/CreateBudgetMemberRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/businesses/{client_id}/budgets/{budget_id}/members","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateBudgetMemberRequest"}},"responseCodes":["201","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}/members","href":"budget-members/createbudgetmember","openApiOperationId":"createBudgetMember","summary":"Add budget member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/CreateBudgetMemberRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBudgetMemberRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetMember"}},"schemaId":"components/schemas/BudgetMember"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/BudgetMember","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetMember"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budget-members/createbudgetmember"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}/members"},{"label":"Get budget member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budget-members/getbudgetmember","routeSlug":"/openapi/budget-members/getbudgetmember","metadata":{"seo":{"title":"Get budget member","description":"Get budget member"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBudgetMember","name":"Get budget member","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get budget member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true},{"name":"budget_member_id","in":"path","schemaId":"schema_19","description":"The ID of the budget member.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"},{"name":"budget_member_id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}","href":"budget-members/getbudgetmember","openApiOperationId":"getBudgetMember","summary":"Get budget member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetMember"}},"schemaId":"components/schemas/BudgetMember"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BudgetMember","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetMember"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budget-members/getbudgetmember"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}"},{"label":"Update budget member","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budget-members/updatebudgetmember","routeSlug":"/openapi/budget-members/updatebudgetmember","metadata":{"seo":{"title":"Update budget member","description":"Updates a budget member's reset_amount. Only valid when the budget hashas_member_limits=true and reset_period is not NEVER."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBudgetMember","name":"Update budget member","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update budget member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a budget member's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only valid when the budget has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_member_limits=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset_period"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEVER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side effect:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" The budget's total limit changes by the difference"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"between the old and new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The budget's available amount"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"is not touched — use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Budget-Topups/operation/createBudgetMemberTopup"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"topups"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to change live balances."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true},{"name":"budget_member_id","in":"path","schemaId":"schema_19","description":"The ID of the budget member.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBudgetMemberRequest"}},"schemaId":"components/schemas/UpdateBudgetMemberRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"},{"name":"budget_member_id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateBudgetMemberRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}","href":"budget-members/updatebudgetmember","openApiOperationId":"updateBudgetMember","summary":"Update budget member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/UpdateBudgetMemberRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateBudgetMemberRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetMember"}},"schemaId":"components/schemas/BudgetMember"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BudgetMember","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetMember"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budget-members/updatebudgetmember"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}"},{"label":"Remove budget member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budget-members/deletebudgetmember","routeSlug":"/openapi/budget-members/deletebudgetmember","metadata":{"seo":{"title":"Remove budget member","description":"Deletes the budget member. If the member has an associated card,the card is revoked asynchronously. A budget must retain at least onemember."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBudgetMember","name":"Remove budget member","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove budget member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the budget member. If the member has an associated card,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the card is revoked asynchronously. A budget must retain at least one"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"member."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Side effect:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" On budgets with per-member limits, removing a member"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reduces the budget's total limit and available amount by the member's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"share."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true},{"name":"budget_member_id","in":"path","schemaId":"schema_19","description":"The ID of the budget member.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"},{"name":"budget_member_id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}","href":"budget-members/deletebudgetmember","openApiOperationId":"deleteBudgetMember","summary":"Remove budget member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budget-members/deletebudgetmember"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}"}],"content":{"contentType":"group","meta":{"name":"Budget Members"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Budget Members","showPageActions":true},{"nodeType":"markdoc","content":"This group of endpoints allows you to retrieve and manage budget member data, including listing budget members and fetching individual budget member details."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/businesses/{client_id}/budgets/{budget_id}/members","summary":"List budget members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/budget-members/listbudgetmembers","deprecated":false},{"title":"/v1/businesses/{client_id}/budgets/{budget_id}/members","summary":"Add budget member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/budget-members/createbudgetmember","deprecated":false},{"title":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}","summary":"Get budget member","prefix":{"name":"get","color":"get"},"badges":[],"link":"/budget-members/getbudgetmember","deprecated":false},{"title":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}","summary":"Update budget member","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/budget-members/updatebudgetmember","deprecated":false},{"title":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}","summary":"Remove budget member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/budget-members/deletebudgetmember","deprecated":false}]}]}]}]}},{"type":"group","label":"Budget Owners","link":"/openapi/budget-owners","routeSlug":"/openapi/budget-owners","items":[{"label":"List budget owners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budget-owners/listbudgetowners","routeSlug":"/openapi/budget-owners/listbudgetowners","metadata":{"seo":{"title":"List budget owners","description":"Lists owners of the budget."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBudgetOwners","name":"List budget owners","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1owners/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List budget owners","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Lists owners of the budget."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1owners/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Offset to retrieve items from."},{"name":"limit","in":"query","schemaId":"schema_18","description":"Number of items per page."},{"name":"is_deleted","in":"query","schemaId":"schema_24","description":"Whether the resource is deleted."}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1owners/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/budgets/{budget_id}/owners","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[{"name":"offset","in":"query","example":50,"schemaId":"schema_17"},{"name":"limit","in":"query","example":50,"schemaId":"schema_18"},{"name":"is_deleted","in":"query","example":false,"schemaId":"schema_24"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}/owners","href":"budget-owners/listbudgetowners","openApiOperationId":"listBudgetOwners","summary":"List budget owners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetOwnerListResponse"}},"schemaId":"components/schemas/BudgetOwnerListResponse"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1owners/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BudgetOwnerListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetOwnerListResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budget-owners/listbudgetowners"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}/owners"},{"label":"Add budget owner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budget-owners/createbudgetowner","routeSlug":"/openapi/budget-owners/createbudgetowner","metadata":{"seo":{"title":"Add budget owner","description":"Adds a user (or pending invite) as an owner of the budget. Provideexactly one of user or invite. If an invite has already beenaccepted, the response will contain user rather than invite."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBudgetOwner","name":"Add budget owner","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1owners/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add budget owner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a user (or pending invite) as an owner of the budget. Provide"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If an invite has already been"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepted, the response will contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the same user or invite was previously removed from this budget,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the original record is reinstated rather than a new one created — the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returned "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will match the original owner's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1owners/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBudgetOwnerRequest"}},"schemaId":"components/schemas/CreateBudgetOwnerRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1owners/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/businesses/{client_id}/budgets/{budget_id}/owners","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateBudgetOwnerRequest"}},"responseCodes":["201","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}/owners","href":"budget-owners/createbudgetowner","openApiOperationId":"createBudgetOwner","summary":"Add budget owner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/CreateBudgetOwnerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateBudgetOwnerRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetOwner"}},"schemaId":"components/schemas/BudgetOwner"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1owners/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/BudgetOwner","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetOwner"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budget-owners/createbudgetowner"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}/owners"},{"label":"Remove budget owner","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budget-owners/deletebudgetowner","routeSlug":"/openapi/budget-owners/deletebudgetowner","metadata":{"seo":{"title":"Remove budget owner","description":"Removes the owner from the budget. A budget must retain at least one active owner."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBudgetOwner","name":"Remove budget owner","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1owners~1{budget_owner_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove budget owner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes the owner from the budget. A budget must retain at least one active owner."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true},{"name":"budget_owner_id","in":"path","schemaId":"schema_23","description":"The ID of the budget owner.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1owners~1{budget_owner_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/businesses/{client_id}/budgets/{budget_id}/owners/{budget_owner_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"},{"name":"budget_owner_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}/owners/{budget_owner_id}","href":"budget-owners/deletebudgetowner","openApiOperationId":"deleteBudgetOwner","summary":"Remove budget owner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1owners~1{budget_owner_id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budget-owners/deletebudgetowner"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}/owners/{budget_owner_id}"}],"content":{"contentType":"group","meta":{"name":"Budget Owners"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Budget Owners","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This group of endpoints allows you to retrieve and manage budget owners. A budget owner is a user (or pending invite) who can approve spend, top up, and otherwise manage the budget."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A budget must always have at least one active owner — deleting the last remaining owner is not permitted. Adding an owner who was previously removed will reinstate the original record rather than create a duplicate."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/businesses/{client_id}/budgets/{budget_id}/owners","summary":"List budget owners","prefix":{"name":"get","color":"get"},"badges":[],"link":"/budget-owners/listbudgetowners","deprecated":false},{"title":"/v1/businesses/{client_id}/budgets/{budget_id}/owners","summary":"Add budget owner","prefix":{"name":"post","color":"post"},"badges":[],"link":"/budget-owners/createbudgetowner","deprecated":false},{"title":"/v1/businesses/{client_id}/budgets/{budget_id}/owners/{budget_owner_id}","summary":"Remove budget owner","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/budget-owners/deletebudgetowner","deprecated":false}]}]}]}]}},{"type":"group","label":"Budget Topups","link":"/openapi/budget-topups","routeSlug":"/openapi/budget-topups","items":[{"label":"List budget topups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budget-topups/listbudgettopups","routeSlug":"/openapi/budget-topups/listbudgettopups","metadata":{"seo":{"title":"List budget topups","description":"List the topups for a budget."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBudgetTopups","name":"List budget topups","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1topups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List budget topups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the topups for a budget."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1topups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/budgets/{budget_id}/topups","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}/topups","href":"budget-topups/listbudgettopups","openApiOperationId":"listBudgetTopups","summary":"List budget topups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetTopupListResponse"}},"schemaId":"components/schemas/BudgetTopupListResponse"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1topups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BudgetTopupListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetTopupListResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budget-topups/listbudgettopups"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}/topups"},{"label":"Create budget topup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budget-topups/createbudgettopup","routeSlug":"/openapi/budget-topups/createbudgettopup","metadata":{"seo":{"title":"Create budget topup","description":"Increase or decrease the available amount of a budget. Only permitted when has_member_limits is false for the budget."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBudgetTopup","name":"Create budget topup","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1topups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create budget topup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Increase or decrease the available amount of a budget. Only permitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_member_limits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the budget."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1topups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BudgetTopupCreate"}},"schemaId":"components/schemas/BudgetTopupCreate","pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1topups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/businesses/{client_id}/budgets/{budget_id}/topups","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BudgetTopupCreate"}},"responseCodes":["200","400","401","403"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}/topups","href":"budget-topups/createbudgettopup","openApiOperationId":"createBudgetTopup","summary":"Create budget topup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/BudgetTopupCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BudgetTopupCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetTopup"}},"schemaId":"components/schemas/BudgetTopup"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1topups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BudgetTopup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetTopup"}}},{"code":"400","schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_26"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budget-topups/createbudgettopup"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}/topups"},{"label":"List budget member topups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budget-topups/listbudgetmembertopups","routeSlug":"/openapi/budget-topups/listbudgetmembertopups","metadata":{"seo":{"title":"List budget member topups","description":"List the topups for a budget member."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBudgetMemberTopups","name":"List budget member topups","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}~1topups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List budget member topups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List the topups for a budget member."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true},{"name":"budget_member_id","in":"path","schemaId":"schema_19","description":"The ID of the budget member.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}~1topups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}/topups","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"},{"name":"budget_member_id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}/topups","href":"budget-topups/listbudgetmembertopups","openApiOperationId":"listBudgetMemberTopups","summary":"List budget member topups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetTopupListResponse"}},"schemaId":"components/schemas/BudgetTopupListResponse"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}~1topups/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BudgetTopupListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetTopupListResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budget-topups/listbudgetmembertopups"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}/topups"},{"label":"Create budget member topup","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/budget-topups/createbudgetmembertopup","routeSlug":"/openapi/budget-topups/createbudgetmembertopup","metadata":{"seo":{"title":"Create budget member topup","description":"Increase or decrease the available amount of a budget member. Only permitted when has_member_limits is true for the budget."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBudgetMemberTopup","name":"Create budget member topup","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}~1topups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create budget member topup","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Increase or decrease the available amount of a budget member. Only permitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_member_limits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the budget."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true},{"name":"budget_member_id","in":"path","schemaId":"schema_19","description":"The ID of the budget member.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}~1topups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BudgetTopupCreate"}},"schemaId":"components/schemas/BudgetTopupCreate","pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}~1topups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}/topups","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"},{"name":"budget_member_id","in":"path","required":true,"schemaId":"schema_19"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BudgetTopupCreate"}},"responseCodes":["200","400","401","403"],"pointer":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}/topups","href":"budget-topups/createbudgetmembertopup","openApiOperationId":"createBudgetMemberTopup","summary":"Create budget member topup"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/BudgetTopupCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BudgetTopupCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetTopup"}},"schemaId":"components/schemas/BudgetTopup"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}},"schemaId":"schema_27"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1budgets~1{budget_id}~1members~1{budget_member_id}~1topups/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/BudgetTopup","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BudgetTopup"}}},{"code":"400","schemaId":"schema_27","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_27"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/budget-topups/createbudgetmembertopup"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}/topups"}],"content":{"contentType":"group","meta":{"name":"Budget Topups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Budget Topups","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This group of endpoints allows you to retrieve and create budget topups. Topups are used to increase or decrease the available amount of a budget or budget member."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Topups will be automatically approved, unless a Workflow or Policy has been configured in Weel for that requires approval for budget topups."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two types of topups:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Budget topups are used to increase or decrease the available amount of a budget. This is only permitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_member_limits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the budget."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Budget member topups are used to increase or decrease the available amount of a budget member. This is only permitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_member_limits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the budget."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_member_limits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when this toggle is enabled in the budget creation form."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"image","inline":true,"attributes":{"alt":"Has Member Limits is true","src":"/assets/has-member-limits-true.03f190dbe19d48fcae7033bc5a8380f208e6522c847b6cf8489830f821bfed7d.c5aff763.png"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/businesses/{client_id}/budgets/{budget_id}/topups","summary":"List budget topups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/budget-topups/listbudgettopups","deprecated":false},{"title":"/v1/businesses/{client_id}/budgets/{budget_id}/topups","summary":"Create budget topup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/budget-topups/createbudgettopup","deprecated":false},{"title":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}/topups","summary":"List budget member topups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/budget-topups/listbudgetmembertopups","deprecated":false},{"title":"/v1/businesses/{client_id}/budgets/{budget_id}/members/{budget_member_id}/topups","summary":"Create budget member topup","prefix":{"name":"post","color":"post"},"badges":[],"link":"/budget-topups/createbudgetmembertopup","deprecated":false}]}]}]}]}},{"type":"separator","label":"Statements","content":null},{"type":"group","label":"Statements","link":"/openapi/statements","routeSlug":"/openapi/statements","items":[{"label":"List statements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/statements/liststatements","routeSlug":"/openapi/statements/liststatements","metadata":{"seo":{"title":"List statements","description":"This endpoint allows you to retrieve a list of balances for the required period for a given business."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listStatements","name":"List statements","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1statements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List statements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint allows you to retrieve a list of balances for the required period for a given business."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1statements/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Offset to retrieve items from."},{"name":"limit","in":"query","schemaId":"schema_18","description":"Number of items per page."},{"name":"start_date","in":"query","schemaId":"schema_20","description":"The start date for this statement in UTC.","required":true},{"name":"end_date","in":"query","schemaId":"schema_20","description":"The end date for this statement in UTC.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1statements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/statements","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[{"name":"offset","in":"query","example":50,"schemaId":"schema_17"},{"name":"limit","in":"query","example":50,"schemaId":"schema_18"},{"name":"start_date","in":"query","required":true,"schemaId":"schema_20"},{"name":"end_date","in":"query","required":true,"schemaId":"schema_20"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v1/businesses/{client_id}/statements","href":"statements/liststatements","openApiOperationId":"listStatements","summary":"List statements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementListResponse"}},"schemaId":"components/schemas/StatementListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1statements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementListResponse"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/liststatements"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/statements"},{"label":"Get account balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/statements/listbalances","routeSlug":"/openapi/statements/listbalances","metadata":{"seo":{"title":"Get account balances","description":"Retrieve real-time account balances for all currencies associated with your business. This endpoint returns the current balance for each currency wallet associated with your business account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBalances","name":"Get account balances","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get account balances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve real-time account balances for all currencies associated with your business. This endpoint returns the current balance for each currency wallet associated with your business account.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/balance","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v1/businesses/{client_id}/balance","href":"statements/listbalances","openApiOperationId":"listBalances","summary":"Get account balances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}},"schemaId":"schema_28"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_28","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/listbalances"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/balance"}],"content":{"contentType":"group","meta":{"name":"Statements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Statements","showPageActions":true},{"nodeType":"markdoc","content":"This group of endpoints allows you to retrieve a list of balances for the required period for a given business."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/businesses/{client_id}/statements","summary":"List statements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statements/liststatements","deprecated":false},{"title":"/v1/businesses/{client_id}/balance","summary":"Get account balances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statements/listbalances","deprecated":false}]}]}]}]}},{"type":"separator","label":"Custom Fields","content":null},{"type":"group","label":"Custom Fields","link":"/openapi/custom-fields","routeSlug":"/openapi/custom-fields","items":[{"label":"List custom fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/listcustomfields","routeSlug":"/openapi/custom-fields/listcustomfields","metadata":{"seo":{"title":"List custom fields","description":"Returns a paginated list of custom fields for the given business."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomFields","name":"List custom fields","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List custom fields","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of custom fields for the given business."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Offset to retrieve items from."},{"name":"limit","in":"query","schemaId":"schema_18","description":"Number of items per page."}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/custom-fields","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[{"name":"offset","in":"query","example":50,"schemaId":"schema_17"},{"name":"limit","in":"query","example":50,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v1/businesses/{client_id}/custom-fields","href":"custom-fields/listcustomfields","openApiOperationId":"listCustomFields","summary":"List custom fields"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldListResponse"}},"schemaId":"components/schemas/CustomFieldListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomFieldListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldListResponse"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-fields/listcustomfields"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/custom-fields"},{"label":"Create a custom field","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/createcustomfield","routeSlug":"/openapi/custom-fields/createcustomfield","metadata":{"seo":{"title":"Create a custom field","description":"Creates a new custom field for the given business. The created_by value will be set to PUBLIC_API."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomField","name":"Create a custom field","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new custom field for the given business. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value will be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUBLIC_API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCustomFieldRequest"}},"schemaId":"components/schemas/CreateCustomFieldRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/businesses/{client_id}/custom-fields","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCustomFieldRequest"}},"responseCodes":["201","400","401","403"],"pointer":"/v1/businesses/{client_id}/custom-fields","href":"custom-fields/createcustomfield","openApiOperationId":"createCustomField","summary":"Create a custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/CreateCustomFieldRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCustomFieldRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomField"}},"schemaId":"components/schemas/CustomField"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CustomField","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomField"}}},{"code":"400"},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-fields/createcustomfield"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/custom-fields"},{"label":"Get a custom field","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/getcustomfield","routeSlug":"/openapi/custom-fields/getcustomfield","metadata":{"seo":{"title":"Get a custom field","description":"Returns a single custom field by ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCustomField","name":"Get a custom field","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a single custom field by ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"custom_field_id","in":"path","schemaId":"schema_29","description":"The ID of the custom field.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"custom_field_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_29"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}","href":"custom-fields/getcustomfield","openApiOperationId":"getCustomField","summary":"Get a custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomField"}},"schemaId":"components/schemas/CustomField"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomField","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomField"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-fields/getcustomfield"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}"},{"label":"Update a custom field","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/updatecustomfield","routeSlug":"/openapi/custom-fields/updatecustomfield","metadata":{"seo":{"title":"Update a custom field","description":"Partially updates a custom field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomField","name":"Update a custom field","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates a custom field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrictions for accounting integration fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (created by Xero, MYOB, QuickBooks, NetSuite, or Business Central): the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be changed. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_setting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be updated."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"custom_field_id","in":"path","schemaId":"schema_29","description":"The ID of the custom field.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomFieldRequest"}},"schemaId":"components/schemas/UpdateCustomFieldRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"custom_field_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_29"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCustomFieldRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}","href":"custom-fields/updatecustomfield","openApiOperationId":"updateCustomField","summary":"Update a custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/UpdateCustomFieldRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomFieldRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomField"}},"schemaId":"components/schemas/CustomField"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomField","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomField"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-fields/updatecustomfield"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}"},{"label":"Delete a custom field","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-fields/deletecustomfield","routeSlug":"/openapi/custom-fields/deletecustomfield","metadata":{"seo":{"title":"Delete a custom field","description":"Deletes a custom field. This also removes all associated options and budget links."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomField","name":"Delete a custom field","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes a custom field. This also removes all associated options and budget links."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"custom_field_id","in":"path","schemaId":"schema_29","description":"The ID of the custom field.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"custom_field_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_29"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}","href":"custom-fields/deletecustomfield","openApiOperationId":"deleteCustomField","summary":"Delete a custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-fields/deletecustomfield"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}"}],"content":{"contentType":"group","meta":{"name":"Custom Fields"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Fields","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This group of endpoints allows you to create and manage custom fields (dimensions/cost centres) for your business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields can be of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (with predefined options) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FREE_TEXT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Custom fields created via the Public API have a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_by"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUBLIC_API"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom fields created by accounting integrations (Xero, MYOB, QuickBooks, NetSuite, Business Central) have restrictions: their name and type cannot be modified via the Public API."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/businesses/{client_id}/custom-fields","summary":"List custom fields","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-fields/listcustomfields","deprecated":false},{"title":"/v1/businesses/{client_id}/custom-fields","summary":"Create a custom field","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-fields/createcustomfield","deprecated":false},{"title":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}","summary":"Get a custom field","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-fields/getcustomfield","deprecated":false},{"title":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}","summary":"Update a custom field","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/custom-fields/updatecustomfield","deprecated":false},{"title":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}","summary":"Delete a custom field","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-fields/deletecustomfield","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Field Options","link":"/openapi/custom-field-options","routeSlug":"/openapi/custom-field-options","items":[{"label":"List custom field options","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-field-options/listcustomfieldoptions","routeSlug":"/openapi/custom-field-options/listcustomfieldoptions","metadata":{"seo":{"title":"List custom field options","description":"Returns a paginated list of all options for the given custom field, including disabled ones."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomFieldOptions","name":"List custom field options","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List custom field options","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of all options for the given custom field, including disabled ones."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"custom_field_id","in":"path","schemaId":"schema_29","description":"The ID of the custom field.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Offset to retrieve items from."},{"name":"limit","in":"query","schemaId":"schema_18","description":"Number of items per page."}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"custom_field_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_29"}],"query":[{"name":"offset","in":"query","example":50,"schemaId":"schema_17"},{"name":"limit","in":"query","example":50,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options","href":"custom-field-options/listcustomfieldoptions","openApiOperationId":"listCustomFieldOptions","summary":"List custom field options"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldOptionListResponse"}},"schemaId":"components/schemas/CustomFieldOptionListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomFieldOptionListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldOptionListResponse"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-field-options/listcustomfieldoptions"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options"},{"label":"Create a custom field option","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-field-options/createcustomfieldoption","routeSlug":"/openapi/custom-field-options/createcustomfieldoption","metadata":{"seo":{"title":"Create a custom field option","description":"Adds a new option to a LIST type custom field."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCustomFieldOption","name":"Create a custom field option","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a custom field option","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a new option to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type custom field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not permitted for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"FREE_TEXT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" custom fields or custom fields created by accounting integrations."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"custom_field_id","in":"path","schemaId":"schema_29","description":"The ID of the custom field.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCustomFieldOptionRequest"}},"schemaId":"components/schemas/CreateCustomFieldOptionRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"custom_field_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_29"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCustomFieldOptionRequest"}},"responseCodes":["201","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options","href":"custom-field-options/createcustomfieldoption","openApiOperationId":"createCustomFieldOption","summary":"Create a custom field option"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/CreateCustomFieldOptionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCustomFieldOptionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldOption"}},"schemaId":"components/schemas/CustomFieldOption"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CustomFieldOption","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldOption"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-field-options/createcustomfieldoption"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options"},{"label":"Update a custom field option","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-field-options/updatecustomfieldoption","routeSlug":"/openapi/custom-field-options/updatecustomfieldoption","metadata":{"seo":{"title":"Update a custom field option","description":"Partially updates a custom field option."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCustomFieldOption","name":"Update a custom field option","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options~1{option_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a custom field option","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates a custom field option."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accounting integration fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Xero, MYOB, QuickBooks, NetSuite, Business Central): only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be changed. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be modified."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-accounting-integration fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (MANUAL, PUBLIC_API): only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"text"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be changed. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field cannot be modified — delete and recreate options instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"custom_field_id","in":"path","schemaId":"schema_29","description":"The ID of the custom field.","required":true},{"name":"option_id","in":"path","schemaId":"schema_29","description":"The ID of the custom field option.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options~1{option_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomFieldOptionRequest"}},"schemaId":"components/schemas/UpdateCustomFieldOptionRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options~1{option_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options/{option_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"custom_field_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_29"},{"name":"option_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_29"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCustomFieldOptionRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options/{option_id}","href":"custom-field-options/updatecustomfieldoption","openApiOperationId":"updateCustomFieldOption","summary":"Update a custom field option"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/UpdateCustomFieldOptionRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCustomFieldOptionRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldOption"}},"schemaId":"components/schemas/CustomFieldOption"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options~1{option_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomFieldOption","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldOption"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-field-options/updatecustomfieldoption"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options/{option_id}"},{"label":"Delete a custom field option","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-field-options/deletecustomfieldoption","routeSlug":"/openapi/custom-field-options/deletecustomfieldoption","metadata":{"seo":{"title":"Delete a custom field option","description":"Permanently deletes a custom field option."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCustomFieldOption","name":"Delete a custom field option","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options~1{option_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a custom field option","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Permanently deletes a custom field option.\n\nNot permitted for options belonging to custom fields created by accounting integrations.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"custom_field_id","in":"path","schemaId":"schema_29","description":"The ID of the custom field.","required":true},{"name":"option_id","in":"path","schemaId":"schema_29","description":"The ID of the custom field option.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options~1{option_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options/{option_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"custom_field_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_29"},{"name":"option_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_29"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options/{option_id}","href":"custom-field-options/deletecustomfieldoption","openApiOperationId":"deleteCustomFieldOption","summary":"Delete a custom field option"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1options~1{option_id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-field-options/deletecustomfieldoption"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options/{option_id}"}],"content":{"contentType":"group","meta":{"name":"Custom Field Options"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Field Options","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This group of endpoints allows you to manage the list options for a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LIST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type custom field. Options created via the Public API can be disabled or deleted."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options","summary":"List custom field options","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-field-options/listcustomfieldoptions","deprecated":false},{"title":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options","summary":"Create a custom field option","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-field-options/createcustomfieldoption","deprecated":false},{"title":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options/{option_id}","summary":"Update a custom field option","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/custom-field-options/updatecustomfieldoption","deprecated":false},{"title":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/options/{option_id}","summary":"Delete a custom field option","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-field-options/deletecustomfieldoption","deprecated":false}]}]}]}]}},{"type":"group","label":"Custom Field Budgets","link":"/openapi/custom-field-budgets","routeSlug":"/openapi/custom-field-budgets","items":[{"label":"List budgets linked to a custom field","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-field-budgets/listcustomfieldbudgets","routeSlug":"/openapi/custom-field-budgets/listcustomfieldbudgets","metadata":{"seo":{"title":"List budgets linked to a custom field","description":"Returns a paginated list of budgets that have this custom field assigned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCustomFieldBudgets","name":"List budgets linked to a custom field","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1budgets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List budgets linked to a custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of budgets that have this custom field assigned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"custom_field_id","in":"path","schemaId":"schema_29","description":"The ID of the custom field.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1budgets/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Offset to retrieve items from."},{"name":"limit","in":"query","schemaId":"schema_18","description":"Number of items per page."}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1budgets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/budgets","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"custom_field_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_29"}],"query":[{"name":"offset","in":"query","example":50,"schemaId":"schema_17"},{"name":"limit","in":"query","example":50,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/budgets","href":"custom-field-budgets/listcustomfieldbudgets","openApiOperationId":"listCustomFieldBudgets","summary":"List budgets linked to a custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldBudgetListResponse"}},"schemaId":"components/schemas/CustomFieldBudgetListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1budgets/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CustomFieldBudgetListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldBudgetListResponse"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-field-budgets/listcustomfieldbudgets"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/budgets"},{"label":"Link a budget to a custom field","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-field-budgets/linkcustomfieldbudget","routeSlug":"/openapi/custom-field-budgets/linkcustomfieldbudget","metadata":{"seo":{"title":"Link a budget to a custom field","description":"Assigns a custom field to a budget. The budget must belong to the same business. Only permitted when the custom field's budget_setting is SOME."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"linkCustomFieldBudget","name":"Link a budget to a custom field","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1budgets/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Link a budget to a custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigns a custom field to a budget. The budget must belong to the same business. Only permitted when the custom field's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"budget_setting"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SOME"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"custom_field_id","in":"path","schemaId":"schema_29","description":"The ID of the custom field.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1budgets/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCustomFieldBudgetRequest"}},"schemaId":"components/schemas/CreateCustomFieldBudgetRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1budgets/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/budgets","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"custom_field_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_29"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCustomFieldBudgetRequest"}},"responseCodes":["201","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/budgets","href":"custom-field-budgets/linkcustomfieldbudget","openApiOperationId":"linkCustomFieldBudget","summary":"Link a budget to a custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/CreateCustomFieldBudgetRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCustomFieldBudgetRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldBudget"}},"schemaId":"components/schemas/CustomFieldBudget"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1budgets/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CustomFieldBudget","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CustomFieldBudget"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-field-budgets/linkcustomfieldbudget"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/budgets"},{"label":"Unlink a budget from a custom field","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/custom-field-budgets/unlinkcustomfieldbudget","routeSlug":"/openapi/custom-field-budgets/unlinkcustomfieldbudget","metadata":{"seo":{"title":"Unlink a budget from a custom field","description":"Removes the link between a custom field and a budget."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unlinkCustomFieldBudget","name":"Unlink a budget from a custom field","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1budgets~1{budget_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Unlink a budget from a custom field","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Removes the link between a custom field and a budget."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"custom_field_id","in":"path","schemaId":"schema_29","description":"The ID of the custom field.","required":true},{"name":"budget_id","in":"path","schemaId":"schema_23","description":"The ID of the budget.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1budgets~1{budget_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/budgets/{budget_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"custom_field_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_29"},{"name":"budget_id","in":"path","required":true,"schemaId":"schema_23"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","401","403","404"],"pointer":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/budgets/{budget_id}","href":"custom-field-budgets/unlinkcustomfieldbudget","openApiOperationId":"unlinkCustomFieldBudget","summary":"Unlink a budget from a custom field"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1custom-fields~1{custom_field_id}~1budgets~1{budget_id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/custom-field-budgets/unlinkcustomfieldbudget"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/budgets/{budget_id}"}],"content":{"contentType":"group","meta":{"name":"Custom Field Budgets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Custom Field Budgets","showPageActions":true},{"nodeType":"markdoc","content":"This group of endpoints allows you to link custom fields to budgets, controlling which budgets have a custom field assigned."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/budgets","summary":"List budgets linked to a custom field","prefix":{"name":"get","color":"get"},"badges":[],"link":"/custom-field-budgets/listcustomfieldbudgets","deprecated":false},{"title":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/budgets","summary":"Link a budget to a custom field","prefix":{"name":"post","color":"post"},"badges":[],"link":"/custom-field-budgets/linkcustomfieldbudget","deprecated":false},{"title":"/v1/businesses/{client_id}/custom-fields/{custom_field_id}/budgets/{budget_id}","summary":"Unlink a budget from a custom field","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/custom-field-budgets/unlinkcustomfieldbudget","deprecated":false}]}]}]}]}},{"type":"separator","label":"Chart of Accounts","content":null},{"type":"group","label":"Accounting Codes","link":"/openapi/accounting-codes","routeSlug":"/openapi/accounting-codes","items":[{"label":"List accounting codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/accounting-codes/listaccountingcodes","routeSlug":"/openapi/accounting-codes/listaccountingcodes","metadata":{"seo":{"title":"List accounting codes","description":"Returns a paginated list of GL codes for the given business."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccountingCodes","name":"List accounting codes","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1accounting-codes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List accounting codes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of GL codes for the given business."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1accounting-codes/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Offset to retrieve items from."},{"name":"limit","in":"query","schemaId":"schema_18","description":"Number of items per page."}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1accounting-codes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/accounting-codes","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[{"name":"offset","in":"query","example":50,"schemaId":"schema_17"},{"name":"limit","in":"query","example":50,"schemaId":"schema_18"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v1/businesses/{client_id}/accounting-codes","href":"accounting-codes/listaccountingcodes","openApiOperationId":"listAccountingCodes","summary":"List accounting codes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingCodeListResponse"}},"schemaId":"components/schemas/AccountingCodeListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1accounting-codes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountingCodeListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingCodeListResponse"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-codes/listaccountingcodes"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/accounting-codes"},{"label":"Create or update an accounting code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/accounting-codes/upsertaccountingcode","routeSlug":"/openapi/accounting-codes/upsertaccountingcode","metadata":{"seo":{"title":"Create or update an accounting code","description":"Creates or updates a GL code for the business (upsert by code)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"upsertAccountingCode","name":"Create or update an accounting code","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1accounting-codes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create or update an accounting code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates or updates a GL code for the business (upsert by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a GL code with the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" already exists, its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is updated."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a previously soft-deleted GL code with that "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" exists, it is restored."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Otherwise a new record is created."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only available for businesses with a manual integration or no integration. If no integration exists, a manual integration is automatically created. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the business has a connected accounting provider (Xero, MYOB, NetSuite, QuickBooks, Business Central)."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1accounting-codes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAccountingCodeRequest"}},"schemaId":"components/schemas/CreateAccountingCodeRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1accounting-codes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/businesses/{client_id}/accounting-codes","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAccountingCodeRequest"}},"responseCodes":["200","201","400","401","403"],"pointer":"/v1/businesses/{client_id}/accounting-codes","href":"accounting-codes/upsertaccountingcode","openApiOperationId":"upsertAccountingCode","summary":"Create or update an accounting code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/CreateAccountingCodeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAccountingCodeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK (existing code updated or restored)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingCode"}},"schemaId":"components/schemas/AccountingCode"},{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingCode"}},"schemaId":"components/schemas/AccountingCode"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1accounting-codes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountingCode","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingCode"}}},{"code":"201","schemaId":"components/schemas/AccountingCode","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingCode"}}},{"code":"400"},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-codes/upsertaccountingcode"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/accounting-codes"},{"label":"Delete an accounting code","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/accounting-codes/deleteaccountingcode","routeSlug":"/openapi/accounting-codes/deleteaccountingcode","metadata":{"seo":{"title":"Delete an accounting code","description":"Soft-deletes a GL code. Only available for businesses with a manual integration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAccountingCode","name":"Delete an accounting code","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1accounting-codes~1{accounting_code_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an accounting code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Soft-deletes a GL code. Only available for businesses with a manual integration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any category mapped to this GL code will have its mapping cleared. Business admins and accountants will receive an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCOUNTING_CODE_DELETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" notification."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"accounting_code_id","in":"path","schemaId":"schema_29","description":"The ID of the accounting code (GL code).","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1accounting-codes~1{accounting_code_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/businesses/{client_id}/accounting-codes/{accounting_code_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"accounting_code_id","in":"path","required":true,"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6","schemaId":"schema_29"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/accounting-codes/{accounting_code_id}","href":"accounting-codes/deleteaccountingcode","openApiOperationId":"deleteAccountingCode","summary":"Delete an accounting code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request (e.g. business has a non-manual accounting integration)"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1accounting-codes~1{accounting_code_id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-codes/deleteaccountingcode"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/accounting-codes/{accounting_code_id}"}],"content":{"contentType":"group","meta":{"name":"Accounting Codes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounting Codes","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This group of endpoints allows you to manage GL codes (accounting codes) for your business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"GL codes are used to classify expenses for bookkeeping export. Businesses with a connected accounting integration (Xero, MYOB, NetSuite, QuickBooks, Business Central) cannot create or delete GL codes via the API — those are managed by the integration sync. Businesses with a manual integration or no integration can freely create, update, and delete GL codes. A manual integration is automatically created on the first POST if none exists."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/businesses/{client_id}/accounting-codes","summary":"List accounting codes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounting-codes/listaccountingcodes","deprecated":false},{"title":"/v1/businesses/{client_id}/accounting-codes","summary":"Create or update an accounting code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounting-codes/upsertaccountingcode","deprecated":false},{"title":"/v1/businesses/{client_id}/accounting-codes/{accounting_code_id}","summary":"Delete an accounting code","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/accounting-codes/deleteaccountingcode","deprecated":false}]}]}]}]}},{"type":"group","label":"Categories","link":"/openapi/categories","routeSlug":"/openapi/categories","items":[{"label":"List categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/categories/listcategories","routeSlug":"/openapi/categories/listcategories","metadata":{"seo":{"title":"List categories","description":"Returns a paginated list of expense categories for the given business."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCategories","name":"List categories","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a paginated list of expense categories for the given business."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1categories/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_17","description":"Offset to retrieve items from."},{"name":"limit","in":"query","schemaId":"schema_18","description":"Number of items per page."},{"name":"custom","in":"query","schemaId":"schema_30","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by category type. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns only custom categories; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns only system-defined categories. Omit to return all."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1categories/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/businesses/{client_id}/categories","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[{"name":"offset","in":"query","example":50,"schemaId":"schema_17"},{"name":"limit","in":"query","example":50,"schemaId":"schema_18"},{"name":"custom","in":"query","required":false,"schemaId":"schema_30"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","403"],"pointer":"/v1/businesses/{client_id}/categories","href":"categories/listcategories","openApiOperationId":"listCategories","summary":"List categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CategoryListResponse"}},"schemaId":"components/schemas/CategoryListResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1categories/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CategoryListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CategoryListResponse"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/listcategories"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/categories"},{"label":"Create a category","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/categories/createcategory","routeSlug":"/openapi/categories/createcategory","metadata":{"seo":{"title":"Create a category","description":"Creates a new custom category (custom: true) for the business. The name must be unique within the business."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCategory","name":"Create a category","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1categories/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new custom category ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for the business. The name must be unique within the business."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1categories/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCategoryRequest"}},"schemaId":"components/schemas/CreateCategoryRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1categories/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/businesses/{client_id}/categories","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCategoryRequest"}},"responseCodes":["201","400","401","403"],"pointer":"/v1/businesses/{client_id}/categories","href":"categories/createcategory","openApiOperationId":"createCategory","summary":"Create a category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/CreateCategoryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCategoryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Category"}},"schemaId":"components/schemas/Category"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1categories/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Category","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Category"}}},{"code":"400"},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/createcategory"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/categories"},{"label":"Update a category","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/categories/updatecategory","routeSlug":"/openapi/categories/updatecategory","metadata":{"seo":{"title":"Update a category","description":"Updates an existing category. Accepted fields depend on the category type:"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCategory","name":"Update a category","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1categories~1{category_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing category. Accepted fields depend on the category type:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom categories ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accounting_code_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mutable; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns 400."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System categories ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accounting_code_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mutable; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns 400."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"category_id","in":"path","schemaId":"schema_31","description":"The ID of the category.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1categories~1{category_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCategoryRequest"}},"schemaId":"components/schemas/UpdateCategoryRequest","pointer":"/paths/~1v1~1businesses~1{client_id}~1categories~1{category_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/businesses/{client_id}/categories/{category_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"category_id","in":"path","required":true,"example":"7cb19e45-1234-5678-abcd-ef9876543210","schemaId":"schema_31"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCategoryRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/categories/{category_id}","href":"categories/updatecategory","openApiOperationId":"updateCategory","summary":"Update a category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"schemaId":"components/schemas/UpdateCategoryRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCategoryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Category"}},"schemaId":"components/schemas/Category"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1categories~1{category_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Category","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Category"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/updatecategory"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/categories/{category_id}"},{"label":"Delete a category","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/categories/deletecategory","routeSlug":"/openapi/categories/deletecategory","metadata":{"seo":{"title":"Delete a category","description":"Soft-deletes a custom category. Returns 400 if the category is system-defined (custom: false)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCategory","name":"Delete a category","isWebhook":false,"pointer":"/paths/~1v1~1businesses~1{client_id}~1categories~1{category_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a category","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Soft-deletes a custom category. Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if the category is system-defined ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_id","in":"path","schemaId":"schema_16","description":"The ID of the business.","required":true},{"name":"category_id","in":"path","schemaId":"schema_31","description":"The ID of the category.","required":true}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1categories~1{category_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/businesses/{client_id}/categories/{category_id}","servers":[{"url":"https://public.letsweel.com"}],"parameters":{"path":[{"name":"client_id","in":"path","required":true,"example":123,"schemaId":"schema_16"},{"name":"category_id","in":"path","required":true,"example":"7cb19e45-1234-5678-abcd-ef9876543210","schemaId":"schema_31"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["204","400","401","403","404"],"pointer":"/v1/businesses/{client_id}/categories/{category_id}","href":"categories/deletecategory","openApiOperationId":"deleteCategory","summary":"Delete a category"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://public.letsweel.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request (system categories cannot be deleted)"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v1~1businesses~1{client_id}~1categories~1{category_id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/categories/deletecategory"}],"panels":[]}]},"httpPath":"/v1/businesses/{client_id}/categories/{category_id}"}],"content":{"contentType":"group","meta":{"name":"Categories"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Categories","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This group of endpoints allow you to manage expense categories for your business."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Categories classify transactions. System-defined categories ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") can only have their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state toggled. Custom categories ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") can have their "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" updated and can be deleted."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/businesses/{client_id}/categories","summary":"List categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/categories/listcategories","deprecated":false},{"title":"/v1/businesses/{client_id}/categories","summary":"Create a category","prefix":{"name":"post","color":"post"},"badges":[],"link":"/categories/createcategory","deprecated":false},{"title":"/v1/businesses/{client_id}/categories/{category_id}","summary":"Update a category","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/categories/updatecategory","deprecated":false},{"title":"/v1/businesses/{client_id}/categories/{category_id}","summary":"Delete a category","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/categories/deletecategory","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/StatementListResponse":{"id":"components/schemas/StatementListResponse","kind":"json-schema","title":"StatementListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of daily balance records for the given period.","example":100},"next":{"type":"string","description":"The URL to the next page of daily balance records.","example":"offset=50&limit=50"},"previous":{"type":"string","description":"The URL to the previous page of daily balance records.","example":"offset=0&limit=50"},"start_date":{"type":"string","format":"date","description":"The start date for this statement in UTC.","example":"2024-01-01"},"end_date":{"type":"string","format":"date","description":"The end date for this statement in UTC.","example":"2024-01-31"},"currency":{"type":"string","description":"The currency of the statement.","example":"AUD"},"opening_balance":{"type":"number","description":"The opening balance of the statement.","example":1000},"closing_balance":{"type":"number","description":"The closing balance of the statement.","example":1000},"daily_balances":{"type":"array","items":{"$ref":"#/components/schemas/DailyBalance"}}}}},"components/schemas/DailyBalance":{"id":"components/schemas/DailyBalance","kind":"json-schema","title":"DailyBalance","data":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"The date of the daily balance.","example":"2024-01-01"},"opening_balance":{"type":"number","description":"The opening balance of this date.","example":1000},"closing_balance":{"type":"number","description":"The closing balance of this date.","example":1000},"id":{"type":"string","description":"The ID of the daily balance.","example":"e33b7c61-5124-4ba0-b238-e4c573133715"},"created":{"type":"string","format":"date-time","description":"The date and time when the balance was generated in UTC.","example":"2024-01-01T00:00:00Z"},"updated":{"type":"string","format":"date-time","description":"The date and time when the balance was last updated in UTC.","example":"2024-01-01T00:00:00Z"}}}},"components/schemas/TransactionListResponse":{"id":"components/schemas/TransactionListResponse","kind":"json-schema","title":"TransactionListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of transactions that match the query.","example":100},"next":{"type":"string","description":"The URL to the next page of transactions.","example":"offset=50&limit=50"},"previous":{"type":"string","description":"The URL to the previous page of transactions.","example":"offset=0&limit=50"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"}}}}},"components/schemas/Transaction":{"id":"components/schemas/Transaction","kind":"json-schema","title":"Transaction","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the transaction.","example":"e33b7c61-5124-4ba0-b238-e4c573133715"},"cleared_date":{"type":["string","null"],"format":"date-time","description":"The date the transaction was cleared in UTC.","example":"2024-01-01T00:00:00Z"},"auth_date":{"type":"string","format":"date-time","description":"The date the transaction was authorised in UTC.","example":"2024-01-01T00:00:00Z"},"merchant_name":{"type":"string","description":"The name of the merchant.","example":"Bunnings Warehouse"},"attendees":{"type":"array","description":"The names of the attendees of the transaction.","items":{"type":"string","description":"The name of the attendee.","example":"Jane Doe"}},"budget":{"$ref":"#/components/schemas/TransactionBudget","description":"The budget associated with the transaction."},"currency":{"type":"string","description":"The currency of the transaction.","example":"AUD"},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldValue"}},"fx_amount":{"type":"number","description":"The foreign currency amount of the transaction.","example":100},"amount":{"type":"number","description":"The amount of the transaction in AUD (positive for credits, negative for debits).","example":-100},"gst":{"type":"number","description":"The GST amount of the transaction.","example":9.09},"expense_status":{"type":"string","description":"The expense completion status of the transaction.","enum":["COMPLETE","INCOMPLETE_EXPENSE"],"example":"COMPLETE"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"transaction_type":{"type":"string","description":"The type of transaction.","enum":["CARD_TRANSACTION","CHARGE","DEPOSIT_DIRECT_CREDIT","DEPOSIT_DIRECT_DEBIT","BILL","REIMBURSEMENT","EXTERNAL_TRANSFER","MANUAL_TRANSFER","CREDIT"],"example":"CARD_TRANSACTION"},"user":{"description":"The user who made the transaction.","$ref":"#/components/schemas/SubUser"},"line_items":{"type":"array","description":"The line items of the transaction.","items":{"$ref":"#/components/schemas/LineItem"}},"receipt_urls":{"type":"array","description":"The URLs of the receipts for the transaction. These are temporary, pre-signed links that expire 8 hours after the response is generated. Download the files before then, or request the transaction again to obtain fresh URLs. Do not store these URLs, as they will stop working once they expire.\n","items":{"type":"string","example":"https://divipay-user-production.s3.amazonaws.com/123/68eae8f6-cb90-4403-ba76-a2cc12c3979j.png"}},"created":{"type":"string","format":"date-time","description":"The date and time when the transaction was created in UTC.","example":"2024-01-01T00:00:00Z"},"updated":{"type":"string","format":"date-time","description":"The date and time when the transaction was last updated in UTC.","example":"2024-01-01T00:00:00Z"}}}},"components/schemas/TransactionBudget":{"id":"components/schemas/TransactionBudget","kind":"json-schema","title":"TransactionBudget","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the budget.","example":"e33b7c61-5124-4ba0-b238-e4c573133715"},"name":{"type":"string","description":"The name of the budget.","example":"Sales Team"},"budget_type":{"type":"string","description":"The type of budget.","enum":["BUDGET","SUBSCRIPTION"],"example":"BUDGET"}}}},"components/schemas/TransactionStatus":{"id":"components/schemas/TransactionStatus","kind":"json-schema","title":"TransactionStatus","data":{"type":"string","description":"The status of the transaction.","enum":["AUTHED","CLEARED","REFUNDED","DECLINED"],"example":"CLEARED"}},"components/schemas/LineItem":{"id":"components/schemas/LineItem","kind":"json-schema","title":"LineItem","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the line item.","example":"e33b7c61-5124-4ba0-b238-e4c573133715"},"amount":{"type":"number","description":"The amount of the line item in AUD.","example":100},"gst_amount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The GST amount of the line item. When a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is applied to the line item, this is derived from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tax_rate.rate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":9.09},"tax_rate":{"$ref":"#/components/schemas/TaxRate","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The tax rate applied to the line item. This property has three states: it is absent when itemised tax rates are not enabled for the business; it is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"TaxRate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object when a tax rate could be resolved for the line item; and it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when itemised tax rates are enabled for the business but a tax rate could not be resolved for the line item."},"children":[]}]}]}]},"category":{"$ref":"#/components/schemas/LineItemCategory"},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldValue"}},"description":{"type":"string","description":"The description of the line item.","example":"Building supplies"}}}},"components/schemas/TaxRate":{"id":"components/schemas/TaxRate","kind":"json-schema","title":"TaxRate","data":{"type":["object","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A tax rate applied to a line item. May be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when itemised tax rates are enabled for the business but a rate could not be resolved."},"children":[]}]}]}],"properties":{"id":{"type":"string","format":"uuid","description":"The ID of the tax rate.","example":"e33b7c61-5124-4ba0-b238-e4c573133715"},"name":{"type":"string","description":"The name of the tax rate.","example":"GST"},"rate":{"type":"number","description":"The tax rate as a decimal fraction.","example":0.1},"code":{"type":["string","null"],"description":"The tax rate code.","example":"GST"},"is_default_for":{"type":"string","description":"Which transaction types the tax rate is the default for.","enum":["DOMESTIC","INTERNATIONAL","BOTH","NONE"],"example":"DOMESTIC"},"is_enabled":{"type":"boolean","description":"Whether the tax rate is enabled.","example":true},"source":{"type":"string","description":"The source of the tax rate.","enum":["WEEL","MANUAL","ASP"],"example":"WEEL"}}}},"components/schemas/CustomFieldValue":{"id":"components/schemas/CustomFieldValue","kind":"json-schema","title":"CustomFieldValue","data":{"type":"object","properties":{"field_name":{"type":"string","description":"The name of the custom field.","example":"Project"},"entry_text":{"type":"string","description":"The text value of the custom field.","example":"Project 1"}}}},"components/schemas/InviteListResponse":{"id":"components/schemas/InviteListResponse","kind":"json-schema","title":"InviteListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of invites that match the query.","example":10},"next":{"type":["string","null"],"description":"The URL to the next page of invites.","example":"offset=50&limit=50"},"previous":{"type":["string","null"],"description":"The URL to the previous page of invites.","example":null},"results":{"type":"array","items":{"$ref":"#/components/schemas/Invite"}}}}},"components/schemas/PaymentType":{"id":"components/schemas/PaymentType","kind":"json-schema","title":"PaymentType","data":{"type":"string","enum":["bills","cards","reimbursements"]}},"components/schemas/Invite":{"id":"components/schemas/Invite","kind":"json-schema","title":"Invite","data":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the invite.","example":99},"email":{"type":"string","format":"email","description":"The email address the invite was sent to.","example":"jane.doe@example.com"},"role_id":{"type":"string","format":"uuid","description":"The ID of the role assigned to the invitee.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"role":{"type":"string","description":"The name of the role assigned to the invitee.","example":"Team Member"},"payment_types":{"type":"array","items":{"$ref":"#/components/schemas/PaymentType"},"description":"The payment types the invitee will have access to.","example":["cards","reimbursements"]},"used":{"type":"boolean","description":"Whether the invite has been accepted.","example":false},"created":{"type":"string","format":"date-time","description":"The date and time the invite was created in UTC.","example":"2026-05-01T00:00:00Z"},"updated":{"type":"string","format":"date-time","description":"The date and time the invite was last updated in UTC.","example":"2026-05-01T00:00:00Z"}}}},"components/schemas/InviteCreateRequest":{"id":"components/schemas/InviteCreateRequest","kind":"json-schema","title":"InviteCreateRequest","data":{"type":"object","required":["email","role_id","payment_types"],"properties":{"email":{"type":"string","format":"email","description":"The email address to send the invite to.","example":"jane.doe@example.com"},"role_id":{"type":"string","format":"uuid","description":"The ID of the role to assign to the invitee. Must belong to the business.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"payment_types":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/PaymentType"},"description":"The payment types the invitee will have access to. Must be a non-empty list.","example":["cards","reimbursements"]}}}},"components/schemas/UserListResponse":{"id":"components/schemas/UserListResponse","kind":"json-schema","title":"UserListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of users that match the query.","example":100},"next":{"type":"string","description":"The URL to the next page of users.","example":"offset=50&limit=50"},"previous":{"type":"string","description":"The URL to the previous page of users.","example":"offset=0&limit=50"},"results":{"type":"array","items":{"$ref":"#/components/schemas/User"}}}}},"components/schemas/RoleListResponse":{"id":"components/schemas/RoleListResponse","kind":"json-schema","title":"RoleListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of roles for the business.","example":5},"next":{"type":"string","description":"The URL to the next page of roles.","example":"offset=50&limit=50"},"previous":{"type":"string","description":"The URL to the previous page of roles.","example":"offset=0&limit=50"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Role"}}}}},"components/schemas/Role":{"id":"components/schemas/Role","kind":"json-schema","title":"Role","data":{"type":"object","required":["id","name","is_deletable","permissions"],"properties":{"id":{"type":"string","format":"uuid","description":"The ID of the role.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"name":{"type":"string","description":"The name of the role.","example":"Team Member"},"is_deletable":{"type":"boolean","description":"Whether the role can be deleted.","example":false},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/Permission"}}}}},"components/schemas/Permission":{"id":"components/schemas/Permission","kind":"json-schema","title":"Permission","data":{"type":"object","required":["resource","action"],"properties":{"resource":{"type":"string","description":"The resource the action applies to.","example":"transactions"},"action":{"type":"string","description":"The action permitted on the resource.","enum":["create","read","update","delete"],"example":"read"}}}},"components/schemas/User":{"id":"components/schemas/User","kind":"json-schema","title":"User","data":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the user.","example":123},"first_name":{"type":"string","description":"The first name of the user.","example":"John"},"last_name":{"type":"string","description":"The last name of the user.","example":"Doe"},"name":{"type":"string","description":"The full name of the user or the display name if the user has set one.","example":"John Doe"},"email":{"type":"string","format":"email","description":"The email of the user.","example":"john.doe@example.com"},"role":{"type":"string","description":"The role of the user.","example":"Team Member"},"role_id":{"type":"string","format":"uuid","description":"The ID of the user's role.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"is_deleted":{"type":"boolean","description":"Whether the user is deleted.","example":false},"created":{"type":"string","format":"date-time","description":"The date and time when the user was created in UTC.","example":"2024-01-01T00:00:00Z"},"updated":{"type":"string","format":"date-time","description":"The date and time when the user was last updated in UTC.","example":"2024-01-01T00:00:00Z"},"payment_types":{"type":"array","description":"The payment types the user can transact with.","items":{"$ref":"#/components/schemas/PaymentType"},"example":["cards"]},"out_of_office_mode":{"type":"boolean","description":"Whether the user is out of office.","example":true},"out_of_office_start_date":{"type":["string","null"],"format":"date","description":"First day of the out-of-office period (inclusive).","example":"2026-06-01"},"out_of_office_end_date":{"type":["string","null"],"format":"date","description":"Last day of the out-of-office period (inclusive).","example":"2026-06-15"},"delegate_approver":{"type":["integer","null"],"description":"The user ID to delegate approvals to while out of office.","example":789},"expense_delegate":{"type":["array","null"],"items":{"type":"integer"},"description":"The user IDs of this user's expense assistants (who can act on their expenses). Null if the business does not have the expense assistant feature.","example":[456,789]}}}},"components/schemas/UserUpdate":{"id":"components/schemas/UserUpdate","kind":"json-schema","title":"UserUpdate","data":{"type":"object","description":"Fields that may be updated on an active employee. All optional.","properties":{"role_id":{"type":"string","format":"uuid","description":"The role to assign to the user. Must belong to the same business.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"payment_types":{"type":"array","description":"The payment types the user can transact with.","items":{"$ref":"#/components/schemas/PaymentType"},"example":["cards"]},"out_of_office_mode":{"type":"boolean","description":"Whether the user is out of office. When true, both start and end dates are required.","example":true},"out_of_office_start_date":{"type":"string","format":"date","description":"First day of the out-of-office period (inclusive).","example":"2026-06-01"},"out_of_office_end_date":{"type":"string","format":"date","description":"Last day of the out-of-office period (inclusive). Must be on or after the start date.","example":"2026-06-15"},"delegate_approver":{"type":["integer","null"],"description":"The user ID to delegate approvals to while out of office. Must belong to the same business and have no overlapping out-of-office period.","example":789},"expense_delegate":{"type":"array","items":{"type":"integer"},"description":"Replaces the user's full set of expense assistants with these user IDs. A user can have at most 3 expense assistants. Each ID must belong to the same business, must be a different user (a user cannot be their own expense assistant), and must not be repeated. Expense assistants cannot be chained. A user who is themselves an expense assistant cannot be given assistants, and a user who already has assistants cannot be assigned as one. Omit this field to leave the current assistants unchanged, or send an empty array to remove them all.","example":[456,789]}}}},"components/schemas/SubUser":{"id":"components/schemas/SubUser","kind":"json-schema","title":"SubUser","data":{"type":["object","null"],"properties":{"id":{"type":"integer","description":"The ID of the user.","example":123},"first_name":{"type":"string","description":"The first name of the user.","example":"John"},"last_name":{"type":"string","description":"The last name of the user.","example":"Doe"},"name":{"type":"string","description":"The full name of the user or the display name if the user has set one.","example":"John Doe"}}}},"components/schemas/UserBudget":{"id":"components/schemas/UserBudget","kind":"json-schema","title":"UserBudget","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the budget.","example":"e33b7c61-5124-4ba0-b238-e4c573133715"},"name":{"type":"string","description":"The name of the budget.","example":"Sales Team"},"budget_type":{"type":"string","description":"The type of budget.","enum":["BUDGET","SUBSCRIPTION"],"example":"BUDGET"}}}},"components/schemas/UserBudgetMember":{"id":"components/schemas/UserBudgetMember","kind":"json-schema","title":"UserBudgetMember","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the budget member.","example":"e33b7c61-5124-4ba0-b238-e4c573133715"},"budget":{"description":"The budget for the budget member.","$ref":"#/components/schemas/UserBudget"},"available_amount":{"type":"number","description":"The available amount of the budget member.","example":800},"spent_amount":{"type":"number","description":"The amount of the budget that has been spent by the budget member.","example":200},"reset_amount":{"type":"number","description":"The reset amount of the budget member.","example":1000},"is_deleted":{"type":"boolean","description":"Whether the budget member is deleted.","example":false},"created":{"type":"string","format":"date-time","description":"The date and time when the budget member was created in UTC.","example":"2024-01-01T00:00:00Z"},"updated":{"type":"string","format":"date-time","description":"The date and time when the budget member was last updated in UTC.","example":"2024-01-01T00:00:00Z"}}}},"components/schemas/UserBudgetMemberListResponse":{"id":"components/schemas/UserBudgetMemberListResponse","kind":"json-schema","title":"UserBudgetMemberListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of budget members for the user.","example":100},"next":{"type":"string","description":"The URL to the next page of budget members.","example":"offset=50&limit=50"},"previous":{"type":"string","description":"The URL to the previous page of budget members.","example":"offset=0&limit=50"},"results":{"type":"array","items":{"$ref":"#/components/schemas/UserBudgetMember"}}}}},"components/schemas/Budget":{"id":"components/schemas/Budget","kind":"json-schema","title":"Budget","data":{"type":"object","required":["id","name","budget_type","available_amount","spent_amount","reset_amount","reset_period","current_period_start","current_period_end","has_member_limits","rollover_funds","limit_categories","categories","custom_fields","is_deleted","created","updated"],"properties":{"id":{"type":"string","description":"The ID of the budget.","example":"e33b7c61-5124-4ba0-b238-e4c573133715"},"name":{"type":"string","description":"The name of the budget.","example":"Sales Team"},"budget_type":{"type":"string","description":"The type of budget.","enum":["BUDGET","SUBSCRIPTION"],"example":"BUDGET"},"available_amount":{"type":"number","description":"The available amount of the budget.","example":800},"spent_amount":{"type":"number","description":"The amount of the budget that has been spent.","example":200},"reset_amount":{"type":"number","description":"The reset amount of the budget.","example":1000},"reset_period":{"$ref":"#/components/schemas/BudgetResetPeriod"},"current_period_start":{"type":["string","null"],"format":"date-time","description":"The start date of the current period in UTC.","example":"2024-01-01T00:00:00Z"},"current_period_end":{"type":["string","null"],"format":"date-time","description":"The end date of the current period in UTC.","example":"2024-01-31T23:59:59Z"},"has_member_limits":{"type":"boolean","description":"Whether the budget has member limits.","example":false},"rollover_funds":{"type":"boolean","description":"When true, unspent balance rolls over to the next period instead of resetting.","example":false},"limit_categories":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, only categories listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are visible on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the budget. When false, all enabled business categories are visible."},"children":[]}]}]}],"example":false},"categories":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Categories currently visible on the budget. Returns an empty array"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit_categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is false (no restriction in force)."},"children":[]}]}]}],"items":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","format":"uuid","example":"7f183748-c7fb-428a-9b2a-603a03dcabdb"},"name":{"type":"string","example":"Travel"}}}},"custom_fields":{"type":"array","description":"Custom fields attached to this budget.","items":{"type":"object","required":["id","name","allow_options"],"properties":{"id":{"type":"string","format":"uuid","description":"The id of the custom field.","example":"44b2add5-eeb2-456c-8918-9bb362b0e896"},"name":{"type":"string","example":"Department"},"allow_options":{"type":["array","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For LIST-type custom fields, the list-item ids selectable on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this budget. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means no per-budget restriction (all"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabled options are selectable). An empty array means no"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"options are selectable on this budget. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"FREE_TEXT custom fields."},"children":[]}]}]}],"items":{"type":"string","format":"uuid"}}}}},"is_deleted":{"type":"boolean","description":"Whether the budget is deleted.","example":false},"created":{"type":"string","format":"date-time","description":"The date and time when the budget was created in UTC.","example":"2024-01-01T00:00:00Z"},"updated":{"type":"string","format":"date-time","description":"The date and time when the budget was last updated in UTC.","example":"2024-01-01T00:00:00Z"}}}},"components/schemas/BudgetListResponse":{"id":"components/schemas/BudgetListResponse","kind":"json-schema","title":"BudgetListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of budgets that match the query.","example":100},"next":{"type":"string","description":"The URL to the next page of budgets.","example":"offset=50&limit=50"},"previous":{"type":"string","description":"The URL to the previous page of budgets.","example":"offset=0&limit=50"},"results":{"type":"array","items":{"$ref":"#/components/schemas/Budget"}}}}},"components/schemas/BudgetResetPeriod":{"id":"components/schemas/BudgetResetPeriod","kind":"json-schema","title":"BudgetResetPeriod","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The reset cadence for the budget. JULY_FINANCIAL_YEAR resets on 1 July;"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"APRIL_FINANCIAL_YEAR resets on 1 April."},"children":[]}]}]}],"enum":["DAILY","WEEKLY","FORTNIGHTLY","MONTHLY","QUARTERLY","ANNUALLY","JULY_FINANCIAL_YEAR","APRIL_FINANCIAL_YEAR","NEVER"],"example":"MONTHLY"}},"components/schemas/BudgetUserRef":{"id":"components/schemas/BudgetUserRef","kind":"json-schema","title":"BudgetUserRef","data":{"type":"object","description":"Reference to an existing Weel user by id.","required":["id"],"properties":{"id":{"type":"integer","description":"The id of the user.","example":12345}}}},"components/schemas/BudgetInviteRef":{"id":"components/schemas/BudgetInviteRef","kind":"json-schema","title":"BudgetInviteRef","data":{"type":"object","description":"Reference to an outstanding invite by id.","required":["id"],"properties":{"id":{"type":"string","format":"uuid","description":"The id of the invite.","example":"f4c1e25a-2a78-4f4f-9d3e-1c3a96cf21b1"}}}},"components/schemas/BudgetMemberInput":{"id":"components/schemas/BudgetMemberInput","kind":"json-schema","title":"BudgetMemberInput","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A member to attach to the budget. Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_member_limits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is true"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and must be omitted otherwise; the sum of member "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must equal the budget's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"user":{"$ref":"#/components/schemas/BudgetUserRef"},"invite":{"$ref":"#/components/schemas/BudgetInviteRef"},"reset_amount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The per-member spending cap when has_member_limits is true."},"children":[]}]}]}],"example":250}},"oneOf":[{"required":["user"]},{"required":["invite"]}]}},"components/schemas/BudgetOwnerInput":{"id":"components/schemas/BudgetOwnerInput","kind":"json-schema","title":"BudgetOwnerInput","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An owner (budget approver) to attach to the budget. Provide exactly"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"user":{"$ref":"#/components/schemas/BudgetUserRef"},"invite":{"$ref":"#/components/schemas/BudgetInviteRef"}},"oneOf":[{"required":["user"]},{"required":["invite"]}]}},"components/schemas/BudgetCustomFieldInput":{"id":"components/schemas/BudgetCustomFieldInput","kind":"json-schema","title":"BudgetCustomFieldInput","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A custom field to attach to the budget. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allow_options"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" restricts the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visible list items for LIST-type custom fields. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to detach"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all options; omit the key to leave existing options unchanged."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not accepted."},"children":[]}]}]}],"required":["id"],"properties":{"id":{"type":"string","format":"uuid","description":"The id of the custom field.","example":"a2b1d8c0-9a4e-4b8a-bf24-90af44a98e2f"},"allow_options":{"type":"array","description":"List item ids that should remain selectable on this budget.","items":{"type":"string","format":"uuid"}}}}},"components/schemas/BudgetCreateRequest":{"id":"components/schemas/BudgetCreateRequest","kind":"json-schema","title":"BudgetCreateRequest","data":{"type":"object","required":["name","reset_amount","reset_period","has_member_limits","rollover_funds","members","owners"],"properties":{"name":{"type":"string","maxLength":128,"description":"The name of the budget.","example":"Sales Team"},"reset_amount":{"type":"number","description":"The amount the budget resets to each period.","example":1000},"reset_period":{"$ref":"#/components/schemas/BudgetResetPeriod"},"has_member_limits":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, each member has its own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cap and the sum"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of member caps must equal the budget "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". When false,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"members share the budget's pot."},"children":[]}]}]}],"example":false},"rollover_funds":{"type":"boolean","description":"When true, unspent balance rolls over to the next period.","example":false},"members":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/BudgetMemberInput"}},"owners":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/BudgetOwnerInput"}},"limit_categories":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, only the categories listed in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"categories"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are visible"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"on the budget. When false, all business categories are visible."},"children":[]}]}]}],"default":false,"example":false},"categories":{"type":"array","description":"Category ids that should be visible on the budget.","items":{"type":"string","format":"uuid"}},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/BudgetCustomFieldInput"}}}}},"components/schemas/BudgetUpdateRequest":{"id":"components/schemas/BudgetUpdateRequest","kind":"json-schema","title":"BudgetUpdateRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partial update of a budget's configuration. To change members or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"owners, use their respective endpoints —"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Budget-Members"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"budget members"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#tag/Budget-Owners"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"budget owners"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Toggling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_member_limits"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cascades onto existing members (equal split on false→true)."},"children":[]}]}]}],"properties":{"name":{"type":"string","maxLength":128,"example":"Sales Team"},"reset_amount":{"type":"number","example":1500},"reset_period":{"$ref":"#/components/schemas/BudgetResetPeriod"},"has_member_limits":{"type":"boolean","example":true},"rollover_funds":{"type":"boolean","example":true},"limit_categories":{"type":"boolean","example":true},"categories":{"type":"array","items":{"type":"string","format":"uuid"}},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/BudgetCustomFieldInput"}}}}},"components/schemas/BudgetMember":{"id":"components/schemas/BudgetMember","kind":"json-schema","title":"BudgetMember","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the budget member.","example":"e33b7c61-5124-4ba0-b238-e4c573133715"},"user":{"description":"The user for the budget member. Only present if the user has accepted their invite to Weel.","$ref":"#/components/schemas/SubUser"},"invite":{"description":"The invite for the budget member. Only present if the user has not  accepted their invite to Weel.","$ref":"#/components/schemas/Invite"},"available_amount":{"type":"number","description":"The available amount of the budget member.","example":800},"spent_amount":{"type":"number","description":"The amount of the budget that has been spent by the budget member.","example":200},"reset_amount":{"type":"number","description":"The reset amount of the budget member.","example":1000},"is_deleted":{"type":"boolean","description":"Whether the budget member is deleted.","example":false},"created":{"type":"string","format":"date-time","description":"The date and time when the budget member was created in UTC.","example":"2024-01-01T00:00:00Z"},"updated":{"type":"string","format":"date-time","description":"The date and time when the budget member was last updated in UTC.","example":"2024-01-01T00:00:00Z"}}}},"components/schemas/BudgetMemberListResponse":{"id":"components/schemas/BudgetMemberListResponse","kind":"json-schema","title":"BudgetMemberListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of budget members that match the query.","example":100},"next":{"type":"string","description":"The URL to the next page of budget members.","example":"offset=50&limit=50"},"previous":{"type":"string","description":"The URL to the previous page of budget members.","example":"offset=0&limit=50"},"results":{"type":"array","items":{"$ref":"#/components/schemas/BudgetMember"}}}}},"components/schemas/CreateBudgetMemberRequest":{"id":"components/schemas/CreateBudgetMemberRequest","kind":"json-schema","title":"CreateBudgetMemberRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when the budget has "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_member_limits=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and must be omitted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"otherwise."},"children":[]}]}]}],"properties":{"user":{"type":"object","description":"An accepted user in this business.","properties":{"id":{"type":"integer","description":"The user's ID.","example":123}},"required":["id"]},"invite":{"type":"object","description":"A pending invite in this business.","properties":{"id":{"type":"string","description":"The invite's ID.","example":"e33b7c61-5124-4ba0-b238-e4c573133715"}},"required":["id"]},"reset_amount":{"type":"number","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The member's spending limit. Required when the budget has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_member_limits=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Must be omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_member_limits=false"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(the member inherits the budget's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"example":500}},"oneOf":[{"required":["user"]},{"required":["invite"]}]}},"components/schemas/UpdateBudgetMemberRequest":{"id":"components/schemas/UpdateBudgetMemberRequest","kind":"json-schema","title":"UpdateBudgetMemberRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the member's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reset_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only valid when the budget has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"has_member_limits=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"reset_amount":{"type":"number","description":"The new per-member spending limit.","example":750}},"required":["reset_amount"]}},"components/schemas/BudgetOwner":{"id":"components/schemas/BudgetOwner","kind":"json-schema","title":"BudgetOwner","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the budget owner.","example":"e33b7c61-5124-4ba0-b238-e4c573133715"},"user":{"description":"The user for the budget owner. Only present once the underlying invite has been accepted.","$ref":"#/components/schemas/SubUser"},"invite":{"description":"The pending invite for the budget owner. Only present while the user has not yet accepted their invite.","$ref":"#/components/schemas/Invite"},"is_deleted":{"type":"boolean","description":"Whether the budget owner has been removed from the budget.","example":false},"created":{"type":"string","format":"date-time","description":"The date and time when the budget owner was created in UTC.","example":"2024-01-01T00:00:00Z"},"updated":{"type":"string","format":"date-time","description":"The date and time when the budget owner was last updated in UTC.","example":"2024-01-01T00:00:00Z"}}}},"components/schemas/BudgetOwnerListResponse":{"id":"components/schemas/BudgetOwnerListResponse","kind":"json-schema","title":"BudgetOwnerListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of budget owners that match the query.","example":3},"next":{"type":"string","description":"The URL to the next page of budget owners.","example":"offset=50&limit=50"},"previous":{"type":"string","description":"The URL to the previous page of budget owners.","example":"offset=0&limit=50"},"results":{"type":"array","items":{"$ref":"#/components/schemas/BudgetOwner"}}}}},"components/schemas/CreateBudgetOwnerRequest":{"id":"components/schemas/CreateBudgetOwnerRequest","kind":"json-schema","title":"CreateBudgetOwnerRequest","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provide exactly one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the invite has already"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"been accepted by the time the request is processed, the response will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"contain "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" rather than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"invite"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"user":{"type":"object","description":"An accepted user in this business.","properties":{"id":{"type":"integer","description":"The user's ID.","example":123}},"required":["id"]},"invite":{"type":"object","description":"A pending invite in this business.","properties":{"id":{"type":"string","description":"The invite's ID.","example":"e33b7c61-5124-4ba0-b238-e4c573133715"}},"required":["id"]}},"oneOf":[{"required":["user"]},{"required":["invite"]}]}},"components/schemas/BudgetTopup":{"id":"components/schemas/BudgetTopup","kind":"json-schema","title":"BudgetTopup","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the topup.","example":"e33b7c61-5124-4ba0-b238-e4c573133715"},"amount":{"type":"number","description":"Positive values increase the available amount, negative values decrease it.","example":100},"description":{"type":"string","description":"The description of the topup.","example":"Additional funds for travel"},"status":{"type":"string","description":"The status of the topup.","enum":["APPROVED","CANCELLED","DECLINED","PENDING"],"example":"APPROVED"},"requested_by":{"description":"The user who requested the topup.","$ref":"#/components/schemas/SubUser"},"actioned_by":{"description":"The user who actioned an approval or decline of the topup.","$ref":"#/components/schemas/SubUser"},"actioned_on":{"type":"string","format":"date-time","description":"The date and time when the topup was actioned in UTC.","example":"2024-01-01T00:00:00Z"},"created":{"type":"string","format":"date-time","description":"The date and time when the topup was created in UTC.","example":"2024-01-01T00:00:00Z"},"updated":{"type":"string","format":"date-time","description":"The date and time when the topup was last updated in UTC.","example":"2024-01-01T00:00:00Z"}}}},"components/schemas/BudgetTopupListResponse":{"id":"components/schemas/BudgetTopupListResponse","kind":"json-schema","title":"BudgetTopupListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"The total number of topups that match the query.","example":100},"next":{"type":"string","description":"The URL to the next page of topups.","example":"offset=50&limit=50"},"previous":{"type":"string","description":"The URL to the previous page of topups.","example":"offset=0&limit=50"},"results":{"type":"array","items":{"$ref":"#/components/schemas/BudgetTopup"}}}}},"components/schemas/BudgetTopupCreate":{"id":"components/schemas/BudgetTopupCreate","kind":"json-schema","title":"BudgetTopupCreate","data":{"type":"object","required":["amount","description"],"properties":{"amount":{"type":"number","description":"Positive values increase the available amount, negative values decrease it.","example":100},"description":{"type":"string","description":"The description of the topup.","example":"Additional funds for travel"},"auto_approve":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, topups require approval before being added to the budget. Set this to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to automatically add the topup to the budget."},"children":[]}]}]}],"example":true}}}},"components/schemas/LineItemCategory":{"id":"components/schemas/LineItemCategory","kind":"json-schema","title":"LineItemCategory","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the category.","example":"f2c9897d-62fb-4d64-9647-3e6bf62d07c2"},"name":{"type":"string","description":"The name of the category in Weel.","example":"Accommodation"},"code":{"type":["string","null"],"description":"The accounting code of the category, if any.","example":"6668"}}}},"components/schemas/Balance":{"id":"components/schemas/Balance","kind":"json-schema","title":"Balance","data":{"type":"object","properties":{"balance":{"type":"number","description":"Account balance amount as a decimal number","example":123.45},"currency":{"type":"string","description":"ISO 4217 currency code","example":"AUD"}},"required":["balance","currency"]}},"components/schemas/CustomField":{"id":"components/schemas/CustomField","kind":"json-schema","title":"CustomField","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for this custom field.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"type":"string","description":"The display name of the custom field.","example":"Project Code"},"field_type":{"type":"string","description":"The type of the custom field.","enum":["LIST","FREE_TEXT"],"example":"LIST"},"budget_setting":{"type":"string","description":"Controls which budgets this custom field is assigned to.","enum":["NONE","SOME","ALL_CURRENT_AND_NEW"],"example":"NONE"},"is_manager_only":{"type":"boolean","description":"Whether this custom field is visible only to managers. Cannot be changed after creation.","example":false},"created_by":{"type":"string","description":"The source that created this custom field.","enum":["MANUAL","PUBLIC_API","XERO","MYOB","QUICKBOOKS","NETSUITE","BUSINESS_CENTRAL"],"example":"PUBLIC_API"},"created":{"type":"string","format":"date-time","description":"The date and time when this custom field was created.","example":"2024-01-15T09:00:00Z"},"updated":{"type":"string","format":"date-time","description":"The date and time when this custom field was last updated.","example":"2024-01-15T09:00:00Z"}}}},"components/schemas/CustomFieldListResponse":{"id":"components/schemas/CustomFieldListResponse","kind":"json-schema","title":"CustomFieldListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of custom fields.","example":10},"next":{"type":["string","null"],"description":"Pagination cursor for the next page.","example":"limit=50&offset=50"},"previous":{"type":["string","null"],"description":"Pagination cursor for the previous page.","example":null},"results":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}}}}},"components/schemas/CreateCustomFieldRequest":{"id":"components/schemas/CreateCustomFieldRequest","kind":"json-schema","title":"CreateCustomFieldRequest","data":{"type":"object","required":["name","field_type"],"properties":{"name":{"type":"string","description":"The display name for the custom field. Must be unique within the business.","example":"Project Code"},"field_type":{"type":"string","description":"The type of the custom field.","enum":["LIST","FREE_TEXT"],"example":"LIST"},"budget_setting":{"type":"string","description":"Controls which budgets this custom field is assigned to.","enum":["NONE","SOME","ALL_CURRENT_AND_NEW"],"default":"ALL_CURRENT_AND_NEW","example":"NONE"}}}},"components/schemas/UpdateCustomFieldRequest":{"id":"components/schemas/UpdateCustomFieldRequest","kind":"json-schema","title":"UpdateCustomFieldRequest","data":{"type":"object","properties":{"name":{"type":"string","description":"The new display name. Not permitted for fields created by accounting integrations. Cannot set to a name already in use by another custom field in the business.","example":"Cost Centre"},"field_type":{"type":"string","description":"The type of the custom field. Not permitted for fields created by accounting integrations.","enum":["LIST","FREE_TEXT"],"example":"LIST"},"is_manager_only":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cannot be changed after creation — always returns 400 if a different value is sent."},"children":[]}]}]}],"example":false},"budget_setting":{"type":"string","description":"Controls which budgets this custom field is assigned to.","enum":["NONE","SOME","ALL_CURRENT_AND_NEW"],"example":"SOME"}}}},"components/schemas/CustomFieldOption":{"id":"components/schemas/CustomFieldOption","kind":"json-schema","title":"CustomFieldOption","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for this option.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"text":{"type":"string","description":"The display text of this option.","example":"Project Alpha"},"enabled":{"type":"boolean","description":"Whether this option is available for selection.","example":true},"created":{"type":"string","format":"date-time","description":"The date and time when this option was created.","example":"2024-01-15T09:00:00Z"},"updated":{"type":"string","format":"date-time","description":"The date and time when this option was last updated.","example":"2024-01-15T09:00:00Z"}}}},"components/schemas/CustomFieldOptionListResponse":{"id":"components/schemas/CustomFieldOptionListResponse","kind":"json-schema","title":"CustomFieldOptionListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of options for this custom field (including disabled).","example":5},"next":{"type":["string","null"],"description":"Pagination cursor for the next page.","example":"limit=50&offset=50"},"previous":{"type":["string","null"],"description":"Pagination cursor for the previous page.","example":null},"results":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldOption"}}}}},"components/schemas/CreateCustomFieldOptionRequest":{"id":"components/schemas/CreateCustomFieldOptionRequest","kind":"json-schema","title":"CreateCustomFieldOptionRequest","data":{"type":"object","required":["text"],"properties":{"text":{"type":"string","description":"The display text for this option.","example":"Project Alpha"}}}},"components/schemas/UpdateCustomFieldOptionRequest":{"id":"components/schemas/UpdateCustomFieldOptionRequest","kind":"json-schema","title":"UpdateCustomFieldOptionRequest","data":{"type":"object","properties":{"text":{"type":"string","description":"The new display text. Only permitted for options belonging to non-accounting-integration custom fields.","example":"Project Beta"},"enabled":{"type":"boolean","description":"Enable or disable this option. Only permitted for options belonging to accounting integration custom fields (Xero, MYOB, QuickBooks, NetSuite, Business Central).","example":false}}}},"components/schemas/CustomFieldBudget":{"id":"components/schemas/CustomFieldBudget","kind":"json-schema","title":"CustomFieldBudget","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the linked budget.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"name":{"type":"string","description":"The name of the linked budget.","example":"Marketing Q1"}}}},"components/schemas/CustomFieldBudgetListResponse":{"id":"components/schemas/CustomFieldBudgetListResponse","kind":"json-schema","title":"CustomFieldBudgetListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of budgets linked to this custom field.","example":3},"next":{"type":["string","null"],"description":"Pagination cursor for the next page.","example":"limit=50&offset=50"},"previous":{"type":["string","null"],"description":"Pagination cursor for the previous page.","example":null},"results":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldBudget"}}}}},"components/schemas/CreateCustomFieldBudgetRequest":{"id":"components/schemas/CreateCustomFieldBudgetRequest","kind":"json-schema","title":"CreateCustomFieldBudgetRequest","data":{"type":"object","required":["budget"],"properties":{"budget":{"type":"string","format":"uuid","description":"The ID of the budget to link to this custom field.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}}},"components/schemas/AccountingCode":{"id":"components/schemas/AccountingCode","kind":"json-schema","title":"AccountingCode","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for this GL code.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"code":{"type":"string","description":"The GL code string used for bookkeeping export.","example":"4000"},"name":{"type":"string","description":"The display name of the GL code.","example":"Office Expenses"},"created":{"type":"string","format":"date-time","description":"When this GL code was created in UTC.","example":"2026-01-15T10:30:00Z"},"updated":{"type":"string","format":"date-time","description":"When this GL code was last updated in UTC.","example":"2026-01-15T10:30:00Z"}}}},"components/schemas/AccountingCodeListResponse":{"id":"components/schemas/AccountingCodeListResponse","kind":"json-schema","title":"AccountingCodeListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of GL codes.","example":100},"next":{"type":["string","null"],"description":"Pagination cursor for the next page.","example":"limit=50&offset=50"},"previous":{"type":["string","null"],"description":"Pagination cursor for the previous page.","example":null},"results":{"type":"array","items":{"$ref":"#/components/schemas/AccountingCode"}}}}},"components/schemas/CreateAccountingCodeRequest":{"id":"components/schemas/CreateAccountingCodeRequest","kind":"json-schema","title":"CreateAccountingCodeRequest","data":{"type":"object","required":["code","name"],"properties":{"code":{"type":"string","maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The GL code string. Used as the upsert key — if a code with this value already exists it will be updated."},"children":[]}]}]}],"example":"4000"},"name":{"type":"string","maxLength":150,"description":"The display name of the GL code.","example":"Office Expenses"}}}},"components/schemas/Category":{"id":"components/schemas/Category","kind":"json-schema","title":"Category","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for this category.","example":"7cb19e45-1234-5678-abcd-ef9876543210"},"name":{"type":"string","description":"The display name of the category.","example":"Travel"},"custom":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether this is a custom category created by the business. System-defined categories have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":false},"enabled":{"type":"boolean","description":"Whether this category is available for use on transactions.","example":true},"accounting_code_id":{"type":["string","null"],"format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the GL code mapped to this category, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if no mapping exists."},"children":[]}]}]}],"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"created":{"type":"string","format":"date-time","description":"When this category was created in UTC.","example":"2025-01-01T00:00:00Z"},"updated":{"type":"string","format":"date-time","description":"When this category was last updated in UTC.","example":"2025-01-01T00:00:00Z"}}}},"components/schemas/CategoryListResponse":{"id":"components/schemas/CategoryListResponse","kind":"json-schema","title":"CategoryListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of categories.","example":10},"next":{"type":["string","null"],"description":"Pagination cursor for the next page.","example":"limit=50&offset=50"},"previous":{"type":["string","null"],"description":"Pagination cursor for the previous page.","example":null},"results":{"type":"array","items":{"$ref":"#/components/schemas/Category"}}}}},"components/schemas/TaxRateListResponse":{"id":"components/schemas/TaxRateListResponse","kind":"json-schema","title":"TaxRateListResponse","data":{"type":"object","properties":{"count":{"type":"integer","description":"Total number of tax rates.","example":10},"next":{"type":["string","null"],"description":"Pagination cursor for the next page.","example":"limit=50&offset=50"},"previous":{"type":["string","null"],"description":"Pagination cursor for the previous page.","example":null},"results":{"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}}}}},"components/schemas/CreateCategoryRequest":{"id":"components/schemas/CreateCategoryRequest","kind":"json-schema","title":"CreateCategoryRequest","data":{"type":"object","required":["name"],"properties":{"name":{"type":"string","maxLength":128,"description":"The display name for the new custom category. Must be unique within the business.","example":"Internal Events"},"accounting_code_id":{"type":["string","null"],"format":"uuid","description":"The ID of a GL code to map to this category. Must belong to the same business. Omit to create without a mapping.","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}}},"components/schemas/UpdateCategoryRequest":{"id":"components/schemas/UpdateCategoryRequest","kind":"json-schema","title":"UpdateCategoryRequest","data":{"type":"object","properties":{"name":{"type":"string","maxLength":128,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New display name. Only accepted for custom categories ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Returns 400 for system categories."},"children":[]}]}]}],"example":"Updated Category Name"},"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether this category is available for use. Only accepted for system categories ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"custom: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Returns 400 for custom categories."},"children":[]}]}]}],"example":false},"accounting_code_id":{"type":["string","null"],"format":"uuid","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of a GL code to map to this category. Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to remove an existing mapping. Must belong to the same business."},"children":[]}]}]}],"example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"}}}},"schema_16":{"kind":"json-schema","data":{"type":"integer","example":123},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"type":"integer","default":0,"example":50},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"type":"integer","default":50,"maximum":500,"example":50},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"type":"string","enum":["COMPLETE","INCOMPLETE_EXPENSE"],"example":"COMPLETE"},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"$ref":"#/components/schemas/TransactionStatus"},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"type":"string"},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"type":"boolean","example":false},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"type":"string","enum":["BUDGET","SUBSCRIPTION"],"example":"BUDGET"},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"type":"object","properties":{"non_field_errors":{"type":"array","items":{"type":"string","example":"Cannot topup budget with member limits"}}}},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"type":"object","properties":{"non_field_errors":{"type":"array","items":{"type":"string","example":"Cannot topup budget member when budget does not have member limits"}}}},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/Balance"}},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"3fa85f64-5717-4562-b3fc-2c963f66afa6"},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"type":"string","format":"uuid","example":"7cb19e45-1234-5678-abcd-ef9876543210"},"id":"schema_31"}},"exampleStore":{},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://public.letsweel.com"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Weel OpenAPI","description":"The Weel OpenAPI empowers businesses with seamless expense management and real-time insights. Our platform makes it easy to integrate and automate expense workflows, manage receipts, and keep track of spending across your organization.\n"}},"baseSlug":"/openapi","routesMapping":{}}