1
0
Files
bigcapital/shared/sdk-ts/src/schema.ts
T
rebekah-create 3cbc4842b9 fix(server): correct "Liabilties" typo to "Liabilities" in balance sheet
The balance sheet rendered "Current Liabilties" in the Liabilities
section because of a typo in the i18n key, the schema reference, the
swagger example responses, and the generated SDK fixtures. Fixed all
five locations so PDF/HTML/JSON renders all read "Current Liabilities".

- packages/server/src/i18n/en/balance_sheet.json: rename key and value
- packages/server/src/modules/FinancialStatements/modules/BalanceSheet/
  BalanceSheetSchema.ts: update i18n key reference
- packages/server/src/modules/FinancialStatements/modules/BalanceSheet/
  BalanceSheet.swagger.ts: fix three example response strings
- shared/sdk-ts/openapi.json + schema.ts: regenerate to match
2026-05-12 00:10:44 -04:00

29035 lines
1.0 MiB
Plaintext

/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/api/system_db": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["SystemDatabaseController_ping"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/auth/signin": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Sign in a user */
post: operations["AuthController_signin"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/auth/signup": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Sign up a new user */
post: operations["AuthController_signup"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/auth/signup/verify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Confirm user signup */
post: operations["AuthController_signupConfirm"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/auth/send_reset_password": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Send reset password email */
post: operations["AuthController_sendResetPassword"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/auth/reset_password/{token}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Reset password using token */
post: operations["AuthController_resetPassword"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/auth/meta": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get auth metadata (e.g. signup disabled) */
get: operations["AuthController_meta"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/auth/signup/verify/resend": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Resend the signup confirmation message */
post: operations["AuthedController_resendSignupConfirm"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/auth/account": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve the authenticated account */
get: operations["AuthedController_getAuthedAcccount"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/api-keys/generate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Generate a new API key */
post: operations["AuthApiKeysController_generate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/api-keys/{id}/revoke": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Revoke an API key */
put: operations["AuthApiKeysController_revoke"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/api-keys": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get all API keys for the current tenant */
get: operations["AuthApiKeysController_getApiKeys"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/items": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the item list. */
get: operations["ItemsController_getItems"];
put?: never;
/** Create a new item (product or service). */
post: operations["ItemsController_createItem"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/items/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get the given item (product or service). */
get: operations["ItemsController_getItem"];
/** Edit the given item (product or service). */
put: operations["ItemsController_editItem"];
post?: never;
/** Delete the given item (product or service). */
delete: operations["ItemsController_deleteItem"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/items/validate-bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validates which items can be deleted and returns counts of deletable and non-deletable items. */
post: operations["ItemsController_validateBulkDeleteItems"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/items/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deletes multiple items in bulk. */
post: operations["ItemsController_bulkDeleteItems"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/items/{id}/inactivate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Inactivate the given item (product or service). */
patch: operations["ItemsController_inactivateItem"];
trace?: never;
};
"/api/items/{id}/activate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Activate the given item (product or service). */
patch: operations["ItemsController_activateItem"];
trace?: never;
};
"/api/items/{id}/invoices": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the item associated invoices transactions. */
get: operations["ItemsController_getItemInvoicesTransactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/items/{id}/bills": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the item associated bills transactions. */
get: operations["ItemsController_getItemBillTransactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/items/{id}/estimates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the item associated estimates transactions. */
get: operations["ItemsController_getItemEstimatesTransactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/items/{id}/receipts": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the item associated receipts transactions. */
get: operations["ItemsController_getItemReceiptTransactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/inventory-adjustments/quick": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Create a quick inventory adjustment. */
post: operations["InventoryAdjustmentsController_createQuickInventoryAdjustment"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/inventory-adjustments/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the inventory adjustment details. */
get: operations["InventoryAdjustmentsController_getInventoryAdjustment"];
put?: never;
post?: never;
/** Delete the given inventory adjustment. */
delete: operations["InventoryAdjustmentsController_deleteInventoryAdjustment"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/inventory-adjustments": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the inventory adjustments. */
get: operations["InventoryAdjustmentsController_getInventoryAdjustments"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/inventory-adjustments/{id}/publish": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Publish the given inventory adjustment. */
put: operations["InventoryAdjustmentsController_publishInventoryAdjustment"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/branches": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the branches. */
get: operations["BranchesController_getBranches"];
put?: never;
/** Create a new branch. */
post: operations["BranchesController_createBranch"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/branches/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the branch details. */
get: operations["BranchesController_getBranch"];
/** Edit the given branch. */
put: operations["BranchesController_editBranch"];
post?: never;
/** Delete the given branch. */
delete: operations["BranchesController_deleteBranch"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/branches/activate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Activate the branches feature. */
post: operations["BranchesController_activateBranches"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/branches/{id}/mark-as-primary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Mark the given branch as primary. */
put: operations["BranchesController_markBranchAsPrimary"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/warehouses": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get all warehouses */
get: operations["WarehousesController_getWarehouses"];
put?: never;
/** Create a warehouse */
post: operations["WarehousesController_createWarehouse"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/warehouses/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a warehouse */
get: operations["WarehousesController_getWarehouse"];
put: operations["WarehousesController_editWarehouse"];
post?: never;
/** Delete a warehouse */
delete: operations["WarehousesController_deleteWarehouse"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/warehouses/activate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Activate a warehouse */
post: operations["WarehousesController_activateWarehouses"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/warehouses/{id}/mark-primary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Mark a warehouse as primary */
put: operations["WarehousesController_markWarehousePrimary"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/items/{id}/warehouses": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the item associated warehouses. */
get: operations["WarehouseItemsController_getItemWarehouses"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/accounts/validate-bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validates which accounts can be deleted and returns counts of deletable and non-deletable accounts. */
post: operations["AccountsController_validateBulkDeleteAccounts"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/accounts/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deletes multiple accounts in bulk. */
post: operations["AccountsController_bulkDeleteAccounts"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/accounts": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the accounts. */
get: operations["AccountsController_getAccounts"];
put?: never;
/** Create an account */
post: operations["AccountsController_createAccount"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/accounts/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the account details. */
get: operations["AccountsController_getAccount"];
/** Edit the given account. */
put: operations["AccountsController_editAccount"];
post?: never;
/** Delete the given account. */
delete: operations["AccountsController_deleteAccount"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/accounts/{id}/activate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Activate the given account. */
post: operations["AccountsController_activateAccount"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/accounts/{id}/inactivate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Inactivate the given account. */
post: operations["AccountsController_inactivateAccount"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/accounts/types": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the account types. */
get: operations["AccountsController_getAccountTypes"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/accounts/transactions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the account transactions. */
get: operations["AccountsController_getAccountTransactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/inventory-cost/items": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get items inventory valuation list */
get: operations["InventoryCostController_getItemsCost"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-invoices/validate-bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validates which sale invoices can be deleted and returns the results. */
post: operations["SaleInvoicesController_validateBulkDeleteSaleInvoices"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-invoices/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deletes multiple sale invoices. */
post: operations["SaleInvoicesController_bulkDeleteSaleInvoices"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-invoices": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale invoices. */
get: operations["SaleInvoicesController_getSaleInvoices"];
put?: never;
/** Create a new sale invoice. */
post: operations["SaleInvoicesController_createSaleInvoice"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-invoices/{id}/mail": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale invoice mail state. */
get: operations["SaleInvoicesController_getSaleInvoiceMailState"];
put?: never;
/** Send the sale invoice mail. */
post: operations["SaleInvoicesController_sendSaleInvoiceMail"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-invoices/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale invoice details. */
get: operations["SaleInvoicesController_getSaleInvoice"];
/** Edit the given sale invoice. */
put: operations["SaleInvoicesController_editSaleInvoice"];
post?: never;
/** Delete the given sale invoice. */
delete: operations["SaleInvoicesController_deleteSaleInvoice"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-invoices/receivable": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the receivable sale invoices. */
get: operations["SaleInvoicesController_getReceivableSaleInvoices"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-invoices/state": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale invoice state. */
get: operations["SaleInvoicesController_getSaleInvoiceState"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-invoices/{id}/deliver": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Deliver the given sale invoice. */
put: operations["SaleInvoicesController_deliverSaleInvoice"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-invoices/{id}/writeoff": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Write off the given sale invoice. */
post: operations["SaleInvoicesController_writeOff"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-invoices/{id}/cancel-writeoff": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Cancel the written off sale invoice. */
post: operations["SaleInvoicesController_cancelWrittenoff"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-invoices/{id}/payments": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale invoice payments. */
get: operations["SaleInvoicesController_getInvoicePayments"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-invoices/{id}/html": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale invoice HTML. */
get: operations["SaleInvoicesController_saleInvoiceHtml"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-invoices/{id}/generate-link": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Generate sharable sale invoice link (private or public) */
post: operations["SaleInvoicesController_generateSaleInvoiceSharableLink"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/pdf-templates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the PDF templates. */
get: operations["PdfTemplatesController_getPdfTemplates"];
put?: never;
/** Create a new PDF template. */
post: operations["PdfTemplatesController_createPdfTemplate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/pdf-templates/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the PDF template details. */
get: operations["PdfTemplatesController_getPdfTemplate"];
/** Edit the given PDF template. */
put: operations["PdfTemplatesController_editPdfTemplate"];
post?: never;
/** Delete the given PDF template. */
delete: operations["PdfTemplatesController_deletePdfTemplate"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/pdf-templates/state": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the PDF template branding state. */
get: operations["PdfTemplatesController_getPdfTemplateBrandingState"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/pdf-templates/{id}/assign-default": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Assign the given PDF template as default. */
put: operations["PdfTemplatesController_assignPdfTemplateAsDefault"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/attachments": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Upload attachment to S3 */
post: operations["AttachmentsController_uploadAttachment"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/attachments/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get attachment by ID */
get: operations["AttachmentsController_getAttachment"];
put?: never;
post?: never;
/** Delete attachment by ID */
delete: operations["AttachmentsController_deleteAttachment"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/attachments/{id}/link": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Link attachment to a model */
post: operations["AttachmentsController_linkDocument"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/attachments/{id}/unlink": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Unlink attachment from a model */
post: operations["AttachmentsController_unlinkDocument"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/attachments/{id}/presigned-url": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get presigned URL for attachment */
get: operations["AttachmentsController_getAttachmentPresignedUrl"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/tax-rates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the tax rates. */
get: operations["TaxRatesController_getTaxRates"];
put?: never;
/** Create a new tax rate. */
post: operations["TaxRatesController_createTaxRate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/tax-rates/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the tax rate details. */
get: operations["TaxRatesController_getTaxRate"];
/** Edit the given tax rate. */
put: operations["TaxRatesController_editTaxRate"];
post?: never;
/** Delete the given tax rate. */
delete: operations["TaxRatesController_deleteTaxRate"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/tax-rates/{id}/activate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Activate the given tax rate. */
put: operations["TaxRatesController_activateTaxRate"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/tax-rates/{id}/inactivate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Inactivate the given tax rate. */
put: operations["TaxRatesController_inactivateTaxRate"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payments-received/{id}/mail": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["PaymentReceivesController_getPaymentReceiveMailOptions"];
put?: never;
post: operations["PaymentReceivesController_sendPaymentReceiveMail"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payments-received/{id}/edit-page": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["PaymentReceivesController_getPaymentReceiveEditPage"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payments-received": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the payment received list. */
get: operations["PaymentReceivesController_getPaymentsReceived"];
put?: never;
/** Create a new payment received. */
post: operations["PaymentReceivesController_createPaymentReceived"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payments-received/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the payment received details. */
get: operations["PaymentReceivesController_getPaymentReceive"];
/** Edit the given payment received. */
put: operations["PaymentReceivesController_editPaymentReceive"];
post?: never;
/** Delete the given payment received. */
delete: operations["PaymentReceivesController_deletePaymentReceive"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payments-received/validate-bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validates which payments received can be deleted and returns the results. */
post: operations["PaymentReceivesController_validateBulkDeletePaymentsReceived"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payments-received/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deletes multiple payments received. */
post: operations["PaymentReceivesController_bulkDeletePaymentsReceived"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payments-received/state": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the payment received state. */
get: operations["PaymentReceivesController_getPaymentReceivedState"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payments-received/{id}/invoices": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the payment received invoices. */
get: operations["PaymentReceivesController_getPaymentReceiveInvoices"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/import/file": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Upload import file */
post: operations["ImportController_fileUpload"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/import/{import_id}/mapping": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Map import columns */
post: operations["ImportController_mapping"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/import/{import_id}/preview": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Preview import data */
get: operations["ImportController_preview"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/import/{import_id}/import": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Process import */
post: operations["ImportController_import"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/import/sample": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get import sample */
get: operations["ImportController_downloadImportSample"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/import/{import_id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get import metadata */
get: operations["ImportController_getImportFileMeta"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/resources/{resourceModel}/meta": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the resource meta */
get: operations["ResourceController_getResourceMeta"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payment-links/{paymentLinkId}/invoice": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get payment link public metadata
* @description Retrieves public metadata for an invoice payment link
*/
get: operations["PaymentLinksController_getPaymentLinkPublicMeta"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payment-links/{paymentLinkId}/stripe_checkout_session": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Stripe checkout session
* @description Creates a Stripe checkout session for an invoice payment link
*/
post: operations["PaymentLinksController_createInvoicePaymentLinkCheckoutSession"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payment-links/{paymentLinkId}/invoice/pdf": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get payment link invoice PDF
* @description Retrieves the PDF of the invoice associated with a payment link
*/
get: operations["PaymentLinksController_getPaymentLinkInvoicePdf"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/stripe/link": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get Stripe Connect link
* @description Retrieves the Stripe OAuth2 Connect authorization URL
*/
get: operations["StripeIntegrationController_getStripeConnectLink"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/stripe/callback": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Exchange Stripe OAuth code
* @description Exchanges the Stripe authorization code for user id and access token
*/
post: operations["StripeIntegrationController_exchangeOAuth"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/stripe/account": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Stripe account
* @description Creates a new Stripe Connect account
*/
post: operations["StripeIntegrationController_createAccount"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/stripe/account_session": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Stripe account session
* @description Creates an account session for the Stripe Connect embedded component
*/
post: operations["StripeIntegrationController_createAccountSession"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/stripe/account_link": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create Stripe account link
* @description Creates a Stripe Connect account link for onboarding
*/
post: operations["StripeIntegrationController_createAccountLink"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/webhooks/stripe": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Listen to Stripe webhooks */
post: operations["StripePaymentWebhooksController_handleWebhook"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/item-categories": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the item categories. */
get: operations["ItemCategoryController_getItemCategories"];
put?: never;
/** Create a new item category. */
post: operations["ItemCategoryController_createItemCategory"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/item-categories/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the item category details. */
get: operations["ItemCategoryController_getItemCategory"];
/** Edit the given item category. */
put: operations["ItemCategoryController_editItemCategory"];
post?: never;
/** Delete the given item category. */
delete: operations["ItemCategoryController_deleteItemCategory"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/expenses/validate-bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validate which expenses can be deleted and return the results. */
post: operations["ExpensesController_validateBulkDeleteExpenses"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/expenses/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deletes multiple expenses. */
post: operations["ExpensesController_bulkDeleteExpenses"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/expenses": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get the expense transactions. */
get: operations["ExpensesController_getExpenses"];
put?: never;
/** Create a new expense transaction. */
post: operations["ExpensesController_createExpense"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/expenses/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get the expense transaction details. */
get: operations["ExpensesController_getExpense"];
/** Edit the given expense transaction. */
put: operations["ExpensesController_editExpense"];
post?: never;
/** Delete the given expense transaction. */
delete: operations["ExpensesController_deleteExpense"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/expenses/{id}/publish": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Publish the given expense transaction. */
post: operations["ExpensesController_publishExpense"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/warehouse-transfers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve warehouse transfer transactions with pagination. */
get: operations["WarehouseTransfersController_getWarehousesTransfers"];
put?: never;
/** Create a new warehouse transfer transaction. */
post: operations["WarehouseTransfersController_createWarehouseTransfer"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/warehouse-transfers/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve warehouse transfer transaction details. */
get: operations["WarehouseTransfersController_getWarehouseTransfer"];
put?: never;
/** Edit the given warehouse transfer transaction. */
post: operations["WarehouseTransfersController_editWarehouseTransfer"];
/** Delete the given warehouse transfer transaction. */
delete: operations["WarehouseTransfersController_deleteWarehouseTransfer"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/warehouse-transfers/{id}/initiate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Initiate the given warehouse transfer. */
put: operations["WarehouseTransfersController_initiateTransfer"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/warehouse-transfers/{id}/transferred": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Mark the given warehouse transfer as transferred. */
put: operations["WarehouseTransfersController_deliverTransfer"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/customers/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the customer details. */
get: operations["CustomersController_getCustomer"];
/** Edit the given customer. */
put: operations["CustomersController_editCustomer"];
post?: never;
/** Delete the given customer. */
delete: operations["CustomersController_deleteCustomer"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/customers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the customers paginated list. */
get: operations["CustomersController_getCustomers"];
put?: never;
/** Create a new customer. */
post: operations["CustomersController_createCustomer"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/customers/{id}/opening-balance": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Edit the opening balance of the given customer. */
put: operations["CustomersController_editOpeningBalance"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/customers/validate-bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validates which customers can be deleted and returns counts of deletable and non-deletable customers. */
post: operations["CustomersController_validateBulkDeleteCustomers"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/customers/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deletes multiple customers in bulk. */
post: operations["CustomersController_bulkDeleteCustomers"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendors": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the vendors. */
get: operations["VendorsController_getVendors"];
put?: never;
/** Create a new vendor. */
post: operations["VendorsController_createVendor"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendors/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the vendor details. */
get: operations["VendorsController_getVendor"];
/** Edit the given vendor. */
put: operations["VendorsController_editVendor"];
post?: never;
/** Delete the given vendor. */
delete: operations["VendorsController_deleteVendor"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendors/{id}/opening-balance": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Edit the given vendor opening balance. */
put: operations["VendorsController_editOpeningBalance"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendors/validate-bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validates which vendors can be deleted and returns counts of deletable and non-deletable vendors. */
post: operations["VendorsController_validateBulkDeleteVendors"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendors/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deletes multiple vendors in bulk. */
post: operations["VendorsController_bulkDeleteVendors"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-estimates/validate-bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validates which sale estimates can be deleted and returns the results. */
post: operations["SaleEstimatesController_validateBulkDeleteSaleEstimates"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-estimates/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deletes multiple sale estimates. */
post: operations["SaleEstimatesController_bulkDeleteSaleEstimates"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-estimates": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale estimates. */
get: operations["SaleEstimatesController_getSaleEstimates"];
put?: never;
/** Create a new sale estimate. */
post: operations["SaleEstimatesController_createSaleEstimate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-estimates/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale estimate details. */
get: operations["SaleEstimatesController_getSaleEstimate"];
/** Edit the given sale estimate. */
put: operations["SaleEstimatesController_editSaleEstimate"];
post?: never;
/** Delete the given sale estimate. */
delete: operations["SaleEstimatesController_deleteSaleEstimate"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-estimates/state": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale estimate state. */
get: operations["SaleEstimatesController_getSaleEstimateState"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-estimates/{id}/deliver": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deliver the given sale estimate. */
post: operations["SaleEstimatesController_deliverSaleEstimate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-estimates/{id}/approve": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Approve the given sale estimate. */
put: operations["SaleEstimatesController_approveSaleEstimate"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-estimates/{id}/reject": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Reject the given sale estimate. */
put: operations["SaleEstimatesController_rejectSaleEstimate"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-estimates/{id}/notify-sms": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Notify the given sale estimate by SMS. */
post: operations["SaleEstimatesController_notifySaleEstimateBySms"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-estimates/{id}/sms-details": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale estimate SMS details. */
get: operations["SaleEstimatesController_getSaleEstimateSmsDetails"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-estimates/{id}/mail": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale estimate mail state. */
get: operations["SaleEstimatesController_getSaleEstimateMail"];
put?: never;
/** Send the given sale estimate by mail. */
post: operations["SaleEstimatesController_sendSaleEstimateMail"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-receipts/validate-bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validates which sale receipts can be deleted and returns the results. */
post: operations["SaleReceiptsController_validateBulkDeleteSaleReceipts"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-receipts/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deletes multiple sale receipts. */
post: operations["SaleReceiptsController_bulkDeleteSaleReceipts"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-receipts": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale receipts paginated list */
get: operations["SaleReceiptsController_getSaleReceipts"];
put?: never;
/** Create a new sale receipt. */
post: operations["SaleReceiptsController_createSaleReceipt"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-receipts/{id}/mail": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale receipt mail. */
get: operations["SaleReceiptsController_getSaleReceiptMail"];
put?: never;
/** Send the sale receipt mail. */
post: operations["SaleReceiptsController_sendSaleReceiptMail"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-receipts/state": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale receipt state. */
get: operations["SaleReceiptsController_getSaleReceiptState"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-receipts/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the sale receipt details. */
get: operations["SaleReceiptsController_getSaleReceipt"];
/** Edit the given sale receipt. */
put: operations["SaleReceiptsController_editSaleReceipt"];
post?: never;
/** Delete the given sale receipt. */
delete: operations["SaleReceiptsController_deleteSaleReceipt"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/sale-receipts/{id}/close": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Close the given sale receipt. */
post: operations["SaleReceiptsController_closeSaleReceipt"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/bills/validate-bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validate which bills can be deleted and return the results. */
post: operations["BillsController_validateBulkDeleteBills"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/bills/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deletes multiple bills. */
post: operations["BillsController_bulkDeleteBills"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/bills": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the bills. */
get: operations["BillsController_getBills"];
put?: never;
/** Create a new bill. */
post: operations["BillsController_createBill"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/bills/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the bill details. */
get: operations["BillsController_getBill"];
/** Edit the given bill. */
put: operations["BillsController_editBill"];
post?: never;
/** Delete the given bill. */
delete: operations["BillsController_deleteBill"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/bills/{id}/payment-transactions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve the specific bill associated payment transactions. */
get: operations["BillsController_getBillPaymentTransactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/bills/{id}/open": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Open the given bill. */
patch: operations["BillsController_openBill"];
trace?: never;
};
"/api/bills/due": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the due bills. */
get: operations["BillsController_getDueBills"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/landed-cost/transactions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get landed cost transactions */
get: operations["BillAllocateLandedCostController_getLandedCostTransactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/landed-cost/bills/{billId}/allocate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Allocate landed cost to bill items */
post: operations["BillAllocateLandedCostController_calculateLandedCost"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/landed-cost/{allocatedLandedCostId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Delete allocated landed cost */
delete: operations["BillAllocateLandedCostController_deleteAllocatedLandedCost"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/landed-cost/bills/{billId}/transactions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get bill landed cost transactions */
get: operations["BillAllocateLandedCostController_getBillLandedCostTransactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/manual-journals/validate-bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validate which manual journals can be deleted and return the results. */
post: operations["ManualJournalsController_validateBulkDeleteManualJournals"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/manual-journals/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deletes multiple manual journals. */
post: operations["ManualJournalsController_bulkDeleteManualJournals"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/manual-journals": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the manual journals paginated list. */
get: operations["ManualJournalsController_getManualJournals"];
put?: never;
/** Create a new manual journal. */
post: operations["ManualJournalsController_createManualJournal"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/manual-journals/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the manual journal details. */
get: operations["ManualJournalsController_getManualJournal"];
/** Edit the given manual journal. */
put: operations["ManualJournalsController_editManualJournal"];
post?: never;
/** Delete the given manual journal. */
delete: operations["ManualJournalsController_deleteManualJournal"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/manual-journals/{id}/publish": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Publish the given manual journal. */
patch: operations["ManualJournalsController_publishManualJournal"];
trace?: never;
};
"/api/credit-notes": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get all credit notes */
get: operations["CreditNotesController_getCreditNotes"];
put?: never;
/** Create a new credit note */
post: operations["CreditNotesController_createCreditNote"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/credit-notes/state": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get credit note state */
get: operations["CreditNotesController_getCreditNoteState"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/credit-notes/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a specific credit note by ID */
get: operations["CreditNotesController_getCreditNote"];
/** Update a credit note */
put: operations["CreditNotesController_editCreditNote"];
post?: never;
/** Delete a credit note */
delete: operations["CreditNotesController_deleteCreditNote"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/credit-notes/{id}/open": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Open a credit note */
put: operations["CreditNotesController_openCreditNote"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/credit-notes/validate-bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validates which credit notes can be deleted and returns the results. */
post: operations["CreditNotesController_validateBulkDeleteCreditNotes"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/credit-notes/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deletes multiple credit notes. */
post: operations["CreditNotesController_bulkDeleteCreditNotes"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/credit-notes/{creditNoteId}/refunds": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve the credit note graph. */
get: operations["CreditNoteRefundsController_getCreditNoteRefunds"];
put?: never;
/** Create a refund for the given credit note. */
post: operations["CreditNoteRefundsController_createRefundCreditNote"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/credit-notes/refunds/{refundCreditId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve a refund transaction for the given credit note. */
get: operations["CreditNoteRefundsController_getRefundCreditNoteTransaction"];
put?: never;
post?: never;
/** Delete a refund for the given credit note. */
delete: operations["CreditNoteRefundsController_deleteRefundCreditNote"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/credit-notes/{creditNoteId}/applied-invoices": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Applied credit note to invoices */
get: operations["CreditNotesApplyInvoiceController_appliedCreditNoteToInvoices"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/credit-notes/{creditNoteId}/apply-invoices": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get credit note associated invoices to apply */
get: operations["CreditNotesApplyInvoiceController_getCreditNoteAssociatedInvoicesToApply"];
put?: never;
/** Apply credit note to invoices */
post: operations["CreditNotesApplyInvoiceController_applyCreditNoteToInvoices"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/credit-notes/applied-invoices/{applyCreditToInvoicesId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Delete applied credit note to invoice */
delete: operations["CreditNotesApplyInvoiceController_deleteApplyCreditNoteToInvoices"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendor-credits/validate-bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Validates which vendor credits can be deleted and returns the results. */
post: operations["VendorCreditsController_validateBulkDeleteVendorCredits"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendor-credits/bulk-delete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Deletes multiple vendor credits. */
post: operations["VendorCreditsController_bulkDeleteVendorCredits"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendor-credits": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the vendor credits. */
get: operations["VendorCreditsController_getVendorCredits"];
put?: never;
/** Create a new vendor credit. */
post: operations["VendorCreditsController_createVendorCredit"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendor-credits/{id}/open": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Open the given vendor credit. */
put: operations["VendorCreditsController_openVendorCredit"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendor-credits/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the vendor credit details. */
get: operations["VendorCreditsController_getVendorCredit"];
/** Edit the given vendor credit. */
put: operations["VendorCreditsController_editVendorCredit"];
post?: never;
/** Delete the given vendor credit. */
delete: operations["VendorCreditsController_deleteVendorCredit"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendor-credits/{vendorCreditId}/bills-to-apply": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get bills that can be applied with this vendor credit. */
get: operations["VendorCreditApplyBillsController_getVendorCreditToApplyBills"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendor-credits/{vendorCreditId}/apply-to-bills": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Apply vendor credit to the given bills. */
post: operations["VendorCreditApplyBillsController_applyVendorCreditToBills"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendor-credits/applied-bills/{vendorCreditAppliedBillId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Remove an applied bill from the vendor credit. */
delete: operations["VendorCreditApplyBillsController_deleteAppliedBillToVendorCredit"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendor-credits/{vendorCreditId}/applied-bills": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get bills already applied to this vendor credit. */
get: operations["VendorCreditApplyBillsController_getAppliedBillsToVendorCredit"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/bill-payments": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the bill payments list. */
get: operations["BillPaymentsController_getBillPayments"];
put?: never;
/** Create a new bill payment. */
post: operations["BillPaymentsController_createBillPayment"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/bill-payments/{billPaymentId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the bill payment details. */
get: operations["BillPaymentsController_getBillPayment"];
/** Edit the given bill payment. */
put: operations["BillPaymentsController_editBillPayment"];
post?: never;
/** Delete the given bill payment. */
delete: operations["BillPaymentsController_deleteBillPayment"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/bill-payments/new-page/entries": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the payable entries of the new page once vendor be selected. */
get: operations["BillPaymentsController_getBillPaymentNewPageEntries"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/bill-payments/{billPaymentId}/bills": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the bills of the given bill payment. */
get: operations["BillPaymentsController_getPaymentBills"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/bill-payments/{billPaymentId}/edit-page": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the edit page of the given bill payment. */
get: operations["BillPaymentsController_getBillPaymentEditPage"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendor-credits/refunds/{refundCreditId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve a refund vendor credit transaction by id. */
get: operations["VendorCreditsRefundController_getRefundVendorCreditTransaction"];
put?: never;
post?: never;
/** Delete a refund for the given vendor credit. */
delete: operations["VendorCreditsRefundController_deleteRefundVendorCredit"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/vendor-credits/{vendorCreditId}/refund": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve the vendor credit refunds graph. */
get: operations["VendorCreditsRefundController_getVendorCreditRefunds"];
put?: never;
/** Create a refund for the given vendor credit. */
post: operations["VendorCreditsRefundController_createRefundVendorCredit"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/accounts": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve the bank accounts. */
get: operations["BankAccountsController_getBankAccounts"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/accounts/{bankAccountId}/summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve the bank account summary. */
get: operations["BankAccountsController_getBankAccountSummary"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/accounts/{id}/disconnect": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Disconnect the bank connection of the given bank account. */
post: operations["BankAccountsController_disconnectBankAccount"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/accounts/{id}/refresh": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Refresh the bank account transactions. */
post: operations["BankAccountsController_refreshBankAccount"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/accounts/{id}/pause": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Pause transactions syncing of the given bank account. */
post: operations["BankAccountsController_pauseBankAccount"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/accounts/{id}/resume": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Resume transactions syncing of the given bank account. */
post: operations["BankAccountsController_resumeBankAccount"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/plaid/link-token": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Get Plaid link token */
post: operations["BankingPlaidController_getLinkToken"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/plaid/exchange-token": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Exchange Plaid access token */
post: operations["BankingPlaidController_exchangeToken"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/plaid/webhooks": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Listen to Plaid webhooks */
post: operations["BankingPlaidWebhooksController_webhooks"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/categorize": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Categorize bank transactions. */
post: operations["BankingCategorizeController_categorizeTransaction"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/categorize/bulk": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Uncategorize bank transactions in bulk. */
delete: operations["BankingCategorizeController_uncategorizeTransactionsBulk"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/categorize/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Uncategorize a bank transaction. */
delete: operations["BankingCategorizeController_uncategorizeTransaction"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/transactions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get bank account transactions */
get: operations["BankingTransactionsController_getBankAccountTransactions"];
put?: never;
/** Create a new bank transaction */
post: operations["BankingTransactionsController_createTransaction"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/transactions/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a specific bank transaction by ID */
get: operations["BankingTransactionsController_getTransaction"];
put?: never;
post?: never;
/** Delete a bank transaction */
delete: operations["BankingTransactionsController_deleteTransaction"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/uncategorized/autofill": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get autofill values for categorize transactions */
get: operations["BankingUncategorizedTransactionsController_getAutofillCategorizeTransaction"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/uncategorized/accounts/{accountId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get uncategorized transactions for a specific bank account */
get: operations["BankingUncategorizedTransactionsController_getBankAccountUncategorizedTransactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/uncategorized/{uncategorizedTransactionId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a specific uncategorized transaction by ID */
get: operations["BankingUncategorizedTransactionsController_getUncategorizedTransaction"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/pending": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get pending bank account transactions */
get: operations["BankingPendingTransactionsController_getPendingTransactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/rules": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the bank rules. */
get: operations["BankRulesController_getBankRules"];
put?: never;
/** Create a new bank rule. */
post: operations["BankRulesController_createBankRule"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/rules/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the bank rule details. */
get: operations["BankRulesController_getBankRule"];
/** Edit the given bank rule. */
put: operations["BankRulesController_editBankRule"];
post?: never;
/** Delete the given bank rule. */
delete: operations["BankRulesController_deleteBankRule"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/recognized/{recognizedTransactionId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get recognized transaction */
get: operations["BankingRecognizedTransactionsController_getRecognizedTransaction"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/recognized": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a list of recognized transactions */
get: operations["BankingRecognizedTransactionsController_getRecognizedTransactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/exclude/bulk": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Exclude the given bank transactions. */
put: operations["BankingTransactionsExcludeController_excludeBankTransactions"];
post?: never;
/** Unexclude the given bank transactions. */
delete: operations["BankingTransactionsExcludeController_unexcludeBankTransactions"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/exclude": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the excluded bank transactions. */
get: operations["BankingTransactionsExcludeController_getExcludedBankTransactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/exclude/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Exclude the given bank transaction. */
put: operations["BankingTransactionsExcludeController_excludeBankTransaction"];
post?: never;
/** Unexclude the given bank transaction. */
delete: operations["BankingTransactionsExcludeController_unexcludeBankTransaction"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/matching/matched": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the matched transactions. */
get: operations["BankingMatchingController_getMatchedTransactions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/matching/match": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Match the given uncategorized transaction. */
post: operations["BankingMatchingController_matchTransaction"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/banking/matching/unmatch/{uncategorizedTransactionId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Unmatch the given uncategorized transaction. */
patch: operations["BankingMatchingController_unmatchMatchedTransaction"];
trace?: never;
};
"/api/transactions-locking/lock": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Lock all transactions for a module or all modules */
put: operations["TransactionsLockingController_commandTransactionsLocking"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/transactions-locking/cancel-lock": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Cancel all transactions locking for a module or all modules */
put: operations["TransactionsLockingController_cancelTransactionLocking"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/transactions-locking/unlock-partial": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Partial unlock all transactions locking for a module or all modules */
put: operations["TransactionsLockingController_unlockTransactionsLockingBetweenPeriod"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/transactions-locking/cancel-unlock-partial": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Cancel partial unlocking all transactions locking for a module or all modules */
put: operations["TransactionsLockingController_cancelPartialUnlocking"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/transactions-locking": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get all transactions locking meta */
get: operations["TransactionsLockingController_getTransactionLockingMetaList"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/transactions-locking/{module}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get transactions locking meta for a module */
get: operations["TransactionsLockingController_getTransactionLockingMeta"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/settings": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the settings. */
get: operations["SettingsController_getSettings"];
/** Save the given settings. */
put: operations["SettingsController_saveSettings"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/balance-sheet": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get balance sheet statement */
get: operations["BalanceSheetStatementController_balanceSheet"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/purchases-by-items": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get purchases by items report */
get: operations["PurchasesByItemReportController_purchasesByItems"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/customer-balance-summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get customer balance summary report */
get: operations["CustomerBalanceSummaryController_customerBalanceSummary"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/vendor-balance-summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get vendor balance summary */
get: operations["VendorBalanceSummaryController_vendorBalanceSummary"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/sales-by-items": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Sales by items report
* @description Retrieves the sales by items report.
*/
get: operations["SalesByItemsController_salesByitems"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/general-ledger": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get general ledger report */
get: operations["GeneralLedgerController_getGeneralLedger"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/trial-balance-sheet": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get trial balance sheet */
get: operations["TrialBalanceSheetController_getTrialBalanceSheet"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/transactions-by-vendors": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get transactions by vendor */
get: operations["TransactionsByVendorController_transactionsByVendor"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/transactions-by-customers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get transactions by customer */
get: operations["TransactionsByCustomerController_transactionsByCustomer"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/transactions-by-reference": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get transactions by reference */
get: operations["TransactionsByReferenceController_getTransactionsByReference"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/receivable-aging-summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get receivable aging summary */
get: operations["ARAgingSummaryController_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/payable-aging-summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get payable aging summary */
get: operations["APAgingSummaryController_get"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/inventory-item-details": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get inventory item details */
get: operations["InventoryItemDetailsController_inventoryItemDetails"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/inventory-valuation": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves the inventory valuation sheet */
get: operations["InventoryValuationController_getInventoryValuationSheet"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/sales-tax-liability-summary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get sales tax liability summary report */
get: operations["SalesTaxLiabilitySummaryController_getSalesTaxLiabilitySummary"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/journal": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Journal report */
get: operations["JournalSheetController_journalSheet"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/profit-loss-sheet": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get profit/loss statement report */
get: operations["ProfitLossSheetController_profitLossSheet"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/reports/cashflow-statement": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get cashflow statement report */
get: operations["CashflowController_getCashflow"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/dashboard/boot": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get dashboard boot metadata */
get: operations["DashboardController_getBootMeta"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/roles": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get all roles */
get: operations["RolesController_getRoles"];
put?: never;
/** Create a new role */
post: operations["RolesController_createRole"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/roles/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a specific role by ID */
get: operations["RolesController_getRole"];
/** Edit an existing role */
put: operations["RolesController_editRole"];
post?: never;
/** Delete a role */
delete: operations["RolesController_deleteRole"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/roles/permissions/schema": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get role permissions schema */
get: operations["RolesController_getRolePermissionsSchema"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/subscription": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get all subscriptions for the current tenant */
get: operations["SubscriptionsController_getSubscriptions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/subscription/lemon/checkout_url": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Get LemonSqueezy checkout URL */
post: operations["SubscriptionsController_getCheckoutUrl"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/subscription/cancel": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Cancel the current organization subscription */
post: operations["SubscriptionsController_cancelSubscription"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/subscription/resume": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Resume the current organization subscription */
post: operations["SubscriptionsController_resumeSubscription"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/subscription/change": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Change the subscription plan of the current organization */
post: operations["SubscriptionsController_changeSubscriptionPlan"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/webhooks/lemon": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["SubscriptionsLemonWebhook_lemonWebhooks"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/organization/build": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Build organization database */
post: operations["OrganizationController_build"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/organization/build/{buildJobId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Gets the organization build job details */
get: operations["OrganizationController_buildJob"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/organization/current": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get current organization */
get: operations["OrganizationController_currentOrganization"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/organization/base-currency-mutate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["OrganizationController_baseCurrencyMutate"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/organization": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Update organization information */
put: operations["OrganizationController_updateOrganization"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payment-services": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["PaymentServicesController_getPaymentServicesSpecificInvoice"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payment-services/state": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["PaymentServicesController_getPaymentMethodsState"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payment-services/{paymentServiceId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["PaymentServicesController_getPaymentService"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/payment-services/{paymentMethodId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["PaymentServicesController_updatePaymentMethod"];
delete: operations["PaymentServicesController_deletePaymentMethod"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/export": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves exported the given resource. */
get: operations["ExportController_export"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/views/resource/{resourceModel}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get the given resource views */
get: operations["ViewsController_getResourceViews"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/currencies": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get all currencies */
get: operations["CurrenciesController_findAll"];
put?: never;
/** Create a new currency */
post: operations["CurrenciesController_create"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/currencies/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Edit an existing currency */
put: operations["CurrenciesController_edit"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/currencies/{code}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Delete a currency by code */
delete: operations["CurrenciesController_delete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/currencies/{currencyCode}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a currency by code */
get: operations["CurrenciesController_findOne"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/date-formats": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["MiscellaneousController_getDateFormats"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/users/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve user details of the given user id. */
get: operations["UsersController_getUser"];
/** Edit details of the given user. */
put: operations["UsersController_editUser"];
post?: never;
/** Soft deleting the given user. */
delete: operations["UsersController_deleteUser"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieve the list of users. */
get: operations["UsersController_listUsers"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/users/{id}/activate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Activate the given user. */
put: operations["UsersController_activateUser"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/users/{id}/inactivate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Inactivate the given user. */
put: operations["UsersController_inactivateUser"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/invite": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Send an invitation to a new user. */
patch: operations["UsersInviteController_sendInvite"];
trace?: never;
};
"/api/invite/users/{id}/resend": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Resend an invitation to an existing user. */
post: operations["UsersInviteController_resendInvite"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/invite/accept/{token}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Accept a user invitation. */
post: operations["UsersInvitePublicController_acceptInvite"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/invite/check/{token}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Check if an invitation token is valid. */
get: operations["UsersInvitePublicController_checkInvite"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/contacts/auto-complete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get the auto-complete contacts */
get: operations["ContactsController_getAutoComplete"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/contacts/{id}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get contact by ID (customer or vendor) */
get: operations["ContactsController_getContact"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/api/contacts/{id}/activate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Activate a contact */
patch: operations["ContactsController_activateContact"];
trace?: never;
};
"/api/contacts/{id}/inactivate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Inactivate a contact */
patch: operations["ContactsController_inactivateContact"];
trace?: never;
};
"/api/exchange-rates/latest": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get the latest exchange rate */
get: operations["ExchangeRatesController_getLatestExchangeRate"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
AuthSigninResponseDto: {
/** @description JWT access token */
accessToken: string;
/** @description Organization ID */
organizationId: string;
/** @description Tenant ID */
tenantId: number;
/** @description User ID */
userId: number;
};
AuthMetaResponseDto: {
/** @description Whether signup is disabled */
signupDisabled: boolean;
};
AuthSigninDto: {
/**
* @description User password
* @example password123
*/
password: string;
/**
* @description User email address
* @example user@example.com
*/
email: string;
};
AuthSignupDto: {
/**
* @description User first name
* @example John
*/
firstName: string;
/**
* @description User last name
* @example Doe
*/
lastName: string;
/**
* @description User email address
* @example john.doe@example.com
*/
email: string;
/**
* @description User password
* @example password123
*/
password: string;
};
AuthSignupVerifyDto: {
/**
* @description User email address
* @example user@example.com
*/
email: string;
/**
* @description Signup confirmation token from email
* @example confirmation-token
*/
token: string;
};
AuthSendResetPasswordDto: {
/**
* @description User email address to send reset link to
* @example user@example.com
*/
email: string;
};
AuthResetPasswordDto: {
/**
* @description New password
* @example new-password
*/
password: string;
};
ApiKeyResponseDto: {
/**
* @description API key ID
* @example 1
*/
id: number;
/**
* @description The API key string
* @example bc_1234567890abcdef
*/
key: string;
};
ApiKeyRevokeResponseDto: {
/**
* @description API key ID
* @example 1
*/
id: number;
/**
* @description Whether the API key was revoked
* @example true
*/
revoked: boolean;
};
ApiKeyListItemDto: {
/**
* @description API key ID
* @example 1
*/
id: number;
/**
* @description API key name
* @example My API Key
*/
name: string;
/**
* @description First 8 characters of the API key token
* @example bc_1234...
*/
token: string;
/**
* Format: date-time
* @description Creation date
* @example 2024-01-01T00:00:00.000Z
*/
createdAt: string;
/**
* Format: date-time
* @description Expiration date
* @example 2024-12-31T23:59:59.000Z
*/
expiresAt?: string;
/**
* @description Whether the key is revoked
* @example false
*/
revoked: boolean;
};
ApiKeyListResponseDto: {
data: components["schemas"]["ApiKeyListItemDto"][];
};
GenerateApiKeyDto: {
/**
* @description Optional name for the API key
* @example My API Key
*/
name?: string;
};
ItemErrorResponseDto: {
/**
* @description HTTP status code
* @example 400
*/
statusCode: number;
/**
* @description Error type identifier
* @example ITEM_NAME_EXISTS
* @enum {string}
*/
type: "ITEM_NAME_EXISTS" | "ITEM_CATEOGRY_NOT_FOUND" | "COST_ACCOUNT_NOT_COGS" | "COST_ACCOUNT_NOT_FOUMD" | "SELL_ACCOUNT_NOT_FOUND" | "SELL_ACCOUNT_NOT_INCOME" | "INVENTORY_ACCOUNT_NOT_FOUND" | "INVENTORY_ACCOUNT_NOT_INVENTORY" | "ITEMS_HAVE_ASSOCIATED_TRANSACTIONS" | "ITEM_HAS_ASSOCIATED_TRANSACTINS" | "ITEM_HAS_ASSOCIATED_INVENTORY_ADJUSTMENT" | "ITEM_CANNOT_CHANGE_INVENTORY_TYPE" | "TYPE_CANNOT_CHANGE_WITH_ITEM_HAS_TRANSACTIONS" | "INVENTORY_ACCOUNT_CANNOT_MODIFIED" | "PURCHASE_TAX_RATE_NOT_FOUND" | "SELL_TAX_RATE_NOT_FOUND" | "INCOME_ACCOUNT_REQUIRED_WITH_SELLABLE_ITEM" | "COST_ACCOUNT_REQUIRED_WITH_PURCHASABLE_ITEM" | "NOT_FOUND" | "ITEMS_NOT_FOUND";
/**
* @description Human-readable error message
* @example The item name is already exist.
*/
message?: string | null;
/** @description Additional error payload data */
payload?: Record<string, never> | null;
};
ItemApiErrorResponseDto: {
/** @description Array of error details */
errors: components["schemas"]["ItemErrorResponseDto"][];
};
ValidateBulkDeleteItemsResponseDto: {
/**
* @description Number of items that can be deleted
* @example 2
*/
deletableCount: number;
/**
* @description Number of items that cannot be deleted
* @example 1
*/
nonDeletableCount: number;
/**
* @description IDs of items that can be deleted
* @example [
* 1,
* 2
* ]
*/
deletableIds: number[];
/**
* @description IDs of items that cannot be deleted
* @example [
* 3
* ]
*/
nonDeletableIds: number[];
};
ItemReceiptsResponseDto: {
/**
* @description The unique identifier of the receipt.
* @example 123
*/
receiptId: number;
/**
* @description The receipt number.
* @example RCPT-2024-001
*/
receipNumber: string;
/**
* @description The reference number for the receipt.
* @example REF-2024-001
*/
referenceNumber: string;
/**
* @description The date of the receipt.
* @example 2024-06-01
*/
receiptDate: string;
/**
* @description The formatted date of the receipt.
* @example 01/06/2024
*/
formattedReceiptDate: string;
/**
* @description The amount for the receipt.
* @example 1000
*/
amount: number;
/**
* @description The formatted amount for the receipt.
* @example $1,000.00
*/
formattedAmount: string;
/**
* @description The quantity of items in the receipt.
* @example 10
*/
quantity: number;
/**
* @description The formatted quantity of items in the receipt.
* @example 10
*/
formattedQuantity: string;
/**
* @description The rate per item in the receipt.
* @example 100
*/
rate: number;
/**
* @description The formatted rate per item in the receipt.
* @example $100.00
*/
formattedRate: string;
/**
* @description The display name of the customer.
* @example John Doe
*/
customerDisplayName: string;
/**
* @description The currency code of the customer.
* @example USD
*/
customerCurrencyCode: string;
};
ItemEstimatesResponseDto: {
/**
* @description The unique identifier of the estimate.
* @example 123
*/
estimateId: number;
/**
* @description The estimate number.
* @example EST-2024-001
*/
estimateNumber: string;
/**
* @description The reference number for the estimate.
* @example REF-2024-001
*/
referenceNumber: string;
/**
* @description The date of the estimate.
* @example 2024-06-01
*/
estimateDate: string;
/**
* @description The formatted estimate date.
* @example 01/06/2024
*/
formattedEstimateDate: string;
/**
* @description The amount of the estimate.
* @example 1000
*/
amount: number;
/**
* @description The formatted amount of the estimate.
* @example $1,000.00
*/
formattedAmount: string;
/**
* @description The quantity in the estimate.
* @example 5
*/
quantity: number;
/**
* @description The formatted quantity in the estimate.
* @example 5
*/
formattedQuantity: string;
/**
* @description The rate in the estimate.
* @example 200
*/
rate: number;
/**
* @description The formatted rate in the estimate.
* @example $200.00
*/
formattedRate: string;
/**
* @description The display name of the customer.
* @example Acme Corp
*/
customerDisplayName: string;
/**
* @description The currency code of the customer.
* @example USD
*/
customerCurrencyCode: string;
};
ItemBillsResponseDto: {
/**
* @description The unique identifier of the bill.
* @example 123
*/
billId: number;
/**
* @description The bill number.
* @example BILL-2024-001
*/
billNumber: string;
/**
* @description The reference number of the bill.
* @example REF-2024-001
*/
referenceNumber: string;
/**
* @description The date of the bill.
* @example 2024-06-01
*/
billDate: string;
/**
* @description The formatted date of the bill.
* @example 01/06/2024
*/
formattedBillDate: string;
/**
* @description The due date of the bill.
* @example 2024-06-15
*/
billDueDate: string;
/**
* @description The formatted due date of the bill.
* @example 15/06/2024
*/
formattedBillDueDate: string;
/**
* @description The amount of the bill item.
* @example 1000
*/
amount: number;
/**
* @description The formatted amount of the bill item.
* @example $1,000.00
*/
formattedAmount: string;
/**
* @description The quantity of the item in the bill.
* @example 5
*/
quantity: number;
/**
* @description The formatted quantity of the item in the bill.
* @example 5
*/
formattedQuantity: string;
/**
* @description The rate of the item in the bill.
* @example 200
*/
rate: number;
/**
* @description The formatted rate of the item in the bill.
* @example $200.00
*/
formattedRate: string;
/**
* @description The display name of the vendor.
* @example Acme Vendor
*/
vendorDisplayName: string;
/**
* @description The currency code of the vendor.
* @example USD
*/
vendorCurrencyCode: string;
};
ItemInvoiceResponseDto: {
/**
* @description The unique identifier of the invoice.
* @example 123
*/
invoiceId: number;
/**
* @description The invoice number.
* @example INV-2024-001
*/
invoiceNumber: string;
/**
* @description The reference number of the invoice.
* @example REF-2024-001
*/
referenceNumber: string;
/**
* @description The date of the invoice.
* @example 2024-06-01
*/
invoiceDate: string;
/**
* @description The formatted date of the invoice.
* @example 01/06/2024
*/
formattedInvoiceDate: string;
/**
* @description The amount of the invoice item.
* @example 1000
*/
amount: number;
/**
* @description The formatted amount of the invoice item.
* @example $1,000.00
*/
formattedAmount: string;
/**
* @description The quantity of the item in the invoice.
* @example 5
*/
quantity: number;
/**
* @description The formatted quantity of the item in the invoice.
* @example 5
*/
formattedQuantity: string;
/**
* @description The rate of the item in the invoice.
* @example 200
*/
rate: number;
/**
* @description The formatted rate of the item in the invoice.
* @example $200.00
*/
formattedRate: string;
/**
* @description The display name of the customer.
* @example Acme Corp
*/
customerDisplayName: string;
/**
* @description The currency code of the customer.
* @example USD
*/
customerCurrencyCode: string;
};
Pagination: {
/**
* @description Total number of items across all pages
* @example 100
*/
total: number;
/**
* @description Current page number (1-based)
* @example 1
*/
page: number;
/**
* @description Number of items per page
* @example 10
*/
pageSize: number;
};
PaginatedResponseDto: {
/** @description Pagination metadata */
pagination: components["schemas"]["Pagination"];
};
ItemResponseDto: {
/**
* @description The unique identifier of the item
* @example 1
*/
id: number;
/**
* @description The name of the item
* @example Ergonomic Office Chair Model X-2000
*/
name: string;
/**
* @description The type of the item
* @example inventory
* @enum {string}
*/
type: "service" | "non-inventory" | "inventory";
/**
* @description The formatted type of the item
* @example Inventory Item
*/
typeFormatted: string;
/**
* @description The item code/SKU
* @example CHAIR-X2000
*/
code?: string;
/**
* @description Whether the item can be sold
* @example true
*/
sellable: boolean;
/**
* @description Whether the item can be purchased
* @example true
*/
purchasable: boolean;
/**
* @description The selling price of the item
* @example 399.99
*/
sellPrice?: number;
/**
* @description The formatted selling price of the item
* @example $399.99
*/
sellPriceFormatted?: string;
/**
* @description The cost price of the item
* @example 299.99
*/
costPrice?: number;
/**
* @description The formatted cost price of the item
* @example $299.99
*/
costPriceFormatted?: string;
/**
* @description The currency code of the item
* @example USD
*/
currencyCode: string;
/**
* @description The ID of the cost account
* @example 1001
*/
costAccountId?: number;
/** @description The cost account details */
costAccount?: Record<string, never>;
/**
* @description The ID of the inventory account
* @example 3001
*/
inventoryAccountId?: number;
/** @description The inventory account details */
inventoryAccount?: Record<string, never>;
/**
* @description The ID of the sell account
* @example 2001
*/
sellAccountId?: number;
/** @description The sell account details */
sellAccount?: Record<string, never>;
/**
* @description The ID of the item category
* @example 5
*/
categoryId?: number;
/** @description The category details */
category?: Record<string, never>;
/**
* @description The description shown on sales documents
* @example Premium ergonomic office chair with adjustable height and lumbar support
*/
sellDescription?: string;
/**
* @description The description shown on purchase documents
* @example Ergonomic office chair - Model X-2000 with standard features
*/
purchaseDescription?: string;
/**
* @description The quantity of the item in stock (for inventory items)
* @example 50
*/
quantityOnHand?: number;
/**
* @description Additional notes about the item
* @example Available in black, gray, and navy colors. 5-year warranty included.
*/
note?: string;
/**
* @description Whether the item is active
* @example true
*/
active: boolean;
/**
* @description The ID of the tax rate applied to sales
* @example 1
*/
sellTaxRateId?: number;
/** @description The tax rate details for sales */
sellTaxRate?: Record<string, never>;
/**
* @description The ID of the tax rate applied to purchases
* @example 1
*/
purchaseTaxRateId?: number;
/** @description The tax rate details for purchases */
purchaseTaxRate?: Record<string, never>;
/** @description The warehouse quantities for the item */
itemWarehouses?: unknown[];
/**
* Format: date-time
* @description The date when the item was created
* @example 2024-03-20T10:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @description The date when the item was last updated
* @example 2024-03-20T10:00:00Z
*/
updatedAt: string;
};
EditItemDto: {
/**
* @description Item name
* @example Ergonomic Office Chair Model X-2000
*/
name: string;
/**
* @description Item type
* @example inventory
* @enum {string}
*/
type: "service" | "non-inventory" | "inventory";
/**
* @description Item code/SKU
* @example CHAIR-X2000
*/
code?: string;
/**
* @description Whether the item can be purchased
* @example true
*/
purchasable?: boolean;
/**
* @description Cost price of the item
* @example 299.99
*/
costPrice?: number;
/**
* @description ID of the cost account
* @example 1001
*/
costAccountId?: number;
/**
* @description Whether the item can be sold
* @example true
*/
sellable?: boolean;
/**
* @description Selling price of the item
* @example 399.99
*/
sellPrice?: number;
/**
* @description ID of the sell account
* @example 2001
*/
sellAccountId?: number;
/**
* @description ID of the inventory account (required for inventory items)
* @example 3001
*/
inventoryAccountId?: number;
/**
* @description Description shown on sales documents
* @example Premium ergonomic office chair with adjustable height, lumbar support, and breathable mesh back
*/
sellDescription?: string;
/**
* @description Description shown on purchase documents
* @example Ergonomic office chair - Model X-2000 with standard features
*/
purchaseDescription?: string;
/**
* @description ID of the tax rate applied to sales
* @example 1
*/
sellTaxRateId?: number;
/**
* @description ID of the tax rate applied to purchases
* @example 1
*/
purchaseTaxRateId?: number;
/**
* @description ID of the item category
* @example 5
*/
categoryId?: number;
/**
* @description Additional notes about the item
* @example Available in black, gray, and navy colors. 5-year warranty included.
*/
note?: string;
/**
* @description Whether the item is active
* @default true
* @example true
*/
active: boolean;
/**
* @description IDs of media files associated with the item
* @example [
* 1,
* 2,
* 3
* ]
*/
mediaIds?: number[];
};
BulkDeleteItemsDto: {
/**
* @description Array of item IDs to delete
* @example [
* 1,
* 2,
* 3
* ]
*/
ids: number[];
/**
* @description When true, undeletable items will be skipped and only deletable ones removed.
* @default false
*/
skipUndeletable: boolean;
};
CreateItemDto: {
/**
* @description Item name
* @example Ergonomic Office Chair Model X-2000
*/
name: string;
/**
* @description Item type
* @example inventory
* @enum {string}
*/
type: "service" | "non-inventory" | "inventory";
/**
* @description Item code/SKU
* @example CHAIR-X2000
*/
code?: string;
/**
* @description Whether the item can be purchased
* @example true
*/
purchasable?: boolean;
/**
* @description Cost price of the item
* @example 299.99
*/
costPrice?: number;
/**
* @description ID of the cost account
* @example 1001
*/
costAccountId?: number;
/**
* @description Whether the item can be sold
* @example true
*/
sellable?: boolean;
/**
* @description Selling price of the item
* @example 399.99
*/
sellPrice?: number;
/**
* @description ID of the sell account
* @example 2001
*/
sellAccountId?: number;
/**
* @description ID of the inventory account (required for inventory items)
* @example 3001
*/
inventoryAccountId?: number;
/**
* @description Description shown on sales documents
* @example Premium ergonomic office chair with adjustable height, lumbar support, and breathable mesh back
*/
sellDescription?: string;
/**
* @description Description shown on purchase documents
* @example Ergonomic office chair - Model X-2000 with standard features
*/
purchaseDescription?: string;
/**
* @description ID of the tax rate applied to sales
* @example 1
*/
sellTaxRateId?: number;
/**
* @description ID of the tax rate applied to purchases
* @example 1
*/
purchaseTaxRateId?: number;
/**
* @description ID of the item category
* @example 5
*/
categoryId?: number;
/**
* @description Additional notes about the item
* @example Available in black, gray, and navy colors. 5-year warranty included.
*/
note?: string;
/**
* @description Whether the item is active
* @default true
* @example true
*/
active: boolean;
/**
* @description IDs of media files associated with the item
* @example [
* 1,
* 2,
* 3
* ]
*/
mediaIds?: number[];
};
InventoryAdjustmentResponseDto: {
/**
* @description The unique identifier of the inventory adjustment
* @example 1
*/
id: number;
/**
* @description The date of the inventory adjustment
* @example 2024-03-20
*/
date: string;
/**
* @description The type of adjustment (increment or decrement)
* @example increment
* @enum {string}
*/
type: "increment" | "decrement";
/**
* @description The formatted type of adjustment
* @example inventory_adjustment.increment
*/
formattedType: string;
/**
* @description The ID of the adjustment account
* @example 100
*/
adjustmentAccountId: number;
/**
* @description The reason for the adjustment
* @example Stock count discrepancy
*/
reason: string;
/**
* @description The reference number for the adjustment
* @example IA-2024-001
*/
referenceNo: string;
/**
* @description Additional description of the adjustment
* @example Year-end inventory reconciliation
*/
description?: string;
/**
* @description The ID of the user who created the adjustment
* @example 1
*/
userId: number;
/**
* @description The date when the adjustment was published
* @example 2024-03-20T10:00:00Z
*/
publishedAt?: string;
/**
* @description The ID of the branch where the adjustment was made
* @example 1
*/
branchId: number;
/**
* @description The ID of the warehouse where the adjustment was made
* @example 1
*/
warehouseId: number;
/**
* @description The date when the adjustment was created
* @example 2024-03-20T09:00:00Z
*/
createdAt: string;
/** @description The entries associated with this adjustment */
entries: unknown[][];
};
InventoryAdjustmentsPaginationDto: {
/** @example 1 */
page: number;
/** @example 12 */
pageSize: number;
/** @example 42 */
total: number;
};
InventoryAdjustmentsListResponseDto: {
data: components["schemas"]["InventoryAdjustmentResponseDto"][];
pagination: components["schemas"]["InventoryAdjustmentsPaginationDto"];
};
CreateQuickInventoryAdjustmentDto: {
/**
* Format: date-time
* @description Date of the inventory adjustment
*/
date: string;
/**
* @description Type of adjustment
* @enum {string}
*/
type: "increment" | "decrement";
/** @description ID of the adjustment account */
adjustmentAccountId: number;
/** @description Reason for the adjustment */
reason: string;
/** @description Description of the adjustment */
description: string;
/** @description Reference number */
referenceNo: string;
/** @description ID of the item being adjusted */
itemId: number;
/** @description Quantity to adjust */
quantity: number;
/** @description Cost of the item */
cost: number;
/** @description Whether to publish the adjustment immediately */
publish: boolean;
/** @description ID of the warehouse (optional) */
warehouseId?: number;
/** @description ID of the branch (optional) */
branchId?: number;
};
BranchResponseDto: {
/**
* @description Branch ID
* @example 1
*/
id: number;
/**
* @description Branch name
* @example Main Branch
*/
name: string;
/**
* @description Branch code
* @example BR001
*/
code: string;
/**
* @description Branch address
* @example 123 Main Street
*/
address: string;
/**
* @description Branch city
* @example New York
*/
city: string;
/**
* @description Branch country
* @example USA
*/
country: string;
/**
* @description Branch phone number
* @example +1-555-123-4567
*/
phoneNumber: string;
/**
* @description Branch email
* @example branch@example.com
*/
email: string;
/**
* @description Branch website
* @example https://www.example.com/branch
*/
website: string;
/**
* @description Whether this is the primary branch
* @example true
*/
primary: boolean;
/**
* Format: date-time
* @description Creation timestamp
* @example 2024-03-20T10:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @description Last update timestamp
* @example 2024-03-20T10:00:00Z
*/
updatedAt: string;
};
CreateBranchDto: {
/**
* @description Branch name
* @example Main Branch
*/
name: string;
/**
* @description Whether this is the primary branch
* @default false
* @example true
*/
primary: boolean;
/**
* @description Branch code
* @example BR001
*/
code?: string;
/**
* @description Branch address
* @example 123 Main Street
*/
address?: string;
/**
* @description Branch city
* @example New York
*/
city?: string;
/**
* @description Branch country
* @example USA
*/
country?: string;
/**
* @description Branch phone number
* @example +1-555-123-4567
*/
phone_number?: string;
/**
* @description Branch email
* @example branch@example.com
*/
email?: string;
/**
* @description Branch website
* @example https://www.example.com/branch
*/
website?: string;
};
EditBranchDto: {
/**
* @description Branch name
* @example Main Branch
*/
name: string;
/**
* @description Whether this is the primary branch
* @default false
* @example true
*/
primary: boolean;
/**
* @description Branch code
* @example BR001
*/
code?: string;
/**
* @description Branch address
* @example 123 Main Street
*/
address?: string;
/**
* @description Branch city
* @example New York
*/
city?: string;
/**
* @description Branch country
* @example USA
*/
country?: string;
/**
* @description Branch phone number
* @example +1-555-123-4567
*/
phone_number?: string;
/**
* @description Branch email
* @example branch@example.com
*/
email?: string;
/**
* @description Branch website
* @example https://www.example.com/branch
*/
website?: string;
};
WarehouseResponseDto: {
/**
* @description The name of the warehouse
* @example Main Warehouse
*/
name: string;
/**
* @description The unique code identifier for the warehouse
* @example WH-001
*/
code: string;
/**
* @description The city where the warehouse is located
* @example New York
*/
city: string;
/**
* @description The country where the warehouse is located
* @example United States
*/
country: string;
/**
* @description The full address of the warehouse
* @example 123 Warehouse Street, New York, NY 10001
*/
address: string;
/**
* @description Indicates if this is the primary warehouse
* @example true
*/
primary: boolean;
};
CreateWarehouseDto: {
/** @description The name of the warehouse */
name: string;
/** @description Whether the warehouse is primary */
primary: boolean;
/** @description The code of the warehouse */
code: string;
/** @description The address of the warehouse */
address: string;
/** @description The city of the warehouse */
city: string;
/** @description The country of the warehouse */
country: string;
/** @description The phone number of the warehouse */
phoneNumber: string;
/** @description The email of the warehouse */
email: string;
/** @description The website of the warehouse */
website: string;
};
EditWarehouseDto: {
/** @description The name of the warehouse */
name: string;
/** @description Whether the warehouse is primary */
primary: boolean;
/** @description The code of the warehouse */
code: string;
/** @description The address of the warehouse */
address: string;
/** @description The city of the warehouse */
city: string;
/** @description The country of the warehouse */
country: string;
/** @description The phone number of the warehouse */
phoneNumber: string;
/** @description The email of the warehouse */
email: string;
/** @description The website of the warehouse */
website: string;
};
ValidateBulkDeleteResponseDto: {
/**
* @description Number of items that can be deleted
* @example 2
*/
deletableCount: number;
/**
* @description Number of items that cannot be deleted
* @example 1
*/
nonDeletableCount: number;
/**
* @description IDs of items that can be deleted
* @example [
* 1,
* 2
* ]
*/
deletableIds: number[];
/**
* @description IDs of items that cannot be deleted
* @example [
* 3
* ]
*/
nonDeletableIds: number[];
};
GetAccountTransactionResponseDto: {
/**
* @description The transaction date (ISO string or Date)
* @example 2024-01-01
*/
date: Record<string, never>;
/**
* @description The formatted transaction date
* @example 01 Jan 2024
*/
formattedDate: string;
/**
* @description The transaction type (referenceType from model)
* @example INVOICE
*/
transactionType: string;
/**
* @description The transaction id (referenceId from model)
* @example 123
*/
transactionId: number;
/**
* @description The formatted transaction type (translated string)
* @example Invoice
*/
transactionTypeFormatted: string;
/**
* @description The credit amount
* @example 100
*/
credit: number;
/**
* @description The debit amount
* @example 50
*/
debit: number;
/**
* @description The formatted credit amount (e.g. currency formatted)
* @example 100.00 USD
*/
formattedCredit: string;
/**
* @description The formatted debit amount (e.g. currency formatted)
* @example 50.00 USD
*/
formattedDebit: string;
/**
* @description The foreign currency credit (credit * exchangeRate)
* @example 120
*/
fcCredit: number;
/**
* @description The foreign currency debit (debit * exchangeRate)
* @example 60
*/
fcDebit: number;
/**
* @description The formatted foreign currency credit
* @example 120.00 EUR
*/
formattedFcCredit: string;
/**
* @description The formatted foreign currency debit
* @example 60.00 EUR
*/
formattedFcDebit: string;
};
AccountTypeResponseDto: {
/**
* @description The display label for the account type
* @example Cash
*/
label: string;
/**
* @description The unique key for the account type
* @example cash
*/
key: string;
/**
* @description The normal balance type for the account
* @example debit
*/
normal: string;
/**
* @description The parent type of the account
* @example current-asset
*/
parentType: string;
/**
* @description The root type of the account
* @example asset
*/
rootType: string;
/**
* @description Whether the account type supports multiple currencies
* @example true
*/
multiCurrency: boolean;
/**
* @description Whether the account type appears on the balance sheet
* @example true
*/
balanceSheet: boolean;
/**
* @description Whether the account type appears on the income sheet
* @example false
*/
incomeSheet: boolean;
};
AccountResponseDto: {
/**
* @description The unique identifier of the account
* @example 1
*/
id: number;
/**
* @description The name of the account
* @example Cash Account
*/
name: string;
/**
* @description The slug of the account
* @example cash-account
*/
slug: string;
/**
* @description The code of the account
* @example 1001
*/
code: string;
/**
* @description The index of the account
* @example 1
*/
index: number;
/**
* @description The type of the account
* @example bank
*/
accountType: string;
/**
* @description The formatted account type label
* @example Bank Account
*/
accountTypeLabel: string;
/**
* @description The parent account ID
* @example null
*/
parentAccountId: number;
/**
* @description Whether the account is predefined
* @example false
*/
predefined: boolean;
/**
* @description The currency code of the account
* @example USD
*/
currencyCode: string;
/**
* @description Whether the account is active
* @example true
*/
active: boolean;
/**
* @description The bank balance of the account
* @example 5000
*/
bankBalance: number;
/**
* @description The formatted bank balance
* @example $5,000.00
*/
bankBalanceFormatted: string;
/**
* @description The last feeds update timestamp
* @example 2024-03-20T10:30:00Z
*/
lastFeedsUpdatedAt: Record<string, never>;
/**
* @description The formatted last feeds update timestamp
* @example Mar 20, 2024 10:30 AM
*/
lastFeedsUpdatedAtFormatted: string;
/**
* @description The amount of the account
* @example 5000
*/
amount: number;
/**
* @description The formatted amount
* @example $5,000.00
*/
formattedAmount: string;
/**
* @description The Plaid item ID
* @example plaid-item-123
*/
plaidItemId: string;
/**
* @description The Plaid account ID
* @example plaid-account-456
*/
plaidAccountId: string;
/**
* @description Whether the feeds are active
* @example true
*/
isFeedsActive: boolean;
/**
* @description Whether the account is syncing owner
* @example true
*/
isSyncingOwner: boolean;
/**
* @description Whether the feeds are paused
* @example false
*/
isFeedsPaused: boolean;
/**
* @description The account normal
* @example debit
*/
accountNormal: string;
/**
* @description The formatted account normal
* @example Debit
*/
accountNormalFormatted: string;
/**
* @description The flatten name with all dependant accounts names
* @example Assets: Cash Account
*/
flattenName: string;
/**
* @description The account level in the hierarchy
* @example 2
*/
accountLevel: number;
/**
* Format: date-time
* @description The creation timestamp
* @example 2024-03-20T10:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @description The update timestamp
* @example 2024-03-20T10:30:00Z
*/
updatedAt: string;
};
BulkDeleteDto: {
/**
* @description Array of IDs to delete
* @example [
* 1,
* 2,
* 3
* ]
*/
ids: number[];
/**
* @description When true, undeletable items will be skipped and only deletable ones will be removed.
* @default false
*/
skipUndeletable: boolean;
};
CreateAccountDTO: {
/**
* @description Account name
* @example Cash Account
*/
name: string;
/**
* @description Account code
* @example CA001
*/
code?: string;
/**
* @description Currency code for the account
* @example USD
*/
currencyCode?: string;
/**
* @description Type of account
* @example asset
*/
accountType: string;
/**
* @description Account description
* @example Main cash account for daily operations
*/
description?: string;
/**
* @description ID of the parent account
* @example 1
*/
parentAccountId?: number;
/**
* @description Whether the account is active
* @default true
* @example true
*/
active: boolean;
/**
* @description Plaid account ID for syncing
* @example plaid_account_123456
*/
plaidAccountId?: string;
/**
* @description Plaid item ID for syncing
* @example plaid_item_123456
*/
plaidItemId?: string;
};
EditAccountDTO: {
/**
* @description The name of the account
* @example Bank Account
*/
name: string;
/**
* @description The code of the account
* @example 123456
*/
code: string;
/**
* @description The type of the account
* @example Bank Account
*/
accountType: string;
/**
* @description The description of the account
* @example This is a description
*/
description: string;
/**
* @description The parent account ID of the account
* @example 1
*/
parentAccountId: number;
};
InventoryItemCostDto: {
/** @description Item ID */
itemId: number;
/** @description Valuation */
valuation: number;
/** @description Quantity */
quantity: number;
/** @description Average cost */
average: number;
};
GetInventoryItemsCostResponseDto: {
/** @description List of item costs */
costs: components["schemas"]["InventoryItemCostDto"][];
};
GenerateSaleInvoiceSharableLinkResponseDto: {
/**
* @description Sharable payment link for the sale invoice
* @example http://localhost:3000/payment/123e4567-e89b-12d3-a456-426614174000
*/
link: string;
};
SaleInvoiceStateResponseDto: {
/**
* @description The ID of the default PDF template for sale invoices
* @example 1
*/
defaultTemplateId: number | null;
};
ItemEntryDto: {
/**
* @description The index of the item entry
* @example 1
*/
index: number;
/**
* @description The id of the item
* @example 1
*/
itemId: number;
/**
* @description The rate of the item entry
* @example 1
*/
rate: number;
/**
* @description The quantity of the item entry
* @example 1
*/
quantity: number;
/**
* @description The discount of the item entry
* @example 1
*/
discount: number;
/**
* @description The type of the discount
* @example percentage
*/
discountType: string;
/**
* @description The description of the item entry
* @example This is a description
*/
description: string;
/**
* @description The tax code of the item entry
* @example 123456
*/
taxCode: string;
/**
* @description The tax rate id of the item entry
* @example 1
*/
taxRateId: number;
/**
* @description The warehouse id of the item entry
* @example 1
*/
warehouseId: number;
/**
* @description The project id of the item entry
* @example 1
*/
projectId: number;
/**
* @description The project ref id of the item entry
* @example 1
*/
projectRefId: number;
/**
* @description The project ref type of the item entry
* @example TASK
*/
projectRefType: string;
/**
* @description The project ref invoiced amount of the item entry
* @example 100
*/
projectRefInvoicedAmount: number;
/**
* @description The sell account id of the item entry
* @example 1020
*/
sellAccountId: number;
/**
* @description The cost account id of the item entry
* @example 1021
*/
costAccountId: number;
};
AttachmentLinkDto: Record<string, never>;
PaymentMethodDto: {
/**
* @description The ID of the payment integration
* @example 1
*/
paymentIntegrationId: number;
/**
* @description Whether the payment method is enabled
* @example true
*/
enable: boolean;
};
SaleInvoiceResponseDto: {
/**
* @description The unique identifier of the sale invoice
* @example 1
*/
id: number;
/**
* Format: date-time
* @description The date of the invoice
* @example 2023-01-01T00:00:00Z
*/
invoiceDate: string;
/**
* Format: date-time
* @description The due date of the invoice
* @example 2023-01-15T00:00:00Z
*/
dueDate: string;
/**
* @description The invoice number
* @example INV-001
*/
invoiceNo: string;
/**
* @description The reference number
* @example REF-001
*/
referenceNo?: string;
/**
* @description The ID of the customer
* @example 1
*/
customerId: number;
/**
* @description The exchange rate for currency conversion
* @example 1
*/
exchangeRate?: number;
/**
* @description The currency code
* @example USD
*/
currencyCode?: string;
/**
* @description Custom message on the invoice
* @example Thank you for your business
*/
invoiceMessage?: string;
/**
* @description Terms and conditions of the invoice
* @example Payment due within 14 days
*/
termsConditions?: string;
/**
* @description Whether tax is inclusive in the item rates
* @example false
*/
isInclusiveTax?: boolean;
/** @description The line items of the invoice */
entries: components["schemas"]["ItemEntryDto"][];
/**
* @description Whether the invoice has been delivered
* @example false
*/
delivered: boolean;
/**
* Format: date-time
* @description The date when the invoice was delivered
* @example 2023-01-02T00:00:00Z
*/
deliveredAt?: string;
/**
* @description The ID of the warehouse
* @example 1
*/
warehouseId?: number;
/**
* @description The ID of the branch
* @example 1
*/
branchId?: number;
/**
* @description The ID of the project
* @example 1
*/
projectId?: number;
/** @description The attachments of the invoice */
attachments?: components["schemas"]["AttachmentLinkDto"][];
/** @description The payment methods associated with the invoice */
paymentMethods?: components["schemas"]["PaymentMethodDto"][];
/**
* @description The discount value
* @example 10
*/
discount?: number;
/**
* @description The type of discount (percentage or fixed)
* @example percentage
* @enum {string}
*/
discountType?: "percentage" | "amount";
/**
* @description The adjustment amount
* @example 5
*/
adjustment?: number;
/**
* @description The ID of the PDF template
* @example 1
*/
pdfTemplateId?: number;
/**
* @description The total amount of tax withheld
* @example 50
*/
taxAmountWithheld?: number;
/**
* @description The balance of the invoice
* @example 1000
*/
balance: number;
/**
* @description The amount paid
* @example 500
*/
paymentAmount: number;
/**
* @description The amount credited
* @example 0
*/
creditedAmount?: number;
/**
* @description The subtotal amount before tax and adjustments
* @example 900
*/
subtotal: number;
/**
* @description The total amount including tax and adjustments
* @example 1000
*/
total: number;
/**
* @description The due amount remaining to be paid
* @example 500
*/
dueAmount: number;
/**
* @description Whether the invoice is overdue
* @example false
*/
isOverdue: boolean;
/**
* @description Whether the invoice is partially paid
* @example true
*/
isPartiallyPaid: boolean;
/**
* @description Whether the invoice is fully paid
* @example false
*/
isFullyPaid: boolean;
/**
* Format: date-time
* @description The date when the invoice was created
* @example 2023-01-01T00:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @description The date when the invoice was last updated
* @example 2023-01-02T00:00:00Z
*/
updatedAt?: string;
};
CreateSaleInvoiceDto: {
/**
* @description Customer ID
* @example 1
*/
customerId: number;
/**
* Format: date-time
* @description Invoice date
* @example 2023-01-01T00:00:00Z
*/
invoiceDate: string;
/**
* Format: date-time
* @description Due date
* @example 2023-01-15T00:00:00Z
*/
dueDate: string;
/**
* @description Invoice number
* @example INV-001
*/
invoiceNo?: string;
/**
* @description Reference number
* @example REF-001
*/
referenceNo?: string;
/**
* @description Whether the invoice is delivered
* @default false
*/
delivered: boolean;
/**
* @description Invoice message
* @example Thank you for your business
*/
invoiceMessage?: string;
/**
* @description Terms and conditions
* @example Payment due within 14 days
*/
termsConditions?: string;
/**
* @description Exchange rate
* @example 1
*/
exchangeRate?: number;
/**
* @description Warehouse ID
* @example 1
*/
warehouseId?: number;
/**
* @description Branch ID
* @example 1
*/
branchId?: number;
/**
* @description Project ID
* @example 1
*/
projectId?: number;
/**
* @description Whether tax is inclusive
* @example false
*/
isInclusiveTax?: boolean;
/** @description Invoice line items */
entries: components["schemas"]["ItemEntryDto"][];
/**
* @description PDF template ID
* @example 1
*/
pdfTemplateId?: number;
/** @description Payment methods */
paymentMethods?: components["schemas"]["PaymentMethodDto"][];
/**
* @description Discount value
* @example 10
*/
discount?: number;
/**
* @description Discount type
* @example percentage
* @enum {string}
*/
discountType?: "percentage" | "amount";
/**
* @description Adjustment amount
* @example 5
*/
adjustment?: number;
/**
* @description ID of the estimate this invoice is created from
* @example 1
*/
fromEstimateId?: number;
/**
* @description The attachments of the sale receipt
* @example [
* {
* "key": "123456"
* }
* ]
*/
attachments: string[];
};
EditSaleInvoiceDto: {
/**
* @description Customer ID
* @example 1
*/
customerId: number;
/**
* Format: date-time
* @description Invoice date
* @example 2023-01-01T00:00:00Z
*/
invoiceDate: string;
/**
* Format: date-time
* @description Due date
* @example 2023-01-15T00:00:00Z
*/
dueDate: string;
/**
* @description Invoice number
* @example INV-001
*/
invoiceNo?: string;
/**
* @description Reference number
* @example REF-001
*/
referenceNo?: string;
/**
* @description Whether the invoice is delivered
* @default false
*/
delivered: boolean;
/**
* @description Invoice message
* @example Thank you for your business
*/
invoiceMessage?: string;
/**
* @description Terms and conditions
* @example Payment due within 14 days
*/
termsConditions?: string;
/**
* @description Exchange rate
* @example 1
*/
exchangeRate?: number;
/**
* @description Warehouse ID
* @example 1
*/
warehouseId?: number;
/**
* @description Branch ID
* @example 1
*/
branchId?: number;
/**
* @description Project ID
* @example 1
*/
projectId?: number;
/**
* @description Whether tax is inclusive
* @example false
*/
isInclusiveTax?: boolean;
/** @description Invoice line items */
entries: components["schemas"]["ItemEntryDto"][];
/**
* @description PDF template ID
* @example 1
*/
pdfTemplateId?: number;
/** @description Payment methods */
paymentMethods?: components["schemas"]["PaymentMethodDto"][];
/**
* @description Discount value
* @example 10
*/
discount?: number;
/**
* @description Discount type
* @example percentage
* @enum {string}
*/
discountType?: "percentage" | "amount";
/**
* @description Adjustment amount
* @example 5
*/
adjustment?: number;
/**
* @description ID of the estimate this invoice is created from
* @example 1
*/
fromEstimateId?: number;
/**
* @description The attachments of the sale receipt
* @example [
* {
* "key": "123456"
* }
* ]
*/
attachments: string[];
};
UploadAttachmentDto: {
/** Format: binary */
file: string;
};
LinkAttachmentDto: Record<string, never>;
UnlinkAttachmentDto: Record<string, never>;
TaxRateResponseDto: {
/**
* @description The unique identifier of the tax rate
* @example 1
*/
id: number;
/**
* @description The name of the tax rate
* @example VAT
*/
name: string;
/**
* @description The formatted name of the tax rate including the rate percentage
* @example VAT [10%]
*/
nameFormatted: string;
/**
* @description The code of the tax rate
* @example VAT
*/
code: string;
/**
* @description The rate of the tax rate as a decimal number
* @example 10
*/
rate: number;
/**
* @description The formatted rate of the tax rate with percentage symbol
* @example 10%
*/
rateFormatted: string;
/**
* @description The description of the tax rate
* @example Value Added Tax
*/
description?: string;
/**
* @description Whether the tax is non-recoverable
* @example false
*/
isNonRecoverable: boolean;
/**
* @description Whether the tax is compound
* @example false
*/
isCompound: boolean;
/**
* @description Whether the tax rate is active
* @example true
*/
active: boolean;
/**
* Format: date-time
* @description The date when the tax rate was created
* @example 2024-03-20T10:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @description The date when the tax rate was last updated
* @example 2024-03-20T10:00:00Z
*/
updatedAt: string;
};
CreateTaxRateDto: {
/**
* @description The name of the tax rate.
* @example VAT
*/
name: string;
/**
* @description The code of the tax rate.
* @example VAT
*/
code: string;
/**
* @description The rate of the tax rate.
* @example 10
*/
rate: number;
/**
* @description The description of the tax rate.
* @example VAT
*/
description: string;
/**
* @description Whether the tax is non-recoverable.
* @example false
*/
isNonRecoverable: boolean;
/**
* @description Whether the tax is compound.
* @example false
*/
isCompound: boolean;
/**
* @description Whether the tax rate is active.
* @example false
*/
active: boolean;
};
EditTaxRateDto: {
/**
* @description The name of the tax rate.
* @example VAT
*/
name: string;
/**
* @description The code of the tax rate.
* @example VAT
*/
code: string;
/**
* @description The rate of the tax rate.
* @example 10
*/
rate: number;
/**
* @description The description of the tax rate.
* @example VAT
*/
description: string;
/**
* @description Whether the tax is non-recoverable.
* @example false
*/
isNonRecoverable: boolean;
/**
* @description Whether the tax is compound.
* @example false
*/
isCompound: boolean;
/**
* @description Whether the tax rate is active.
* @example false
*/
active: boolean;
};
PaymentReceivedStateResponseDto: {
/**
* @description The ID of the default PDF template for payment received
* @example 1
*/
defaultTemplateId: number | null;
};
PaymentReceivedEntryResponseDto: {
/**
* @description ID of the entry
* @example 1
*/
id: number;
/**
* @description Index of the entry
* @example 0
*/
index: number;
/**
* @description ID of the payment received
* @example 1
*/
paymentReceiveId: number;
/**
* @description ID of the invoice
* @example 10
*/
invoiceId: number;
/**
* @description Amount paid for this invoice
* @example 100
*/
paymentAmount: number;
/**
* @description Formatted paid amount
* @example 100.00
*/
paymentAmountFormatted: string;
/**
* @description Invoice details
* @example {
* "id": 10,
* "invoiceNo": "INV-001",
* "total": 1000,
* "dueAmount": 500,
* "customerId": 1
* }
*/
invoice: Record<string, never>;
};
PaymentReceivedResponseDto: {
/**
* @description The unique identifier of the payment received
* @example 1
*/
id: number;
/**
* @description The payment receive number
* @example PR-001
*/
paymentReceiveNo: string;
/**
* @description The date of the payment
* @example 2023-01-01T00:00:00Z
*/
paymentDate: Record<string, never>;
/**
* @description The formatted payment date
* @example 2023-01-01
*/
formattedPaymentDate: string;
/**
* @description The customer ID
* @example 1
*/
customerId: number;
/**
* @description The reference number
* @example REF-001
*/
referenceNo?: string;
/**
* @description The amount received
* @example 100
*/
amount: number;
/**
* @description The formatted amount
* @example 100.00
*/
formattedAmount: string;
/**
* @description The formatted total
* @example 100.00 USD
*/
formattedTotal: string;
/**
* @description The currency code
* @example USD
*/
currencyCode: string;
/**
* @description The exchange rate
* @example 1
*/
exchangeRate: number;
/**
* @description The formatted exchange rate
* @example 1.00
*/
formattedExchangeRate: string;
/**
* @description The statement or note
* @example Payment for invoice INV-001
*/
statement?: string;
/**
* @description The ID of the deposit account
* @example 2
*/
depositAccountId: number;
/** @description Deposit account details */
depositAccount: components["schemas"]["AccountResponseDto"];
/**
* @description The ID of the branch
* @example 1
*/
branchId?: number;
/** @description Branch details */
branch?: components["schemas"]["BranchResponseDto"];
/**
* @description The ID of the PDF template
* @example 1
*/
pdfTemplateId?: number;
/**
* @description PDF template details
* @example {
* "id": 1,
* "templateName": "Default",
* "resource": "PaymentReceive",
* "attributes": {
* "primaryColor": "#000000"
* }
* }
*/
pdfTemplate?: Record<string, never>;
/**
* @description The user ID who created the payment
* @example 5
*/
userId: number;
/**
* @description The date when the payment was created
* @example 2023-01-01T00:00:00Z
*/
createdAt: Record<string, never>;
/**
* @description The formatted created at date
* @example 2023-01-01
*/
formattedCreatedAt: string;
/**
* @description The date when the payment was last updated
* @example 2023-01-02T00:00:00Z
*/
updatedAt?: Record<string, never>;
/**
* @description The entries of the payment received
* @example [
* {
* "id": 1,
* "index": 0,
* "paymentReceiveId": 1,
* "invoiceId": 10,
* "paymentAmount": 100,
* "paymentAmountFormatted": "100.00",
* "invoice": {
* "id": 10,
* "invoiceNo": "INV-001",
* "total": 1000,
* "dueAmount": 500,
* "customerId": 1
* }
* }
* ]
*/
entries: components["schemas"]["PaymentReceivedEntryResponseDto"][];
/**
* @description The attachments of the payment received
* @example [
* {
* "key": "file-uuid-1"
* },
* {
* "key": "file-uuid-2"
* }
* ]
*/
attachments?: components["schemas"]["AttachmentLinkDto"][];
};
CreatePaymentReceivedDto: {
/**
* @description The id of the customer
* @example 1
*/
customerId: number;
/**
* @description The payment date of the payment received
* @example 2021-01-01
*/
paymentDate: Record<string, never>;
/**
* @description The amount of the payment received
* @example 100
*/
amount: number;
/**
* @description The exchange rate of the payment received
* @example 1
*/
exchangeRate: number;
/**
* @description The reference number of the payment received
* @example 123456
*/
referenceNo: string;
/**
* @description The id of the deposit account
* @example 1
*/
depositAccountId: number;
/**
* @description The payment receive number of the payment received
* @example 123456
*/
paymentReceiveNo: string;
/**
* @description The statement of the payment received
* @example 123456
*/
statement: string;
/**
* @description The entries of the payment received
* @example [
* {
* "invoiceId": 1,
* "paymentAmount": 100
* }
* ]
*/
entries: string[];
/**
* @description The id of the branch
* @example 1
*/
branchId: number;
/**
* @description The attachments of the payment received
* @example [
* {
* "id": 1,
* "type": "bill"
* }
* ]
*/
attachments: string[];
};
EditPaymentReceivedDto: {
/**
* @description The id of the customer
* @example 1
*/
customerId: number;
/**
* @description The payment date of the payment received
* @example 2021-01-01
*/
paymentDate: Record<string, never>;
/**
* @description The amount of the payment received
* @example 100
*/
amount: number;
/**
* @description The exchange rate of the payment received
* @example 1
*/
exchangeRate: number;
/**
* @description The reference number of the payment received
* @example 123456
*/
referenceNo: string;
/**
* @description The id of the deposit account
* @example 1
*/
depositAccountId: number;
/**
* @description The payment receive number of the payment received
* @example 123456
*/
paymentReceiveNo: string;
/**
* @description The statement of the payment received
* @example 123456
*/
statement: string;
/**
* @description The entries of the payment received
* @example [
* {
* "invoiceId": 1,
* "paymentAmount": 100
* }
* ]
*/
entries: string[];
/**
* @description The id of the branch
* @example 1
*/
branchId: number;
/**
* @description The attachments of the payment received
* @example [
* {
* "id": 1,
* "type": "bill"
* }
* ]
*/
attachments: string[];
};
ModelMetaDefaultSortDto: {
/**
* @description The sort order
* @example DESC
* @enum {string}
*/
sortOrder: "DESC" | "ASC";
/**
* @description The sort field
* @example createdAt
*/
sortField: string;
};
ModelPrintMetaDto: {
/**
* @description The page title for print
* @example Invoice INV-0001
*/
pageTitle: string;
};
ResourceMetaResponseDto: {
/**
* @description The default filter field
* @example query
*/
defaultFilterField: string;
/** @description The default sort configuration */
defaultSort: components["schemas"]["ModelMetaDefaultSortDto"];
/**
* @description Whether the resource is exportable
* @example true
*/
exportable?: boolean;
/**
* @description The field to flatten on during export
* @example entries
*/
exportFlattenOn?: string;
/**
* @description Whether the resource is importable
* @example true
*/
importable?: boolean;
/**
* @description The import aggregator field
* @example entries
*/
importAggregator?: string;
/**
* @description The field to aggregate on during import
* @example referenceNo
*/
importAggregateOn?: string;
/**
* @description The field to aggregate by during import
* @example id
*/
importAggregateBy?: string;
/** @description The print metadata */
print?: components["schemas"]["ModelPrintMetaDto"];
/** @description The resource fields (legacy format) */
fields: {
[key: string]: unknown;
};
/** @description The resource fields (new format) */
fields2: {
[key: string]: unknown;
};
/** @description The resource columns */
columns: {
[key: string]: unknown;
};
};
PaymentLinkEntryDto: {
/** @description Line item description */
description: string;
/** @description Item name */
itemName: string;
/** @description Quantity */
quantity: number;
/** @description Formatted quantity */
quantityFormatted: string;
/** @description Unit rate */
rate: number;
/** @description Formatted rate */
rateFormatted: string;
/** @description Line total */
total: number;
/** @description Formatted total */
totalFormatted: string;
};
PaymentLinkTaxEntryDto: {
/** @description Tax name */
name: string;
/** @description Tax rate amount */
taxRateAmount: number;
/** @description Formatted tax rate amount */
taxRateAmountFormatted: string;
/** @description Tax rate code */
taxRateCode: string;
};
PaymentLinkBrandingTemplateDto: {
/** @description Company logo URI */
companyLogoUri: string;
/** @description Primary color */
primaryColor: string;
/** @description Secondary color */
secondaryColor?: string;
};
PaymentLinkOrganizationDto: {
/** @description Organization address */
address: Record<string, never>;
/** @description Organization name */
name: string;
/** @description Primary brand color */
primaryColor: string;
/** @description Logo URI */
logoUri: string;
/** @description Formatted address text */
addressTextFormatted: string;
};
GetInvoicePaymentLinkResponseDto: {
/** @description Amount due */
dueAmount: number;
/** @description Formatted amount due */
dueAmountFormatted: string;
/** @description Due date */
dueDate: string;
/** @description Formatted due date */
dueDateFormatted: string;
/** @description Formatted invoice date */
invoiceDateFormatted: string;
/** @description Invoice number */
invoiceNo: string;
/** @description Payment amount */
paymentAmount: number;
/** @description Formatted payment amount */
paymentAmountFormatted: string;
/** @description Subtotal */
subtotal: number;
/** @description Formatted subtotal */
subtotalFormatted: string;
/** @description Formatted subtotal in local currency */
subtotalLocalFormatted: string;
/** @description Total amount */
total: number;
/** @description Formatted total */
totalFormatted: string;
/** @description Formatted total in local currency */
totalLocalFormatted: string;
/** @description Customer name */
customerName: string;
/** @description Invoice message */
invoiceMessage: string;
/** @description Terms and conditions */
termsConditions: string;
/** @description Invoice line entries */
entries: components["schemas"]["PaymentLinkEntryDto"][];
/** @description Tax entries */
taxes: components["schemas"]["PaymentLinkTaxEntryDto"][];
/** @description Branding template */
brandingTemplate: components["schemas"]["PaymentLinkBrandingTemplateDto"];
/** @description Organization metadata */
organization: components["schemas"]["PaymentLinkOrganizationDto"];
/** @description Whether Stripe is available as payment method */
hasStripePaymentMethod: boolean;
/** @description Whether invoice has receivable balance */
isReceivable: boolean;
/** @description Formatted customer address */
formattedCustomerAddress: string;
};
GetInvoicePaymentLinkResponseWrapperDto: {
/** @description Payment link invoice metadata */
data: components["schemas"]["GetInvoicePaymentLinkResponseDto"];
};
CreateStripeCheckoutSessionResponseDto: {
/**
* @description Stripe checkout session ID
* @example cs_test_xxx
*/
sessionId: string;
/**
* @description Stripe publishable key for the client
* @example pk_test_xxx
*/
publishableKey: string;
/**
* @description URL to redirect the customer to complete checkout
* @example https://checkout.stripe.com/c/pay/cs_test_xxx
*/
redirectTo: string;
};
GetStripeConnectLinkResponseDto: {
/**
* @description Stripe OAuth2 Connect authorization URL
* @example https://connect.stripe.com/oauth/authorize?response_type=code&client_id=...
*/
url: string;
};
ExchangeStripeOAuthBodyDto: {
/**
* @description Authorization code returned by Stripe OAuth
* @example ac_xxx
*/
code: string;
};
CreateStripeAccountResponseDto: {
/**
* @description The Stripe Connect account ID
* @example acct_1234567890
*/
account_id: string;
};
CreateStripeAccountSessionBodyDto: {
/**
* @description Stripe Connect account ID to create a session for
* @example acct_1234567890
*/
account?: string;
};
CreateStripeAccountSessionResponseDto: {
/**
* @description Stripe Account Session client secret for the Connect embedded component
* @example acs_xxx_secret_xxx
*/
client_secret: string;
};
CreateStripeAccountLinkBodyDto: {
/**
* @description Stripe Connect account ID
* @example acct_xxx
*/
stripeAccountId: string;
};
StripeAccountLinkResponseDto: {
/**
* @description URL for the account onboarding flow
* @example https://connect.stripe.com/setup/xxx
*/
url: string;
/**
* @description Unix timestamp when the link was created
* @example 1234567890
*/
created: number;
/**
* @description Unix timestamp when the link expires
* @example 1234567890
*/
expires_at: number;
/**
* @description Stripe object type
* @example account_link
*/
object: string;
};
CreateStripeAccountLinkResponseDto: {
/** @description Stripe AccountLink object for onboarding */
clientSecret: components["schemas"]["StripeAccountLinkResponseDto"];
};
ItemCategoryResponseDto: {
/**
* @description The unique identifier of the item category
* @example 1
*/
id: number;
/**
* @description The name of the item category
* @example Electronics
*/
name: string;
/**
* @description The description of the item category
* @example Electronic devices and accessories
*/
description?: string;
/**
* @description The cost account ID
* @example 1
*/
costAccountId?: number;
/**
* @description The sell account ID
* @example 1
*/
sellAccountId?: number;
/**
* @description The inventory account ID
* @example 1
*/
inventoryAccountId?: number;
/**
* @description The cost method
* @example FIFO
*/
costMethod?: string;
/**
* @description The user ID who created the category
* @example 1
*/
userId: number;
/**
* Format: date-time
* @description The creation date of the category
* @example 2024-03-20T10:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @description The last update date of the category
* @example 2024-03-20T10:00:00Z
*/
updatedAt: string;
/**
* @description The number of items in this category
* @example 5
*/
count: number;
};
CreateItemCategoryDto: {
/**
* @description The category name
* @example Category name
*/
name: string;
/**
* @description The category description
* @example Category description
*/
description: string;
/**
* @description The cost account ID
* @example 1
*/
costAccountId: number;
/**
* @description The sell account ID
* @example 1
*/
sellAccountId: number;
/**
* @description The inventory account ID
* @example 1
*/
inventoryAccountId: number;
/**
* @description The cost method
* @example FIFO
*/
costMethod: string;
};
EditItemCategoryDto: {
/**
* @description The category name
* @example Category name
*/
name: string;
/**
* @description The category description
* @example Category description
*/
description: string;
/**
* @description The cost account ID
* @example 1
*/
costAccountId: number;
/**
* @description The sell account ID
* @example 1
*/
sellAccountId: number;
/**
* @description The inventory account ID
* @example 1
*/
inventoryAccountId: number;
/**
* @description The cost method
* @example FIFO
*/
costMethod: string;
};
ExpenseCategoryResponseDto: {
/**
* @description The unique identifier of the expense category
* @example 1
*/
id: number;
/**
* @description The amount of the expense category
* @example 100
*/
amount: number;
/**
* @description The allocated cost amount of the expense category
* @example 50
*/
allocatedCostAmount: number;
/**
* @description The expense account ID associated with this category
* @example 1
*/
expenseAccountId: number;
/**
* @description The project ID associated with this category
* @example 1
*/
projectId?: number;
/**
* @description The description of the expense category
* @example Office supplies for Q1
*/
description: string;
/**
* @description The unallocated cost amount of the expense category
* @example 50
*/
unallocatedCostAmount: number;
};
ExpenseResponseDto: {
/**
* @description The unique identifier of the expense
* @example 1
*/
id: number;
/**
* @description The total amount of the expense
* @example 1000
*/
totalAmount: number;
/**
* @description The currency code of the expense
* @example USD
*/
currencyCode: string;
/**
* @description The exchange rate used for the expense
* @example 1.2
*/
exchangeRate: number;
/**
* @description The description of the expense
* @example Office supplies and equipment
*/
description?: string;
/**
* @description The ID of the payment account used for this expense
* @example 1
*/
paymentAccountId: number;
/**
* @description The reference number of the expense
* @example EXP-2024-001
*/
referenceNo: string;
/**
* Format: date-time
* @description The date when the expense was published
* @example 2024-03-20T10:00:00Z
*/
publishedAt?: string;
/**
* @description The ID of the user who created the expense
* @example 1
*/
userId: number;
/**
* Format: date-time
* @description The payment date of the expense
* @example 2024-03-20T10:00:00Z
*/
paymentDate: string;
/**
* @description The ID of the payee
* @example 1
*/
payeeId: number;
/**
* @description The landed cost amount of the expense
* @example 800
*/
landedCostAmount: number;
/**
* @description The allocated cost amount of the expense
* @example 200
*/
allocatedCostAmount: number;
/**
* @description The invoiced amount of the expense
* @example 0
*/
invoicedAmount: number;
/**
* @description The ID of the branch associated with the expense
* @example 1
*/
branchId: number;
/**
* Format: date-time
* @description The creation date of the expense
* @example 2024-03-20T10:00:00Z
*/
createdAt: string;
/**
* @description Whether the expense is published
* @example true
*/
isPublished: boolean;
/**
* @description The unallocated cost amount of the expense
* @example 200
*/
unallocatedCostAmount: number;
/**
* @description The local amount of the expense (total amount * exchange rate)
* @example 1200
*/
localAmount: number;
/**
* @description The local landed cost amount of the expense
* @example 960
*/
localLandedCostAmount: number;
/**
* @description The local allocated cost amount of the expense
* @example 240
*/
localAllocatedCostAmount: number;
/**
* @description The local unallocated cost amount of the expense
* @example 240
*/
localUnallocatedCostAmount: number;
/**
* @description The billable amount of the expense
* @example 1000
*/
billableAmount: number;
/** @description The categories associated with this expense */
categories: components["schemas"]["ExpenseCategoryResponseDto"][];
};
CreateExpenseDto: {
/**
* @description The reference number of the expense
* @example INV-123456
*/
referenceNo: string;
/**
* Format: date-time
* @description The payment date of the expense
* @example 2021-01-01
*/
paymentDate: string;
/**
* @description The payment account id of the expense
* @example 1
*/
paymentAccountId: number;
/**
* @description The description of the expense
* @example This is a description
*/
description: string;
/**
* @description The exchange rate of the expense
* @example 1
*/
exchangeRate: number;
/**
* @description The currency code of the expense
* @example USD
*/
currencyCode: string;
/**
* @description The publish status of the expense
* @example true
*/
publish: boolean;
/**
* @description The payee id of the expense
* @example 1
*/
payeeId: number;
/**
* @description The branch id of the expense
* @example 1
*/
branchId: number;
/**
* @description The categories of the expense
* @example [
* {
* "index": 1,
* "expenseAccountId": 1,
* "amount": 100,
* "description": "This is a description",
* "landedCost": true,
* "projectId": 1
* }
* ]
*/
categories: string[];
/**
* @description The attachments of the expense
* @example [
* {
* "key": "123456"
* }
* ]
*/
attachments: string[];
};
EditExpenseDto: {
/**
* @description The reference number of the expense
* @example INV-123456
*/
referenceNo: string;
/**
* Format: date-time
* @description The payment date of the expense
* @example 2021-01-01
*/
paymentDate: string;
/**
* @description The payment account id of the expense
* @example 1
*/
paymentAccountId: number;
/**
* @description The description of the expense
* @example This is a description
*/
description: string;
/**
* @description The exchange rate of the expense
* @example 1
*/
exchangeRate: number;
/**
* @description The currency code of the expense
* @example USD
*/
currencyCode: string;
/**
* @description The publish status of the expense
* @example true
*/
publish: boolean;
/**
* @description The payee id of the expense
* @example 1
*/
payeeId: number;
/**
* @description The branch id of the expense
* @example 1
*/
branchId: number;
/**
* @description The categories of the expense
* @example [
* {
* "index": 1,
* "expenseAccountId": 1,
* "amount": 100,
* "description": "This is a description",
* "landedCost": true,
* "projectId": 1
* }
* ]
*/
categories: string[];
/**
* @description The attachments of the expense
* @example [
* {
* "key": "123456"
* }
* ]
*/
attachments: string[];
};
WarehouseTransferEntryResponseDto: {
/**
* @description The ID of the warehouse transfer entry
* @example 1
*/
id: number;
/**
* @description The ID of the item being transferred
* @example 1
*/
itemId: number;
/**
* @description The quantity of items being transferred
* @example 100
*/
quantity: number;
/**
* @description The cost per unit of the item
* @example 10.5
*/
cost: number;
/**
* @description The total cost of the transfer entry
* @example 1050
*/
total: number;
/**
* @description The formatted quantity of items being transferred
* @example 100.00
*/
formattedQuantity: string;
/**
* @description The formatted cost per unit of the item
* @example $10.50
*/
formattedCost: string;
/**
* @description The formatted total cost of the transfer entry
* @example $1,050.00
*/
formattedTotal: string;
/** @description The item details */
item: Record<string, never>;
};
WarehouseTransferResponseDto: {
/**
* @description The ID of the warehouse transfer
* @example 1
*/
id: number;
/**
* Format: date-time
* @description The date of the warehouse transfer
* @example 2024-03-20
*/
date: string;
/**
* @description The formatted date of the warehouse transfer
* @example Mar 20, 2024
*/
formattedDate: string;
/**
* @description The transaction number of the warehouse transfer
* @example WT-2024-001
*/
transactionNumber: string;
/**
* @description The ID of the source warehouse
* @example 1
*/
fromWarehouseId: number;
/**
* @description The ID of the destination warehouse
* @example 2
*/
toWarehouseId: number;
/**
* Format: date-time
* @description The date when the transfer was initiated
* @example 2024-03-20T10:00:00Z
*/
transferInitiatedAt: string;
/**
* Format: date-time
* @description The date when the transfer was delivered
* @example 2024-03-21T15:00:00Z
*/
transferDeliveredAt: string;
/**
* @description Whether the transfer has been initiated
* @example true
*/
isInitiated: boolean;
/**
* @description Whether the transfer has been completed
* @example true
*/
isTransferred: boolean;
/** @description The source warehouse details */
fromWarehouse: Record<string, never>;
/** @description The destination warehouse details */
toWarehouse: Record<string, never>;
/** @description The entries of the warehouse transfer */
entries: components["schemas"]["WarehouseTransferEntryResponseDto"][];
/**
* Format: date-time
* @description The creation date of the warehouse transfer
* @example 2024-03-20T09:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @description The last update date of the warehouse transfer
* @example 2024-03-21T15:00:00Z
*/
updatedAt: string;
};
CreateWarehouseTransferDto: {
/**
* @description The id of the warehouse to transfer from
* @example 1
*/
fromWarehouseId: number;
/**
* @description The id of the warehouse to transfer to
* @example 2
*/
toWarehouseId: number;
/**
* Format: date-time
* @description The date of the warehouse transfer
* @example 2021-01-01
*/
date: string;
/**
* @description The transaction number of the warehouse transfer
* @example 123456
*/
transactionNumber: string;
/**
* @description Whether the warehouse transfer has been initiated
* @example false
*/
transferInitiated: boolean;
/**
* @description Whether the warehouse transfer has been delivered
* @example false
*/
transferDelivered: boolean;
/**
* @description The entries of the warehouse transfer
* @example [
* {
* "index": 1,
* "itemId": 1,
* "description": "This is a description",
* "quantity": 100,
* "cost": 100
* }
* ]
*/
entries: string[];
};
EditWarehouseTransferDto: {
/**
* @description The id of the warehouse to transfer from
* @example 1
*/
fromWarehouseId: number;
/**
* @description The id of the warehouse to transfer to
* @example 2
*/
toWarehouseId: number;
/**
* Format: date-time
* @description The date of the warehouse transfer
* @example 2021-01-01
*/
date: string;
/**
* @description The transaction number of the warehouse transfer
* @example 123456
*/
transactionNumber: string;
/**
* @description Whether the warehouse transfer has been initiated
* @example false
*/
transferInitiated: boolean;
/**
* @description Whether the warehouse transfer has been delivered
* @example false
*/
transferDelivered: boolean;
/**
* @description The entries of the warehouse transfer
* @example [
* {
* "index": 1,
* "itemId": 1,
* "description": "This is a description",
* "quantity": 100,
* "cost": 100
* }
* ]
*/
entries: string[];
};
ValidateBulkDeleteCustomersResponseDto: {
/**
* @description Number of customers that can be deleted
* @example 2
*/
deletableCount: number;
/**
* @description Number of customers that cannot be deleted
* @example 1
*/
nonDeletableCount: number;
/**
* @description IDs of customers that can be deleted
* @example [
* 1,
* 2
* ]
*/
deletableIds: number[];
/**
* @description IDs of customers that cannot be deleted
* @example [
* 3
* ]
*/
nonDeletableIds: number[];
};
CustomerResponseDto: {
/** @example 1500 */
balance: number;
/** @example USD */
currencyCode: string;
/** @example 1000 */
openingBalance: number;
/**
* Format: date-time
* @example 2024-01-01T00:00:00Z
*/
openingBalanceAt: string;
/** @example 1 */
openingBalanceExchangeRate: number;
/** @example 1 */
openingBalanceBranchId?: number;
/** @example Mr. */
salutation?: string;
/** @example John */
firstName?: string;
/** @example Doe */
lastName?: string;
/** @example Acme Corporation */
companyName?: string;
/** @example John Doe - Acme Corporation */
displayName: string;
/** @example john.doe@acme.com */
email?: string;
/** @example +1 (555) 123-4567 */
workPhone?: string;
/** @example +1 (555) 987-6543 */
personalPhone?: string;
/** @example https://www.acme.com */
website?: string;
/** @example 123 Business Ave */
billingAddress1?: string;
/** @example Suite 100 */
billingAddress2?: string;
/** @example New York */
billingAddressCity?: string;
/** @example United States */
billingAddressCountry?: string;
/** @example billing@acme.com */
billingAddressEmail?: string;
/** @example 10001 */
billingAddressPostcode?: string;
/** @example +1 (555) 111-2222 */
billingAddressPhone?: string;
/** @example NY */
billingAddressState?: string;
/** @example 456 Shipping St */
shippingAddress1?: string;
/** @example Unit 200 */
shippingAddress2?: string;
/** @example Los Angeles */
shippingAddressCity?: string;
/** @example United States */
shippingAddressCountry?: string;
/** @example shipping@acme.com */
shippingAddressEmail?: string;
/** @example 90001 */
shippingAddressPostcode?: string;
/** @example +1 (555) 333-4444 */
shippingAddressPhone?: string;
/** @example CA */
shippingAddressState?: string;
/** @example Important client with regular monthly orders */
note: string;
/** @example true */
active: boolean;
/**
* Format: date-time
* @example 2024-01-01T00:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @example 2024-01-01T00:00:00Z
*/
updatedAt: string;
/** @example 1000 */
localOpeningBalance: number;
/** @example 1500 */
closingBalance: number;
};
CreateCustomerDto: {
/** @description Billing address line 1 */
billingAddress1?: string;
/** @description Billing address line 2 */
billingAddress2?: string;
/** @description Billing address city */
billingAddressCity?: string;
/** @description Billing address country */
billingAddressCountry?: string;
/** @description Billing address email */
billingAddressEmail?: string;
/** @description Billing address postcode */
billingAddressPostcode?: string;
/** @description Billing address phone */
billingAddressPhone?: string;
/** @description Billing address state */
billingAddressState?: string;
/** @description Shipping address line 1 */
shippingAddress1?: string;
/** @description Shipping address line 2 */
shippingAddress2?: string;
/** @description Shipping address city */
shippingAddressCity?: string;
/** @description Shipping address country */
shippingAddressCountry?: string;
/** @description Shipping address email */
shippingAddressEmail?: string;
/** @description Shipping address postcode */
shippingAddressPostcode?: string;
/** @description Shipping address phone */
shippingAddressPhone?: string;
/** @description Shipping address state */
shippingAddressState?: string;
/**
* @description Customer type
* @example business
*/
customerType: string;
/**
* @description Currency code
* @example USD
*/
currencyCode: string;
/**
* @description Opening balance
* @example 5000
*/
openingBalance?: number;
/**
* @description Opening balance date (required when openingBalance is provided)
* @example 2024-01-01
*/
openingBalanceAt?: string;
/**
* @description Opening balance exchange rate
* @example 1
*/
openingBalanceExchangeRate?: number;
/**
* @description Opening balance branch ID
* @example 101
*/
openingBalanceBranchId?: number;
/**
* @description Salutation
* @example Mr.
*/
salutation?: string;
/**
* @description First name
* @example John
*/
firstName?: string;
/**
* @description Last name
* @example Smith
*/
lastName?: string;
/**
* @description Company name
* @example Acme Corporation
*/
companyName?: string;
/**
* @description Display name
* @example Acme Corporation
*/
displayName: string;
/**
* @description Website
* @example https://www.acmecorp.com
*/
website?: string;
/**
* @description Email
* @example contact@acmecorp.com
*/
email?: string;
/**
* @description Work phone
* @example +1 (555) 123-4567
*/
workPhone?: string;
/** @description Personal phone */
personalPhone?: string;
/** @description Note */
note?: string;
/**
* @description Active status
* @default true
*/
active: boolean;
/**
* @description Customer code
* @example CUST-001
*/
code?: string;
};
EditCustomerDto: {
/** @description Billing address line 1 */
billingAddress1?: string;
/** @description Billing address line 2 */
billingAddress2?: string;
/** @description Billing address city */
billingAddressCity?: string;
/** @description Billing address country */
billingAddressCountry?: string;
/** @description Billing address email */
billingAddressEmail?: string;
/** @description Billing address postcode */
billingAddressPostcode?: string;
/** @description Billing address phone */
billingAddressPhone?: string;
/** @description Billing address state */
billingAddressState?: string;
/** @description Shipping address line 1 */
shippingAddress1?: string;
/** @description Shipping address line 2 */
shippingAddress2?: string;
/** @description Shipping address city */
shippingAddressCity?: string;
/** @description Shipping address country */
shippingAddressCountry?: string;
/** @description Shipping address email */
shippingAddressEmail?: string;
/** @description Shipping address postcode */
shippingAddressPostcode?: string;
/** @description Shipping address phone */
shippingAddressPhone?: string;
/** @description Shipping address state */
shippingAddressState?: string;
/** @description Customer type */
customerType: string;
/** @description Salutation */
salutation?: string;
/** @description First name */
firstName?: string;
/** @description Last name */
lastName?: string;
/** @description Company name */
companyName?: string;
/** @description Display name */
displayName: string;
/** @description Website */
website?: string;
/** @description Email */
email?: string;
/** @description Work phone */
workPhone?: string;
/** @description Personal phone */
personalPhone?: string;
/** @description Note */
note?: string;
/** @description Active status */
active?: boolean;
/** @description Customer code */
code?: string;
};
CustomerOpeningBalanceEditDto: {
/**
* @description Opening balance
* @example 5000
*/
openingBalance: number;
/**
* @description Opening balance date
* @example 2024-01-01
*/
openingBalanceAt?: string;
/**
* @description Opening balance exchange rate
* @example 1
*/
openingBalanceExchangeRate?: number;
/**
* @description Opening balance branch ID
* @example 101
*/
openingBalanceBranchId?: number;
};
BulkDeleteCustomersDto: {
/**
* @description Array of customer IDs to delete
* @example [
* 1,
* 2,
* 3
* ]
*/
ids: number[];
/**
* @description When true, undeletable customers will be skipped and only deletable ones removed.
* @default false
*/
skipUndeletable: boolean;
};
ValidateBulkDeleteVendorsResponseDto: {
/**
* @description Number of vendors that can be deleted
* @example 2
*/
deletableCount: number;
/**
* @description Number of vendors that cannot be deleted
* @example 1
*/
nonDeletableCount: number;
/**
* @description IDs of vendors that can be deleted
* @example [
* 1,
* 2
* ]
*/
deletableIds: number[];
/**
* @description IDs of vendors that cannot be deleted
* @example [
* 3
* ]
*/
nonDeletableIds: number[];
};
CreateVendorDto: {
/** @description Billing address line 1 */
billingAddress1?: string;
/** @description Billing address line 2 */
billingAddress2?: string;
/** @description Billing address city */
billingAddressCity?: string;
/** @description Billing address country */
billingAddressCountry?: string;
/** @description Billing address email */
billingAddressEmail?: string;
/** @description Billing address postcode */
billingAddressPostcode?: string;
/** @description Billing address phone */
billingAddressPhone?: string;
/** @description Billing address state */
billingAddressState?: string;
/** @description Shipping address line 1 */
shippingAddress1?: string;
/** @description Shipping address line 2 */
shippingAddress2?: string;
/** @description Shipping address city */
shippingAddressCity?: string;
/** @description Shipping address country */
shippingAddressCountry?: string;
/** @description Shipping address email */
shippingAddressEmail?: string;
/** @description Shipping address postcode */
shippingAddressPostcode?: string;
/** @description Shipping address phone */
shippingAddressPhone?: string;
/** @description Shipping address state */
shippingAddressState?: string;
/** @description Vendor opening balance */
openingBalance?: number;
/**
* @description Vendor opening balance exchange rate
* @default 1
*/
openingBalanceExchangeRate: number;
/**
* Format: date-time
* @description Date of the opening balance (required when openingBalance is provided)
*/
openingBalanceAt?: string;
/** @description Branch ID for the opening balance */
openingBalanceBranchId?: number;
/** @description Currency code for the vendor */
currencyCode: string;
/** @description Vendor salutation */
salutation?: string;
/** @description Vendor first name */
firstName?: string;
/** @description Vendor last name */
lastName?: string;
/** @description Vendor company name */
companyName?: string;
/** @description Vendor display name */
displayName?: string;
/** @description Vendor website */
website?: string;
/** @description Vendor email address */
email?: string;
/** @description Vendor work phone number */
workPhone?: string;
/** @description Vendor personal phone number */
personalPhone?: string;
/** @description Additional notes about the vendor */
note?: string;
/**
* @description Whether the vendor is active
* @default true
*/
active: boolean;
/**
* @description Vendor code
* @example VEND-001
*/
code?: string;
};
EditVendorDto: {
/** @description Billing address line 1 */
billingAddress1?: string;
/** @description Billing address line 2 */
billingAddress2?: string;
/** @description Billing address city */
billingAddressCity?: string;
/** @description Billing address country */
billingAddressCountry?: string;
/** @description Billing address email */
billingAddressEmail?: string;
/** @description Billing address postcode */
billingAddressPostcode?: string;
/** @description Billing address phone */
billingAddressPhone?: string;
/** @description Billing address state */
billingAddressState?: string;
/** @description Shipping address line 1 */
shippingAddress1?: string;
/** @description Shipping address line 2 */
shippingAddress2?: string;
/** @description Shipping address city */
shippingAddressCity?: string;
/** @description Shipping address country */
shippingAddressCountry?: string;
/** @description Shipping address email */
shippingAddressEmail?: string;
/** @description Shipping address postcode */
shippingAddressPostcode?: string;
/** @description Shipping address phone */
shippingAddressPhone?: string;
/** @description Shipping address state */
shippingAddressState?: string;
/** @description Vendor salutation */
salutation?: string;
/** @description Vendor first name */
firstName?: string;
/** @description Vendor last name */
lastName?: string;
/** @description Vendor company name */
companyName?: string;
/** @description Vendor display name */
displayName?: string;
/** @description Vendor website */
website?: string;
/** @description Vendor email address */
email?: string;
/** @description Vendor work phone number */
workPhone?: string;
/** @description Vendor personal phone number */
personalPhone?: string;
/** @description Additional notes about the vendor */
note?: string;
/** @description Whether the vendor is active */
active?: boolean;
/** @description Vendor code */
code?: string;
};
VendorOpeningBalanceEditDto: {
/**
* @description Opening balance
* @example 5000
*/
openingBalance: number;
/**
* @description Opening balance date
* @example 2024-01-01
*/
openingBalanceAt?: string;
/**
* @description Opening balance exchange rate
* @example 1
*/
openingBalanceExchangeRate?: number;
/**
* @description Opening balance branch ID
* @example 101
*/
openingBalanceBranchId?: number;
};
BulkDeleteVendorsDto: {
/**
* @description Array of vendor IDs to delete
* @example [
* 1,
* 2,
* 3
* ]
*/
ids: number[];
/**
* @description When true, undeletable vendors will be skipped and only deletable ones removed.
* @default false
*/
skipUndeletable: boolean;
};
SaleEstiamteStateResponseDto: {
/**
* @description The ID of the default PDF template for sale estimates
* @example 1
*/
defaultTemplateId: number | null;
};
SaleEstimateResponseDto: {
/**
* @description Unique identifier of the customer
* @example 1
*/
customerId: number;
/**
* @description Date of the estimate
* @example 2024-01-01
*/
estimateDate: string;
/**
* @description Expiration date of the estimate
* @example 2024-01-31
*/
expirationDate: string;
/**
* @description Reference number of the estimate
* @example EST-2024-001
*/
reference: string;
/**
* @description Estimate number
* @example EST-2024-001
*/
estimateNumber: string;
/**
* @description Note for the estimate
* @example This is a note.
*/
note: string;
/**
* @description Terms and conditions for the estimate
* @example Payment due in 30 days.
*/
termsConditions: string;
/**
* @description Email to send the estimate to
* @example customer@email.com
*/
sendToEmail: string;
/**
* @description Exchange rate used for the estimate
* @example 1
*/
exchangeRate: number;
/**
* @description Amount of the estimate
* @example 1000
*/
amount: number;
/**
* @description Currency code
* @example USD
*/
currencyCode: string;
/**
* @description Delivered at date
* @example 2024-01-05
*/
deliveredAt?: string;
/**
* @description Approved at date
* @example 2024-01-10
*/
approvedAt?: string;
/**
* @description Rejected at date
* @example 2024-01-15
*/
rejectedAt?: string;
/**
* @description User ID who created the estimate
* @example 42
*/
userId: number;
/**
* @description Converted to invoice ID
* @example 100
*/
convertedToInvoiceId?: number;
/**
* @description Converted to invoice at date
* @example 2024-02-01
*/
convertedToInvoiceAt?: string;
/**
* @description Created at date
* @example 2024-01-01
*/
createdAt?: string;
/**
* @description Updated at date
* @example 2024-01-10
*/
updatedAt?: string;
/**
* @description Branch ID
* @example 2
*/
branchId?: number;
/**
* @description Warehouse ID
* @example 3
*/
warehouseId?: number;
/**
* @description Discount value
* @example 100
*/
discount: number;
/**
* @description Discount type
* @example amount
*/
discountType: string;
/**
* @description Adjustment value
* @example 50
*/
adjustment: number;
/**
* @description Formatted subtotal of the estimate
* @example 1,000.00
*/
formattedSubtotal: string;
/**
* @description Formatted total amount of the estimate
* @example 1,200.00
*/
formattedAmount: string;
/**
* @description Formatted estimate date
* @example 2024-01-01
*/
formattedEstimateDate: string;
/**
* @description Formatted expiration date
* @example 2024-01-31
*/
formattedExpirationDate: string;
/**
* @description Formatted delivered at date
* @example 2024-01-05
*/
formattedDeliveredAtDate: string;
/**
* @description Formatted approved at date
* @example 2024-01-10
*/
formattedApprovedAtDate: string;
/**
* @description Formatted rejected at date
* @example 2024-01-15
*/
formattedRejectedAtDate: string;
/**
* @description Formatted discount amount
* @example 100.00
*/
discountAmountFormatted: string;
/**
* @description Formatted discount percentage
* @example 10%
*/
discountPercentageFormatted: string;
/**
* @description Formatted adjustment amount
* @example 50.00
*/
adjustmentFormatted: string;
/**
* @description Formatted total
* @example 1,150.00
*/
totalFormatted: string;
/**
* @description Formatted total in local currency
* @example 1,200.00
*/
totalLocalFormatted: string;
/**
* @description Formatted created at date
* @example 2024-01-01
*/
formattedCreatedAt: string;
/** @description Entries of the sale estimate */
entries: components["schemas"]["ItemEntryDto"][];
/** @description Attachments of the sale estimate */
attachments: components["schemas"]["AttachmentLinkDto"][];
};
CreateSaleEstimateDto: {
/**
* @description The id of the customer
* @example 1
*/
customerId: number;
/**
* Format: date-time
* @description The date of the estimate
* @example 2021-01-01
*/
estimateDate: string;
/**
* Format: date-time
* @description The expiration date of the estimate
* @example 2021-01-01
*/
expirationDate: string;
/**
* @description The reference of the estimate
* @example 123456
*/
reference: string;
/**
* @description The exchange rate of the estimate
* @example 1
*/
exchangeRate: number;
/**
* @description The id of the warehouse
* @example 1
*/
warehouseId: number;
/**
* @description The id of the branch
* @example 1
*/
branchId: number;
/**
* @description The entries of the estimate
* @example [
* {
* "index": 1,
* "itemId": 1,
* "description": "This is a description",
* "quantity": 100,
* "cost": 100
* }
* ]
*/
entries: string[];
/**
* @description The note of the estimate
* @example This is a note
*/
note: string;
/**
* @description The terms and conditions of the estimate
* @example This is a terms and conditions
*/
termsConditions: string;
/**
* @description The email to send the estimate to
* @example test@test.com
*/
sendToEmail: string;
/**
* @description The attachments of the estimate
* @example [
* {
* "key": "123456"
* }
* ]
*/
attachments: string[];
/**
* @description The id of the pdf template
* @example 1
*/
pdfTemplateId: number;
/**
* @description The discount of the estimate
* @example 1
*/
discount: number;
/**
* @description The type of the discount
* @example amount
*/
discountType: string;
/**
* @description The adjustment of the estimate
* @example 1
*/
adjustment: number;
};
EditSaleEstimateDto: {
/**
* @description The id of the customer
* @example 1
*/
customerId: number;
/**
* Format: date-time
* @description The date of the estimate
* @example 2021-01-01
*/
estimateDate: string;
/**
* Format: date-time
* @description The expiration date of the estimate
* @example 2021-01-01
*/
expirationDate: string;
/**
* @description The reference of the estimate
* @example 123456
*/
reference: string;
/**
* @description The exchange rate of the estimate
* @example 1
*/
exchangeRate: number;
/**
* @description The id of the warehouse
* @example 1
*/
warehouseId: number;
/**
* @description The id of the branch
* @example 1
*/
branchId: number;
/**
* @description The entries of the estimate
* @example [
* {
* "index": 1,
* "itemId": 1,
* "description": "This is a description",
* "quantity": 100,
* "cost": 100
* }
* ]
*/
entries: string[];
/**
* @description The note of the estimate
* @example This is a note
*/
note: string;
/**
* @description The terms and conditions of the estimate
* @example This is a terms and conditions
*/
termsConditions: string;
/**
* @description The email to send the estimate to
* @example test@test.com
*/
sendToEmail: string;
/**
* @description The attachments of the estimate
* @example [
* {
* "key": "123456"
* }
* ]
*/
attachments: string[];
/**
* @description The id of the pdf template
* @example 1
*/
pdfTemplateId: number;
/**
* @description The discount of the estimate
* @example 1
*/
discount: number;
/**
* @description The type of the discount
* @example amount
*/
discountType: string;
/**
* @description The adjustment of the estimate
* @example 1
*/
adjustment: number;
};
SaleReceiptStateResponseDto: {
/**
* @description The ID of the default PDF template for sale invoices
* @example 1
*/
defaultTemplateId: number | null;
};
SaleReceiptResponseDto: {
/**
* @description The unique identifier of the sale receipt
* @example 1
*/
id: number;
/**
* Format: date-time
* @description The date of the sale receipt
* @example 2024-01-01T00:00:00Z
*/
receiptDate: string;
/**
* @description The receipt number
* @example SR-2024-001
*/
receiptNumber: string;
/**
* @description The reference number
* @example REF-001
*/
referenceNo?: string;
/**
* @description The ID of the customer
* @example 1
*/
customerId: number;
/** @description The customer details */
customer: components["schemas"]["CustomerResponseDto"];
/**
* @description The ID of the deposit account
* @example 1
*/
depositAccountId: number;
/** @description The deposit account details */
depositAccount: components["schemas"]["AccountResponseDto"];
/**
* @description The exchange rate for currency conversion
* @example 1
*/
exchangeRate?: number;
/**
* @description The currency code
* @example USD
*/
currencyCode?: string;
/**
* @description The message on the receipt
* @example Thank you for your payment
*/
receiptMessage?: string;
/**
* @description The statement on the receipt
* @example Paid in full
*/
statement?: string;
/**
* @description Whether the receipt is closed
* @example false
*/
closed: boolean;
/**
* @description The date when the receipt was closed
* @example 2024-01-02T00:00:00Z
*/
closedAt?: Record<string, never>;
/**
* @description The ID of the warehouse
* @example 1
*/
warehouseId?: number;
/** @description The warehouse details */
warehouse?: components["schemas"]["WarehouseResponseDto"];
/**
* @description The ID of the branch
* @example 1
*/
branchId?: number;
/** @description The branch details */
branch?: components["schemas"]["BranchResponseDto"];
/** @description The entries of the sale receipt */
entries: components["schemas"]["ItemEntryDto"][];
/** @description The attachments of the sale receipt */
attachments?: components["schemas"]["AttachmentLinkDto"][];
/**
* @description The discount value
* @example 100
*/
discount?: number;
/**
* @description The type of discount (percentage or fixed)
* @example percentage
* @enum {string}
*/
discountType?: "percentage" | "amount";
/**
* @description The adjustment amount
* @example 50
*/
adjustment?: number;
/**
* @description The subtotal amount before discount and adjustments
* @example 900
*/
subtotal: number;
/**
* @description The subtotal in local currency
* @example 900
*/
subtotalLocal: number;
/**
* @description The formatted subtotal
* @example 900.00
*/
subtotalFormatted: string;
/**
* @description The formatted subtotal in local currency
* @example 900.00
*/
subtotalLocalFormatted: string;
/**
* @description The total amount after discount and adjustments
* @example 1000
*/
total: number;
/**
* @description The total in local currency
* @example 1000
*/
totalLocal: number;
/**
* @description The formatted total
* @example 1,000.00
*/
totalFormatted: string;
/**
* @description The formatted total in local currency
* @example 1,000.00
*/
totalLocalFormatted: string;
/**
* @description The formatted amount
* @example 1,000.00
*/
formattedAmount: string;
/**
* @description The formatted receipt date
* @example 2024-01-01
*/
formattedReceiptDate: string;
/**
* @description The formatted closed at date
* @example 2024-01-02
*/
formattedClosedAtDate: string;
/**
* @description The formatted created at date
* @example 2024-01-01
*/
formattedCreatedAt: string;
/**
* @description The formatted discount amount
* @example 100.00
*/
discountAmountFormatted: string;
/**
* @description The formatted discount percentage
* @example 10%
*/
discountPercentageFormatted: string;
/**
* @description The formatted adjustment amount
* @example 50.00
*/
adjustmentFormatted: string;
/**
* Format: date-time
* @description The date when the receipt was created
* @example 2024-01-01T00:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @description The date when the receipt was last updated
* @example 2024-01-02T00:00:00Z
*/
updatedAt?: string;
};
CreateSaleReceiptDto: {
/**
* @description The id of the customer
* @example 1
*/
customerId: number;
/**
* @description The exchange rate of the sale receipt
* @example 1
*/
exchangeRate: number;
/**
* @description The id of the deposit account
* @example 1
*/
depositAccountId: number;
/**
* Format: date-time
* @description The date of the sale receipt
* @example 2021-01-01
*/
receiptDate: string;
/**
* @description The receipt number of the sale receipt
* @example 123456
*/
receiptNumber: string;
/**
* @description The reference number of the sale receipt
* @example 123456
*/
referenceNo: string;
/**
* @description Whether the sale receipt is closed
* @example false
*/
closed: boolean;
/**
* @description The id of the warehouse
* @example 1
*/
warehouseId: number;
/**
* @description The id of the branch
* @example 1
*/
branchId: number;
/**
* @description The entries of the sale receipt
* @example [
* {
* "key": "123456"
* }
* ]
*/
entries: string[];
/**
* @description The receipt message of the sale receipt
* @example 123456
*/
receiptMessage: string;
/**
* @description The statement of the sale receipt
* @example 123456
*/
statement: string;
/**
* @description The attachments of the sale receipt
* @example [
* {
* "key": "123456"
* }
* ]
*/
attachments: string[];
/**
* @description The id of the pdf template
* @example 1
*/
pdfTemplateId: number;
/**
* @description The discount of the sale receipt
* @example 1
*/
discount: number;
/**
* @description The discount type of the sale receipt
* @example percentage
*/
discountType: string;
/**
* @description The adjustment of the sale receipt
* @example 1
*/
adjustment: number;
};
EditSaleReceiptDto: {
/**
* @description The id of the customer
* @example 1
*/
customerId: number;
/**
* @description The exchange rate of the sale receipt
* @example 1
*/
exchangeRate: number;
/**
* @description The id of the deposit account
* @example 1
*/
depositAccountId: number;
/**
* Format: date-time
* @description The date of the sale receipt
* @example 2021-01-01
*/
receiptDate: string;
/**
* @description The receipt number of the sale receipt
* @example 123456
*/
receiptNumber: string;
/**
* @description The reference number of the sale receipt
* @example 123456
*/
referenceNo: string;
/**
* @description Whether the sale receipt is closed
* @example false
*/
closed: boolean;
/**
* @description The id of the warehouse
* @example 1
*/
warehouseId: number;
/**
* @description The id of the branch
* @example 1
*/
branchId: number;
/**
* @description The entries of the sale receipt
* @example [
* {
* "key": "123456"
* }
* ]
*/
entries: string[];
/**
* @description The receipt message of the sale receipt
* @example 123456
*/
receiptMessage: string;
/**
* @description The statement of the sale receipt
* @example 123456
*/
statement: string;
/**
* @description The attachments of the sale receipt
* @example [
* {
* "key": "123456"
* }
* ]
*/
attachments: string[];
/**
* @description The id of the pdf template
* @example 1
*/
pdfTemplateId: number;
/**
* @description The discount of the sale receipt
* @example 1
*/
discount: number;
/**
* @description The discount type of the sale receipt
* @example percentage
*/
discountType: string;
/**
* @description The adjustment of the sale receipt
* @example 1
*/
adjustment: number;
};
BillResponseDto: {
/**
* @description The unique identifier of the bill
* @example 1
*/
id: number;
/**
* @description The bill number
* @example BILL-2024-001
*/
billNumber: string;
/**
* Format: date-time
* @description The date the bill was issued
* @example 2024-03-15T00:00:00Z
*/
billDate: string;
/**
* Format: date-time
* @description The due date of the bill
* @example 2024-04-15T00:00:00Z
*/
dueDate: string;
/**
* @description The reference number
* @example PO-2024-001
*/
referenceNo?: string;
/**
* @description The ID of the vendor
* @example 1001
*/
vendorId: number;
/**
* @description The exchange rate for currency conversion
* @example 1.25
*/
exchangeRate?: number;
/**
* @description The currency code
* @example USD
*/
currencyCode?: string;
/**
* @description Additional notes about the bill
* @example Office supplies and equipment for Q2 2024
*/
note?: string;
/**
* @description Whether tax is inclusive in the item rates
* @example false
*/
isInclusiveTax?: boolean;
/** @description The line items of the bill */
entries: components["schemas"]["ItemEntryDto"][];
/**
* @description The ID of the warehouse
* @example 101
*/
warehouseId?: number;
/**
* @description The ID of the branch
* @example 201
*/
branchId?: number;
/** @description Branch details */
branch?: components["schemas"]["BranchResponseDto"];
/**
* @description The ID of the project
* @example 301
*/
projectId?: number;
/** @description The attachments of the bill */
attachments?: components["schemas"]["AttachmentLinkDto"][];
/**
* @description The discount value
* @example 100
*/
discount?: number;
/**
* @description The type of discount (percentage or fixed)
* @example amount
* @enum {string}
*/
discountType?: "percentage" | "amount";
/**
* @description The adjustment amount
* @example 50
*/
adjustment?: number;
/**
* @description The total amount of tax withheld
* @example 50
*/
taxAmountWithheld?: number;
/**
* @description The balance of the bill
* @example 1000
*/
balance: number;
/**
* @description The amount paid
* @example 500
*/
paymentAmount: number;
/**
* @description The amount credited
* @example 0
*/
creditedAmount?: number;
/**
* @description The subtotal amount before tax and adjustments
* @example 900
*/
subtotal: number;
/**
* @description The total amount including tax and adjustments
* @example 1000
*/
total: number;
/**
* @description The due amount remaining to be paid
* @example 500
*/
dueAmount: number;
/**
* @description Whether the bill is overdue
* @example false
*/
isOverdue: boolean;
/**
* @description Whether the bill is partially paid
* @example true
*/
isPartiallyPaid: boolean;
/**
* @description Whether the bill is fully paid
* @example false
*/
isFullyPaid: boolean;
/**
* Format: date-time
* @description The date when the bill was created
* @example 2024-03-15T00:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @description The date when the bill was last updated
* @example 2024-03-16T00:00:00Z
*/
updatedAt?: string;
};
BillEntryDto: {
/**
* @description The index of the item entry
* @example 1
*/
index: number;
/**
* @description The id of the item
* @example 1
*/
itemId: number;
/**
* @description The rate of the item entry
* @example 1
*/
rate: number;
/**
* @description The quantity of the item entry
* @example 1
*/
quantity: number;
/**
* @description The discount of the item entry
* @example 1
*/
discount: number;
/**
* @description The type of the discount
* @example percentage
*/
discountType: string;
/**
* @description The description of the item entry
* @example This is a description
*/
description: string;
/**
* @description The tax code of the item entry
* @example 123456
*/
taxCode: string;
/**
* @description The tax rate id of the item entry
* @example 1
*/
taxRateId: number;
/**
* @description The warehouse id of the item entry
* @example 1
*/
warehouseId: number;
/**
* @description The project id of the item entry
* @example 1
*/
projectId: number;
/**
* @description The project ref id of the item entry
* @example 1
*/
projectRefId: number;
/**
* @description The project ref type of the item entry
* @example TASK
*/
projectRefType: string;
/**
* @description The project ref invoiced amount of the item entry
* @example 100
*/
projectRefInvoicedAmount: number;
/**
* @description The sell account id of the item entry
* @example 1020
*/
sellAccountId: number;
/**
* @description The cost account id of the item entry
* @example 1021
*/
costAccountId: number;
/**
* @description Flag indicating whether the entry contributes to landed cost
* @example true
*/
landedCost?: boolean;
};
AttachmentDto: {
/**
* @description Storage key of the attachment file
* @example attachments/bills/receipt.pdf
*/
key: string;
};
CreateBillDto: {
/**
* @description Unique bill number
* @example BILL-2024-001
*/
billNumber?: string;
/**
* @description Reference number
* @example PO-2024-001
*/
referenceNo?: string;
/**
* Format: date-time
* @description Date the bill was issued
* @example 2024-03-15
*/
billDate: string;
/**
* Format: date-time
* @description Date the bill is due
* @example 2024-04-15
*/
dueDate?: string;
/**
* @description Vendor identifier
* @example 1001
*/
vendorId: number;
/**
* @description Exchange rate applied to bill amounts
* @example 1.25
*/
exchangeRate?: number;
/**
* @description Warehouse identifier
* @example 101
*/
warehouseId?: number;
/**
* @description Branch identifier
* @example 201
*/
branchId?: number;
/**
* @description Project identifier
* @example 301
*/
projectId?: number;
/**
* @description Additional notes about the bill
* @example Office supplies and equipment for Q2 2024
*/
note?: string;
/**
* @description Indicates if the bill is open
* @example true
*/
open?: boolean;
/**
* @description Indicates if tax is inclusive in prices
* @example false
*/
isInclusiveTax?: boolean;
/** @description Bill line items */
entries: components["schemas"]["BillEntryDto"][];
/** @description File attachments associated with the bill */
attachments?: components["schemas"]["AttachmentDto"][];
/**
* @description Type of discount applied
* @example amount
* @enum {string}
*/
discountType?: "percentage" | "amount";
/**
* @description Discount value
* @example 100
*/
discount?: number;
/**
* @description Adjustment value
* @example 50
*/
adjustment?: number;
};
EditBillDto: {
/**
* @description Unique bill number
* @example BILL-2024-001
*/
billNumber?: string;
/**
* @description Reference number
* @example PO-2024-001
*/
referenceNo?: string;
/**
* Format: date-time
* @description Date the bill was issued
* @example 2024-03-15
*/
billDate: string;
/**
* Format: date-time
* @description Date the bill is due
* @example 2024-04-15
*/
dueDate?: string;
/**
* @description Vendor identifier
* @example 1001
*/
vendorId: number;
/**
* @description Exchange rate applied to bill amounts
* @example 1.25
*/
exchangeRate?: number;
/**
* @description Warehouse identifier
* @example 101
*/
warehouseId?: number;
/**
* @description Branch identifier
* @example 201
*/
branchId?: number;
/**
* @description Project identifier
* @example 301
*/
projectId?: number;
/**
* @description Additional notes about the bill
* @example Office supplies and equipment for Q2 2024
*/
note?: string;
/**
* @description Indicates if the bill is open
* @example true
*/
open?: boolean;
/**
* @description Indicates if tax is inclusive in prices
* @example false
*/
isInclusiveTax?: boolean;
/** @description Bill line items */
entries: components["schemas"]["BillEntryDto"][];
/** @description File attachments associated with the bill */
attachments?: components["schemas"]["AttachmentDto"][];
/**
* @description Type of discount applied
* @example amount
* @enum {string}
*/
discountType?: "percentage" | "amount";
/**
* @description Discount value
* @example 100
*/
discount?: number;
/**
* @description Adjustment value
* @example 50
*/
adjustment?: number;
};
AllocateBillLandedCostDto: Record<string, never>;
ManualJournalEntryResponseDto: {
/**
* @description Entry index
* @example 1
*/
index: number;
/**
* @description Credit amount
* @example 1000
*/
credit?: number;
/**
* @description Debit amount
* @example 0
*/
debit?: number;
/**
* @description Account ID
* @example 1
*/
accountId: number;
/**
* @description Entry note
* @example Payment for services
*/
note?: string;
/**
* @description Contact ID
* @example 1
*/
contactId?: number;
/**
* @description Branch ID
* @example 1
*/
branchId?: number;
/**
* @description Project ID
* @example 1
*/
projectId?: number;
/** @description Account details */
account?: Record<string, never>;
/** @description Contact details */
contact?: Record<string, never>;
/** @description Branch details */
branch?: Record<string, never>;
};
ManualJournalResponseDto: {
/**
* @description Manual Journal ID
* @example 1
*/
id: number;
/**
* Format: date-time
* @description Journal date
* @example 2024-03-20
*/
date: string;
/**
* @description Journal number
* @example MJ-2024-001
*/
journalNumber: string;
/**
* @description Journal type
* @example General
*/
journalType?: string;
/**
* @description Reference number
* @example REF-001
*/
reference?: string;
/**
* @description Total amount
* @example 1000
*/
amount: number;
/**
* @description Currency code
* @example USD
*/
currencyCode?: string;
/**
* @description Exchange rate
* @example 1
*/
exchangeRate?: number;
/**
* @description Description
* @example Monthly journal entry
*/
description?: string;
/**
* @description Published status
* @example false
*/
isPublished: boolean;
/**
* Format: date-time
* @description Published date
* @example 2024-03-20T10:00:00Z
*/
publishedAt?: string;
/**
* Format: date-time
* @description Created date
* @example 2024-03-20T09:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @description Updated date
* @example 2024-03-20T09:30:00Z
*/
updatedAt?: string;
/**
* @description Branch ID
* @example 1
*/
branchId?: number;
/**
* @description Formatted amount
* @example $1,000.00
*/
formattedAmount: string;
/**
* @description Formatted date
* @example Mar 20, 2024
*/
formattedDate: string;
/**
* @description Formatted published date
* @example Mar 20, 2024
*/
formattedPublishedAt?: string;
/**
* @description Formatted created date
* @example Mar 20, 2024
*/
formattedCreatedAt: string;
/** @description Journal entries */
entries: components["schemas"]["ManualJournalEntryResponseDto"][];
/** @description Attachments */
attachments?: string[];
};
ManualJournalEntryDto: {
/** @description Entry index */
index: number;
/** @description Credit amount */
credit?: number;
/** @description Debit amount */
debit?: number;
/** @description Account ID */
accountId: number;
/** @description Entry note */
note?: string;
/** @description Contact ID */
contactId?: number;
/** @description Branch ID */
branchId?: number;
/** @description Project ID */
projectId?: number;
};
CreateManualJournalDto: {
/**
* Format: date-time
* @description Journal date
*/
date: string;
/** @description Currency code */
currencyCode?: string;
/** @description Exchange rate */
exchangeRate?: number;
/** @description Journal number */
journalNumber?: string;
/** @description Journal type */
journalType?: string;
/** @description Reference */
reference?: string;
/** @description Description */
description?: string;
/** @description Branch ID */
branchId?: number;
/** @description Publish status */
publish?: boolean;
/** @description Journal entries */
entries: components["schemas"]["ManualJournalEntryDto"][];
/** @description Attachments */
attachments?: components["schemas"]["AttachmentDto"][];
};
EditManualJournalDto: {
/**
* Format: date-time
* @description Journal date
*/
date: string;
/** @description Currency code */
currencyCode?: string;
/** @description Exchange rate */
exchangeRate?: number;
/** @description Journal number */
journalNumber?: string;
/** @description Journal type */
journalType?: string;
/** @description Reference */
reference?: string;
/** @description Description */
description?: string;
/** @description Branch ID */
branchId?: number;
/** @description Publish status */
publish?: boolean;
/** @description Journal entries */
entries: components["schemas"]["ManualJournalEntryDto"][];
/** @description Attachments */
attachments?: components["schemas"]["AttachmentDto"][];
};
CreditNoteResponseDto: {
/**
* @description The unique identifier of the credit note
* @example 1
*/
id: number;
/**
* Format: date-time
* @description The date of the credit note
* @example 2023-01-01T00:00:00Z
*/
creditNoteDate: string;
/**
* @description The credit note number
* @example CN-001
*/
creditNoteNumber: string;
/**
* @description The reference number
* @example REF-001
*/
referenceNo?: string;
/**
* @description The ID of the customer
* @example 1
*/
customerId: number;
/**
* @description The exchange rate for currency conversion
* @example 1
*/
exchangeRate?: number;
/**
* @description The currency code
* @example USD
*/
currencyCode?: string;
/**
* @description Custom note on the credit note
* @example Thank you for your business
*/
note?: string;
/**
* @description Terms and conditions of the credit note
* @example Valid for 30 days
*/
termsConditions?: string;
/**
* @description Whether the credit note is open
* @example true
*/
isOpen: boolean;
/**
* @description Whether the credit note is closed
* @example false
*/
isClosed: boolean;
/** @description The line items of the credit note */
entries: components["schemas"]["ItemEntryDto"][];
/**
* @description The ID of the warehouse
* @example 1
*/
warehouseId?: number;
/**
* @description The ID of the branch
* @example 1
*/
branchId?: number;
/** @description The attachments of the credit note */
attachments?: components["schemas"]["AttachmentLinkDto"][];
/**
* @description The discount value
* @example 10
*/
discount?: number;
/**
* @description The type of discount (percentage or fixed)
* @example percentage
* @enum {string}
*/
discountType?: "percentage" | "amount";
/**
* @description The adjustment amount
* @example 5
*/
adjustment?: number;
/**
* @description The ID of the PDF template
* @example 1
*/
pdfTemplateId?: number;
/**
* @description The total amount of credits remaining
* @example 100
*/
creditsRemaining?: number;
/**
* @description The total amount of credits used
* @example 50
*/
creditsUsed?: number;
/**
* @description The subtotal amount before discount and adjustments
* @example 900
*/
subtotal: number;
/**
* @description The subtotal amount in local currency
* @example 900
*/
subtotalLocal?: number;
/**
* @description The discount amount
* @example 10
*/
discountAmount?: number;
/**
* @description The discount amount in local currency
* @example 10
*/
discountAmountLocal?: number;
/**
* @description The discount percentage
* @example 10
*/
discountPercentage?: number;
/**
* @description The adjustment amount in local currency
* @example 5
*/
adjustmentLocal?: number;
/**
* @description The total amount after discount and adjustments
* @example 1000
*/
total: number;
/**
* @description The total amount in local currency
* @example 1000
*/
totalLocal?: number;
/**
* Format: date-time
* @description The date when the credit note was created
* @example 2023-01-01T00:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @description The date when the credit note was last updated
* @example 2023-01-02T00:00:00Z
*/
updatedAt?: string;
/**
* @description Formatted credit note date
* @example 2023-01-01
*/
formattedCreditNoteDate: string;
/**
* @description Formatted created at date
* @example 2023-01-01
*/
formattedCreatedAt: string;
/**
* @description Formatted amount
* @example $1,000.00
*/
formattedAmount: string;
/**
* @description Formatted credits remaining
* @example $100.00
*/
formattedCreditsRemaining: string;
/**
* @description Formatted credits used
* @example $50.00
*/
formattedCreditsUsed: string;
/**
* @description Formatted subtotal
* @example $900.00
*/
formattedSubtotal: string;
/**
* @description Formatted discount amount
* @example $10.00
*/
discountAmountFormatted: string;
/**
* @description Formatted discount amount in local currency
* @example $10.00
*/
discountAmountLocalFormatted: string;
/**
* @description Formatted discount percentage
* @example 10%
*/
discountPercentageFormatted: string;
/**
* @description Formatted adjustment
* @example $5.00
*/
adjustmentFormatted: string;
/**
* @description Formatted adjustment in local currency
* @example $5.00
*/
adjustmentLocalFormatted: string;
/**
* @description Formatted total
* @example $1,000.00
*/
totalFormatted: string;
/**
* @description Formatted total in local currency
* @example $1,000.00
*/
totalLocalFormatted: string;
};
CreateCreditNoteDto: {
/**
* @description The customer ID
* @example 1
*/
customerId: number;
/**
* @description The exchange rate
* @example 3.43
*/
exchangeRate: number;
/**
* Format: date-time
* @description The credit note date
* @example 2021-09-01
*/
creditNoteDate: string;
/**
* @description The reference number
* @example 123
*/
referenceNo: string;
/**
* @description The credit note number
* @example 123
*/
creditNoteNumber: string;
/**
* @description The note
* @example 123
*/
note: string;
/**
* @description The terms and conditions
* @example 123
*/
termsConditions: string;
/**
* @description The credit note is open
* @example false
*/
open: boolean;
/**
* @description The warehouse ID
* @example 1
*/
warehouseId: number;
/**
* @description The branch ID
* @example 1
*/
branchId: number;
/**
* @description The credit note entries
* @example [
* {
* "itemId": 1,
* "quantity": 1,
* "rate": 10,
* "taxRateId": 1
* }
* ]
*/
entries: string[];
/**
* @description The pdf template ID
* @example 1
*/
pdfTemplateId: number;
/**
* @description The discount amount
* @example 10
*/
discount: number;
/**
* @description The discount type
* @example percentage
* @enum {string}
*/
discountType: "percentage" | "amount";
};
CreditNoteStateResponseDto: {
/**
* @description Default PDF template ID for credit notes
* @example 1
*/
defaultTemplateId: number;
};
EditCreditNoteDto: {
/**
* @description The customer ID
* @example 1
*/
customerId: number;
/**
* @description The exchange rate
* @example 3.43
*/
exchangeRate: number;
/**
* Format: date-time
* @description The credit note date
* @example 2021-09-01
*/
creditNoteDate: string;
/**
* @description The reference number
* @example 123
*/
referenceNo: string;
/**
* @description The credit note number
* @example 123
*/
creditNoteNumber: string;
/**
* @description The note
* @example 123
*/
note: string;
/**
* @description The terms and conditions
* @example 123
*/
termsConditions: string;
/**
* @description The credit note is open
* @example false
*/
open: boolean;
/**
* @description The warehouse ID
* @example 1
*/
warehouseId: number;
/**
* @description The branch ID
* @example 1
*/
branchId: number;
/**
* @description The credit note entries
* @example [
* {
* "itemId": 1,
* "quantity": 1,
* "rate": 10,
* "taxRateId": 1
* }
* ]
*/
entries: string[];
/**
* @description The pdf template ID
* @example 1
*/
pdfTemplateId: number;
/**
* @description The discount amount
* @example 10
*/
discount: number;
/**
* @description The discount type
* @example percentage
* @enum {string}
*/
discountType: "percentage" | "amount";
};
RefundCreditAccountDto: {
/** @example 10 */
id: number;
/** @example Cash on Hand */
name: string;
};
RefundCreditNoteSummaryDto: {
/** @example 1 */
id: number;
/** @example CN-0001 */
creditNoteNumber: string;
};
RefundCreditNoteResponseDto: {
/** @example 100 */
id: number;
/** @example 2024-01-15 */
date: string;
/** @example 2024-01-15 */
formattedDate: string;
/** @example 250 */
amount: number;
/** @example $250.00 */
formttedAmount: string;
/** @example REF-001 */
referenceNo?: string | null;
/** @example Refund issued to customer */
description?: string | null;
fromAccount: components["schemas"]["RefundCreditAccountDto"];
creditNote: components["schemas"]["RefundCreditNoteSummaryDto"];
};
CreditNoteRefundDto: {
/**
* @description The id of the from account
* @example 1
*/
fromAccountId: number;
/**
* @description The amount of the credit note refund
* @example 100
*/
amount: number;
/**
* @description The exchange rate of the credit note refund
* @example 1
*/
exchangeRate: number;
/**
* @description The reference number of the credit note refund
* @example 123456
*/
referenceNo: string;
/**
* @description The description of the credit note refund
* @example Credit note refund
*/
description: string;
/**
* Format: date-time
* @description The date of the credit note refund
* @example 2021-01-01
*/
date: string;
/**
* @description The id of the branch
* @example 1
*/
branchId: number;
};
AppliedCreditNoteInvoiceResponseDto: {
/** @example 1 */
id: number;
/** @example 200 */
amount: number;
/** @example $200.00 */
formttedAmount: string;
/** @example CN-0001 */
creditNoteNumber: string;
/** @example 2024-01-10 */
creditNoteDate: string;
/** @example 2024-01-10 */
formattedCreditNoteDate: string;
/** @example INV-0001 */
invoiceNumber: string;
/** @example REF-001 */
invoiceReferenceNo?: string | null;
};
CreditNoteInvoiceToApplyResponseDto: {
/** @example 1 */
id: number;
/** @example INV-0001 */
invoiceNo: string;
/** @example REF-001 */
referenceNo?: string | null;
/** @example 2024-01-10 */
invoiceDate: string;
/** @example 2024-01-20 */
dueDate: string;
/** @example USD */
currencyCode?: string | null;
/** @example 500 */
balance: number;
/** @example 500 */
dueAmount: number;
/** @example 0 */
paymentAmount: number;
/** @example 2024-01-10 */
formattedInvoiceDate: string;
/** @example 2024-01-20 */
formattedDueDate: string;
/** @example $500.00 */
formatted_amount: string;
/** @example $500.00 */
formattedDueAmount: string;
/** @example $0.00 */
formattedPaymentAmount: string;
};
ApplyCreditNoteInvoiceEntryDto: {
/**
* @description Invoice ID to apply credit to
* @example 1
*/
invoiceId: number;
/**
* @description Amount to apply
* @example 100.5
*/
amount: number;
};
ApplyCreditNoteToInvoicesDto: {
/**
* @description Entries of invoice ID and amount to apply
* @example [
* {
* "invoice_id": 1,
* "amount": 100.5
* },
* {
* "invoice_id": 2,
* "amount": 50
* }
* ]
*/
entries: components["schemas"]["ApplyCreditNoteInvoiceEntryDto"][];
};
CreateVendorCreditDto: {
/**
* @description The id of the vendor
* @example 1
*/
vendorId: number;
/**
* @description The exchange rate of the vendor credit
* @example 1
*/
exchangeRate: number;
/**
* @description The vendor credit number
* @example 123456
*/
vendorCreditNumber: string;
/**
* @description The reference number of the vendor credit
* @example 123456
*/
referenceNo: string;
/**
* @description The date of the vendor credit
* @example 2021-01-01
*/
vendorCreditDate: string;
/**
* @description The note of the vendor credit
* @example 123456
*/
note: string;
/**
* @description The open status of the vendor credit
* @example true
*/
open: boolean;
/**
* @description The warehouse id of the vendor credit
* @example 1
*/
warehouseId: number;
/**
* @description The branch id of the vendor credit
* @example 1
*/
branchId: number;
/**
* @description The entries of the vendor credit
* @example [
* {
* "itemId": 1,
* "quantity": 1,
* "unitPrice": 1,
* "discount": 1,
* "discountType": "percentage",
* "accountId": 1,
* "amount": 1
* }
* ]
*/
entries: string[];
/**
* @description The attachments of the vendor credit
* @example [
* {
* "key": "123456"
* }
* ]
*/
attachments: string[];
/**
* @description The discount of the vendor credit
* @example 1
*/
discount: number;
/**
* @description The discount type of the vendor credit
* @example percentage
*/
discountType: string;
/**
* @description The adjustment of the vendor credit
* @example 1
*/
adjustment: number;
};
EditVendorCreditDto: {
/**
* @description The id of the vendor
* @example 1
*/
vendorId: number;
/**
* @description The exchange rate of the vendor credit
* @example 1
*/
exchangeRate: number;
/**
* @description The vendor credit number
* @example 123456
*/
vendorCreditNumber: string;
/**
* @description The reference number of the vendor credit
* @example 123456
*/
referenceNo: string;
/**
* @description The date of the vendor credit
* @example 2021-01-01
*/
vendorCreditDate: string;
/**
* @description The note of the vendor credit
* @example 123456
*/
note: string;
/**
* @description The open status of the vendor credit
* @example true
*/
open: boolean;
/**
* @description The warehouse id of the vendor credit
* @example 1
*/
warehouseId: number;
/**
* @description The branch id of the vendor credit
* @example 1
*/
branchId: number;
/**
* @description The entries of the vendor credit
* @example [
* {
* "itemId": 1,
* "quantity": 1,
* "unitPrice": 1,
* "discount": 1,
* "discountType": "percentage",
* "accountId": 1,
* "amount": 1
* }
* ]
*/
entries: string[];
/**
* @description The attachments of the vendor credit
* @example [
* {
* "key": "123456"
* }
* ]
*/
attachments: string[];
/**
* @description The discount of the vendor credit
* @example 1
*/
discount: number;
/**
* @description The discount type of the vendor credit
* @example percentage
*/
discountType: string;
/**
* @description The adjustment of the vendor credit
* @example 1
*/
adjustment: number;
};
ApplyVendorCreditToBillEntryDto: {
/**
* @description Bill ID to apply vendor credit to
* @example 1
*/
billId: number;
/**
* @description Amount to apply
* @example 100.5
*/
amount: number;
};
ApplyVendorCreditToBillsDto: {
/**
* @description Entries of bill ID and amount to apply
* @example [
* {
* "billId": 1,
* "amount": 100.5
* },
* {
* "billId": 2,
* "amount": 50
* }
* ]
*/
entries: components["schemas"]["ApplyVendorCreditToBillEntryDto"][];
};
BillPaymentEntryResponseDto: {
/**
* @description The payment amount formatted
* @example 100.00
*/
paymentAmountFormatted: string;
/** @description The bill details */
bill: components["schemas"]["BillResponseDto"];
};
BillPaymentResponseDto: {
/**
* @description The unique identifier of the bill payment
* @example 1
*/
id: number;
/**
* @description The vendor ID
* @example 1
*/
vendorId: number;
/**
* @description The amount paid
* @example 100
*/
amount: number;
/**
* @description The currency code
* @example USD
*/
currencyCode?: string;
/**
* @description The payment account ID
* @example 2
*/
paymentAccountId: number;
/**
* @description The payment number
* @example PAY-2024-001
*/
paymentNumber?: string;
/**
* @description The payment date
* @example 2024-01-01
*/
paymentDate: string;
/**
* @description The formatted payment date
* @example 2024-01-01
*/
formattedPaymentDate: string;
/**
* @description The exchange rate
* @example 1
*/
exchangeRate?: number;
/**
* @description Statement or note
* @example Payment for January bills
*/
statement?: string;
/**
* @description Reference number
* @example REF-123
*/
reference?: string;
/**
* @description The branch ID
* @example 1
*/
branchId?: number;
/**
* @description The formatted amount
* @example 100.00 USD
*/
formattedAmount: string;
/**
* @description The formatted total
* @example 100.00 USD
*/
formattedTotal: string;
/**
* @description The formatted subtotal
* @example 100.00 USD
*/
formattedSubtotal: string;
/**
* Format: date-time
* @description The date when the payment was created
* @example 2024-01-01T12:00:00Z
*/
createdAt: string;
/**
* @description The formatted created at date
* @example 2024-01-01
*/
formattedCreatedAt: string;
/**
* Format: date-time
* @description The date when the payment was last updated
* @example 2024-01-02T12:00:00Z
*/
updatedAt?: string;
/** @description The entries of the bill payment */
entries: components["schemas"]["BillPaymentEntryResponseDto"][];
/** @description The attachments of the bill payment */
attachments?: components["schemas"]["AttachmentLinkDto"][];
};
CreateBillPaymentDto: {
/**
* @description The id of the vendor
* @example 1
*/
vendorId: number;
/**
* @description The amount of the bill payment
* @example 100
*/
amount: number;
/**
* @description The id of the payment account
* @example 1
*/
paymentAccountId: number;
/**
* @description The payment number of the bill payment
* @example 123456
*/
paymentNumber: string;
/**
* @description The payment date of the bill payment
* @example 2021-01-01
*/
paymentDate: Record<string, never>;
/**
* @description The exchange rate of the bill payment
* @example 1
*/
exchangeRate: number;
/**
* @description The statement of the bill payment
* @example 123456
*/
statement: string;
/**
* @description The entries of the bill payment
* @example [
* {
* "billId": 1,
* "paymentAmount": 100
* }
* ]
*/
entries: string[];
/**
* @description The id of the branch
* @example 1
*/
branchId: number;
/**
* @description The attachments of the bill payment
* @example [
* {
* "id": 1,
* "type": "bill"
* }
* ]
*/
attachments: string[];
};
EditBillPaymentDto: {
/**
* @description The id of the vendor
* @example 1
*/
vendorId: number;
/**
* @description The amount of the bill payment
* @example 100
*/
amount: number;
/**
* @description The id of the payment account
* @example 1
*/
paymentAccountId: number;
/**
* @description The payment number of the bill payment
* @example 123456
*/
paymentNumber: string;
/**
* @description The payment date of the bill payment
* @example 2021-01-01
*/
paymentDate: Record<string, never>;
/**
* @description The exchange rate of the bill payment
* @example 1
*/
exchangeRate: number;
/**
* @description The statement of the bill payment
* @example 123456
*/
statement: string;
/**
* @description The entries of the bill payment
* @example [
* {
* "billId": 1,
* "paymentAmount": 100
* }
* ]
*/
entries: string[];
/**
* @description The id of the branch
* @example 1
*/
branchId: number;
/**
* @description The attachments of the bill payment
* @example [
* {
* "id": 1,
* "type": "bill"
* }
* ]
*/
attachments: string[];
};
RefundVendorCreditDto: {
/**
* @description The amount of the refund
* @example 100
*/
amount: number;
/**
* @description The exchange rate of the refund
* @example 1
*/
exchangeRate: number;
/**
* @description The id of the deposit account
* @example 1
*/
depositAccountId: number;
/**
* @description The description of the refund
* @example Refund for vendor credit
*/
description: string;
/**
* Format: date-time
* @description The date of the refund
* @example 2021-01-01
*/
date: string;
/**
* @description The id of the branch
* @example 1
*/
branchId: number;
};
BankAccountResponseDto: {
/**
* @description The unique identifier of the account
* @example 1
*/
id: number;
/**
* @description The name of the account
* @example Cash Account
*/
name: string;
/**
* @description The slug of the account
* @example cash-account
*/
slug: string;
/**
* @description The code of the account
* @example 1001
*/
code: string;
/**
* @description The type of the account
* @example bank
*/
accountType: string;
/**
* @description The parent account ID
* @example null
*/
parentAccountId: number;
/**
* @description The currency code of the account
* @example USD
*/
currencyCode: string;
/**
* @description Whether the account is active
* @example true
*/
active: boolean;
/**
* @description The bank balance of the account
* @example 5000
*/
bankBalance: number;
/**
* @description The formatted bank balance
* @example $5,000.00
*/
bankBalanceFormatted: string;
/**
* @description The last feeds update timestamp
* @example 2024-03-20T10:30:00Z
*/
lastFeedsUpdatedAt: Record<string, never>;
/**
* @description The formatted last feeds update timestamp
* @example Mar 20, 2024 10:30 AM
*/
lastFeedsUpdatedAtFormatted: string;
/**
* @description The last feeds updated from now (relative time)
* @example 2 hours ago
*/
lastFeedsUpdatedFromNow: string;
/**
* @description The amount of the account
* @example 5000
*/
amount: number;
/**
* @description The formatted amount
* @example $5,000.00
*/
formattedAmount: string;
/**
* @description The Plaid item ID
* @example plaid-item-123
*/
plaidItemId: string;
/**
* @description The Plaid account ID
* @example plaid-account-456
*/
plaidAccountId: string;
/**
* @description Whether the feeds are active
* @example true
*/
isFeedsActive: boolean;
/**
* @description Whether the account is syncing owner
* @example true
*/
isSyncingOwner: boolean;
/**
* @description Whether the feeds are paused
* @example false
*/
isFeedsPaused: boolean;
/**
* @description The account normal
* @example debit
*/
accountNormal: string;
/**
* @description The formatted account normal
* @example Debit
*/
accountNormalFormatted: string;
/**
* @description The flatten name with all dependant accounts names
* @example Assets: Cash Account
*/
flattenName: string;
/**
* @description The account level in the hierarchy
* @example 2
*/
accountLevel: number;
/**
* Format: date-time
* @description The creation timestamp
* @example 2024-03-20T10:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @description The update timestamp
* @example 2024-03-20T10:30:00Z
*/
updatedAt: string;
};
PlaidItemDto: {
/**
* @description The public token
* @example 123
*/
publicToken: string;
/**
* @description The institution ID
* @example 123
*/
institutionId: string;
};
PlaidWebhookDto: {
/**
* @description The Plaid item ID
* @example 123
*/
itemId: string;
/**
* @description The Plaid webhook type
* @example 123
*/
webhookType: string;
/**
* @description The Plaid webhook code
* @example 123
*/
webhookCode: string;
};
CategorizeBankTransactionRouteDto: {
/**
* Format: date-time
* @description The date of the bank transaction
* @example 2023-01-01T00:00:00.000Z
*/
date: string;
/**
* @description ID of the credit account associated with this transaction
* @example 1001
*/
creditAccountId: number;
/**
* @description Optional external reference number
* @example REF-001
*/
referenceNo?: string;
/**
* @description Optional transaction number or reference
* @example TRX-001
*/
transactionNumber?: string;
/**
* @description Type of bank transaction (e.g., deposit, withdrawal)
* @example deposit
*/
transactionType: string;
/**
* @description Exchange rate for currency conversion
* @default 1
* @example 1.15
*/
exchangeRate: number;
/**
* @description Currency code for the transaction
* @example USD
*/
currencyCode?: string;
/**
* @description Description of the bank transaction
* @example Monthly rent payment
*/
description?: string;
/**
* @description ID of the branch where the transaction occurred
* @example 101
*/
branchId?: number;
/**
* @description Array of uncategorized transaction IDs to be categorized
* @example [
* 1001,
* 1002,
* 1003
* ]
*/
uncategorizedTransactionIds: number[];
};
BankTransactionResponseDto: {
/**
* @description The withdrawal amount
* @example 1000.5
*/
withdrawal: number;
/**
* @description The deposit amount
* @example 2000.75
*/
deposit: number;
/**
* @description The running balance after the transaction
* @example 3000.25
*/
runningBalance: number;
/**
* @description Formatted withdrawal amount with currency symbol
* @example $1,000.50
*/
formattedWithdrawal: string;
/**
* @description Formatted deposit amount with currency symbol
* @example $2,000.75
*/
formattedDeposit: string;
/**
* @description Formatted running balance with currency symbol
* @example $3,000.25
*/
formattedRunningBalance: string;
/**
* @description Unique transaction number
* @example TRX-2024-001
*/
transactionNumber: string;
/**
* @description Reference number for the transaction
* @example REF-2024-001
*/
referenceNumber: string;
/**
* @description ID of the reference entity
* @example 12345
*/
referenceId: number;
/**
* @description Type of the reference entity
* @example INVOICE
*/
referenceType: string;
/**
* @description Formatted transaction type
* @example Bank Transfer
*/
formattedTransactionType: string;
/**
* @description Current balance
* @example 5000
*/
balance: number;
/**
* @description Formatted balance with currency symbol
* @example $5,000.00
*/
formattedBalance: string;
/**
* Format: date-time
* @description Transaction date
* @example 2024-03-20T10:30:00Z
*/
date: string;
/**
* @description Formatted transaction date
* @example March 20, 2024
*/
formattedDate: string;
/**
* @description Transaction status
* @example COMPLETED
*/
status: string;
/**
* @description Formatted transaction status
* @example Completed
*/
formattedStatus: string;
/**
* @description ID of the uncategorized transaction
* @example 67890
*/
uncategorizedTransactionId: number;
};
CreateBankTransactionDto: {
/**
* Format: date-time
* @description The date of the bank transaction
* @example 2023-01-01T00:00:00.000Z
*/
date: string;
/**
* @description Optional transaction number or reference
* @example TRX-001
*/
transactionNumber?: string;
/**
* @description Optional external reference number
* @example REF-001
*/
referenceNo?: string;
/**
* @description Type of bank transaction (e.g., deposit, withdrawal)
* @example deposit
*/
transactionType: string;
/**
* @description Description of the bank transaction
* @example Monthly rent payment
*/
description: string;
/**
* @description Transaction amount
* @example 1000.5
*/
amount: number;
/**
* @description Exchange rate for currency conversion
* @default 1
* @example 1.15
*/
exchangeRate: number;
/**
* @description Currency code for the transaction
* @example USD
*/
currencyCode?: string;
/**
* @description ID of the credit account associated with this transaction
* @example 1001
*/
creditAccountId: number;
/**
* @description ID of the cashflow account associated with this transaction
* @example 2001
*/
cashflowAccountId: number;
/**
* @description Whether the transaction should be published
* @default true
*/
publish: boolean;
/**
* @description ID of the branch where the transaction occurred
* @example 101
*/
branchId?: number;
/**
* @description Plaid transaction ID if imported from Plaid
* @example plaid_trx_12345
*/
plaidTransactionId?: string;
/**
* @description Plaid account ID if imported from Plaid
* @example plaid_acc_67890
*/
plaidAccountId?: string;
/**
* @description ID of the uncategorized transaction if this is categorizing an existing transaction
* @example 5001
*/
uncategorizedTransactionId?: number;
};
GetAutofillCategorizeTransactionResponseDto: {
/**
* @description Assigned credit/debit account ID from recognition
* @example 10
*/
creditAccountId?: number;
/**
* @description Bank account ID (debit)
* @example 5
*/
debitAccountId?: number;
/**
* @description Total amount of uncategorized transactions
* @example -150.5
*/
amount: number;
/**
* @description Formatted amount
* @example $150.50
*/
formattedAmount: string;
/**
* @description Transaction date
* @example 2024-01-15
*/
date: string;
/**
* @description Formatted date
* @example Jan 15, 2024
*/
formattedDate: string;
/**
* @description Whether the transaction is recognized by a rule
* @example true
*/
isRecognized: boolean;
/**
* @description Bank rule ID that recognized the transaction
* @example 1
*/
recognizedByRuleId?: number;
/**
* @description Bank rule name that recognized the transaction
* @example Salary Rule
*/
recognizedByRuleName?: string;
/**
* @description Reference number
* @example REF-001
*/
referenceNo?: string;
/**
* @description Transaction type (category)
* @example other_expense
*/
transactionType: string;
/**
* @description Whether this is a deposit transaction
* @example false
*/
isDepositTransaction: boolean;
/**
* @description Whether this is a withdrawal transaction
* @example true
*/
isWithdrawalTransaction: boolean;
/** @description Assigned payee from recognition */
payee?: string;
/** @description Assigned memo from recognition */
memo?: string;
};
GetPendingTransactionResponseDto: {
/** @description Transaction amount */
amount: number;
/** @description Transaction date */
date: Record<string, never>;
/** @description Bank account ID */
accountId: number;
/** @description Transaction reference number */
referenceNo?: string;
/** @description Payee */
payee?: string;
/** @description Transaction description */
description?: string;
/** @description Plaid transaction ID */
plaidTransactionId?: string;
/** @description Recognized transaction ID */
recognizedTransactionId?: number;
/** @description Is transaction pending? */
pending: boolean;
/** @description Transaction currency code */
currencyCode: string;
/** @description Withdrawal amount */
withdrawal: number;
/** @description Deposit amount */
deposit: number;
/** @description Is deposit transaction? */
isDepositTransaction: boolean;
/** @description Is withdrawal transaction? */
isWithdrawalTransaction: boolean;
/** @description Formatted amount */
formattedAmount: string;
/** @description Formatted date */
formattedDate: string;
/** @description Formatted deposit amount */
formattedDepositAmount: string;
/** @description Formatted withdrawal amount */
formattedWithdrawalAmount: string;
};
BankRuleConditionResponseDto: {
/**
* @description The unique identifier of the bank rule condition
* @example 1
*/
id: number;
/**
* @description The field to check in the condition
* @example description
* @enum {string}
*/
field: "description" | "amount";
/**
* @description The comparison operator to use
* @example contains
* @enum {string}
*/
comparator: "equals" | "equal" | "contains" | "not_contain" | "bigger" | "bigger_or_equal" | "smaller" | "smaller_or_equal";
/**
* @description The value to compare against
* @example Salary
*/
value: string;
};
BankRuleResponseDto: {
/**
* @description The unique identifier of the bank rule
* @example 1
*/
id: number;
/**
* @description The name of the bank rule
* @example Monthly Salary
*/
name: string;
/**
* @description The order in which the rule should be applied
* @example 1
*/
order: number;
/**
* @description The account ID to apply the rule if
* @example 1
*/
applyIfAccountId: number;
/**
* @description The transaction type to apply the rule if
* @example deposit
* @enum {string}
*/
applyIfTransactionType: "deposit" | "withdrawal";
/**
* @description The conditions type to apply the rule if
* @example and
* @enum {string}
*/
conditionsType: "and" | "or";
/**
* @description The conditions to apply the rule if
* @example [
* {
* "id": 1,
* "field": "description",
* "comparator": "contains",
* "value": "Salary"
* }
* ]
*/
conditions: components["schemas"]["BankRuleConditionResponseDto"][];
/**
* @description The category to assign the rule if
* @example InterestIncome
* @enum {string}
*/
assignCategory: "InterestIncome" | "OtherIncome" | "Deposit" | "Expense" | "OwnerDrawings";
/**
* @description The account ID to assign the rule if
* @example 1
*/
assignAccountId: number;
/**
* @description The payee to assign the rule if
* @example Employer Inc.
*/
assignPayee?: string;
/**
* @description The memo to assign the rule if
* @example Monthly Salary
*/
assignMemo?: string;
/**
* @description The creation timestamp of the bank rule
* @example 2024-03-20T10:00:00Z
*/
createdAt: string;
/**
* @description The last update timestamp of the bank rule
* @example 2024-03-20T10:00:00Z
*/
updatedAt: string;
};
CreateBankRuleDto: {
/**
* @description The name of the bank rule
* @example Monthly Salary
*/
name: string;
/**
* @description The order of the bank rule
* @example 1
*/
order: number;
/**
* @description The account ID to apply the rule if
* @example 1
*/
applyIfAccountId: number;
/**
* @description The transaction type to apply the rule if
* @example deposit
*/
applyIfTransactionType: string;
/**
* @description The conditions type to apply the rule if
* @example and
*/
conditionsType: string;
/**
* @description The conditions to apply the rule if
* @example [
* {
* "field": "description",
* "comparator": "contains",
* "value": "Salary"
* }
* ]
*/
conditions: string[];
/**
* @description The category to assign the rule if
* @example Income:Salary
*/
assignCategory: string;
/**
* @description The account ID to assign the rule if
* @example 1
*/
assignAccountId: number;
/**
* @description The payee to assign the rule if
* @example Employer Inc.
*/
assignPayee: string;
/**
* @description The memo to assign the rule if
* @example Monthly Salary
*/
assignMemo: string;
};
EditBankRuleDto: {
/**
* @description The name of the bank rule
* @example Monthly Salary
*/
name: string;
/**
* @description The order of the bank rule
* @example 1
*/
order: number;
/**
* @description The account ID to apply the rule if
* @example 1
*/
applyIfAccountId: number;
/**
* @description The transaction type to apply the rule if
* @example deposit
*/
applyIfTransactionType: string;
/**
* @description The conditions type to apply the rule if
* @example and
*/
conditionsType: string;
/**
* @description The conditions to apply the rule if
* @example [
* {
* "field": "description",
* "comparator": "contains",
* "value": "Salary"
* }
* ]
*/
conditions: string[];
/**
* @description The category to assign the rule if
* @example Income:Salary
*/
assignCategory: string;
/**
* @description The account ID to assign the rule if
* @example 1
*/
assignAccountId: number;
/**
* @description The payee to assign the rule if
* @example Employer Inc.
*/
assignPayee: string;
/**
* @description The memo to assign the rule if
* @example Monthly Salary
*/
assignMemo: string;
};
GetRecognizedTransactionResponseDto: {
/**
* @description The unique identifier of the uncategorized transaction
* @example 123
*/
uncategorizedTransactionId: number;
/**
* @description The reference number of the transaction
* @example TRX-2024-001
*/
referenceNo: string;
/**
* @description The description of the transaction
* @example Payment for invoice #123
*/
description: string;
/**
* @description The payee of the transaction
* @example John Doe
*/
payee: string;
/**
* @description The amount of the transaction
* @example 1500.75
*/
amount: number;
/**
* @description The formatted amount of the transaction
* @example $1,500.75
*/
formattedAmount: string;
/**
* @description The date of the transaction
* @example 2024-04-01
*/
date: string;
/**
* @description The formatted date of the transaction
* @example Apr 1, 2024
*/
formattedDate: string;
/**
* @description The assigned account ID
* @example 10
*/
assignedAccountId: number;
/**
* @description The assigned account name
* @example Bank Account
*/
assignedAccountName: string;
/**
* @description The assigned account code
* @example 1001
*/
assignedAccountCode: string;
/**
* @description The assigned payee
* @example Jane Smith
*/
assignedPayee: string;
/**
* @description The assigned memo
* @example Office supplies
*/
assignedMemo: string;
/**
* @description The assigned category
* @example Office Expenses
*/
assignedCategory: string;
/**
* @description The formatted assigned category
* @example Other Income
*/
assignedCategoryFormatted: string;
/**
* @description The withdrawal amount
* @example 500
*/
withdrawal: number;
/**
* @description The deposit amount
* @example 1000
*/
deposit: number;
/**
* @description Whether this is a deposit transaction
* @example true
*/
isDepositTransaction: boolean;
/**
* @description Whether this is a withdrawal transaction
* @example false
*/
isWithdrawalTransaction: boolean;
/**
* @description The formatted deposit amount
* @example $1,000.00
*/
formattedDepositAmount: string;
/**
* @description The formatted withdrawal amount
* @example $500.00
*/
formattedWithdrawalAmount: string;
/**
* @description The bank rule ID
* @example BR-001
*/
bankRuleId: string;
/**
* @description The bank rule name
* @example Salary Rule
*/
bankRuleName: string;
};
GetExcludedBankTransactionResponseDto: {
/** @description Transaction amount (positive for deposit, negative for withdrawal) */
amount: number;
/** @description Transaction date (ISO string or Date) */
date: Record<string, never>;
/** @description ID of the associated bank account */
accountId: number;
/** @description Reference number for the transaction */
referenceNo?: string;
/** @description Payee name */
payee?: string;
/** @description Transaction description */
description?: string;
/** @description Plaid transaction ID */
plaidTransactionId?: string;
/** @description Whether the transaction is pending */
pending?: boolean;
/** @description ID of the recognized transaction, if any */
recognizedTransactionId?: number;
/** @description Categorization reference type */
categorizeRefType?: string;
/** @description Categorization reference ID */
categorizeRefId?: number;
/** @description Formatted amount (localized string) */
formattedAmount?: string;
/** @description Formatted transaction date */
formattedDate?: string;
/** @description Formatted deposit amount */
formattedDepositAmount?: string;
/** @description Formatted withdrawal amount */
formattedWithdrawalAmount?: string;
/** @description Withdrawal amount */
withdrawal?: number;
/** @description Deposit amount */
deposit?: number;
/** @description True if deposit transaction */
isDepositTransaction?: boolean;
/** @description True if withdrawal transaction */
isWithdrawalTransaction?: boolean;
/** @description True if transaction is recognized */
isRecognized?: boolean;
/** @description True if transaction is excluded */
isExcluded?: boolean;
/** @description True if transaction is pending */
isPending?: boolean;
/** @description Assigned account ID from recognized transaction */
assignedAccountId?: number;
/** @description Assigned account name from recognized transaction */
assignedAccountName?: string;
/** @description Assigned account code from recognized transaction */
assignedAccountCode?: string;
/** @description Assigned payee from recognized transaction */
assignedPayee?: string;
/** @description Assigned memo from recognized transaction */
assignedMemo?: string;
/** @description Assigned category from recognized transaction */
assignedCategory?: string;
/** @description Assigned formatted category from recognized transaction */
assignedCategoryFormatted?: string;
};
ExcludeBankTransactionsBulkDto: {
/**
* @description IDs of uncategorized bank transactions to exclude or unexclude
* @example [
* 1,
* 2,
* 3
* ]
*/
ids: number[];
};
MatchedTransactionItemDto: {
/**
* @description Transaction amount
* @example 100.5
*/
amount: number;
/**
* @description Formatted amount
* @example $100.50
*/
amountFormatted: string;
/**
* @description Transaction date
* @example 2024-01-15
*/
date: string;
/**
* @description Formatted date
* @example Jan 15, 2024
*/
dateFormatted: string;
/**
* @description Reference number
* @example REF-001
*/
referenceNo: string;
/**
* @description Transaction number
* @example TXN-001
*/
transactionNo: string;
/**
* @description Transaction ID
* @example 1
*/
transactionId: number;
/**
* @description Transaction type
* @example SaleInvoice
*/
transactionType: string;
};
GetMatchedTransactionsResponseDto: {
/** @description Perfect matches (amount and date match) */
perfectMatches: components["schemas"]["MatchedTransactionItemDto"][];
/** @description Possible matches (candidates) */
possibleMatches: components["schemas"]["MatchedTransactionItemDto"][];
/**
* @description Total pending amount
* @example 500
*/
totalPending: number;
};
MatchBankTransactionDto: {
/**
* @description Uncategorized transaction IDs to match
* @example [
* 1,
* 2
* ]
*/
uncategorizedTransactions: number[];
/**
* @description The entries to match
* @example [
* {
* "referenceType": "SaleInvoice",
* "referenceId": 1
* },
* {
* "referenceType": "SaleInvoice",
* "referenceId": 2
* }
* ]
*/
matchedTransactions: string[];
};
TransactionLockingResponseDto: {
/**
* @description Indicates whether transaction locking is enabled
* @example true
*/
isEnabled: boolean;
/**
* @description Indicates whether partial unlock is enabled
* @example false
*/
isPartialUnlock: boolean;
/**
* Format: date-time
* @description The date until which transactions are locked
* @example 2024-12-31
*/
lockToDate: string;
/**
* @description The start date of the unlock period
* @example 2025-01-01
*/
unlockFromDate: string;
/**
* @description The end date of the unlock period
* @example 2025-01-31
*/
unlockToDate: string;
/**
* @description The reason for locking transactions
* @example Year-end closing
*/
lockReason: string;
/**
* @description The reason for unlocking transactions
* @example New fiscal year
*/
unlockReason: string;
/**
* @description The reason for partial unlock of transactions
* @example Special adjustment period
*/
partialUnlockReason: string;
};
TransactionsLockingDto: Record<string, never>;
CancelTransactionsLockingDto: Record<string, never>;
NumberFormatQueryDto: {
/**
* @description Number of decimal places to display
* @example 2
*/
precision?: number;
/**
* @description Whether to divide the number by 1000
* @example false
*/
divideOn1000?: boolean;
/**
* @description Whether to show zero values
* @example true
*/
showZero?: boolean;
/**
* @description How to format money values
* @example total
* @enum {string}
*/
formatMoney?: "total" | "always" | "none";
/**
* @description How to format negative numbers
* @example parentheses
* @enum {string}
*/
negativeFormat?: "parentheses" | "mines";
};
BalanceSheetQueryResponseDto: {
/**
* @description Column display type
* @enum {string}
*/
displayColumnsType: "total" | "date_periods";
/**
* @description Column grouping
* @enum {string}
*/
displayColumnsBy: "day" | "month" | "year" | "quarter";
/** @description Start date */
fromDate: string;
/** @description End date */
toDate: string;
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
/** @description Exclude zero balance accounts */
noneZero: boolean;
/** @description Exclude accounts with no transactions */
noneTransactions: boolean;
/**
* @description Accounting basis
* @enum {string}
*/
basis: "cash" | "accrual";
/** @description Account IDs to include */
accountIds: number[];
/** @description Show percentage of column */
percentageOfColumn: boolean;
/** @description Show percentage of row */
percentageOfRow: boolean;
/** @description Include previous period */
previousPeriod: boolean;
/** @description Show previous period amount change */
previousPeriodAmountChange: boolean;
/** @description Show previous period percentage change */
previousPeriodPercentageChange: boolean;
/** @description Include previous year */
previousYear: boolean;
/** @description Show previous year amount change */
previousYearAmountChange: boolean;
/** @description Show previous year percentage change */
previousYearPercentageChange: boolean;
};
FinancialReportTotalDto: {
/** @description Numeric amount */
amount: number;
/** @description Formatted amount string */
formattedAmount: string;
/** @description Currency code */
currencyCode: string;
/** @description Date associated with the total */
date?: Record<string, never>;
};
FinancialReportPercentageDto: {
/** @description Percentage amount */
amount: number;
/** @description Formatted percentage string */
formattedAmount: string;
};
BalanceSheetDataNodeDto: {
/** @description Node identifier (string for aggregates, number for accounts) */
id: Record<string, never>;
/** @description Account or category name */
name: string;
/**
* @description Type of node
* @enum {string}
*/
nodeType: "AGGREGATE" | "ACCOUNTS" | "ACCOUNT" | "NET_INCOME";
/** @description Node type alias */
type?: string;
/** @description Total amount information */
total: components["schemas"]["FinancialReportTotalDto"];
/** @description Horizontal totals for date periods */
horizontalTotals?: components["schemas"]["FinancialReportTotalDto"][];
/** @description Percentage of row */
percentageRow?: components["schemas"]["FinancialReportPercentageDto"];
/** @description Percentage of column */
percentageColumn?: components["schemas"]["FinancialReportPercentageDto"];
/** @description Previous period total */
previousPeriod?: components["schemas"]["FinancialReportTotalDto"];
/** @description Previous period change */
previousPeriodChange?: components["schemas"]["FinancialReportTotalDto"];
/** @description Previous period percentage */
previousPeriodPercentage?: components["schemas"]["FinancialReportPercentageDto"];
/** @description Previous year total */
previousYear?: components["schemas"]["FinancialReportTotalDto"];
/** @description Previous year change */
previousYearChange?: components["schemas"]["FinancialReportTotalDto"];
/** @description Previous year percentage */
previousYearPercentage?: components["schemas"]["FinancialReportPercentageDto"];
/** @description Account code */
code?: string;
/** @description Display index */
index?: number;
/** @description Parent account ID */
parentAccountId?: number;
/** @description Child nodes */
children?: components["schemas"]["BalanceSheetDataNodeDto"][];
};
BalanceSheetMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted as-of date */
formattedAsDate: string;
/** @description Formatted date range */
formattedDateRange: string;
};
BalanceSheetResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["BalanceSheetQueryResponseDto"];
/** @description Hierarchical balance sheet data */
data: components["schemas"]["BalanceSheetDataNodeDto"][];
/** @description Report metadata */
meta: components["schemas"]["BalanceSheetMetaDto"];
};
FinancialTableColumnDto: {
/** @description Column key */
key: string;
/** @description Column header label */
label: string;
/** @description Cell position index */
cellIndex?: number;
/** @description Nested column definitions */
children?: components["schemas"]["FinancialTableColumnDto"][];
};
FinancialTableCellDto: {
/** @description Cell key */
key: string;
/** @description Cell value */
value: string;
};
FinancialTableRowDto: {
/** @description Cell data for this row */
cells: components["schemas"]["FinancialTableCellDto"][];
/** @description Row type classifications */
rowTypes: string[];
/** @description Row identifier */
id: Record<string, never>;
/** @description Child rows */
children?: components["schemas"]["FinancialTableRowDto"][];
};
FinancialTableDataDto: {
/** @description Table column definitions */
columns: components["schemas"]["FinancialTableColumnDto"][];
/** @description Table row data */
rows: components["schemas"]["FinancialTableRowDto"][];
};
BalanceSheetTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["BalanceSheetQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["BalanceSheetMetaDto"];
};
PurchasesByItemsQueryResponseDto: {
/** @description Start date */
fromDate: string;
/** @description End date */
toDate: string;
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
/** @description Item IDs to include */
itemsIds: number[];
/** @description Vendor IDs to include */
vendorsIds: number[];
};
PurchasesByItemDto: {
/** @description Item ID */
id: number;
/** @description Item name */
name: string;
/** @description Item code */
code: string;
/** @description Item type */
type: string;
/** @description Quantity purchased */
quantity: number;
/** @description Total purchases amount */
total: components["schemas"]["FinancialReportTotalDto"];
/** @description Average cost */
averageCost?: number;
};
PurchasesByItemsMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted from date */
formattedFromDate: string;
/** @description Formatted to date */
formattedToDate: string;
/** @description Formatted date range */
formattedDateRange: string;
};
PurchasesByItemsResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["PurchasesByItemsQueryResponseDto"];
/** @description Purchases by items */
data: components["schemas"]["PurchasesByItemDto"][];
/** @description Report metadata */
meta: components["schemas"]["PurchasesByItemsMetaDto"];
};
PurchasesByItemsTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["PurchasesByItemsQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["PurchasesByItemsMetaDto"];
};
CustomerBalanceSummaryQueryResponseDto: {
/** @description As-of date */
asDate: string;
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
/** @description Customer IDs to include */
customersIds: number[];
/** @description Exclude zero balance customers */
noneZero: boolean;
/** @description Exclude inactive customers */
noneInactive: boolean;
};
CustomerBalanceDto: {
/** @description Customer ID */
customerId: number;
/** @description Customer name */
customerName: string;
/** @description Opening balance */
openingBalance?: components["schemas"]["FinancialReportTotalDto"];
/** @description Closing balance */
closingBalance: components["schemas"]["FinancialReportTotalDto"];
/** @description Total debit */
totalDebit?: components["schemas"]["FinancialReportTotalDto"];
/** @description Total credit */
totalCredit?: components["schemas"]["FinancialReportTotalDto"];
};
CustomerBalanceSummaryMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted as-of date */
formattedAsDate: string;
/** @description Formatted date range */
formattedDateRange: string;
};
CustomerBalanceSummaryResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["CustomerBalanceSummaryQueryResponseDto"];
/** @description Customer balances */
data: components["schemas"]["CustomerBalanceDto"][];
/** @description Report metadata */
meta: components["schemas"]["CustomerBalanceSummaryMetaDto"];
};
CustomerBalanceSummaryTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["CustomerBalanceSummaryQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["CustomerBalanceSummaryMetaDto"];
};
VendorBalanceSummaryQueryResponseDto: {
/** @description As-of date */
asDate: string;
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
/** @description Vendor IDs to include */
vendorsIds: number[];
/** @description Exclude zero balance vendors */
noneZero: boolean;
/** @description Exclude inactive vendors */
noneInactive: boolean;
};
VendorBalanceDto: {
/** @description Vendor ID */
vendorId: number;
/** @description Vendor name */
vendorName: string;
/** @description Opening balance */
openingBalance?: components["schemas"]["FinancialReportTotalDto"];
/** @description Closing balance */
closingBalance: components["schemas"]["FinancialReportTotalDto"];
/** @description Total debit */
totalDebit?: components["schemas"]["FinancialReportTotalDto"];
/** @description Total credit */
totalCredit?: components["schemas"]["FinancialReportTotalDto"];
};
VendorBalanceSummaryMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted as-of date */
formattedAsDate: string;
/** @description Formatted date range */
formattedDateRange: string;
};
VendorBalanceSummaryResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["VendorBalanceSummaryQueryResponseDto"];
/** @description Vendor balances */
data: components["schemas"]["VendorBalanceDto"][];
/** @description Report metadata */
meta: components["schemas"]["VendorBalanceSummaryMetaDto"];
};
VendorBalanceSummaryTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["VendorBalanceSummaryQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["VendorBalanceSummaryMetaDto"];
};
SalesByItemsQueryResponseDto: {
/** @description Start date */
fromDate: string;
/** @description End date */
toDate: string;
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
/** @description Item IDs to include */
itemsIds: number[];
/** @description Customer IDs to include */
customersIds: number[];
};
SalesByItemDto: {
/** @description Item ID */
id: number;
/** @description Item name */
name: string;
/** @description Item code */
code: string;
/** @description Item type */
type: string;
/** @description Quantity sold */
quantity: number;
/** @description Total sales amount */
total: components["schemas"]["FinancialReportTotalDto"];
/** @description Average price */
averagePrice?: number;
/** @description COGS */
cogs?: components["schemas"]["FinancialReportTotalDto"];
/** @description Profit */
profit?: components["schemas"]["FinancialReportTotalDto"];
/** @description Profit percentage */
profitPercentage?: number;
};
SalesByItemsMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted from date */
formattedFromDate: string;
/** @description Formatted to date */
formattedToDate: string;
/** @description Formatted date range */
formattedDateRange: string;
};
SalesByItemsResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["SalesByItemsQueryResponseDto"];
/** @description Sales by items */
data: components["schemas"]["SalesByItemDto"][];
/** @description Report metadata */
meta: components["schemas"]["SalesByItemsMetaDto"];
};
SalesByItemsTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["SalesByItemsQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["SalesByItemsMetaDto"];
};
GeneralLedgerQueryResponseDto: {
/** @description Start date */
fromDate: string;
/** @description End date */
toDate: string;
/**
* @description Accounting basis
* @enum {string}
*/
basis: "cash" | "accrual";
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
/** @description Exclude zero balance accounts */
noneZero: boolean;
/** @description Account IDs to include */
accountsIds: number[];
};
GeneralLedgerTransactionDto: {
/** @description Transaction date */
date: string;
/** @description Formatted date */
dateFormatted: string;
/** @description Reference type */
referenceType: string;
/** @description Reference ID */
referenceId: number;
/** @description Transaction number */
transactionNumber?: string;
/** @description Formatted transaction type */
transactionTypeFormatted: string;
/** @description Contact name */
contactName: string;
/** @description Contact type */
contactType: string;
/** @description Transaction type */
transactionType: string;
/** @description Transaction index */
index: number;
/** @description Transaction note */
note?: string;
/** @description Credit amount */
credit: number;
/** @description Debit amount */
debit: number;
/** @description Transaction amount */
amount: number;
/** @description Running balance */
runningBalance: number;
/** @description Formatted amount */
formattedAmount: string;
/** @description Formatted credit */
formattedCredit: string;
/** @description Formatted debit */
formattedDebit: string;
/** @description Formatted running balance */
formattedRunningBalance: string;
/** @description Currency code */
currencyCode: string;
};
GeneralLedgerAccountDto: {
/** @description Account ID */
id: number;
/** @description Account name */
name: string;
/** @description Account code */
code: string;
/** @description Account index */
index: number;
/** @description Parent account ID */
parentAccountId?: number;
/** @description Opening balance */
openingBalance: components["schemas"]["FinancialReportTotalDto"];
/** @description Account transactions */
transactions: components["schemas"]["GeneralLedgerTransactionDto"][];
/** @description Closing balance */
closingBalance: components["schemas"]["FinancialReportTotalDto"];
};
GeneralLedgerMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted from date */
formattedFromDate: string;
/** @description Formatted to date */
formattedToDate: string;
/** @description Formatted date range */
formattedDateRange: string;
};
GeneralLedgerResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["GeneralLedgerQueryResponseDto"];
/** @description General ledger data */
data: components["schemas"]["GeneralLedgerAccountDto"][];
/** @description Report metadata */
meta: components["schemas"]["GeneralLedgerMetaDto"];
};
GeneralLedgerTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["GeneralLedgerQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["GeneralLedgerMetaDto"];
};
TrialBalanceSheetQueryResponseDto: {
/** @description Start date */
fromDate: string;
/** @description End date */
toDate: string;
/** @description Account IDs to include */
accountIds: number[];
/** @description Exclude zero balance accounts */
noneZero: boolean;
/** @description Exclude accounts with no transactions */
noneTransactions: boolean;
/**
* @description Accounting basis
* @enum {string}
*/
basis: "cash" | "accrual";
/**
* @description Column display type
* @enum {string}
*/
displayColumnsType: "total" | "date_periods";
/**
* @description Column grouping
* @enum {string}
*/
displayColumnsBy: "day" | "month" | "year" | "quarter";
};
TrialBalanceSheetAccountDto: {
/** @description Account ID */
id: number;
/** @description Account name */
name: string;
/** @description Account code */
code: string;
/** @description Opening balance */
openingBalance?: components["schemas"]["FinancialReportTotalDto"];
/** @description Closing balance */
closingBalance?: components["schemas"]["FinancialReportTotalDto"];
/** @description Debit total */
debitTotal?: components["schemas"]["FinancialReportTotalDto"];
/** @description Credit total */
creditTotal?: components["schemas"]["FinancialReportTotalDto"];
/** @description Debit/change */
debit?: components["schemas"]["FinancialReportTotalDto"];
/** @description Credit/change */
credit?: components["schemas"]["FinancialReportTotalDto"];
/** @description Period balance */
periodBalance?: components["schemas"]["FinancialReportTotalDto"];
/**
* @description Account normal
* @enum {string}
*/
accountNormal?: "debit" | "credit";
/** @description Account index */
index?: number;
};
TrialBalanceSheetMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted from date */
formattedFromDate: string;
/** @description Formatted to date */
formattedToDate: string;
/** @description Formatted date range */
formattedDateRange: string;
/**
* Format: date-time
* @description Opening balance at
*/
openingBalanceAt?: string;
/**
* Format: date-time
* @description Closing balance at
*/
closingBalanceAt?: string;
/** @description Formatted opening balance date */
formattedOpeningBalanceDate?: string;
/** @description Formatted closing balance date */
formattedClosingBalanceDate?: string;
};
TrialBalanceSheetResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["TrialBalanceSheetQueryResponseDto"];
/** @description Trial balance sheet data */
data: components["schemas"]["TrialBalanceSheetAccountDto"][];
/** @description Report metadata */
meta: components["schemas"]["TrialBalanceSheetMetaDto"];
};
TrialBalanceSheetTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["TrialBalanceSheetQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["TrialBalanceSheetMetaDto"];
};
TransactionsByVendorQueryResponseDto: {
/** @description Start date */
fromDate: string;
/** @description End date */
toDate: string;
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
/** @description Vendor IDs to include */
vendorsIds: number[];
/** @description Exclude zero balance vendors */
noneZero: boolean;
};
VendorTransactionDto: {
/** @description Transaction date */
date: string;
/** @description Formatted date */
dateFormatted: string;
/** @description Transaction type */
transactionType: string;
/** @description Transaction number */
transactionNumber: string;
/** @description Reference type */
referenceType?: string;
/** @description Reference ID */
referenceId?: number;
/** @description Transaction description */
description?: string;
/** @description Transaction amount */
amount: components["schemas"]["FinancialReportTotalDto"];
/** @description Running balance */
runningBalance: components["schemas"]["FinancialReportTotalDto"];
};
VendorWithTransactionsDto: {
/** @description Vendor ID */
vendorId: number;
/** @description Vendor name */
vendorName: string;
/** @description Opening balance */
openingBalance?: components["schemas"]["FinancialReportTotalDto"];
/** @description Vendor transactions */
transactions: components["schemas"]["VendorTransactionDto"][];
/** @description Closing balance */
closingBalance: components["schemas"]["FinancialReportTotalDto"];
/** @description Total debit */
totalDebit?: components["schemas"]["FinancialReportTotalDto"];
/** @description Total credit */
totalCredit?: components["schemas"]["FinancialReportTotalDto"];
};
TransactionsByVendorMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted from date */
formattedFromDate: string;
/** @description Formatted to date */
formattedToDate: string;
/** @description Formatted date range */
formattedDateRange: string;
};
TransactionsByVendorResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["TransactionsByVendorQueryResponseDto"];
/** @description Vendors with transactions */
data: components["schemas"]["VendorWithTransactionsDto"][];
/** @description Report metadata */
meta: components["schemas"]["TransactionsByVendorMetaDto"];
};
TransactionsByVendorTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["TransactionsByVendorQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["TransactionsByVendorMetaDto"];
};
TransactionsByCustomerQueryResponseDto: {
/** @description Start date */
fromDate: string;
/** @description End date */
toDate: string;
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
/** @description Customer IDs to include */
customersIds: number[];
/** @description Exclude zero balance customers */
noneZero: boolean;
};
CustomerTransactionDto: {
/** @description Transaction date */
date: string;
/** @description Formatted date */
dateFormatted: string;
/** @description Transaction type */
transactionType: string;
/** @description Transaction number */
transactionNumber: string;
/** @description Reference type */
referenceType?: string;
/** @description Reference ID */
referenceId?: number;
/** @description Transaction description */
description?: string;
/** @description Transaction amount */
amount: components["schemas"]["FinancialReportTotalDto"];
/** @description Running balance */
runningBalance: components["schemas"]["FinancialReportTotalDto"];
};
CustomerWithTransactionsDto: {
/** @description Customer ID */
customerId: number;
/** @description Customer name */
customerName: string;
/** @description Opening balance */
openingBalance?: components["schemas"]["FinancialReportTotalDto"];
/** @description Customer transactions */
transactions: components["schemas"]["CustomerTransactionDto"][];
/** @description Closing balance */
closingBalance: components["schemas"]["FinancialReportTotalDto"];
/** @description Total debit */
totalDebit?: components["schemas"]["FinancialReportTotalDto"];
/** @description Total credit */
totalCredit?: components["schemas"]["FinancialReportTotalDto"];
};
TransactionsByCustomerMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted from date */
formattedFromDate: string;
/** @description Formatted to date */
formattedToDate: string;
/** @description Formatted date range */
formattedDateRange: string;
};
TransactionsByCustomerResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["TransactionsByCustomerQueryResponseDto"];
/** @description Customers with transactions */
data: components["schemas"]["CustomerWithTransactionsDto"][];
/** @description Report metadata */
meta: components["schemas"]["TransactionsByCustomerMetaDto"];
};
TransactionsByCustomerTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["TransactionsByCustomerQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["TransactionsByCustomerMetaDto"];
};
ARAgingSummaryQueryResponseDto: {
/** @description As-of date */
asDate: string;
/** @description Aging days before */
agingDaysBefore: number;
/** @description Number of aging periods */
agingPeriods: number;
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
/** @description Customer IDs to include */
customersIds: number[];
/** @description Branch IDs to include */
branchesIds: number[];
/** @description Exclude zero balance accounts */
noneZero: boolean;
};
ARAgingPeriodDto: {
/** @description From period date */
fromPeriod: string;
/** @description To period date */
toPeriod?: string;
/** @description Before days */
beforeDays: number;
/** @description To days */
toDays?: number;
};
ARAgingPeriodTotalDto: {
/** @description From period date */
fromPeriod: string;
/** @description To period date */
toPeriod?: string;
/** @description Before days */
beforeDays: number;
/** @description To days */
toDays?: number;
/** @description Period total */
total: components["schemas"]["FinancialReportTotalDto"];
};
ARAgingCustomerDto: {
/** @description Customer name */
customerName: string;
/** @description Current balance */
current: components["schemas"]["FinancialReportTotalDto"];
/** @description Aging periods */
aging: components["schemas"]["ARAgingPeriodTotalDto"][];
/** @description Customer total */
total: components["schemas"]["FinancialReportTotalDto"];
};
ARAgingSummaryDataDto: {
/** @description Customers aging data */
customers: components["schemas"]["ARAgingCustomerDto"][];
/** @description Current total */
current: components["schemas"]["FinancialReportTotalDto"];
/** @description Aging totals */
aging: components["schemas"]["ARAgingPeriodTotalDto"][];
/** @description Grand total */
total: components["schemas"]["FinancialReportTotalDto"];
};
ARAgingSummaryMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted as-of date */
formattedAsDate: string;
};
ARAgingSummaryResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["ARAgingSummaryQueryResponseDto"];
/** @description Aging columns definitions */
columns: components["schemas"]["ARAgingPeriodDto"][];
/** @description Aging summary data */
data: components["schemas"]["ARAgingSummaryDataDto"];
/** @description Report metadata */
meta: components["schemas"]["ARAgingSummaryMetaDto"];
};
ARAgingSummaryTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["ARAgingSummaryQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["ARAgingSummaryMetaDto"];
};
APAgingPeriodTotalDto: {
/** @description From period date */
fromPeriod: string;
/** @description To period date */
toPeriod?: string;
/** @description Before days */
beforeDays: number;
/** @description To days */
toDays?: number;
/** @description Period total */
total: components["schemas"]["FinancialReportTotalDto"];
};
APAgingVendorDto: {
/** @description Vendor name */
vendorName: string;
/** @description Current balance */
current: components["schemas"]["FinancialReportTotalDto"];
/** @description Aging periods */
aging: components["schemas"]["APAgingPeriodTotalDto"][];
/** @description Vendor total */
total: components["schemas"]["FinancialReportTotalDto"];
};
APAgingSummaryDataDto: {
/** @description Vendors aging data */
vendors: components["schemas"]["APAgingVendorDto"][];
/** @description Current total */
current: components["schemas"]["FinancialReportTotalDto"];
/** @description Aging totals */
aging: components["schemas"]["APAgingPeriodTotalDto"][];
/** @description Grand total */
total: components["schemas"]["FinancialReportTotalDto"];
};
APAgingSummaryMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted as-of date */
formattedAsDate: string;
};
APAgingSummaryResponseDto: {
/** @description Aging summary data */
data: components["schemas"]["APAgingSummaryDataDto"];
/** @description Report metadata */
meta: components["schemas"]["APAgingSummaryMetaDto"];
};
APAgingSummaryQueryResponseDto: {
/** @description As-of date */
asDate: string;
/** @description Aging days before */
agingDaysBefore: number;
/** @description Number of aging periods */
agingPeriods: number;
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
/** @description Vendor IDs to include */
vendorsIds: number[];
/** @description Branch IDs to include */
branchesIds: number[];
/** @description Exclude zero balance accounts */
noneZero: boolean;
};
APAgingSummaryTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["APAgingSummaryQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["APAgingSummaryMetaDto"];
};
InventoryItemDetailsQueryResponseDto: {
/** @description Start date */
fromDate: string;
/** @description End date */
toDate: string;
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
/** @description Item IDs to include */
itemsIds: number[];
};
InventoryItemTransactionDto: {
/** @description Transaction date */
date: string;
/** @description Formatted date */
dateFormatted: string;
/** @description Transaction type */
transactionType: string;
/** @description Reference ID */
referenceId: number;
/** @description Transaction number */
transactionNumber: string;
/** @description Transaction description */
description?: string;
/** @description Quantity */
quantity: number;
/** @description Rate */
rate: number;
/** @description Total amount */
total: components["schemas"]["FinancialReportTotalDto"];
/** @description Running quantity */
runningQuantity: number;
};
InventoryItemDetailDto: {
/** @description Item ID */
id: number;
/** @description Item name */
name: string;
/** @description Item code */
code: string;
/** @description Opening quantity */
openingQuantity: number;
/** @description Closing quantity */
closingQuantity: number;
/** @description Item transactions */
transactions: components["schemas"]["InventoryItemTransactionDto"][];
};
InventoryItemDetailsMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted from date */
formattedFromDate: string;
/** @description Formatted to date */
formattedToDate: string;
/** @description Formatted date range */
formattedDateRange: string;
};
InventoryItemDetailsResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["InventoryItemDetailsQueryResponseDto"];
/** @description Inventory items with details */
data: components["schemas"]["InventoryItemDetailDto"][];
/** @description Report metadata */
meta: components["schemas"]["InventoryItemDetailsMetaDto"];
};
InventoryItemDetailsTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["InventoryItemDetailsQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["InventoryItemDetailsMetaDto"];
};
InventoryValuationQueryResponseDto: {
/** @description As-of date */
asDate: string;
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
/** @description Item IDs to include */
itemsIds: number[];
/** @description Exclude zero quantity items */
noneZero: boolean;
};
InventoryValuationItemDto: {
/** @description Item ID */
id: number;
/** @description Item name */
name: string;
/** @description Item code */
code: string;
/** @description Item type */
type: string;
/** @description Quantity on hand */
quantityOnHand?: number;
/** @description Average cost */
averageCost?: number;
/** @description Total value */
totalValue?: components["schemas"]["FinancialReportTotalDto"];
/** @description Asset account name */
assetAccountName?: string;
/** @description Asset account code */
assetAccountCode?: string;
};
InventoryValuationMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted as-of date */
formattedAsDate: string;
/** @description Formatted date range */
formattedDateRange: string;
};
InventoryValuationResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["InventoryValuationQueryResponseDto"];
/** @description Inventory items valuation */
data: components["schemas"]["InventoryValuationItemDto"][];
/** @description Report metadata */
meta: components["schemas"]["InventoryValuationMetaDto"];
};
InventoryValuationTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["InventoryValuationQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["InventoryValuationMetaDto"];
};
SalesTaxLiabilitySummaryQueryResponseDto: {
/** @description Start date */
fromDate: string;
/** @description End date */
toDate: string;
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
};
TaxRateSummaryDto: {
/** @description Tax rate ID */
id: number;
/** @description Tax rate name */
name: string;
/** @description Tax rate percentage */
rate: number;
/** @description Taxable amount */
taxableAmount: components["schemas"]["FinancialReportTotalDto"];
/** @description Tax amount collected */
taxAmount: components["schemas"]["FinancialReportTotalDto"];
/** @description Total sales (including tax) */
totalSales: components["schemas"]["FinancialReportTotalDto"];
};
SalesTaxLiabilitySummaryMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted from date */
formattedFromDate: string;
/** @description Formatted to date */
formattedToDate: string;
/** @description Formatted date range */
formattedDateRange: string;
};
SalesTaxLiabilitySummaryResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["SalesTaxLiabilitySummaryQueryResponseDto"];
/** @description Tax rate summaries */
data: components["schemas"]["TaxRateSummaryDto"][];
/** @description Report metadata */
meta: components["schemas"]["SalesTaxLiabilitySummaryMetaDto"];
};
SalesTaxLiabilitySummaryTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["SalesTaxLiabilitySummaryQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["SalesTaxLiabilitySummaryMetaDto"];
};
JournalSheetQueryResponseDto: {
/** @description Start date */
fromDate: string;
/** @description End date */
toDate: string;
/** @description From range */
fromRange?: number;
/** @description To range */
toRange?: number;
/** @description Account IDs to include */
accountsIds: number[];
/** @description Number format settings */
numberFormat: Record<string, never>;
};
JournalEntryDto: {
/** @description Entry index */
index: number;
/** @description Entry note */
note?: string;
/** @description Contact name */
contactName?: string;
/** @description Contact type */
contactType?: string;
/** @description Account name */
accountName: string;
/** @description Account code */
accountCode: string;
/** @description Transaction number */
transactionNumber?: string;
/** @description Formatted credit */
formattedCredit: string;
/** @description Formatted debit */
formattedDebit: string;
/** @description Credit amount */
credit: number;
/** @description Debit amount */
debit: number;
};
JournalTransactionDto: {
/** @description Transaction date */
date: string;
/** @description Formatted date */
dateFormatted: string;
/** @description Transaction type */
transactionType: string;
/** @description Reference ID */
referenceId: number;
/** @description Formatted reference type */
referenceTypeFormatted: string;
/** @description Journal entries */
entries: components["schemas"]["JournalEntryDto"][];
/** @description Total credit */
credit: number;
/** @description Total debit */
debit: number;
/** @description Formatted total credit */
formattedCredit: string;
/** @description Formatted total debit */
formattedDebit: string;
};
JournalSheetMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted from date */
formattedFromDate: string;
/** @description Formatted to date */
formattedToDate: string;
/** @description Formatted date range */
formattedDateRange: string;
};
JournalSheetResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["JournalSheetQueryResponseDto"];
/** @description Journal transactions */
data: components["schemas"]["JournalTransactionDto"][];
/** @description Report metadata */
meta: components["schemas"]["JournalSheetMetaDto"];
};
JournalSheetTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["JournalSheetQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["JournalSheetMetaDto"];
};
ProfitLossSheetQueryResponseDto: {
/**
* @description Column display type
* @enum {string}
*/
display_columns_type: "total" | "date_periods";
/**
* @description Column grouping
* @enum {string}
*/
display_columns_by: "day" | "month" | "year" | "quarter";
/** @description Start date */
from_date: string;
/** @description End date */
to_date: string;
/** @description Number format settings */
number_format: components["schemas"]["NumberFormatQueryDto"];
/** @description Exclude zero balance accounts */
none_zero: boolean;
/** @description Exclude accounts with no transactions */
none_transactions: boolean;
/**
* @description Accounting basis
* @enum {string}
*/
basis: "cash" | "accrual";
/** @description Account IDs to include */
accounts_ids: number[];
/** @description Show percentage of column */
percentage_column: boolean;
/** @description Show percentage of row */
percentage_row: boolean;
/** @description Show percentage of income */
percentage_income: boolean;
/** @description Show percentage of expense */
percentage_expense: boolean;
/** @description Include previous period */
previous_period: boolean;
/** @description Show previous period amount change */
previous_period_amount_change: boolean;
/** @description Show previous period percentage change */
previous_period_percentage_change: boolean;
/** @description Include previous year */
previous_year: boolean;
/** @description Show previous year amount change */
previous_year_amount_change: boolean;
/** @description Show previous year percentage change */
previous_year_percentage_change: boolean;
};
ProfitLossSheetDataNodeDto: {
/** @description Node identifier (string for aggregates, number for accounts) */
id: Record<string, never>;
/** @description Account or category name */
name: string;
/**
* @description Type of node
* @enum {string}
*/
node_type: "ACCOUNTS" | "ACCOUNT" | "EQUATION" | "TOTAL";
/** @description Node type alias */
type?: string;
/** @description Total amount information */
total: components["schemas"]["FinancialReportTotalDto"];
/** @description Horizontal totals for date periods */
horizontal_totals?: components["schemas"]["FinancialReportTotalDto"][];
/** @description Percentage of income */
percentage_income?: components["schemas"]["FinancialReportPercentageDto"];
/** @description Percentage of expense */
percentage_expense?: components["schemas"]["FinancialReportPercentageDto"];
/** @description Percentage of row */
percentage_row?: components["schemas"]["FinancialReportPercentageDto"];
/** @description Percentage of column */
percentage_column?: components["schemas"]["FinancialReportPercentageDto"];
/** @description Previous period total */
previous_period?: components["schemas"]["FinancialReportTotalDto"];
/** @description Previous period change */
previous_period_change?: components["schemas"]["FinancialReportTotalDto"];
/** @description Previous period percentage */
previous_period_percentage?: components["schemas"]["FinancialReportPercentageDto"];
/** @description Previous year total */
previous_year?: components["schemas"]["FinancialReportTotalDto"];
/** @description Previous year change */
previous_year_change?: components["schemas"]["FinancialReportTotalDto"];
/** @description Previous year percentage */
previous_year_percentage?: components["schemas"]["FinancialReportPercentageDto"];
/** @description Account code */
code?: string;
/** @description Display index */
index?: number;
/** @description Child nodes */
children?: components["schemas"]["ProfitLossSheetDataNodeDto"][];
};
ProfitLossSheetMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted from date */
formatted_from_date: string;
/** @description Formatted to date */
formatted_to_date: string;
/** @description Formatted date range */
formatted_date_range: string;
};
ProfitLossSheetResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["ProfitLossSheetQueryResponseDto"];
/** @description Hierarchical profit/loss data */
data: components["schemas"]["ProfitLossSheetDataNodeDto"][];
/** @description Report metadata */
meta: components["schemas"]["ProfitLossSheetMetaDto"];
};
ProfitLossSheetTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["ProfitLossSheetQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["ProfitLossSheetMetaDto"];
};
CashflowStatementQueryResponseDto: {
/**
* @description Column display type
* @enum {string}
*/
displayColumnsType: "total" | "date_periods";
/**
* @description Column grouping
* @enum {string}
*/
displayColumnsBy: "day" | "month" | "year" | "quarter";
/** @description Start date */
fromDate: string;
/** @description End date */
toDate: string;
/** @description Number format settings */
numberFormat: components["schemas"]["NumberFormatQueryDto"];
/** @description Exclude zero balance accounts */
noneZero: boolean;
/** @description Exclude accounts with no transactions */
noneTransactions: boolean;
/**
* @description Accounting basis
* @enum {string}
*/
basis: "cash" | "accrual";
/** @description Account IDs to include */
accountIds: number[];
};
CashflowStatementDataNodeDto: {
/** @description Node identifier (string for aggregates, number for accounts) */
id: Record<string, never>;
/** @description Account or category name */
name: string;
/**
* @description Type of node
* @enum {string}
*/
nodeType: "AGGREGATE" | "ACCOUNT" | "NET_INCOME" | "TOTAL";
/** @description Node type alias */
type?: string;
/** @description Total amount information */
total: components["schemas"]["FinancialReportTotalDto"];
/** @description Horizontal totals for date periods */
horizontalTotals?: components["schemas"]["FinancialReportTotalDto"][];
/** @description Account code */
code?: string;
/** @description Display index */
index?: number;
/** @description Child nodes */
children?: components["schemas"]["CashflowStatementDataNodeDto"][];
};
CashflowStatementMetaDto: {
/** @description Organization name */
organizationName: string;
/** @description Base currency code */
baseCurrency: string;
/** @description Date format string */
dateFormat: string;
/** @description Whether cost computation is running */
isCostComputeRunning: boolean;
/** @description Sheet name */
sheetName: string;
/** @description Formatted from date */
formattedFromDate: string;
/** @description Formatted to date */
formattedToDate: string;
/** @description Formatted date range */
formattedDateRange: string;
};
CashflowStatementResponseDto: {
/** @description Query parameters used to generate the report */
query: components["schemas"]["CashflowStatementQueryResponseDto"];
/** @description Hierarchical cashflow data */
data: components["schemas"]["CashflowStatementDataNodeDto"][];
/** @description Report metadata */
meta: components["schemas"]["CashflowStatementMetaDto"];
};
CashflowStatementTableResponseDto: {
/** @description Table data structure */
table: components["schemas"]["FinancialTableDataDto"];
/** @description Query parameters used to generate the report */
query: components["schemas"]["CashflowStatementQueryResponseDto"];
/** @description Report metadata */
meta: components["schemas"]["CashflowStatementMetaDto"];
};
RoleAbilityResponseDto: {
/**
* @description The subject of the ability
* @example all
*/
subject: string;
/**
* @description The action permitted for the subject
* @example manage
*/
action: string;
};
DashboardFeatureResponseDto: {
/**
* @description The name of the feature
* @example warehouses
*/
name: string;
/**
* @description Whether the feature is accessible for the tenant
* @example true
*/
isAccessible: boolean;
/**
* @description The default accessibility of the feature
* @example false
*/
defaultAccessible: boolean;
};
GetDashboardBootMetaResponseDto: {
/**
* @description List of abilities for the current user
* @example [
* {
* "subject": "all",
* "action": "manage"
* },
* {
* "subject": "invoices",
* "action": "read"
* }
* ]
*/
abilities: components["schemas"]["RoleAbilityResponseDto"][];
/**
* @description List of features and their accessibility
* @example [
* {
* "name": "warehouses",
* "isAccessible": true,
* "defaultAccessible": false
* },
* {
* "name": "branches",
* "isAccessible": false,
* "defaultAccessible": false
* }
* ]
*/
features: components["schemas"]["DashboardFeatureResponseDto"][];
/**
* @description Whether the app is running on Bigcapital Cloud
* @example true
*/
isBigcapitalCloud: boolean;
};
RolePermissionResponseDto: {
/**
* @description The action/ability of the permission
* @example read
*/
ability: string;
/**
* @description The subject of the permission
* @example item
*/
subject: string;
/**
* @description The value of the permission
* @example true
*/
value: boolean;
};
RoleResponseDto: {
/**
* @description Unique identifier of the role
* @example 1
*/
id: number;
/**
* @description The slug of the role
* @example admin
*/
slug: string;
/**
* @description The name of the role
* @example Administrator
*/
name: string;
/**
* @description The description of the role
* @example Administrator role with all permissions
*/
description: string;
/**
* @description Indicates if the role is predefined
* @example false
*/
predefined: boolean;
/**
* @description List of permissions associated with the role
* @example [
* {
* "ability": "read",
* "subject": "item",
* "value": true
* },
* {
* "ability": "edit",
* "subject": "item",
* "value": false
* }
* ]
*/
permissions: components["schemas"]["RolePermissionResponseDto"][];
};
CreateRolePermissionDto: {
/**
* @description The subject of the permission
* @example subject
*/
subject: string;
/**
* @description The action of the permission
* @example read
*/
ability: string;
/**
* @description The value of the permission
* @example true
*/
value: boolean;
};
CreateRoleDto: {
/**
* @description The name of the role
* @example admin
*/
roleName: string;
/**
* @description The description of the role
* @example Administrator
*/
roleDescription: string;
/** @description The permissions of the role */
permissions: components["schemas"]["CreateRolePermissionDto"][];
};
EditRolePermissionDto: {
/**
* @description The subject of the permission
* @example subject
*/
subject: string;
/**
* @description The action of the permission
* @example read
*/
ability: string;
/**
* @description The value of the permission
* @example true
*/
value: boolean;
/**
* @description The permission ID
* @example 1
*/
permissionId: number;
};
EditRoleDto: {
/**
* @description The name of the role
* @example admin
*/
roleName: string;
/**
* @description The description of the role
* @example Administrator
*/
roleDescription: string;
/** @description The permissions of the role */
permissions: components["schemas"]["EditRolePermissionDto"][];
};
OrganizationBuildJobResponseDto: {
/** @example 123 */
id: string;
/** @example active */
state: string;
/** @example 50 */
progress: Record<string, never>;
/** @example false */
isCompleted: boolean;
/** @example true */
isRunning: boolean;
/** @example false */
isWaiting: boolean;
/** @example false */
isFailed: boolean;
};
OrganizationMetadataResponseDto: {
/**
* @description Internal numeric ID of the metadata
* @example 1
*/
id: number;
/**
* @description Tenant ID associated with the organization
* @example 101
*/
tenantId: number;
/**
* @description Name of the organization
* @example Acme Inc.
*/
name: string;
/**
* @description Industry of the organization
* @example Technology
*/
industry?: string;
/**
* @description Location of the organization
* @example US
*/
location: string;
/**
* @description Base currency in ISO 4217 format
* @example USD
*/
baseCurrency: string;
/**
* @description Language/locale of the organization
* @example en-US
*/
language: string;
/**
* @description Timezone of the organization
* @example America/New_York
*/
timezone: string;
/**
* @description Date format used by the organization
* @example MM/DD/YYYY
*/
dateFormat: string;
/**
* @description Fiscal year of the organization
* @example January
*/
fiscalYear: string;
/**
* @description Tax identification number
* @example 12-3456789
*/
taxNumber?: string | null;
/**
* @description Primary brand color in hex format
* @example #4285F4
*/
primaryColor?: string | null;
/**
* @description Logo file key reference
* @example organizations/acme-logo-123456.png
*/
logoKey?: string | null;
/**
* @description Logo URL (presigned or public) for display
* @example https://...
*/
logoUri?: string | null;
/**
* @description Organization address details
* @example 123 Main St, New York, NY
*/
address?: string | null;
};
GetCurrentOrganizationResponseDto: {
/**
* @description Internal numeric ID of the organization
* @example 1
*/
id: number;
/**
* @description Unique string identifier for the organization
* @example org_123456
*/
organizationId: string;
/**
* Format: date-time
* @description Date when the organization was initialized
* @example 2024-01-01T00:00:00.000Z
*/
initializedAt: string;
/**
* Format: date-time
* @description Date when the organization was seeded
* @example 2024-01-01T01:00:00.000Z
*/
seededAt: string;
/**
* Format: date-time
* @description Date when the organization was built
* @example 2024-01-01T02:00:00.000Z
*/
builtAt: string;
/**
* @description Database batch identifier, if any
* @example batch_001
*/
databaseBatch?: string | null;
/** @description Organization metadata */
metadata: components["schemas"]["OrganizationMetadataResponseDto"][];
/**
* @description Whether the organization is ready
* @example true
*/
isReady: boolean;
/**
* @description Whether a build process is currently running
* @example false
*/
isBuildRunning: boolean;
/**
* @description Whether an upgrade process is currently running
* @example false
*/
isUpgradeRunning: boolean;
};
BuildOrganizationDto: {
/**
* @description Organization name
* @example Acme Inc.
*/
name: string;
/**
* @description Industry of the organization
* @example Technology
*/
industry?: string;
/**
* @description Country location in ISO 3166-1 alpha-2 format
* @example US
*/
location: string;
/**
* @description Base currency in ISO 4217 format
* @example USD
*/
baseCurrency: string;
/**
* @description Timezone of the organization
* @example America/New_York
*/
timezone: string;
/**
* @description Starting month of fiscal year
* @example January
*/
fiscalYear: string;
/**
* @description Language/locale of the organization
* @example en-US
*/
language: string;
/**
* @description Date format used by the organization
* @example MM/DD/YYYY
*/
dateFormat?: string;
};
UpdateOrganizationDto: {
/**
* @description Organization name
* @example Acme Inc.
*/
name?: string;
/**
* @description Industry of the organization
* @example Technology
*/
industry?: string;
/**
* @description Country location in ISO 3166-1 alpha-2 format
* @example US
*/
location?: string;
/**
* @description Base currency in ISO 4217 format
* @example USD
*/
baseCurrency?: string;
/**
* @description Timezone of the organization
* @example America/New_York
*/
timezone?: string;
/**
* @description Starting month of fiscal year
* @example January
*/
fiscalYear?: string;
/**
* @description Language/locale of the organization
* @example en-US
*/
language?: string;
/**
* @description Date format used by the organization
* @example MM/DD/YYYY
*/
dateFormat?: string;
/**
* @description Organization address details
* @example {
* "address_1": "123 Main St",
* "address_2": "Suite 100",
* "postal_code": "10001",
* "city": "New York",
* "stateProvince": "NY",
* "phone": "+1-555-123-4567"
* }
*/
address?: Record<string, never>;
/**
* @description Primary brand color in hex format
* @example #4285F4
*/
primaryColor?: string;
/**
* @description Logo file key reference
* @example organizations/acme-logo-123456.png
*/
logoKey?: string;
/**
* @description Organization tax identification number
* @example 12-3456789
*/
taxNumber?: string;
};
EditPaymentMethodOptionsDto: Record<string, never>;
EditPaymentMethodDTO: {
/** @description Edit payment method options */
options?: components["schemas"]["EditPaymentMethodOptionsDto"];
/** @description Payment method name */
name?: string;
};
ViewColumn: Record<string, never>;
ViewResponseDto: {
/** @description The unique identifier of the view */
id: number;
/** @description The name of the view */
name: string;
/** @description The slug of the view */
slug: string;
/** @description Whether the view is predefined */
predefined: boolean;
/** @description The resource model associated with the view */
resourceModel: string;
/** @description Whether the view is marked as favourite */
favourite: boolean;
/** @description The roles logic expression for the view */
rolesLogicExpression: string;
/** @description The roles associated with the view */
roles: components["schemas"]["RoleResponseDto"][];
/** @description The columns associated with the view */
columns: components["schemas"]["ViewColumn"][];
/**
* Format: date-time
* @description The creation timestamp
*/
createdAt: string;
/**
* Format: date-time
* @description The last update timestamp
*/
updatedAt: string;
};
CurrencyResponseDto: {
/**
* @description The unique identifier of the currency
* @example 1
*/
id: number;
/**
* @description The name of the currency
* @example US Dollar
*/
currencyName: string;
/**
* @description The code of the currency
* @example USD
*/
currencyCode: string;
/**
* @description The sign/symbol of the currency
* @example $
*/
currencySign: string;
/**
* @description Whether this is the base currency for the organization
* @example true
*/
isBaseCurrency: boolean;
/**
* Format: date-time
* @description The creation timestamp
* @example 2024-03-20T10:00:00Z
*/
createdAt: string;
/**
* Format: date-time
* @description The last update timestamp
* @example 2024-03-20T10:00:00Z
*/
updatedAt: string;
};
CreateCurrencyDto: {
/**
* @description The currency name
* @example USD
*/
currencyName: string;
/**
* @description The currency code
* @example USD
*/
currencyCode: string;
/**
* @description The currency sign
* @example $
*/
currencySign: string;
};
EditCurrencyDto: {
/**
* @description The currency name
* @example USD
*/
currencyName: string;
/**
* @description The currency sign
* @example $
*/
currencySign: string;
};
DateFormatResponseDto: {
/** @example 03/09/2026 [MM/DD/YYYY] */
label: string;
/** @example MM/DD/YYYY */
key: string;
};
EditUserDto: {
/**
* @description First name of the user
* @example John
*/
firstName: string;
/**
* @description Last name of the user
* @example Doe
*/
lastName: string;
/**
* @description Email address of the user
* @example john.doe@example.com
*/
email: string;
/**
* @description Role ID assigned to the user
* @example 2
*/
roleId: number;
};
SendInviteUserDto: {
/**
* @description Email address of the user to invite
* @example john.doe@example.com
*/
email: string;
/**
* @description Role ID to assign to the invited user
* @example 2
*/
roleId: number;
};
InviteUserDto: {
/**
* @description First name of the user to invite
* @example John
*/
firstName: string;
/**
* @description Last name of the user to invite
* @example Doe
*/
lastName: string;
/**
* @description Password for the invited user
* @example StrongPassword123!
*/
password: string;
};
ExchangeRateLatestResponseDto: {
/**
* @description The base currency code
* @example USD
*/
baseCurrency: string;
/**
* @description The target currency code
* @example EUR
*/
toCurrency: string;
/**
* @description The exchange rate value
* @example 0.85
*/
exchangeRate: number;
};
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
SystemDatabaseController_ping: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AuthController_signin: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AuthSigninDto"];
};
};
responses: {
/** @description Sign-in successful. Returns access token and tenant/organization IDs. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AuthSigninResponseDto"];
};
};
};
};
AuthController_signup: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AuthSignupDto"];
};
};
responses: {
/** @description Sign-up initiated. Check email for confirmation. */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AuthController_signupConfirm: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AuthSignupVerifyDto"];
};
};
responses: {
/** @description Signup confirmed successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AuthController_sendResetPassword: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AuthSendResetPasswordDto"];
};
};
responses: {
/** @description Reset password email sent if the account exists. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AuthController_resetPassword: {
parameters: {
query?: never;
header?: never;
path: {
/** @description Reset password token from email link */
token: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AuthResetPasswordDto"];
};
};
responses: {
/** @description Password reset successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AuthController_meta: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Auth metadata for the login/signup page. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AuthMetaResponseDto"];
};
};
};
};
AuthedController_resendSignupConfirm: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @example 200 */
code?: number;
/** @example resent successfully. */
message?: string;
};
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AuthedController_getAuthedAcccount: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AuthApiKeysController_generate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["GenerateApiKeyDto"];
};
};
responses: {
/** @description The generated API key */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ApiKeyResponseDto"];
};
};
};
};
AuthApiKeysController_revoke: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description API key ID */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description API key revoked */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ApiKeyRevokeResponseDto"];
};
};
};
};
AuthApiKeysController_getApiKeys: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description List of API keys */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ApiKeyListItemDto"][];
};
};
};
};
ItemsController_getItems: {
parameters: {
query?: {
/** @description Custom view ID for filtering */
customViewId?: number;
/** @description Array of filter roles */
filterRoles?: string[];
/** @description Column sort direction */
columnSortBy?: string;
/** @description Sort order direction */
sortOrder?: "DESC" | "ASC";
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug for filtering */
viewSlug?: string;
/** @description Filter for inactive items */
inactiveMode?: boolean;
/** @description Number of items per page */
pageSize?: number;
/** @description Page number for pagination */
page?: number;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The item list has been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResponseDto"] & {
data?: components["schemas"]["ItemResponseDto"][];
};
};
};
};
};
ItemsController_createItem: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateItemDto"];
};
};
responses: {
/** @description The item has been successfully created. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation error. Possible error types: ITEM_NAME_EXISTS, ITEM_CATEOGRY_NOT_FOUND, COST_ACCOUNT_NOT_COGS, SELL_ACCOUNT_NOT_INCOME, INVENTORY_ACCOUNT_NOT_INVENTORY, INCOME_ACCOUNT_REQUIRED_WITH_SELLABLE_ITEM, COST_ACCOUNT_REQUIRED_WITH_PURCHASABLE_ITEM, etc. */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ItemApiErrorResponseDto"];
};
};
};
};
ItemsController_getItem: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The item id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The item details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ItemResponseDto"];
};
};
/** @description The item not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ItemsController_editItem: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The item id */
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditItemDto"];
};
};
responses: {
/** @description The item has been successfully updated. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Validation error. Possible error types: ITEM_NAME_EXISTS, INVENTORY_ACCOUNT_CANNOT_MODIFIED, TYPE_CANNOT_CHANGE_WITH_ITEM_HAS_TRANSACTIONS, etc. */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ItemApiErrorResponseDto"];
};
};
/** @description The item not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ItemsController_deleteItem: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The item id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The item has been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Cannot delete item. Possible error types: ITEM_HAS_ASSOCIATED_TRANSACTINS, ITEM_HAS_ASSOCIATED_INVENTORY_ADJUSTMENT, etc. */
400: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ItemApiErrorResponseDto"];
};
};
/** @description The item not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ItemsController_validateBulkDeleteItems: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteItemsDto"];
};
};
responses: {
/** @description Validation completed. Returns counts and IDs of deletable and non-deletable items. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ValidateBulkDeleteItemsResponseDto"];
};
};
};
};
ItemsController_bulkDeleteItems: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteItemsDto"];
};
};
responses: {
/** @description The items have been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ItemsController_inactivateItem: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The item id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The item has been successfully inactivated. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The item not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ItemsController_activateItem: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The item id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The item has been successfully activated. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The item not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ItemsController_getItemInvoicesTransactions: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The item id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The item associated invoices transactions have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ItemInvoiceResponseDto"][];
};
};
/** @description The item not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ItemsController_getItemBillTransactions: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The item id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The item associated bills transactions have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ItemBillsResponseDto"][];
};
};
/** @description The item not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ItemsController_getItemEstimatesTransactions: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The item id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The item associated estimate transactions have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ItemEstimatesResponseDto"][];
};
};
/** @description The item not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ItemsController_getItemReceiptTransactions: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The item id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The item associated receipts transactions have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ItemReceiptsResponseDto"];
};
};
/** @description The item not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
InventoryAdjustmentsController_createQuickInventoryAdjustment: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateQuickInventoryAdjustmentDto"];
};
};
responses: {
/** @description The inventory adjustment has been successfully created. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
InventoryAdjustmentsController_getInventoryAdjustment: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The inventory adjustment details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["InventoryAdjustmentResponseDto"];
};
};
};
};
InventoryAdjustmentsController_deleteInventoryAdjustment: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The inventory adjustment has been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
InventoryAdjustmentsController_getInventoryAdjustments: {
parameters: {
query?: {
page?: number;
pageSize?: number;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The inventory adjustments have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["InventoryAdjustmentsListResponseDto"];
};
};
};
};
InventoryAdjustmentsController_publishInventoryAdjustment: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The inventory adjustment has been successfully published. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BranchesController_getBranches: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The branches have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BranchResponseDto"][];
};
};
};
};
BranchesController_createBranch: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateBranchDto"];
};
};
responses: {
/** @description The branch has been successfully created. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BranchResponseDto"];
};
};
/** @description The branch not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BranchesController_getBranch: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The branch details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BranchResponseDto"];
};
};
/** @description The branch not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BranchesController_editBranch: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditBranchDto"];
};
};
responses: {
/** @description The branch has been successfully edited. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BranchResponseDto"];
};
};
/** @description The branch not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BranchesController_deleteBranch: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The branch has been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The branch not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BranchesController_activateBranches: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The branches feature has been successfully activated. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BranchesController_markBranchAsPrimary: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The branch has been successfully marked as primary. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BranchResponseDto"];
};
};
/** @description The branch not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
WarehousesController_getWarehouses: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The warehouses have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WarehouseResponseDto"][];
};
};
};
};
WarehousesController_createWarehouse: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateWarehouseDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
WarehousesController_getWarehouse: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The warehouse details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WarehouseResponseDto"];
};
};
};
};
WarehousesController_editWarehouse: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditWarehouseDto"];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
WarehousesController_deleteWarehouse: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
WarehousesController_activateWarehouses: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
WarehousesController_markWarehousePrimary: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
WarehouseItemsController_getItemWarehouses: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The item id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The item associated warehouses have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The item not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AccountsController_validateBulkDeleteAccounts: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Validation completed. Returns counts and IDs of deletable and non-deletable accounts. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ValidateBulkDeleteResponseDto"];
};
};
};
};
AccountsController_bulkDeleteAccounts: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description The accounts have been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AccountsController_getAccounts: {
parameters: {
query?: {
/** @description Filter to show only inactive accounts */
onlyInactive?: boolean;
/** @description Structure type for the accounts list */
structure?: "tree" | "flat";
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles array */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order */
sortOrder?: "DESC" | "ASC";
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
/** @description Page number */
page?: number;
/** @description Page size */
pageSize?: number;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The accounts have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AccountResponseDto"][];
};
};
};
};
AccountsController_createAccount: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateAccountDTO"];
};
};
responses: {
/** @description The account has been successfully created. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AccountsController_getAccount: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The account id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The account details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AccountResponseDto"];
};
};
/** @description The account not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AccountsController_editAccount: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The account id */
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditAccountDTO"];
};
};
responses: {
/** @description The account has been successfully updated. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The account not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AccountsController_deleteAccount: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The account id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The account has been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The account not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AccountsController_activateAccount: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The account id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The account has been successfully activated. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The account not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AccountsController_inactivateAccount: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The account id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The account has been successfully inactivated. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The account not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AccountsController_getAccountTypes: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The account types have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AccountTypeResponseDto"][];
};
};
};
};
AccountsController_getAccountTransactions: {
parameters: {
query?: {
/** @description ID of the account to fetch transactions for */
accountId?: number;
/** @description Maximum number of transactions to return */
limit?: number;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The account transactions have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GetAccountTransactionResponseDto"][];
};
};
};
};
InventoryCostController_getItemsCost: {
parameters: {
query: {
/** @description The date to get the inventory cost for */
date: string;
/** @description The ids of the items to get the inventory cost for */
itemsIds: string[];
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Items inventory cost list */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GetInventoryItemsCostResponseDto"];
};
};
};
};
SaleInvoicesController_validateBulkDeleteSaleInvoices: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Validation completed with counts and IDs of deletable and non-deletable sale invoices. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ValidateBulkDeleteResponseDto"];
};
};
};
};
SaleInvoicesController_bulkDeleteSaleInvoices: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Sale invoices deleted successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_getSaleInvoices: {
parameters: {
query?: {
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order (asc/desc) */
sortOrder?: string;
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sale invoices have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResponseDto"] & {
data?: components["schemas"]["SaleInvoiceResponseDto"][];
};
};
};
};
};
SaleInvoicesController_createSaleInvoice: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateSaleInvoiceDto"];
};
};
responses: {
/** @description Sale invoice created successfully */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_getSaleInvoiceMailState: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale invoice id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Sale invoice mail state retrieved successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The sale invoice not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_sendSaleInvoiceMail: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale invoice id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Sale invoice mail sent successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The sale invoice not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_getSaleInvoice: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path: {
/** @description The sale invoice id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sale invoice details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SaleInvoiceResponseDto"];
};
};
/** @description The sale invoice not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_editSaleInvoice: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale invoice id */
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditSaleInvoiceDto"];
};
};
responses: {
/** @description Sale invoice edited successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The sale invoice not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_deleteSaleInvoice: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale invoice id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sale invoice has been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The sale invoice not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_getReceivableSaleInvoices: {
parameters: {
query?: {
/** @description The customer id */
customerId?: number;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The receivable sale invoices have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The customer not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_getSaleInvoiceState: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sale invoice state has been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SaleInvoiceStateResponseDto"];
};
};
/** @description The sale invoice not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_deliverSaleInvoice: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale invoice id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sale invoice has been successfully marked asdelivered. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The sale invoice not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_writeOff: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale invoice id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sale invoice has been successfully written off. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The sale invoice not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_cancelWrittenoff: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale invoice id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sale invoice has been successfully marked as not written off. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The sale invoice not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_getInvoicePayments: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale invoice id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sale invoice not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_saleInvoiceHtml: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale invoice id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sale invoice not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleInvoicesController_generateSaleInvoiceSharableLink: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale invoice id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The link has been generated successfully. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GenerateSaleInvoiceSharableLinkResponseDto"];
};
};
};
};
PdfTemplatesController_getPdfTemplates: {
parameters: {
query: {
resource: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The PDF templates have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PdfTemplatesController_createPdfTemplate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The PDF template has been successfully created. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PdfTemplatesController_getPdfTemplate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The PDF template details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The PDF template not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PdfTemplatesController_editPdfTemplate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The PDF template has been successfully edited. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The PDF template not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PdfTemplatesController_deletePdfTemplate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The PDF template has been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The PDF template not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PdfTemplatesController_getPdfTemplateBrandingState: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The PDF template branding state has been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PdfTemplatesController_assignPdfTemplateAsDefault: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The PDF template has been successfully assigned as default. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The PDF template not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AttachmentsController_uploadAttachment: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
/** @description Upload attachment */
requestBody: {
content: {
"multipart/form-data": components["schemas"]["UploadAttachmentDto"];
};
};
responses: {
/** @description The document has been uploaded successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Unauthorized - File upload failed */
401: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AttachmentsController_getAttachment: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Attachment ID */
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns the attachment file */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AttachmentsController_deleteAttachment: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Attachment ID */
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The document has been deleted successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AttachmentsController_linkDocument: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Attachment ID */
id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["LinkAttachmentDto"];
};
};
responses: {
/** @description The document has been linked successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AttachmentsController_unlinkDocument: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Attachment ID */
id: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UnlinkAttachmentDto"];
};
};
responses: {
/** @description The document has been unlinked successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
AttachmentsController_getAttachmentPresignedUrl: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Attachment ID */
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns the presigned URL for the attachment */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
TaxRatesController_getTaxRates: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The tax rates have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
data?: components["schemas"]["TaxRateResponseDto"][];
};
};
};
};
};
TaxRatesController_createTaxRate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateTaxRateDto"];
};
};
responses: {
/** @description The tax rate has been successfully created. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TaxRateResponseDto"];
};
};
};
};
TaxRatesController_getTaxRate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The tax rate details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TaxRateResponseDto"];
};
};
};
};
TaxRatesController_editTaxRate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditTaxRateDto"];
};
};
responses: {
/** @description The tax rate has been successfully updated. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TaxRateResponseDto"];
};
};
};
};
TaxRatesController_deleteTaxRate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The tax rate has been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TaxRateResponseDto"];
};
};
};
};
TaxRatesController_activateTaxRate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The tax rate has been successfully activated. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TaxRateResponseDto"];
};
};
};
};
TaxRatesController_inactivateTaxRate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The tax rate has been successfully inactivated. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TaxRateResponseDto"];
};
};
};
};
PaymentReceivesController_getPaymentReceiveMailOptions: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The payment receive mail options have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentReceivesController_sendPaymentReceiveMail: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The payment receive mail has been successfully sent. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentReceivesController_getPaymentReceiveEditPage: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The payment received edit page has been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentReceivesController_getPaymentsReceived: {
parameters: {
query?: {
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order (asc/desc) */
sortOrder?: string;
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The payment received has been retrieved successfully. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResponseDto"] & {
data?: components["schemas"]["PaymentReceivedResponseDto"][];
};
};
};
};
};
PaymentReceivesController_createPaymentReceived: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreatePaymentReceivedDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentReceivesController_getPaymentReceive: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The payment received details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaymentReceivedResponseDto"];
};
};
};
};
PaymentReceivesController_editPaymentReceive: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditPaymentReceivedDto"];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentReceivesController_deletePaymentReceive: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentReceivesController_validateBulkDeletePaymentsReceived: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Validation completed with counts and IDs of deletable and non-deletable payments received. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ValidateBulkDeleteResponseDto"];
};
};
};
};
PaymentReceivesController_bulkDeletePaymentsReceived: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Payments received deleted successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentReceivesController_getPaymentReceivedState: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The payment received state has been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaymentReceivedStateResponseDto"];
};
};
};
};
PaymentReceivesController_getPaymentReceiveInvoices: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The payment received invoices have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ImportController_fileUpload: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description File uploaded successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ImportController_mapping: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
import_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Mapping successful */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ImportController_preview: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
import_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Preview data */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ImportController_import: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
import_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Import processed successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ImportController_downloadImportSample: {
parameters: {
query: {
resource: string;
format: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Sample data */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ImportController_getImportFileMeta: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
import_id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Import metadata */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ResourceController_getResourceMeta: {
parameters: {
query?: never;
header?: never;
path: {
/** @description The resource model name (e.g., SaleInvoice, Customer, Item) */
resourceModel: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Retrieves the resource meta */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ResourceMetaResponseDto"];
};
};
};
};
PaymentLinksController_getPaymentLinkPublicMeta: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The ID of the payment link */
paymentLinkId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully retrieved payment link metadata */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GetInvoicePaymentLinkResponseWrapperDto"];
};
};
/** @description Payment link not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentLinksController_createInvoicePaymentLinkCheckoutSession: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The ID of the payment link */
paymentLinkId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully created Stripe checkout session */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CreateStripeCheckoutSessionResponseDto"];
};
};
/** @description Payment link not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentLinksController_getPaymentLinkInvoicePdf: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The ID of the payment link */
paymentLinkId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully retrieved invoice PDF */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/pdf": string;
};
};
/** @description Payment link or invoice not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
StripeIntegrationController_getStripeConnectLink: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully retrieved Stripe Connect link */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GetStripeConnectLinkResponseDto"];
};
};
};
};
StripeIntegrationController_exchangeOAuth: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ExchangeStripeOAuthBodyDto"];
};
};
responses: {
/** @description Successfully exchanged OAuth code */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
StripeIntegrationController_createAccount: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully created Stripe account */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CreateStripeAccountResponseDto"];
};
};
};
};
StripeIntegrationController_createAccountSession: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateStripeAccountSessionBodyDto"];
};
};
responses: {
/** @description Successfully created account session */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CreateStripeAccountSessionResponseDto"];
};
};
};
};
StripeIntegrationController_createAccountLink: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateStripeAccountLinkBodyDto"];
};
};
responses: {
/** @description Successfully created account link */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CreateStripeAccountLinkResponseDto"];
};
};
};
};
StripePaymentWebhooksController_handleWebhook: {
parameters: {
query?: never;
header: {
"stripe-signature": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ItemCategoryController_getItemCategories: {
parameters: {
query?: {
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order (asc/desc) */
sortOrder?: string;
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The item categories have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ItemCategoryResponseDto"][];
};
};
};
};
ItemCategoryController_createItemCategory: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateItemCategoryDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ItemCategoryController_getItemCategory: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The item category details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ItemCategoryResponseDto"];
};
};
};
};
ItemCategoryController_editItemCategory: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditItemCategoryDto"];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ItemCategoryController_deleteItemCategory: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ExpensesController_validateBulkDeleteExpenses: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Validation completed with counts and IDs of deletable and non-deletable expenses. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ValidateBulkDeleteResponseDto"];
};
};
};
};
ExpensesController_bulkDeleteExpenses: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Expenses deleted successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ExpensesController_getExpenses: {
parameters: {
query?: {
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order (asc/desc) */
sortOrder?: string;
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The item list has been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResponseDto"] & {
data?: components["schemas"]["ExpenseResponseDto"][];
};
};
};
};
};
ExpensesController_createExpense: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateExpenseDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ExpensesController_getExpense: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The expense transaction have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ExpenseResponseDto"];
};
};
};
};
ExpensesController_editExpense: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditExpenseDto"];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ExpensesController_deleteExpense: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ExpensesController_publishExpense: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
WarehouseTransfersController_getWarehousesTransfers: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The warehouse transfer transactions have been retrieved successfully. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResponseDto"] & {
data?: components["schemas"]["WarehouseTransferResponseDto"][];
};
};
};
};
};
WarehouseTransfersController_createWarehouseTransfer: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateWarehouseTransferDto"];
};
};
responses: {
/** @description The warehouse transfer transaction has been created successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
WarehouseTransfersController_getWarehouseTransfer: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The warehouse transfer transaction details have been retrieved successfully. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["WarehouseTransferResponseDto"];
};
};
};
};
WarehouseTransfersController_editWarehouseTransfer: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditWarehouseTransferDto"];
};
};
responses: {
/** @description The warehouse transfer transaction has been edited successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
WarehouseTransfersController_deleteWarehouseTransfer: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The warehouse transfer transaction has been deleted successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
WarehouseTransfersController_initiateTransfer: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The warehouse transfer has been initiated successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
WarehouseTransfersController_deliverTransfer: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The warehouse transfer has been marked as transferred successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CustomersController_getCustomer: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The customer details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CustomerResponseDto"];
};
};
};
};
CustomersController_editCustomer: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditCustomerDto"];
};
};
responses: {
/** @description The customer has been successfully updated. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CustomerResponseDto"];
};
};
};
};
CustomersController_deleteCustomer: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The customer has been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CustomersController_getCustomers: {
parameters: {
query?: {
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order (asc/desc) */
sortOrder?: string;
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The customers have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CustomerResponseDto"][];
};
};
};
};
CustomersController_createCustomer: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateCustomerDto"];
};
};
responses: {
/** @description The customer has been successfully created. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CustomerResponseDto"];
};
};
};
};
CustomersController_editOpeningBalance: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CustomerOpeningBalanceEditDto"];
};
};
responses: {
/** @description The customer opening balance has been successfully updated. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CustomerResponseDto"];
};
};
};
};
CustomersController_validateBulkDeleteCustomers: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteCustomersDto"];
};
};
responses: {
/** @description Validation completed. Returns counts and IDs of deletable and non-deletable customers. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ValidateBulkDeleteCustomersResponseDto"];
};
};
};
};
CustomersController_bulkDeleteCustomers: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteCustomersDto"];
};
};
responses: {
/** @description The customers have been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorsController_getVendors: {
parameters: {
query?: {
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order (asc/desc) */
sortOrder?: string;
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorsController_createVendor: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateVendorDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorsController_getVendor: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorsController_editVendor: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditVendorDto"];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorsController_deleteVendor: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorsController_editOpeningBalance: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["VendorOpeningBalanceEditDto"];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorsController_validateBulkDeleteVendors: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteVendorsDto"];
};
};
responses: {
/** @description Validation completed. Returns counts and IDs of deletable and non-deletable vendors. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ValidateBulkDeleteVendorsResponseDto"];
};
};
};
};
VendorsController_bulkDeleteVendors: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteVendorsDto"];
};
};
responses: {
/** @description The vendors have been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleEstimatesController_validateBulkDeleteSaleEstimates: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Validation completed with counts and IDs of deletable and non-deletable sale estimates. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ValidateBulkDeleteResponseDto"];
};
};
};
};
SaleEstimatesController_bulkDeleteSaleEstimates: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Sale estimates deleted successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleEstimatesController_getSaleEstimates: {
parameters: {
query?: {
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order (asc/desc) */
sortOrder?: string;
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Sale estimates retrieved successfully */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SaleEstimateResponseDto"] & {
data?: components["schemas"]["SaleEstimateResponseDto"][];
};
};
};
};
};
SaleEstimatesController_createSaleEstimate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateSaleEstimateDto"];
};
};
responses: {
/** @description Sale estimate created successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleEstimatesController_getSaleEstimate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path: {
/** @description The sale estimate id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sale estimate details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SaleEstimateResponseDto"];
};
};
};
};
SaleEstimatesController_editSaleEstimate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale estimate id */
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditSaleEstimateDto"];
};
};
responses: {
/** @description Sale estimate edited successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Sale estimate not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleEstimatesController_deleteSaleEstimate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale estimate id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Sale estimate deleted successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Sale estimate not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleEstimatesController_getSaleEstimateState: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Sale estimate state retrieved successfully */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SaleEstiamteStateResponseDto"];
};
};
};
};
SaleEstimatesController_deliverSaleEstimate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale estimate id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Sale estimate delivered successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleEstimatesController_approveSaleEstimate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale estimate id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleEstimatesController_rejectSaleEstimate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale estimate id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleEstimatesController_notifySaleEstimateBySms: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale estimate id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleEstimatesController_getSaleEstimateSmsDetails: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleEstimatesController_getSaleEstimateMail: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale estimate id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleEstimatesController_sendSaleEstimateMail: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale estimate id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleReceiptsController_validateBulkDeleteSaleReceipts: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Validation completed with counts and IDs of deletable and non-deletable sale receipts. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ValidateBulkDeleteResponseDto"];
};
};
};
};
SaleReceiptsController_bulkDeleteSaleReceipts: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Sale receipts deleted successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleReceiptsController_getSaleReceipts: {
parameters: {
query?: {
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order (asc/desc) */
sortOrder?: string;
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResponseDto"] & {
data?: components["schemas"]["SaleReceiptResponseDto"][];
};
};
};
};
};
SaleReceiptsController_createSaleReceipt: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateSaleReceiptDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleReceiptsController_getSaleReceiptMail: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale receipt id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleReceiptsController_sendSaleReceiptMail: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale receipt id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleReceiptsController_getSaleReceiptState: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sale receipt has been retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SaleReceiptStateResponseDto"];
};
};
};
};
SaleReceiptsController_getSaleReceipt: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path: {
/** @description The sale receipt id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The sale receipt details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SaleReceiptResponseDto"];
};
};
/** @description The sale receipt not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleReceiptsController_editSaleReceipt: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale receipt id */
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditSaleReceiptDto"];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleReceiptsController_deleteSaleReceipt: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale receipt id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SaleReceiptsController_closeSaleReceipt: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The sale receipt id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillsController_validateBulkDeleteBills: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Validation completed with counts and IDs of deletable and non-deletable bills. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ValidateBulkDeleteResponseDto"];
};
};
};
};
BillsController_bulkDeleteBills: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Bills deleted successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillsController_getBills: {
parameters: {
query?: {
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order (asc/desc) */
sortOrder?: string;
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The bill id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The bill details has been retrieved successfully */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResponseDto"] & {
data?: components["schemas"]["BillResponseDto"][];
};
};
};
};
};
BillsController_createBill: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateBillDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillsController_getBill: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The bill id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The bill details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BillResponseDto"];
};
};
};
};
BillsController_editBill: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The bill id */
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditBillDto"];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillsController_deleteBill: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The bill id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillsController_getBillPaymentTransactions: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The bill id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description List of payment transactions for the bill. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillsController_openBill: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The bill id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillsController_getDueBills: {
parameters: {
query?: {
/** @description Filter due bills by vendor ID. */
vendor_id?: number;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description List of due bills (optionally filtered by vendor). */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillAllocateLandedCostController_getLandedCostTransactions: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description List of landed cost transactions. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillAllocateLandedCostController_calculateLandedCost: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
billId: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AllocateBillLandedCostDto"];
};
};
responses: {
/** @description Landed cost allocated successfully. */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillAllocateLandedCostController_deleteAllocatedLandedCost: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
allocatedLandedCostId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Allocated landed cost deleted successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillAllocateLandedCostController_getBillLandedCostTransactions: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
billId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description List of bill landed cost transactions. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ManualJournalsController_validateBulkDeleteManualJournals: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Validation completed with counts and IDs of deletable and non-deletable manual journals. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ValidateBulkDeleteResponseDto"];
};
};
};
};
ManualJournalsController_bulkDeleteManualJournals: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Manual journals deleted successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ManualJournalsController_getManualJournals: {
parameters: {
query?: {
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order (asc/desc) */
sortOrder?: string;
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The manual journal details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ManualJournalResponseDto"][];
};
};
/** @description The manual journal not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ManualJournalsController_createManualJournal: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateManualJournalDto"];
};
};
responses: {
/** @description The manual journal has been successfully created. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ManualJournalResponseDto"];
};
};
};
};
ManualJournalsController_getManualJournal: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The manual journal id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The manual journal details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ManualJournalResponseDto"];
};
};
/** @description The manual journal not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ManualJournalsController_editManualJournal: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The manual journal id */
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditManualJournalDto"];
};
};
responses: {
/** @description The manual journal has been successfully edited. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ManualJournalResponseDto"];
};
};
/** @description The manual journal not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ManualJournalsController_deleteManualJournal: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The manual journal id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The manual journal has been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The manual journal not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ManualJournalsController_publishManualJournal: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The manual journal id */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The manual journal has been successfully published. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ManualJournalResponseDto"];
};
};
/** @description The manual journal not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CreditNotesController_getCreditNotes: {
parameters: {
query?: {
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order (asc/desc) */
sortOrder?: string;
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns a list of credit notes */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResponseDto"] & {
data?: components["schemas"]["CreditNoteResponseDto"][];
};
};
};
};
};
CreditNotesController_createCreditNote: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateCreditNoteDto"];
};
};
responses: {
/** @description Credit note successfully created */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Invalid input data */
400: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CreditNotesController_getCreditNoteState: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns the credit note state */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CreditNoteStateResponseDto"];
};
};
};
};
CreditNotesController_getCreditNote: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path: {
/** @description Credit note ID */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns the credit note */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CreditNoteResponseDto"];
};
};
/** @description Credit note not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CreditNotesController_editCreditNote: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Credit note ID */
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditCreditNoteDto"];
};
};
responses: {
/** @description Credit note successfully updated */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Invalid input data */
400: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Credit note not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CreditNotesController_deleteCreditNote: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Credit note ID */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Credit note successfully deleted */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Credit note not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CreditNotesController_openCreditNote: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Credit note ID */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Credit note successfully opened */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Credit note not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CreditNotesController_validateBulkDeleteCreditNotes: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Validation completed with counts and IDs of deletable and non-deletable credit notes. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ValidateBulkDeleteResponseDto"];
};
};
};
};
CreditNotesController_bulkDeleteCreditNotes: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Credit notes deleted successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CreditNoteRefundsController_getCreditNoteRefunds: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
creditNoteId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Credit note refunds retrieved successfully. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["RefundCreditNoteResponseDto"][];
};
};
};
};
CreditNoteRefundsController_createRefundCreditNote: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
creditNoteId: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreditNoteRefundDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CreditNoteRefundsController_getRefundCreditNoteTransaction: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
refundCreditId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Refund credit note transaction retrieved successfully. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["RefundCreditNoteResponseDto"];
};
};
};
};
CreditNoteRefundsController_deleteRefundCreditNote: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
refundCreditId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CreditNotesApplyInvoiceController_appliedCreditNoteToInvoices: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
creditNoteId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Credit note successfully applied to invoices */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["AppliedCreditNoteInvoiceResponseDto"][];
};
};
/** @description Invalid input data */
400: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Credit note not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CreditNotesApplyInvoiceController_getCreditNoteAssociatedInvoicesToApply: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
creditNoteId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Credit note associated invoices to apply */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CreditNoteInvoiceToApplyResponseDto"][];
};
};
/** @description Invalid input data */
400: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Credit note not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CreditNotesApplyInvoiceController_applyCreditNoteToInvoices: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
creditNoteId: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ApplyCreditNoteToInvoicesDto"];
};
};
responses: {
/** @description Credit note successfully applied to invoices */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Invalid input data */
400: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Credit note not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CreditNotesApplyInvoiceController_deleteApplyCreditNoteToInvoices: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
applyCreditToInvoicesId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Credit note application successfully deleted */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Credit note application not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditsController_validateBulkDeleteVendorCredits: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Validation completed with counts and IDs of deletable and non-deletable vendor credits. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ValidateBulkDeleteResponseDto"];
};
};
};
};
VendorCreditsController_bulkDeleteVendorCredits: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BulkDeleteDto"];
};
};
responses: {
/** @description Vendor credits deleted successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditsController_getVendorCredits: {
parameters: {
query?: {
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order (asc/desc) */
sortOrder?: string;
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditsController_createVendorCredit: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateVendorCreditDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditsController_openVendorCredit: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditsController_getVendorCredit: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditsController_editVendorCredit: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditVendorCreditDto"];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditsController_deleteVendorCredit: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditApplyBillsController_getVendorCreditToApplyBills: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
vendorCreditId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditApplyBillsController_applyVendorCreditToBills: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
vendorCreditId: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ApplyVendorCreditToBillsDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditApplyBillsController_deleteAppliedBillToVendorCredit: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
vendorCreditAppliedBillId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditApplyBillsController_getAppliedBillsToVendorCredit: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
vendorCreditId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillPaymentsController_getBillPayments: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The bill payments have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResponseDto"] & {
data?: components["schemas"]["BillPaymentResponseDto"][];
};
};
};
};
};
BillPaymentsController_createBillPayment: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateBillPaymentDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillPaymentsController_getBillPayment: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The bill payment id */
billPaymentId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The bill payment details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BillPaymentResponseDto"];
};
};
};
};
BillPaymentsController_editBillPayment: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The bill payment id */
billPaymentId: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditBillPaymentDto"];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillPaymentsController_deleteBillPayment: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The bill payment id */
billPaymentId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillPaymentsController_getBillPaymentNewPageEntries: {
parameters: {
query: {
/** @description The vendor id */
vendorId: number;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillPaymentsController_getPaymentBills: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The bill payment id */
billPaymentId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BillPaymentsController_getBillPaymentEditPage: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The bill payment id */
billPaymentId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditsRefundController_getRefundVendorCreditTransaction: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
refundCreditId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditsRefundController_deleteRefundVendorCredit: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
refundCreditId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditsRefundController_getVendorCreditRefunds: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
vendorCreditId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
VendorCreditsRefundController_createRefundVendorCredit: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
vendorCreditId: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["RefundVendorCreditDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankAccountsController_getBankAccounts: {
parameters: {
query?: {
/** @description Custom view ID */
customViewId?: number;
/** @description Filter roles array */
filterRoles?: string[];
/** @description Column to sort by */
columnSortBy?: string;
/** @description Sort order */
sortOrder?: "DESC" | "ASC";
/** @description Stringified filter roles */
stringifiedFilterRoles?: string;
/** @description Search keyword */
searchKeyword?: string;
/** @description View slug */
viewSlug?: string;
/** @description Page number */
page?: number;
/** @description Page size */
pageSize?: number;
/** @description Include inactive accounts */
inactiveMode?: boolean;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description List of bank accounts retrieved successfully. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BankAccountResponseDto"][];
};
};
};
};
BankAccountsController_getBankAccountSummary: {
parameters: {
query?: never;
header?: never;
path: {
bankAccountId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankAccountsController_disconnectBankAccount: {
parameters: {
query?: never;
header?: never;
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Bank account disconnected successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Bank account not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankAccountsController_refreshBankAccount: {
parameters: {
query?: never;
header?: never;
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Bank account transactions refreshed successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Bank account not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankAccountsController_pauseBankAccount: {
parameters: {
query?: never;
header?: never;
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Bank account transactions paused successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Bank account not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankAccountsController_resumeBankAccount: {
parameters: {
query?: never;
header?: never;
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Bank account transactions resumed successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Bank account not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingPlaidController_getLinkToken: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingPlaidController_exchangeToken: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PlaidItemDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingPlaidWebhooksController_webhooks: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["PlaidWebhookDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingCategorizeController_categorizeTransaction: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CategorizeBankTransactionRouteDto"];
};
};
responses: {
/** @description The bank transactions have been categorized successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingCategorizeController_uncategorizeTransactionsBulk: {
parameters: {
query: {
/** @description Array of uncategorized transaction IDs to uncategorize */
uncategorizedTransactionIds: unknown[];
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The bank transactions have been uncategorized successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingCategorizeController_uncategorizeTransaction: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Uncategorized transaction ID to uncategorize */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The bank transaction has been uncategorized successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingTransactionsController_getBankAccountTransactions: {
parameters: {
query: {
/** @description Page number for pagination */
page?: number;
/** @description Number of items per page */
pageSize?: number;
/** @description Bank account ID */
accountId: number;
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns a list of bank account transactions */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResponseDto"] & {
data?: components["schemas"]["BankTransactionResponseDto"][];
};
};
};
};
};
BankingTransactionsController_createTransaction: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateBankTransactionDto"];
};
};
responses: {
/** @description The bank transaction has been successfully created */
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Invalid input data */
400: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingTransactionsController_getTransaction: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Bank transaction ID */
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns the bank transaction details */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BankTransactionResponseDto"];
};
};
/** @description Bank transaction not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingTransactionsController_deleteTransaction: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Bank transaction ID */
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The bank transaction has been successfully deleted */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Bank transaction not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingUncategorizedTransactionsController_getAutofillCategorizeTransaction: {
parameters: {
query: {
/** @description Uncategorized transaction IDs to get autofill for */
uncategorizedTransactionIds: unknown[];
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns autofill values for categorize transactions */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GetAutofillCategorizeTransactionResponseDto"];
};
};
};
};
BankingUncategorizedTransactionsController_getBankAccountUncategorizedTransactions: {
parameters: {
query?: {
/** @description Page number for pagination */
page?: number;
/** @description Number of items per page */
pageSize?: number;
/** @description Minimum date for filtering transactions */
minDate?: string;
/** @description Maximum date for filtering transactions */
maxDate?: string;
/** @description Minimum amount for filtering transactions */
minAmount?: number;
/** @description Maximum amount for filtering transactions */
maxAmount?: number;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Bank account ID */
accountId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns a list of uncategorized transactions for the specified bank account */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingUncategorizedTransactionsController_getUncategorizedTransaction: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Uncategorized transaction ID */
uncategorizedTransactionId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns the uncategorized transaction details */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Uncategorized transaction not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingPendingTransactionsController_getPendingTransactions: {
parameters: {
query?: {
/** @description Page number for pagination */
page?: number;
/** @description Number of items per page */
pageSize?: number;
/** @description Filter by bank account ID */
accountId?: number;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns a list of pending bank account transactions */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResponseDto"] & {
data?: components["schemas"]["GetPendingTransactionResponseDto"][];
};
};
};
};
};
BankRulesController_getBankRules: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The bank rules have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BankRuleResponseDto"][];
};
};
};
};
BankRulesController_createBankRule: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateBankRuleDto"];
};
};
responses: {
/** @description The bank rule has been successfully created. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BankRuleResponseDto"];
};
};
};
};
BankRulesController_getBankRule: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The bank rule details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["BankRuleResponseDto"];
};
};
};
};
BankRulesController_editBankRule: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditBankRuleDto"];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankRulesController_deleteBankRule: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The bank rule has been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingRecognizedTransactionsController_getRecognizedTransaction: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The ID of the recognized transaction */
recognizedTransactionId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns the recognized transaction details */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GetRecognizedTransactionResponseDto"];
};
};
/** @description Recognized transaction not found */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingRecognizedTransactionsController_getRecognizedTransactions: {
parameters: {
query?: {
/** @description Query parameters for filtering recognized transactions */
query?: unknown;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns a list of recognized transactions */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResponseDto"] & {
data?: components["schemas"]["GetRecognizedTransactionResponseDto"][];
};
};
};
};
};
BankingTransactionsExcludeController_excludeBankTransactions: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ExcludeBankTransactionsBulkDto"];
};
};
responses: {
/** @description Bank transactions excluded successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingTransactionsExcludeController_unexcludeBankTransactions: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ExcludeBankTransactionsBulkDto"];
};
};
responses: {
/** @description Bank transactions unexcluded successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingTransactionsExcludeController_getExcludedBankTransactions: {
parameters: {
query?: {
/** @description Page number */
page?: number;
/** @description Page size */
pageSize?: number;
/** @description Filter by bank account ID */
accountId?: number;
/** @description Minimum date (ISO) */
minDate?: string;
/** @description Maximum date (ISO) */
maxDate?: string;
/** @description Minimum amount */
minAmount?: number;
/** @description Maximum amount */
maxAmount?: number;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The excluded bank transactions has been retrieved successfully. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PaginatedResponseDto"] & {
data?: components["schemas"]["GetExcludedBankTransactionResponseDto"][];
};
};
};
};
};
BankingTransactionsExcludeController_excludeBankTransaction: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingTransactionsExcludeController_unexcludeBankTransaction: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingMatchingController_getMatchedTransactions: {
parameters: {
query: {
/** @description Uncategorized transaction IDs to match */
uncategorizedTransactionIds: unknown[];
/** @description Filter from date */
fromDate?: string;
/** @description Filter to date */
toDate?: string;
/** @description Minimum amount */
minAmount?: number;
/** @description Maximum amount */
maxAmount?: number;
/** @description Transaction type filter */
transactionType?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Matched transactions (perfect and possible matches). */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GetMatchedTransactionsResponseDto"];
};
};
};
};
BankingMatchingController_matchTransaction: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["MatchBankTransactionDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BankingMatchingController_unmatchMatchedTransaction: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
uncategorizedTransactionId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
TransactionsLockingController_commandTransactionsLocking: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["TransactionsLockingDto"];
};
};
responses: {
/** @description The transactions have been successfully locked. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TransactionLockingResponseDto"];
};
};
};
};
TransactionsLockingController_cancelTransactionLocking: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CancelTransactionsLockingDto"];
};
};
responses: {
/** @description The transactions locking has been successfully canceled. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TransactionLockingResponseDto"];
};
};
};
};
TransactionsLockingController_unlockTransactionsLockingBetweenPeriod: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The transactions have been successfully partially unlocked. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TransactionLockingResponseDto"];
};
};
};
};
TransactionsLockingController_cancelPartialUnlocking: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The partial transaction unlocking has been successfully canceled. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TransactionLockingResponseDto"];
};
};
};
};
TransactionsLockingController_getTransactionLockingMetaList: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The transactions locking meta has been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TransactionLockingResponseDto"];
};
};
};
};
TransactionsLockingController_getTransactionLockingMeta: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
module: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The module transactions locking meta has been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TransactionLockingResponseDto"];
};
};
};
};
SettingsController_getSettings: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SettingsController_saveSettings: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
BalanceSheetStatementController_balanceSheet: {
parameters: {
query: {
/** @description Type of columns to display in the balance sheet */
displayColumnsType: "total" | "date_periods";
/** @description Time period for column display */
displayColumnsBy: "day" | "month" | "year" | "quarter";
/** @description Start date for the balance sheet period */
fromDate?: string;
/** @description End date for the balance sheet period */
toDate?: string;
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Whether to include accounts with no transactions */
noneTransactions?: boolean;
/** @description Whether to exclude zero balance accounts */
noneZero?: boolean;
/** @description Accounting basis for the balance sheet */
basis?: "cash" | "accrual";
/** @description Array of account IDs to include in the balance sheet */
accountIds: number[];
/** @description Whether to show percentage of column total */
percentageOfColumn?: boolean;
/** @description Whether to show percentage of row total */
percentageOfRow?: boolean;
/** @description Whether to include previous period data */
previousPeriod?: boolean;
/** @description Whether to show amount change from previous period */
previousPeriodAmountChange?: boolean;
/** @description Whether to show percentage change from previous period */
previousPeriodPercentageChange?: boolean;
/** @description Whether to include previous year data */
previousYear?: boolean;
/** @description Whether to show amount change from previous year */
previousYearAmountChange?: boolean;
/** @description Whether to show percentage change from previous year */
previousYearPercentageChange?: boolean;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Balance sheet statement */
200: {
headers: {
[name: string]: unknown;
};
content: {
/**
* @example {
* "query": {
* "display_columns_type": "total",
* "display_columns_by": "year",
* "from_date": "2025-01-01",
* "to_date": "2025-06-16",
* "number_format": {
* "precision": 2,
* "divide_on1000": false,
* "show_zero": false,
* "format_money": "total",
* "negative_format": "mines"
* },
* "none_zero": false,
* "none_transactions": false,
* "basis": "cash",
* "account_ids": [],
* "percentage_of_column": false,
* "percentage_of_row": false,
* "previous_period": false,
* "previous_period_amount_change": false,
* "previous_period_percentage_change": false,
* "previous_year": false,
* "previous_year_amount_change": false,
* "previous_year_percentage_change": false
* },
* "data": [
* {
* "name": "Assets",
* "id": "ASSETS",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": -122623,
* "formatted_amount": "-$122,623.00",
* "currency_code": "USD"
* },
* "children": [
* {
* "name": "Current Asset",
* "id": "CURRENT_ASSETS",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": -122623,
* "formatted_amount": "-$122,623.00",
* "currency_code": "USD"
* },
* "children": [
* {
* "name": "Cash and cash equivalents",
* "id": "CASH_EQUIVALENTS",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": -500,
* "formatted_amount": "-$500.00",
* "currency_code": "USD"
* },
* "children": [
* {
* "id": 1002,
* "index": 1,
* "name": "Undeposited Funds",
* "code": "10003",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1003,
* "index": 1,
* "name": "Petty Cash",
* "code": "10004",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1000,
* "index": 1,
* "name": "Bank Account",
* "code": "10001",
* "total": {
* "amount": -500,
* "formatted_amount": "-500.00",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1001,
* "index": 1,
* "name": "Saving Bank Account",
* "code": "10002",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1034,
* "index": null,
* "name": "Chase - Plaid Checking",
* "code": "",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* }
* ]
* },
* {
* "name": "Accounts Receivable",
* "id": "ACCOUNTS_RECEIVABLE",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD"
* },
* "children": [
* {
* "id": 1006,
* "index": 1,
* "name": "Accounts Receivable (A/R)",
* "code": "10007",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* }
* ]
* },
* {
* "name": "Inventory",
* "id": "INVENTORY",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": 1000,
* "formatted_amount": "$1,000.00",
* "currency_code": "USD"
* },
* "children": [
* {
* "id": 1007,
* "index": 1,
* "name": "Inventory Asset",
* "code": "10008",
* "total": {
* "amount": 1000,
* "formatted_amount": "1,000.00",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* }
* ]
* },
* {
* "name": "Other current assets",
* "id": "OTHER_CURRENT_ASSET",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": -123123,
* "formatted_amount": "-$123,123.00",
* "currency_code": "USD"
* },
* "children": [
* {
* "id": 1030,
* "index": 1,
* "name": "Prepaid Expenses",
* "code": "100010",
* "total": {
* "amount": -123123,
* "formatted_amount": "-123,123.00",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* }
* ]
* }
* ]
* },
* {
* "name": "Fixed Asset",
* "id": "FIXED_ASSET",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD"
* },
* "children": [
* {
* "id": 1004,
* "index": 1,
* "name": "Computer Equipment",
* "code": "10005",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1005,
* "index": 1,
* "name": "Office Equipment",
* "code": "10006",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* }
* ]
* },
* {
* "name": "Non-Current Assets",
* "id": "NON_CURRENT_ASSET",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD"
* },
* "children": []
* }
* ]
* },
* {
* "name": "Liabilities and Equity",
* "id": "LIABILITY_EQUITY",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": -122623,
* "formatted_amount": "-$122,623.00",
* "currency_code": "USD"
* },
* "children": [
* {
* "name": "Liabilities",
* "id": "LIABILITY",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": -8700,
* "formatted_amount": "-$8,700.00",
* "currency_code": "USD"
* },
* "children": [
* {
* "name": "Current Liabilities",
* "id": "CURRENT_LIABILITY",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": -8700,
* "formatted_amount": "-$8,700.00",
* "currency_code": "USD"
* },
* "children": [
* {
* "id": 1008,
* "index": 1,
* "name": "Accounts Payable (A/P)",
* "code": "20001",
* "total": {
* "amount": 1300,
* "formatted_amount": "1,300.00",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1013,
* "index": 1,
* "name": "Tax Payable",
* "code": "20006",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1009,
* "index": 1,
* "name": "Owner A Drawings",
* "code": "20002",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1010,
* "index": 1,
* "name": "Loan",
* "code": "20003",
* "total": {
* "amount": -10000,
* "formatted_amount": "-10,000.00",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1011,
* "index": 1,
* "name": "Opening Balance Liabilities",
* "code": "20004",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1012,
* "index": 1,
* "name": "Revenue Received in Advance",
* "code": "20005",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1029,
* "index": 1,
* "name": "Unearned Revenue",
* "code": "50005",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* }
* ]
* },
* {
* "name": "Long-Term Liabilities",
* "id": "LOGN_TERM_LIABILITY",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD"
* },
* "children": []
* },
* {
* "name": "Non-Current Liabilities",
* "id": "NON_CURRENT_LIABILITY",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD"
* },
* "children": []
* }
* ]
* },
* {
* "name": "Equity",
* "id": "EQUITY",
* "node_type": "AGGREGATE",
* "type": "AGGREGATE",
* "total": {
* "amount": -113923,
* "formatted_amount": "-$113,923.00",
* "currency_code": "USD"
* },
* "children": [
* {
* "id": 1014,
* "index": 1,
* "name": "Retained Earnings",
* "code": "30001",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1015,
* "index": 1,
* "name": "Opening Balance Equity",
* "code": "30002",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1016,
* "index": 1,
* "name": "Owner's Equity",
* "code": "30003",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": 1017,
* "index": 1,
* "name": "Drawings",
* "code": "30003",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "node_type": "ACCOUNT",
* "children": []
* },
* {
* "id": "NET_INCOME",
* "name": "Net Income",
* "node_type": "NET_INCOME",
* "total": {
* "amount": -113923,
* "formatted_amount": "-$113,923.00",
* "currency_code": "USD"
* },
* "children": []
* }
* ]
* }
* ]
* }
* ],
* "meta": {
* "organization_name": "BIGCAPITAL, INC",
* "base_currency": "USD",
* "date_format": "DD MMM yyyy",
* "is_cost_compute_running": false,
* "sheet_name": "Balance Sheet Statement",
* "formatted_as_date": "2025/06/16",
* "formatted_date_range": "As 2025/06/16"
* }
* }
*/
"application/json": components["schemas"]["BalanceSheetResponseDto"];
/**
* @example {
* "table": {
* "columns": [
* {
* "key": "name",
* "label": "Account name",
* "cell_index": 0
* },
* {
* "key": "total",
* "label": "Total",
* "children": [],
* "cell_index": 1
* }
* ],
* "rows": [
* {
* "cells": [
* {
* "key": "name",
* "value": "Assets"
* },
* {
* "key": "total",
* "value": "-$122,623.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "ASSETS",
* "children": [
* {
* "cells": [
* {
* "key": "name",
* "value": "Current Asset"
* },
* {
* "key": "total",
* "value": "-$122,623.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "CURRENT_ASSETS",
* "children": [
* {
* "cells": [
* {
* "key": "name",
* "value": "Cash and cash equivalents"
* },
* {
* "key": "total",
* "value": "-$500.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "CASH_EQUIVALENTS",
* "children": [
* {
* "cells": [
* {
* "key": "name",
* "value": "Undeposited Funds"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1002
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Petty Cash"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1003
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Bank Account"
* },
* {
* "key": "total",
* "value": "-500.00"
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1000
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Saving Bank Account"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1001
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Chase - Plaid Checking"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1034
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Total Cash and cash equivalents"
* },
* {
* "key": "total",
* "value": "-$500.00"
* }
* ],
* "row_types": [
* "TOTAL"
* ],
* "id": "CASH_EQUIVALENTS"
* }
* ]
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Accounts Receivable"
* },
* {
* "key": "total",
* "value": "$0.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "ACCOUNTS_RECEIVABLE",
* "children": [
* {
* "cells": [
* {
* "key": "name",
* "value": "Accounts Receivable (A/R)"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1006
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Total Accounts Receivable"
* },
* {
* "key": "total",
* "value": "$0.00"
* }
* ],
* "row_types": [
* "TOTAL"
* ],
* "id": "ACCOUNTS_RECEIVABLE"
* }
* ]
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Inventory"
* },
* {
* "key": "total",
* "value": "$1,000.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "INVENTORY",
* "children": [
* {
* "cells": [
* {
* "key": "name",
* "value": "Inventory Asset"
* },
* {
* "key": "total",
* "value": "1,000.00"
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1007
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Total Inventory"
* },
* {
* "key": "total",
* "value": "$1,000.00"
* }
* ],
* "row_types": [
* "TOTAL"
* ],
* "id": "INVENTORY"
* }
* ]
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Other current assets"
* },
* {
* "key": "total",
* "value": "-$123,123.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "OTHER_CURRENT_ASSET",
* "children": [
* {
* "cells": [
* {
* "key": "name",
* "value": "Prepaid Expenses"
* },
* {
* "key": "total",
* "value": "-123,123.00"
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1030
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Total Other current assets"
* },
* {
* "key": "total",
* "value": "-$123,123.00"
* }
* ],
* "row_types": [
* "TOTAL"
* ],
* "id": "OTHER_CURRENT_ASSET"
* }
* ]
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Total Current Asset"
* },
* {
* "key": "total",
* "value": "-$122,623.00"
* }
* ],
* "row_types": [
* "TOTAL"
* ],
* "id": "CURRENT_ASSETS"
* }
* ]
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Fixed Asset"
* },
* {
* "key": "total",
* "value": "$0.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "FIXED_ASSET",
* "children": [
* {
* "cells": [
* {
* "key": "name",
* "value": "Computer Equipment"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1004
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Office Equipment"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1005
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Total Fixed Asset"
* },
* {
* "key": "total",
* "value": "$0.00"
* }
* ],
* "row_types": [
* "TOTAL"
* ],
* "id": "FIXED_ASSET"
* }
* ]
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Non-Current Assets"
* },
* {
* "key": "total",
* "value": "$0.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "NON_CURRENT_ASSET"
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Total Assets"
* },
* {
* "key": "total",
* "value": "-$122,623.00"
* }
* ],
* "row_types": [
* "TOTAL"
* ],
* "id": "ASSETS"
* }
* ]
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Liabilities and Equity"
* },
* {
* "key": "total",
* "value": "-$122,623.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "LIABILITY_EQUITY",
* "children": [
* {
* "cells": [
* {
* "key": "name",
* "value": "Liabilities"
* },
* {
* "key": "total",
* "value": "-$8,700.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "LIABILITY",
* "children": [
* {
* "cells": [
* {
* "key": "name",
* "value": "Current Liabilities"
* },
* {
* "key": "total",
* "value": "-$8,700.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "CURRENT_LIABILITY",
* "children": [
* {
* "cells": [
* {
* "key": "name",
* "value": "Accounts Payable (A/P)"
* },
* {
* "key": "total",
* "value": "1,300.00"
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1008
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Tax Payable"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1013
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Owner A Drawings"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1009
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Loan"
* },
* {
* "key": "total",
* "value": "-10,000.00"
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1010
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Opening Balance Liabilities"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1011
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Revenue Received in Advance"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1012
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Unearned Revenue"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1029
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Total Current Liabilities"
* },
* {
* "key": "total",
* "value": "-$8,700.00"
* }
* ],
* "row_types": [
* "TOTAL"
* ],
* "id": "CURRENT_LIABILITY"
* }
* ]
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Long-Term Liabilities"
* },
* {
* "key": "total",
* "value": "$0.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "LOGN_TERM_LIABILITY"
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Non-Current Liabilities"
* },
* {
* "key": "total",
* "value": "$0.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "NON_CURRENT_LIABILITY"
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Total Liabilities"
* },
* {
* "key": "total",
* "value": "-$8,700.00"
* }
* ],
* "row_types": [
* "TOTAL"
* ],
* "id": "LIABILITY"
* }
* ]
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Equity"
* },
* {
* "key": "total",
* "value": "-$113,923.00"
* }
* ],
* "row_types": [
* "AGGREGATE"
* ],
* "id": "EQUITY",
* "children": [
* {
* "cells": [
* {
* "key": "name",
* "value": "Retained Earnings"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1014
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Opening Balance Equity"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1015
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Owner's Equity"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1016
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Drawings"
* },
* {
* "key": "total",
* "value": ""
* }
* ],
* "row_types": [
* "ACCOUNT"
* ],
* "id": 1017
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Net Income"
* },
* {
* "key": "total",
* "value": "-$113,923.00"
* }
* ],
* "row_types": [
* "NET_INCOME"
* ],
* "id": "NET_INCOME"
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Total Equity"
* },
* {
* "key": "total",
* "value": "-$113,923.00"
* }
* ],
* "row_types": [
* "TOTAL"
* ],
* "id": "EQUITY"
* }
* ]
* },
* {
* "cells": [
* {
* "key": "name",
* "value": "Total Liabilities and Equity"
* },
* {
* "key": "total",
* "value": "-$122,623.00"
* }
* ],
* "row_types": [
* "TOTAL"
* ],
* "id": "LIABILITY_EQUITY"
* }
* ]
* }
* ]
* },
* "query": {
* "display_columns_type": "total",
* "display_columns_by": "year",
* "from_date": "2025-01-01",
* "to_date": "2025-06-21",
* "number_format": {
* "precision": 2,
* "divide_on1000": false,
* "show_zero": false,
* "format_money": "total",
* "negative_format": "mines"
* },
* "none_zero": false,
* "none_transactions": false,
* "basis": "cash",
* "account_ids": [],
* "percentage_of_column": false,
* "percentage_of_row": false,
* "previous_period": false,
* "previous_period_amount_change": false,
* "previous_period_percentage_change": false,
* "previous_year": false,
* "previous_year_amount_change": false,
* "previous_year_percentage_change": false
* },
* "meta": {
* "organization_name": "BIGCAPITAL, INC",
* "base_currency": "USD",
* "date_format": "DD MMM yyyy",
* "is_cost_compute_running": false,
* "sheet_name": "Balance Sheet Statement",
* "formatted_as_date": "2025/06/21",
* "formatted_date_range": "As 2025/06/21"
* }
* }
*/
"application/json+table": components["schemas"]["BalanceSheetTableResponseDto"];
};
};
};
};
PurchasesByItemReportController_purchasesByItems: {
parameters: {
query?: {
/** @description Start date for the purchases by items report */
fromDate?: string;
/** @description End date for the purchases by items report */
toDate?: string;
/** @description Array of item IDs to filter the purchases report */
itemsIds?: number[];
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Whether to exclude items with no transactions */
noneTransactions?: boolean;
/** @description Whether to include only active items */
onlyActive?: boolean;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Purchases by items report */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["PurchasesByItemsResponseDto"];
"application/json+table": components["schemas"]["PurchasesByItemsTableResponseDto"];
};
};
};
};
CustomerBalanceSummaryController_customerBalanceSummary: {
parameters: {
query?: {
/** @description The date as of which the balance summary is calculated */
asDate?: string;
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Whether to show the percentage column in the summary */
percentageColumn?: boolean;
/** @description Whether to exclude contacts with no transactions */
noneTransactions?: boolean;
/** @description Whether to exclude contacts with zero balance */
noneZero?: boolean;
/** @description Array of customer IDs to filter the summary */
customersIds?: number[];
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Customer balance summary report */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CustomerBalanceSummaryResponseDto"];
"application/json+table": components["schemas"]["CustomerBalanceSummaryTableResponseDto"];
};
};
};
};
VendorBalanceSummaryController_vendorBalanceSummary: {
parameters: {
query?: {
/** @description The date as of which the balance summary is calculated */
asDate?: string;
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Whether to show the percentage column in the summary */
percentageColumn?: boolean;
/** @description Whether to exclude contacts with no transactions */
noneTransactions?: boolean;
/** @description Whether to exclude contacts with zero balance */
noneZero?: boolean;
/** @description Array of vendor IDs to filter the summary */
vendorsIds?: number[];
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Vendor balance summary */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["VendorBalanceSummaryResponseDto"];
"application/json+table": components["schemas"]["VendorBalanceSummaryTableResponseDto"];
};
};
};
};
SalesByItemsController_salesByitems: {
parameters: {
query?: {
/** @description Start date for the sales by items report */
fromDate?: string;
/** @description End date for the sales by items report */
toDate?: string;
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Whether to exclude items with no transactions */
noneTransactions?: boolean;
/** @description Whether to include only active items */
onlyActive?: boolean;
/** @description Array of item IDs to filter the sales report */
itemsIds?: number[];
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Sales by items report */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SalesByItemsResponseDto"];
"application/json+table": components["schemas"]["SalesByItemsTableResponseDto"];
};
};
};
};
GeneralLedgerController_getGeneralLedger: {
parameters: {
query?: {
/** @description Accounting basis for the report (e.g., cash, accrual) */
basis?: string;
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Whether to exclude transactions from the report */
noneTransactions?: boolean;
/** @description Array of account IDs to filter the report */
accountsIds?: number[];
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description General ledger report */
200: {
headers: {
[name: string]: unknown;
};
content: {
/**
* @example {
* "query": {
* "from_date": "2025-06-01",
* "to_date": "2025-06-16",
* "basis": "cash",
* "number_format": {
* "no_cents": false,
* "divide_on1000": false
* },
* "none_zero": false,
* "accounts_ids": []
* },
* "data": [
* {
* "id": 1008,
* "name": "Accounts Payable (A/P)",
* "code": "20001",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "reference_type": "Bill",
* "reference_id": 4,
* "transaction_number": null,
* "transaction_type_formatted": "Bill",
* "contact_name": "business",
* "contact_type": "customer",
* "transaction_type": "Bill",
* "index": 1,
* "note": null,
* "credit": 1000,
* "debit": 0,
* "amount": 1000,
* "running_balance": 1000,
* "formatted_amount": "1,000.00",
* "formatted_credit": "1,000.00",
* "formatted_debit": "0.00",
* "formatted_running_balance": "1,000.00",
* "currency_code": "USD"
* },
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "reference_type": "Bill",
* "reference_id": 5,
* "transaction_number": null,
* "transaction_type_formatted": "Bill",
* "contact_name": "business",
* "contact_type": "customer",
* "transaction_type": "Bill",
* "index": 1,
* "note": null,
* "credit": 1000,
* "debit": 0,
* "amount": 1000,
* "running_balance": 2000,
* "formatted_amount": "1,000.00",
* "formatted_credit": "1,000.00",
* "formatted_debit": "0.00",
* "formatted_running_balance": "2,000.00",
* "currency_code": "USD"
* },
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "reference_type": "BillPayment",
* "reference_id": 3,
* "transaction_number": "",
* "transaction_type_formatted": "transaction_type.payment_made",
* "contact_name": "business",
* "contact_type": "customer",
* "transaction_type": "BillPayment",
* "index": 1,
* "note": null,
* "credit": 0,
* "debit": 500,
* "amount": -500,
* "running_balance": 1500,
* "formatted_amount": "-500.00",
* "formatted_credit": "0.00",
* "formatted_debit": "500.00",
* "formatted_running_balance": "1,500.00",
* "currency_code": "USD"
* },
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "reference_type": "VendorCredit",
* "reference_id": 3,
* "transaction_number": "VC-00001",
* "transaction_type_formatted": "Vendor Credit",
* "contact_name": "business",
* "contact_type": "customer",
* "transaction_type": "VendorCredit",
* "index": 1,
* "note": null,
* "credit": 0,
* "debit": 100,
* "amount": -100,
* "running_balance": 1400,
* "formatted_amount": "-100.00",
* "formatted_credit": "0.00",
* "formatted_debit": "100.00",
* "formatted_running_balance": "1,400.00",
* "currency_code": "USD"
* },
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "reference_type": "VendorCredit",
* "reference_id": 4,
* "transaction_number": "VC-00001",
* "transaction_type_formatted": "Vendor Credit",
* "contact_name": "business",
* "contact_type": "customer",
* "transaction_type": "VendorCredit",
* "index": 1,
* "note": null,
* "credit": 0,
* "debit": 100,
* "amount": -100,
* "running_balance": 1300,
* "formatted_amount": "-100.00",
* "formatted_credit": "0.00",
* "formatted_debit": "100.00",
* "formatted_running_balance": "1,300.00",
* "currency_code": "USD"
* }
* ],
* "closing_balance": {
* "amount": 1300,
* "formatted_amount": "$1,300.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 1300,
* "formatted_amount": "$1,300.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1006,
* "name": "Accounts Receivable (A/R)",
* "code": "10007",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1000,
* "name": "Bank Account",
* "code": "10001",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "reference_type": "BillPayment",
* "reference_id": 3,
* "transaction_number": "",
* "transaction_type_formatted": "transaction_type.payment_made",
* "transaction_type": "BillPayment",
* "index": 2,
* "note": null,
* "credit": 500,
* "debit": 0,
* "amount": -500,
* "running_balance": -500,
* "formatted_amount": "-500.00",
* "formatted_credit": "500.00",
* "formatted_debit": "0.00",
* "formatted_running_balance": "-500.00",
* "currency_code": "USD"
* }
* ],
* "closing_balance": {
* "amount": -500,
* "formatted_amount": "-$500.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": -500,
* "formatted_amount": "-$500.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1023,
* "name": "Bank Fees and Charges",
* "code": "40006",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1034,
* "name": "Chase - Plaid Checking",
* "code": "",
* "index": null,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1004,
* "name": "Computer Equipment",
* "code": "10005",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1019,
* "name": "Cost of Goods Sold",
* "code": "40002",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "reference_type": "Bill",
* "reference_id": 4,
* "transaction_number": null,
* "transaction_type_formatted": "Bill",
* "transaction_type": "Bill",
* "index": 1,
* "note": null,
* "credit": 0,
* "debit": 1000,
* "amount": 1000,
* "running_balance": 1000,
* "formatted_amount": "1,000.00",
* "formatted_credit": "0.00",
* "formatted_debit": "1,000.00",
* "formatted_running_balance": "1,000.00",
* "currency_code": "USD"
* },
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "reference_type": "VendorCredit",
* "reference_id": 3,
* "transaction_number": "VC-00001",
* "transaction_type_formatted": "Vendor Credit",
* "transaction_type": "VendorCredit",
* "index": 2,
* "note": null,
* "credit": 100,
* "debit": 0,
* "amount": -100,
* "running_balance": 900,
* "formatted_amount": "-100.00",
* "formatted_credit": "100.00",
* "formatted_debit": "0.00",
* "formatted_running_balance": "900.00",
* "currency_code": "USD"
* },
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "reference_type": "VendorCredit",
* "reference_id": 4,
* "transaction_number": "VC-00001",
* "transaction_type_formatted": "Vendor Credit",
* "transaction_type": "VendorCredit",
* "index": 2,
* "note": null,
* "credit": 100,
* "debit": 0,
* "amount": -100,
* "running_balance": 800,
* "formatted_amount": "-100.00",
* "formatted_credit": "100.00",
* "formatted_debit": "0.00",
* "formatted_running_balance": "800.00",
* "currency_code": "USD"
* }
* ],
* "closing_balance": {
* "amount": 800,
* "formatted_amount": "$800.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 800,
* "formatted_amount": "$800.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1024,
* "name": "Depreciation Expense",
* "code": "40007",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [
* {
* "date": "2025-06-15T22:00:00.000Z",
* "date_formatted": "2025 Jun 16",
* "reference_type": "Journal",
* "reference_id": 1017,
* "transaction_number": "REF",
* "transaction_type_formatted": "Manual journal",
* "transaction_type": "Journal",
* "index": 2,
* "note": "",
* "credit": 10000,
* "debit": 0,
* "amount": -10000,
* "running_balance": -10000,
* "formatted_amount": "-10,000.00",
* "formatted_credit": "10,000.00",
* "formatted_debit": "0.00",
* "formatted_running_balance": "-10,000.00",
* "currency_code": "USD"
* }
* ],
* "closing_balance": {
* "amount": -10000,
* "formatted_amount": "-$10,000.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": -10000,
* "formatted_amount": "-$10,000.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1031,
* "name": "Discount",
* "code": "40008",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1017,
* "name": "Drawings",
* "code": "30003",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1022,
* "name": "Exchange Gain or Loss",
* "code": "40005",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 123123,
* "formatted_amount": "$123,123.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 123123,
* "formatted_amount": "$123,123.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 123123,
* "formatted_amount": "$123,123.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1007,
* "name": "Inventory Asset",
* "code": "10008",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "reference_type": "Bill",
* "reference_id": 5,
* "transaction_number": null,
* "transaction_type_formatted": "Bill",
* "transaction_type": "Bill",
* "index": 1,
* "note": null,
* "credit": 0,
* "debit": 1000,
* "amount": 1000,
* "running_balance": 1000,
* "formatted_amount": "1,000.00",
* "formatted_credit": "0.00",
* "formatted_debit": "1,000.00",
* "formatted_running_balance": "1,000.00",
* "currency_code": "USD"
* }
* ],
* "closing_balance": {
* "amount": 1000,
* "formatted_amount": "$1,000.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 1000,
* "formatted_amount": "$1,000.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1010,
* "name": "Loan",
* "code": "20003",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [
* {
* "date": "2025-06-15T22:00:00.000Z",
* "date_formatted": "2025 Jun 16",
* "reference_type": "Journal",
* "reference_id": 1017,
* "transaction_number": "REF",
* "transaction_type_formatted": "Manual journal",
* "transaction_type": "Journal",
* "index": 1,
* "note": "",
* "credit": 0,
* "debit": 10000,
* "amount": -10000,
* "running_balance": -10000,
* "formatted_amount": "-10,000.00",
* "formatted_credit": "0.00",
* "formatted_debit": "10,000.00",
* "formatted_running_balance": "-10,000.00",
* "currency_code": "USD"
* }
* ],
* "closing_balance": {
* "amount": -10000,
* "formatted_amount": "-$10,000.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": -10000,
* "formatted_amount": "-$10,000.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1005,
* "name": "Office Equipment",
* "code": "10006",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1020,
* "name": "Office expenses",
* "code": "40003",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1015,
* "name": "Opening Balance Equity",
* "code": "30002",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1011,
* "name": "Opening Balance Liabilities",
* "code": "20004",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1033,
* "name": "Other Charges",
* "code": "40010",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1018,
* "name": "Other Expenses",
* "code": "40011",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1009,
* "name": "Owner A Drawings",
* "code": "20002",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1016,
* "name": "Owner's Equity",
* "code": "30003",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1003,
* "name": "Petty Cash",
* "code": "10004",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1030,
* "name": "Prepaid Expenses",
* "code": "100010",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": -123123,
* "formatted_amount": "-$123,123.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": -123123,
* "formatted_amount": "-$123,123.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": -123123,
* "formatted_amount": "-$123,123.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1032,
* "name": "Purchase Discount",
* "code": "40009",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1021,
* "name": "Rent",
* "code": "40004",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1014,
* "name": "Retained Earnings",
* "code": "30001",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1012,
* "name": "Revenue Received in Advance",
* "code": "20005",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1025,
* "name": "Sales of Product Income",
* "code": "50001",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1026,
* "name": "Sales of Service Income",
* "code": "50002",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1001,
* "name": "Saving Bank Account",
* "code": "10002",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1013,
* "name": "Tax Payable",
* "code": "20006",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1027,
* "name": "Uncategorized Income",
* "code": "50003",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1002,
* "name": "Undeposited Funds",
* "code": "10003",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* },
* {
* "id": 1029,
* "name": "Unearned Revenue",
* "code": "50005",
* "index": 1,
* "parent_account_id": null,
* "opening_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-01"
* },
* "transactions": [],
* "closing_balance": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* },
* "closing_balance_subaccounts": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD",
* "date": "2025-06-16"
* }
* }
* ],
* "meta": {
* "organization_name": "BIGCAPITAL, INC",
* "base_currency": "USD",
* "date_format": "DD MMM yyyy",
* "is_cost_compute_running": false,
* "sheet_name": "Balance Sheet",
* "formatted_from_date": "2025/06/01",
* "formatted_to_date": "2025/06/16",
* "formatted_date_range": "From 2025/06/01 | To 2025/06/16"
* }
* }
*/
"application/json": components["schemas"]["GeneralLedgerResponseDto"];
"application/json+table": components["schemas"]["GeneralLedgerTableResponseDto"];
};
};
};
};
TrialBalanceSheetController_getTrialBalanceSheet: {
parameters: {
query?: {
/** @description Start date for the trial balance sheet */
fromDate?: string;
/** @description End date for the trial balance sheet */
toDate?: string;
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Accounting basis for the report */
basis?: "cash" | "accrual";
/** @description Filter out zero balance accounts */
noneZero?: boolean;
/** @description Filter out accounts with no transactions */
noneTransactions?: boolean;
/** @description Show only active accounts */
onlyActive?: boolean;
/** @description Filter by specific account IDs */
accountIds?: number[];
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Trial balance sheet */
200: {
headers: {
[name: string]: unknown;
};
content: {
/**
* @example {
* "data": {
* "accounts": [
* {
* "id": 1000,
* "parent_account_id": null,
* "name": "Bank Account",
* "formatted_name": "Bank Account - 10001",
* "code": "10001",
* "account_normal": "debit",
* "credit": 500,
* "debit": 0,
* "balance": -500,
* "currency_code": "USD",
* "formatted_credit": "500.00",
* "formatted_debit": "",
* "formatted_balance": "-500.00",
* "children": []
* },
* {
* "id": 1001,
* "parent_account_id": null,
* "name": "Saving Bank Account",
* "formatted_name": "Saving Bank Account - 10002",
* "code": "10002",
* "account_normal": "debit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1002,
* "parent_account_id": null,
* "name": "Undeposited Funds",
* "formatted_name": "Undeposited Funds - 10003",
* "code": "10003",
* "account_normal": "debit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1003,
* "parent_account_id": null,
* "name": "Petty Cash",
* "formatted_name": "Petty Cash - 10004",
* "code": "10004",
* "account_normal": "debit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1004,
* "parent_account_id": null,
* "name": "Computer Equipment",
* "formatted_name": "Computer Equipment - 10005",
* "code": "10005",
* "account_normal": "debit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1005,
* "parent_account_id": null,
* "name": "Office Equipment",
* "formatted_name": "Office Equipment - 10006",
* "code": "10006",
* "account_normal": "debit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1006,
* "parent_account_id": null,
* "name": "Accounts Receivable (A/R)",
* "formatted_name": "Accounts Receivable (A/R) - 10007",
* "code": "10007",
* "account_normal": "debit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1007,
* "parent_account_id": null,
* "name": "Inventory Asset",
* "formatted_name": "Inventory Asset - 10008",
* "code": "10008",
* "account_normal": "debit",
* "credit": 0,
* "debit": 1000,
* "balance": 1000,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "1,000.00",
* "formatted_balance": "1,000.00",
* "children": []
* },
* {
* "id": 1008,
* "parent_account_id": null,
* "name": "Accounts Payable (A/P)",
* "formatted_name": "Accounts Payable (A/P) - 20001",
* "code": "20001",
* "account_normal": "credit",
* "credit": 2000,
* "debit": 700,
* "balance": -1300,
* "currency_code": "USD",
* "formatted_credit": "2,000.00",
* "formatted_debit": "700.00",
* "formatted_balance": "-1,300.00",
* "children": []
* },
* {
* "id": 1009,
* "parent_account_id": null,
* "name": "Owner A Drawings",
* "formatted_name": "Owner A Drawings - 20002",
* "code": "20002",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1010,
* "parent_account_id": null,
* "name": "Loan",
* "formatted_name": "Loan - 20003",
* "code": "20003",
* "account_normal": "credit",
* "credit": 0,
* "debit": 10000,
* "balance": 10000,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "10,000.00",
* "formatted_balance": "10,000.00",
* "children": []
* },
* {
* "id": 1011,
* "parent_account_id": null,
* "name": "Opening Balance Liabilities",
* "formatted_name": "Opening Balance Liabilities - 20004",
* "code": "20004",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1012,
* "parent_account_id": null,
* "name": "Revenue Received in Advance",
* "formatted_name": "Revenue Received in Advance - 20005",
* "code": "20005",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1013,
* "parent_account_id": null,
* "name": "Tax Payable",
* "formatted_name": "Tax Payable - 20006",
* "code": "20006",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1014,
* "parent_account_id": null,
* "name": "Retained Earnings",
* "formatted_name": "Retained Earnings - 30001",
* "code": "30001",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1015,
* "parent_account_id": null,
* "name": "Opening Balance Equity",
* "formatted_name": "Opening Balance Equity - 30002",
* "code": "30002",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1016,
* "parent_account_id": null,
* "name": "Owner's Equity",
* "formatted_name": "Owner's Equity - 30003",
* "code": "30003",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1017,
* "parent_account_id": null,
* "name": "Drawings",
* "formatted_name": "Drawings - 30003",
* "code": "30003",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1018,
* "parent_account_id": null,
* "name": "Other Expenses",
* "formatted_name": "Other Expenses - 40011",
* "code": "40011",
* "account_normal": "debit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1019,
* "parent_account_id": null,
* "name": "Cost of Goods Sold",
* "formatted_name": "Cost of Goods Sold - 40002",
* "code": "40002",
* "account_normal": "debit",
* "credit": 200,
* "debit": 1000,
* "balance": 800,
* "currency_code": "USD",
* "formatted_credit": "200.00",
* "formatted_debit": "1,000.00",
* "formatted_balance": "800.00",
* "children": []
* },
* {
* "id": 1020,
* "parent_account_id": null,
* "name": "Office expenses",
* "formatted_name": "Office expenses - 40003",
* "code": "40003",
* "account_normal": "debit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1021,
* "parent_account_id": null,
* "name": "Rent",
* "formatted_name": "Rent - 40004",
* "code": "40004",
* "account_normal": "debit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1022,
* "parent_account_id": null,
* "name": "Exchange Gain or Loss",
* "formatted_name": "Exchange Gain or Loss - 40005",
* "code": "40005",
* "account_normal": "debit",
* "credit": 0,
* "debit": 123123,
* "balance": 123123,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "123,123.00",
* "formatted_balance": "123,123.00",
* "children": []
* },
* {
* "id": 1023,
* "parent_account_id": null,
* "name": "Bank Fees and Charges",
* "formatted_name": "Bank Fees and Charges - 40006",
* "code": "40006",
* "account_normal": "debit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1024,
* "parent_account_id": null,
* "name": "Depreciation Expense",
* "formatted_name": "Depreciation Expense - 40007",
* "code": "40007",
* "account_normal": "debit",
* "credit": 10000,
* "debit": 0,
* "balance": -10000,
* "currency_code": "USD",
* "formatted_credit": "10,000.00",
* "formatted_debit": "",
* "formatted_balance": "-10,000.00",
* "children": []
* },
* {
* "id": 1025,
* "parent_account_id": null,
* "name": "Sales of Product Income",
* "formatted_name": "Sales of Product Income - 50001",
* "code": "50001",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1026,
* "parent_account_id": null,
* "name": "Sales of Service Income",
* "formatted_name": "Sales of Service Income - 50002",
* "code": "50002",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1027,
* "parent_account_id": null,
* "name": "Uncategorized Income",
* "formatted_name": "Uncategorized Income - 50003",
* "code": "50003",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1029,
* "parent_account_id": null,
* "name": "Unearned Revenue",
* "formatted_name": "Unearned Revenue - 50005",
* "code": "50005",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1030,
* "parent_account_id": null,
* "name": "Prepaid Expenses",
* "formatted_name": "Prepaid Expenses - 100010",
* "code": "100010",
* "account_normal": "debit",
* "credit": 123123,
* "debit": 0,
* "balance": -123123,
* "currency_code": "USD",
* "formatted_credit": "123,123.00",
* "formatted_debit": "",
* "formatted_balance": "-123,123.00",
* "children": []
* },
* {
* "id": 1031,
* "parent_account_id": null,
* "name": "Discount",
* "formatted_name": "Discount - 40008",
* "code": "40008",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1032,
* "parent_account_id": null,
* "name": "Purchase Discount",
* "formatted_name": "Purchase Discount - 40009",
* "code": "40009",
* "account_normal": "debit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1033,
* "parent_account_id": null,
* "name": "Other Charges",
* "formatted_name": "Other Charges - 40010",
* "code": "40010",
* "account_normal": "credit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* },
* {
* "id": 1034,
* "parent_account_id": null,
* "name": "Chase - Plaid Checking",
* "formatted_name": "Chase - Plaid Checking",
* "code": "",
* "account_normal": "debit",
* "credit": 0,
* "debit": 0,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "",
* "formatted_debit": "",
* "formatted_balance": "",
* "children": []
* }
* ],
* "total": {
* "credit": 135823,
* "debit": 135823,
* "balance": 0,
* "currency_code": "USD",
* "formatted_credit": "$135,823.00",
* "formatted_debit": "$135,823.00",
* "formatted_balance": "$0.00"
* }
* },
* "query": {
* "from_date": "2025-01-01",
* "to_date": "2025-06-16",
* "number_format": {
* "divide_on1000": false,
* "negative_format": "mines",
* "show_zero": false,
* "format_money": "total",
* "precision": 2
* },
* "basis": "accrual",
* "none_zero": false,
* "none_transactions": true,
* "only_active": false,
* "account_ids": [
* null
* ]
* },
* "meta": {
* "organization_name": "BIGCAPITAL, INC",
* "base_currency": "USD",
* "date_format": "DD MMM yyyy",
* "is_cost_compute_running": false,
* "sheet_name": "Trial Balance Sheet",
* "formatted_from_date": "2025/01/01",
* "formatted_to_date": "2025/06/16",
* "formatted_date_range": "From 2025/01/01 to 2025/06/16"
* }
* }
*/
"application/json": components["schemas"]["TrialBalanceSheetResponseDto"];
"application/json+table": components["schemas"]["TrialBalanceSheetTableResponseDto"];
};
};
};
};
TransactionsByVendorController_transactionsByVendor: {
parameters: {
query?: {
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Whether to exclude transactions */
noneTransactions?: boolean;
/** @description Whether to exclude zero values */
noneZero?: boolean;
/** @description Array of vendor IDs to include */
vendorsIds?: string[];
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Transactions by vendor */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TransactionsByVendorResponseDto"];
"application/json+table": components["schemas"]["TransactionsByVendorTableResponseDto"];
};
};
};
};
TransactionsByCustomerController_transactionsByCustomer: {
parameters: {
query?: {
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Whether to exclude transactions */
noneTransactions?: boolean;
/** @description Whether to exclude zero values */
noneZero?: boolean;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Transactions by customer */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["TransactionsByCustomerResponseDto"];
"application/json+table": components["schemas"]["TransactionsByCustomerTableResponseDto"];
};
};
};
};
TransactionsByReferenceController_getTransactionsByReference: {
parameters: {
query: {
/** @description The type of the reference (e.g., SaleInvoice, Bill, etc.) */
referenceType: string;
/** @description The ID of the reference */
referenceId: number;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Transactions by reference */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ARAgingSummaryController_get: {
parameters: {
query?: {
/** @description Number of days before the aging period starts */
agingDaysBefore?: number;
/** @description Number of aging periods to calculate */
agingPeriods?: number;
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Whether to exclude zero values */
noneZero?: boolean;
/** @description Array of customer IDs to include */
customersIds?: string[];
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Receivable aging summary response */
200: {
headers: {
[name: string]: unknown;
};
content: {
/**
* @example {
* "query": {
* "as_date": "2025-06-30",
* "aging_days_before": 30,
* "aging_periods": 3,
* "number_format": {
* "divide_on1000": false,
* "negative_format": "mines",
* "show_zero": false,
* "format_money": "total",
* "precision": 2
* },
* "customers_ids": [],
* "branches_ids": [],
* "none_zero": false
* },
* "columns": [
* {
* "from_period": "2025-06-30",
* "to_period": "2025-05-31",
* "before_days": 0,
* "to_days": 30
* },
* {
* "from_period": "2025-05-31",
* "to_period": "2025-05-01",
* "before_days": 31,
* "to_days": 60
* },
* {
* "from_period": "2025-05-01",
* "to_period": null,
* "before_days": 61,
* "to_days": null
* }
* ],
* "data": {
* "customers": [
* {
* "customer_name": "business",
* "current": {
* "amount": 0,
* "formatted_amount": ""
* },
* "aging": [
* {
* "from_period": "2025-06-30",
* "to_period": "2025-05-31",
* "before_days": 0,
* "to_days": 30,
* "total": {
* "amount": 5000,
* "formatted_amount": "5,000.00"
* }
* },
* {
* "from_period": "2025-05-31",
* "to_period": "2025-05-01",
* "before_days": 31,
* "to_days": 60,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "from_period": "2025-05-01",
* "to_period": null,
* "before_days": 61,
* "to_days": null,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* }
* ],
* "total": {
* "amount": 5000,
* "formatted_amount": "$5,000.00"
* }
* },
* {
* "customer_name": "business",
* "current": {
* "amount": 0,
* "formatted_amount": ""
* },
* "aging": [
* {
* "from_period": "2025-06-30",
* "to_period": "2025-05-31",
* "before_days": 0,
* "to_days": 30,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "from_period": "2025-05-31",
* "to_period": "2025-05-01",
* "before_days": 31,
* "to_days": 60,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "from_period": "2025-05-01",
* "to_period": null,
* "before_days": 61,
* "to_days": null,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* }
* ],
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00"
* }
* },
* {
* "customer_name": "asdsadasd, asd",
* "current": {
* "amount": 0,
* "formatted_amount": ""
* },
* "aging": [
* {
* "from_period": "2025-06-30",
* "to_period": "2025-05-31",
* "before_days": 0,
* "to_days": 30,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "from_period": "2025-05-31",
* "to_period": "2025-05-01",
* "before_days": 31,
* "to_days": 60,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "from_period": "2025-05-01",
* "to_period": null,
* "before_days": 61,
* "to_days": null,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* }
* ],
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00"
* }
* },
* {
* "customer_name": "Ahmed Bouhuolia",
* "current": {
* "amount": 300000,
* "formatted_amount": "300,000.00"
* },
* "aging": [
* {
* "from_period": "2025-06-30",
* "to_period": "2025-05-31",
* "before_days": 0,
* "to_days": 30,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "from_period": "2025-05-31",
* "to_period": "2025-05-01",
* "before_days": 31,
* "to_days": 60,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "from_period": "2025-05-01",
* "to_period": null,
* "before_days": 61,
* "to_days": null,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* }
* ],
* "total": {
* "amount": 300000,
* "formatted_amount": "$300,000.00"
* }
* }
* ],
* "total": {
* "current": {
* "amount": 300000,
* "formatted_amount": "$300,000.00"
* },
* "aging": [
* {
* "from_period": "2025-06-30",
* "to_period": "2025-05-31",
* "before_days": 0,
* "to_days": 30,
* "total": {
* "amount": 5000,
* "formatted_amount": "$5,000.00"
* }
* },
* {
* "from_period": "2025-05-31",
* "to_period": "2025-05-01",
* "before_days": 31,
* "to_days": 60,
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00"
* }
* },
* {
* "from_period": "2025-05-01",
* "to_period": null,
* "before_days": 61,
* "to_days": null,
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00"
* }
* }
* ],
* "total": {
* "amount": 305000,
* "formatted_amount": "$305,000.00"
* }
* }
* },
* "meta": {
* "organization_name": "BIGCAPITAL, INC",
* "base_currency": "USD",
* "date_format": "DD MMM yyyy",
* "is_cost_compute_running": false,
* "sheet_name": "A/R Aging Summary",
* "formatted_as_date": "2025/06/30",
* "formatted_date_range": "As 2025/06/30"
* }
* }
*/
"application/json": components["schemas"]["ARAgingSummaryResponseDto"];
"application/json+table": components["schemas"]["ARAgingSummaryTableResponseDto"];
};
};
};
};
APAgingSummaryController_get: {
parameters: {
query?: {
/** @description Number of days before the aging period starts */
agingDaysBefore?: number;
/** @description Number of aging periods to calculate */
agingPeriods?: number;
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Whether to exclude zero values */
noneZero?: boolean;
/** @description Array of vendor IDs to include */
vendorsIds?: string[];
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description A/P aging summary response */
200: {
headers: {
[name: string]: unknown;
};
content: {
/**
* @example {
* "data": {
* "vendors": [
* {
* "vendor_name": "asdasd, asdasd",
* "current": {
* "amount": 0,
* "formatted_amount": ""
* },
* "aging": [
* {
* "from_period": "2025-06-30",
* "to_period": "2025-05-31",
* "before_days": 0,
* "to_days": 30,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "from_period": "2025-05-31",
* "to_period": "2025-05-01",
* "before_days": 31,
* "to_days": 60,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "from_period": "2025-05-01",
* "to_period": null,
* "before_days": 61,
* "to_days": null,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* }
* ],
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00"
* }
* },
* {
* "vendor_name": "Ahmed Bouhuolia",
* "current": {
* "amount": 32000,
* "formatted_amount": "32,000.00"
* },
* "aging": [
* {
* "from_period": "2025-06-30",
* "to_period": "2025-05-31",
* "before_days": 0,
* "to_days": 30,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "from_period": "2025-05-31",
* "to_period": "2025-05-01",
* "before_days": 31,
* "to_days": 60,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "from_period": "2025-05-01",
* "to_period": null,
* "before_days": 61,
* "to_days": null,
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* }
* ],
* "total": {
* "amount": 32000,
* "formatted_amount": "$32,000.00"
* }
* }
* ],
* "total": {
* "current": {
* "amount": 32000,
* "formatted_amount": "$32,000.00"
* },
* "aging": [
* {
* "from_period": "2025-06-30",
* "to_period": "2025-05-31",
* "before_days": 0,
* "to_days": 30,
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00"
* }
* },
* {
* "from_period": "2025-05-31",
* "to_period": "2025-05-01",
* "before_days": 31,
* "to_days": 60,
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00"
* }
* },
* {
* "from_period": "2025-05-01",
* "to_period": null,
* "before_days": 61,
* "to_days": null,
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00"
* }
* }
* ],
* "total": {
* "amount": 32000,
* "formatted_amount": "$32,000.00"
* }
* }
* },
* "columns": [
* {
* "from_period": "2025-06-30",
* "to_period": "2025-05-31",
* "before_days": 0,
* "to_days": 30
* },
* {
* "from_period": "2025-05-31",
* "to_period": "2025-05-01",
* "before_days": 31,
* "to_days": 60
* },
* {
* "from_period": "2025-05-01",
* "to_period": null,
* "before_days": 61,
* "to_days": null
* }
* ],
* "query": {
* "as_date": "2025-06-30",
* "aging_days_before": 30,
* "aging_periods": 3,
* "number_format": {
* "precision": 2,
* "divide_on1000": false,
* "show_zero": false,
* "format_money": "total",
* "negative_format": "mines"
* },
* "vendors_ids": [],
* "branches_ids": [],
* "none_zero": false
* },
* "meta": {
* "organization_name": "BIGCAPITAL, INC",
* "base_currency": "USD",
* "date_format": "DD MMM yyyy",
* "is_cost_compute_running": false,
* "sheet_name": "A/P Aging Summary",
* "formatted_as_date": "2025/06/30",
* "formatted_date_range": "As 2025/06/30"
* }
* }
*/
"application/json": components["schemas"]["APAgingSummaryResponseDto"];
"application/json+table": components["schemas"]["APAgingSummaryTableResponseDto"];
};
};
};
};
InventoryItemDetailsController_inventoryItemDetails: {
parameters: {
query?: {
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Whether to exclude transactions */
noneTransactions?: boolean;
/** @description Items IDs for the inventory item details */
itemsIds?: string[];
/** @description Warehouses IDs for the inventory item details */
warehousesIds?: string[];
/** @description Branches IDs for the inventory item details */
branchesIds?: string[];
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Inventory item details report */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["InventoryItemDetailsResponseDto"];
"application/json+table": components["schemas"]["InventoryItemDetailsTableResponseDto"];
};
};
};
};
InventoryValuationController_getInventoryValuationSheet: {
parameters: {
query?: {
/** @description The date for which the inventory valuation is requested */
asDate?: string;
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Whether to exclude transactions */
noneTransactions?: boolean;
/** @description Whether to exclude zero values */
noneZero?: boolean;
/** @description Whether to include only active items */
onlyActive?: boolean;
/** @description Array of item IDs to filter */
itemsIds?: number[];
/** @description Array of warehouse IDs to filter */
warehousesIds?: number[];
/** @description Array of branch IDs to filter */
branchesIds?: number[];
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The inventory valuation sheet */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["InventoryValuationResponseDto"];
"application/json+table": components["schemas"]["InventoryValuationTableResponseDto"];
};
};
};
};
SalesTaxLiabilitySummaryController_getSalesTaxLiabilitySummary: {
parameters: {
query: {
/** @description Start date for the sales tax liability summary */
fromDate: string;
/** @description End date for the sales tax liability summary */
toDate: string;
/** @description Accounting basis for the summary */
basis: "cash" | "accrual";
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Sales tax liability summary report */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["SalesTaxLiabilitySummaryResponseDto"];
"application/json+table": components["schemas"]["SalesTaxLiabilitySummaryTableResponseDto"];
};
};
};
};
JournalSheetController_journalSheet: {
parameters: {
query?: {
/** @description Whether to hide cents in the number format */
noCents?: boolean;
/** @description Whether to divide numbers by 1000 */
divideOn1000?: boolean;
/** @description Type of transaction to filter */
transactionType?: string;
/** @description ID of the transaction to filter */
transactionId?: string;
/** @description Start range for filtering */
fromRange?: number;
/** @description End range for filtering */
toRange?: number;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Journal report */
200: {
headers: {
[name: string]: unknown;
};
content: {
/**
* @example {
* "query": {
* "from_date": "2025-06-01",
* "to_date": "2025-06-21",
* "from_range": null,
* "to_range": null,
* "accounts_ids": [],
* "number_format": {
* "no_cents": false,
* "divide_on1000": false
* }
* },
* "data": [
* {
* "date": "2025-05-24T22:00:00.000Z",
* "date_formatted": "2025 May 25",
* "transaction_type": "Expense",
* "reference_id": 1000,
* "reference_type_formatted": "Expense",
* "entries": [
* {
* "index": 1,
* "note": null,
* "account_name": "Prepaid Expenses",
* "account_code": "100010",
* "transaction_number": null,
* "formatted_credit": "123,123.00",
* "formatted_debit": "",
* "credit": 123123,
* "debit": 0
* },
* {
* "index": 2,
* "note": "",
* "account_name": "Exchange Gain or Loss",
* "account_code": "40005",
* "transaction_number": null,
* "formatted_credit": "",
* "formatted_debit": "123,123.00",
* "credit": 0,
* "debit": 123123
* }
* ],
* "credit": 123123,
* "debit": 123123,
* "formatted_credit": "$123,123.00",
* "formatted_debit": "$123,123.00"
* },
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "transaction_type": "BillPayment",
* "reference_id": 3,
* "reference_type_formatted": "BillPayment",
* "entries": [
* {
* "index": 1,
* "note": null,
* "contact_name": "business",
* "contact_type": "customer",
* "account_name": "Accounts Payable (A/P)",
* "account_code": "20001",
* "transaction_number": "",
* "formatted_credit": "",
* "formatted_debit": "500.00",
* "credit": 0,
* "debit": 500
* },
* {
* "index": 2,
* "note": null,
* "account_name": "Bank Account",
* "account_code": "10001",
* "transaction_number": "",
* "formatted_credit": "500.00",
* "formatted_debit": "",
* "credit": 500,
* "debit": 0
* }
* ],
* "credit": 500,
* "debit": 500,
* "formatted_credit": "$500.00",
* "formatted_debit": "$500.00"
* },
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "transaction_type": "VendorCredit",
* "reference_id": 3,
* "reference_type_formatted": "VendorCredit",
* "entries": [
* {
* "index": 1,
* "note": null,
* "contact_name": "business",
* "contact_type": "customer",
* "account_name": "Accounts Payable (A/P)",
* "account_code": "20001",
* "transaction_number": "VC-00001",
* "formatted_credit": "",
* "formatted_debit": "100.00",
* "credit": 0,
* "debit": 100
* },
* {
* "index": 2,
* "note": null,
* "account_name": "Cost of Goods Sold",
* "account_code": "40002",
* "transaction_number": "VC-00001",
* "formatted_credit": "100.00",
* "formatted_debit": "",
* "credit": 100,
* "debit": 0
* }
* ],
* "credit": 100,
* "debit": 100,
* "formatted_credit": "$100.00",
* "formatted_debit": "$100.00"
* },
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "transaction_type": "VendorCredit",
* "reference_id": 4,
* "reference_type_formatted": "VendorCredit",
* "entries": [
* {
* "index": 1,
* "note": null,
* "contact_name": "business",
* "contact_type": "customer",
* "account_name": "Accounts Payable (A/P)",
* "account_code": "20001",
* "transaction_number": "VC-00001",
* "formatted_credit": "",
* "formatted_debit": "100.00",
* "credit": 0,
* "debit": 100
* },
* {
* "index": 2,
* "note": null,
* "account_name": "Cost of Goods Sold",
* "account_code": "40002",
* "transaction_number": "VC-00001",
* "formatted_credit": "100.00",
* "formatted_debit": "",
* "credit": 100,
* "debit": 0
* }
* ],
* "credit": 100,
* "debit": 100,
* "formatted_credit": "$100.00",
* "formatted_debit": "$100.00"
* },
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "transaction_type": "Bill",
* "reference_id": 4,
* "reference_type_formatted": "Bill",
* "entries": [
* {
* "index": 1,
* "note": null,
* "contact_name": "business",
* "contact_type": "customer",
* "account_name": "Accounts Payable (A/P)",
* "account_code": "20001",
* "transaction_number": null,
* "formatted_credit": "1,000.00",
* "formatted_debit": "",
* "credit": 1000,
* "debit": 0
* },
* {
* "index": 1,
* "note": null,
* "account_name": "Cost of Goods Sold",
* "account_code": "40002",
* "transaction_number": null,
* "formatted_credit": "",
* "formatted_debit": "1,000.00",
* "credit": 0,
* "debit": 1000
* }
* ],
* "credit": 1000,
* "debit": 1000,
* "formatted_credit": "$1,000.00",
* "formatted_debit": "$1,000.00"
* },
* {
* "date": "2025-06-09T22:00:00.000Z",
* "date_formatted": "2025 Jun 10",
* "transaction_type": "Bill",
* "reference_id": 5,
* "reference_type_formatted": "Bill",
* "entries": [
* {
* "index": 1,
* "note": null,
* "contact_name": "business",
* "contact_type": "customer",
* "account_name": "Accounts Payable (A/P)",
* "account_code": "20001",
* "transaction_number": null,
* "formatted_credit": "1,000.00",
* "formatted_debit": "",
* "credit": 1000,
* "debit": 0
* },
* {
* "index": 1,
* "note": null,
* "account_name": "Inventory Asset",
* "account_code": "10008",
* "transaction_number": null,
* "formatted_credit": "",
* "formatted_debit": "1,000.00",
* "credit": 0,
* "debit": 1000
* }
* ],
* "credit": 1000,
* "debit": 1000,
* "formatted_credit": "$1,000.00",
* "formatted_debit": "$1,000.00"
* },
* {
* "date": "2025-06-15T22:00:00.000Z",
* "date_formatted": "2025 Jun 16",
* "transaction_type": "Journal",
* "reference_id": 1017,
* "reference_type_formatted": "Journal",
* "entries": [
* {
* "index": 1,
* "note": "",
* "account_name": "Loan",
* "account_code": "20003",
* "transaction_number": "REF",
* "formatted_credit": "",
* "formatted_debit": "10,000.00",
* "credit": 0,
* "debit": 10000
* },
* {
* "index": 2,
* "note": "",
* "account_name": "Depreciation Expense",
* "account_code": "40007",
* "transaction_number": "REF",
* "formatted_credit": "10,000.00",
* "formatted_debit": "",
* "credit": 10000,
* "debit": 0
* }
* ],
* "credit": 10000,
* "debit": 10000,
* "formatted_credit": "$10,000.00",
* "formatted_debit": "$10,000.00"
* }
* ],
* "meta": {
* "organization_name": "BIGCAPITAL, INC",
* "base_currency": "USD",
* "date_format": "DD MMM yyyy",
* "is_cost_compute_running": false,
* "sheet_name": "",
* "formatted_date_range": "From 2025/06/01 | To 2025/06/21",
* "formatted_from_date": "2025/06/01",
* "formatted_to_date": "2025/06/21"
* }
* }
*/
"application/json": components["schemas"]["JournalSheetResponseDto"];
"application/json+table": components["schemas"]["JournalSheetTableResponseDto"];
};
};
};
};
ProfitLossSheetController_profitLossSheet: {
parameters: {
query: {
/** @description The basis for the profit and loss sheet */
basis: string;
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Whether to exclude zero values */
noneZero?: boolean;
/** @description Whether to exclude transactions */
noneTransactions?: boolean;
/** @description Array of account IDs to include */
accountsIds?: string[];
/** @description Type of columns to display */
displayColumnsType: "total" | "date_periods";
/** @description How to display columns */
displayColumnsBy: string;
/** @description Whether to show percentage column */
percentageColumn?: boolean;
/** @description Whether to show percentage row */
percentageRow?: boolean;
/** @description Whether to show income percentage */
percentageIncome?: boolean;
/** @description Whether to show expense percentage */
percentageExpense?: boolean;
/** @description Whether to include previous period */
previousPeriod?: boolean;
/** @description Whether to show previous period amount change */
previousPeriodAmountChange?: boolean;
/** @description Whether to show previous period percentage change */
previousPeriodPercentageChange?: boolean;
/** @description Whether to include previous year */
previousYear?: boolean;
/** @description Whether to show previous year amount change */
previousYearAmountChange?: boolean;
/** @description Whether to show previous year percentage change */
previousYearPercentageChange?: boolean;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Profit & loss statement */
200: {
headers: {
[name: string]: unknown;
};
content: {
/**
* @example {
* "query": {
* "from_date": "2025-01-01",
* "to_date": "2025-06-22",
* "number_format": {
* "divide_on1000": false,
* "negative_format": "mines",
* "show_zero": false,
* "format_money": "total",
* "precision": 2
* },
* "basis": "accrual",
* "none_zero": false,
* "none_transactions": false,
* "display_columns_type": "total",
* "display_columns_by": "year",
* "accounts_ids": [],
* "percentage_column": false,
* "percentage_row": false,
* "percentage_income": false,
* "percentage_expense": false,
* "previous_period": false,
* "previous_period_amount_change": false,
* "previous_period_percentage_change": false,
* "previous_year": false,
* "previous_year_amount_change": false,
* "previous_year_percentage_change": false
* },
* "data": [
* {
* "id": "INCOME",
* "name": "Income",
* "node_type": "ACCOUNTS",
* "total": {
* "amount": 3931,
* "formatted_amount": "$3,931.00"
* },
* "children": [
* {
* "id": 1025,
* "name": "Sales of Product Income",
* "node_type": "ACCOUNT",
* "total": {
* "amount": 3931,
* "formatted_amount": "3,931.00"
* }
* },
* {
* "id": 1026,
* "name": "Sales of Service Income",
* "node_type": "ACCOUNT",
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "id": 1027,
* "name": "Uncategorized Income",
* "node_type": "ACCOUNT",
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* }
* ]
* },
* {
* "id": "COST_OF_SALES",
* "name": "Cost of sales",
* "node_type": "ACCOUNTS",
* "total": {
* "amount": 800,
* "formatted_amount": "$800.00"
* },
* "children": [
* {
* "id": 1019,
* "name": "Cost of Goods Sold",
* "node_type": "ACCOUNT",
* "total": {
* "amount": 800,
* "formatted_amount": "800.00"
* }
* }
* ]
* },
* {
* "id": "GROSS_PROFIT",
* "name": "GROSS PROFIT",
* "node_type": "EQUATION",
* "total": {
* "amount": 3131,
* "formatted_amount": "$3,131.00"
* }
* },
* {
* "id": "EXPENSES",
* "name": "Expenses",
* "node_type": "ACCOUNTS",
* "total": {
* "amount": -111563,
* "formatted_amount": "-$111,563.00"
* },
* "children": [
* {
* "id": 1020,
* "name": "Office expenses",
* "node_type": "ACCOUNT",
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "id": 1021,
* "name": "Rent",
* "node_type": "ACCOUNT",
* "total": {
* "amount": -92831,
* "formatted_amount": "-92,831.00"
* }
* },
* {
* "id": 1023,
* "name": "Bank Fees and Charges",
* "node_type": "ACCOUNT",
* "total": {
* "amount": -8732,
* "formatted_amount": "-8,732.00"
* }
* },
* {
* "id": 1024,
* "name": "Depreciation Expense",
* "node_type": "ACCOUNT",
* "total": {
* "amount": -10000,
* "formatted_amount": "-10,000.00"
* }
* }
* ]
* },
* {
* "id": "NET_OPERATING_INCOME",
* "name": "NET OPERATING INCOME",
* "node_type": "EQUATION",
* "total": {
* "amount": 114694,
* "formatted_amount": "$114,694.00"
* }
* },
* {
* "id": "OTHER_INCOME",
* "name": "Other income",
* "node_type": "ACCOUNTS",
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00"
* },
* "children": [
* {
* "id": 1031,
* "name": "Discount",
* "node_type": "ACCOUNT",
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* },
* {
* "id": 1033,
* "name": "Other Charges",
* "node_type": "ACCOUNT",
* "total": {
* "amount": 0,
* "formatted_amount": ""
* }
* }
* ]
* },
* {
* "id": "OTHER_EXPENSES",
* "name": "Other expenses",
* "node_type": "ACCOUNTS",
* "total": {
* "amount": 119149,
* "formatted_amount": "$119,149.00"
* },
* "children": [
* {
* "id": 1018,
* "name": "Other Expenses",
* "node_type": "ACCOUNT",
* "total": {
* "amount": -1243,
* "formatted_amount": "-1,243.00"
* }
* },
* {
* "id": 1022,
* "name": "Exchange Gain or Loss",
* "node_type": "ACCOUNT",
* "total": {
* "amount": 123123,
* "formatted_amount": "123,123.00"
* }
* },
* {
* "id": 1032,
* "name": "Purchase Discount",
* "node_type": "ACCOUNT",
* "total": {
* "amount": -2731,
* "formatted_amount": "-2,731.00"
* }
* }
* ]
* },
* {
* "id": "NET_INCOME",
* "name": "NET INCOME",
* "node_type": "EQUATION",
* "total": {
* "amount": -4455,
* "formatted_amount": "-$4,455.00"
* }
* }
* ],
* "meta": {
* "organization_name": "BIGCAPITAL, INC",
* "base_currency": "USD",
* "date_format": "DD MMM yyyy",
* "is_cost_compute_running": false,
* "sheet_name": "Cashflow Statement",
* "formatted_from_date": "2025/01/01",
* "formatted_to_date": "2025/06/22",
* "formatted_date_range": "From 2025/01/01 | To 2025/06/22"
* }
* }
*/
"application/json": components["schemas"]["ProfitLossSheetResponseDto"];
"application/json+table": components["schemas"]["ProfitLossSheetTableResponseDto"];
};
};
};
};
CashflowController_getCashflow: {
parameters: {
query?: {
/** @description Start date for the cash flow statement period */
fromDate?: string;
/** @description End date for the cash flow statement period */
toDate?: string;
/** @description Display columns by time period */
displayColumnsBy?: "day" | "month" | "year" | "quarter";
/** @description Type of column display */
displayColumnsType?: "total" | "date_periods";
/** @description Filter out zero values */
noneZero?: boolean;
/** @description Filter out transactions */
noneTransactions?: boolean;
/** @description Number of decimal places to display */
precision?: number;
/** @description Whether to divide the number by 1000 */
divideOn1000?: boolean;
/** @description Whether to show zero values */
showZero?: boolean;
/** @description How to format money values */
formatMoney?: "total" | "always" | "none";
/** @description How to format negative numbers */
negativeFormat?: "parentheses" | "mines";
/** @description Basis for the cash flow statement */
basis?: string;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Cashflow statement report */
200: {
headers: {
[name: string]: unknown;
};
content: {
/**
* @example {
* "data": [
* {
* "id": "OPERATING",
* "label": "OPERATING ACTIVITIES",
* "footer_label": "Net cash provided by operating activities",
* "section_type": "AGGREGATE",
* "children": [
* {
* "id": "NET_INCOME",
* "label": "Net income",
* "total": {
* "amount": -113923,
* "formatted_amount": "-113,923.00",
* "currency_code": "USD"
* },
* "section_type": "NET_INCOME",
* "children": []
* },
* {
* "section_type": "ACCOUNTS",
* "id": "OPERATING_ACCOUNTS",
* "label": "Adjustments net income by operating activities.",
* "children": [
* {
* "id": 1006,
* "code": "10007",
* "label": "Accounts Receivable (A/R)",
* "account_type": "accounts-receivable",
* "adjustment_type": "mines",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1007,
* "code": "10008",
* "label": "Inventory Asset",
* "account_type": "inventory",
* "adjustment_type": "mines",
* "total": {
* "amount": -1000,
* "formatted_amount": "-1,000.00",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1008,
* "code": "20001",
* "label": "Accounts Payable (A/P)",
* "account_type": "accounts-payable",
* "adjustment_type": "plus",
* "total": {
* "amount": 1300,
* "formatted_amount": "1,300.00",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1013,
* "code": "20006",
* "label": "Tax Payable",
* "account_type": "tax-payable",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1030,
* "code": "100010",
* "label": "Prepaid Expenses",
* "account_type": "other-current-asset",
* "adjustment_type": "mines",
* "total": {
* "amount": 123123,
* "formatted_amount": "123,123.00",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1009,
* "code": "20002",
* "label": "Owner A Drawings",
* "account_type": "other-current-liability",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1010,
* "code": "20003",
* "label": "Loan",
* "account_type": "other-current-liability",
* "adjustment_type": "plus",
* "total": {
* "amount": -10000,
* "formatted_amount": "-10,000.00",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1011,
* "code": "20004",
* "label": "Opening Balance Liabilities",
* "account_type": "other-current-liability",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1012,
* "code": "20005",
* "label": "Revenue Received in Advance",
* "account_type": "other-current-liability",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1029,
* "code": "50005",
* "label": "Unearned Revenue",
* "account_type": "other-current-liability",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* }
* ],
* "total": {
* "amount": 113423,
* "formatted_amount": "$113,423.00",
* "currency_code": "USD"
* }
* }
* ],
* "total": {
* "amount": -500,
* "formatted_amount": "-$500.00",
* "currency_code": "USD"
* }
* },
* {
* "section_type": "ACCOUNTS",
* "id": "INVESTMENT",
* "label": "INVESTMENT ACTIVITIES",
* "footer_label": "cash_flow_statement.net_cash_investing",
* "children": [
* {
* "id": 1004,
* "code": "10005",
* "label": "Computer Equipment",
* "account_type": "fixed-asset",
* "adjustment_type": "mines",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1005,
* "code": "10006",
* "label": "Office Equipment",
* "account_type": "fixed-asset",
* "adjustment_type": "mines",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* }
* ],
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD"
* }
* },
* {
* "section_type": "ACCOUNTS",
* "id": "FINANCIAL",
* "label": "FINANCIAL ACTIVITIES",
* "footer_label": "cash_flow_statement.net_cash_financing",
* "children": [
* {
* "id": 1014,
* "code": "30001",
* "label": "Retained Earnings",
* "account_type": "equity",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1015,
* "code": "30002",
* "label": "Opening Balance Equity",
* "account_type": "equity",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1016,
* "code": "30003",
* "label": "Owner's Equity",
* "account_type": "equity",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1017,
* "code": "30003",
* "label": "Drawings",
* "account_type": "equity",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* }
* ],
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD"
* }
* },
* {
* "section_type": "CASH_AT_BEGINNING",
* "id": "CASH_BEGINNING_PERIOD",
* "label": "Cash at beginning of period",
* "children": [
* {
* "id": 1002,
* "code": "10003",
* "label": "Undeposited Funds",
* "account_type": "cash",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1003,
* "code": "10004",
* "label": "Petty Cash",
* "account_type": "cash",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1000,
* "code": "10001",
* "label": "Bank Account",
* "account_type": "bank",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1001,
* "code": "10002",
* "label": "Saving Bank Account",
* "account_type": "bank",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* },
* {
* "id": 1034,
* "code": "",
* "label": "Chase - Plaid Checking",
* "account_type": "bank",
* "adjustment_type": "plus",
* "total": {
* "amount": 0,
* "formatted_amount": "",
* "currency_code": "USD"
* },
* "section_type": "ACCOUNT"
* }
* ],
* "total": {
* "amount": 0,
* "formatted_amount": "$0.00",
* "currency_code": "USD"
* }
* },
* {
* "section_type": "TOTAL",
* "id": "NET_CASH_INCREASE",
* "label": "NET CASH INCREASE FOR PERIOD",
* "total": {
* "amount": -500,
* "formatted_amount": "-$500.00",
* "currency_code": "USD"
* }
* },
* {
* "section_type": "TOTAL",
* "id": "CASH_END_PERIOD",
* "label": "CASH AT END OF PERIOD",
* "total": {
* "amount": -500,
* "formatted_amount": "-$500.00",
* "currency_code": "USD"
* }
* }
* ],
* "query": {
* "display_columns_type": "total",
* "display_columns_by": "year",
* "from_date": "2025-01-01",
* "to_date": "2025-06-16",
* "number_format": {
* "precision": 2,
* "divide_on1000": false,
* "show_zero": false,
* "format_money": "total",
* "negative_format": "mines"
* },
* "none_zero": false,
* "none_transactions": false,
* "basis": "cash"
* },
* "meta": {
* "organization_name": "BIGCAPITAL, INC",
* "base_currency": "USD",
* "date_format": "DD MMM yyyy",
* "is_cost_compute_running": false,
* "sheet_name": "Statement of Cash Flow",
* "formatted_to_date": "2025/06/16",
* "formatted_from_date": "2025/01/01",
* "formatted_date_range": "From 2025/01/01 | To 2025/06/16"
* }
* }
*/
"application/json": components["schemas"]["CashflowStatementResponseDto"];
"application/json+table": components["schemas"]["CashflowStatementTableResponseDto"];
};
};
};
};
DashboardController_getBootMeta: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The dashboard details have been successfully retrieved. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GetDashboardBootMetaResponseDto"];
};
};
};
};
RolesController_getRoles: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description List of all roles */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["RoleResponseDto"][];
};
};
};
};
RolesController_createRole: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateRoleDto"];
};
};
responses: {
/** @description Role created successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
RolesController_getRole: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Role ID */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Role details */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["RoleResponseDto"];
};
};
};
};
RolesController_editRole: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Role ID */
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditRoleDto"];
};
};
responses: {
/** @description Role updated successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
RolesController_deleteRole: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Role ID */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Role deleted successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
RolesController_getRolePermissionsSchema: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Role permissions schema */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SubscriptionsController_getSubscriptions: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description List of subscriptions retrieved successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SubscriptionsController_getCheckoutUrl: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @description The variant ID for the subscription plan */
variantId: string;
};
};
};
responses: {
/** @description Checkout URL retrieved successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SubscriptionsController_cancelSubscription: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Subscription canceled successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SubscriptionsController_resumeSubscription: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Subscription resumed successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SubscriptionsController_changeSubscriptionPlan: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** @description The variant ID for the new subscription plan */
variant_id: number;
};
};
};
responses: {
/** @description Subscription plan changed successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
SubscriptionsLemonWebhook_lemonWebhooks: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
OrganizationController_build: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["BuildOrganizationDto"];
};
};
responses: {
/** @description The organization database has been initialized */
200: {
headers: {
[name: string]: unknown;
};
content: {
/**
* @example {
* "type": "success",
* "code": "ORGANIZATION.DATABASE.INITIALIZED",
* "message": "The organization database has been initialized.",
* "data": {
* "job_id": "1"
* }
* }
*/
"application/json": unknown;
};
};
500: {
headers: {
[name: string]: unknown;
};
content: {
/**
* @example {
* "errors": [
* {
* "statusCode": 500,
* "type": "TENANT_ALREADY_BUILT",
* "message": null
* }
* ]
* }
*/
"application/json": unknown;
};
};
};
};
OrganizationController_buildJob: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description The build job id */
buildJobId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns the organization build job details */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["OrganizationBuildJobResponseDto"];
};
};
};
};
OrganizationController_currentOrganization: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Returns the current organization */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["GetCurrentOrganizationResponseDto"];
};
};
};
};
OrganizationController_baseCurrencyMutate: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
OrganizationController_updateOrganization: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateOrganizationDto"];
};
};
responses: {
/** @description Organization information has been updated successfully */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentServicesController_getPaymentServicesSpecificInvoice: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentServicesController_getPaymentMethodsState: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentServicesController_getPaymentService: {
parameters: {
query?: never;
header?: never;
path: {
paymentServiceId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentServicesController_updatePaymentMethod: {
parameters: {
query?: never;
header?: never;
path: {
paymentMethodId: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditPaymentMethodDTO"];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
PaymentServicesController_deletePaymentMethod: {
parameters: {
query?: never;
header?: never;
path: {
paymentMethodId: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ExportController_export: {
parameters: {
query?: never;
header: {
accept: string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ViewsController_getResourceViews: {
parameters: {
query?: never;
header?: never;
path: {
/** @description The resource model to get views for */
resourceModel: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Specific resource views */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ViewResponseDto"];
};
};
};
};
CurrenciesController_findAll: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description List of all currencies. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CurrencyResponseDto"][];
};
};
};
};
CurrenciesController_create: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["CreateCurrencyDto"];
};
};
responses: {
/** @description The currency has been successfully created. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CurrencyResponseDto"];
};
};
/** @description Invalid input data. */
400: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CurrenciesController_edit: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Currency ID */
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditCurrencyDto"];
};
};
responses: {
/** @description The currency has been successfully updated. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CurrencyResponseDto"];
};
};
/** @description Invalid input data. */
400: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Currency not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CurrenciesController_delete: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Currency code */
code: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The currency has been successfully deleted. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description Currency not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
CurrenciesController_findOne: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
/** @description Currency code */
currencyCode: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The currency details. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["CurrencyResponseDto"];
};
};
/** @description Currency not found. */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
MiscellaneousController_getDateFormats: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["DateFormatResponseDto"][];
};
};
};
};
UsersController_getUser: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description User details retrieved successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
UsersController_editUser: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["EditUserDto"];
};
};
responses: {
/** @description The user has been edited successfully. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
UsersController_deleteUser: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The user has been deleted successfully. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
UsersController_listUsers: {
parameters: {
query: {
page_size: number;
page: number;
};
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description List of users retrieved successfully. */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
UsersController_activateUser: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The user has been activated successfully. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
UsersController_inactivateUser: {
parameters: {
query?: never;
header: {
/** @description Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token. */
Authorization: string;
/** @description Required if Authorization is a JWT token. The organization ID to operate within. */
"organization-id": string;
};
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The user has been inactivated successfully. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": unknown;
};
};
};
};
UsersInviteController_sendInvite: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["SendInviteUserDto"];
};
};
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
UsersInviteController_resendInvite: {
parameters: {
query?: never;
header?: never;
path: {
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
UsersInvitePublicController_acceptInvite: {
parameters: {
query?: never;
header?: never;
path: {
token: string;
};
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["InviteUserDto"];
};
};
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
UsersInvitePublicController_checkInvite: {
parameters: {
query?: never;
header?: never;
path: {
token: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ContactsController_getAutoComplete: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ContactsController_getContact: {
parameters: {
query?: never;
header?: never;
path: {
/** @description Contact ID */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Contact details (under "customer" key for form/duplicate use) */
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ContactsController_activateContact: {
parameters: {
query?: never;
header?: never;
path: {
/** @description Contact ID */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ContactsController_inactivateContact: {
parameters: {
query?: never;
header?: never;
path: {
/** @description Contact ID */
id: number;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ExchangeRatesController_getLatestExchangeRate: {
parameters: {
query?: {
/** @description Source currency code (ISO 4217) */
from_currency?: string;
/** @description Target currency code (ISO 4217) */
to_currency?: string;
};
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Successfully retrieved exchange rate */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ExchangeRateLatestResponseDto"];
};
};
/** @description Invalid currency code or service error */
400: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
}