Big Red Cloud API

/**
 * BigRedCloudAPI - generated by OmniStream from Big Red Cloud API's OpenAPI spec.
 * One typed method per endpoint. A single Omni key reaches the API.
 */
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/bigredcloud";

export class BigRedCloudAPIError extends Error {
  status: number;
  code?: string;
  constructor(status: number, code: string | undefined, message?: string) {
    super(message || `BigRedCloudAPI error ${status}`);
    this.name = "BigRedCloudAPIError";
    this.status = status;
    this.code = code;
  }
}

export interface BigRedCloudAPIOptions {
  baseUrl?: string;
  fetch?: typeof fetch;
  timeoutMs?: number;
}

export class BigRedCloudAPI {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: BigRedCloudAPIOptions = {}) {
    if (!token) throw new Error("BigRedCloudAPI: token is required");
  }
  rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;

  private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
    const f = this.opts.fetch ?? globalThis.fetch;
    const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
    if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
    const headers: Record<string, string> = { "x-omni-key": this.token };
    if (body !== undefined) headers["content-type"] = "application/json";
    const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
    this.rateLimit = {
      remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
      remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
    };
    const data = await res.json().catch(() => ({}));
    if (!res.ok) throw new BigRedCloudAPIError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** Returns a list of company's Accounts. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" and "code" fields. */
  accountsGet(): Promise<any> {
    return this._request("GET", "/v1/accounts", {});
  }

  /** Returns a list of company's Analysis Categories. Supports OData querying protocol.
Filtering is allowed by "categoryTypeId" field.
Ordering is allowed by "id" and "orderIndex" fields. */
  analysisCategoriesGet(): Promise<any> {
    return this._request("GET", "/v1/analysisCategories", {});
  }

  /** Returns a list of company's Bank Account. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" and "acCode" fields. */
  bankAccountsGet(): Promise<any> {
    return this._request("GET", "/v1/bankAccounts", {});
  }

  /** Creates a new Bank Account. */
  bankAccountsPost(body: unknown): Promise<any> {
    return this._request("POST", "/v1/bankAccounts", { body });
  }

  /** Processes a batch of Bank Accounts. */
  bankAccountsProcessBatch(body: unknown): Promise<any> {
    return this._request("PUT", "/v1/bankAccounts/batch", { body });
  }

  /** Returns information about a single Bank Account. */
  getv1BankaccountsId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/v1/bankAccounts/{id}", { params });
  }

  /** Updates an existing Bank Account. */
  bankAccountsPut(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/bankAccounts/{id}", { body, params });
  }

  /** Removes an existing Bank Account. */
  bankAccountsDelete(params: { "id": number; "timestamp": string }): Promise<any> {
    return this._request("DELETE", "/v1/bankAccounts/{id}", { params });
  }

  /** Returns a list of global Book Transactions' Types. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field. */
  bookTranTypesGet(): Promise<any> {
    return this._request("GET", "/v1/bookTranTypes", {});
  }

  /** Returns a list of company's Cash Payments. Supports OData querying protocol.
Filtering is allowed by "entryDate" field.
Ordering is allowed by "id" field. */
  cashPaymentsGet(): Promise<any> {
    return this._request("GET", "/v1/cashPayments", {});
  }

  /** Creates a new Cash Payment. */
  cashPaymentsPost(body: unknown): Promise<any> {
    return this._request("POST", "/v1/cashPayments", { body });
  }

  /** Processes a batch of Cash Payments. */
  cashPaymentsProcessBatch(body: unknown): Promise<any> {
    return this._request("PUT", "/v1/cashPayments/batch", { body });
  }

  /** Returns information about a single Cash Payment. */
  getv1CashpaymentsId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/v1/cashPayments/{id}", { params });
  }

  /** Updates an existing Cash Payment. */
  cashPaymentsPut(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/cashPayments/{id}", { body, params });
  }

  /** Removes an existing Cash Payment. */
  cashPaymentsDelete(params: { "id": number; "timestamp": string }): Promise<any> {
    return this._request("DELETE", "/v1/cashPayments/{id}", { params });
  }

  /** Returns a list of company's Cash Receipts. Supports OData querying protocol.
Filtering is allowed by "entryDate" field.
Ordering is allowed by "id" field. */
  cashReceiptsGet(): Promise<any> {
    return this._request("GET", "/v1/cashReceipts", {});
  }

  /** Creates a new Cash Receipt. */
  cashReceiptsPost(body: unknown): Promise<any> {
    return this._request("POST", "/v1/cashReceipts", { body });
  }

  /** Processes a batch of Cash Receipts. */
  cashReceiptsProcessBatch(body: unknown): Promise<any> {
    return this._request("PUT", "/v1/cashReceipts/batch", { body });
  }

  /** Returns information about a single Cash Receipt. */
  getv1CashreceiptsId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/v1/cashReceipts/{id}", { params });
  }

  /** Updates an existing Cash Receipt. */
  cashReceiptsPut(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/cashReceipts/{id}", { body, params });
  }

  /** Removes an existing Cash Receipt. */
  cashReceiptsDelete(params: { "id": number; "timestamp": string }): Promise<any> {
    return this._request("DELETE", "/v1/cashReceipts/{id}", { params });
  }

  /** Returns a list of company's Category Types. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field. */
  categoryTypesGet(): Promise<any> {
    return this._request("GET", "/v1/categoryTypes", {});
  }

  /** Returns a list of company settings. Supports OData querying protocol.
Filtering is forbidden. */
  companySettingsGet(): Promise<any> {
    return this._request("GET", "/v1/companySettings", {});
  }

  /** Returns the company configuration settings. */
  companySetupConfigGet(): Promise<any> {
    return this._request("GET", "/v1/companySetupConfig", {});
  }

  /** Returns the company option setting. */
  companySetupConfigGetCompanyOptions(): Promise<any> {
    return this._request("GET", "/v1/companySetupConfig/getCompanyOptions", {});
  }

  /** Returns the financial year. */
  companySetupConfigGetFinancialYear(): Promise<any> {
    return this._request("GET", "/v1/companySetupConfig/getFinancialYear", {});
  }

  /** Returns a list of company's Customers. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" and "code" fields. */
  customersGet(): Promise<any> {
    return this._request("GET", "/v1/customers", {});
  }

  /** Creates a new Customer. */
  customersPost(body: unknown): Promise<any> {
    return this._request("POST", "/v1/customers", { body });
  }

  /** Processes a batch of Customers. */
  customersProcessBatch(body: unknown): Promise<any> {
    return this._request("PUT", "/v1/customers/batch", { body });
  }

  /** Returns information about a single Customer. You may specify that Customer's ledger balance should be calculated. */
  getv1CustomersId(params: { "id": number; "needBalance"?: boolean }): Promise<any> {
    return this._request("GET", "/v1/customers/{id}", { params });
  }

  /** Updates an existing Customer. */
  customersPut(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/customers/{id}", { body, params });
  }

  /** Removes an existing Customer. */
  customersDelete(params: { "id": number; "timestamp": string }): Promise<any> {
    return this._request("DELETE", "/v1/customers/{id}", { params });
  }

  /** Returns a list of Customer's account transactions. */
  customersGetAccountTrans(params: { "itemId": number }): Promise<any> {
    return this._request("GET", "/v1/customers/{itemId}/accountTrans", { params });
  }

  /** Returns a Customer's opening balances, calculated for the next periods: current month, one month old, two months old, three and more months old. */
  customersGetOpeningBalance(params: { "itemId": number }): Promise<any> {
    return this._request("GET", "/v1/customers/{itemId}/openingBalance", { params });
  }

  /** Returns a list of Customer's opening balance transactions. */
  customersGetOpeningBalanceList(params: { "itemId": number }): Promise<any> {
    return this._request("GET", "/v1/customers/{itemId}/openingBalanceList", { params });
  }

  /** Returns a list of Customer's quotes. */
  customersGetQuotes(params: { "itemId": number }): Promise<any> {
    return this._request("GET", "/v1/customers/{itemId}/quotes", { params });
  }

  /** Sends a Statement email.
If "toAddress" is not empty then email will be sent to this address. Otherwise email will be sent to Statement Customer's address. */
  emailSendEmailStatement(body: unknown): Promise<any> {
    return this._request("POST", "/v1/email/sendEmailStatement", { body });
  }

  /** Sends a Quote email.
If "toAddress" is not empty then email will be sent to this address. Otherwise email will be sent to Statement Customer's address. */
  emailSendQuote(body: unknown): Promise<any> {
    return this._request("POST", "/v1/email/sendQuote", { body });
  }

  /** Sends a Sales Invoice email.
If "toAddress" is not empty then email will be sent to this address. Otherwise email will be sent to Sales Invoice Customer's address. */
  emailSendSalesInvoice(body: unknown): Promise<any> {
    return this._request("POST", "/v1/email/sendSalesInvoice", { body });
  }

  /** Returns a list of global Owner Type Groups. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field. */
  ownerTypeGroupsGet(): Promise<any> {
    return this._request("GET", "/v1/ownerTypeGroups", {});
  }

  /** Returns a list of global Owner Types. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field. */
  ownerTypesGet(): Promise<any> {
    return this._request("GET", "/v1/ownerTypes", {});
  }

  /** Returns a list of company's Payments. Supports OData querying protocol.
Filtering is allowed by "entryDate" field.
Ordering is allowed by "id" field. */
  paymentsGet(): Promise<any> {
    return this._request("GET", "/v1/payments", {});
  }

  /** Creates a new Payment. */
  paymentsPost(body: unknown): Promise<any> {
    return this._request("POST", "/v1/payments", { body });
  }

  /** Processes a batch of Payments. */
  paymentsProcessBatch(body: unknown): Promise<any> {
    return this._request("PUT", "/v1/payments/batch", { body });
  }

  /** Returns information about a single Payments. */
  getv1PaymentsId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/v1/payments/{id}", { params });
  }

  /** Updates an existing Payment. */
  paymentsPut(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/payments/{id}", { body, params });
  }

  /** Removes an existing Payment. */
  paymentsDelete(params: { "id": number; "timestamp": string }): Promise<any> {
    return this._request("DELETE", "/v1/payments/{id}", { params });
  }

  /** Returns a list of global Product Types. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field. */
  productTypesGet(): Promise<any> {
    return this._request("GET", "/v1/productTypes", {});
  }

  /** Returns a list of company's Products. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" and "stockCode" fields. */
  productsGet(): Promise<any> {
    return this._request("GET", "/v1/products", {});
  }

  /** Creates a new Product. */
  productsPost(body: unknown): Promise<any> {
    return this._request("POST", "/v1/products", { body });
  }

  /** Processes a batch of Products. */
  productsProcessBatch(body: unknown): Promise<any> {
    return this._request("PUT", "/v1/products/batch", { body });
  }

  /** Returns information about a single Product. */
  getv1ProductsId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/v1/products/{id}", { params });
  }

  /** Updates an existing Product. */
  productsPut(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/products/{id}", { body, params });
  }

  /** Removes an existing Product. */
  productsDelete(params: { "id": number; "timestamp": string }): Promise<any> {
    return this._request("DELETE", "/v1/products/{id}", { params });
  }

  /** Returns a list of company's Purchases. Supports OData querying protocol.
Filtering is allowed by "entryDate" field.
Ordering is allowed by "id" field. */
  purchasesGet(): Promise<any> {
    return this._request("GET", "/v1/purchases", {});
  }

  /** Creates a new Purchase. */
  purchasesPost(body: unknown): Promise<any> {
    return this._request("POST", "/v1/purchases", { body });
  }

  /** Processes a batch of Purchases. */
  purchasesProcessBatch(body: unknown): Promise<any> {
    return this._request("PUT", "/v1/purchases/batch", { body });
  }

  /** Returns information about a single Purchases. */
  getv1PurchasesId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/v1/purchases/{id}", { params });
  }

  /** Updates an existing Purchase. */
  purchasesPut(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/purchases/{id}", { body, params });
  }

  /** Removes an existing Purchase. */
  purchasesDelete(params: { "id": number; "timestamp": string }): Promise<any> {
    return this._request("DELETE", "/v1/purchases/{id}", { params });
  }

  /** Returns a list of company's Quotes.
Filtering is forbidden.
Ordering is allowed by "id". */
  quoteGet(): Promise<any> {
    return this._request("GET", "/v1/quotes", {});
  }

  /** Creates a new Quote. */
  quotePost(): Promise<any> {
    return this._request("POST", "/v1/quotes", {  });
  }

  /** Processes a batch of Quote. */
  quoteProcessBatch(body: unknown): Promise<any> {
    return this._request("PUT", "/v1/quotes/batch", { body });
  }

  /** Close a Quote. */
  quoteClose(params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/quotes/close/{id}", { params });
  }

  /** Creates a new Quote with auto generating reference. */
  quotePostCreateQuoteWithGeneratingReference(): Promise<any> {
    return this._request("POST", "/v1/quotes/createQuoteWithGeneratingReference", {  });
  }

  /** Generate a sale invoice from a Quote.
When sale invoice is empty, new sale invoice will be generated from Quote. */
  quotePostGenerateSaleInvoice(body: unknown): Promise<any> {
    return this._request("POST", "/v1/quotes/generateSaleInvoice", { body });
  }

  /** Reopen a Quote. */
  quoteReopen(params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/quotes/reopen/{id}", { params });
  }

  /** Returns information about a single Quote. */
  getv1QuotesId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/v1/quotes/{id}", { params });
  }

  /** Updates an existing Quote. */
  quotePut(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/quotes/{id}", { body, params });
  }

  /** Removes an existing Quote. */
  quoteDelete(params: { "id": number; "timestamp": string }): Promise<any> {
    return this._request("DELETE", "/v1/quotes/{id}", { params });
  }

  /** Returns a list of company's Sales Entries, Sales Invoices and Sales Credit Notes. Supports OData querying protocol.
Filtering is allowed by "entryDate" field.
Ordering is allowed by "id" field. */
  salesGet(): Promise<any> {
    return this._request("GET", "/v1/sales", {});
  }

  /** Returns a list of company's Sales Credit Notes. Supports OData querying protocol.
Filtering is allowed by "entryDate" field.
Ordering is allowed by "id" field. */
  salesCreditNotesGet(): Promise<any> {
    return this._request("GET", "/v1/salesCreditNotes", {});
  }

  /** Creates a new Sales Credit Note. */
  salesCreditNotesPost(body: unknown): Promise<any> {
    return this._request("POST", "/v1/salesCreditNotes", { body });
  }

  /** Processes a batch of Sales Credit Notes. */
  salesCreditNotesProcessBatch(body: unknown): Promise<any> {
    return this._request("PUT", "/v1/salesCreditNotes/batch", { body });
  }

  /** Returns information about a single Sales Credit Note. */
  getv1SalescreditnotesId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/v1/salesCreditNotes/{id}", { params });
  }

  /** Updates an existing Sales Credit Note. */
  salesCreditNotesPut(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/salesCreditNotes/{id}", { body, params });
  }

  /** Removes an existing Sales Credit Note. */
  salesCreditNotesDelete(params: { "id": number; "timestamp": string }): Promise<any> {
    return this._request("DELETE", "/v1/salesCreditNotes/{id}", { params });
  }

  /** Returns a list of company's Sales Entries. Supports OData querying protocol.
Filtering is allowed by "entryDate" field.
Ordering is allowed by "id" field. */
  salesEntriesGet(): Promise<any> {
    return this._request("GET", "/v1/salesEntries", {});
  }

  /** Creates a new Sales Entry. */
  salesEntriesPost(body: unknown): Promise<any> {
    return this._request("POST", "/v1/salesEntries", { body });
  }

  /** Processes a batch of Sales Entries. */
  salesEntriesProcessBatch(body: unknown): Promise<any> {
    return this._request("PUT", "/v1/salesEntries/batch", { body });
  }

  /** Returns information about a single Sales Entry. */
  getv1SalesentriesId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/v1/salesEntries/{id}", { params });
  }

  /** Updates an existing Sales Entry. */
  salesEntriesPut(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/salesEntries/{id}", { body, params });
  }

  /** Removes an existing Sales Entry. */
  salesEntriesDelete(params: { "id": number; "timestamp": string }): Promise<any> {
    return this._request("DELETE", "/v1/salesEntries/{id}", { params });
  }

  /** Returns a list of company's Sales Invoices. Supports OData querying protocol.
Filtering is allowed by "entryDate" field.
Ordering is allowed by "id" field. */
  salesInvoicesGet(): Promise<any> {
    return this._request("GET", "/v1/salesInvoices", {});
  }

  /** Creates a new Sales Invoice. */
  salesInvoicesPost(body: unknown): Promise<any> {
    return this._request("POST", "/v1/salesInvoices", { body });
  }

  /** Processes a batch of Sales Invoices. */
  salesInvoicesProcessBatch(body: unknown): Promise<any> {
    return this._request("PUT", "/v1/salesInvoices/batch", { body });
  }

  /** Creates a new Sale Invoice with auto generating reference. */
  salesInvoicesPostCreateSaleInvoiceWithGeneratingReference(body: unknown): Promise<any> {
    return this._request("POST", "/v1/salesInvoices/createSaleInvoiceWithGeneratingReference", { body });
  }

  /** Returns information about a single Sales Invoice. */
  getv1SalesinvoicesId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/v1/salesInvoices/{id}", { params });
  }

  /** Updates an existing Sales Invoice. */
  salesInvoicesPut(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/salesInvoices/{id}", { body, params });
  }

  /** Removes an existing Sales Invoice. */
  salesInvoicesDelete(params: { "id": number; "timestamp": string }): Promise<any> {
    return this._request("DELETE", "/v1/salesInvoices/{id}", { params });
  }

  /** Returns a list of company's SaleRep.
Filtering is forbidden.
Ordering is allowed by "id". */
  salesRepGet(): Promise<any> {
    return this._request("GET", "/v1/salesReps", {});
  }

  /** Creates a new SaleRep. */
  salesRepPost(body: unknown): Promise<any> {
    return this._request("POST", "/v1/salesReps", { body });
  }

  /** Processes a batch of Sale Rep. */
  salesRepProcessBatch(body: unknown): Promise<any> {
    return this._request("PUT", "/v1/salesReps/batch", { body });
  }

  /** Returns information about a single SaleRep. */
  getv1SalesrepsId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/v1/salesReps/{id}", { params });
  }

  /** Updates an existing Sale Rep. */
  salesRepPut(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/salesReps/{id}", { body, params });
  }

  /** Removes an existing Sale Rep. */
  salesRepDelete(params: { "id": number; "timestamp": string }): Promise<any> {
    return this._request("DELETE", "/v1/salesReps/{id}", { params });
  }

  /** Returns a list of company's Suppliers. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" and "code" fields. */
  suppliersGet(): Promise<any> {
    return this._request("GET", "/v1/suppliers", {});
  }

  /** Creates a new Supplier. */
  suppliersPost(body: unknown): Promise<any> {
    return this._request("POST", "/v1/suppliers", { body });
  }

  /** Processes a batch of Suppliers. */
  suppliersProcessBatch(body: unknown): Promise<any> {
    return this._request("PUT", "/v1/suppliers/batch", { body });
  }

  /** Returns information about a single Supplier. You may specify that Supplier's ledger balance should be calculated. */
  getv1SuppliersId(params: { "id": number; "needBalance"?: boolean }): Promise<any> {
    return this._request("GET", "/v1/suppliers/{id}", { params });
  }

  /** Updates an existing Supplier. */
  suppliersPut(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/v1/suppliers/{id}", { body, params });
  }

  /** Removes an existing Supplier. */
  suppliersDelete(params: { "id": number; "timestamp": string }): Promise<any> {
    return this._request("DELETE", "/v1/suppliers/{id}", { params });
  }

  /** Returns a list of Supplier's account transactions. */
  suppliersGetAccountTrans(params: { "itemId": number }): Promise<any> {
    return this._request("GET", "/v1/suppliers/{itemId}/accountTrans", { params });
  }

  /** Returns a Supplier's opening balances, calculated for the next periods: current month, one month old, two months old, three and more months old. */
  suppliersGetOpeningBalance(params: { "itemId": number }): Promise<any> {
    return this._request("GET", "/v1/suppliers/{itemId}/openingBalance", { params });
  }

  /** Returns a list of Supplier's opening balance transactions. */
  suppliersGetOpeningBalanceList(params: { "itemId": number }): Promise<any> {
    return this._request("GET", "/v1/suppliers/{itemId}/openingBalanceList", { params });
  }

  /** Returns a list of company's User Defined Fields. Supports OData querying protocol.
Filtering is allowed by "categoryTypeId" field.
Ordering is allowed by "id" and "orderIndex" fields. */
  userDefinedFieldsGet(): Promise<any> {
    return this._request("GET", "/v1/userDefinedFields", {});
  }

  /** Returns a list of global Vat Analysis Types. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field. */
  vatAnalysisTypesGet(): Promise<any> {
    return this._request("GET", "/v1/vatAnalysisTypes", {});
  }

  /** Returns a list of global Vat Categories. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field. */
  vatCategoriesGet(): Promise<any> {
    return this._request("GET", "/v1/vatCategories", {});
  }

  /** Process Vat Rates */
  vatCategoriesProcessVatRates(body: unknown): Promise<any> {
    return this._request("POST", "/v1/vatCategories/vatRates", { body });
  }

  /** Returns a list of company's Vat Rates. Supports OData querying protocol.
Filtering is allowed by "vatCategoryId" field.
Ordering is allowed by "id" and "orderIndex" fields. */
  vatRatesGet(): Promise<any> {
    return this._request("GET", "/v1/vatRates", {});
  }

  /** Returns a list of global Vat Types. Supports OData querying protocol.
Filtering is forbidden.
Ordering is allowed by "id" field. */
  vatTypesGet(): Promise<any> {
    return this._request("GET", "/v1/vatTypes", {});
  }
}

export default BigRedCloudAPI;