import * as _emotion_react_jsx_runtime from '@emotion/react/jsx-runtime'; import * as React from 'react'; import { ReactNode, SetStateAction, Context, SyntheticEvent, ComponentProps, Ref, MouseEvent, FocusEvent, ContextType } from 'react'; import { FieldValues, Control, FieldPath, SetFieldValue, DeepRequired } from 'react-hook-form'; import { SortDirection } from '@tanstack/react-table'; import * as _tanstack_react_query from '@tanstack/react-query'; import { QueryClient } from '@tanstack/react-query'; import { ServiceOperationQuery, ServiceOperationMutation, QraftContextValue, requestFn } from '@openapi-qraft/react'; import { MenuProps, ButtonProps, SxProps, Theme as Theme$1 } from '@mui/material'; import { IconButtonProps } from '@mui/material/IconButton'; import { Theme } from '@mui/material/styles'; import { GridSortDirection } from '@mui/x-data-grid/models/gridSortModel'; import { I18n, Messages } from '@lingui/core'; import { z } from 'zod'; import * as class_variance_authority_types from 'class-variance-authority/types'; import { VariantProps } from 'class-variance-authority'; import { DialogProps } from '@mui/material/Dialog'; import * as _mui_x_data_grid_internals from '@mui/x-data-grid/internals'; import { GridColDef } from '@mui/x-data-grid'; import { Combobox as Combobox$1 } from '@base-ui/react'; import { Scope } from '@sentry/react'; import { Locale } from 'date-fns'; export { toast } from 'react-hot-toast'; /** * This file was auto-generated by @openapi-qraft/cli. * Do not make direct changes to the file. */ interface paths { "/api/widget-gateway/init": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Initializes widget and returns user context */ get: operations["GetApiWidgetGatewayInit"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/widget-gateway/proxy": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Proxies requests to banking services for active users (legacy DTO-based approach) */ post: operations["PostApiWidgetGatewayProxy"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/api/widget-gateway/proxy/{path}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Proxies requests to banking services using transparent HTTP method and path routing. * Note: ASP.NET Core gives literal route segments priority over catch-all parameters, * so POST /api/widget-gateway/proxy (no extra path) matches ProxyRequestAsync, not this action. */ get: operations["GetApiWidgetGatewayProxyPath"]; /** * Proxies requests to banking services using transparent HTTP method and path routing. * Note: ASP.NET Core gives literal route segments priority over catch-all parameters, * so POST /api/widget-gateway/proxy (no extra path) matches ProxyRequestAsync, not this action. */ put: operations["PutApiWidgetGatewayProxyPath"]; /** * Proxies requests to banking services using transparent HTTP method and path routing. * Note: ASP.NET Core gives literal route segments priority over catch-all parameters, * so POST /api/widget-gateway/proxy (no extra path) matches ProxyRequestAsync, not this action. */ post: operations["PostApiWidgetGatewayProxyPath"]; /** * Proxies requests to banking services using transparent HTTP method and path routing. * Note: ASP.NET Core gives literal route segments priority over catch-all parameters, * so POST /api/widget-gateway/proxy (no extra path) matches ProxyRequestAsync, not this action. */ delete: operations["DeleteApiWidgetGatewayProxyPath"]; options?: never; head?: never; /** * Proxies requests to banking services using transparent HTTP method and path routing. * Note: ASP.NET Core gives literal route segments priority over catch-all parameters, * so POST /api/widget-gateway/proxy (no extra path) matches ProxyRequestAsync, not this action. */ patch: operations["PatchApiWidgetGatewayProxyPath"]; trace?: never; }; "/api/widget-gateway/revoke": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Revokes cached OAuth tokens for the current user session */ post: operations["PostApiWidgetGatewayRevoke"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/application-status": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the latest application status per product for the current widget session. * @description Intended for widget initialization, before an application (and its client secret) exists. * For each product it returns the latest application matching the widget session's organization * reference — preferring the current applicant's own in-progress application — and whether that * applicant started it: STARTED_BY_YOU when the applicant email matches, otherwise STARTED_BY_OTHER. * ApplicationId is returned only for STARTED_BY_YOU, so another applicant's handle is never leaked. * The organization reference and applicant email come from trusted headers injected by the widget * gateway, not from the app token's organization. * * **Token types:** APP | **Required scopes:** `bank_account_application:read:org` */ get: operations["GetApplicationStatus"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/authorization-controls/merchant-category-groups": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Lists the Merchant Category Code Groups (MCCGs) pre-configured for the institution — * named sets of merchant category codes. Consumed during card issuance to choose which * groups to white-list as authorization controls on a card. * Each group carries its identifier, description, and effective start and end dates. * Results are paginated; pass the opaque pagination_token from a prior response * to fetch the next page. * @description **Token types:** APP, USER | **Required scopes:** `authorization_control:read:org` */ get: operations["GetMerchantCategoryGroups"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/bank-account-applications": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * List bank account applications. * @description Returns a paginated summary of the bank account applications belonging to the calling * application (tenant). Only non-sensitive fields are included so partners can observe the * progress of their applications. Applicant-scoped (client-secret) tokens are not permitted. * * **Token types:** APP | **Required scopes:** `bank_account_application:read:org` */ get: operations["GetBankAccountApplications"]; put?: never; /** * Create a new bank account application. * @description Creates a new application to apply for an embedded bank account with optional applicant details, business details, and/or business owners. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ post: operations["CreateApplication"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/bank-account-applications/resume": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Resume a bank account application by email. * @description Looks up a DRAFT application by email and reissues a client secret, sending it to the applicant via email. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ post: operations["ResumeApplication"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/bank-account-applications/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a bank account application by ID. * @description Retrieves a bank account application by its ID. * * **Token types:** APP | **Required scopes:** `bank_account_application:read:org` */ get: operations["GetBankAccountApplication"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update an existing bank account application. * @description Updates an existing application with applicant details, business details, and/or business owners in a single request. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ patch: operations["UpdateApplication"]; trace?: never; }; "/embedded-banking/v1/bank-account-applications/{id}/business-verification": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Process KYC/KYB verification for a bank account application. * @description Processes KYC/KYB verification for a bank account application. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ post: operations["VerifyBusiness"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/bank-account-applications/{id}/submission": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Submit a bank account application for processing. * @description Processes an application for an embedded bank account. This triggers KYC/KYB verification. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ post: operations["SubmitApplication"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/bank-account-applications/{id}/verification": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Verify an applicant's email using a verification code. * @description Verifies an email verification code for a bank account application. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ post: operations["VerifyEmailCode"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/bank-account-applications/{id}/verification-codes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send an email verification code to the applicant. * @description Sends an email verification code to the work email address associated with a bank account application. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ post: operations["SendVerificationEmail"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/bank-accounts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get all bank accounts with balances. * @description Retrieves all embedded bank accounts for the authenticated user with their current balances. Bank and platform users can optionally filter by organization ID to see accounts for a specific VSP. * * **Token types:** APP, USER | **Required scopes:** `bank_account:read:org` */ get: operations["GetBankAccounts"]; put?: never; /** * Create a new bank account. * @description Creates a new embedded bank account for the authenticated user. * * **Token types:** APP, USER | **Required scopes:** `bank_account:write:org` */ post: operations["CreateBankAccount"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/bank-accounts/access": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Manage access to bank accounts for users (grant or revoke). * @description Grants or revokes access to bank accounts for the specified users. * Set type to 'GRANT' to grant access or 'REVOKE' to revoke access. * Users cannot revoke their own access. * * **Token types:** APP, USER | **Required scopes:** `bank_account:write:org` */ post: operations["ManageBankAccountAccess"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/bank-accounts/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a bank account by ID. * @description Retrieves a specific bank account with its current balance. * * **Token types:** APP, USER | **Required scopes:** `bank_account:read:org` */ get: operations["GetBankAccount"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update a bank account. * @description Updates a specific bank account. Supports: * - Updating the nickname and/or bankAccountReference * - Closing the account by setting status to CLOSED * When closing an account, nickname and bankAccountReference can be updated in the same request, and they will be applied after the account is closed. * * **Token types:** APP, USER | **Required scopes:** `bank_account:write:org` */ patch: operations["UpdateBankAccount"]; trace?: never; }; "/embedded-banking/v1/bank-accounts/{id}/access": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get users with access to a bank account. * @description Retrieves all users with access to the specified bank account. * * **Token types:** APP, USER | **Required scopes:** `bank_account:read:org` */ get: operations["GetBankAccountAccess"]; put?: never; /** * Grant access to a bank account. * @description Grants access to the specified bank account for the given users. * * **Token types:** APP, USER | **Required scopes:** `bank_account:write:org` */ post: operations["GrantBankAccountAccess"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/bank-accounts/{id}/access/{userId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Revoke access from a bank account. * @description Revokes access to the specified bank account from the given user. Cannot revoke your own access. * * **Token types:** APP, USER | **Required scopes:** `bank_account:write:org` */ delete: operations["RevokeBankAccountAccess"]; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/bank-accounts/{id}/transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get transactions for a bank account. * @description Retrieves transactions for a specific bank account with optional date filtering and pagination. * * **Token types:** APP, USER | **Required scopes:** `bank_account:read:org` */ get: operations["GetBankAccountTransactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/bank-accounts/{id}/transfers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get transfers for a bank account. * @description Retrieves transfers for a specific bank account with cursor-based pagination. * * **Token types:** APP, USER | **Required scopes:** `bank_account:read:org` */ get: operations["GetBankAccountTransfers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/beneficial-owners": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get beneficial owners. * @description Retrieves beneficial owners (business stakeholders) for bank account applications. * BANK callers see all stakeholders across their partner VSPs. * PLATFORM callers see stakeholders for their visible organizations. * When available, the last 4 digits of the SSN are returned via the ssnLast4 field. * * **Token types:** APP, USER | **Required scopes:** `beneficial_owner:read:org` */ get: operations["GetBeneficialOwners"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/credit-card-applications": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create a new credit card application. * @description Creates a new application to apply for an embedded credit card with optional applicant details, business details, and/or business owners. * * **Token types:** APP | **Required scopes:** `credit_card_application:write:org` */ post: operations["CreateCreditCardApplication"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/credit-card-applications/resume": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Resume a credit card application by email. * @description Looks up a DRAFT credit card application by email and reissues a client secret, sending it to the applicant via email. * * **Token types:** APP | **Required scopes:** `credit_card_application:write:org` */ post: operations["ResumeCreditCardApplication"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/credit-card-applications/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a credit card application by ID. * @description Retrieves a credit card application by its ID. * * **Token types:** APP | **Required scopes:** `credit_card_application:read:org` */ get: operations["GetCreditCardApplication"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update an existing credit card application. * @description Merges applicant details, business details, and/or business owners into the stored * record. Omit a section to preserve its stored value; within a section, null fields * preserve existing values. Encrypted PII (SSN, password, tax id) is only re-encrypted * when a new plaintext value is supplied. * * **Token types:** APP | **Required scopes:** `credit_card_application:write:org` */ patch: operations["UpdateCreditCardApplication"]; trace?: never; }; "/embedded-banking/v1/credit-card-applications/{id}/submission": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Submit a credit card application for processing. * @description Runs Alloy KYB/KYC on the application, persists the verification outcome on the row, * and transitions the application out of DRAFT. APPROVED verifications move the * application to PENDING_UNDERWRITING, DENIED verifications move it to REJECTED, and * MANUAL_REVIEW / PENDING verifications move it to SUBMITTED. The client secret is * invalidated on every successful submission. TSYS integration is tracked separately * in EMBD-2118 — this endpoint does not yet call TSYS. * * **Token types:** APP | **Required scopes:** `credit_card_application:write:org` */ post: operations["SubmitCreditCardApplication"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/credit-card-applications/{id}/verification": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Verify an applicant's email using a verification code. * @description Verifies an email verification code for a credit card application. * * **Token types:** APP | **Required scopes:** `credit_card_application:write:org` */ post: operations["VerifyCreditCardEmailCode"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/credit-card-applications/{id}/verification-codes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send an email verification code to the applicant. * @description Sends an email verification code to the work email address associated with a credit card application. * * **Token types:** APP | **Required scopes:** `credit_card_application:write:org` */ post: operations["SendCreditCardVerificationEmail"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/credit-cards": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description **Token types:** APP, USER | **Required scopes:** `credit_card:read:org` */ get: operations["GetCreditCards"]; put?: never; /** @description **Token types:** APP, USER | **Required scopes:** `credit_card:issue:org` */ post: operations["CreateAdditionalCard"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/credit-cards/{cardId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description **Token types:** APP, USER | **Required scopes:** `credit_card:read:org` */ get: operations["GetCreditCardById"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/credit-cards/{cardId}/close": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description **Token types:** USER | **Required scopes:** `credit_card:close:org` */ post: operations["CloseCreditCard"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/credit-cards/{cardId}/lock-status": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description **Token types:** APP, USER | **Required scopes:** `credit_card:lock:org` */ post: operations["SetCreditCardLockStatus"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/credit-cards/{id}/activate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** @description **Token types:** USER | **Required scopes:** `credit_card:activate:org` */ post: operations["ActivateCreditCard"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/credit-cards/{id}/transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description **Token types:** APP, USER | **Required scopes:** `credit_card:read:org` */ get: operations["GetCreditCardTransactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/disclosure-acceptances": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Accept bank disclosures using an invitation token. * Requires an application (APP) token. * @description Accepts bank disclosures using an invitation token for a specific user. Requires an application (APP) token. */ post: operations["AcceptDisclosuresWithToken"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/disclosures/accept": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Accept bank disclosures for the authenticated user. * @description Accepts bank disclosures for the authenticated user. */ post: operations["AcceptDisclosures"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/external-bank-accounts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Gets all external bank accounts for the authenticated user. * @description Retrieves all external bank accounts for the authenticated user. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:read:org` */ get: operations["GetExternalBankAccounts"]; put?: never; /** * Connects a new external bank account. * @description Connects a new external bank account. Optionally pass a verification object to set the account as verified immediately (MANUAL method only). Requires 'external_bank_account:set_verification:org' scope when verification is provided. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org` */ post: operations["ConnectExternalBankAccount"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/external-bank-accounts/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Gets an external bank account by ID. * @description Retrieves a specific external bank account by ID. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:read:org` */ get: operations["GetExternalBankAccount"]; put?: never; post?: never; /** * Unlinks an external bank account. * @description Unlinks (deactivates) an external bank account. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org` */ delete: operations["UnlinkExternalBankAccount"]; options?: never; head?: never; /** * Updates an external bank account. * @description Updates an external bank account's nickname and/or verification status. Updating verification status requires 'CanSetExternalBankAccountVerification' permission. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org` */ patch: operations["UpdateExternalBankAccount"]; trace?: never; }; "/embedded-banking/v1/external-bank-accounts/{id}/access": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get users with access to an external bank account. * @description Retrieves all users with access to the specified external bank account. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:read:org` */ get: operations["GetExternalBankAccountAccess"]; put?: never; /** * Grant access to an external bank account. * @description Grants access to the specified external bank account for the given users. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org` */ post: operations["GrantExternalBankAccountAccess"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/external-bank-accounts/{id}/access/{userId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Revoke access from an external bank account. * @description Revokes access to the specified external bank account from the given user. Cannot revoke your own access. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org` */ delete: operations["RevokeExternalBankAccountAccess"]; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/external-bank-accounts/{id}/link": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Links an external bank account by initiating micro-deposit verification. * @description Initiates micro-deposit verification for an existing external bank account. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:micro_deposit:org` */ post: operations["LinkExternalBankAccount"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/external-bank-accounts/{id}/validate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Validates an external bank account using micro-deposits. * @description Validates an external bank account using micro-deposit amounts. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org` */ post: operations["ValidateExternalBankAccount"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/money-movements/ach": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Creates an ACH money movement. * @description Creates an ACH (Automated Clearing House) money movement between accounts. * * **Token types:** APP, USER | **Required scopes:** `transfer:write:org` */ post: operations["CreateAchMoneyMovement"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/money-movements/book": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Creates a book transfer (internal-to-internal) between bank accounts. * @description Creates a book transfer (internal-to-internal) between two bank accounts within the same organization. * * **Token types:** APP, USER | **Required scopes:** `transfer:write:org` */ post: operations["CreateBookTransfer"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/money-movements/fednow": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Creates a FedNow (Federal Reserve instant payment) money movement. * @description Creates a FedNow (Federal Reserve instant payment) money movement. * * **Token types:** APP, USER | **Required scopes:** `transfer:write:org` */ post: operations["CreateFedNowMoneyMovement"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/money-movements/rtp": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Creates an RTP (Real-Time Payments) money movement. * @description Creates an RTP (Real-Time Payments) money movement for instant transfers. * * **Token types:** APP, USER | **Required scopes:** `transfer:write:org` */ post: operations["CreateRtpMoneyMovement"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/embedded-banking/v1/organization/summary": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a summary of organization data for the authenticated user's organization hierarchy. * @description Returns aggregated counts for applications, bank accounts, and external bank accounts within the caller's visible organization hierarchy. */ get: operations["GetOrganizationSummary"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/files/boarding/applications/{applicationId}/attachments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Provides a way to upload an attachment for a given application */ post: operations["PostFilesBoardingApplicationsApplicationidAttachments"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/files/boarding/applications/{applicationId}/attachments/{attachmentId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get: operations["GetFilesBoardingApplicationsApplicationidAttachmentsAttachmentid"]; put?: never; post?: never; delete: operations["DeleteFilesBoardingApplicationsApplicationidAttachmentsAttachmentid"]; options?: never; head?: never; patch?: never; trace?: never; }; "/files/disputes/{disputeId}/attachments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Provides a way to upload an attachment for a given dispute * @description **Required scopes:** `dispute:write` */ post: operations["PostFilesDisputesDisputeidAttachments"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/files/disputes/{disputeId}/attachments/{attachmentId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description **Required scopes:** `dispute:read` */ get: operations["GetFilesDisputesDisputeidAttachmentsAttachmentid"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/files/reporting/{type}/{id}/download": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post: operations["PostFilesReportingTypeIdDownload"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/files/underwriting/applications/{applicationId}/attachments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Provides a way to upload an attachment for a given application */ post: operations["PostFilesUnderwritingApplicationsApplicationidAttachments"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/files/underwriting/applications/{applicationId}/attachments/{attachmentId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get: operations["GetFilesUnderwritingApplicationsApplicationidAttachmentsAttachmentid"]; put?: never; post?: never; delete: operations["DeleteFilesUnderwritingApplicationsApplicationidAttachmentsAttachmentid"]; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/accounting-connections": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get accounting connections * @description Get all connections */ get: operations["get_accounting-connections"]; put?: never; /** * Connect to an accounting system * @description Create new connection */ post: operations["post_accounting-connections"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/accounting-connections/{connection_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get an accounting connection by ID * @description Get connection by id */ get: operations["get_accounting-connections_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/accounting-connections/{connection_id}/disconnect": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Disconnect from an accounting system * @description Disconnect */ post: operations["post_accounting-connections_id_disconnect"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/accounting-connections/{connection_id}/sync": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Force Sync */ post: operations["post_accounting-connections_id_sync"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/accounting-synced-records": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Synced Records * @description Get synchronized records */ get: operations["get_accounting-synced-records"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/accounting-synced-records/{synced_record_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Single Synced Record * @description Get synchronized record by id */ get: operations["get_accounting-synced-records_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/accounting-synced-records/{synced_record_id}/push": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Push Object * @description Push object to the accounting system manually */ post: operations["post_accounting-synced-records_id_push"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/accounting-tax-rates": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get tax rate accounts * @description Get all tax rate accounts */ get: operations["get_accounting-tax-rates"]; put?: never; /** * Create a new tax rate * @description Create a new tax rate account */ post: operations["post_accounting-tax-rates"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/accounting-tax-rates/{tax_rate_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a tax rate account by ID * @description Get tax rate account by id */ get: operations["get_accounting-tax-rates_id"]; put?: never; post?: never; /** * Delete a tax rate * @description Delete a tax rate account */ delete: operations["delete_accounting-tax-rates_id"]; options?: never; head?: never; /** * Update a tax rate * @description Update an existing tax rate account */ patch: operations["patch_accounting-tax-rates_id"]; trace?: never; }; "/finops/v1/accounting/payables": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get payables list from accounting system * @description Returns a list of accounts payable invoices (bills) that exist in the entity's accounting system. This requires that an accounting connection has been previously established. Refer to the [Accounting integration guide](https://docs.monite.com/accounting/integration/index) for details. * * This endpoint only provides read-only access to the accounting system's data but does not pull those payables into Monite. You can use it to review the data in the accounting system and find out which of those payables already exist or do not exist in Monite. * * Data is actual as of the date and time of the last accounting synchronization, which is specified by the `last_pull` value in the response from `GET /accounting-connections/{connection_id}`. To make sure you are accessing the most up-to-date accounting data, you can use `POST /accounting-connections/{connection_id}/sync` to trigger on-demand synchronization before getting the list of payables. */ get: operations["get_accounting_payables"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/accounting/payables/{payable_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get payable details from accounting system * @description Returns information about an individual payable invoice (bill) that exists in the entity's accounting system. This payable may or may not also exist in Monite. */ get: operations["get_accounting_payables_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/accounting/receivables": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get invoice list from accounting system * @description Returns a list of invoices that exist in the entity's accounting system. This requires that an accounting connection has been previously established. Refer to the [Accounting integration guide](https://docs.monite.com/accounting/integration/index) for details. * * This endpoint only provides read-only access to the accounting system's data but does not pull those invoices into Monite. You can use it to review the data in the accounting system and find out which of those invoices already exist or do not exist in Monite. * * Data is actual as of the date and time of the last accounting synchronization, which is specified by the `last_pull` value in the response from `GET /accounting-connections/{connection_id}`. To make sure you are accessing the most up-to-date accounting data, you can use `POST /accounting-connections/{connection_id}/sync` to trigger on-demand synchronization before getting the invoice list. */ get: operations["get_accounting_receivables"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/accounting/receivables/{invoice_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get invoice details from accounting system * @description Returns information about an individual invoice that exists in the entity's accounting system. This invoice may or may not also exist in Monite. */ get: operations["get_accounting_receivables_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/analytics/credit-notes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get credit notes analytics * @description Retrieve aggregated statistics for payables with different breakdowns. */ get: operations["get_analytics_credit-notes"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/analytics/payables": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get payables analytics * @description Retrieve aggregated statistics for payables with different breakdowns. */ get: operations["get_analytics_payables"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/analytics/receipts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get receipts analytics * @description Retrieve aggregated statistics for payables with different breakdowns. */ get: operations["get_analytics_receipts"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/analytics/receivables": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get receivables analytics * @description Retrieve aggregated statistics for receivables with different breakdowns. */ get: operations["get_analytics_receivables"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/analytics/transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get transaction analytics */ get: operations["get_analytics_transactions"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/approval-policies": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get approval policies * @description Retrieve a list of all approval policies with pagination. */ get: operations["get_approval-policies"]; put?: never; /** * Create an approval policy * @description Create a new approval policy. */ post: operations["post_approval-policies"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/approval-policies/{approval_policy_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get an approval policy by ID * @description Retrieve a specific approval policy. */ get: operations["get_approval-policies_id"]; put?: never; post?: never; /** * Delete an approval policy * @description Delete an existing approval policy. */ delete: operations["delete_approval-policies_id"]; options?: never; head?: never; /** * Update an approval policy * @description Update an existing approval policy. */ patch: operations["patch_approval-policies_id"]; trace?: never; }; "/finops/v1/approval-policies/{approval_policy_id}/processes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get approval processes created from a policy * @description Retrieve a list of approval policy processes. The response is capped at the 500 most recent processes; use the `object_id` + `object_type` filters to narrow results for a specific resource. */ get: operations["get_approval-policies_id_processes"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get an approval process by ID * @description Retrieve a specific approval policy process. */ get: operations["get_approval-policies_id_processes_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Cancel an approval process * @description Cancel an ongoing approval process for a specific approval policy. */ post: operations["post_approval-policies_id_processes_id_cancel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/steps": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the steps of an approval process * @description Retrieve a list of approval policy process steps. */ get: operations["get_approval-policies_id_processes_id_steps"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/approval-requests": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get approval requests */ get: operations["get_approval-requests"]; put?: never; /** Create an approval request */ post: operations["post_approval-requests"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/approval-requests/{approval_request_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get an approval request by ID */ get: operations["get_approval-requests_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/approval-requests/{approval_request_id}/approve": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Approve an approval request */ post: operations["post_approval-requests_id_approve"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/approval-requests/{approval_request_id}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Cancel an approval request */ post: operations["post_approval-requests_id_cancel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/approval-requests/{approval_request_id}/reject": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Reject an approval request */ post: operations["post_approval-requests_id_reject"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/bank-details": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get an entity's bank accounts * @description Get all bank accounts of this entity. */ get: operations["get_bank-details"]; put?: never; /** * Create an entity bank account * @description Add a new US bank account for the specified entity. * * Required fields are `account_holder_name`, `account_number` and `routing_number`. Optionally provide * `bank_name` and `display_name`. */ post: operations["post_bank-details"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/bank-details/{bank_account_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get an entity's bank account * @description Retrieve a bank account by its ID. */ get: operations["get_bank-details_id"]; put?: never; post?: never; /** * Delete an entity's bank account * @description Delete the bank account specified by its ID. */ delete: operations["delete_bank-details_id"]; options?: never; head?: never; /** * Update an entity's bank account * @description Change the specified fields with the provided values. */ patch: operations["patch_bank-details_id"]; trace?: never; }; "/finops/v1/batch-payment-links": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create a batch payment link */ post: operations["post_batch-payment-links"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/batch-payment-links/{batch_payment_link_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a batch payment link by ID */ get: operations["get_batch-payment-links_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/batch-payment-links/{batch_payment_link_id}/expire": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Expire a batch payment link */ post: operations["post_batch-payment-links_id_expire"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/batch-payments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create a batch payment */ post: operations["post_batch-payments"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/batch-payments/{batch_payment_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get batch payment by ID */ get: operations["get_batch-payments_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/comments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get comments * @description Get comments */ get: operations["get_comments"]; put?: never; /** * Create a comment * @description Create new comment */ post: operations["post_comments"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/comments/{comment_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a comment by ID * @description Get comment */ get: operations["get_comments_id"]; put?: never; post?: never; /** * Delete a comment * @description Delete comment */ delete: operations["delete_comments_id"]; options?: never; head?: never; /** * Update a comment * @description Update comment */ patch: operations["patch_comments_id"]; trace?: never; }; "/finops/v1/companies": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Delete * @description Delete company */ delete: operations["delete_companies"]; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/cost-centers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get cost centers * @description Get all cost centers */ get: operations["get_cost-centers"]; put?: never; /** * Create a new cost center * @description Create a new cost center */ post: operations["post_cost-centers"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/cost-centers/{cost_center_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a cost center by ID * @description Get cost center by id */ get: operations["get_cost-centers_id"]; put?: never; post?: never; /** * Delete a cost center * @description Delete a cost center */ delete: operations["delete_cost-centers_id"]; options?: never; head?: never; /** * Update a cost center * @description Update an existing cost center */ patch: operations["patch_cost-centers_id"]; trace?: never; }; "/finops/v1/counterparts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get all counterparts */ get: operations["get_counterparts"]; put?: never; /** Create a counterpart */ post: operations["post_counterparts"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a counterpart */ get: operations["get_counterparts_id"]; put?: never; post?: never; /** Delete a counterpart */ delete: operations["delete_counterparts_id"]; options?: never; head?: never; /** Update a counterpart */ patch: operations["patch_counterparts_id"]; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}/addresses": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a counterpart's addresses */ get: operations["get_counterparts_id_addresses"]; put?: never; /** Create a counterpart address */ post: operations["post_counterparts_id_addresses"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a counterpart's address */ get: operations["get_counterparts_id_addresses_id"]; put?: never; post?: never; /** Delete a counterpart's address */ delete: operations["delete_counterparts_id_addresses_id"]; options?: never; head?: never; /** Update a counterpart's address */ patch: operations["patch_counterparts_id_addresses_id"]; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}/bank-accounts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a counterpart's bank accounts */ get: operations["get_counterparts_id_bank-accounts"]; put?: never; /** Create a counterpart bank account */ post: operations["post_counterparts_id_bank-accounts"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a counterpart's bank account */ get: operations["get_counterparts_id_bank-accounts_id"]; put?: never; post?: never; /** Delete a counterpart's bank account */ delete: operations["delete_counterparts_id_bank-accounts_id"]; options?: never; head?: never; /** Update a counterpart's bank account */ patch: operations["patch_counterparts_id_bank-accounts_id"]; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}/make-default": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Set a counterpart's bank account as default for its currency */ post: operations["post_counterparts_id_bank-accounts_id_make-default"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}/contacts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a counterpart's contacts */ get: operations["get_counterparts_id_contacts"]; put?: never; /** Create a counterpart contact */ post: operations["post_counterparts_id_contacts"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a counterpart's contact */ get: operations["get_counterparts_id_contacts_id"]; put?: never; post?: never; /** Delete a counterpart's contact */ delete: operations["delete_counterparts_id_contacts_id"]; options?: never; head?: never; /** Update a counterpart's contact */ patch: operations["patch_counterparts_id_contacts_id"]; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}/make-default": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Set a counterpart's default contact */ post: operations["post_counterparts_id_contacts_id_make-default"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a list of a counterpart's e-invoicing credentials */ get: operations["get_counterparts_id_einvoicing-credentials"]; put?: never; /** Add e-invoicing credentials for a counterpart */ post: operations["post_counterparts_id_einvoicing-credentials"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a counterpart's e-invoicing credentials by ID */ get: operations["get_counterparts_id_einvoicing-credentials_id"]; put?: never; post?: never; /** Delete a counterpart's e-invoicing credentials */ delete: operations["delete_counterparts_id_einvoicing-credentials_id"]; options?: never; head?: never; /** Update a counterpart's e-invoicing credentials */ patch: operations["patch_counterparts_id_einvoicing-credentials_id"]; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}/partner-metadata": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get counterpart metadata */ get: operations["get_counterparts_id_partner-metadata"]; /** Replace counterpart metadata */ put: operations["put_counterparts_id_partner-metadata"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}/vat-ids": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a counterpart's VAT IDs */ get: operations["get_counterparts_id_vat-ids"]; put?: never; /** Create a counterpart VAT ID */ post: operations["post_counterparts_id_vat-ids"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a counterpart's VAT ID */ get: operations["get_counterparts_id_vat-ids_id"]; put?: never; post?: never; /** Delete a counterpart's VAT ID */ delete: operations["delete_counterparts_id_vat-ids_id"]; options?: never; head?: never; /** Update a counterpart's VAT ID */ patch: operations["patch_counterparts_id_vat-ids_id"]; trace?: never; }; "/finops/v1/custom-tax-rates": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get custom tax rates */ get: operations["get_custom-tax-rates"]; put?: never; /** Create a custom tax rate */ post: operations["post_custom-tax-rates"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/custom-tax-rates/{custom_tax_rate_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a custom tax rate by ID */ get: operations["get_custom-tax-rates_id"]; put?: never; post?: never; /** Delete a custom tax rate */ delete: operations["delete_custom-tax-rates_id"]; options?: never; head?: never; /** Update a custom tax rate */ patch: operations["patch_custom-tax-rates_id"]; trace?: never; }; "/finops/v1/data-exports": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get all export jobs */ get: operations["get_data-exports"]; put?: never; /** * Create an export job * @description Request the export of payable and receivable documents with the specified statuses. */ post: operations["post_data-exports"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/data-exports/extra-data": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get extra fields included in data export */ get: operations["get_data-exports_extra-data"]; put?: never; /** Add a field to be included in data export */ post: operations["post_data-exports_extra-data"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/data-exports/extra-data/{extra_data_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get an extra field by ID */ get: operations["get_data-exports_extra-data_id"]; put?: never; post?: never; /** Delete an extra field */ delete: operations["delete_data-exports_extra-data_id"]; options?: never; head?: never; /** Update the configuration of an extra field */ patch: operations["patch_data-exports_extra-data_id"]; trace?: never; }; "/finops/v1/data-exports/supported-formats": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get supported export formats */ get: operations["get_data-exports_supported-formats"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/data-exports/{document_export_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the export job status by ID */ get: operations["get_data-exports_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/delivery-notes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get delivery notes * @description Get all delivery notes with filtering and pagination. */ get: operations["get_delivery-notes"]; put?: never; /** Create a delivery note */ post: operations["post_delivery-notes"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/delivery-notes/{delivery_note_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a delivery note by ID */ get: operations["get_delivery-notes_id"]; put?: never; post?: never; /** Delete a delivery note */ delete: operations["delete_delivery-notes_id"]; options?: never; head?: never; /** Update a delivery note */ patch: operations["patch_delivery-notes_id"]; trace?: never; }; "/finops/v1/delivery-notes/{delivery_note_id}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Cancel a delivery note */ post: operations["post_delivery-notes_id_cancel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/delivery-notes/{delivery_note_id}/mark-as-delivered": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Mark a delivery note as delivered */ post: operations["post_delivery-notes_id_mark-as-delivered"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/document-templates": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get PDF templates * @description This API call returns all supported templates with language codes. */ get: operations["get_document-templates"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/document-templates/system": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get built-in PDF templates * @description This API call returns all supported system templates with language codes. */ get: operations["get_document-templates_system"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/document-templates/{document_template_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a PDF template by ID */ get: operations["get_document-templates_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/document-templates/{document_template_id}/make-default": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Set the default PDF template */ post: operations["post_document-templates_id_make-default"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/document-templates/{document_template_id}/preview": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Preview a PDF template * @description Returns a sample PDF invoice generated using the specified template. */ get: operations["get_document-templates_id_preview"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/documents/generate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Generate Document Id * @description Generate an ID for given document */ post: operations["post_documents_generate"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/documents/last": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Last Document */ get: operations["get_documents_last"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/documents/reset": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Doc Id */ post: operations["post_documents_reset"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/documents/{entity_id}/next-numbers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the next document numbers for an entity */ get: operations["get_documents_id_next-numbers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/einvoice-search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Check if e-invoicing credentials exist in the network. */ get: operations["get_einvoice-search"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/entities": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get all entities * @description Retrieve a list of all entities. */ get: operations["get_entities"]; put?: never; /** * Create an entity * @description Create a new entity from the specified values. */ post: operations["post_entities"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/entities/me": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the current entity * @deprecated * @description Deprecated. Use `GET /entity_users/my_entity` instead. */ get: operations["get_entities_me"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update the current entity * @deprecated * @description Deprecated. Use `PATCH /entity_users/my_entity` instead. */ patch: operations["patch_entities_me"]; trace?: never; }; "/finops/v1/entities/{entity_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get an entity * @description Retrieve an entity by its ID. */ get: operations["get_entities_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update an entity * @description Change the specified fields with the provided values. */ patch: operations["patch_entities_id"]; trace?: never; }; "/finops/v1/entities/{entity_id}/activate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Activate an entity * @description Activate an entity to allow it to perform any operations. */ post: operations["post_entities_id_activate"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/entities/{entity_id}/deactivate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Deactivate an entity * @description Deactivate an entity to stop it from performing any operations. */ post: operations["post_entities_id_deactivate"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/entities/{entity_id}/documents": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Update entity onboarding documents * @deprecated * @description Deprecated. Use `POST /onboarding_documents` instead. Update the onboarding documents of an entity. */ post: operations["post_entities_id_documents"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/entities/{entity_id}/logo": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Upload an entity logo * @description Entity logo can be PNG, JPG, or GIF, up to 10 MB in size. The logo is used, for example, in PDF documents created by this entity. */ put: operations["put_entities_id_logo"]; post?: never; /** Delete an entity's logo */ delete: operations["delete_entities_id_logo"]; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/entities/{entity_id}/onboarding-data": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get entity onboarding data */ get: operations["get_entities_id_onboarding-data"]; /** * Update entity onboarding data * @deprecated * @description Deprecated. Use `PATCH /entities/{entity_id}/onboarding_data` instead. Update entity onboarding data. */ put: operations["put_entities_id_onboarding-data"]; post?: never; delete?: never; options?: never; head?: never; /** Patch entity onboarding data */ patch: operations["patch_entities_id_onboarding-data"]; trace?: never; }; "/finops/v1/entities/{entity_id}/onboarding-requirements": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get onboarding requirements * @deprecated * @description Deprecated. Use `GET /onboarding-requirements` instead. Check the information required to complete the onboarding process. */ get: operations["get_entities_id_onboarding-requirements"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/entities/{entity_id}/partner-metadata": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get entity metadata * @description Retrieve a metadata object associated with this entity, usually in a JSON format. */ get: operations["get_entities_id_partner-metadata"]; /** * Replace entity metadata * @description Fully replace the current metadata object with the specified instance. */ put: operations["put_entities_id_partner-metadata"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/entities/{entity_id}/payment-methods": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Enabled Payment Methods * @description Get all enabled payment methods. */ get: operations["get_entities_id_payment-methods"]; /** * Enable Payment Methods * @description Set which payment methods should be enabled. */ put: operations["put_entities_id_payment-methods"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/entities/{entity_id}/settings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get entity settings * @description Retrieve all settings for this entity. */ get: operations["get_entities_id_settings"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update entity settings * @description Change the specified fields with the provided values. */ patch: operations["patch_entities_id_settings"]; trace?: never; }; "/finops/v1/entities/{entity_id}/vat-ids": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get an entity's VAT IDs */ get: operations["get_entities_id_vat-ids"]; put?: never; /** Create an entity VAT ID */ post: operations["post_entities_id_vat-ids"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/entities/{entity_id}/vat-ids/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get an entity's VAT ID */ get: operations["get_entities_id_vat-ids_id"]; put?: never; post?: never; /** Delete an entity's VAT ID */ delete: operations["delete_entities_id_vat-ids_id"]; options?: never; head?: never; /** Update an entity's VAT ID */ patch: operations["patch_entities_id_vat-ids_id"]; trace?: never; }; "/finops/v1/entity-users": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get all entity users * @description Retrieve a list of all entity users. */ get: operations["get_entity-users"]; put?: never; /** * Create an entity user * @description Create a new entity user from the specified values. */ post: operations["post_entity-users"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/entity-users/me": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get current entity user * @description Retrieve an entity user by its ID. */ get: operations["get_entity-users_me"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update current entity user * @description Change the specified fields with provided values. */ patch: operations["patch_entity-users_me"]; trace?: never; }; "/finops/v1/entity-users/my-entity": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get an entity of this user * @description Retrieves information of an entity, which this entity user belongs to. */ get: operations["get_entity-users_my-entity"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update an entity of this user * @description Update information of an entity, which this entity user belongs to. */ patch: operations["patch_entity-users_my-entity"]; trace?: never; }; "/finops/v1/entity-users/my-role": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a role of this entity user * @description Retrieves information of a role assigned to this entity user. */ get: operations["get_entity-users_my-role"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/entity-users/{entity_user_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get an entity user * @description Retrieve an entity user by its ID. */ get: operations["get_entity-users_id"]; put?: never; post?: never; /** Delete an entity user */ delete: operations["delete_entity-users_id"]; options?: never; head?: never; /** * Update an entity user * @description Change the specified fields with provided values. */ patch: operations["patch_entity-users_id"]; trace?: never; }; "/finops/v1/events": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get events * @description Returns all webhook events that were triggered for the specified entity based on your enabled webhook subscriptions. These are the same events that were sent to your configured webhook listener endpoints, aggregated into a single list. Results can be filtered by the related object type or time period. * * You can use this to get the missed events for the time periods when your webhook listener was temporarily unavailable. * * We guarantee access to event data only from the last three months. Earlier events may be unavailable. */ get: operations["get_events"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/events/{event_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get an event by ID * @description Get a webhook event by its ID. The data is the same as you might have previously received in a webhook sent by Monite to your server. */ get: operations["get_events_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/files": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get files */ get: operations["get_files"]; put?: never; /** Upload a file */ post: operations["post_files"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/files/{file_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a file by ID */ get: operations["get_files_id"]; put?: never; post?: never; /** Delete a file */ delete: operations["delete_files_id"]; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/financing-invoices": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get invoices * @description Returns a list of invoices requested for financing */ get: operations["get_financing-invoices"]; put?: never; /** * Request financing for invoices * @description Returns a session token and a connect token to open Kanmon SDK for confirming invoice details. */ post: operations["post_financing-invoices"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/financing-offers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get financing offers and the business status * @description Returns a list of financing offers and the business's onboarding status */ get: operations["get_financing-offers"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/financing-tokens": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Create a token for Kanmon SDK * @description Returns a token for Kanmon SDK. Creates a business and user on Kanmon if not already exist. */ post: operations["post_financing-tokens"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/get-rates-v2": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get Rates V2 * @description Get exchange rates between specified currency and others */ get: operations["get_get-rates-v2"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/batch-payment-links/{batch_payment_link_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Payment Link */ get: operations["get_internal_batch-payment-links_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/currencies": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Currencies */ get: operations["get_internal_currencies"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/payment-intents/{payment_intent_id}/authorize": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Authorize Payment Link */ post: operations["post_internal_payment-intents_id_authorize"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Authorize Payment Link Embedded */ post: operations["post_internal_payment-intents_id_authorize-embedded"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Consent Data */ get: operations["get_internal_payment-intents_id_authorize-embedded_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-code": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Authorize Payment Link Embedded Set Sca Code */ post: operations["post_internal_payment-intents_id_authorize-embedded_id_set-sca-code"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-method": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Authorize Payment Link Embedded Set Sca Method */ post: operations["post_internal_payment-intents_id_authorize-embedded_id_set-sca-method"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/payment-intents/{payment_intent_id}/banks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Banks For Payment Intent */ get: operations["get_internal_payment-intents_id_banks"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/payment-intents/{payment_intent_id}/confirm-payment": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Confirm Payment */ post: operations["post_internal_payment-intents_id_confirm-payment"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/payment-intents/{payment_intent_id}/confirm-tesouro": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Confirm Tesouro Payment */ post: operations["post_internal_payment-intents_id_confirm-tesouro"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/payment-intents/{payment_intent_id}/payments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create Yapily Payment */ post: operations["post_internal_payment-intents_id_payments"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/payment-links/{payment_link_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Payment Link */ get: operations["get_internal_payment-links_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/payment-links/{payment_link_id}/regenerate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Regenerate Payment Link */ post: operations["post_internal_payment-links_id_regenerate"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/internal/payment-page-theme": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get partner payment page theme settings for frontend */ get: operations["get_internal_payment-page-theme"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/ledger-accounts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get ledger accounts * @description Get all ledger accounts */ get: operations["get_ledger-accounts"]; put?: never; /** * Create a new ledger account * @description Create a new ledger account */ post: operations["post_ledger-accounts"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/ledger-accounts/{ledger_account_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a ledger account by ID * @description Get ledger account by id */ get: operations["get_ledger-accounts_id"]; put?: never; post?: never; /** * Delete a ledger account * @description Delete a ledger account */ delete: operations["delete_ledger-accounts_id"]; options?: never; head?: never; /** * Update a ledger account * @description Update an existing ledger account */ patch: operations["patch_ledger-accounts_id"]; trace?: never; }; "/finops/v1/mail-templates": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get All With Filters * @description Get all custom templates */ get: operations["get_mail-templates"]; put?: never; /** * Create * @description Create custom template */ post: operations["post_mail-templates"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/mail-templates/preview": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Preview * @description Preview rendered template */ post: operations["post_mail-templates_preview"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/mail-templates/system": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get All System Templates * @description Get all system templates */ get: operations["get_mail-templates_system"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/mail-templates/{template_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get * @description Get custom template by ID */ get: operations["get_mail-templates_id"]; put?: never; post?: never; /** * Delete * @description Delete custom template bt ID */ delete: operations["delete_mail-templates_id"]; options?: never; head?: never; /** * Update * @description Update custom template by ID */ patch: operations["patch_mail-templates_id"]; trace?: never; }; "/finops/v1/mail-templates/{template_id}/make-default": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Make Default * @description Make template default */ post: operations["post_mail-templates_id_make-default"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/mailbox-domains": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get mailbox domains * @description Get all domains owned by partner_id */ get: operations["get_mailbox-domains"]; put?: never; /** * Create a mailbox domain * @description Create domain for the partner_id */ post: operations["post_mailbox-domains"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/mailbox-domains/{domain_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Delete a mailbox domain * @description Delete domain for the partner_id */ delete: operations["delete_mailbox-domains_id"]; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/mailbox-domains/{domain_id}/verify": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Verify a mailbox domain * @description Verify domain for the partner_id */ post: operations["post_mailbox-domains_id_verify"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/mailboxes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get mailboxes * @description Get all mailboxes owned by Entity */ get: operations["get_mailboxes"]; put?: never; /** * Create a mailbox * @description Create a new mailbox */ post: operations["post_mailboxes"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/mailboxes/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Get mailboxes by IDs * @description Get all mailboxes owned by Entity */ post: operations["post_mailboxes_search"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/mailboxes/{mailbox_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** * Delete a mailbox * @description Delete mailbox */ delete: operations["delete_mailboxes_id"]; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/measure-units": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get measure units */ get: operations["get_measure-units"]; put?: never; /** Create a measure unit */ post: operations["post_measure-units"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/measure-units/{unit_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a measure unit by ID */ get: operations["get_measure-units_id"]; put?: never; post?: never; /** Delete a measure unit */ delete: operations["delete_measure-units_id"]; options?: never; head?: never; /** Update a measure unit */ patch: operations["patch_measure-units_id"]; trace?: never; }; "/finops/v1/ocr-tasks": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get OCR tasks */ get: operations["get_ocr-tasks"]; put?: never; /** OCR a file from URL */ post: operations["post_ocr-tasks"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/ocr-tasks/upload-from-file": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Upload a file for OCR */ post: operations["post_ocr-tasks_upload-from-file"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/ocr-tasks/{task_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get an OCR task by ID */ get: operations["get_ocr-tasks_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/overdue-reminders": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get overdue reminder configurations */ get: operations["get_overdue-reminders"]; put?: never; /** Create an overdue reminder configuration */ post: operations["post_overdue-reminders"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/overdue-reminders/{overdue_reminder_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get an overdue reminder configuration by ID */ get: operations["get_overdue-reminders_id"]; put?: never; post?: never; /** Delete an overdue reminder configuration */ delete: operations["delete_overdue-reminders_id"]; options?: never; head?: never; /** Update an overdue reminder configuration */ patch: operations["patch_overdue-reminders_id"]; trace?: never; }; "/finops/v1/payable-credit-notes": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get credit notes */ get: operations["get_payable-credit-notes"]; put?: never; /** Create a credit note */ post: operations["post_payable-credit-notes"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-credit-notes/upload-from-file": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Upload a credit note from a file * @description Upload an incoming credit note (payable) in PDF, PNG, or JPEG format and scan its contents. The maximum file size is 20MB. */ post: operations["post_payable-credit-notes_upload-from-file"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-credit-notes/validations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get credit note validations * @description Get credit notes validations. */ get: operations["get_payable-credit-notes_validations"]; /** * Update credit note validations * @description Update credit notes validations. */ put: operations["put_payable-credit-notes_validations"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-credit-notes/validations/reset": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Reset credit note validations * @description Reset credit notes validations. */ post: operations["post_payable-credit-notes_validations_reset"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-credit-notes/{credit_note_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a credit note by ID */ get: operations["get_payable-credit-notes_id"]; put?: never; post?: never; /** Delete a credit note */ delete: operations["delete_payable-credit-notes_id"]; options?: never; head?: never; /** Update a credit note */ patch: operations["patch_payable-credit-notes_id"]; trace?: never; }; "/finops/v1/payable-credit-notes/{credit_note_id}/approve": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Approve a credit note * @description Approve the credit note for appliance. */ post: operations["post_payable-credit-notes_id_approve"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-credit-notes/{credit_note_id}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Cancel a credit note * @description Cancel the credit note that was not confirmed during the review. */ post: operations["post_payable-credit-notes_id_cancel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-credit-notes/{credit_note_id}/cancel-ocr": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Cancel OCR of a credit note * @description Request to cancel the OCR processing of the specified credit note. */ post: operations["post_payable-credit-notes_id_cancel-ocr"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-credit-notes/{credit_note_id}/line-items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get all line items of a credit note */ get: operations["get_payable-credit-notes_id_line-items"]; /** Replace all line items of a credit note */ put: operations["put_payable-credit-notes_id_line-items"]; /** Add a new line item to a credit note */ post: operations["post_payable-credit-notes_id_line-items"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a single line item of a credit note */ get: operations["get_payable-credit-notes_id_line-items_id"]; put?: never; post?: never; /** Delete a line item from a credit note */ delete: operations["delete_payable-credit-notes_id_line-items_id"]; options?: never; head?: never; /** Update a line item of a credit note */ patch: operations["patch_payable-credit-notes_id_line-items_id"]; trace?: never; }; "/finops/v1/payable-credit-notes/{credit_note_id}/reject": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Reject a credit note * @description Decline the credit note when an approver finds any mismatch or discrepancies. */ post: operations["post_payable-credit-notes_id_reject"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-credit-notes/{credit_note_id}/submit-for-approval": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Submit a credit note for approval * @description Start the approval process once the uploaded credit note is validated. */ post: operations["post_payable-credit-notes_id_submit-for-approval"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-credit-notes/{credit_note_id}/validate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Validate a credit note */ get: operations["get_payable-credit-notes_id_validate"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-purchase-orders": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get purchase orders */ get: operations["get_payable-purchase-orders"]; put?: never; /** Create a purchase order */ post: operations["post_payable-purchase-orders"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-purchase-orders/variables": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the available variables for purchase orders * @description Get a list of placeholders allowed to insert into an email template for customization */ get: operations["get_payable-purchase-orders_variables"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-purchase-orders/{purchase_order_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a purchase order by ID */ get: operations["get_payable-purchase-orders_id"]; put?: never; post?: never; /** Delete a purchase order */ delete: operations["delete_payable-purchase-orders_id"]; options?: never; head?: never; /** Update a purchase order */ patch: operations["patch_payable-purchase-orders_id"]; trace?: never; }; "/finops/v1/payable-purchase-orders/{purchase_order_id}/preview": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Preview a purchase order's email message */ post: operations["post_payable-purchase-orders_id_preview"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payable-purchase-orders/{purchase_order_id}/send": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Send a purchase order via email */ post: operations["post_payable-purchase-orders_id_send"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get payables * @description Lists all payables from the connected entity. * * If you already have the data of the payable (amount in [minor units]( * https://docs.monite.com/references/currencies#minor-units), currency, vendor information, and other details) * stored somewhere as individual attributes, you can create a payable with these attributes by calling [POST * /payables](https://docs.monite.com/api/payables/post-payables) and providing the [base64-encoded]( * https://en.wikipedia.org/wiki/Base64) contents of the original invoice file in the field `base64_encoded_file`. * * A payable is a financial document given by an entity`s supplier itemizing the purchase of a good or a service and * demanding payment. * * The `file_name` field is optional. If omitted, it defaults to “default_file_name”. If the settings are configured * to automatically set `suggested_payment_term`, this object can be omitted from the request body. * * The `id` generated for this payable can be used in other API calls to update the data of this payable or trigger [ * status transitions](https://docs.monite.com/accounts-payable/approvals/manual-transition), for example. essential data * fields to move from `draft` to `new` * * Related guide: [Create a payable from data](https://docs.monite.com/accounts-payable/payables/collect#create-a-payable-from-data) * * See also: * * * [Automatic calculation of due date](https://docs.monite.com/accounts-payable/payables/collect#automatic-calculation-of-due-date) * * [Suggested payment date](https://docs.monite.com/accounts-payable/payables/collect#suggested-payment-date) * * [Attach file](https://docs.monite.com/accounts-payable/payables/collect#attach-file) * * [Collect payables by email](https://docs.monite.com/accounts-payable/payables/collect#send-payables-by-email) * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) */ get: operations["get_payables"]; put?: never; /** * Create a payable * @description Add a new payable by providing the amount, currency, vendor name, and other details. * You can provide the base64_encoded contents of the original invoice file in the field `base64_encoded_file`. * * You can use this endpoint to bypass the Monite OCR service and provide the data directly * (for example, if you already have the data in place). * * A newly created payable has the the `draft` [status](https://docs.monite.com/accounts-payable/payables/index). */ post: operations["post_payables"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/analytics": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get payables analytics * @deprecated * @description Retrieve aggregated statistics for payables, including total amount and count, both overall and by status. * * For more flexible configuration and retrieval of other data types, use `GET /analytics/payables`. */ get: operations["get_payables_analytics"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/storecove": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Webhook to receive e-invoicing events from Storecove for new documents * @description A webhook endpoint designed to handle e-invoicing events from Storecove. It listens for events about newly received documents and validates them for further processing in a background. More information about Storecove webhooks is [here](https://www.storecove.com/docs#_receiving_documents). */ post: operations["post_payables_storecove"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/upload-from-file": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Upload a payable from a file * @description Upload an incoming invoice (payable) in PDF, PNG, or JPEG format and scan its contents. The maximum file size is 20MB. */ post: operations["post_payables_upload-from-file"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/validations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get payables validations * @description Get payable validations. */ get: operations["get_payables_validations"]; /** * Update payables validations * @description Update payable validations. */ put: operations["put_payables_validations"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/validations/reset": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Reset payables validations * @description Reset payable validations to default ones. */ post: operations["post_payables_validations_reset"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/variables": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the available variables for payable email templates * @description Get a list of placeholders allowed to insert into an email template for customization */ get: operations["get_payables_variables"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/{payable_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a payable by ID * @description Retrieves information about a specific payable with the given ID. */ get: operations["get_payables_id"]; put?: never; post?: never; /** * Delete a payable * @description Deletes a specific payable. */ delete: operations["delete_payables_id"]; options?: never; head?: never; /** * Update a payable * @description Updates the information about a specific payable. */ patch: operations["patch_payables_id"]; trace?: never; }; "/finops/v1/payables/{payable_id}/approve-payment-operation": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Approve a payable for payment * @description Confirms that the payable is ready to be paid. */ post: operations["post_payables_id_approve-payment-operation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/{payable_id}/attach-file": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Attach a file to a payable * @description Attach file to payable without existing attachment. */ post: operations["post_payables_id_attach-file"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/{payable_id}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Cancel a payable * @description Cancels the payable that was not confirmed during the review. */ post: operations["post_payables_id_cancel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/{payable_id}/cancel-ocr": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Cancel OCR of a payable * @description Request to cancel the OCR processing of the specified payable. */ post: operations["post_payables_id_cancel-ocr"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/{payable_id}/history": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Returns the history of the specified accounts payable document. */ get: operations["get_payables_id_history"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/{payable_id}/line-items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the line items of a payable * @description Get a list of all line items related to a specific payable. * Related guide: [List all payable line items](https://docs.monite.com/accounts-payable/payables/line-items#list-all-line-items-of-a-payable) * * See also: * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) * * [Collect payables](https://docs.monite.com/accounts-payable/payables/collect) */ get: operations["get_payables_id_line-items"]; /** * Replaces the lines items in a payable * @description Replaces the information of all line items of a specific payable. * * Related guide: [Replace all line items](https://docs.monite.com/accounts-payable/payables/line-items#replace-all-line-items) * * See also: * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) * * [Collect payables](https://docs.monite.com/accounts-payable/payables/collect) */ put: operations["put_payables_id_line-items"]; /** * Add a line item to a payable * @description Add a new line item to a specific payable. * * The `subtotal` and `total` fields of line items are automatically calculated based on the `unit_price`, * `quantity`, and `tax` fields, therefore, are read-only and appear only in the response schema. The field * `ledger_account_id` is required **only** for account integration, otherwise, it is optional. * * Related guide: [Add line items to a payable](https://docs.monite.com/accounts-payable/payables/line-items#add-line-items-to-a-payable) * * See also: * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) * * [Collect payables](https://docs.monite.com/accounts-payable/payables/collect) */ post: operations["post_payables_id_line-items"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/{payable_id}/line-items/{line_item_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a single line item of a payable * @description Get information about a specific line item with a given ID. * * Related guide: [Retrieve a line item](https://docs.monite.com/accounts-payable/payables/line-items#retrieve-a-line-item) * * See also: * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) * * [Collect payables](https://docs.monite.com/accounts-payable/payables/collect) */ get: operations["get_payables_id_line-items_id"]; put?: never; post?: never; /** * Delete a line item from a payable * @description Delete the line item with the given ID. * * Related guide: [Remove a line item](https://docs.monite.com/accounts-payable/payables/line-items#remove-a-line-item) * * See also: * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) * * [Collect payables](https://docs.monite.com/accounts-payable/payables/collect) */ delete: operations["delete_payables_id_line-items_id"]; options?: never; head?: never; /** * Update a line item in a payable * @description Edits the information of a specific line item. * * Related guide: [Update a line item](https://docs.monite.com/accounts-payable/payables/line-items#update-a-line-item) * * See also: * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) * * [Collect payables](https://docs.monite.com/accounts-payable/payables/collect) */ patch: operations["patch_payables_id_line-items_id"]; trace?: never; }; "/finops/v1/payables/{payable_id}/mark-as-paid": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Mark a payable as paid * @description Mark a payable as paid. * * Payables can be paid using the payment channels offered by Monite or through external payment channels. In the latter * case, the invoice is not automatically marked as paid in the system and needs to be converted to the paid status * manually. * * Optionally, it is possible to pass the `comment` field in the request body, to describe how and when the invoice was * paid. * * Notes: * - To use this endpoint with an entity user token, this entity user must have a role that includes the `pay` permission * for payables. * - The `amount_to_pay` field is automatically calculated based on the `amount_due` less the percentage described * in the `payment_terms.discount` value. * * Related guide: [Mark a payable as paid](https://docs.monite.com/accounts-payable/approvals/manual-transition#mark-as-paid) * * See also: * * [Payables lifecycle](https://docs.monite.com/accounts-payable/payables/index) * * [Payables status transitions](https://docs.monite.com/accounts-payable/payables/collect#suggested-payment-date) */ post: operations["post_payables_id_mark-as-paid"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/{payable_id}/mark-as-partially-paid": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Mark a payable as partially paid * @description Mark a payable as partially paid. * * If the payable is partially paid, its status is moved to `partially_paid`. The value of the `amount_paid` field must be * the sum of all payments made, not only the last one. * * Notes: * - This endpoint can be used for payables in the `waiting_to_be_paid` status. * - The `amount_paid` must be greater than 0 and less than the total payable amount specified by the `amount` field. * - You can use this endpoint multiple times for the same payable to reflect multiple partial payments, always setting the * sum of all payments made. * - To use this endpoint with an entity user token, this entity user must have a role that includes the `pay` * permission for payables. * - The `amount_to_pay` field is automatically calculated based on the `amount_due` less the percentage described * in the `payment_terms.discount` value. * * Related guide: [Mark a payable as partially paid](https://docs.monite.com/accounts-payable/approvals/manual-transition#mark-as-partially-paid) * * See also: * * [Payables lifecycle](https://docs.monite.com/accounts-payable/payables/index) * * [Payables status transitions](https://docs.monite.com/accounts-payable/payables/collect#suggested-payment-date) * * [Mark a payable as paid](https://docs.monite.com/accounts-payable/approvals/manual-transition#mark-as-paid) */ post: operations["post_payables_id_mark-as-partially-paid"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/{payable_id}/reject": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Reject a payable * @description Declines the payable when an approver finds any mismatch or discrepancies. */ post: operations["post_payables_id_reject"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/{payable_id}/reopen": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Reopen a rejected or waiting_to_be_paid payable * @description Reset payable state from rejected or waiting_to_be_paid to new. */ post: operations["post_payables_id_reopen"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/{payable_id}/submit-for-approval": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Submit a payable for approval * @description Starts the approval process once the uploaded payable is validated. */ post: operations["post_payables_id_submit-for-approval"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/{payable_id}/suggestions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get suggestions * @description Get AI suggestions */ get: operations["get_payables_id_suggestions"]; put?: never; post?: never; /** * Delete suggestions * @description Remove AI suggestions */ delete: operations["delete_payables_id_suggestions"]; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payables/{payable_id}/validate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Validate a payable * @description Check the invoice for compliance with the requirements for movement from draft to new status. */ post: operations["post_payables_id_validate"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-fees": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Payment Fees */ get: operations["get_payment-fees"]; put?: never; /** Create Payment Fee */ post: operations["post_payment-fees"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-fees/{fee_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Payment Fee By Id */ get: operations["get_payment-fees_id"]; put?: never; post?: never; /** Delete Payment Fee By Id */ delete: operations["delete_payment-fees_id"]; options?: never; head?: never; /** Update Payment Fee By Id */ patch: operations["patch_payment-fees_id"]; trace?: never; }; "/finops/v1/payment-intents": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get payment intents */ get: operations["get_payment-intents"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-intents/{payment_intent_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get payment intent by ID */ get: operations["get_payment-intents_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** Update the payment intent amount */ patch: operations["patch_payment-intents_id"]; trace?: never; }; "/finops/v1/payment-intents/{payment_intent_id}/history": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get the payment intent history */ get: operations["get_payment-intents_id_history"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-links": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create a payment link */ post: operations["post_payment-links"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-links/{payment_link_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get payment link by ID */ get: operations["get_payment-links_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-links/{payment_link_id}/expire": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Expire a payment link */ post: operations["post_payment-links_id_expire"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-onboarding-links": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create an onboarding link */ post: operations["post_payment-onboarding-links"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-pages": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a receivable by ID * @description GET /payment-pages */ get: operations["get_payment-pages"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-records": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get payment records */ get: operations["get_payment-records"]; put?: never; /** Create a payment record */ post: operations["post_payment-records"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-records/{payment_record_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a payment record */ get: operations["get_payment-records_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** Update a payment record */ patch: operations["patch_payment-records_id"]; trace?: never; }; "/finops/v1/payment-records/{payment_record_id}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Cancel a payment record */ post: operations["post_payment-records_id_cancel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-records/{payment_record_id}/mark-as-succeeded": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Mark a payment record as succeeded */ post: operations["post_payment-records_id_mark-as-succeeded"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-records/{payment_record_id}/start-processing": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Start processing a payment record */ post: operations["post_payment-records_id_start-processing"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-reminders": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get payment reminder configurations */ get: operations["get_payment-reminders"]; put?: never; /** Create a payment reminder configuration */ post: operations["post_payment-reminders"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-reminders/{payment_reminder_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a payment reminder configuration by ID */ get: operations["get_payment-reminders_id"]; put?: never; post?: never; /** Delete a payment reminder configuration */ delete: operations["delete_payment-reminders_id"]; options?: never; head?: never; /** Update a payment reminder configuration */ patch: operations["patch_payment-reminders_id"]; trace?: never; }; "/finops/v1/payment-terms": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get payment terms */ get: operations["get_payment-terms"]; put?: never; /** Create a payment term */ post: operations["post_payment-terms"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-terms/{payment_terms_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a payment term by ID */ get: operations["get_payment-terms_id"]; put?: never; post?: never; /** Delete a payment term */ delete: operations["delete_payment-terms_id"]; options?: never; head?: never; /** Update a payment term */ patch: operations["patch_payment-terms_id"]; trace?: never; }; "/finops/v1/payment-tiers": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Payment Tiers */ get: operations["get_payment-tiers"]; put?: never; /** Create Payment Tier */ post: operations["post_payment-tiers"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/payment-tiers/{tier_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get Payment Tier By Id */ get: operations["get_payment-tiers_id"]; put?: never; post?: never; /** Delete Payment Tier By Id */ delete: operations["delete_payment-tiers_id"]; options?: never; head?: never; /** Update Payment Tier By Id */ patch: operations["patch_payment-tiers_id"]; trace?: never; }; "/finops/v1/persons/{person_id}/documents": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Update person onboarding documents * @deprecated * @description Deprecated. Use `POST /persons/{person_id}/onboarding_documents` instead. Update the onboarding documents of a person. */ post: operations["post_persons_id_documents"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/products": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get products */ get: operations["get_products"]; put?: never; /** Create a product */ post: operations["post_products"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/products/{product_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a product by ID */ get: operations["get_products_id"]; put?: never; post?: never; /** Delete a product */ delete: operations["delete_products_id"]; options?: never; head?: never; /** Update a product */ patch: operations["patch_products_id"]; trace?: never; }; "/finops/v1/projects": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get all projects for entity * @description Get all projects for an entity */ get: operations["get_projects"]; put?: never; /** * Create a project * @description Create a new project. */ post: operations["post_projects"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/projects/{project_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a project by ID * @description Get a project with the given ID. */ get: operations["get_projects_id"]; put?: never; post?: never; /** * Delete a project * @description Delete a project. */ delete: operations["delete_projects_id"]; options?: never; head?: never; /** * Update a project * @description Update a project. */ patch: operations["patch_projects_id"]; trace?: never; }; "/finops/v1/receipts": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get receipts */ get: operations["get_receipts"]; put?: never; /** Create a receipt */ post: operations["post_receipts"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receipts/upload-from-file": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Upload a receipt from a file * @description Upload an incoming receipt in the PDF, PNG, or JPEG format and scan its contents. The maximum file size is 20 MB. */ post: operations["post_receipts_upload-from-file"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receipts/{receipt_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a receipt by ID */ get: operations["get_receipts_id"]; put?: never; post?: never; /** Delete a receipt */ delete: operations["delete_receipts_id"]; options?: never; head?: never; /** Update a receipt */ patch: operations["patch_receipts_id"]; trace?: never; }; "/finops/v1/receipts/{receipt_id}/attach-file": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Attach a file to a receipt * @description Attach a file to a receipt without an existing attachment. */ post: operations["post_receipts_id_attach-file"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receipts/{receipt_id}/line-items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get all line items of a receipt */ get: operations["get_receipts_id_line-items"]; put?: never; /** Add a new line item to a receipt */ post: operations["post_receipts_id_line-items"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; post?: never; /** Delete a line item from a receipt */ delete: operations["delete_receipts_id_line-items_id"]; options?: never; head?: never; /** Update a line item of a receipt */ patch: operations["patch_receipts_id_line-items_id"]; trace?: never; }; "/finops/v1/receivables": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get receivables * @description Returns a list of [accounts receivable](https://docs.monite.com/accounts-receivable/index) documents - invoices, quotes, and credit notes - of the specified entity. * * Results can be filtered by amount, counterpart, due date, and other criteria. Multiple filters are combined using logical AND unless specified otherwise. If no documents matching the search criteria are found, the endpoint returns a successful response with an empty `data` array. * * This endpoint supports [pagination](https://docs.monite.com/api/concepts/pagination-sorting-filtering) and sorting. By default, results are sorted by the creation date in ascending order (from oldest to newest). * * #### Examples * * ##### Invoices * * * Get all overdue invoices: * ``` * GET /receivables?type=invoice&status=overdue * ``` * * * Get all invoices created for the counterpart named "Solarwind" (case-insensitive): * * ``` * GET /receivables?type=invoice?counterpart_name__icontains=Solarwind * ``` * * * Get invoices whose total amount starts from 500 EUR: * * ``` * GET /receivables?type=invoice&total_amount__gte=50000 * ``` * * * Get invoices that are due for payment in September 2024: * * ``` * GET /receivables?type=invoice&due_date__gte=2024-09-01&due_date__lt=2024-10-01 * ``` * **Note:** This will only return invoices with a set due date. Invoices without due dates are excluded from date range filters. * * * * Get invoices without a due date: * * ``` * GET /receivables?type=invoice&has_due_date=false * ``` * * * * Get invoices with any due date (excluding those without due dates): * * ``` * GET /receivables?type=invoice&has_due_date=true * ``` * * * * Get invoices created on or after September 1, 2024: * * ``` * GET /receivables?type=invoice&created_at__gte=2024-09-01T00:00:00Z * ``` * * * Find an invoice created from a specific quote: * * ``` * GET /receivables?type=invoice?based_on=QUOTE_ID * ``` * * ##### Quotes * * * Get the latest created quote: * * ``` * GET /receivables?type=quote&sort=created_at&order=desc&limit=1 * ``` * * * Get the latest issued quote: * * ``` * GET /receivables?type=quote&sort=issue_date&order=desc&limit=1 * ``` * * ##### Credit notes * * * Find all credit notes created for a specific invoice: * * ``` * GET /receivables?type=credit_note?based_on=INVOICE_ID * ``` */ get: operations["get_receivables"]; put?: never; /** Create a receivable */ post: operations["post_receivables"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/required-fields": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get required field names for invoice creation * @description Get field requirements for invoice creation given the entity and counterpart details. */ get: operations["get_receivables_required-fields"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/search": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Search receivables * @description This is a POST version of the `GET /receivables` endpoint. Use it to send search and filter parameters in the request body instead of the URL query string in case the query is too long and exceeds the URL length limit of your HTTP client. */ post: operations["post_receivables_search"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/variables": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get email template variables * @description Get a list of placeholders that can be used in email templates for customization. */ get: operations["get_receivables_variables"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a receivable by ID */ get: operations["get_receivables_id"]; put?: never; post?: never; /** Delete a receivable */ delete: operations["delete_receivables_id"]; options?: never; head?: never; /** Update a receivable */ patch: operations["patch_receivables_id"]; trace?: never; }; "/finops/v1/receivables/{receivable_id}/accept": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Accept a quote */ post: operations["post_receivables_id_accept"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Cancel an invoice */ post: operations["post_receivables_id_cancel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/clone": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Clone a receivable */ post: operations["post_receivables_id_clone"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/decline": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Decline a quote */ post: operations["post_receivables_id_decline"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/history": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a receivable's history * @description Returns the history of the specified accounts receivable document. The history contains all revisions of the document, status updates, and other events that occurred during the document's lifecycle. For more information, see [Document history](https://docs.monite.com/accounts-receivable/document-history). * * You can filter the history by the date range and event type. Events are sorted from oldest to newest by default. */ get: operations["get_receivables_id_history"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/history/{receivable_history_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a receivable's history record by ID * @description Returns a single record from the change history of the specified accounts receivable document. */ get: operations["get_receivables_id_history_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/issue": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Issue a receivable */ post: operations["post_receivables_id_issue"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/line-items": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Update the line items of a receivable * @description Replace all line items of an existing invoice or quote with a new list of line items. */ put: operations["put_receivables_id_line-items"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/mails": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a list of all mails sent by receivable */ get: operations["get_receivables_id_mails"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/mails/{mail_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a mail sent by receivable */ get: operations["get_receivables_id_mails_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/mark-as-paid": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Mark an invoice as paid */ post: operations["post_receivables_id_mark-as-paid"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/mark-as-partially-paid": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Mark an invoice as partially paid * @deprecated * @description Deprecated. Use `POST /payment_records` to record an invoice payment. */ post: operations["post_receivables_id_mark-as-partially-paid"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/mark-as-uncollectible": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Mark an invoice as uncollectible */ post: operations["post_receivables_id_mark-as-uncollectible"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/pdf-link": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a link to the PDF version of a receivable */ get: operations["get_receivables_id_pdf-link"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/preview": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Preview a receivable's email message */ post: operations["post_receivables_id_preview"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/send": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Send a receivable via email */ post: operations["post_receivables_id_send"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/send-test-reminder": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Send a test reminder */ post: operations["post_receivables_id_send-test-reminder"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/receivables/{receivable_id}/verify": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Verify a receivable */ post: operations["post_receivables_id_verify"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/recurrences": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get recurrences */ get: operations["get_recurrences"]; put?: never; /** Create a recurrence */ post: operations["post_recurrences"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/recurrences/{recurrence_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a recurrence by ID */ get: operations["get_recurrences_id"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** Update a recurrence */ patch: operations["patch_recurrences_id"]; trace?: never; }; "/finops/v1/recurrences/{recurrence_id}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Cancel a recurrence */ post: operations["post_recurrences_id_cancel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/recurrences/{recurrence_id}/pause": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Pause a recurrence */ post: operations["post_recurrences_id_pause"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/recurrences/{recurrence_id}/resume": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Resume a recurrence */ post: operations["post_recurrences_id_resume"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/regulatory-templates": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get All */ get: operations["get_regulatory-templates"]; put?: never; /** Create */ post: operations["post_regulatory-templates"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/regulatory-templates/download-template-ids-vat-rates": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Download Template Ids Vat Rates * @description Returns 'template-ids-vat-rates.json' file */ get: operations["get_regulatory-templates_download-template-ids-vat-rates"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/regulatory-templates/{regulatory_template_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get By Id */ get: operations["get_regulatory-templates_id"]; put?: never; post?: never; /** Delete By Id */ delete: operations["delete_regulatory-templates_id"]; options?: never; head?: never; /** Update By Id */ patch: operations["patch_regulatory-templates_id"]; trace?: never; }; "/finops/v1/render-pdf": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Render Pdf */ post: operations["post_render-pdf"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/roles": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Search roles * @description Find all roles that match the search criteria. */ get: operations["get_roles"]; put?: never; /** * Create a role * @description Create a new role from the specified values. */ post: operations["post_roles"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/roles/{role_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a role by ID */ get: operations["get_roles_id"]; put?: never; post?: never; /** * Delete a role * @description Delete a role with the specified ID. The role being deleted must not be in use by any entity users, otherwise a 409 error is returned. To check if there are entity users that have this role, call `GET /entity_users?role_id=ROLE_ID`. */ delete: operations["delete_roles_id"]; options?: never; head?: never; /** * Update a role * @description Change the specified fields with the provided values. */ patch: operations["patch_roles_id"]; trace?: never; }; "/finops/v1/rules": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get All */ get: operations["get_rules"]; put?: never; /** Create */ post: operations["post_rules"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/rules/{rule_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get By Id */ get: operations["get_rules_id"]; put?: never; post?: never; /** Delete By Id */ delete: operations["delete_rules_id"]; options?: never; head?: never; /** Update Rule By Id */ patch: operations["patch_rules_id"]; trace?: never; }; "/finops/v1/send-email": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send Email * @description Send email to the entity */ post: operations["post_send-email"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/send-email/render-template": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Render Template * @description Render template */ post: operations["post_send-email_render-template"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/send-email/send-email-by-document-type": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send Email By Document Type * @description Send Email by Document type */ post: operations["post_send-email_send-email-by-document-type"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/send-email/stateless": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Send Stateless Email * @description Stateless email sender */ post: operations["post_send-email_stateless"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/settings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get partner settings * @description Retrieve all settings for this partner. */ get: operations["get_settings"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Update partner settings * @description Change the specified fields with the provided values. */ patch: operations["patch_settings"]; trace?: never; }; "/finops/v1/tags": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get tags * @description Get a list of all tags. Tags can be assigned to resources to assist with searching and filtering. * Tags can also be used as trigger conditions in payable approval policies. * * Optional filters: * - `category`: Return only tags that belong to the specified category. * - `category__in`: Return tags that belong to any of the specified categories. */ get: operations["get_tags"]; put?: never; /** * Create a tag * @description Create a new tag. The tag name must be unique. * Tag names are case-sensitive, that is `Marketing` and `marketing` are two different tags. * * * The response returns an auto-generated ID assigned to this tag. * To assign this tag to a resource, send the tag ID in the `tag_ids` list when creating or updating a resource. */ post: operations["post_tags"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/tags/{tag_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a tag by ID * @description Get information about a tag with the given ID. */ get: operations["get_tags_id"]; put?: never; post?: never; /** * Delete a tag * @description Delete a tag with the given ID. This tag will be automatically deleted from all resources where it was used. */ delete: operations["delete_tags_id"]; options?: never; head?: never; /** * Update a tag * @description Change the tag name. The new name must be unique among existing tags. * Tag names are case-sensitive, that is `Marketing` and `marketing` are two different tags. */ patch: operations["patch_tags_id"]; trace?: never; }; "/finops/v1/text-templates": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get text templates * @description Get text templates */ get: operations["get_text-templates"]; put?: never; /** * Create a text template * @description Create a text template */ post: operations["post_text-templates"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/text-templates/{text_template_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get a text template by ID * @description Get all custom contents */ get: operations["get_text-templates_id"]; put?: never; post?: never; /** * Delete a text template * @description Delete custom content by ID */ delete: operations["delete_text-templates_id"]; options?: never; head?: never; /** * Update a text template by ID * @description Update custom content by ID */ patch: operations["patch_text-templates_id"]; trace?: never; }; "/finops/v1/text-templates/{text_template_id}/make-default": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Make a text template default * @description Make text template default */ post: operations["post_text-templates_id_make-default"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/transactions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get transactions */ get: operations["get_transactions"]; put?: never; /** Create a transaction */ post: operations["post_transactions"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/transactions/bulk": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Create multiple transactions */ post: operations["post_transactions_bulk"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/transactions/validations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get required fields configuration */ get: operations["get_transactions_validations"]; /** Update required fields configuration */ put: operations["put_transactions_validations"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/transactions/{transaction_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a transaction */ get: operations["get_transactions_id"]; put?: never; post?: never; /** Delete a transaction */ delete: operations["delete_transactions_id"]; options?: never; head?: never; /** Update a transaction */ patch: operations["patch_transactions_id"]; trace?: never; }; "/finops/v1/transactions/{transaction_id}/approve": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Approve a transaction */ post: operations["post_transactions_id_approve"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/transactions/{transaction_id}/cancel": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Cancel a transaction */ post: operations["post_transactions_id_cancel"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/transactions/{transaction_id}/expense_history": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get expense history for a transaction */ get: operations["get_transactions_id_expense_history"]; put?: never; /** Record an approval action in expense history */ post: operations["post_transactions_id_expense_history"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/transactions/{transaction_id}/reject": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Reject a transaction */ post: operations["post_transactions_id_reject"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/transactions/{transaction_id}/reopen": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Reopen a rejected transaction */ post: operations["post_transactions_id_reopen"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/transactions/{transaction_id}/submit": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Submit a transaction for approval */ post: operations["post_transactions_id_submit"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/transactions/{transaction_id}/validate": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Validate a transaction against required fields configuration */ post: operations["post_transactions_id_validate"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/vat-rates": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get VAT rates */ get: operations["get_vat-rates"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/webhook-deliveries": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Get the webhook delivery log * @description Returns an aggregated log of webhook delivery attempts. The data contains a list of triggered webhook events, how many times Monite tried to send each event to your server, the last HTTP status code returned by your webhook listener endpoint, and whether the final attempt to deliver that event was successful. * * We guarantee access to webhook delivery data only from the last three months. Earlier data may be unavailable. * * Note that if the same event type is included in multiple webhook subscriptions, the results will include several entries for each occurrence of this event - one entry per subscription. */ get: operations["get_webhook-deliveries"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/webhook-subscriptions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get webhook subscriptions */ get: operations["get_webhook-subscriptions"]; put?: never; /** Subscribe to a webhook */ post: operations["post_webhook-subscriptions"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/webhook-subscriptions/{webhook_subscription_id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** Get a webhook subscription */ get: operations["get_webhook-subscriptions_id"]; put?: never; post?: never; /** Delete a webhook subscription */ delete: operations["delete_webhook-subscriptions_id"]; options?: never; head?: never; /** Update a webhook subscription */ patch: operations["patch_webhook-subscriptions_id"]; trace?: never; }; "/finops/v1/webhook-subscriptions/{webhook_subscription_id}/disable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Disable a webhook subscription */ post: operations["post_webhook-subscriptions_id_disable"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/webhook-subscriptions/{webhook_subscription_id}/enable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Enable a webhook subscription */ post: operations["post_webhook-subscriptions_id_enable"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/finops/v1/webhook-subscriptions/{webhook_subscription_id}/regenerate-secret": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** Regenerate a webhook secret and return the new webhook subscription */ post: operations["post_webhook-subscriptions_id_regenerate-secret"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/departments": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Lists all departments for the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:read:org` */ get: operations["ListDepartments"]; put?: never; /** * Creates a new department in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ post: operations["CreateDepartment"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/departments/{departmentId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Gets a department by ID. * @description **Token types:** APP, USER | **Required scopes:** `user:read:org` */ get: operations["GetDepartment"]; /** * Updates a department in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ put: operations["UpdateDepartment"]; post?: never; /** * Deactivates a department in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ delete: operations["DeactivateDepartment"]; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/departments/{departmentId}/members": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Bulk assigns or removes users from a department. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ post: operations["BulkUpdateDepartmentMembers"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/departments/{departmentId}/members/{userId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Assigns a user to a department. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ put: operations["AssignUserToDepartment"]; post?: never; /** * Removes a user from a department. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ delete: operations["RemoveUserFromDepartment"]; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/locations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Lists all locations for the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:read:org` */ get: operations["ListLocations"]; put?: never; /** * Creates a new location in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ post: operations["CreateLocation"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/locations/{locationId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Gets a location by ID. * @description **Token types:** APP, USER | **Required scopes:** `user:read:org` */ get: operations["GetLocation"]; /** * Updates a location in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ put: operations["UpdateLocation"]; post?: never; /** * Deactivates a location in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ delete: operations["DeactivateLocation"]; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/locations/{locationId}/members": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Bulk assigns or removes users from a location. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ post: operations["BulkUpdateLocationMembers"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/locations/{locationId}/members/{userId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Assigns a user to a location. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ put: operations["AssignUserToLocation"]; post?: never; /** * Removes a user from a location. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ delete: operations["RemoveUserFromLocation"]; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/oidc-applications": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Lists all applications across the caller's organization hierarchy with child organization type counts. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:read` */ get: operations["ListApplications"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/oidc-applications/{applicationId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Gets an application by ID, including its scopes and enabled status. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:read` */ get: operations["GetApplication"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Updates payment rail scopes for an application. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:write` */ patch: operations["PatchApplicationScopes"]; trace?: never; }; "/identity/v1/oidc-applications/{applicationId}/disable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Disables an application. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:write` */ post: operations["DisableApplication"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/oidc-applications/{applicationId}/enable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Enables an application. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:write` */ post: operations["EnableApplication"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/organizations": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Lists organizations that have a relationship with the caller's organization. * @description Returns organizations that the caller's organization has a relationship with. * Supports optional filtering by organization type and pagination via limit/offset. * Requires the organization:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:read:org` */ get: operations["GetOrganizations"]; put?: never; /** * Creates a new organization as a child of the caller's organization. * @description Creates an EMBEDDED, TRANSACTOR, or VERTICAL_SOFTWARE_PROVIDER organization under the caller's org. * A BANKING_SERVICES relationship is automatically established between the caller and the new org. * Requires the organization:write:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:write:org` */ post: operations["CreateOrganization"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/organizations/visible-ids": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Gets all organization IDs visible to the caller by traversing the hierarchy downward. * @description Returns all organizations below the caller in the hierarchy (e.g., a bank sees its VSPs and their acceptors). * Does NOT return organizations above the caller in the hierarchy. * This endpoint returns only IDs for minimal payload size - ideal for caching by consuming services. * Requires the organization:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:read:org` */ get: operations["GetVisibleOrganizationIds"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/organizations/{organizationId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Gets details for a specific organization. * @description The caller must have a relationship with the target organization to access its details. * Requires the organization:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:read:org` */ get: operations["GetOrganization"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Updates an organization's fields. Only provided fields are updated; omitted fields remain unchanged. * @description The caller must have visibility of the target organization in their hierarchy. * Requires the organization:write:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:write:org` */ patch: operations["UpdateOrganization"]; trace?: never; }; "/identity/v1/organizations/{organizationId}/disable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Disables an organization by setting its deactivation timestamp. * @description Only VSP or EMBEDDED organizations can be disabled. * The target organization must be visible in the caller's hierarchy. * Requires org:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `org:write:all` */ post: operations["DisableOrganization"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/organizations/{organizationId}/disable-applications": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Disables all applications for an organization. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:write` */ post: operations["DisableOrganizationApplications"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/organizations/{organizationId}/disabled-payment-rails": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Gets disabled payment rails for an organization. * @description Returns the list of payment rails that are disabled for the organization. * Empty list means all rails are enabled. Requires the organization:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:read:org` */ get: operations["GetOrganizationPaymentRails"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Updates payment rail status for an organization. * @description Allows disabling or enabling payment rails (payment_rail:ach, payment_rail:fednow, payment_rail:rtp). * Requires the org:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `org:write:all` */ patch: operations["PatchOrganizationPaymentRails"]; trace?: never; }; "/identity/v1/organizations/{organizationId}/enable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Enables an organization by clearing its deactivation timestamp. * @description Only VSP or EMBEDDED organizations can be enabled. * The target organization must be visible in the caller's hierarchy. * Requires org:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `org:write:all` */ post: operations["EnableOrganization"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/organizations/{organizationId}/enable-applications": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Enables all applications for an organization. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:write` */ post: operations["EnableOrganizationApplications"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/organizations/{organizationId}/logo": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; /** * Uploads a logo for an organization. * @description Requires the org:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `org:write:all` */ put: operations["UploadOrganizationLogo"]; post?: never; /** * Deletes a logo for an organization. * @description Requires the org:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `org:write:all` */ delete: operations["DeleteOrganizationLogo"]; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/organizations/{organizationId}/oidc-applications": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Gets all applications for an organization. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:read` */ get: operations["GetOrganizationApplications"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/organizations/{organizationId}/settings": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Gets settings for an organization from Monite Platform. * @description Requires the organization:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:read:org` */ get: operations["GetOrganizationSettings"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Updates settings for an organization in Monite Platform. * @description Requires the org:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `org:write:all` */ patch: operations["PatchOrganizationSettings"]; trace?: never; }; "/identity/v1/roles": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Lists all roles for the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `role:read:org` */ get: operations["ListRoles"]; put?: never; /** * Creates a new role in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `role:write:org` */ post: operations["CreateRole"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/roles/{roleId}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Gets a role by ID. * @description **Token types:** APP, USER | **Required scopes:** `role:read:org` */ get: operations["GetRole"]; put?: never; post?: never; /** * Deactivates a role in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `role:write:org` */ delete: operations["DeleteRole"]; options?: never; head?: never; /** * Updates a role in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `role:write:org` */ patch: operations["UpdateRole"]; trace?: never; }; "/identity/v1/roles/{roleId}/members": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Lists all members assigned to a role in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `role:read:org` */ get: operations["ListRoleMembers"]; put?: never; /** * Assigns or removes users (members) for a role in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ post: operations["BulkUpdateRoleMembers"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/roles/{roleId}/permissions": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Lists all permissions assigned to a role. * @description **Token types:** APP, USER | **Required scopes:** `role:read:org` */ get: operations["ListRolePermissions"]; put?: never; /** * Assigns or removes permissions for a role in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `role:write:org` */ post: operations["BulkUpdateRolePermissions"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/user-data/{key}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Reads the opaque JSON value previously stored under the given key for the * authenticated user. */ get: operations["GetUserData"]; /** * Upserts an opaque JSON value under the given key for the authenticated user. * The service stores and returns the value verbatim; it does not interpret or * validate its shape. */ put: operations["UpsertUserData"]; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/users": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Lists users from the target organization and all its descendants. * @description Returns users from the target organization AND all organizations below it in the hierarchy. * When X-Organization-ID header is provided, uses that org as target (if visible to caller). * When no header is provided, defaults to the caller's own organization. * Supports optional filtering by organization type, user status, reporting manager, and pagination. * Requires the user:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `user:read:org` */ get: operations["GetUsers"]; put?: never; /** * Creates a new user in the specified organization. * @description Creates an ACTIVE or INVITED user in any organization accessible to the caller. * Requires the user:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `user:write:all` */ post: operations["CreateUser"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/users/me": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Gets the currently authenticated user's profile. * @description Resolves the caller from their JWT claims (user id, organization id, client id) and returns * their profile. */ get: operations["GetMe"]; put?: never; post?: never; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/users/{id}": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** * Gets a single user from a downstream organization in the hierarchy. * @description Returns the user only if they belong to an organization below the caller in the hierarchy. * Requires the user:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `user:read:org` */ get: operations["GetUser"]; put?: never; post?: never; delete?: never; options?: never; head?: never; /** * Updates profile fields for a user in a downstream organization. * @description Requires user_profile:write:self (own org) or user_profile:write:all (cross-org). * A caller cannot update their own profile. * * **Token types:** APP, USER */ patch: operations["UpdateUser"]; trace?: never; }; "/identity/v1/users/{userId}/disable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Disables a user by setting their status to INACTIVE. * @description The target user must be visible in the caller's organization hierarchy. * Requires user:write:org scope. * * **Token types:** APP, USER | **Required scopes:** `user:write:org` */ post: operations["DisableUser"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; "/identity/v1/users/{userId}/enable": { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; get?: never; put?: never; /** * Enables a user by setting their status to ACTIVE. * @description The target user must be visible in the caller's organization hierarchy. * Requires user:write:org scope. * * **Token types:** APP, USER | **Required scopes:** `user:write:org` */ post: operations["EnableUser"]; delete?: never; options?: never; head?: never; patch?: never; trace?: never; }; } type webhooks = Record; interface components { schemas: { /** @enum {string} */ APIVersion: "2025-06-23" | "2024-05-25" | "2024-01-31" | "2023-09-01" | "2023-06-04" | "2023-04-12" | "2023-03-14" | "2023-03-01" | "2023-02-07" | "2022-11-16"; /** @description Request model for accepting bank disclosures with an invitation token. */ AcceptDisclosuresWithTokenRequest: { /** @description The invitation token for accepting disclosures. */ invitationToken: string; /** * Format: uuid * @description The user ID accepting the disclosures. */ userId: string; }; /** @description Fields for the account to which the receivable has to be paid */ AccountDataBlock: { account_holder_name?: string; /** @default Account holder */ account_holder_name_header: string; account_number?: string; /** @default Account number */ account_number_header: string; bank_name?: string; /** @default Bank */ bank_name_header: string; bic?: string; /** @default BIC */ bic_header: string; header?: string; iban?: string; /** @default IBAN */ iban_header: string; payment_hyperlink?: string; routing_number?: string; /** @default Routing number */ routing_number_header: string; sort_code?: string; /** @default Sort code */ sort_code_header: string; }; /** @enum {string} */ AccountDisabledReason: "requirements.past_due" | "requirements.pending_verification" | "listed" | "platform_paused" | "rejected.fraud" | "rejected.listed" | "rejected.terms_of_service" | "rejected.other" | "under_review" | "other"; AccountIdentification: { type: components["schemas"]["PaymentIntentAccountType"]; value: string; }; AccountingConnectionList: { data: components["schemas"]["AccountingConnectionResponse"][]; }; AccountingConnectionResponse: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; business_info?: components["schemas"]["BusinessInfoSchema"]; connection_url: string; errors?: components["schemas"]["ErrorSchema"][]; /** Format: date-time */ last_pull?: string; platform?: string; status?: components["schemas"]["ConnectionStatus"]; }; /** @description Schema for creating a new cost center. */ AccountingCostCenterCreateRequest: { /** @description Description of the cost center */ description?: string; /** @description Name of the cost center */ name?: string; }; AccountingCostCenterListResponse: { data: components["schemas"]["AccountingCostCenterResponse"][]; next_pagination_token?: string; prev_pagination_token?: string; }; /** @description Represents a cost center retrieved from an accounting system. */ AccountingCostCenterResponse: { /** Format: uuid */ id: string; /** * Format: date-time * @description The timestamp when the cost center was created. */ created_at: string; /** * Format: date-time * @description The timestamp when the cost center was last updated. */ updated_at: string; /** @description Description of the cost center */ description?: string; /** * @description Whether the cost center is from an external system * @default false */ is_external: boolean; name?: string; }; /** @description Schema for updating an existing cost center. */ AccountingCostCenterUpdateRequest: { /** @description Description of the cost center */ description?: string; /** @description Name of the cost center */ name?: string; }; AccountingCustomerRefObject: { /** * @description A unique identifier of the customer in the accounting system. * @example 120 */ id: string; /** * @description Customer name in the accounting system. * @example Acme Inc. */ company_name?: string; }; /** @description Contains the details of an invoice line item retrieved from an accounting system. */ AccountingLineItem: { /** * @description The name or description of the product or service being invoiced. * @example Logo design */ description?: string; /** @description Discount amount for this line item (if any). */ discount_amount?: number; /** @description Discount percentage for this line item (if any). */ discount_percentage?: number; /** @description ID of the ledger account associated with this line item. You can use `GET /ledger_accounts/{ledger_account_id}` to get further details about this ledger account. */ ledger_account_id?: string; /** @description The quantity of the product or service. */ quantity?: number; /** @description An internal reference to the tax rate in the accounting system that the line item is linked to. */ tax_rate_ref?: components["schemas"]["AccountingRefObject"]; /** @description The cost per unit of the product or service. */ unit_amount?: number; }; AccountingMessageResponse: { message: string; }; /** @description Details of an accounts payable invoice (bill) retrieved from an accounting system. */ AccountingPayable: { /** @description An internal identifier of the payable in the accounting system. */ id: string; /** @description Remaining amount to be paid. */ amount_due?: number; /** * @description ISO-4217 currency code of the payable. * @example USD */ currency?: string; /** @description Rate to convert the total amount of the transaction into the entity's base currency at the time of the transaction. */ currency_rate?: number; /** @description The payable's due date. */ due_date?: string; /** @description Invoice number of the payable. */ invoice_number?: string; lines?: components["schemas"]["AccountingLineItem"][]; /** @description Any additional information or business notes about the payable. */ memo?: string; /** * Format: date * @description Date when the payable was added to the accounting service. This may differ from the payable creation date. */ posted_date?: string; /** @description A list of purchase orders linked to the payable, if any. */ purchase_order_refs?: components["schemas"]["AccountingPurchaseOrderRef"][]; /** * @description The status of the payable in the accounting system. Possible values: `open`, `draft`, `partially_paid`, `paid`, `unknown`, `void`. * @example paid */ status: string; /** @description Amount payable, including discounts but excluding VAT/taxes. */ subtotal?: number; /** @description Total VAT or tax amount. */ tax_amount?: number; /** @description The total amount payable, including discounts and VAT/taxes. */ total_amount: number; /** @description Information about the vendor from whom the payable was received. */ vendor_ref?: components["schemas"]["AccountingVendorRefObject"]; }; AccountingPayableList: { data: components["schemas"]["AccountingPayable"][]; }; AccountingPurchaseOrderRef: { /** * @description An internal ID of the purchase order in the accounting system. * @example 10 */ id: string; /** * @description Reference number of the purchase order. * @example PO-1234 */ name?: string; }; /** @description Invoice details retrieved from an accounting system. */ AccountingReceivable: { /** @description An internal identifier of the invoice in the accounting system. */ id?: string; /** * @description ISO-4217 currency code of the invoice. * @example USD */ currency?: string; /** @description Rate to convert the total amount of the transaction into the entity's base currency at the time of the transaction. */ currency_rate?: number; /** @description Information about the customer that the invoice was sent to. */ customer_ref?: components["schemas"]["AccountingCustomerRefObject"]; /** @description Invoice due date. */ due_date?: string; /** @description Invoice document number. */ invoice_number?: string; lines?: components["schemas"]["AccountingLineItem"][]; /** @description Any additional information or business notes about the invoice. */ memo?: string; /** @description An object containing additional invoice data returned by the accounting system. This sometimes includes custom invoice fields. */ pass_through?: Record; /** * Format: date * @description Date when the invoice was added to the accounting service. This may differ from the invoice creation date. */ posted_date?: string; }; AccountingReceivableList: { data: components["schemas"]["AccountingReceivable"][]; }; AccountingRefObject: { /** @description An internal ID of the tax rate in the accounting system. */ id?: string; }; AccountingSettings: { /** @description Default ledger accounts that will be used for various objects pushed into an accounting system. Use `GET /ledger_accounts` to get the IDs of these ledger accounts. */ ledger_account_ids?: components["schemas"]["DefaultLedgerAccountIDs"] | null; /** @description Default accounting tax IDs that will be used for various objects pushed into an accounting system. Use `GET /accounting_tax_rates` to get the IDs of these taxes. */ tax_ids?: components["schemas"]["DefaultAccountingTaxIDs"] | null; }; /** @description Schema for creating a new tax rate. */ AccountingTaxRateCreateRequest: { /** @description Code for the tax rate from the accounting platform */ code?: string; /** @description Description of the tax rate */ description?: string; /** @description Effective tax rate in percent [minor units](https://docs.monite.com/references/currencies#minor-units). Example: 12.5% is 1250. */ effective_tax_rate?: number; /** @description Name of the tax rate */ name?: string; }; AccountingTaxRateListResponse: { data: components["schemas"]["AccountingTaxRateResponse"][]; next_pagination_token?: string; prev_pagination_token?: string; }; AccountingTaxRateResponse: { /** Format: uuid */ id: string; /** * Format: date-time * @description The timestamp when the tax rate was created. */ created_at: string; /** * Format: date-time * @description The timestamp when the tax rate was last updated. */ updated_at: string; /** @description Code for the tax rate from the accounting platform. */ code?: string; components?: components["schemas"]["TaxComponentResponse"][]; /** @description Description of the tax rate */ description?: string; /** @description Effective tax rate in percent [minor units](https://docs.monite.com/references/currencies#minor-units). Example: 12.5% is 1250. */ effective_tax_rate?: number; /** * @description Whether the tax rate is from an external system * @default false */ is_external: boolean; name?: string; status?: string; /** @description Total (not compounded) sum of the components of a tax rate in [minor units](https://docs.monite.com/references/currencies#minor-units). Example: 12.5% is 1250. */ total_tax_rate?: number; }; /** @description Schema for updating an existing tax rate. */ AccountingTaxRateUpdateRequest: { /** @description Code for the tax rate from the accounting platform */ code?: string; /** @description Description of the tax rate */ description?: string; /** @description Effective tax rate in percent [minor units](https://docs.monite.com/references/currencies#minor-units). Example: 12.5% is 1250. */ effective_tax_rate?: number; /** @description Name of the tax rate */ name?: string; }; AccountingVendorRefObject: { /** * @description A unique identifier of the vendor in the accounting system. * @example 120 */ id: string; /** * @description Vendor name in the accounting system. * @example Acme Inc. */ name?: string; }; /** @description Request model for initiating an ACH money movement. */ AchMoneyMovementRequest: { /** * Format: int64 * @description Amount to transfer. Must be greater than 0. */ amount: number | string; /** * @description ISO 4217 alphabetic currency code (e.g. `USD`). Defaults to `USD` when omitted. * Determines the minor unit precision of long AchMoneyMovementRequest.Amount. * @default USD */ currencyCode: string; /** * Format: uuid * @description Source bank account identifier. */ fromBankAccountId: string; /** * @description Optional idempotency key for preventing duplicate transfers. * Maximum length: 256 characters. */ idempotencyKey?: null | string; /** * @description SEC code for the ACH transaction. * Valid values: PPD (consumer), CCD (business), WEB (internet), CTX (corporate trade exchange), IAT (international). */ secCode: string; /** * Format: uuid * @description Destination bank account identifier. */ toBankAccountId: string; /** @description Type of ACH money movement. */ type: components["schemas"]["TransferType"]; }; /** @enum {string} */ ActionEnum: "create" | "read" | "update" | "delete"; ActionSchema: { /** * @description Action name * @default read */ action_name: components["schemas"]["ActionEnum"]; /** * @description Permission type * @default allowed */ permission: components["schemas"]["PermissionEnum"]; }; AddCustomTemplateSchema: { /** @description Jinja2 compatible string with email body */ body_template: string; /** * @description Is default template * @default false */ is_default: boolean; /** * @description Lowercase ISO code of language * @default en */ language: components["schemas"]["LanguageCodeEnum"]; /** @description Custom template name */ name: string; /** @description Jinja2 compatible string with email subject */ subject_template: string; /** @description Document type of content */ type: components["schemas"]["DocumentObjectTypeRequestEnum"]; }; /** @description Domain model for address information. */ Address: { address1?: null | string; address2?: null | string; address3?: null | string; city?: null | string; countryCode?: null | components["schemas"]["CountryCode"]; postalCode?: null | string; state?: null | string; }; AddressData: { /** * @description City name. * @example New York */ city?: string; /** * @description Country in text not Two-letter ISO country code form. * @example United States */ country?: string; /** * @description Street address. * @example 456 Fifth Avenue */ line1?: string; /** @description Additional address information (if any). */ line2?: string; /** * @description ZIP or postal code. * @example 10001 */ postal_code?: string; /** @description State, region, province, or county. */ state?: string; }; AddressDto: { address1?: null | string; address2?: null | string; city?: null | string; country?: null | string; postalCode?: null | string; stateOrProvince?: null | string; }; /** * @description Input model for address information. Every field uses `Optional<T?>` so the * server can distinguish absent / explicit-null / explicit-value on a partial update. */ AddressInput: { address1?: components["schemas"]["OptionalOfstring"]; address2?: components["schemas"]["OptionalOfstring"]; address3?: components["schemas"]["OptionalOfstring"]; city?: components["schemas"]["OptionalOfstring"]; countryCode?: components["schemas"]["OptionalOfCountryCode"]; postalCode?: components["schemas"]["OptionalOfstring"]; state?: components["schemas"]["OptionalOfstring"]; }; /** @description Output model for address information in responses. */ AddressOutput: { /** @description The first line of the address. */ address1?: null | string; /** @description The second line of the address, if applicable. */ address2?: null | string; /** @description The third line of the address, if applicable. */ address3?: null | string; /** @description City, town, or village. */ city?: null | string; countryCode?: null | components["schemas"]["CountryCode"]; /** @description Postal or ZIP code. */ postalCode?: null | string; /** @description State or province. */ state?: null | string; }; /** * @description Summary response for the Admin Portal endpoint. * Contains aggregated counts for applications, bank accounts, and external bank accounts. */ AdminPortalSummaryResponse: { /** @description Summary of bank account applications by status. */ applications: components["schemas"]["BankAccountApplicationSummary"]; /** @description Summary of bank accounts by status. */ bankAccounts: components["schemas"]["BankAccountSummary"]; /** @description Summary of external bank accounts by verification status. */ externalBankAccounts: components["schemas"]["ExternalBankAccountSummary"]; /** @description Per-organization details including name, account count, and user count. */ organizations: components["schemas"]["OrganizationSummary"][]; }; /** @enum {string} */ AggregationFunctionEnum: "count" | "average" | "summary" | "min" | "max"; AirwallexData: { payment_intent_id: string; secret: string; }; AllDocumentExportResponseSchema: { /** @description A set of export objects returned per page. */ data: components["schemas"]["DocumentExportResponseSchema"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results. If there is no next page, i.e. you have reached the last page, the value is `null`. */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results. If there is no previous page, i.e. you have reached the first page, the value is `null`. */ prev_pagination_token?: string; }; AllOverdueRemindersResponse: { data: components["schemas"]["OverdueReminderResponse"][]; }; /** @enum {string} */ AllowedCountries: "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BA" | "BW" | "BV" | "BR" | "IO" | "BN" | "BG" | "BF" | "BI" | "KH" | "CM" | "CA" | "IC" | "CV" | "KY" | "CF" | "EA" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "CI" | "HR" | "CU" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "SZ" | "ET" | "FK" | "FO" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "HM" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KP" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "FM" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "AN" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "MP" | "MK" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "SH" | "KN" | "LC" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SK" | "SI" | "SB" | "SO" | "ZA" | "SS" | "GS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "US" | "UM" | "UY" | "UZ" | "VU" | "VE" | "VN" | "VG" | "VI" | "WF" | "EH" | "YE" | "ZM" | "ZW" | "BL" | "BQ" | "CW" | "MF" | "SX"; /** @enum {string} */ AllowedFileTypes: "ocr_results" | "ocr_files" | "payables" | "receivables" | "delivery_notes" | "receipts" | "userpics" | "entity_logo" | "companies_logo" | "zip" | "identity_documents" | "additional_identity_documents" | "receivable_signatures" | "einvoices_xml" | "attachments"; /** @description Output model representing a monetary amount in minor units alongside its ISO 4217 currency. */ AmountOutput: { /** @description The ISO 4217 three-letter currency code (e.g. `"USD"`). */ currencyCode: string; /** * Format: int64 * @description The monetary value in the currency's minor units (e.g. cents for USD). * For example, USD $12.34 is represented as `1234`. */ value: number | string; }; AmountPredicate: components["schemas"]["SingleAmountPredicate"] | components["schemas"]["MultipleAmountPredicate"]; AnalyticsDataPoint: { dimension_value?: string; metric_value: number; }; ApplicationListResponseDto: { /** Format: uuid */ applicationId: string; childOrganizationTypeCounts?: { [key: string]: number | string; }; clientId: string; displayName: string; isEnabled: boolean; /** Format: uuid */ organizationId?: null | string; scopes: string[]; }; /** @enum {string} */ ApplicationOwnership: "STARTED_BY_YOU" | "STARTED_BY_OTHER"; /** @enum {string} */ ApplicationProduct: "BANK_ACCOUNT" | "CREDIT_CARD"; ApplicationScopesResponseDto: { /** Format: uuid */ applicationId: string; clientId: string; displayName: string; isEnabled: boolean; /** Format: uuid */ organizationId?: null | string; scopes: string[]; }; ApplicationStatusEntry: { /** Format: uuid */ applicationId?: null | string; ownership: components["schemas"]["ApplicationOwnership"]; product: components["schemas"]["ApplicationProduct"]; status: string; }; ApplicationStatusResponse: { applications: components["schemas"]["ApplicationStatusEntry"][]; }; ApplicationStatusResponseDto: { /** Format: uuid */ applicationId: string; clientId: string; displayName: string; isEnabled: boolean; /** Format: uuid */ organizationId?: null | string; scopes: string[]; }; ApprovalActionCreatedResponse: { /** @description Creation status. Always 'created'. */ status: string; }; ApprovalActionEventData: { /** @description ISO timestamp of when the action was performed. */ acted_at?: string; /** @description The approval action: 'approved' or 'rejected'. */ action: string; approval_policy_id?: string; approval_policy_name?: string; approval_policy_process_id?: string; approval_request_id?: string; /** @description 'policy' for policy-based actions. */ approval_source?: string; /** @description Reason for rejection, if applicable. */ reject_reason?: string; }; ApprovalActionRequest: { /** * Format: date-time * @description Timestamp when this specific action was performed. */ acted_at: string; /** @description The approval action performed: 'approved' or 'rejected'. */ action: string; /** * Format: uuid * @description Approval policy ID. */ approval_policy_id?: string; /** @description Approval policy name. */ approval_policy_name?: string; /** * Format: uuid * @description Approval policy process ID. */ approval_policy_process_id?: string; /** * Format: uuid * @description Approval request ID from approval-requests. */ approval_request_id?: string; /** * @description Source of the action. Typically 'policy'. * @default policy */ approval_source: string; /** * Format: uuid * @description The user who performed the action. */ entity_user_id?: string; /** @description Reason for rejection, if applicable. */ reject_reason?: string; }; ApprovalPolicyCreate: { /** @description A brief description of the approval policy. */ description?: string; /** * Format: date-time * @description The date and time (in the ISO 8601 format) when the approval policy stops being active and stops triggering approval workflows.If `ends_at` is provided in the request, then `starts_at` must also be provided and `ends_at` must be later than `starts_at`. The value will be converted to UTC. */ ends_at?: string; /** @description The name of the approval policy. */ name: string; /** @description The type of object this approval policy applies to. */ object_type: components["schemas"]["ObjectType"]; /** * @description The priority controls which approval policy takes precedence when a payable matches multiple approval policies. A higher value mean higher priority. * @default 0 */ priority: number; /** @description A list of JSON objects that represents the approval policy script. The script contains the logic that determines whether an action should be sent to approval. This field is required, and it should contain at least one script object. */ script: (boolean | number | string | unknown[] | Record)[]; /** * Format: date-time * @description The date and time (in the ISO 8601 format) when the approval policy becomes active. Only payables submitted for approval during the policy's active period will trigger this policy. If omitted or `null`, the policy is effective immediately. The value will be converted to UTC. */ starts_at?: string; /** * @description A JSON object that represents the trigger for the approval policy. The trigger specifies the event that will trigger the policy to be evaluated. * @example {amount >= 1000} */ trigger?: boolean | number | string | unknown[] | Record; }; /** @enum {string} */ ApprovalPolicyCursorFields: "created_at" | "updated_at"; ApprovalPolicyResource: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; /** Format: uuid */ created_by: string; /** @description A brief description of the approval policy. */ description?: string; /** * Format: date-time * @description The date and time (in the ISO 8601 format) when the approval policy stops being active and stops triggering approval workflows.If `ends_at` is provided in the request, then `starts_at` must also be provided and `ends_at` must be later than `starts_at`. The value will be converted to UTC. */ ends_at?: string; /** @description The name of the approval policy. */ name: string; /** @description The type of object this approval policy applies to. */ object_type: components["schemas"]["ObjectType"]; /** * @description The priority controls which approval policy takes precedence when a payable matches multiple approval policies. A higher value mean higher priority. * @default 0 */ priority: number; /** @description A list of JSON objects that represents the approval policy script. The script contains the logic that determines whether an action should be sent to approval. This field is required, and it should contain at least one script object. */ script: (boolean | number | string | unknown[] | Record)[]; /** * Format: date-time * @description The date and time (in the ISO 8601 format) when the approval policy becomes active. Only payables submitted for approval during the policy's active period will trigger this policy. If omitted or `null`, the policy is effective immediately. The value will be converted to UTC. */ starts_at?: string; /** * @description The current status of the approval policy. * @example active * @enum {string} */ status: "active" | "pending"; /** * @description A JSON object that represents the trigger for the approval policy. The trigger specifies the event that will trigger the policy to be evaluated. * @example {amount >= 1000} */ trigger?: boolean | number | string | unknown[] | Record; /** Format: uuid */ updated_by?: string; }; ApprovalPolicyResourceList: { data: components["schemas"]["ApprovalPolicyResource"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; /** @enum {string} */ ApprovalPolicyStatus: "active" | "deleted" | "pending"; ApprovalPolicyUpdate: { /** @description A brief description of the approval policy. */ description?: string; /** * Format: date-time * @description The date and time (in the ISO 8601 format) when the approval policy stops being active and stops triggering approval workflows.If `ends_at` is provided in the request, then `starts_at` must also be provided and `ends_at` must be later than `starts_at`. The value will be converted to UTC. */ ends_at?: string; /** @description The name of the approval policy. */ name?: string; /** @description The priority controls which approval policy takes precedence when a payable matches multiple approval policies. A higher value mean higher priority. */ priority?: number; /** @description A list of JSON objects that represents the approval policy script. The script contains the logic that determines whether an action should be sent to approval. This field is required, and it should contain at least one script object. */ script?: (boolean | number | string | unknown[] | Record)[]; /** * Format: date-time * @description The date and time (in the ISO 8601 format) when the approval policy becomes active. Only payables submitted for approval during the policy's active period will trigger this policy. If omitted or `null`, the policy is effective immediately. The value will be converted to UTC. */ starts_at?: string; /** @description A string that represents the current status of the approval policy. */ status?: components["schemas"]["ApprovalPolicyStatus"]; /** * @description A JSON object that represents the trigger for the approval policy. The trigger specifies the event that will trigger the policy to be evaluated. * @example {amount >= 1000} */ trigger?: boolean | number | string | unknown[] | Record; }; ApprovalProcessResourceList: { data: components["schemas"]["ProcessResource"][]; }; ApprovalProcessStepResource: { /** Format: uuid */ approval_request_id?: string; approval_type?: components["schemas"]["ApprovalTypeEnum"]; approved_by: string[]; /** Format: uuid */ object_id: string; reject_reason?: string; /** Format: uuid */ rejected_by?: string; required_approval_count: number; role_ids?: string[]; status: components["schemas"]["ApprovalProcessStepStatus"]; /** Format: uuid */ submitted_by?: string; user_ids: string[]; }; ApprovalProcessStepResourceList: { data: components["schemas"]["ApprovalProcessStepResource"][]; }; /** @enum {string} */ ApprovalProcessStepStatus: "waiting" | "approved" | "rejected" | "canceled" | "failed" | "not_started" | "skipped"; ApprovalRequestCreateByReportingManagerRequest: { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ approval_type: "reporting_manager"; /** Format: uuid */ object_id: string; object_type: components["schemas"]["ObjectType"]; required_approval_count: number; /** Format: uuid */ submitted_by: string; }; ApprovalRequestCreateByRoleRequest: { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ approval_type: "role"; /** Format: uuid */ object_id: string; object_type: components["schemas"]["ObjectType"]; required_approval_count: number; role_ids: string[]; }; ApprovalRequestCreateByUserRequest: { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ approval_type: "user_ids"; /** Format: uuid */ object_id: string; object_type: components["schemas"]["ObjectType"]; required_approval_count: number; user_ids: string[]; }; ApprovalRequestCreateRequest: components["schemas"]["ApprovalRequestCreateByUserRequest"] | components["schemas"]["ApprovalRequestCreateByRoleRequest"] | components["schemas"]["ApprovalRequestCreateByReportingManagerRequest"]; /** @enum {string} */ ApprovalRequestCursorFields: "created_at" | "updated_at"; ApprovalRequestRejectRequest: { /** @description Optional reason explaining why the approval request was rejected. */ reject_reason?: string; }; ApprovalRequestResourceList: { data: components["schemas"]["ApprovalRequestResourceWithMetadata"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; ApprovalRequestResourceWithMetadata: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; approval_type: components["schemas"]["ApprovalTypeEnum"]; approved_by: string[]; /** * Format: uuid * @description ID of the user who created the approval request, or None if it was created by the system (e.g. by an approval policy worker). * @example ea837e28-509b-4b6a-a600-d54b6aa0b1f5 */ created_by?: string; /** Format: uuid */ object_id: string; object_type: components["schemas"]["ObjectType"]; reject_reason?: string; /** Format: uuid */ rejected_by?: string; required_approval_count: number; role_ids?: string[]; status: components["schemas"]["ApprovalRequestStatus"]; /** Format: uuid */ submitted_by?: string; user_ids: string[]; }; /** @enum {string} */ ApprovalRequestStatus: "waiting" | "approved" | "rejected" | "canceled"; /** @enum {string} */ ApprovalTypeEnum: "user_ids" | "role" | "reporting_manager"; AttachmentRequest: { /** * Format: uuid * @description Unique ID of the file with file_type=attachment from /v1/files. */ id: string; /** * @description Indicates whether the file would be included in the email. * @default false */ include_in_email: boolean; }; AttachmentResponse: { /** * Format: uuid * @description Unique ID of the file with file_type=attachment from /v1/files. */ id: string; /** * @description Indicates whether the file would be included in the email. * @default false */ include_in_email: boolean; /** @description MIME type of the file (e.g., 'application/pdf'). */ mimetype: string; /** @description Original filename of the attachment. */ name: string; /** @description File size in bytes. */ size: number; /** @description URL to access the attachment file. */ url: string; }; AuthPaymentIntentPayload: components["schemas"]["ManuallySpecifiedBankAccountPayload"] | components["schemas"]["AuthorizedBankAccountPayload"] | components["schemas"]["BankAccountPayload"]; AuthPaymentIntentResponse: { /** Format: uri */ authorization_url: string; }; /** @description Input model for authentication details. */ AuthenticationInput: { /** @description Password for the account. */ password?: null | string; }; AuthorizedBankAccount: { /** Format: uuid */ id: string; /** @description Masked account number, e.g. ****1234 */ account_number?: string; /** * Format: uuid * @description ID of the entity or counterpart bank account */ bank_account_id?: string; bank_id: string; country: components["schemas"]["AllowedCountries"]; /** @description Masked IBAN number, e.g. ****1234 */ iban?: string; name?: string; }; AuthorizedBankAccountPayload: { /** Format: uuid */ authorized_bank_account_id: string; /** @default false */ iframe: boolean; /** @description PSU identification is required for some banks (e.g. some Germany institutions). */ psu_identification?: components["schemas"]["PsuIdentification"]; /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "authorized_bank_account"; }; /** * @description Automation level for recurrence * @enum {string} */ AutomationLevel: "draft" | "issue" | "issue_and_send"; Bank: { authorization_methods: components["schemas"]["SupportedPaymentAuthorizationFlow"][]; bank_id: string; country: components["schemas"]["AllowedCountries"]; media: components["schemas"]["Media"][]; name: string; payer_required: boolean; psu_identification?: components["schemas"]["PsuIdentificationType"]; }; BankAccount: { /** * Format: uuid * @description The ID of the bank account. */ id: string; /** * @description The name of the person or business that owns this bank account. * @example Bob Jones */ account_holder_name?: string; /** * @description The bank account number. Typically used for UK and US bank accounts. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. * @example 12345678 */ account_number?: string; /** * @description The BIC/SWIFT code of the bank. * @example CHASUS33XXX */ bic?: string; /** * @description The country in which the bank account is registered, repsesented as a two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). * @example US */ country?: components["schemas"]["AllowedCountries"]; /** * @description The currency of the bank account, represented as a three-letter ISO [currency code](https://docs.monite.com/references/currencies). * @example USD */ currency?: components["schemas"]["CurrencyEnum"]; /** * @description User-defined name of this bank account, such as 'Primary account' or 'Savings account'. Used only for entity bank accounts. * @example Primary account */ display_name?: string; /** * @description The IBAN of the bank account. * @example GB29NWBK60161331926819 */ iban?: string; /** * @description Indicates whether this bank account is the default one for its currency. * @default false */ is_default: boolean; /** * @description User-defined name of this bank account, such as 'Primary account' or 'Savings account'. Used only for counterpart bank accounts. * @example Primary account */ name?: string; /** @description The bank's routing transit number (RTN). Typically used for US banks. US routing numbers consist of 9 digits. */ routing_number?: string; /** * @description The bank's sort code. Typically used for UK banks. * @example 123456 */ sort_code?: string; /** * Format: uuid * @description ID of the entity user who added this bank account, or `null` if it was added using a partner access token. Used only for entity bank accounts. */ was_created_by_user_id?: string; }; /** * @description The type of access operation to perform. * @enum {string} */ BankAccountAccessActionType: "GRANT" | "REVOKE"; /** * @description Input model for bank account applicant information. Every field uses `Optional<T?>` * so the server can distinguish absent / explicit-null / explicit-value on a partial update. */ BankAccountApplicantInput: { authentication?: components["schemas"]["OptionalOfAuthenticationInput"]; birthDate?: components["schemas"]["OptionalOfDateOnly"]; firstName?: components["schemas"]["OptionalOfstring"]; hasAcceptedDisclosures?: components["schemas"]["OptionalOfboolean"]; homeAddress?: components["schemas"]["OptionalOfAddressInput"]; isLegallyAuthorized?: components["schemas"]["OptionalOfboolean"]; lastName?: components["schemas"]["OptionalOfstring"]; mobilePhoneNumber?: components["schemas"]["OptionalOfstring"]; ownershipPercentage?: components["schemas"]["OptionalOfdecimal"]; personalIdentificationNumber?: components["schemas"]["OptionalOfPersonalIdentificationNumberDto"]; workEmailAddress?: components["schemas"]["OptionalOfstring"]; }; /** @description Output model for applicant information in responses. */ BankAccountApplicantOutput: { /** * Format: date * @description Date of birth of the applicant. */ birthDate?: null | string; /** * Format: date-time * @description Timestamp when disclosures were accepted. */ disclosuresAcceptedAtDateTime?: null | string; /** @description First name of the applicant. */ firstName?: null | string; /** @description Indicates whether disclosures have been accepted. */ hasAcceptedDisclosures?: null | boolean; homeAddress?: null | components["schemas"]["AddressOutput"]; /** @description Indicates whether the applicant is legally authorized. */ isLegallyAuthorized?: null | boolean; /** @description Last name of the applicant. */ lastName?: null | string; /** @description Mobile phone number of the applicant. */ mobilePhoneNumber?: null | string; /** * Format: double * @description Ownership percentage as a decimal between 0 and 1 (e.g., 25% = 0.25). */ ownershipPercentage?: null | number | string; /** @description Work email address of the applicant. */ workEmailAddress?: null | string; }; /** @description Response model for a bank account application. */ BankAccountApplicationResponse: { /** * Format: uuid * @description Unique identifier for the bank account application. */ id: string; applicant?: null | components["schemas"]["BankAccountApplicantOutput"]; businessDetails?: null | components["schemas"]["BusinessDetailsOutput"]; /** @description List of business owners associated with the application. */ businessOwners?: null | components["schemas"]["BusinessOwnerOutput"][]; /** * Format: uuid * @description Identifier of the organization the application has been onboarded under. * Null until the application has been verified and the organization created. */ organizationId?: null | string; /** @description Current status of the bank account application. */ status?: components["schemas"]["BankAccountApplicationStatusDto"]; /** * Format: uuid * @description Identifier of the user created for the applicant during onboarding. * Null until the application has been verified and the user created. */ userId?: null | string; }; /** * @description Status of a bank account application. * @enum {string} */ BankAccountApplicationStatusDto: "DRAFT" | "SUBMITTED" | "COMPLETE"; /** @description Summary of bank account applications by status. */ BankAccountApplicationSummary: { /** * Format: int32 * @description Number of complete applications. */ complete?: number | string; /** * Format: int32 * @description Number of draft applications (not yet submitted). */ draft?: number | string; /** * Format: int32 * @description Number of submitted applications (under review). */ submitted?: number | string; /** * Format: int32 * @description Total number of applications. */ total?: number | string; }; /** * @description Summary view of a bank account application, returned by the list endpoint so partners can * observe applications without exposing applicant or business owner detail. */ BankAccountApplicationSummaryResponse: { /** * Format: uuid * @description Unique identifier for the bank account application. */ id: string; /** @description Legal name of the business applying for the bank account, when provided. */ businessName?: null | string; /** * Format: date-time * @description When the application was created (UTC). */ createdAt: string; /** * @description Whether the applicant's work email address has been verified. Null until verification * has been attempted. */ emailVerified?: null | boolean; kycVerificationStatus?: null | components["schemas"]["KycVerificationStatusDto"]; /** @description Overall status of the bank account application. */ status: components["schemas"]["BankAccountApplicationStatusDto"]; /** * Format: date-time * @description When the application was last updated (UTC). */ updatedAt: string; }; /** @description Bank account information for a money movement. */ BankAccountInfo: { /** * Format: uuid * @description Bank account identifier. */ id: string; /** @description Optional bank account nickname. */ nickname?: null | string; }; BankAccountPayload: { /** Format: uuid */ bank_account_id: string; bank_id: string; /** @default false */ iframe: boolean; /** @description PSU identification is required for some banks (e.g. some Germany institutions). */ psu_identification?: components["schemas"]["PsuIdentification"]; /** @default false */ save_to_authorized: boolean; /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "bank_account"; }; BankAccountPaymentMethod: { details: components["schemas"]["BankAccountPaymentMethodDetails"]; /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "bank_account"; }; BankAccountPaymentMethodDetails: { /** * @description The name of the person or business that owns this bank account. * @example Bob Jones */ account_holder_name?: string; /** * @description The bank account number. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. * @example 12345678 */ account_number?: string; /** * @description The SWIFT/BIC code of the bank. Can be either 8 or 11 characters long. * @example CHASUS33XXX */ bic?: string; /** @description ISO currency code of the bank account. */ currency?: components["schemas"]["CurrencyEnum"]; /** * @description The IBAN of the bank account, up to 34 characters. * @example GB29NWBK60161331926819 */ iban?: string; /** @description The name of the bank account, if available. For example, "Primary account" or "Savings account". */ name?: string; /** @description The bank's routing transit number (RTN). US routing numbers consist of 9 digits. */ routing_number?: string; /** * @description The bank's sort code. * @example 123456 */ sort_code?: string; }; /** @description Response model for a bank account. */ BankAccountResponse: { /** * Format: uuid * @description Unique identifier for the bank account. */ id: string; /** @description Masked account number. */ accountNumber: string; /** @description Reference identifier associated with the bank account. */ bankAccountReference?: null | string; /** * Format: date-time * @description The UTC timestamp when the bank account was created. */ createdDateTime: string; /** @description Nickname for the bank account. */ nickname?: null | string; /** @description Bank routing number. */ routingNumber: string; /** @description The status of the bank account. */ status: components["schemas"]["BankAccountStatus"]; }; BankAccountSnapshot: { account_holder_name?: string; account_number?: string; bank_name?: string; routing_number?: string; }; /** * @description Indicates where a bank account is held. * @enum {string} */ BankAccountSourceDto: "INTERNAL" | "EXTERNAL"; /** * @description The status of a bank account. * @enum {string} */ BankAccountStatus: "ACTIVE" | "CLOSED"; /** @description Summary of bank accounts. */ BankAccountSummary: { /** * Format: int32 * @description Total number of bank accounts. */ total?: number | string; }; /** * @description Direction of a bank account transaction. * @enum {string} */ BankAccountTransactionDirectionDto: "CREDIT" | "DEBIT"; /** @description Response model for a bank account transaction. */ BankAccountTransactionResponse: { /** @description Amount of the transaction in minor units (e.g. cents for USD). */ amount: components["schemas"]["AmountOutput"]; /** * Format: date * @description Date the transaction occurred. */ date: string; /** @description Description of the transaction. */ description: string; /** @description Direction of the transaction (credit or debit). */ direction: components["schemas"]["BankAccountTransactionDirectionDto"]; /** @description Running balance after this transaction in minor units (e.g. cents for USD). */ runningBalance: components["schemas"]["AmountOutput"]; }; /** @description Output model for a bank account transfer account. */ BankAccountTransferAccountOutput: { /** * Format: uuid * @description Unique identifier for the account. */ id: string; /** @description Nickname for the account. */ nickname?: null | string; }; /** * @description Type of payment network used for bank account transfers. * @enum {string} */ BankAccountTransferNetworkTypeDto: "BOOK" | "ACH" | "RTP" | "FED_NOW"; /** @description Response model for a bank account transfer. */ BankAccountTransferResponse: { /** * Format: uuid * @description Unique identifier for the transfer. */ id: string; /** @description The amount transferred. */ amount: components["schemas"]["AmountOutput"]; /** * Format: date * @description The date of the transfer. */ date: string; /** @description The account the transfer is from. */ fromAccount: components["schemas"]["BankAccountTransferAccountOutput"]; /** @description The payment network the transfer was routed on. */ network: components["schemas"]["BankAccountTransferNetworkTypeDto"]; /** @description The status of the transfer. */ status: components["schemas"]["BankAccountTransferStatusDto"]; /** @description The account the transfer is to. */ toAccount: components["schemas"]["BankAccountTransferAccountOutput"]; /** @description The type of transfer. */ type: components["schemas"]["BankAccountTransferTypeDto"]; }; /** * @description Status of a bank account transfer operation. * @enum {string} */ BankAccountTransferStatusDto: "PENDING" | "COMPLETED" | "FAILED"; /** * @description Type of bank account transfer operation. * @enum {string} */ BankAccountTransferTypeDto: "INTERNAL_TO_EXTERNAL" | "EXTERNAL_TO_INTERNAL" | "INTERNAL_TO_INTERNAL"; /** @enum {string} */ BankAccountTypeEnum: "INTERNAL" | "EXTERNAL" | "BANK_DETAILS"; /** @description Response model for a bank account with balance information. */ BankAccountWithBalanceResponse: { /** * Format: uuid * @description Unique identifier for the bank account. */ id: string; /** @description Masked account number. */ accountNumber: string; /** @description Current balance of the bank account in minor units (e.g. cents for USD). */ balance: components["schemas"]["AmountOutput"]; /** @description Reference identifier associated with the bank account. */ bankAccountReference?: null | string; /** * Format: date-time * @description The UTC timestamp when the bank account was created. */ createdDateTime: string; /** @description Nickname for the bank account. */ nickname?: null | string; /** @description Bank routing number. */ routingNumber: string; /** @description The status of the bank account. */ status: components["schemas"]["BankAccountStatus"]; }; /** @description A bank account identifier with its source type. */ BankAccountWithSourceInput: { /** * Format: uuid * @description Unique identifier for the bank account. */ bankAccountId: string; /** @description Whether this is an internal or external bank account. */ source: components["schemas"]["BankAccountSourceDto"]; }; BanksResponse: { data: components["schemas"]["Bank"][]; }; /** * @description In invoice history, this object contains information about a credit note created for this invoice. * In quote history, it contains information about an invoice created from this quote. */ BasedOnReceivableCreatedEventData: { /** * Format: uuid * @description The ID of the newly created receivable document. * @example 1531cf6e-52f5-4203-acb2-7cc3a37660c6 */ receivable_id: string; /** @description The type of the receivable document that was created based on the current document. */ type: components["schemas"]["ReceivableType"]; }; /** @enum {string} */ BasedOnTransitionType: "invoice" | "credit_note"; /** * @description Recipient schema specific for batch payment links. * Supports 'us_ach' and 'wire' payout methods in the schema, but only 'us_ach' is currently used. * Validation is done at the scenario level. */ BatchPaymentIntentsRecipient: { /** Format: uuid */ id: string; /** Format: uuid */ bank_account_id?: string; /** @enum {string} */ type: "counterpart"; }; /** * @description Request schema for creating a batch payment link. * Based on PaymentsBatchPaymentRequest but excluding payer_bank_account_id. */ BatchPaymentLinkRequest: { /** Format: date-time */ expires_at?: string; /** * @default us_ach * @enum {string} */ funding_payment_method: "us_ach"; payment_intents: components["schemas"]["BatchSinglePaymentIntent"][]; /** * @default [ * "us_ach" * ] */ payout_payment_methods: components["schemas"]["MoniteAllPaymentMethodsTypes"][]; /** * Format: uri * @description The URL where to redirect the payer after the payment. If `return_url` is specified, then after the payment is completed the payment page will display the "Return to platform" link that navigates to this URL. * @example https://pay.example.com/complete */ return_url?: string; }; /** @description Response schema for a batch payment link. */ BatchPaymentLinkResponse: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; error?: Record; /** Format: date-time */ expires_at: string; /** Format: uri */ payment_page_url: string; status: components["schemas"]["PaymentsBatchPaymentStatus"]; total_amount?: number; }; /** * @description Response schema for a batch payment link with payment intents. * Used for GET /batch_payment_links/{link_id} endpoint. */ BatchPaymentLinkWithPaymentIntents: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; error?: Record; /** Format: date-time */ expires_at: string; payment_intents: components["schemas"]["PaymentIntentResponse"][]; /** Format: uri */ payment_page_url: string; status: components["schemas"]["PaymentsBatchPaymentStatus"]; total_amount?: number; }; /** * @description Single payment intent schema specific for batch payment links. * Uses BatchPaymentIntentsRecipient instead of PaymentIntentsRecipient. */ BatchSinglePaymentIntent: { object: components["schemas"]["PaymentObjectPayable"]; /** @description Must be provided if payable's document id is missing. */ payment_reference?: string; recipient: components["schemas"]["BatchPaymentIntentsRecipient"]; }; /** @description Response model for a beneficial owner (business stakeholder). */ BeneficialOwnerResponse: { /** * Format: uuid * @description Unique identifier for the beneficial owner. */ id: string; /** * Format: uuid * @description The bank account application this owner was submitted with. */ applicationId: string; /** * Format: date * @description The date of birth of the beneficial owner. */ birthDate?: null | string; /** @description The first name of the beneficial owner. */ firstName?: null | string; homeAddress?: null | components["schemas"]["AddressOutput"]; /** @description The last name of the beneficial owner. */ lastName?: null | string; /** @description The mobile phone number of the beneficial owner. */ mobilePhoneNumber?: null | string; /** * Format: uuid * @description The VSP organization ID associated with this owner. */ organizationId: string; /** * Format: double * @description The ownership percentage (as a decimal, e.g., 0.25 for 25%). */ ownershipPercentage?: null | number | string; /** * @description The last 4 digits of the Social Security Number. * Omitted from the response if SSN is not available. */ ssnLast4?: null | string; /** @description The work email address of the beneficial owner. */ workEmailAddress?: null | string; }; "BizObjectsSchema-Input": { /** @description List of objects */ objects?: components["schemas"]["RootSchema-Input"][]; }; "BizObjectsSchema-Output": { /** @description List of objects */ objects?: components["schemas"]["RootSchema-Output"][]; }; Body_put_entities_id_logo: { /** Format: binary */ file: Blob; }; /** @description Request model for initiating a book transfer between internal accounts. */ BookTransferRequest: { /** * Format: int64 * @description Amount to transfer. Must be greater than 0. */ amount: number | string; /** * @description ISO 4217 alphabetic currency code (e.g. `USD`). Defaults to `USD` when omitted. * Determines the minor unit precision of long BookTransferRequest.Amount. * @default USD */ currencyCode: string; /** * Format: uuid * @description Source internal bank account identifier. */ fromBankAccountId: string; /** * @description Optional idempotency key for preventing duplicate transfers. * Maximum length: 256 characters. */ idempotencyKey?: null | string; /** * Format: uuid * @description Destination internal bank account identifier. */ toBankAccountId: string; }; BulkApplicationStatusResponseDto: { /** Format: int32 */ applicationsAffected: number | string; isEnabled: boolean; /** Format: uuid */ organizationId: string; }; /** @enum {string} */ BulkMembershipType: "ASSIGN" | "REMOVE"; BulkUpdateMembershipsRequest: { type: components["schemas"]["BulkMembershipType"]; userIds: string[]; }; /** @enum {string} */ BulkUpdatePermissionType: "ASSIGN" | "REMOVE"; BulkUpdatePermissionsRequest: { permissionIds: string[]; type: components["schemas"]["BulkUpdatePermissionType"]; }; /** * @description Input model for business details. Every field uses `Optional<T?>` so the server * can distinguish absent / explicit-null / explicit-value on a partial update. */ BusinessDetailsInput: { address?: components["schemas"]["OptionalOfAddressInput"]; businessStructureType?: components["schemas"]["OptionalOfBusinessStructureType"]; dbaName?: components["schemas"]["OptionalOfstring"]; formationDate?: components["schemas"]["OptionalOfDateOnly"]; legalName?: components["schemas"]["OptionalOfstring"]; northAmericanIndustryClassificationSystemCode?: components["schemas"]["OptionalOfNorthAmericanIndustryClassificationSystemCode"]; phoneNumber?: components["schemas"]["OptionalOfstring"]; taxId?: components["schemas"]["OptionalOfTaxIdentificationNumberInput"]; website?: components["schemas"]["OptionalOfstring"]; }; /** @description Output model for business details in responses. */ BusinessDetailsOutput: { address?: null | components["schemas"]["AddressOutput"]; businessStructureType?: null | components["schemas"]["BusinessStructureType"]; /** @description Doing Business As (DBA) name. */ dbaName?: null | string; /** @description Legal business name. */ legalName?: null | string; northAmericanIndustryClassificationSystemCode?: null | components["schemas"]["NorthAmericanIndustryClassificationSystemCode"]; /** @description Business phone number. */ phoneNumber?: null | string; /** @description Business website URL. */ website?: null | string; }; BusinessInfoSchema: { base_currency?: string; email?: string; legal_name?: string; name?: string; type?: string; }; /** * @description Input model for business owner information. Every field uses `Optional<T?>` so * the server can distinguish absent / explicit-null / explicit-value on a partial update. */ BusinessOwnerInput: { /** * Format: uuid * @description Identifier of an existing owner. Omit for new owners — the server assigns a new id. * Identity, not three-state, so it stays a plain nullable Guid. */ id?: null | string; birthDate?: components["schemas"]["OptionalOfDateOnly"]; firstName?: components["schemas"]["OptionalOfstring"]; homeAddress?: components["schemas"]["OptionalOfAddressInput"]; lastName?: components["schemas"]["OptionalOfstring"]; mobilePhoneNumber?: components["schemas"]["OptionalOfstring"]; ownershipPercentage?: components["schemas"]["OptionalOfdecimal"]; personalIdentificationNumber?: components["schemas"]["OptionalOfPersonalIdentificationNumberDto"]; }; /** @description Output model for business owner information in responses. */ BusinessOwnerOutput: { /** * Format: uuid * @description Unique identifier of the business owner record. Used by the client to reference * existing owners on update requests. */ id?: null | string; /** * Format: date * @description Date of birth of the business owner. */ birthDate?: null | string; /** @description First name of the business owner. */ firstName?: null | string; homeAddress?: null | components["schemas"]["AddressOutput"]; /** @description Last name of the business owner. */ lastName?: null | string; /** @description Mobile phone number of the business owner. */ mobilePhoneNumber?: null | string; /** * Format: double * @description Ownership percentage as a decimal between 0 and 1 (e.g., 25% = 0.25). */ ownershipPercentage?: null | number | string; }; "BusinessProfile-Input": { /** * @description Required for US entities. A free-form description of the products the entity sells (whether online or at offline retail stores) or the services it provides to its customers. * @example Acme Inc. is an online computer store that offers a wide range of computer products, laptops, smartphones, tablets, accessories, and more. */ description_of_goods_or_services?: string | null; /** @description Required for US entities. The approximate revenue that the business generates per month. */ estimated_monthly_revenue?: components["schemas"]["EstimatedMonthlyRevenue"] | null; /** * @description The merchant category code of the entity. MCCs are used to classify businesses based on the goods or services they provide. * @example 5734 */ mcc?: string | null; /** @description Required for US entities. A list of primary countries where the business conducts its operations, such as selling products or providing services. Use two-letter country codes (ISO 3166-2 alpha-2). */ operating_countries?: components["schemas"]["AllowedCountries"][] | null; /** @description The business's publicly available website. */ url?: string | null; }; "BusinessProfile-Output": { /** * @description Required for US entities. A free-form description of the products the entity sells (whether online or at offline retail stores) or the services it provides to its customers. * @example Acme Inc. is an online computer store that offers a wide range of computer products, laptops, smartphones, tablets, accessories, and more. */ description_of_goods_or_services?: string | null; /** @description Required for US entities. The approximate revenue that the business generates per month. */ estimated_monthly_revenue?: components["schemas"]["EstimatedMonthlyRevenue"] | null; /** * @description The merchant category code of the entity. MCCs are used to classify businesses based on the goods or services they provide. * @example 5734 */ mcc?: string | null; /** @description Required for US entities. A list of primary countries where the business conducts its operations, such as selling products or providing services. Use two-letter country codes (ISO 3166-2 alpha-2). */ operating_countries?: components["schemas"]["AllowedCountries"][] | null; /** @description The business's publicly available website. */ url?: string | null; }; /** @enum {string} */ BusinessStructureType: "CORPORATION_PUBLIC" | "CORPORATION_PRIVATE" | "CORPORATION_NOT_FOR_PROFIT" | "LLC" | "LLP" | "PARTNERSHIP" | "SOLE_PROPRIETORSHIP" | "GOVERNMENT" | "COOPERATIVE" | "ASSOCIATION" | "OTHER"; /** * @description Status of a business verification (KYC/KYB) result. * @enum {string} */ BusinessVerificationStatusDto: "APPROVED" | "DENIED" | "MANUAL_REVIEW" | "PENDING"; ButtonTheme: { primary_color?: string | null; primary_hover_color?: string | null; secondary_color?: string | null; secondary_hover_color?: string | null; }; CardPaymentMethod: { details: components["schemas"]["CardPaymentMethodDetails"]; /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "card"; }; CardPaymentMethodDetails: { /** @description The card brand name. */ brand: string; /** @description The card type */ card_type: components["schemas"]["CardTypeEnum"]; /** @description The card's expiration month (1 - January, 12 - December). */ expiry_month: number; /** @description The card's expiration year. */ expiry_year: number; /** * @description The last four digits of the card number. * @example 1234 */ last4: string; }; CardTheme: { background_color?: string | null; }; /** @enum {string} */ CardTypeEnum: "credit" | "debit" | "prepaid" | "unknown"; CloseCreditCardRequest: { reason: components["schemas"]["CreditCardCloseReason"]; }; CommentCreateRequest: { /** Format: uuid */ object_id: string; object_type: string; reply_to_entity_user_id?: string | null; text: string; }; /** @enum {string} */ CommentCursorFields: "id"; CommentPayload: { /** @description An arbitrary comment that describes how and when this payable was paid. */ comment?: string; }; CommentResource: { /** Format: uuid */ id: string; created_at: string | null; updated_at: string | null; /** Format: uuid */ created_by_entity_user_id: string; /** Format: uuid */ entity_id: string; /** Format: uuid */ object_id: string; object_type: string; reply_to_entity_user_id: string | null; status: components["schemas"]["StatusEnum"]; text: string; }; CommentResourceList: { data: components["schemas"]["CommentResource"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token: string | null; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token: string | null; }; CommentUpdateRequest: { reply_to_entity_user_id?: string | null; text?: string | null; }; CommercialConditionsBlock: { commercial_conditions?: string; /** @default Commercial conditions */ header: string; }; "CommonSchema-Input": { /** @description List of actions */ actions?: components["schemas"]["ActionSchema"][]; /** * @description Object type (enum property replaced by openapi-typescript) * @enum {string} */ object_type: "accounting_tax_rate" | "approval_policy" | "approval_request" | "comment" | "cost_center" | "counterpart" | "counterpart_vat_id" | "delivery_note" | "entity" | "entity_bank_account" | "entity_user" | "entity_vat_ids" | "export" | "ledger_account" | "mailbox" | "ocr_task" | "onboarding" | "overdue_reminder" | "payables_purchase_order" | "payment_record" | "payment_reminder" | "person" | "product" | "project" | "receipt" | "receivable" | "reconciliation" | "role" | "tag" | "todo_task" | "todo_task_mute" | "transaction" | "workflow"; }; "CommonSchema-Output": { /** @description List of actions */ actions?: components["schemas"]["ActionSchema"][]; /** * @description Object type (enum property replaced by openapi-typescript) * @enum {string} */ object_type: "accounting_tax_rate" | "approval_policy" | "approval_request" | "comment" | "cost_center" | "counterpart" | "counterpart_vat_id" | "delivery_note" | "entity" | "entity_bank_account" | "entity_user" | "entity_vat_ids" | "export" | "ledger_account" | "mailbox" | "ocr_task" | "onboarding" | "overdue_reminder" | "payables_purchase_order" | "payment_record" | "payment_reminder" | "person" | "product" | "project" | "receipt" | "receivable" | "reconciliation" | "role" | "tag" | "todo_task" | "todo_task_mute" | "transaction" | "workflow"; }; /** @description Request to connect a new external bank account. */ ConnectExternalBankAccountRequest: { /** @description External bank account number. */ accountNumber: string; /** @description Name on the bank account. */ nameOnAccount: string; /** @description Nickname for the external bank account. */ nickname: string; /** @description Bank routing number (ABA number). */ routingNumber: string; /** @description Type of bank account (checking or savings). */ type: components["schemas"]["ExternalBankAccountTypeDto"]; verification?: null | components["schemas"]["ExternalBankAccountVerificationInput"]; }; /** @enum {string} */ ConnectionStatus: "connected" | "disconnected" | "deauthorized" | "pending_auth"; ConsentPayload: { consent: string; }; /** @enum {string} */ ConsentState: "AWAITING_SCA_METHOD" | "AWAITING_SCA_CODE" | "AWAITING_DECOUPLED_AUTHORIZATION" | "AUTHORIZED" | "FAILED"; /** @description Address information. */ CounterpartAddress: { /** * @description City name. * @example New York */ city: string; /** * @description Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). * @example US */ country: components["schemas"]["AllowedCountries"]; /** * @description Street address. * @example 456 Fifth Avenue */ line1: string; /** @description Additional address information (if any). */ line2?: string; /** * @description ZIP or postal code. * @example 10001 */ postal_code: string; /** @description State, region, province, or county. */ state?: string; }; CounterpartAddressResourceList: { data: components["schemas"]["CounterpartAddressResponseWithCounterpartID"][]; }; /** @description Address information. */ CounterpartAddressResponseWithCounterpartID: { /** * Format: uuid * @description Unique ID of the address in the system */ id: string; /** * @description City name. * @example New York */ city: string; /** * Format: uuid * @description ID of the counterpart that owns the address. */ counterpart_id: string; /** * @description Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). * @example US */ country: components["schemas"]["AllowedCountries"]; /** * @description Street address. * @example 456 Fifth Avenue */ line1: string; /** @description Additional address information (if any). */ line2?: string; /** * @description ZIP or postal code. * @example 10001 */ postal_code: string; /** @description State, region, province, or county. */ state?: string; }; CounterpartBankAccountResourceList: { data: components["schemas"]["CounterpartBankAccountResponse"][]; }; CounterpartBankAccountResponse: { /** Format: uuid */ id: string; /** * @description The name of the person or business that owns this bank account. Required for US bank accounts to accept ACH payments. * @example Bob Jones */ account_holder_name?: string; /** * @description The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. * @example 12345678 */ account_number?: string; /** * @description The BIC/SWIFT code of the bank. * @example CHASUS33XXX */ bic?: string; /** Format: uuid */ counterpart_id: string; country: components["schemas"]["AllowedCountries"]; currency: components["schemas"]["CurrencyEnum"]; /** * @description The IBAN of the bank account. * @example GB29NWBK60161331926819 */ iban?: string; /** @default false */ is_default_for_currency: boolean; name?: string; /** @description Metadata for partner needs. */ partner_metadata?: Record; /** @description The bank's routing transit number (RTN). Required for US bank accounts to accept ACH payments. US routing numbers consist of 9 digits. */ routing_number?: string; /** * @description The bank's sort code. * @example 123456 */ sort_code?: string; }; /** @description The contact person for an organization. */ CounterpartContactResponse: { /** Format: uuid */ id: string; /** @description The address of a contact person. */ address: components["schemas"]["CounterpartAddress"]; /** Format: uuid */ counterpart_id: string; /** * Format: email * @description The email address of a contact person. * @example contact@example.org */ email?: string; /** * @description The first name of a contact person. * @example Mary */ first_name: string; is_default: boolean; /** * @description The last name of a contact person. * @example O'Brien */ last_name: string; /** * @description The phone number of a contact person * @example 5551235476 */ phone?: string; /** * @description The title or honorific of a contact person. Examples: Mr., Ms., Dr., Prof. * @example Ms. */ title?: string; }; CounterpartContactsResourceList: { data: components["schemas"]["CounterpartContactResponse"][]; }; /** * @description This schema is used to create new counterparts (either organizations or individuals). * The counterpart type is specified by the `type` property. Depending on the `type`, * you need to provide the data for either the `individual` or `organization` property. */ CounterpartCreatePayload: components["schemas"]["CounterpartOrganizationRootCreatePayload"] | components["schemas"]["CounterpartIndividualRootCreatePayload"]; /** @enum {string} */ CounterpartCursorFields: "counterpart_name"; CounterpartEinvoicingCredentialExistenceResponse: { /** @description Indicates if the e-invoicing credentials exist in the system */ exists: boolean; }; CounterpartEinvoicingCredentialResponse: { /** Format: uuid */ id: string; network_identifier: string; network_schema: components["schemas"]["EinvoiceSchemaTypeEnum"]; }; CounterpartEinvoicingCredentialResponseList: { data: components["schemas"]["CounterpartEinvoicingCredentialResponse"][]; }; CounterpartEinvoicingCredentialSchema: { network_identifier: string; network_schema: components["schemas"]["EinvoiceSchemaTypeEnum"]; }; CounterpartFields: { /** * @description Object describing the required field `tax_id` of an counterpart * @default { * "description": "The counterpart's taxpayer identification number or tax ID. For identification purposes, this field may be required for counterparts that are not VAT-registered.", * "required": false * } */ tax_id: components["schemas"]["FieldSchema"]; /** * @description Object describing the required field `vat_id` of an counterpart * @default { * "description": "The counterpart's VAT (Value Added Tax) identification number. This field is required for counterparts that are VAT-registered.", * "required": false * } */ vat_id: components["schemas"]["FieldSchema"]; }; /** @description Represents counterparts that are individuals (natural persons). */ CounterpartIndividualCreatePayload: { /** @description The person's address. Required when `is_vendor` is true. */ address?: components["schemas"]["CounterpartAddress"]; /** * Format: email * @description The person's email address. * @example asingh@example.net */ email?: string; /** * @description The person's first name. * @example Adnan */ first_name: string; /** * @description The person's last name. * @example Singh */ last_name: string; /** * @description The person's phone number. * @example 5553211234 */ phone?: string; /** @description A list of IDs of user-defined tags (labels) assigned to this counterpart. */ tag_ids?: string[]; /** * @description The person's title or honorific. Examples: Mr., Ms., Dr., Prof. * @example Mr. */ title?: string; }; /** @enum {string} */ CounterpartIndividualFieldsEnum: "first_name" | "last_name" | "email" | "tax_id" | "vat_id"; CounterpartIndividualResponse: { /** * Format: email * @description The person's email address. * @example asingh@example.net */ email?: string; /** * @description The person's first name. * @example Adnan */ first_name: string; /** @description Indicates if the counterpart is a customer. */ is_customer: boolean; /** @description Indicates if the counterpart is a vendor. */ is_vendor: boolean; /** * @description The person's last name. * @example Singh */ last_name: string; /** * @description The person's phone number. * @example 5553211234 */ phone?: string; /** @description The list of tags for this counterpart. */ tags?: components["schemas"]["CounterpartTagSchema"][]; /** * @description The person's title or honorific. Examples: Mr., Ms., Dr., Prof. * @example Mr. */ title?: string; }; /** @description This schema is used to create counterparts that are individuals (natural persons). */ CounterpartIndividualRootCreatePayload: { /** * @description A user-defined identifier of the counterpart. For example, the customer or vendor reference number in the entity's CRM system. If specified, it will be displayed in PDF invoices and other accounts receivable documents created by the entity. * @example CR-ABC-12345 * @example CUS123456 */ external_reference?: string; individual: components["schemas"]["CounterpartIndividualCreatePayload"]; /** @description Indicates if the counterpart is a customer. */ is_customer: boolean; /** @description Indicates if the counterpart is a vendor. */ is_vendor: boolean; /** * @description The language used to generate PDF documents for this counterpart. * @default en */ language: components["schemas"]["LanguageCodeEnum"]; /** @default true */ reminders_enabled: boolean; /** @description The counterpart's taxpayer identification number or tax ID. For identification purposes, this field may be required for counterparts that are not VAT-registered. */ tax_id?: string; /** * @description Must be "individual". * @example individual * @enum {string} */ type: "individual"; }; /** @description Represents counterparts that are individuals (natural persons). */ CounterpartIndividualRootResponse: { /** * Format: uuid * @description Unique ID of the counterpart. */ id: string; /** * Format: date-time * @description Date and time when the counterpart was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. */ created_at: string; /** * Format: date-time * @description Date and time when the counterpart was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. */ updated_at: string; /** * @description `true` if the counterpart was created automatically by Monite when processing incoming invoices with OCR. `false` if the counterpart was created by the API client. * @default false */ created_automatically: boolean; /** * Format: uuid * @description Entity user ID of counterpart creator. */ created_by_entity_user_id?: string; /** * Format: uuid * @description ID of the counterpart's billing address. If the counterpart is US-based and needs to accept ACH payments, this address must have all fields filled in. If `default_billing_address_id` is not defined, the default address is instead used as the billing address for ACH payments. */ default_billing_address_id?: string; /** * Format: uuid * @description ID of the shipping address. */ default_shipping_address_id?: string; /** * @description A user-defined identifier of the counterpart. For example, the customer or vendor reference number in the entity's CRM system. If specified, it will be displayed in PDF invoices and other accounts receivable documents created by the entity. * @example 123456789 */ external_reference?: string; individual: components["schemas"]["CounterpartIndividualResponse"]; /** @description Indicates if the counterpart is a customer. */ is_customer: boolean; /** @description Indicates if the counterpart is a vendor. */ is_vendor: boolean; /** @description The language used to generate PDF documents for this counterpart. */ language?: components["schemas"]["LanguageCodeEnum"]; reminders_enabled?: boolean; /** @description The counterpart's taxpayer identification number or tax ID. */ tax_id?: string; /** @description The counterpart type: `organization` (juridical person) or `individual` (natural person). */ type: components["schemas"]["CounterpartType"]; }; /** @description Represents counterparts that are individuals (natural persons). */ CounterpartIndividualRootUpdatePayload: { /** * Format: uuid * @description ID of the counterpart's billing address. If the counterpart is US-based and needs to accept ACH payments, this address must have all fields filled in. If `default_billing_address_id` is not defined, the default address is instead used as the billing address for ACH payments. */ default_billing_address_id?: string; /** * Format: uuid * @description ID of the shipping address. */ default_shipping_address_id?: string; /** * @description A user-defined identifier of the counterpart. For example, the customer or vendor reference number in the entity's CRM system. If specified, it will be displayed in PDF invoices and other accounts receivable documents created by the entity. * @example 123456789 */ external_reference?: string; individual: components["schemas"]["CounterpartIndividualUpdatePayload"]; /** @description Indicates if the counterpart is a customer. */ is_customer?: boolean; /** @description Indicates if the counterpart is a vendor. */ is_vendor?: boolean; /** @description The language used to generate PDF documents for this counterpart. */ language?: components["schemas"]["LanguageCodeEnum"]; reminders_enabled?: boolean; /** @description The counterpart's taxpayer identification number or tax ID. For identification purposes, this field may be required for counterparts that are not VAT-registered. */ tax_id?: string; }; /** @description Represents counterparts that are individuals (natural persons). */ CounterpartIndividualUpdatePayload: { /** * Format: email * @description The person's email address. * @example asingh@example.net */ email?: string; /** * @description The person's first name. * @example Adnan */ first_name?: string; /** * @description The person's last name. * @example Singh */ last_name?: string; /** * @description The person's phone number. * @example 5553211234 */ phone?: string; /** @description A list of IDs of user-defined tags (labels) assigned to this counterpart. */ tag_ids?: string[]; /** * @description The person's title or honorific. Examples: Mr., Ms., Dr., Prof. * @example Mr. */ title?: string; }; /** @description Fields for the counterpart of the entity that has to pay the receivable */ CounterpartInfoBlock: { /** @description HTML formatted billing address of the counterpart */ billing_address?: string; /** @description Counterpart billing address not formatted data */ billing_address_data?: components["schemas"]["AddressData"]; /** @description Header for the counterpart info block. Empty for Mollie; 'Customer' for all other entity counterparts */ counterpart_info_header?: string; /** @description Email address of the counterpart */ email?: string; /** @description External reference of the counterpart */ external_reference?: string; /** @default Counterpart Reference */ external_reference_header: string; /** @description Name of the organization entity or first and last name of the individual entity */ name?: string; /** @description Phone number of the counterpart */ phone?: string; /** @description HTML formatted shipping address of the counterpart */ shipping_address?: string; /** @description Counterpart shipping address not formatted data */ shipping_address_data?: components["schemas"]["AddressData"]; /** @description Header for the shipping address */ shipping_address_header?: string; /** @description Tax ID of the counterpart */ tax_id?: string; /** * @description Header for the tax ID field * @default TAX ID */ tax_id_header: string; /** @description Country code of the counterpart's VAT ID. E.g. 'NL' */ vat_country?: string; /** @description VAT ID of the counterpart */ vat_id?: string; /** @description Header for the VAT ID field */ vat_id_header?: string; }; /** @description Represents counterparts that are organizations (juridical persons). */ CounterpartOrganizationCreatePayload: { /** @description The address of the organization. Required when `is_vendor` is true. */ address?: components["schemas"]["CounterpartAddress"]; /** * Format: email * @description The email address of the organization * @example acme@example.com */ email?: string; /** * @description The legal name of the organization. * @example Acme Inc. */ legal_name: string; /** * @description The phone number of the organization * @example 5551231234 */ phone?: string; /** @description A list of IDs of user-defined tags (labels) assigned to this counterpart. */ tag_ids?: string[]; }; /** @enum {string} */ CounterpartOrganizationFieldsEnum: "name" | "email" | "tax_id" | "vat_id"; CounterpartOrganizationResponse: { /** * Format: email * @description The email address of the organization * @example acme@example.com */ email?: string; /** @description Indicates if the counterpart is a customer. */ is_customer: boolean; /** @description Indicates if the counterpart is a vendor. */ is_vendor: boolean; /** * @description The legal name of the organization. * @example Acme Inc. */ legal_name: string; /** * @description The phone number of the organization * @example 5551231234 */ phone?: string; /** @description The list of tags for this counterpart. */ tags?: components["schemas"]["CounterpartTagSchema"][]; }; /** @description This schema is used to create counterparts that are organizations (juridical persons). */ CounterpartOrganizationRootCreatePayload: { /** * @description A user-defined identifier of the counterpart. For example, the customer or vendor reference number in the entity's CRM system. If specified, it will be displayed in PDF invoices and other accounts receivable documents created by the entity. * @example 123456789 */ external_reference?: string; /** @description Indicates if the counterpart is a customer. */ is_customer: boolean; /** @description Indicates if the counterpart is a vendor. */ is_vendor: boolean; /** * @description The language used to generate PDF documents for this counterpart. * @default en */ language: components["schemas"]["LanguageCodeEnum"]; organization: components["schemas"]["CounterpartOrganizationCreatePayload"]; /** @default true */ reminders_enabled: boolean; /** @description The counterpart's taxpayer identification number or tax ID. For identification purposes, this field may be required for counterparts that are not VAT-registered. */ tax_id?: string; /** * @description Must be "organization". * @example organization * @enum {string} */ type: "organization"; }; /** @description Represents counterparts that are organizations (juridical persons). */ CounterpartOrganizationRootResponse: { /** * Format: uuid * @description Unique ID of the counterpart. */ id: string; /** * Format: date-time * @description Date and time when the counterpart was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. */ created_at: string; /** * Format: date-time * @description Date and time when the counterpart was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. */ updated_at: string; /** * @description `true` if the counterpart was created automatically by Monite when processing incoming invoices with OCR. `false` if the counterpart was created by the API client. * @default false */ created_automatically: boolean; /** * Format: uuid * @description Entity user ID of counterpart creator. */ created_by_entity_user_id?: string; /** * Format: uuid * @description ID of the counterpart's billing address. If the counterpart is US-based and needs to accept ACH payments, this address must have all fields filled in. If `default_billing_address_id` is not defined, the default address is instead used as the billing address for ACH payments. */ default_billing_address_id?: string; /** * Format: uuid * @description ID of the shipping address. */ default_shipping_address_id?: string; /** * @description A user-defined identifier of the counterpart. For example, the customer or vendor reference number in the entity's CRM system. If specified, it will be displayed in PDF invoices and other accounts receivable documents created by the entity. * @example 123456789 */ external_reference?: string; /** @description Indicates if the counterpart is a customer. */ is_customer: boolean; /** @description Indicates if the counterpart is a vendor. */ is_vendor: boolean; /** @description The language used to generate PDF documents for this counterpart. */ language?: components["schemas"]["LanguageCodeEnum"]; organization: components["schemas"]["CounterpartOrganizationResponse"]; reminders_enabled?: boolean; /** @description The counterpart's taxpayer identification number or tax ID. */ tax_id?: string; /** @description The counterpart type: `organization` (juridical person) or `individual` (natural person). */ type: components["schemas"]["CounterpartType"]; }; /** @description Represents counterparts that are organizations (juridical persons). */ CounterpartOrganizationRootUpdatePayload: { /** * Format: uuid * @description ID of the counterpart's billing address. If the counterpart is US-based and needs to accept ACH payments, this address must have all fields filled in. If `default_billing_address_id` is not defined, the default address is instead used as the billing address for ACH payments. */ default_billing_address_id?: string; /** * Format: uuid * @description ID of the shipping address. */ default_shipping_address_id?: string; /** * @description A user-defined identifier of the counterpart. For example, the customer or vendor reference number in the entity's CRM system. If specified, it will be displayed in PDF invoices and other accounts receivable documents created by the entity. * @example 123456789 */ external_reference?: string; /** @description Indicates if the counterpart is a customer. */ is_customer?: boolean; /** @description Indicates if the counterpart is a vendor. */ is_vendor?: boolean; /** * @description The language used to generate PDF documents for this counterpart. * @default en */ language: components["schemas"]["LanguageCodeEnum"]; organization: components["schemas"]["CounterpartOrganizationUpdatePayload"]; /** @default true */ reminders_enabled: boolean; /** @description The counterpart's taxpayer identification number or tax ID. For identification purposes, this field may be required for counterparts that are not VAT-registered. */ tax_id?: string; }; /** @description Represents counterparts that are organizations (juridical persons). */ CounterpartOrganizationUpdatePayload: { /** * Format: email * @description The email address of the organization. * @example acme@example.com */ email?: string; /** * @description The legal name of the organization. * @example Acme Inc. */ legal_name?: string; /** * @description The phone number of the organization. * @example 5551231234 */ phone?: string; /** @description A list of IDs of user-defined tags (labels) assigned to this counterpart. */ tag_ids?: string[]; }; /** @description A paginated list of counterparts */ CounterpartPaginationResponse: { data: components["schemas"]["CounterpartResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; /** @description Address information. */ CounterpartRawAddress: { /** * @description City name. * @example New York */ city?: string; /** * @description Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). * @example US */ country?: components["schemas"]["AllowedCountries"]; /** * @description Street address. * @example 456 Fifth Avenue */ line1?: string; /** @description Additional address information (if any). */ line2?: string; /** * @description ZIP or postal code. * @example 10001 */ postal_code?: string; /** @description State, region, province, or county. */ state?: string; }; /** @description Address information. */ CounterpartRawAddressUpdateRequest: { /** * @description City name. * @example New York */ city?: string; /** * @description Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). * @example US */ country?: components["schemas"]["AllowedCountries"]; /** * @description Street address. * @example 456 Fifth Avenue */ line1?: string; /** @description Additional address information (if any). */ line2?: string; /** * @description ZIP or postal code. * @example 10001 */ postal_code?: string; /** @description State, region, province, or county. */ state?: string; }; CounterpartRawBankAccount: { /** @description Vendor's bank account name. */ account_holder_name?: string; /** * @description Vendor's bank account number, IBAN, or similar (if specified in the payable document). * @example 123456789012 */ account_number?: string; /** * @description SWIFT code (BIC) of the vendor's bank. * @example CHASUS33XXX */ bic?: string; /** @description required for non-GB bank accounts */ iban?: string; /** @description required for US bank accounts */ routing_number?: string; /** @description required for GB bank accounts */ sort_code?: string; }; CounterpartRawBankAccountUpdateRequest: { /** @description Vendor's bank account name. */ account_holder_name?: string; /** * @description Vendor's bank account number, IBAN, or similar (if specified in the payable document). * @example 123456789012 */ account_number?: string; /** * @description SWIFT code (BIC) of the vendor's bank. * @example CHASUS33XXX */ bic?: string; /** @description required for non-GB bank accounts */ iban?: string; /** @description required for US bank accounts */ routing_number?: string; /** @description required for GB bank accounts */ sort_code?: string; }; CounterpartRawData: { /** @description The address of the vendor or supplier. */ address?: components["schemas"]["CounterpartRawAddress"]; /** @description Object representing counterpart bank account. */ bank_account?: components["schemas"]["CounterpartRawBankAccount"]; /** * Format: email * @description The email address of the organization * @example acme@example.com */ email?: string; /** * @description Vendor or supplier name. * @example Acme Inc. */ name?: string; /** * @description The phone number of the organization * @example 5551231234 */ phone?: string; /** * @description The tax id of the counterpart. * @example 123456789 */ tax_id?: string; /** @description VAT ID of the vendor or supplier which was used in the invoice. */ vat_id?: components["schemas"]["CounterpartRawVatID"]; }; CounterpartRawDataUpdateRequest: { /** @description The address of the vendor or supplier. */ address?: components["schemas"]["CounterpartRawAddressUpdateRequest"]; /** @description Object representing counterpart bank account. */ bank_account?: components["schemas"]["CounterpartRawBankAccountUpdateRequest"]; /** * Format: email * @description The email address of the organization * @example acme@example.com */ email?: string; /** * @description Vendor or supplier name. * @example Acme Inc. */ name?: string; /** * @description The phone number of the organization * @example 5551231234 */ phone?: string; /** * @description The tax id of the counterpart. * @example 123456789 */ tax_id?: string; /** @description VAT ID of the vendor or supplier which was used in the invoice. */ vat_id?: components["schemas"]["CounterpartRawVatIDUpdateRequest"]; }; CounterpartRawVatID: { country?: components["schemas"]["AllowedCountries"]; type?: string; value?: string; }; CounterpartRawVatIDUpdateRequest: { country?: components["schemas"]["AllowedCountries"]; type?: string; value?: string; }; /** * @description A Counterpart object contains information about an organization (juridical person) or * individual (natural person) that provides goods and services to or buys them from an * [SME](https://docs.monite.com/docs/glossary#sme). */ CounterpartResponse: components["schemas"]["CounterpartIndividualRootResponse"] | components["schemas"]["CounterpartOrganizationRootResponse"]; CounterpartSchema: { individual: components["schemas"]["CounterpartIndividualFieldsEnum"][]; organization: components["schemas"]["CounterpartOrganizationFieldsEnum"][]; }; /** @description Represents a user-defined tag that can be assigned to resources to filter them. */ CounterpartTagSchema: { /** * Format: uuid * @description A unique ID of this tag. * @example ea837e28-509b-4b6a-a600-d54b6aa0b1f5 */ id: string; /** * Format: date-time * @description Date and time when the tag was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. * @example 2022-09-07T16:35:18.484507+00:00 */ created_at: string; /** * Format: date-time * @description Date and time when the tag was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. * @example 2022-09-07T16:35:18.484507+00:00 */ updated_at: string; /** * @description The tag category. * @example department */ category?: components["schemas"]["TagCategory"]; /** * Format: uuid * @description ID of the user who created the tag. * @example ea837e28-509b-4b6a-a600-d54b6aa0b1f5 */ created_by_entity_user_id?: string; /** * @description The tag description. * @example Tag for the Marketing Department */ description?: string; /** * @description The tag name. * @example Marketing */ name: string; }; /** @enum {string} */ CounterpartType: "individual" | "organization"; CounterpartUpdateAddress: { /** * @description City name. * @example New York */ city?: string; /** * @description Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). * @example US */ country?: components["schemas"]["AllowedCountries"]; /** * @description Street address. * @example 456 Fifth Avenue */ line1?: string; /** @description Additional address information (if any). */ line2?: string; /** * @description ZIP or postal code. * @example 10001 */ postal_code?: string; /** @description State, region, province, or county. */ state?: string; }; /** @description This schema is used to update existing counterparts (organizations or individuals). */ CounterpartUpdatePayload: components["schemas"]["CounterpartIndividualRootUpdatePayload"] | components["schemas"]["CounterpartOrganizationRootUpdatePayload"]; CounterpartUpdateVatID: { country?: components["schemas"]["AllowedCountries"]; /** @example eu_vat */ type?: components["schemas"]["VatIDTypeEnum"]; value?: string; }; CounterpartVatID: { country?: components["schemas"]["AllowedCountries"]; /** * @default unknown * @example eu_vat */ type: components["schemas"]["VatIDTypeEnum"]; /** @example 123456789 */ value: string; }; CounterpartVatIDResourceList: { data: components["schemas"]["CounterpartVatIDResponse"][]; }; CounterpartVatIDResponse: { /** Format: uuid */ id: string; /** Format: uuid */ counterpart_id: string; country?: components["schemas"]["AllowedCountries"]; /** * @default unknown * @example eu_vat */ type: components["schemas"]["VatIDTypeEnum"]; /** @example 123456789 */ value: string; }; /** @enum {string} */ CountryCode: "AFG" | "ALB" | "DZA" | "ASM" | "ALA" | "AND" | "AGO" | "AIA" | "ATA" | "ATG" | "ARG" | "ARM" | "ABW" | "AUS" | "AUT" | "AZE" | "BHS" | "BHR" | "BGD" | "BRB" | "BLR" | "BEL" | "BLZ" | "BEN" | "BES" | "BMU" | "BTN" | "BOL" | "BIH" | "BWA" | "BVT" | "BRA" | "IOT" | "BRN" | "BGR" | "BFA" | "BDI" | "CPV" | "KHM" | "CMR" | "CAN" | "CYM" | "CAF" | "TCD" | "CHL" | "CHN" | "CXR" | "CCK" | "COL" | "COM" | "COD" | "COG" | "CIV" | "COK" | "CRI" | "HRV" | "CUB" | "CUW" | "CYP" | "CZE" | "DNK" | "DJI" | "DMA" | "DOM" | "ECU" | "EGY" | "SLV" | "GNQ" | "ERI" | "EST" | "SWZ" | "ETH" | "FLK" | "FRO" | "FJI" | "FIN" | "FRA" | "GUF" | "PYF" | "ATF" | "GAB" | "GMB" | "GEO" | "DEU" | "GHA" | "GIB" | "GRC" | "GRL" | "GRD" | "GLP" | "GUM" | "GTM" | "GGY" | "GIN" | "GNB" | "GUY" | "HTI" | "HMD" | "HND" | "HKG" | "HUN" | "ISL" | "IND" | "IDN" | "IRL" | "IRN" | "IRQ" | "IMN" | "ISR" | "ITA" | "JAM" | "JPN" | "JEY" | "JOR" | "KAZ" | "KEN" | "KIR" | "KOR" | "KWT" | "KGZ" | "LAO" | "LVA" | "LBN" | "LSO" | "LBR" | "LBY" | "LIE" | "LTU" | "LUX" | "MDG" | "MWI" | "MYS" | "MDV" | "MLI" | "MLT" | "MHL" | "MTQ" | "MRT" | "MUS" | "MYT" | "MEX" | "FSM" | "MDA" | "MCO" | "MNG" | "MNE" | "MSR" | "MAR" | "MOZ" | "MMR" | "NAM" | "NRU" | "NPL" | "NLD" | "NCL" | "NZL" | "NIC" | "NER" | "NGA" | "NIU" | "NFK" | "MAC" | "MKD" | "MNP" | "NOR" | "OMN" | "PAK" | "PLW" | "PSE" | "PAN" | "PNG" | "PRY" | "PER" | "PHL" | "PCN" | "POL" | "PRT" | "PRI" | "PRK" | "QAT" | "REU" | "ROU" | "RUS" | "RWA" | "BLM" | "SHN" | "KNA" | "LCA" | "MAF" | "SPM" | "VCT" | "WSM" | "SMR" | "STP" | "SAU" | "SEN" | "SRB" | "SYC" | "SLE" | "SGP" | "SXM" | "SVK" | "SVN" | "SLB" | "SOM" | "ZAF" | "SGS" | "SSD" | "ESP" | "LKA" | "SDN" | "SUR" | "SJM" | "SWE" | "SYR" | "CHE" | "TCA" | "TWN" | "TJK" | "TZA" | "THA" | "TLS" | "TGO" | "TKL" | "TON" | "TTO" | "TUN" | "TUR" | "TKM" | "TUV" | "UGA" | "UKR" | "UMI" | "ARE" | "GBR" | "USA" | "URY" | "UZB" | "VUT" | "VAT" | "VEN" | "VIR" | "VGB" | "VNM" | "WLF" | "ESH" | "YEM" | "ZMB" | "ZWE"; CountryPredicate: components["schemas"]["SingleCountryPredicate"] | components["schemas"]["MultipleCountryPredicate"]; CreateAdditionalCardRequest: { /** Format: uuid */ cardholderUserId?: null | string; format: components["schemas"]["CreditCardFormat"]; shippingAddress?: null | components["schemas"]["Address"]; }; /** @description Request model for creating a new bank account application. */ CreateBankAccountApplicationRequest: { applicant?: null | components["schemas"]["BankAccountApplicantInput"]; businessDetails?: null | components["schemas"]["BusinessDetailsInput"]; /** @description Optional list of business owners to add to the application. */ businessOwners?: null | components["schemas"]["BusinessOwnerInput"][]; /** @description Custom validation source for the individual (e.g. "Socure"). Used by partners who perform their own KYC. */ individualValidationSource?: null | string; /** @description Custom validation source for the organization (e.g. "Middesk"). Used by partners who perform their own KYC. */ organizationValidationSource?: null | string; }; CreateBankAccountApplicationWithSecretResponse: { /** * Format: uuid * @description Unique identifier for the bank account application. */ id: string; applicant?: null | components["schemas"]["BankAccountApplicantOutput"]; businessDetails?: null | components["schemas"]["BusinessDetailsOutput"]; /** @description List of business owners associated with the application. */ businessOwners?: null | components["schemas"]["BusinessOwnerOutput"][]; clientSecret?: null | string; /** * Format: uuid * @description Identifier of the organization the application has been onboarded under. * Null until the application has been verified and the organization created. */ organizationId?: null | string; /** @description Current status of the bank account application. */ status?: components["schemas"]["BankAccountApplicationStatusDto"]; /** * Format: uuid * @description Identifier of the user created for the applicant during onboarding. * Null until the application has been verified and the user created. */ userId?: null | string; }; /** @description Request model for creating a new bank account. */ CreateBankAccountRequest: { /** * @description An optional bank account number to assign to the new account. When omitted, * Tesouro generates one. Only available to providers explicitly approved by * the bank; the value is validated against the bank's account number rules * and rejected if it does not conform. */ bankAccountNumber?: null | string; /** * @description An optional reference identifier to associate with the bank account. * Can be used to store a Platform's or VSP's internal account identifier. * Must be alphanumeric (letters, numbers, hyphens, underscores, and dots) and max 50 characters. */ bankAccountReference?: null | string; /** * Format: uuid * @description The ID of a beneficial owner to use for VSP APP token bank account creation. * Required for VSP APP token callers (no user context). Not applicable when * `organizationId` is provided by BANK or PLATFORM callers. */ beneficialOwnerId?: null | string; /** @description The nickname for the new bank account. */ nickname: string; }; CreateCounterpartBankAccount: { /** * @description The name of the person or business that owns this bank account. Required for US bank accounts to accept ACH payments. * @example Bob Jones */ account_holder_name?: string; /** * @description The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. * @example 12345678 */ account_number?: string; /** * @description The BIC/SWIFT code of the bank. * @example CHASUS33XXX */ bic?: string; country: components["schemas"]["AllowedCountries"]; currency: components["schemas"]["CurrencyEnum"]; /** * @description The IBAN of the bank account. * @example GB29NWBK60161331926819 */ iban?: string; /** @default false */ is_default_for_currency: boolean; name?: string; /** @description Metadata for partner needs. */ partner_metadata?: Record; /** @description The bank's routing transit number (RTN). Required for US bank accounts to accept ACH payments. US routing numbers consist of 9 digits. */ routing_number?: string; /** * @description The bank's sort code. * @example 123456 */ sort_code?: string; }; /** @description The contact person for an organization. */ CreateCounterpartContactPayload: { /** @description The address of a contact person. */ address: components["schemas"]["CounterpartAddress"]; /** * Format: email * @description The email address of a contact person. * @example contact@example.org */ email?: string; /** * @description The first name of a contact person. * @example Mary */ first_name: string; /** * @description The last name of a contact person. * @example O'Brien */ last_name: string; /** * @description The phone number of a contact person * @example 5551235476 */ phone?: string; /** * @description The title or honorific of a contact person. Examples: Mr., Ms., Dr., Prof. * @example Ms. */ title?: string; }; CreateCounterpartEinvoicingCredentialCounterpartVatId: { /** * Format: uuid * @description ID of Counterpart VAT ID */ counterpart_vat_id_id: string; }; CreateCounterpartEinvoicingCredentialPayload: components["schemas"]["CreateCounterpartEinvoicingCredentialCounterpartVatId"] | components["schemas"]["CounterpartEinvoicingCredentialSchema"]; /** @description Request model for creating a new credit card application. */ CreateCreditCardApplicationRequest: { applicant?: null | components["schemas"]["CreditCardApplicantInput"]; businessDetails?: null | components["schemas"]["CreditCardBusinessDetailsInput"]; /** @description Optional list of business owners to add to the application. */ businessOwners?: null | components["schemas"]["BusinessOwnerInput"][]; }; CreateCreditCardApplicationWithSecretResponse: { /** * Format: uuid * @description Unique identifier for the credit card application. */ id: string; applicant?: null | components["schemas"]["CreditCardApplicantOutput"]; businessDetails?: null | components["schemas"]["CreditCardBusinessDetailsOutput"]; /** @description List of business owners associated with the application. */ businessOwners?: null | components["schemas"]["BusinessOwnerOutput"][]; clientSecret?: null | string; /** @description Current status of the credit card application. */ status?: components["schemas"]["CreditCardApplicationStatusDto"]; verifyBusinessStatus?: null | components["schemas"]["BusinessVerificationStatusDto"]; }; CreateDepartmentRequest: { name: string; }; /** @description Represents a US bank account (bank details) owned by an entity. */ CreateEntityBankAccountRequest: { /** * @description The name of the person or business that owns this bank account. Required in the following cases: * * the account currency is GBP or USD, * * the account currency is EUR and the entity wishes to receive SEPA Credit transfers to this account. * @example Cayla Lloyd */ account_holder_name?: string; /** * @description The bank account number. Required if the account currency is GBP or USD. UK account numbers typically contain 8 digits. US bank account numbers contain 9 to 12 digits. * @example 123456789 */ account_number?: string; /** * @description The bank name. * @example Chase */ bank_name?: string; /** * @description User-defined name of this bank account, such as 'Primary account' or 'Savings account'. * @example Primary account */ display_name?: string; /** * @description The bank's routing transit number (RTN) or branch code. Required if the account currency is USD. US routing numbers consist of 9 digits. * @example 123456789 */ routing_number?: string; }; /** @description A schema for a request to create an entity of different types */ CreateEntityRequest: { /** @description An address description of the entity */ address: components["schemas"]["EntityAddressSchema"]; /** * Format: email * @description An official email address of the entity */ email: string; /** @description A set of meta data describing the individual */ individual?: components["schemas"]["IndividualSchema"] | null; /** @description A set of meta data describing the organization */ organization?: components["schemas"]["OrganizationSchema"] | null; /** @description The contact phone number of the entity. Required for US organizations to use payments. */ phone?: string | null; /** * @description (Germany only) The name of the local district court (_Amtsgericht_) where the entity is registered. Required if `registration_number` is provided. * @example Amtsgericht Charlottenburg */ registration_authority?: string | null; /** * @description (Germany only) The entity's commercial register number (_Handelsregisternummer_) in the German Commercial Register, if available. * @example HRB 202324 */ registration_number?: string | null; /** @description The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered. */ tax_id?: string | null; /** @description A type for an entity */ type: components["schemas"]["EntityTypeEnum"]; /** @description A website of the entity */ website?: string | null; }; CreateEntityUserRequest: { /** @description An entity user business email */ email?: string | null; /** * @description First name * @example Casey */ first_name: string; /** * @description Last name * @example Peters */ last_name?: string | null; login: string; /** @description An entity user phone number in the international format */ phone?: string | null; /** * @description Title * @example Finance Manager */ title?: string | null; }; CreateExportTaskResponseSchema: { /** Format: uuid */ id: string; }; CreateLocationRequest: { name: string; }; CreateOCRRequestPayload: { document_type?: components["schemas"]["OCRDocumentTypeEnum"]; file_url: string; }; CreateOnboardingLinkRequest: { recipient: components["schemas"]["Recipient"]; /** Format: uri */ refresh_url: string; /** Format: uri */ return_url: string; }; /** @description Request body for creating a new organization. */ CreateOrganizationRequestDto: { /** @description The organization's address. */ address: components["schemas"]["AddressDto"]; /** @description The display name of the organization. */ displayName: string; /** @description The organization's primary email address. */ email: string; /** @description The official legal name of the organization. */ legalName: string; /** @description The merchant category codes allowed for this organization. */ mccsAllowed: string[]; /** @description The organization's phone number. */ phoneNumber?: null | string; /** @description A short alphanumeric identifier for the organization (letters, digits, and hyphens only). */ shortName: string; /** @description The organizational type. */ type: components["schemas"]["CreateOrganizationType"]; }; /** @description Response DTO returned when a new organization is successfully created. */ CreateOrganizationResponseDto: { /** * Format: uuid * @description The unique identifier of the newly created organization. */ id: string; /** @description The organization's address. */ address: components["schemas"]["AddressDto"]; /** @description The display name of the organization. */ displayName: string; /** @description The organization's primary email address. */ email: string; /** @description Whether the organization is currently enabled. */ isEnabled: boolean; /** @description The legal name of the organization. */ legalName: string; /** @description The merchant category codes allowed for this organization. */ mccsAllowed: string[]; /** @description The organization's phone number, if provided. */ phoneNumber?: null | string; /** @description The short identifier for the organization. */ shortName: string; /** @description The types assigned to the organization. */ types: components["schemas"]["OrganizationType"][]; }; /** * @description The organization types that may be created via the API. * @enum {string} */ CreateOrganizationType: "EMBEDDED" | "TRANSACTOR" | "VERTICAL_SOFTWARE_PROVIDER"; CreatePaymentFeePayload: { /** @example USD */ currency: components["schemas"]["CurrencyEnum"]; /** @example 400 */ fee_max_amount?: number; /** @example 20 */ fee_min_amount?: number; monite_fee: components["schemas"]["Fee"]; /** @default payer */ paid_by: components["schemas"]["PaidBy"]; partner_fee: components["schemas"]["Fee"]; payment_method: components["schemas"]["MoniteAllPaymentMethodsTypes"]; payment_method_subtype?: components["schemas"]["PaymentMethodSubtype"]; /** @example US */ region: components["schemas"]["FeeRegion"]; /** * Format: uuid * @description Tier id */ tier_id?: string; }; CreatePaymentLinkRequest: { /** * @description The payment amount in [minor units](https://docs.monite.com/references/currencies#minor-units). Required if `object` is not specified. * @example 120550 */ amount?: number; /** * @description The payment currency. Required if `object` is not specified. * @example USD */ currency?: components["schemas"]["CurrencyEnum"]; /** Format: date-time */ expires_at?: string; /** @description An object containing information about the invoice being paid. Used only if `object` is not specified. */ invoice?: components["schemas"]["Invoice"]; /** @description If the invoice being paid is a payable or receivable stored in Monite, provide the `object` object containing the invoice type and ID. Otherwise, use the `amount`, `currency`, `payment_reference`, and (optionally) `invoice` fields to specify the invoice-related data. */ object?: components["schemas"]["PaymentObject"]; payment_methods: components["schemas"]["MoniteAllPaymentMethodsTypes"][]; /** * @description A payment reference number that the recipient can use to identify the payer or purpose of the transaction. Required if `object` is not specified. * @example 011/7057/26072 */ payment_reference?: string; recipient: components["schemas"]["PaymentAccountObject"]; /** * Format: uri * @description The URL where to redirect the payer after the payment. If `return_url` is specified, then after the payment is completed the payment page will display the "Return to platform" link that navigates to this URL. * @example https://pay.example.com/complete */ return_url?: string; }; CreatePaymentTierPayload: { /** @example 500 */ higher_range: number; /** @example 100 */ lower_range: number; measure_unit: components["schemas"]["MeasureUnitEnum"]; period: components["schemas"]["PeriodEnum"]; }; CreateRecurrencePayload: { /** * @description Controls how invoices are processed when generated: * - "draft": Creates invoices in draft status, requiring manual review, issuing, and sending * - "issue": Automatically issues invoices but requires manual sending * - "issue_and_send": Fully automates the process (creates, issues, and sends invoices) * * Default: "issue" (or "issue_and_send" if subject_text and body_text are provided) * * Note: When using "issue_and_send", both subject_text and body_text must be provided. */ automation_level?: components["schemas"]["AutomationLevel"]; /** @description The body text for the email that will be sent with the recurring invoice. */ body_text?: string; /** * @deprecated * @description Deprecated, use `start_date` instead */ day_of_month?: components["schemas"]["DayOfMonth"]; /** * Format: date * @description The end date of the recurring invoice, in the `yyyy-mm-dd` format. The end date is inclusive, that is, the last invoice will be created on this date if the last occurrence falls on this date. `end_date` is mutually exclusive with `max_occurrences`. Either `end_date` or `max_occurrences` must be specified. */ end_date?: string; /** * @deprecated * @description Deprecated, use `end_date` instead */ end_month?: number; /** * @deprecated * @description Deprecated, use `end_date` instead */ end_year?: number; /** * @description How often the invoice will be created. * @default month */ frequency: components["schemas"]["RecurrenceFrequency"]; /** * @description The interval between each occurrence of the invoice. For example, when using monthly frequency, an interval of 1 means invoices will be created every month, an interval of 2 means invoices will be created every 2 months. * @default 1 */ interval: number; /** * Format: uuid * @description ID of the base invoice that will be used as a template for creating recurring invoices. */ invoice_id: string; /** @description How many times the recurring invoice will be created. The recurrence will stop after this number is reached. `max_occurrences` is mutually exclusive with `end_date`. Either `max_occurrences` or `end_date` must be specified. */ max_occurrences?: number; /** @description An object containing the recipients (To, CC, BCC) of the recurring invoices. Can be omitted if the base invoice has the counterpart contact email specified in the `counterpart_contact.email` field. */ recipients?: components["schemas"]["Recipients"]; /** * Format: date * @description The date when the first invoice will be created, in the `yyyy-mm-dd` format. Cannot be a past date. Subsequent invoice dates will be calculated based on `start_date`, `frequency`, and `interval`. */ start_date?: string; /** * @deprecated * @description Deprecated, use `start_date` instead */ start_month?: number; /** * @deprecated * @description Deprecated, use `start_date` instead */ start_year?: number; /** @description The subject for the email that will be sent with the recurring invoice. */ subject_text?: string; }; CreateRoleRequest: { /** @description Role name */ name: string; /** @description Access permissions */ permissions: components["schemas"]["BizObjectsSchema-Input"]; }; CreateRoleRequestDto: { appliesToOrgType?: null | components["schemas"]["OrganizationType"]; description?: null | string; key: string; name: string; }; CreateTextTemplatePayload: { document_type: components["schemas"]["TextTemplateDocumentTypeEnum"]; name: string; template: string; type: components["schemas"]["TextTemplateType"]; }; CreateUserRequestDto: { address1?: null | string; address2?: null | string; city?: null | string; country?: null | string; email: string; isExpenseApprover?: boolean; jobTitle?: null | string; name: string; /** * @description Permission GUIDs to grant the user. Mutually exclusive with `permissionKeys`; * exactly one must be supplied. Prefer `permissionKeys` for new integrations. */ permissionIds?: null | string[]; /** * @description Permission keys (e.g. `"user:write:org"`) to grant the user. Resolved server-side to the * underlying permission IDs. Mutually exclusive with `permissionIds`; exactly one * must be supplied. */ permissionKeys?: null | components["schemas"]["PermissionKey"][]; phoneNumber?: null | string; postalCode?: null | string; redirectUri?: null | string; /** Format: uuid */ reportingManagerUserId?: null | string; stateOrProvince?: null | string; status: string; }; CreateUserResponseDto: { /** Format: uuid */ id: string; /** Format: date-time */ createdAt: string; email: string; isExpenseApprover: boolean; jobTitle?: null | string; name: string; /** Format: uuid */ organizationId: string; /** Format: uuid */ reportingManagerUserId?: null | string; status: string; }; CreateWebhookSubscriptionRequest: { event_types?: string[]; object_type: components["schemas"]["WebhookObjectType"]; /** Format: uri */ url: string; }; /** * @description Input model for applicant information on a credit card application. Inherits the shared * applicant fields from BankAccountApplicantInput and adds the credit-card-specific * underwriting fields. Keeping these off the shared input ensures the bank-account routes, which * reuse BankAccountApplicantInput, neither accept nor advertise fields they do not persist. */ CreditCardApplicantInput: { authentication?: components["schemas"]["OptionalOfAuthenticationInput"]; birthDate?: components["schemas"]["OptionalOfDateOnly"]; firstName?: components["schemas"]["OptionalOfstring"]; hasAcceptedDisclosures?: components["schemas"]["OptionalOfboolean"]; homeAddress?: components["schemas"]["OptionalOfAddressInput"]; isLegallyAuthorized?: components["schemas"]["OptionalOfboolean"]; lastName?: components["schemas"]["OptionalOfstring"]; mobilePhoneNumber?: components["schemas"]["OptionalOfstring"]; /** @description Applicant's monthly rent or mortgage payment in cents. Used by the card issuer for credit underwriting. */ monthlyHousingPayment?: components["schemas"]["OptionalOflong"]; ownershipPercentage?: components["schemas"]["OptionalOfdecimal"]; personalIdentificationNumber?: components["schemas"]["OptionalOfPersonalIdentificationNumberDto"]; /** @description Applicant's total annual income in cents. Used by the card issuer for credit underwriting. */ totalAnnualIncome?: components["schemas"]["OptionalOflong"]; workEmailAddress?: components["schemas"]["OptionalOfstring"]; }; /** * @description Output model for applicant information in credit card application responses. Inherits the * shared applicant fields from BankAccountApplicantOutput and adds the * credit-card-specific underwriting fields, so the bank-account response contract stays clean. */ CreditCardApplicantOutput: { /** * Format: date * @description Date of birth of the applicant. */ birthDate?: null | string; /** * Format: date-time * @description Timestamp when disclosures were accepted. */ disclosuresAcceptedAtDateTime?: null | string; /** @description First name of the applicant. */ firstName?: null | string; /** @description Indicates whether disclosures have been accepted. */ hasAcceptedDisclosures?: null | boolean; homeAddress?: null | components["schemas"]["AddressOutput"]; /** @description Indicates whether the applicant is legally authorized. */ isLegallyAuthorized?: null | boolean; /** @description Last name of the applicant. */ lastName?: null | string; /** @description Mobile phone number of the applicant. */ mobilePhoneNumber?: null | string; /** * Format: int64 * @description Applicant's monthly rent or mortgage payment in cents. */ monthlyHousingPayment?: null | number | string; /** * Format: double * @description Ownership percentage as a decimal between 0 and 1 (e.g., 25% = 0.25). */ ownershipPercentage?: null | number | string; /** * Format: int64 * @description Applicant's total annual income in cents. */ totalAnnualIncome?: null | number | string; /** @description Work email address of the applicant. */ workEmailAddress?: null | string; }; /** @description Response model for a credit card application. */ CreditCardApplicationResponse: { /** * Format: uuid * @description Unique identifier for the credit card application. */ id: string; applicant?: null | components["schemas"]["CreditCardApplicantOutput"]; businessDetails?: null | components["schemas"]["CreditCardBusinessDetailsOutput"]; /** @description List of business owners associated with the application. */ businessOwners?: null | components["schemas"]["BusinessOwnerOutput"][]; /** @description Current status of the credit card application. */ status?: components["schemas"]["CreditCardApplicationStatusDto"]; verifyBusinessStatus?: null | components["schemas"]["BusinessVerificationStatusDto"]; }; /** * @description Status of a credit card application. * @enum {string} */ CreditCardApplicationStatusDto: "DRAFT" | "SUBMITTED" | "PENDING_UNDERWRITING" | "APPROVED" | "APPROVED_PENDING_PROVISIONING" | "REJECTED" | "CANCELLED"; /** * @description Input model for business details on a credit card application. Inherits the shared fields * from BusinessDetailsInput and adds credit-underwriting-specific fields, all * wrapped in `Optional<T?>` for partial-update three-state semantics. */ CreditCardBusinessDetailsInput: { address?: components["schemas"]["OptionalOfAddressInput"]; /** @description Annual business revenue in cents. Used by the card issuer for credit underwriting. */ annualBusinessRevenue?: components["schemas"]["OptionalOflong"]; businessStructureType?: components["schemas"]["OptionalOfBusinessStructureType"]; /** @description Company type as expected by the card issuer. */ companyType?: components["schemas"]["OptionalOfstring"]; dbaName?: components["schemas"]["OptionalOfstring"]; /** @description Expected monthly card spend in cents. Used by the card issuer for credit limit determination. */ estimatedMonthlySpend?: components["schemas"]["OptionalOflong"]; formationDate?: components["schemas"]["OptionalOfDateOnly"]; legalName?: components["schemas"]["OptionalOfstring"]; northAmericanIndustryClassificationSystemCode?: components["schemas"]["OptionalOfNorthAmericanIndustryClassificationSystemCode"]; /** @description Number of employees at the business. */ numberOfEmployees?: components["schemas"]["OptionalOfint"]; /** @description Ownership classification as expected by the card issuer. */ ownership?: components["schemas"]["OptionalOfstring"]; phoneNumber?: components["schemas"]["OptionalOfstring"]; taxId?: components["schemas"]["OptionalOfTaxIdentificationNumberInput"]; website?: components["schemas"]["OptionalOfstring"]; }; /** * @description Output model for business details in credit card application responses. * Inherits the shared output fields from BusinessDetailsOutput. * FormationDate and TaxId are intentionally write-only inputs and are not * echoed on the response, matching the bank account application pattern * (PII minimization on the response path). */ CreditCardBusinessDetailsOutput: { address?: null | components["schemas"]["AddressOutput"]; /** * Format: int64 * @description Annual business revenue in cents. */ annualBusinessRevenue?: null | number | string; businessStructureType?: null | components["schemas"]["BusinessStructureType"]; /** @description Company type as expected by the card issuer. */ companyType?: null | string; /** @description Doing Business As (DBA) name. */ dbaName?: null | string; /** * Format: int64 * @description Expected monthly card spend in cents. */ estimatedMonthlySpend?: null | number | string; /** @description Legal business name. */ legalName?: null | string; northAmericanIndustryClassificationSystemCode?: null | components["schemas"]["NorthAmericanIndustryClassificationSystemCode"]; /** * Format: int32 * @description Number of employees at the business. */ numberOfEmployees?: null | number | string; /** @description Ownership classification as expected by the card issuer. */ ownership?: null | string; /** @description Business phone number. */ phoneNumber?: null | string; /** @description Business website URL. */ website?: null | string; }; /** @enum {string} */ CreditCardCloseReason: "TERMINATED_EMPLOYEE" | "VOLUNTARY_CLOSURE"; /** @enum {string} */ CreditCardFormat: "PHYSICAL" | "DIGITAL"; CreditCardResponse: { /** Format: uuid */ id: string; /** Format: int64 */ cardLimit?: null | number | string; cardStatus: components["schemas"]["CreditCardStatus"]; cardType: components["schemas"]["CreditCardType"]; cardholderName: string; /** Format: date-time */ createdAt: string; currentBalance: components["schemas"]["AmountOutput"]; description?: null | string; lastFourDigits: string; nickname?: null | string; /** Format: date-time */ updatedAt: string; /** Format: uuid */ userId: string; }; /** @enum {string} */ CreditCardStatus: "PENDING_ACTIVATION" | "ACTIVE" | "LOCKED" | "CLOSED"; /** * @description Direction of money movement for a credit card transaction, relative to the cardholder's balance. * @enum {string} */ CreditCardTransactionDirection: "DEBIT" | "CREDIT"; /** * @description A single credit card transaction. Mirrors the bank-account transaction response so partners can * render a unified ledger across both products: monetary values use the shared * AmountOutput (value in minor units + ISO 4217 currency) rather than a bare integer. */ CreditCardTransactionResponse: { /** @description Absolute transaction amount; use CreditCardTransactionDirection CreditCardTransactionResponse.Direction for the sign. */ amount: components["schemas"]["AmountOutput"]; /** * Format: uuid * @description The credit card this transaction belongs to. */ cardId: string; /** * Format: date * @description Transaction date as reported by TSYS. */ date: string; /** @description Raw merchant descriptor / memo. */ description: string; /** @description Whether the transaction is a DEBIT (charge) or CREDIT (refund / payment / reward). */ direction: components["schemas"]["CreditCardTransactionDirection"]; /** @description Last four digits of the card PAN (the full PAN is never returned). */ lastFourDigits: string; /** @description 4-digit merchant category code when available. */ merchantCategoryCode?: null | string; /** @description Cleaned merchant name when available. */ merchantName?: null | string; /** * Format: date * @description Date the transaction posted; `null` while pending. */ postedDate?: null | string; runningBalance?: null | components["schemas"]["AmountOutput"]; /** @description Posting status: PENDING, POSTED, DECLINED or REVERSED. */ status: components["schemas"]["CreditCardTransactionStatus"]; /** @description Business classification of the transaction. */ transactionType: components["schemas"]["CreditCardTransactionType"]; }; /** * @description Lifecycle status of a credit card transaction as projected from TSYS posting data. * @enum {string} */ CreditCardTransactionStatus: "PENDING" | "POSTED" | "DECLINED" | "REVERSED"; /** * @description Business classification of a credit card transaction, normalised from the TSYS transaction type. * @enum {string} */ CreditCardTransactionType: "PURCHASE" | "REFUND" | "PAYMENT" | "FEE" | "INTEREST" | "ADJUSTMENT" | "OTHER"; /** @enum {string} */ CreditCardType: "DIGITAL" | "PHYSICAL"; /** @description Schema for creating a new credit note. */ CreditNoteCreateRequest: { /** * Format: uuid * @description ID of the payable this credit note is based on. The credit note will be linked to this payable * @example 123e4567-e89b-12d3-a456-426614174000 */ based_on?: string; /** * @description The document ID of the original payable that this credit note refers to * @example INV-2287 */ based_on_document_id?: string; /** * Format: uuid * @description The ID of the counterpart's address * @example 123e4567-e89b-12d3-a456-426614174000 */ counterpart_address_id?: string; /** * Format: uuid * @description The ID of the counterpart's bank account * @example 123e4567-e89b-12d3-a456-426614174000 */ counterpart_bank_account_id?: string; /** * Format: uuid * @description The ID of the counterpart (vendor/supplier) * @example 123e4567-e89b-12d3-a456-426614174000 */ counterpart_id?: string; /** * Format: uuid * @description The ID of the counterpart's VAT registration * @example 123e4567-e89b-12d3-a456-426614174000 */ counterpart_vat_id_id?: string; /** * @description The currency code of the credit note * @default EUR * @example USD */ currency: components["schemas"]["CurrencyEnum"]; /** * @description An arbitrary description of this credit note * @example Credit note for returned items from invoice INV-2287 */ description?: string; /** * @description A unique credit note number assigned by the credit note issuer for tracking purposes * @example CN-2287 */ document_id: string; /** * Format: date * @description The date when the credit note was issued, in the YYYY-MM-DD format * @example 2024-01-15 */ issued_at: string; /** * Format: uuid * @description The ID of the project this credit note belongs to * @example 123e4567-e89b-12d3-a456-426614174000 */ project_id?: string; /** * @description The email address from which the credit note was received * @example supplier@example.com */ sender?: string; /** * @description The subtotal amount before taxes * @example 1000 */ subtotal?: number; /** * @description List of tag IDs associated with this credit note * @example [ * "123e4567-e89b-12d3-a456-426614174000" * ] */ tag_ids?: string[]; /** * @description The tax percentage applied to the subtotal * @example 20 */ tax?: number; /** * @description The calculated tax amount * @example 200 */ tax_amount?: number; /** * @description The total amount including taxes * @example 1200 */ total_amount?: number; }; /** @enum {string} */ CreditNoteCursorFields: "id" | "created_at"; /** @enum {string} */ CreditNoteDimensionEnum: "created_at" | "status" | "counterpart_id" | "currency" | "issued_at" | "project_id"; /** @enum {string} */ CreditNoteFieldsAllowedForValidate: "currency" | "document_id" | "issued_at" | "tax_amount" | "based_on" | "total_amount" | "subtotal" | "description" | "tax" | "file_id" | "counterpart_id" | "counterpart_bank_account_id" | "counterpart_address_id" | "counterpart_vat_id_id" | "line_items" | "line_items.quantity" | "line_items.unit_price" | "line_items.tax" | "line_items.unit" | "line_items.name" | "line_items.description" | "line_items.subtotal" | "line_items.total" | "line_items.tax_amount"; /** @description Schema for creating a new credit note line item. */ CreditNoteLineItemCreateRequest: { /** * @description Detailed description of the line item * @example Premium version of Product XYZ with extended warranty */ description?: string; /** * @description Name or title of the line item * @example Product XYZ */ name?: string; /** * @description Quantity of items * @example 2 */ quantity?: number; /** * @description Tax rate in percent [minor units](https://docs.monite.com/references/currencies#minor-units). Example: 12.5% is 1250. * @example 1250 */ tax?: number; /** * @description Unit of measurement * @example pieces */ unit?: string; /** * @description Price per unit in smallest currency unit (e.g. cents) * @example 5000 */ unit_price?: number; }; /** @enum {string} */ CreditNoteLineItemCursorFields: "id" | "created_at" | "name" | "total" | "quantity" | "unit_price"; /** @description A paginated list of credit note line items. */ CreditNoteLineItemPaginationResponse: { /** @description List of credit note line items for the current page */ data: components["schemas"]["CreditNoteLineItemResponse"][]; /** * @description Token to retrieve the next page of results * @example eyJwYWdlIjoyfQ== */ next_pagination_token?: string; /** * @description Token to retrieve the previous page of results * @example eyJwYWdlIjoxfQ== */ prev_pagination_token?: string; }; /** @description Schema for replacing all line items of a credit note. */ CreditNoteLineItemReplaceRequest: { /** @description List of credit note line items to replace existing ones */ data: components["schemas"]["CreditNoteLineItemCreateRequest"][]; }; /** @description Schema for credit note line item response. Includes all fields that can be returned from the API. */ CreditNoteLineItemResponse: { /** * Format: uuid * @description Unique identifier of the line item * @example 123e4567-e89b-12d3-a456-426614174000 */ id: string; /** * Format: date-time * @description Timestamp when the line item was created * @example 2024-01-15T14:30:00Z */ created_at: string; /** * Format: date-time * @description Timestamp when the line item was last updated * @example 2024-01-15T14:30:00Z */ updated_at: string; /** * Format: uuid * @description ID of the user who created the line item * @example 123e4567-e89b-12d3-a456-426614174000 */ created_by_user_id?: string; /** * Format: uuid * @description ID of the parent credit note * @example 123e4567-e89b-12d3-a456-426614174000 */ credit_note_id: string; /** * @description Detailed description of the line item * @example Premium version of Product XYZ with extended warranty */ description?: string; /** * @description Name or title of the line item * @example Product XYZ */ name?: string; /** * @description Quantity of items * @example 2 */ quantity?: number; /** * @description Subtotal amount before tax * @example 10000 */ subtotal?: number; /** * @description Tax percentage * @example 20 */ tax?: number; /** * @description Tax amount * @example 2000 */ tax_amount?: number; /** * @description Total amount including tax * @example 12000 */ total?: number; /** * @description Unit of measurement * @example pieces */ unit?: string; /** * @description Price per unit in smallest currency unit * @example 5000 */ unit_price?: number; }; /** @description Schema for updating an existing credit note line item. All fields are optional. */ CreditNoteLineItemUpdateRequest: { /** * @description Detailed description of the line item * @example Premium version of Product XYZ with extended warranty */ description?: string; /** * @description Name or title of the line item * @example Product XYZ */ name?: string; /** * @description Quantity of items * @example 2 */ quantity?: number; /** * @description Tax rate in percent [minor units](https://docs.monite.com/references/currencies#minor-units). Example: 12.5% is 1250. * @example 1250 */ tax?: number; /** * @description Unit of measurement * @example pieces */ unit?: string; /** * @description Price per unit in smallest currency unit * @example 5000 */ unit_price?: number; }; /** @enum {string} */ CreditNoteMetricEnum: "id" | "total_amount"; /** @description A paginated list of credit notes. */ CreditNotePaginationResponse: { /** @description List of credit notes for the current page */ data: components["schemas"]["CreditNoteResponse"][]; /** * @description Token to retrieve the next page of results * @example eyJwYWdlIjoyfQ== */ next_pagination_token?: string; /** * @description Token to retrieve the previous page of results * @example eyJwYWdlIjoxfQ== */ prev_pagination_token?: string; }; CreditNoteRenderingSettings: { /** * @description If set to `true`, the organization's bank account details will be displayed on the credit note PDF. * @default true */ display_organization_bank_account: boolean; }; /** @description Schema for credit note response. Includes all fields that can be returned from the API. */ CreditNoteResponse: { /** * Format: uuid * @description The unique identifier of the credit note * @example 123e4567-e89b-12d3-a456-426614174000 */ id: string; /** * Format: date-time * @description Date and time when the credit note was created in the system * @example 2024-01-15T14:30:00Z */ created_at: string; /** * Format: date-time * @description Date and time of the last update to the credit note * @example 2024-01-15T14:30:00Z */ updated_at: string; /** * Format: uuid * @description ID of the payable this credit note is based on * @example 123e4567-e89b-12d3-a456-426614174000 */ based_on?: string; /** * @description The document ID of the original payable that this credit note refers to * @example INV-2287 */ based_on_document_id?: string; /** @description Object representing de-normalized counterpart data */ counterpart?: components["schemas"]["CounterpartRawData"]; /** * Format: uuid * @description ID of the counterpart's address * @example 123e4567-e89b-12d3-a456-426614174000 */ counterpart_address_id?: string; /** * Format: uuid * @description ID of the counterpart's bank account * @example 123e4567-e89b-12d3-a456-426614174000 */ counterpart_bank_account_id?: string; /** * Format: uuid * @description ID of the counterpart * @example 123e4567-e89b-12d3-a456-426614174000 */ counterpart_id?: string; /** @description Object representing counterpart data which was extracted by OCR. Used for informational purposes. */ counterpart_raw?: components["schemas"]["CounterpartRawData"]; /** * Format: uuid * @description ID of the counterpart's VAT registration * @example 123e4567-e89b-12d3-a456-426614174000 */ counterpart_vat_id_id?: string; /** * @description External system's user ID for the creator * @example ext_user_123 */ created_by_external_user_id?: string; /** * @description Name of the external user who created the credit note * @example John Doe */ created_by_external_user_name?: string; /** * Format: uuid * @description ID of the user who created the credit note * @example 123e4567-e89b-12d3-a456-426614174000 */ created_by_user_id?: string; /** * @description The currency code * @example USD */ currency?: string; currency_exchange?: components["schemas"]["CurrencyExchangeSchema"]; /** * @description Description of the credit note * @example Credit note for returned items from invoice INV-2287 */ description?: string; /** * @description The credit note's unique document number * @example CN-2287 */ document_id?: string; /** * Format: uuid * @description The ID of the entity to which the credit note belongs * @example 123e4567-e89b-12d3-a456-426614174000 */ entity_id: string; /** * Format: uuid * @description The id of the credit note file stored in the file saver. * @example 123e4567-e89b-12d3-a456-426614174000 */ file_id?: string; /** @description The URL of the credit note file stored in the file saver. */ file_url?: string; /** * Format: date * @description Date when the credit note was issued * @example 2024-01-15 */ issued_at?: string; /** * Format: uuid * @description ID of the OCR processing request * @example 123e4567-e89b-12d3-a456-426614174000 */ ocr_request_id?: string; /** * @description Status of OCR processing * @example completed */ ocr_status?: string; /** * @description The origin or source system of the credit note * @example SAP */ origin: string; /** * Format: uuid * @description ID of the associated project * @example 123e4567-e89b-12d3-a456-426614174000 */ project_id?: string; /** * @description Email address of the sender * @example supplier@example.com */ sender?: string; /** * @description How the data was input (ocr/user_specified) * @example user_specified */ source_of_data: string; /** * @description The current status of the credit note in its lifecycle * @example submitted_for_approval */ status: string; /** * @description The subtotal amount before taxes * @example 1000 */ subtotal?: number; /** * @description List of tags associated with this credit note * @example [ * { * "id": "123e4567-e89b-12d3-a456-426614174000", * "name": "Department A", * "category": "department" * } * ] */ tags?: components["schemas"]["TagReadSchema"][]; /** * @description The tax percentage * @example 20 */ tax?: number; /** * @description The calculated tax amount * @example 200 */ tax_amount?: number; /** * @description The total amount including taxes * @example 1200 */ total_amount?: number; }; CreditNoteResponsePayload: { /** Format: uuid */ id: string; /** * Format: date-time * @description Time at which the receivable was created. Timestamps follow the ISO 8601 standard. */ created_at: string; /** * Format: date-time * @description Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard. */ updated_at: string; /** @description List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. */ attachments?: components["schemas"]["AttachmentResponse"][]; /** Format: uuid */ bank_account_id?: string; bank_account_snapshot?: components["schemas"]["BankAccountSnapshot"]; bank_account_type?: string; /** * Format: uuid * @description The unique ID of a previous document related to the receivable if applicable. */ based_on?: string; /** @description The unique document ID of a previous document related to the receivable if applicable. */ based_on_document_id?: string; /** @description The commercial terms of the receivable (e.g. The products must be delivered in X days). */ commercial_condition_description?: string; /** @description Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. */ counterpart_billing_address?: components["schemas"]["ReceivablesRepresentationOfCounterpartAddress"]; /** @description Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. */ counterpart_business_type?: string; /** @description Additional information about counterpart contacts. */ counterpart_contact?: components["schemas"]["ReceivableCounterpartContact"]; /** @description The external reference of the counterpart. */ counterpart_external_reference?: string; /** * Format: uuid * @description Unique ID of the counterpart. */ counterpart_id: string; /** @description A legal name of a counterpart it is an organization or first and last name if it is an individual */ counterpart_name?: string; /** @description Address where goods were shipped / where services were provided. */ counterpart_shipping_address?: components["schemas"]["ReceivablesRepresentationOfCounterpartAddress"]; /** @description The VAT/TAX ID of the counterpart. */ counterpart_tax_id?: string; /** @description The type of the counterpart. */ counterpart_type: components["schemas"]["CounterpartType"]; counterpart_vat_id?: components["schemas"]["ReceivableCounterpartVatIDResponse"]; /** @description The currency used in the receivable. */ currency: components["schemas"]["CurrencyEnum"]; /** * @deprecated * @description The amount of tax deducted in minor units */ deduction_amount?: number; /** * @deprecated * @description A note with additional information about a tax deduction */ deduction_memo?: string; /** @description List of deductions applied to the receivable (maximum 10 deductions allowed) */ deductions?: components["schemas"]["DeductionItem"][]; /** @description The discount for a receivable. */ discount?: components["schemas"]["DiscountResponse"]; /** @description Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units). */ discounted_subtotal?: number; /** @description The sequential code systematically assigned to invoices. */ document_id?: string; /** @description Settings for rendering documents in PDF format, including settings for line items and specific document types. */ document_rendering?: components["schemas"]["DocumentRenderingSettings"]; /** * Format: date * @description Optional field representing date until which invoice should be paid */ due_date?: string; entity: components["schemas"]["ReceivableEntityOrganization"] | components["schemas"]["ReceivableEntityIndividual"]; entity_address: components["schemas"]["ReceivableEntityAddressSchema"]; /** * @deprecated * @description Deprecated. Always null; use `bank_account_snapshot` instead. */ entity_bank_account?: components["schemas"]["ReceivablesRepresentationOfEntityBankAccount"]; /** * Format: uuid * @description The entity user who created this document. */ entity_user_id?: string; entity_vat_id?: components["schemas"]["ReceivableEntityVatIDResponse"]; /** @description The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated. */ file_language: components["schemas"]["LanguageCodeEnum"]; /** @description The receivable's PDF URL in the counterpart's default language. */ file_url?: string; /** @description Optional text displayed below the line items table in the PDF. */ footer?: string; /** * Format: date-time * @description Optional field for the issue of the entry. */ issue_date?: string; line_items: components["schemas"]["ResponseItem"][]; /** @description A note with additional information for a receivable. */ memo?: string; /** @description The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated. */ original_file_language: components["schemas"]["LanguageCodeEnum"]; /** @description The receivable's PDF URL in the entity's default language. */ original_file_url?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; /** * Format: uuid * @description A project related to current receivable */ project_id?: string; /** @description Contain purchase order number. */ purchase_order?: string; /** @description The status of the Credit Note inside the receivable workflow. */ status: components["schemas"]["CreditNoteStateEnum"]; /** @description The subtotal (excluding tax), in [minor units](https://docs.monite.com/references/currencies#minor-units). */ subtotal?: number; /** @description The subtotal including tax but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). */ subtotal_after_tax?: number; /** * @description The list of tags for this receivable. * @default [] */ tags: components["schemas"]["TagReadSchema"][]; /** @description Indicates whether the goods, materials, or services listed in the receivable are exempt from tax or not. */ tax_exempt?: boolean; /** @description The reason for the tax exemption, if applicable. */ tax_exemption_rationale?: string; /** * @description Indicates whether the discount is applied to the tax-inclusive or tax-exclusive amount. * @default exclusive */ tax_inclusive_discount_mode: components["schemas"]["VatModeEnum"]; /** * @description Defines whether the prices of products in receivable will already include tax or not. * @default exclusive */ tax_mode: components["schemas"]["VatModeEnum"]; /** * @description Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_tax_amount. * @default 0 */ total_amount: number; /** @description The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units). */ total_deduction_amount?: number; /** @description The total tax of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). */ total_tax_amount: number; /** @description List of total tax amount for each tax rate, presented in receivable */ total_tax_amounts?: components["schemas"]["TotalTaxAmountItem"][]; /** @description Total price of the receivable with tax withheld in minor units */ total_withholding_tax?: number; /** @description Trade name of the entity */ trade_name?: string; /** * @description The type of the receivable * @enum {string} */ type: "credit_note"; /** @description The amount of tax withheld in percent minor units */ withholding_tax_rate?: number; }; /** @enum {string} */ CreditNoteStateEnum: "draft" | "issuing" | "issued" | "failed" | "deleted"; /** @description Schema for updating an existing credit note. All fields are optional. */ CreditNoteUpdateRequest: { /** * Format: uuid * @description ID of the payable this credit note is based on. The credit note will be linked to this payable * @example 123e4567-e89b-12d3-a456-426614174000 */ based_on?: string; /** * @description The document ID of the original payable * @example INV-2287 */ based_on_document_id?: string; /** * Format: uuid * @description ID of the counterpart's address * @example 123e4567-e89b-12d3-a456-426614174000 */ counterpart_address_id?: string; /** * Format: uuid * @description ID of the counterpart's bank account * @example 123e4567-e89b-12d3-a456-426614174000 */ counterpart_bank_account_id?: string; /** * Format: uuid * @description ID of the counterpart * @example 123e4567-e89b-12d3-a456-426614174000 */ counterpart_id?: string; /** * Format: uuid * @description ID of the counterpart's VAT registration * @example 123e4567-e89b-12d3-a456-426614174000 */ counterpart_vat_id_id?: string; /** * @description The currency code of the credit note * @example USD */ currency?: components["schemas"]["CurrencyEnum"]; /** * @description An arbitrary description of this credit note * @example Credit note for returned items from invoice INV-2287 */ description?: string; /** * @description A unique credit note number assigned by the credit note issuer for tracking purposes * @example CN-2287 */ document_id?: string; /** * Format: date * @description The date when the credit note was issued, in the YYYY-MM-DD format * @example 2024-01-15 */ issued_at?: string; /** * Format: uuid * @description The ID of the project this credit note belongs to * @example 123e4567-e89b-12d3-a456-426614174000 */ project_id?: string; /** * @description Email address of the sender * @example supplier@example.com */ sender?: string; /** * @description The subtotal amount before taxes * @example 1000 */ subtotal?: number; /** * @description List of tag IDs associated with this credit note * @example [ * "123e4567-e89b-12d3-a456-426614174000" * ] */ tag_ids?: string[]; /** * @description The tax percentage applied to the subtotal * @example 20 */ tax?: number; /** * @description The calculated tax amount * @example 200 */ tax_amount?: number; /** * @description The total amount including taxes * @example 1200 */ total_amount?: number; }; CreditNoteUploadFile: { /** Format: binary */ file: Blob; }; CreditNoteValidationResponse: { /** * Format: uuid * @description A unique ID assigned to this credit note. */ id: string; validation_errors?: Record[]; }; CreditNoteValidationsResource: { required_fields: components["schemas"]["CreditNoteFieldsAllowedForValidate"][]; }; CurrencyDetails: { minor_units: number; name: string; symbol: string; }; /** @enum {string} */ CurrencyEnum: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HTG" | "HUF" | "IDR" | "ILS" | "INR" | "IQD" | "ISK" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SEK" | "SGD" | "SHP" | "SLE" | "SOS" | "SRD" | "SSP" | "SVC" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XOF" | "XPF" | "YER" | "ZAR" | "ZMW"; CurrencyExchangeSchema: { default_currency_code: string; rate: number; total: number; }; CurrencyExchangeSchema2: { default_currency_code: string; rate: number; total: number; }; "CurrencySettings-Input": { default: components["schemas"]["CurrencyEnum"]; exchange_rates?: (components["schemas"]["ExchangeRate"] | null)[]; }; "CurrencySettings-Input2": { default: components["schemas"]["CurrencyEnum"]; exchange_rates?: (components["schemas"]["ExchangeRate"] | null)[]; }; "CurrencySettings-Output": { default: components["schemas"]["CurrencyEnum"]; exchange_rates?: (components["schemas"]["ExchangeRate"] | null)[]; }; "CurrencySettings-Output2": { default: components["schemas"]["CurrencyEnum"]; exchange_rates?: (components["schemas"]["ExchangeRate"] | null)[]; }; /** @enum {string} */ CursorFields: "id" | "created_at"; CustomTaxRateRequest: { /** @description Sub-taxes included in the Custom VAT. */ components: components["schemas"]["VatRateComponent"][]; /** @description Display name of the Custom VAT. */ name: string; }; CustomTaxRateResponse: { /** Format: uuid */ id: string; /** * Format: date-time * @description Time at which the Custom tax rate was created. Timestamps follow the ISO 8601 standard. */ created_at: string; /** * Format: date-time * @description Time at which the Custom tax rate was last updated. Timestamps follow the ISO 8601 standard. */ updated_at: string; /** @description Sub-taxes included in the Custom VAT. */ components: components["schemas"]["VatRateComponent"][]; /** * Format: uuid * @description ID of the user that created the Custom tax rate */ created_by_entity_user_id?: string; /** @description Display name of the Custom VAT. */ name: string; /** @description Total sum of the Custom tax rate including components. Percent multiplied by a 100. Example: 12.125% is 1212.5. */ value: number; }; CustomTaxRateResponseList: { data: components["schemas"]["CustomTaxRateResponse"][]; }; CustomTaxRateUpdateRequest: { /** @description Sub-taxes included in the Custom VAT. */ components?: components["schemas"]["VatRateComponent"][]; /** @description Display name of the Custom VAT. */ name?: string; }; CustomTemplateDataSchema: { /** * Format: uuid * @description ID of email template */ id: string; /** * Format: date-time * @description Template created date and time */ created_at: string; /** * Format: date-time * @description Template updated date and time */ updated_at: string; /** @description Jinja2 compatible email body template */ body_template: string; /** @description Is default template */ is_default: boolean; /** @description Lowercase ISO code of language */ language: string; /** @description Name of the template */ name: string; /** @description Jinja2 compatible email subject template */ subject_template: string; /** @description Document type of content */ type: string; }; /** @enum {string} */ CustomTemplatesCursorFields: "type" | "name"; CustomTemplatesPaginationResponse: { /** @description All user-defined email templates */ data: components["schemas"]["CustomTemplateDataSchema"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; DNSRecord: { is_active: boolean; name?: string | null; /** @description Purpose of specific entry to distinguish between various TXT entries. */ record_purpose?: components["schemas"]["DNSRecordPurpose"] | null; record_type: components["schemas"]["DNSRecordType"]; /** @description Field reflecting validation status by Mailgun. */ valid: string; value: string; }; /** @enum {string} */ DNSRecordPurpose: "DKIM" | "SPF"; /** @enum {string} */ DNSRecordType: "TXT" | "MX" | "CNAME"; DNSRecords: { /** @description Set of DNS settings required by Mailgun for domain verification before emails receiving is possible. */ receiving_dns_records: components["schemas"]["DNSRecord"][]; /** @description Set of DNS settings required by Mailgun for domain verification before emails sending is possible. */ sending_dns_records: components["schemas"]["DNSRecord"][]; }; /** @enum {string} */ DataExportCursorFields: "created_at"; /** @enum {string} */ DateDimensionBreakdownEnum: "daily" | "weekly" | "monthly" | "quarterly" | "yearly"; /** @enum {string} */ DayOfMonth: "first_day" | "last_day"; DeductionItem: { /** @description The amount of the deduction in minor units(https://docs.monite.com/references/currencies#minor-units) */ amount: number; /** @description A note with additional information about this deduction */ memo?: string; /** @description Name or title of this deduction */ name: string; }; DefaultAccountingTaxIDs: { /** @description ID of the accounting tax ID with which all deductions will be pushed. */ deductions?: string | null; }; DefaultBankAccount: { /** * Format: uuid * @description The ID of the default bank account of the given `type`. */ id: string; /** @description The kind of bank account used as the organization's default. */ type: components["schemas"]["DefaultBankAccountType"]; }; /** @enum {string} */ DefaultBankAccountType: "INTERNAL" | "EXTERNAL" | "BANK_DETAILS"; DefaultLedgerAccountIDs: { /** @description ID of the ledger account to which all payment records will be pushed. Changing this value affects only future data pushes and does not affect payment records that already exist in the accounting system. */ payments?: string | null; /** @description ID of the ledger account to which products without a `ledger_account_id` specified will be pushed. Changing this value affects only future data pushes and does not affect products that already exist in the accounting system. */ products?: string | null; }; DeliveryNoteCounterpartResource: { /** * Format: uuid * @description ID of the counterpart */ id: string; /** @description Individual counterpart */ individual?: components["schemas"]["CounterpartIndividualResponse"]; /** @description The language used to generate pdf documents for this counterpart. */ language?: components["schemas"]["LanguageCodeEnum"]; /** @description Organization counterpart */ organization?: components["schemas"]["CounterpartOrganizationResponse"]; }; DeliveryNoteCreateBasedOnRequest: { /** * Format: uuid * @description The unique ID of a previous document related to the receivable if applicable. */ based_on: string; }; DeliveryNoteCreateLineItem: { /** @description Object of product. Can be used instead of product_id, created in product's catalog */ product?: components["schemas"]["DeliveryNoteLineItemProduct"]; /** * Format: uuid * @description Unique identifier of the product. */ product_id?: string; /** @description The quantity of each of the goods, materials, or services listed in the receivable. */ quantity: number; }; /** * @description Delivery Note creation request schema * @example { * "counterpart_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6", * "counterpart_address_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6", * "line_items": [ * { * "quantity": 10, * "product_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6" * }, * { * "quantity": 20, * "product": { * "name": "Product 2", * "description": "Description of product 2", * "measure_unit": { * "name": "pcs", * "description": "pieces" * } * } * } * ], * "delivery_date": "2025-01-01", * "delivery_number": "102-2025-0987", * "memo": "This is a memo", * "display_signature_placeholder": true * } */ DeliveryNoteCreateRequest: { /** * Format: uuid * @description ID of the counterpart address selected for the delivery note */ counterpart_address_id: string; /** * Format: uuid * @description ID of the counterpart */ counterpart_id: string; /** * Format: date * @description Date of delivery */ delivery_date?: string; /** @description Delivery number */ delivery_number?: string; /** * @description Whether to display a signature placeholder in the generated PDF * @default false */ display_signature_placeholder: boolean; /** @description Document ID of the delivery note */ document_id?: string; /** @description List of line items in the delivery note */ line_items: components["schemas"]["DeliveryNoteCreateLineItem"][]; /** @description Additional information regarding the delivery note */ memo?: string; }; /** @enum {string} */ DeliveryNoteCursorFields: "status" | "document_id" | "delivery_date" | "created_at"; DeliveryNoteLineItemProduct: { /** @description Description of the product. */ description?: string; measure_unit?: components["schemas"]["UnitRequest"]; /** @description Name of the product. */ name: string; }; DeliveryNoteLineItemResource: { product: components["schemas"]["DeliveryNoteLineItemProduct"]; /** @description The quantity of each of the goods, materials, or services listed in the receivable. */ quantity: number; }; DeliveryNoteRenderPayload: { /** * @default { * "account_holder_name_header": "Account holder", * "account_number_header": "Account number", * "bank_name_header": "Bank", * "bic_header": "BIC", * "iban_header": "IBAN", * "routing_number_header": "Routing number", * "sort_code_header": "Sort code" * } */ account_data: components["schemas"]["AccountDataBlock"]; /** * @default { * "external_reference_header": "Counterpart Reference", * "tax_id_header": "TAX ID" * } */ counterpart_info: components["schemas"]["CounterpartInfoBlock"]; /** * @default { * "based_invoice_number_header": "Invoice number", * "client_header": "Client", * "created_at_header": "Invoice date", * "delivery_date_header": "Delivery date", * "delivery_number_header": "Delivery number", * "document_id_header": "Document number", * "due_date_header": "Due date", * "fulfillment_date_header": "Fulfillment date", * "issue_date_header": "Issue date", * "paid_date_header": "Paid date", * "purchase_order_header": "Purchase order", * "quote_expires_header": "Quote expires", * "receivable_number_header": "Number" * } */ document_info: components["schemas"]["DocumentInfoBlock"]; /** * @default { * "tax_id_header": "TAX ID", * "vat_id_header": "VAT" * } */ entity_info: components["schemas"]["EntityInfoBlock"]; /** @default {} */ entity_logo: components["schemas"]["EntityLogoBlock"]; /** @default {} */ header: components["schemas"]["HeaderBlock"]; /** * @default { * "amounts_reduced": [], * "deductions": [], * "discount_header": "Discount", * "discounted_subtotal_header": "Discounted subtotal", * "line_items": [], * "subtotal_header": "Subtotal", * "table_headers": [], * "tax_inclusive_discount": false, * "tax_mode_inclusive": false, * "total_header": "Total", * "total_vat_header": "Total VAT", * "total_vats": [], * "withholding_tax_header": "Withholding tax" * } */ line_items: components["schemas"]["LineItemsBlock"]; /** @default {} */ memo: components["schemas"]["MemoBlock"]; /** * @default { * "for_preposition": "for", * "of_preposition": "of", * "page_text": "Page" * } */ page_counter: components["schemas"]["PageCounterBlock"]; signature?: components["schemas"]["SignatureBlock"]; /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ template_type: "delivery_note"; }; /** * @example { * "id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6", * "status": "created", * "created_at": "2022-01-01T00:00:00Z", * "updated_at": "2022-01-01T00:00:00Z", * "entity_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6", * "entity": { * "name": "Entity Name" * }, * "entity_address": { * "line1": "Entity Street", * "city": "Entity City", * "postal_code": "10001", * "country": "US" * }, * "created_by_entity_user_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6", * "counterpart_id": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6", * "counterpart": { * "name": "Counterpart Name" * }, * "counterpart_address": { * "line1": "Counterpart Street", * "city": "Counterpart City", * "postal_code": "10001", * "country": "US" * }, * "line_items": [ * { * "quantity": 20, * "product": { * "name": "Product Name", * "description": "Description of product", * "measure_unit": { * "name": "pcs", * "description": "Pieces" * } * } * } * ], * "document_id": "DN-2022-01-01-0001", * "delivery_date": "2022-01-01", * "delivery_number": "102-2022-0987", * "memo": "This is a memo", * "display_signature_placeholder": true, * "file_url": "https://example.com/delivery_note.pdf", * "original_file_url": "https://example.com/delivery_note_original.pdf", * "file_language": "en", * "original_file_language": "de", * "based_on": "a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6", * "based_on_document_id": "IN-2022-01-01-0001" * } */ DeliveryNoteResource: { /** * Format: uuid * @description Unique ID of the delivery note */ id: string; /** * Format: date-time * @description Time at which the delivery note was created. Timestamps follow the ISO 8601 standard. */ created_at: string; /** * Format: date-time * @description Time at which the delivery note was last updated. Timestamps follow the ISO 8601 standard. */ updated_at: string; /** * Format: uuid * @description The unique ID of a previous document related to the delivery note if applicable. */ based_on?: string; /** @description The unique document ID of a previous document related to the delivery note if applicable. */ based_on_document_id?: string; /** @description Counterpart of the delivery note */ counterpart: components["schemas"]["DeliveryNoteCounterpartResource"]; /** @description Address of the counterpart */ counterpart_address: components["schemas"]["ReceivablesCounterpartAddress"]; /** * Format: uuid * @description ID of the counterpart */ counterpart_id: string; /** * Format: uuid * @description ID of the user that created the delivery note */ created_by_entity_user_id?: string; /** * Format: date * @description Date of delivery */ delivery_date?: string; /** @description Delivery number */ delivery_number?: string; /** @description Whether to display a signature placeholder in the generated PDF */ display_signature_placeholder: boolean; /** @description Document ID of the delivery note */ document_id: string; /** @description Entity that created the delivery note */ entity: components["schemas"]["ReceivableEntityOrganization"] | components["schemas"]["ReceivableEntityIndividual"]; /** @description Address of the entity that created the delivery note */ entity_address: components["schemas"]["ReceivableEntityAddressSchema"]; /** * Format: uuid * @description ID of the entity that created the delivery note */ entity_id: string; /** @description The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated. */ file_language: components["schemas"]["LanguageCodeEnum"]; /** @description The delivery note's PDF URL in the customer-facing language. */ file_url?: string; /** @description List of line items in the delivery note */ line_items: components["schemas"]["DeliveryNoteLineItemResource"][]; /** @description Additional information regarding the delivery note */ memo?: string; /** @description The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated. */ original_file_language: components["schemas"]["LanguageCodeEnum"]; /** @description The delivery note's PDF URL in the entity's language. */ original_file_url?: string; /** @description Status of the delivery note */ status: components["schemas"]["DeliveryNoteStatusEnum"]; }; DeliveryNoteResourceList: { /** @description List of delivery notes */ data: components["schemas"]["DeliveryNoteResource"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; /** @enum {string} */ DeliveryNoteStatusEnum: "created" | "canceled" | "delivered"; /** @description Delivery Note update request schema */ DeliveryNoteUpdateRequest: { /** * Format: uuid * @description ID of the counterpart address selected for the delivery note */ counterpart_address_id?: string; /** * Format: uuid * @description ID of the counterpart */ counterpart_id?: string; /** * Format: date * @description Date of delivery */ delivery_date?: string; /** @description Delivery number */ delivery_number?: string; /** @description Whether to display a signature placeholder in the generated PDF */ display_signature_placeholder?: boolean; /** @description List of line items in the delivery note */ line_items?: components["schemas"]["DeliveryNoteCreateLineItem"][]; /** @description Additional information regarding the delivery note */ memo?: string; }; DepartmentDetail: { /** Format: uuid */ id: string; /** Format: date-time */ createdDateTime: string; members: components["schemas"]["PaginatedResponseOfDepartmentMember"]; name: string; /** Format: date-time */ updatedDateTime: string; }; DepartmentListItem: { /** Format: uuid */ id: string; /** Format: date-time */ createdDateTime: string; /** Format: int32 */ memberCount: number | string; name: string; /** Format: date-time */ updatedDateTime: string; }; DepartmentMember: { /** Format: uuid */ id: string; /** Format: date-time */ createdDateTime: string; email: string; jobTitle?: null | string; /** Format: date-time */ lastLoggedInDateTime?: null | string; name: string; status: string; }; DisabledPaymentRailsResponseDto: { disabledPaymentRails: string[]; /** Format: uuid */ organizationId: string; }; /** @description Response model for disclosure acceptance. */ DisclosureAcceptanceResponse: { /** * Format: date-time * @description The timestamp when the disclosures were accepted. */ acceptedAt: string; /** * Format: uuid * @description The user ID that accepted the disclosures. */ userId: string; }; Discount: { /** @description The actual discount of the product in [minor units](https://docs.monite.com/references/currencies#minor-units) if type field equals amount, else in percent minor units */ amount: number; /** @description The field specifies whether to use product currency or %. */ type: components["schemas"]["DiscountType"]; }; DiscountResponse: { /** @description The actual discount of the product in [minor units](https://docs.monite.com/references/currencies#minor-units) if type field equals amount, else in percent minor units */ amount: number; /** @description The field specifies whether to use product currency or %. */ type: components["schemas"]["DiscountType"]; /** @description The monetary amount of the discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). If the discount `type` is `amount`, this value is the same as the `amount` value. If `type` is `percentage`, the value is the calculated discount amount. */ value?: number; }; /** @enum {string} */ DiscountType: "amount" | "percentage"; DocumentExportResponseSchema: { /** Format: uuid */ id: string; count: number; /** Format: uuid */ created_by_entity_user_id?: string; /** Format: date-time */ end_datetime?: string; /** Format: uuid */ entity_id: string; format: string; language: string; /** Format: uri */ source_url?: string; /** Format: date-time */ start_datetime?: string; status: string; }; /** @enum {string} */ DocumentIDSeparators: "/" | "-" | "|" | "." | ""; DocumentIDsSettings: { /** * @description Prefixes for each document_type. * @default { * "credit_note": "CN", * "delivery_note": "DN", * "invoice": "INV", * "purchase_order": "PO", * "quote": "Q" * } */ document_type_prefix: components["schemas"]["DocumentTypePrefix"]; /** * @description Optionally add 4-digit of the current year. * @default false */ include_date: boolean; /** * @description Minimal size of number in document ID Number will be left padded with zeros if less. * @default 5 */ min_digits: number; /** @description Optional prefix. Does not substitute document_type prefix. */ prefix?: string | null; /** * @description Which character should separate each part of the document_id. * @default - */ separator: components["schemas"]["DocumentIDSeparators"]; }; DocumentIDsSettingsNextNumber: { credit_note?: number | null; delivery_note?: number | null; invoice?: number | null; purchase_order?: number | null; quote?: number | null; }; DocumentIDsSettingsRequest: { /** * @description Prefixes for each document_type. * @default { * "credit_note": "CN", * "delivery_note": "DN", * "invoice": "INV", * "purchase_order": "PO", * "quote": "Q" * } */ document_type_prefix: components["schemas"]["DocumentTypePrefix"]; /** * @description Optionally add 4-digit of the current year. * @default false */ include_date: boolean; /** * @description Minimal size of number in document ID Number will be left padded with zeros if less. * @default 5 */ min_digits: number; /** @description Write-only field. Changes which number will be issued next. Can't be less than the last issued document number. */ next_number?: components["schemas"]["DocumentIDsSettingsNextNumber"] | null; /** @description Optional prefix. Does not substitute document_type prefix. */ prefix?: string | null; /** * @description Which character should separate each part of the document_id. * @default - */ separator: components["schemas"]["DocumentIDSeparators"]; }; /** * @description This block contains information about the document itself depending on the document type and presence of fields * such as: * - client * - document number * - creation date * - issue date * - due date * - paid date * - fulfillment date * - expiry date * - delivery date */ DocumentInfoBlock: { created_at?: string; based_invoice_date?: string; based_invoice_number?: string; /** @default Invoice number */ based_invoice_number_header: string; client?: string; /** @default Client */ client_header: string; /** @default Invoice date */ created_at_header: string; delivery_date?: string; /** @default Delivery date */ delivery_date_header: string; delivery_number?: string; /** @default Delivery number */ delivery_number_header: string; document_id?: string; /** @default Document number */ document_id_header: string; due_date?: string; /** @default Due date */ due_date_header: string; expiry_date?: string; fulfillment_date?: string; /** @default Fulfillment date */ fulfillment_date_header: string; header?: string; issue_date?: string; /** @default Issue date */ issue_date_header: string; paid_date?: string; /** @default Paid date */ paid_date_header: string; project_name?: string; project_name_header?: string; purchase_order?: string; /** @default Purchase order */ purchase_order_header: string; /** @default Quote expires */ quote_expires_header: string; receivable_date?: string; receivable_date_title?: string; receivable_number?: string; /** @default Number */ receivable_number_header: string; section_header?: string; }; /** @enum {string} */ DocumentObjectTypeRequestEnum: "receivables_quote" | "receivables_invoice" | "receivables_paid_invoice" | "receivables_credit_note" | "receivables_discount_reminder" | "receivables_final_reminder" | "payables_purchase_order" | "payables_notify_approver" | "payables_notify_payer"; /** @description Settings for rendering documents in PDF format, including settings for line items and specific document types. */ DocumentRenderingSettings: { /** @description Credit note-specific rendering settings for PDF documents. */ credit_note?: components["schemas"]["CreditNoteRenderingSettings"]; /** * @description If set to `true`, the line items table will be displayed on the quote PDF. Defaults to `true`. * @default true */ display_line_items: boolean; /** * @description If set to `true`, the organization's bank account details will be displayed on the PDF documents. Defaults to `true`. * @default true */ display_organization_bank_account: boolean; /** @description Invoice-specific rendering settings for PDF documents. */ invoice?: components["schemas"]["InvoiceRenderingSettings"]; /** @description Settings for rendering line items in PDF documents. */ line_items?: components["schemas"]["LineItemsRenderingSettings"]; /** @description Quote-specific rendering settings for PDF documents. */ quote?: components["schemas"]["QuoteRenderingSettings"]; }; /** * @description Rendering settings that control how different parts of the PDF documents are displayed. * Includes common settings for all document types such as quotes, invoices, and credit notes and document * type-specific settings that are defined in their respective objects. */ "DocumentRenderingSettings-Input": { /** @description Credit note-specific rendering settings for PDF documents. */ credit_note?: components["schemas"]["CreditNoteRenderingSettings"]; /** * @description If set to `true`, the line items table will be displayed on the quote PDF. Defaults to `true`. * @default true */ display_line_items: boolean; /** * @description If set to `true`, the organization's bank account details will be displayed on the PDF documents. Defaults to `true`. * @default true */ display_organization_bank_account: boolean; /** @description Invoice-specific rendering settings for PDF documents. */ invoice?: components["schemas"]["InvoiceRenderingSettings"]; /** @description Settings for rendering line items in PDF documents. */ line_items?: components["schemas"]["LineItemsRenderingSettings"]; /** @description Quote-specific rendering settings for PDF documents. */ quote?: components["schemas"]["QuoteRenderingSettings"]; }; /** * @description Rendering settings that control how different parts of the PDF documents are displayed. * Includes common settings for all document types such as quotes, invoices, and credit notes and document * type-specific settings that are defined in their respective objects. */ "DocumentRenderingSettings-Output": { /** @description Credit note-specific rendering settings for PDF documents. */ credit_note?: components["schemas"]["CreditNoteRenderingSettings"]; /** * @description If set to `true`, the line items table will be displayed on the quote PDF. Defaults to `true`. * @default true */ display_line_items: boolean; /** * @description If set to `true`, the organization's bank account details will be displayed on the PDF documents. Defaults to `true`. * @default true */ display_organization_bank_account: boolean; /** @description Invoice-specific rendering settings for PDF documents. */ invoice?: components["schemas"]["InvoiceRenderingSettings"]; /** @description Settings for rendering line items in PDF documents. */ line_items?: components["schemas"]["LineItemsRenderingSettings"]; /** @description Quote-specific rendering settings for PDF documents. */ quote?: components["schemas"]["QuoteRenderingSettings"]; }; DocumentResponse: { /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; document_id: string; /** Format: uuid */ object_id: string; }; /** @enum {string} */ DocumentTypeEnum: "quote" | "invoice" | "credit_note" | "discount_reminder" | "final_reminder" | "payables_purchase_order" | "overdue_reminder"; DocumentTypePrefix: { /** @default CN */ credit_note: string; /** @default DN */ delivery_note: string; /** @default INV */ invoice: string; /** @default PO */ purchase_order: string; /** @default Q */ quote: string; }; DomainListResponse: { data: components["schemas"]["DomainResponse"][]; }; DomainRequest: { /** * Format: hostname * @description The domain name, such as `mail.mycompany.com`. Can contain only alphanumeric characters (A..Z a..z 0..9), dots (.), and hyphens (-). Each segment of the domain name must start and end with either a letter or a digit. */ domain: string; }; DomainResponse: { /** * Format: uuid * @description Entry UUID */ id: string; /** @description A dedicated IP address assigned to this mailbox and used to send outgoing email. */ dedicated_ip?: string | null; dns_records: components["schemas"]["DNSRecords"] | { [key: string]: unknown; }; /** * Format: hostname * @description The domain name. */ domain: string; /** @description The time the domain was updated for the last time */ last_updated_at?: string | null; status: string; }; /** @enum {string} */ DownloadType: "Report" | "Request"; /** @enum {string} */ EinvoiceSchemaTypeEnum: "DE:VAT" | "NL:KVK" | "NL:VAT" | "BE:VAT" | "BE:EN"; Email: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; attachments: Record; /** Format: uuid */ entity_id: string; external_user_id?: string; language_code: string; provider: string; provider_response?: unknown; recipient: string; status: string; status_details?: string; subject: string; template_name: string; variables: Record; }; /** * @description Extended ProblemDetails with Embed-specific error code. * Follows RFC 7807 with additional error code field. */ EmbedProblemDetails: { detail?: null | string; /** * @description Embed-specific error code for client error handling. * Stored in the Extensions dictionary to ensure proper JSON serialization. */ errorCode?: null | string; instance?: null | string; /** Format: int32 */ status?: null | number | string; title?: null | string; type?: null | string; }; EmbeddedAuthPayload: components["schemas"]["EmbeddedManuallySpecifiedPayload"] | components["schemas"]["EmbeddedAuthorizedBankAccountPayload"] | components["schemas"]["EmbeddedBankAccountPayload"]; EmbeddedAuthorizationResponse: { application_user_id: string; consent_id: string; consent_token?: string; sca_methods?: components["schemas"]["SCAMethod"][]; selected_sca_method?: components["schemas"]["SCAMethod"]; state: components["schemas"]["ConsentState"]; }; EmbeddedAuthorizedBankAccountPayload: { /** @description User's password in the bank system. */ auth_password: string; /** @description User login in the bank system. */ auth_user: string; /** Format: uuid */ authorized_bank_account_id: string; /** @default false */ iframe: boolean; /** @description PSU identification is required for some banks (e.g. some Germany institutions). */ psu_identification?: components["schemas"]["PsuIdentification"]; /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "authorized_bank_account"; }; EmbeddedBankAccountPayload: { /** @description User's password in the bank system. */ auth_password: string; /** @description User login in the bank system. */ auth_user: string; /** Format: uuid */ bank_account_id: string; bank_id: string; /** @default false */ iframe: boolean; /** @description PSU identification is required for some banks (e.g. some Germany institutions). */ psu_identification?: components["schemas"]["PsuIdentification"]; /** @default false */ save_to_authorized: boolean; /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "bank_account"; }; /** @description Response DTO for embedded business entity data. */ EmbeddedBusinessDataResponseDto: { /** @description The business structure type (e.g., LLC, Corporation). */ businessStructureType?: null | string; /** * Format: date * @description The date the business was formed. */ formationDate?: null | string; naicsCode?: null | components["schemas"]["NorthAmericanIndustryClassificationSystemCode"]; taxId?: null | components["schemas"]["TaxIdResponseDto"]; }; EmbeddedManuallySpecifiedPayload: { /** @description User's password in the bank system. */ auth_password: string; /** @description User login in the bank system. */ auth_user: string; bank_id: string; /** @default false */ iframe: boolean; payer_account_country: components["schemas"]["YapilyCountriesCoverageCodes"]; payer_account_holder_name?: string; payer_account_identification: components["schemas"]["AccountIdentification"]; /** @description PSU identification is required for some banks (e.g. some Germany institutions). */ psu_identification?: components["schemas"]["PsuIdentification"]; /** @default false */ save_to_authorized: boolean; /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "manual_input"; }; EnabledPaymentMethods: { /** * @deprecated * @description Deprecated. Use payment_methods_receive instead. */ payment_methods?: components["schemas"]["MoniteAllPaymentMethodsTypes"][]; /** @description Enable payment methods to receive money. */ payment_methods_receive?: components["schemas"]["MoniteAllPaymentMethodsTypes"][]; /** @description Enable payment methods to send money. */ payment_methods_send?: components["schemas"]["MoniteAllPaymentMethodsTypes"][]; }; /** @description A schema represents address info of the entity */ EntityAddressResponseSchema: { /** @description A city (a full name) where the entity is registered */ city: string; /** * @description A country name (as ISO code) where the entity is registered * @example DE */ country: components["schemas"]["AllowedCountries"]; /** @description A street where the entity is registered */ line1: string; /** @description An alternative street used by the entity */ line2?: string | null; /** @description A postal code of the address where the entity is registered */ postal_code: string; /** @description A state in a country where the entity is registered */ state?: string | null; }; /** @description A schema represents address info of the entity */ EntityAddressSchema: { /** @description A city (a full name) where the entity is registered */ city: string; /** * @description A country name (as ISO code) where the entity is registered * @example DE */ country: components["schemas"]["AllowedCountries"]; /** @description A street where the entity is registered */ line1: string; /** @description An alternative street used by the entity */ line2?: string | null; /** @description A postal code of the address where the entity is registered */ postal_code: string; /** @description State, county, province, prefecture, region, or similar component of the entity's address. For US entities, `state` is required and must be a two-letter [USPS state abbreviation](https://pe.usps.com/text/pub28/28apb.htm), for example, NY or CA. */ state?: string | null; }; /** @description A paginated list of an entity's bank accounts. */ EntityBankAccountPaginationResponse: { /** @description A list of an entity's bank accounts. */ data: components["schemas"]["EntityBankAccountResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; /** @description Represents a US bank account (bank details) owned by an entity. */ EntityBankAccountResponse: { /** * Format: uuid * @description Unique ID of the bank account. */ id: string; /** * @description The name of the person or business that owns this bank account. Required in the following cases: * * the account currency is GBP or USD, * * the account currency is EUR and the entity wishes to receive SEPA Credit transfers to this account. * @example Cayla Lloyd */ account_holder_name?: string; /** * @description The bank account number. Required if the account currency is GBP or USD. UK account numbers typically contain 8 digits. US bank account numbers contain 9 to 12 digits. * @example 123456789 */ account_number?: string; /** * @description The last 4 digits of bank account number. Required if the account currency is GBP or USD and there is no information about the full account number. * @example 5678 */ account_number_last4?: string; /** * @description The bank name. * @example Chase */ bank_name?: string; /** * @description User-defined name of this bank account, such as 'Primary account' or 'Savings account'. * @example Primary account */ display_name?: string; /** * @description The bank's routing transit number (RTN) or branch code. Required if the account currency is USD. US routing numbers consist of 9 digits. * @example 123456789 */ routing_number?: string; /** * Format: uuid * @description ID of the entity user who added this bank account, or `null` if it was added using a partner access token. */ was_created_by_user_id?: string; }; /** @enum {string} */ EntityBusinessStructure: "incorporated_partnership" | "unincorporated_partnership" | "public_corporation" | "private_corporation" | "sole_proprietorship" | "single_member_llc" | "multi_member_llc" | "private_partnership" | "unincorporated_association" | "public_partnership"; /** @description Fields for the contact information of the entity that is issuing the receivable */ EntityContactBlock: { /** @description Email address of the entity */ email?: string; /** @description Phone number of the entity */ phone?: string; registration_authority?: string; registration_authority_header?: string; registration_number?: string; registration_number_header?: string; tax_id?: string; /** @default KVK */ tax_id_header: string; /** @description Trade name of the entity as specified in the receivable */ trade_name?: string; /** @description Title for the trade name field. E.g. 'Doing business as' */ trade_name_title?: string; vat_country?: string; vat_id?: string; /** @default VAT */ vat_id_header: string; /** @description Website of the entity */ website?: string; }; /** @enum {string} */ EntityCursorFields: "created_at" | "updated_at"; EntityFields: { /** * @description Object describing the required field `tax_id` of an entity * @default { * "description": "The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered.", * "required": false * } */ tax_id: components["schemas"]["FieldSchema"]; /** * @description Object describing the required field `vat_id` of an entity * @default { * "description": "The entity's VAT (Value Added Tax) identification number. This field is required for entities that are VAT-registered.", * "required": false * } */ vat_id: components["schemas"]["FieldSchema"]; }; /** @enum {string} */ EntityIndividualFieldsEnum: "first_name" | "last_name" | "address" | "email" | "tax_id" | "vat_id"; EntityIndividualResponse: { /** * Format: uuid * @description UUID entity ID */ id: string; /** * Format: date-time * @description UTC datetime */ created_at: string; /** * Format: date-time * @description UTC datetime */ updated_at: string; /** @description An address description of the entity */ address: components["schemas"]["EntityAddressResponseSchema"]; /** @description An official email address of the entity */ email?: string | null; /** @description A set of metadata describing an individual */ individual: components["schemas"]["IndividualResponseSchema"]; /** @description A logo image of the entity */ logo?: components["schemas"]["FileSchema2"] | null; /** @description A phone number of the entity */ phone?: string | null; /** * @description (Germany only) The name of the local district court (_Amtsgericht_) where the entity is registered. Required if `registration_number` is provided. * @example Amtsgericht Charlottenburg */ registration_authority?: string | null; /** * @description (Germany only) The entity's commercial register number (_Handelsregisternummer_) in the German Commercial Register, if available. * @example HRB 202324 */ registration_number?: string | null; /** @description record status, 'active' by default */ status: components["schemas"]["EntityStatusEnum"]; /** @description The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered. */ tax_id?: string | null; /** * @description A type for an individual (enum property replaced by openapi-typescript) * @enum {string} */ type: "individual"; /** @description A website of the entity */ website?: string | null; }; /** @description Fields for the entity that is issuing the receivable */ EntityInfoBlock: { /** @description HTML formatted address of the entity */ address?: string; /** @description Entity address data */ address_data?: components["schemas"]["AddressData"]; /** @description Email address of the entity */ email?: string; /** @description Header for the entity info block. Empty for Mollie; 'Authorised Dealer' for Israel; 'Provider' for all other countries */ entity_info_header?: string; /** @description First name of the individual entity. For organizations, this field is empty */ first_name?: string; /** @description Last name of the individual entity. For organizations, this field is empty */ last_name?: string; /** @description Name of the organization entity. For individuals, this field is empty */ name?: string; /** @description Phone number of the entity */ phone?: string; tax_id?: string; /** @default TAX ID */ tax_id_header: string; /** @description Trade name of the entity as specified in the receivable */ trade_name?: string; /** @description Title for the trade name field. E.g. 'Doing business as' */ trade_name_title?: string; vat_country?: string; vat_id?: string; /** @default VAT */ vat_id_header: string; /** @description Website of the entity */ website?: string; }; EntityLogoBlock: { entity_logo?: string; }; /** @description Email settings for entity */ EntityMailSettings: { /** * @description Reply-to email addresses for outgoing entity emails. When set, recipients can reply directly to these addresses instead of the sender's email address. Used for invoices, reminders, and other automated emails. * @example [ * "support@example.com" * ] * @example [ * "billing@example.com", * "support@example.com" * ] */ reply_to?: string[] | null; }; EntityOnboardingDataRequest: { /** @description Business information about the entity. */ business_profile?: components["schemas"]["BusinessProfile-Input"] | null; /** @description Used to attest that the beneficial owner information provided is both current and correct. */ ownership_declaration?: components["schemas"]["OwnershipDeclaration-Input"] | null; /** @description Details on the entity's acceptance of the service agreement. */ tos_acceptance?: components["schemas"]["TermsOfServiceAcceptance-Input"] | null; /** @description Details on the entity's acceptance of the Stripe Treasury service agreement. */ treasury_tos_acceptance?: components["schemas"]["TermsOfServiceAcceptance-Input"] | null; }; EntityOnboardingDataResponse: { /** @description Business information about the entity. */ business_profile?: components["schemas"]["BusinessProfile-Output"] | null; /** @description Used to attest that the beneficial owner information provided is both current and correct. */ ownership_declaration?: components["schemas"]["OwnershipDeclaration-Output"] | null; /** @description Details on the entity's acceptance of the service agreement. */ tos_acceptance?: components["schemas"]["TermsOfServiceAcceptance-Output"] | null; /** @description Details on the entity's acceptance of the Stripe Treasury service agreement. */ treasury_tos_acceptance?: components["schemas"]["TermsOfServiceAcceptance-Output"] | null; }; /** @enum {string} */ EntityOrganizationFieldsEnum: "name" | "address" | "email" | "tax_id" | "vat_id"; EntityOrganizationResponse: { /** * Format: uuid * @description UUID entity ID */ id: string; /** * Format: date-time * @description UTC datetime */ created_at: string; /** * Format: date-time * @description UTC datetime */ updated_at: string; /** @description An address description of the entity */ address: components["schemas"]["EntityAddressResponseSchema"]; /** @description An official email address of the entity */ email?: string | null; /** @description A logo image of the entity */ logo?: components["schemas"]["FileSchema2"] | null; /** @description A set of metadata describing an organization */ organization: components["schemas"]["OrganizationResponseSchema"]; /** @description A phone number of the entity */ phone?: string | null; /** * @description (Germany only) The name of the local district court (_Amtsgericht_) where the entity is registered. Required if `registration_number` is provided. * @example Amtsgericht Charlottenburg */ registration_authority?: string | null; /** * @description (Germany only) The entity's commercial register number (_Handelsregisternummer_) in the German Commercial Register, if available. * @example HRB 202324 */ registration_number?: string | null; /** @description record status, 'active' by default */ status: components["schemas"]["EntityStatusEnum"]; /** @description The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered. */ tax_id?: string | null; /** * @description A type for an organization (enum property replaced by openapi-typescript) * @enum {string} */ type: "organization"; /** @description A website of the entity */ website?: string | null; }; EntityPaginationResponse: { /** @description A set of entities of different types returned per page */ data: components["schemas"]["EntityResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string | null; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string | null; }; /** @description A schema for a response after creation of an entity of different types */ EntityResponse: components["schemas"]["EntityOrganizationResponse"] | components["schemas"]["EntityIndividualResponse"]; EntitySchema: { individual: components["schemas"]["EntityIndividualFieldsEnum"][]; organization: components["schemas"]["EntityOrganizationFieldsEnum"][]; }; /** @enum {string} */ EntityStatusEnum: "active" | "inactive" | "deleted"; /** @enum {string} */ EntityTypeEnum: "individual" | "organization"; EntityUpdateVatID: { country?: components["schemas"]["AllowedCountries"] | null; /** @example eu_vat */ type?: components["schemas"]["VatIDTypeEnum"] | null; value?: string | null; }; /** @enum {string} */ EntityUserCursorFields: "updated_at"; EntityUserPaginationResponse: { /** @description array of records */ data: components["schemas"]["EntityUserResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string | null; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string | null; }; EntityUserResponse: { /** * Format: uuid * @description UUID entity user ID */ id: string; /** * Format: date-time * @description UTC datetime */ created_at: string; /** * Format: date-time * @description UTC datetime */ updated_at: string; /** @description An entity user business email */ email?: string | null; /** @description First name */ first_name?: string; /** @description Last name */ last_name?: string | null; /** * @description Login * @example caseyp */ login: string; /** @description An entity user phone number in the international format */ phone?: string | null; /** @description record status, 'active' by default */ status: components["schemas"]["StatusEnum"]; userpic_file_id?: string | null; }; EntityVatID: { country: components["schemas"]["AllowedCountries"]; /** * @default unknown * @example eu_vat */ type: components["schemas"]["VatIDTypeEnum"]; /** @example 123456789 */ value: string; }; EntityVatIDResourceList: { data: components["schemas"]["EntityVatIDResponse"][]; }; EntityVatIDResponse: { /** Format: uuid */ id: string; country: components["schemas"]["AllowedCountries"]; /** Format: uuid */ entity_id: string; /** * @default unknown * @example eu_vat */ type: components["schemas"]["VatIDTypeEnum"]; /** @example 123456789 */ value: string; }; ErrorSchema: { message: string; }; ErrorSchema2: { message: string; }; ErrorSchema3: { message: string; }; ErrorSchemaResponse: { error: components["schemas"]["ErrorSchema"]; }; ErrorSchemaResponse2: { error: components["schemas"]["ErrorSchema2"]; }; ErrorSchemaResponse3: { error: components["schemas"]["ErrorSchema3"]; }; EstimatedMonthlyRevenue: { /** * @description The amount of the monthly revenue, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 250 */ amount?: number | null; /** * @description [Currency code](https://docs.monite.com/references/currencies) of the revenue. * @example USD */ currency?: components["schemas"]["CurrencyEnum"] | null; }; /** @enum {string} */ EventCursorFields: "created_at" | "updated_at"; EventPaginationResource: { /** @description A set of events returned per page */ data: components["schemas"]["EventResource"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string | null; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string | null; }; EventResource: { /** Format: uuid */ id: string; /** @description The timestamp that was generated at the time of making the database transaction that has initially caused the event */ created_at?: string | null; action: string; api_version: string | null; description: string; /** Format: uuid */ entity_id: string; object?: unknown | null; object_type: components["schemas"]["WebhookObjectType"]; }; EventResourceForWebhookClient: { /** Format: uuid */ id: string; /** @description The timestamp that was generated at the time of making the database transaction that has initially caused the event */ created_at?: string | null; action: string; api_version: string | null; description: string; /** Format: uuid */ entity_id: string; object?: unknown | null; object_type: components["schemas"]["WebhookObjectType"]; /** Format: uuid */ webhook_subscription_id: string; }; ExchangeRate: { /** @example USD */ base: components["schemas"]["CurrencyEnum"]; /** @example 0.98 */ rate: number; /** @example GBP */ to: components["schemas"]["CurrencyEnum"]; }; ExpenseHistoryEntryResponse: { /** Format: uuid */ id: string; /** * Format: uuid * @description The user who performed the action, if known. */ entity_user_id?: string; /** @description Structured event payload. Shape depends on event_type: StatusChangedEventData for status_changed, ApprovalActionEventData for approval_action. */ event_data?: components["schemas"]["StatusChangedEventData"] | components["schemas"]["ApprovalActionEventData"]; /** @description The type of event recorded. */ event_type: components["schemas"]["ExpenseHistoryEventTypeEnum"]; /** * Format: date-time * @description When the event occurred. */ timestamp: string; /** Format: uuid */ transaction_id: string; }; /** @enum {string} */ ExpenseHistoryEventTypeEnum: "status_changed" | "approval_action"; ExpenseHistoryResponseList: { data: components["schemas"]["ExpenseHistoryEntryResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; /** @enum {string} */ ExpenseStatusEnum: "new" | "approve_in_progress" | "approved" | "rejected" | "canceled"; /** @enum {string} */ ExportFormat: "csv" | "pdf" | "csv_xero"; ExportObjectSchema: components["schemas"]["ExportPayableSchema"] | components["schemas"]["ExportReceivableSchema"]; ExportPayableSchema: { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ name: "payable"; statuses: components["schemas"]["PayableStateEnum"][]; }; ExportPayloadSchema: { /** Format: date */ date_from: string; /** Format: date */ date_to: string; format: components["schemas"]["ExportFormat"]; objects: components["schemas"]["ExportObjectSchema"][]; }; ExportReceivableSchema: { /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ name: "receivable"; statuses: components["schemas"]["ReceivablesStatusEnum"][]; }; /** @enum {string} */ ExportSettingCursorFields: "id" | "created_at"; /** @description Response representing an external bank account. */ ExternalBankAccountResponse: { /** * Format: uuid * @description Unique identifier for the external bank account. */ id: string; /** @description Masked account number (last 4 digits visible). */ accountNumber: string; /** @description Status of the external bank account. */ accountStatus: components["schemas"]["ExternalBankAccountStatusDto"]; /** @description Name on the bank account. */ nameOnAccount: string; /** @description Nickname for the external bank account. */ nickname: string; /** @description Bank routing number (ABA number). */ routingNumber: string; /** @description Type of bank account (checking or savings). */ type: components["schemas"]["ExternalBankAccountTypeDto"]; /** @description Verification status of the external bank account. */ verificationStatus: components["schemas"]["ExternalBankAccountVerificationStatusDto"]; }; /** * @description Status of an external bank account. * @enum {string} */ ExternalBankAccountStatusDto: "ACTIVE" | "INACTIVE"; /** @description Summary of external bank accounts by verification status. */ ExternalBankAccountSummary: { /** * Format: int32 * @description Number of external bank accounts with failed verification. */ failed?: number | string; /** * Format: int32 * @description Total number of external bank accounts. */ total?: number | string; /** * Format: int32 * @description Number of external bank accounts not yet verified. */ unverified?: number | string; /** * Format: int32 * @description Number of verified external bank accounts. */ verified?: number | string; }; /** * @description Type of external bank account. * @enum {string} */ ExternalBankAccountTypeDto: "CHECKING" | "SAVINGS"; /** @description Input for updating external bank account verification status. */ ExternalBankAccountVerificationInput: { /** @description The method used to verify the external bank account. */ method: components["schemas"]["ExternalBankAccountVerificationMethod"]; }; /** * @description Method used to verify an external bank account. * @enum {string} */ ExternalBankAccountVerificationMethod: "MICRO_DEPOSIT" | "MANUAL"; /** * @description Verification status of an external bank account. * @enum {string} */ ExternalBankAccountVerificationStatusDto: "UNVERIFIED" | "VERIFICATION_SENT" | "VERIFIED" | "FAILED"; ExtraDataCreateRequest: { field_name: components["schemas"]["SupportedFieldNames"]; field_value: string; /** Format: uuid */ object_id: string; /** @enum {string} */ object_type: "counterpart"; }; ExtraDataResource: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; /** Format: uuid */ created_by?: string; field_name: components["schemas"]["SupportedFieldNames"]; field_value: string; /** Format: uuid */ object_id: string; /** @enum {string} */ object_type: "counterpart"; }; ExtraDataResourceList: { data: components["schemas"]["ExtraDataResource"][]; next_pagination_token?: string; prev_pagination_token?: string; }; ExtraDataUpdateRequest: { field_name?: components["schemas"]["SupportedFieldNames"]; field_value?: string; /** Format: uuid */ object_id?: string; /** @enum {string} */ object_type?: "counterpart"; }; /** @description Request model for initiating a FedNow (FedNow Service) money movement. */ FedNowMoneyMovementRequest: { /** * Format: int64 * @description Amount to transfer. Must be greater than 0. */ amount: number | string; /** * @description ISO 4217 alphabetic currency code (e.g. `USD`). Defaults to `USD` when omitted. * Determines the minor unit precision of long FedNowMoneyMovementRequest.Amount. * @default USD */ currencyCode: string; /** * Format: uuid * @description Source bank account identifier. */ fromBankAccountId: string; /** * @description Optional idempotency key for preventing duplicate transfers. * Maximum length: 256 characters. */ idempotencyKey?: null | string; /** @description Optional payment memo or description. */ memo?: null | string; /** * Format: uuid * @description Destination bank account identifier. */ toBankAccountId: string; }; Fee: { /** @example 32 */ amount: number; /** @example 0.55 */ percentage: number; }; /** @enum {string} */ FeeRegion: "EU" | "UK" | "US" | "INTERNATIONAL"; FieldSchema: { /** @description Description of the field */ description: string; /** @description Whether the field is required */ required: boolean; }; /** @enum {string} */ FieldSourceEnum: "user" | "generated" | "automatched"; FileAttachedEventData: { file_name: string; file_size: number; url: string; }; FileResponse: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; file_type: string; md5: string; mimetype: string; name: string; region: string; s3_bucket: string; s3_file_path: string; size: number; url: string; }; /** @description Represents a file (such as a PDF invoice) that was uploaded to Monite. */ FileSchema: { /** * Format: uuid * @description A unique ID of this file. */ id: string; /** * Format: date-time * @description UTC date and time when this file was uploaded to Monite. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */ created_at: string; /** * @description The type of the business object associated with this file. * @example payables */ file_type: string; /** * @description The MD5 hash of the file. * @example 31d1a2dd1ad3dfc39be849d70a68dac0 */ md5: string; /** * @description The file's [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types). * @example application/pdf */ mimetype: string; /** * @description The original file name (if available). * @example invoice.pdf */ name: string; /** * @description If the file is a PDF document, this property contains individual pages extracted from the file. Otherwise, an empty array. * @default [] */ pages: components["schemas"]["PageSchema2"][]; /** * @description Preview images generated for this file. There can be multiple images with different sizes. * @default [] */ previews: components["schemas"]["PreviewSchema2"][]; /** * @description Geographical region of the data center where the file is stored. * @example eu-central-1 */ region: string; /** * @description The file size in bytes. * @example 24381 */ size: number; /** * @description The URL to download the file. * @example https://bucketname.s3.amazonaws.com/12345/67890.pdf */ url: string; }; /** @description Represents a file (such as a PDF invoice) that was uploaded to Monite. */ FileSchema2: { /** * Format: uuid * @description A unique ID of this file. */ id: string; /** * Format: date-time * @description UTC date and time when this file was uploaded to Monite. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */ created_at: string; /** * @description The type of the business object associated with this file. * @example payables */ file_type: string; /** * @description The MD5 hash of the file. * @example 31d1a2dd1ad3dfc39be849d70a68dac0 */ md5: string; /** * @description The file's [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types). * @example application/pdf */ mimetype: string; /** * @description The original file name (if available). * @example invoice.pdf */ name: string; /** * @description If the file is a PDF document, this property contains individual pages extracted from the file. Otherwise, an empty array. * @default [] */ pages: components["schemas"]["PageSchema"][] | null; /** * @description Preview images generated for this file. There can be multiple images with different sizes. * @default [] */ previews: components["schemas"]["PreviewSchema"][] | null; /** * @description Geographical region of the data center where the file is stored. * @example eu-central-1 */ region: string; /** * @description The file size in bytes. * @example 24381 */ size: number; /** * @description The URL to download the file. * @example https://bucketname.s3.amazonaws.com/12345/67890.pdf */ url: string; }; /** @description Represents a file (such as a PDF invoice) that was uploaded to Monite. */ FileSchema3: { /** * Format: uuid * @description A unique ID of this file. */ id: string; /** * Format: date-time * @description UTC date and time when this workflow was uploaded to Monite. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */ created_at: string; /** * @description The type of the business object associated with this file. * @example payables */ file_type: string; /** * @description The MD5 hash of the file. * @example 31d1a2dd1ad3dfc39be849d70a68dac0 */ md5: string; /** * @description The file's [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types). * @example application/pdf */ mimetype: string; /** * @description The original file name (if available). * @example invoice.pdf */ name: string; /** * @description If the file is a PDF document, this property contains individual pages extracted from the file. Otherwise, an empty array. * @default [] */ pages: components["schemas"]["PageSchema3"][]; /** * @description Preview images generated for this file. There can be multiple images with different sizes. * @default [] */ previews: components["schemas"]["PreviewSchema3"][]; /** * @description Geographical region of the data center where the file is stored. * @example eu-central-1 */ region: string; /** * @description The file size in bytes. * @example 24381 */ size: number; /** * @description The URL to download the file. * @example https://bucketname.s3.amazonaws.com/12345/67890.pdf */ url: string; }; /** @enum {string} */ FileUrlType: "original_file_url" | "file_url"; FilesResponse: { data: components["schemas"]["FileResponse"][]; }; FinancingInvoice: { /** @description Amount after fees the business will receive in minor units. */ advance_amount?: number; /** @description Advance rate percentage. 10000 means 100% */ advance_rate_percentage?: number; /** @description Currency code. */ currency: components["schemas"]["CurrencyEnum"]; /** @description Description of the invoice. */ description?: string; /** @description Monite document ID. */ document_id: string; /** * Format: date * @description Monite invoice due date. */ due_date: string; /** @description Fee amount in minor units. */ fee_amount?: number; /** @description Fee percentage. 300 means 3% */ fee_percentage?: number; /** * Format: uuid * @description Monite invoice ID. */ invoice_id: string; /** * Format: date * @description Monite invoice issue date. */ issue_date: string; /** @description Payer business name. Only applicable for BUSINESS payer type. */ payer_business_name?: string; /** @description Payer first name. Only applicable for INDIVIDUAL payer type. */ payer_first_name?: string; /** @description Payer last name. Only applicable for INDIVIDUAL payer type. */ payer_last_name?: string; /** @description Payer type. BUSINESS or INDIVIDUAL */ payer_type: string; /** @description Principal amount of the loan in minor units. */ principal_amount?: number; /** @description Amount the business will repay in minor units. */ repayment_amount?: number; /** * @description Repayment schedule of the invoice. * @example { * "repayment_date": "2025-03-01", * "repayment_amount": 100000, * "repayment_fee_amount": 3000, * "repayment_principal_amount": 97000 * } */ repayment_schedule?: components["schemas"]["RepaymentSchedule"]; /** @description Amount the business requests to be financed in minor units. */ requested_amount?: number; /** @description Status of the invoice. */ status: components["schemas"]["WCInvoiceStatus"]; /** @description Total amount of the invoice in minor units. */ total_amount: number; /** @description The type of the invoice i.e. receivable or payable. */ type: components["schemas"]["FinancingInvoiceType"]; }; /** @enum {string} */ FinancingInvoiceCursorFields: "id" | "created_at"; FinancingInvoiceListResponse: { /** @description A list of invoices requested for financing. */ data: components["schemas"]["FinancingInvoice"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; /** @enum {string} */ FinancingInvoiceType: "payable" | "receivable"; FinancingOffer: { /** * @description The available credit limit in minor units. * @example 500000 */ available_amount?: number; /** * @description The currency code. * @example USD */ currency: components["schemas"]["CurrencyEnum"]; /** @description A list of pricing plans for the offer. */ pricing_plans: components["schemas"]["PricingPlan"][]; /** * @description The status of the financing offer. * @example CURRENT */ status: components["schemas"]["WCOfferStatus"]; /** * @description The total credit limit in minor units. * @example 1000000 */ total_amount: number; }; FinancingOffersResponse: { /** * @description The business's onboarding status. * @example ONBOARDED */ business_status: components["schemas"]["WCBusinessStatus"]; /** @description A list of financing offers extended to the business. */ offers: components["schemas"]["FinancingOffer"][]; }; FinancingPushInvoicesRequest: { /** @description A list of invoices to request financing for. */ invoices: components["schemas"]["FinancingPushInvoicesRequestInvoice"][]; }; FinancingPushInvoicesRequestInvoice: { /** * Format: uuid * @description The invoice ID. */ id: string; /** @description The invoice type. */ type: components["schemas"]["FinancingInvoiceType"]; }; FinancingPushInvoicesResponse: { /** @description A connect token for Kanmon SDK. */ connect_token: string; /** @description An embedded session token for Kanmon SDK. */ session_token: string; }; FinancingTokenResponse: { /** @description A connect token for Kanmon SDK. */ connect_token: string; }; /** @description Footer block contains the footer text that is displayed in the PDF document below the line items table. */ FooterBlock: { footer?: string; }; GenerateDocumentIdRequest: { counterpart_name?: string | null; /** Format: uuid */ entity_id: string; /** Format: uuid */ object_id: string; object_type: string; starts_with?: number | null; }; GetAllPaymentReminders: { data: components["schemas"]["PaymentReminderResponse"][]; }; GlobalDiscount: { /** @description Discount amount. For discount type amount it is discount amount. For percentage, it is calculated percentage as amount. */ amount?: string; /** @description Formatted percentage of the total discount. Used only for percentage discount. */ percentage?: string; }; /** @description Request to grant access to a bank account for specified users. */ GrantUsersAccessRequest: { /** @description List of user IDs to grant access to. */ userIds: string[]; }; HTTPValidationError: { detail?: components["schemas"]["ValidationError"][]; }; HeaderBlock: { document_id?: string; document_name?: string; document_name_not_translated?: string; document_type?: string; }; /** Format: binary */ IFormFile: Blob; /** @description Contains data specific to entities of the `individual` type. */ IndividualResponseSchema: { date_of_birth?: string | null; /** @description A first name of an individual */ first_name: string; id_number?: string | null; /** @description A last name of an individual */ last_name: string; /** @description The last four digits of the individual's Social Security number */ ssn_last_4?: string | null; /** @description A title of an individual */ title?: string | null; }; /** @description A schema contains metadata for an individual */ IndividualSchema: { date_of_birth?: string | null; /** @description A first name of an individual */ first_name: string; id_number?: string | null; /** @description A last name of an individual */ last_name: string; /** @description The last four digits of the individual's Social Security number */ ssn_last_4?: string | null; /** @description A title of an individual */ title?: string | null; }; InlinePaymentTermsRequestPayload: { /** @description The first tier of the payment term. Represents the terms of the first early discount. */ term_1?: components["schemas"]["InlineTermDiscount"]; /** @description The second tier of the payment term. Defines the terms of the second early discount. */ term_2?: components["schemas"]["InlineTermDiscount"]; /** @description The final tier of the payment term. Defines the invoice due date. */ term_final: components["schemas"]["InlineTermFinal"]; }; InlineTermDiscount: { /** @description The discount percentage in minor units. E.g., 200 means 2%. 1050 means 10.5%. */ discount: number; /** Format: date */ end_date?: string; /** @description The amount of days after the invoice issue date. */ number_of_days?: number; }; InlineTermFinal: { /** Format: date */ end_date?: string; /** @description The amount of days after the invoice issue date. */ number_of_days?: number; }; /** * @description Response schema for a batch payment link with payment intents. * Used for GET /batch_payment_links/{link_id} endpoint. */ InternalBatchPaymentLinkResponse: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** @description List of entity bank accounts that can be used as a source for payment. */ entity_bank_accounts?: components["schemas"]["PublicBankAccount"][]; /** Format: uuid */ entity_id: string; error?: Record; /** Format: date-time */ expires_at: string; /** Format: uuid */ partner_id: string; payment_intents: components["schemas"]["PaymentIntentResponse"][]; /** Format: uri */ payment_page_url: string; /** Format: uuid */ project_id: string; status: components["schemas"]["PaymentsBatchPaymentStatus"]; total_amount?: number; }; InternalPaymentLinkResponse: { /** Format: uuid */ id: string; /** @default true */ confirm_on_backend: boolean; /** Format: uuid */ entity_id: string; /** Format: date-time */ expires_at: string; /** Format: uuid */ partner_id: string; payment_intent: components["schemas"]["PaymentIntentWithSecrets"]; /** Format: uuid */ payment_intent_id: string; payment_page_url: string; /** Format: uuid */ project_id: string; return_url?: string; status: string; }; Invoice: { /** Format: date */ due_date?: string; file?: components["schemas"]["InvoiceFile"]; /** Format: date */ issue_date?: string; }; InvoiceFile: { mimetype: string; name: string; /** Format: uri */ url: string; }; InvoiceRenderingSettings: { /** * @description If set to `true`, the organization's bank account details will be displayed on the invoice PDF. * @default true */ display_organization_bank_account: boolean; }; InvoiceResponsePayload: { /** Format: uuid */ id: string; /** * Format: date-time * @description Time at which the receivable was created. Timestamps follow the ISO 8601 standard. */ created_at: string; /** * Format: date-time * @description Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard. */ updated_at: string; /** @description How much is left to be paid in [minor units](https://docs.monite.com/references/currencies#minor-units). Equal 0 if the Invoice is fully paid. */ amount_due: number; /** @description How much has been paid [minor units](https://docs.monite.com/references/currencies#minor-units) */ amount_paid: number; /** @description How much is left to be paid in in [minor units](https://docs.monite.com/references/currencies#minor-units), including payment_term discounts. */ amount_to_pay?: number; /** @description List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. */ attachments?: components["schemas"]["AttachmentResponse"][]; /** Format: uuid */ bank_account_id?: string; bank_account_snapshot?: components["schemas"]["BankAccountSnapshot"]; bank_account_type?: string; /** * Format: uuid * @description The unique ID of a previous document related to the receivable if applicable. */ based_on?: string; /** @description The unique document ID of a previous document related to the receivable if applicable. */ based_on_document_id?: string; /** @description Field with a comment for pay/partially/uncollectible info on this Invoice */ comment?: string; /** @description The commercial terms of the receivable (e.g. The products must be delivered in X days). */ commercial_condition_description?: string; /** @description Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. */ counterpart_billing_address?: components["schemas"]["ReceivablesRepresentationOfCounterpartAddress"]; /** @description Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. */ counterpart_business_type?: string; /** @description Additional information about counterpart contacts. */ counterpart_contact?: components["schemas"]["ReceivableCounterpartContact"]; /** @description The external reference of the counterpart. */ counterpart_external_reference?: string; /** * Format: uuid * @description Unique ID of the counterpart. */ counterpart_id: string; /** @description A legal name of a counterpart it is an organization or first and last name if it is an individual */ counterpart_name?: string; /** @description Address where goods were shipped / where services were provided. */ counterpart_shipping_address?: components["schemas"]["ReceivablesRepresentationOfCounterpartAddress"]; /** @description The VAT/TAX ID of the counterpart. */ counterpart_tax_id?: string; /** @description The type of the counterpart. */ counterpart_type: components["schemas"]["CounterpartType"]; counterpart_vat_id?: components["schemas"]["ReceivableCounterpartVatIDResponse"]; /** @description The currency used in the receivable. */ currency: components["schemas"]["CurrencyEnum"]; /** * @deprecated * @description The amount of tax deducted in minor units */ deduction_amount?: number; /** * @deprecated * @description A note with additional information about a tax deduction */ deduction_memo?: string; /** @description List of deductions applied to the receivable (maximum 10 deductions allowed) */ deductions?: components["schemas"]["DeductionItem"][]; /** @description The discount for a receivable. */ discount?: components["schemas"]["DiscountResponse"]; /** @description Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units). */ discounted_subtotal?: number; /** @description The sequential code systematically assigned to invoices. */ document_id?: string; /** @description Settings for rendering documents in PDF format, including settings for line items and specific document types. */ document_rendering?: components["schemas"]["DocumentRenderingSettings"]; /** * Format: date * @description Optional field representing date until which invoice should be paid */ due_date?: string; entity: components["schemas"]["ReceivableEntityOrganization"] | components["schemas"]["ReceivableEntityIndividual"]; entity_address: components["schemas"]["ReceivableEntityAddressSchema"]; /** * @deprecated * @description Deprecated. Always null; use `bank_account_snapshot` instead. */ entity_bank_account?: components["schemas"]["ReceivablesRepresentationOfEntityBankAccount"]; /** * Format: uuid * @description The entity user who created this document. */ entity_user_id?: string; entity_vat_id?: components["schemas"]["ReceivableEntityVatIDResponse"]; /** @description The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated. */ file_language: components["schemas"]["LanguageCodeEnum"]; /** @description The receivable's PDF URL in the counterpart's default language. */ file_url?: string; /** @description Optional text displayed below the line items table in the PDF. */ footer?: string; /** * Format: date * @description The date when the goods are shipped or the service is provided. Can be a current, past, or future date. * * Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. * * In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user. */ fulfillment_date?: string; /** * Format: date-time * @description Optional field for the issue of the entry. */ issue_date?: string; line_items: components["schemas"]["ResponseItem"][]; /** @description A note with additional information for a receivable. */ memo?: string; /** @description The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated. */ original_file_language: components["schemas"]["LanguageCodeEnum"]; /** @description The receivable's PDF URL in the entity's default language. */ original_file_url?: string; /** Format: uuid */ overdue_reminder_id?: string; /** * Format: date-time * @description Date and time when the invoice was paid. */ paid_at?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; /** * Format: uri * @description Link to the invoice's payment page. Either Monite's payment links or your custom payment links. */ payment_page_url?: string; /** Format: uuid */ payment_reminder_id?: string; payment_terms?: components["schemas"]["PaymentTerms"]; /** * Format: uuid * @description A project related to current receivable */ project_id?: string; /** @description Contain purchase order number. */ purchase_order?: string; /** * Format: uuid * @description Stores an unique ID of a recurrence if the receivable is in a recurring status */ recurrence_id?: string; /** @description Ids of documents that relate to invoice. I.e credit notes, proforma invoices, etc. */ related_documents: components["schemas"]["RelatedDocuments"]; /** @description The status of the receivable inside the receivable workflow. */ status: components["schemas"]["ReceivablesStatusEnum"]; /** @description The subtotal (excluding tax), in [minor units](https://docs.monite.com/references/currencies#minor-units). */ subtotal?: number; /** @description The subtotal including tax but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). */ subtotal_after_tax?: number; /** * @description The list of tags for this receivable. * @default [] */ tags: components["schemas"]["TagReadSchema"][]; /** @description Indicates whether the goods, materials, or services listed in the receivable are exempt from tax or not. */ tax_exempt?: boolean; /** @description The reason for the tax exemption, if applicable. */ tax_exemption_rationale?: string; /** * @description Indicates whether the discount is applied to the tax-inclusive or tax-exclusive amount. * @default exclusive */ tax_inclusive_discount_mode: components["schemas"]["VatModeEnum"]; /** * @description Defines whether the prices of products in receivable will already include tax or not. * @default exclusive */ tax_mode: components["schemas"]["VatModeEnum"]; /** * @description Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_tax_amount. * @default 0 */ total_amount: number; /** @description The total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units), including tax and excluding all issued credit notes. */ total_amount_with_credit_notes: number; /** @description The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units). */ total_deduction_amount?: number; /** @description The total tax of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). */ total_tax_amount: number; /** @description List of total tax amount for each tax rate, presented in receivable */ total_tax_amounts?: components["schemas"]["TotalTaxAmountItem"][]; /** @description Total price of the receivable with tax withheld in minor units */ total_withholding_tax?: number; /** @description Trade name of the entity */ trade_name?: string; /** * @description The type of the document uploaded. * @enum {string} */ type: "invoice"; /** @description The amount of tax withheld in percent minor units */ withholding_tax_rate?: number; }; /** @description Contains information about a text block or line extracted from an uploaded document by OCR. */ Item: { /** * @description OCR confidence score - the estimated accuracy percentage of character recognition of the extracted text, from 0 to 100%. * @example 96.238 */ confidence: number; /** * @description If the `text` value is identified as a currency amount or a date, `processed_text` contains this value converted to a common format: * * * Currency amounts (such as the total, subtotal, tax/VAT, line item prices) are converted to numbers with the currency character removed. For example, "$1,125.00" becomes 1125.0.* Dates are converted to the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, `YYYY-MM-DDThh:mm:ss`. For example, "26/3/2021" becomes "2021-03-26T00:00:00". * * If `text` is not a currency amount or a date, `processed_text` is `null`. * @example 1125 */ processed_text?: unknown; /** * @description The text as recognized by OCR. * @example $1,125.00 */ text: string; }; ItemTypePredicate: components["schemas"]["SingleItemTypePredicate"] | components["schemas"]["MultipleItemTypePredicate"]; /** @enum {string} */ IterationStatus: "pending" | "completed" | "canceled" | "skipped" | "issue_failed" | "send_failed"; JsonElement: unknown; /** @enum {string} */ KycVerificationStatusDto: "PENDING" | "MANUAL_REVIEW" | "APPROVED" | "DENIED"; /** * @description A label-value pair extracted from an uploaded document by OCR. * For example, the label could be "Total" and the value could be a currency amount. */ LabelNValue: { /** * @description Text label. * @example { * "text": "total", * "confidence": 99.799 * } */ label: components["schemas"]["Item"]; /** @description The value (if any). */ value: components["schemas"]["Item"]; }; /** @enum {string} */ LanguageCodeEnum: "ab" | "aa" | "af" | "ak" | "sq" | "am" | "ar" | "an" | "hy" | "av" | "ae" | "ay" | "az" | "bm" | "ba" | "eu" | "be" | "bn" | "bi" | "bs" | "br" | "bg" | "my" | "ca" | "ch" | "ce" | "ny" | "zh" | "cu" | "cv" | "kw" | "co" | "cr" | "hr" | "cs" | "da" | "dv" | "nl" | "dz" | "en" | "eo" | "et" | "ee" | "fo" | "fj" | "fi" | "fr" | "fy" | "ff" | "gd" | "gl" | "lg" | "ka" | "de" | "el" | "kl" | "gn" | "gu" | "ht" | "ha" | "he" | "hz" | "hi" | "ho" | "hu" | "io" | "ig" | "id" | "ia" | "ie" | "iu" | "ik" | "ga" | "it" | "ja" | "jv" | "kn" | "kr" | "ks" | "kk" | "km" | "ki" | "rw" | "ky" | "kv" | "kg" | "ko" | "kj" | "ku" | "lo" | "la" | "lv" | "li" | "ln" | "lt" | "lu" | "lb" | "mk" | "mg" | "ms" | "ml" | "mt" | "gv" | "mi" | "mr" | "mh" | "mn" | "na" | "nv" | "nd" | "nr" | "ng" | "ne" | "no" | "nb" | "nn" | "ii" | "oc" | "oj" | "om" | "os" | "pi" | "ps" | "fa" | "pl" | "pt" | "pa" | "qu" | "ro" | "rm" | "rn" | "ru" | "se" | "sm" | "sg" | "sa" | "sc" | "sr" | "sn" | "sd" | "si" | "sk" | "sl" | "so" | "st" | "es" | "su" | "sw" | "ss" | "sv" | "tl" | "ty" | "tg" | "ta" | "tt" | "te" | "th" | "bo" | "ti" | "to" | "ts" | "tn" | "tr" | "tk" | "tw" | "ug" | "uk" | "ur" | "uz" | "ve" | "vi" | "vo" | "wa" | "cy" | "wo" | "xh" | "yi" | "yo" | "za" | "zu"; /** @description Schema for creating a new ledger account. */ LedgerAccountCreateRequest: { /** @description Description of the ledger account */ description?: string; /** @description Name of the ledger account */ name?: string; /** @description Account code in the accounting system */ nominal_code?: string; }; /** @enum {string} */ LedgerAccountCursorFields: "name"; /** @description A paginated list of ledger accounts. */ LedgerAccountListResponse: { data: components["schemas"]["LedgerAccountResponse"][]; next_pagination_token?: string; prev_pagination_token?: string; }; /** @description Represents a general ledger account retrieved from an accounting system. */ LedgerAccountResponse: { /** * Format: uuid * @description A unique identifier of the ledger account. */ id: string; /** * Format: date-time * @description The timestamp when the ledger account was created. */ created_at: string; /** * Format: date-time * @description The timestamp when the ledger account was last updated. */ updated_at: string; /** * @description The currency of the ledger account, specified as a three-letter [currency code](https://docs.monite.com/references/currencies) (ISO 4217). * @example USD */ currency?: components["schemas"]["CurrencyEnum"]; /** @description The current balance in the account. */ current_balance?: number; /** @description User-defined description of the ledger account. */ description?: string; /** @description Indicates whether this ledger account represents a bank account. */ is_bank_account: boolean; /** * @description Whether the ledger account is from an external system * @default false */ is_external: boolean; /** * @description A user-defined name of the ledger account. Examples: Accounts Receivable, Office Equipment, Advertising, Salaries. * @example Accounts Receivable */ name?: string; /** * @description The account code in the accounting system. * @example 610 */ nominal_code?: string; /** * @description The status of the ledger account. Possible values: Active, Archived, Pending, Unknown. * @example Active */ status: string; /** * @description The subtype or category of the ledger account. Possible values vary based on the accounting system used. Examples: Current, Fixed, Expense, Inventory, Equity. * @example Current */ subtype?: string; /** * @description The type of the ledger account. It determines whether the account is a credit account or a debit account and where it appears in financial reports within the accounting system. Possible values: Asset, Equity, Expense, Income, Liability, Unknown. * @example Asset */ type: string; }; /** @description Schema for updating an existing ledger account. */ LedgerAccountUpdateRequest: { /** @description Description of the ledger account */ description?: string; /** @description Name of the ledger account */ name?: string; /** @description Account code in the accounting system */ nominal_code?: string; }; LineItem: { /** * Format: uuid * @description ID of the tax rate in the connected accounting system, to be used when pushing the invoice to that accounting system. Use `GET /accounting_tax_rates` to get these IDs. If omitted, Monite will attempt to match the tax rates based on their numeric value. */ accounting_tax_rate_id?: string; /** * Format: uuid * @description Unique identifier of the user-defined tax rate object. */ custom_tax_rate_id?: string; /** @description The discount for a product. */ discount?: components["schemas"]["Discount"]; /** @description Object of product. Can be used instead of product_id, created in product's catalog */ product?: components["schemas"]["LineItemProductCreate"]; /** * Format: uuid * @description Unique identifier of the product. */ product_id?: string; /** @description The quantity of each of the goods, materials, or services listed in the receivable. */ quantity: number; /** @description Specifies the display name of the tax rate. This field is applicable only when tax_rate_value is also provided. */ tax_rate_name?: string; /** @description Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries. */ tax_rate_value?: number; /** * @description Tax applicability status of the line item. Possible values: * * * `taxable` (default) - Standard tax behavior. Requires the tax rate to be specified. * * `exempt` - Line item is exempt from taxes. Exempt items are not included in total tax calculations. * * `non_taxable` - Line item is outside the tax scope entirely, cannot have tax rates. * @default taxable */ tax_status: components["schemas"]["TaxStatusEnum"]; }; LineItemColumnSettings: { /** @default true */ display: boolean; /** @description Line item table column header to override Monite's default. If not set, the Monite's default will be used. */ label?: string; }; /** @enum {string} */ LineItemCursorFields: "created_at" | "updated_at"; LineItemFields: { /** * @description Object describing the required field `measure_unit` of a line item's product * @default { * "description": "Unit used to measure the quantity of the product (e.g. items, meters, kilograms)", * "required": false * } */ measure_unit: components["schemas"]["FieldSchema"]; /** * @description Object describing the required field `tax_rate_value` of a line item * @default { * "description": "Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries.", * "required": false * } */ tax_rate_value: components["schemas"]["FieldSchema"]; /** * @description Object describing the required field `vat_rate_id` of a line item * @default { * "description": "Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan.", * "required": false * } */ vat_rate_id: components["schemas"]["FieldSchema"]; }; LineItemInternalRequest: { /** * Format: uuid * @description ID of the tax rate reference used for accounting integration. May be used to override auto-picked tax rate reference in accounting platform in case of any platform-specific constraints. * @example dd13735f-ef3a-4312-8c37-835d70341375 */ accounting_tax_rate_id?: string; /** @description Description of the product. */ description?: string; /** * Format: uuid * @description ID of the account record used to store bookkeeping entries for balance-sheet and income-statement transactions. * @example 7df884fd-8be8-4eba-b6ff-417b66efe033 */ ledger_account_id?: string; /** @description Name of the product. */ name?: string; /** * @description The quantity of each of the goods, materials, or services listed in the payable. * @example 1.22 */ quantity?: number; subtotal?: number; /** * @description Tax rate in percent [minor units](https://docs.monite.com/references/currencies#minor-units). Example: 12.5% is 1250. * @example 1250 */ tax?: number; total?: number; /** * @description The unit of the product * @example meter */ unit?: string; /** * @description The unit price of the product, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 1200 */ unit_price?: number; }; /** @description Extended settings for numeric columns in line items. */ LineItemNumericColumnSettings: { /** @default true */ display: boolean; /** @description Line item table column header to override Monite's default. If not set, the Monite's default will be used. */ label?: string; /** @description Number of decimal places to display for numeric values in this column. */ precision?: number; }; LineItemPaginationResponse: { data: components["schemas"]["LineItemResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; LineItemProduct: { /** * Format: uuid * @description Unique ID of the product. */ id: string; /** * Format: uuid * @description Unique identifier of the accounting tax rate object. */ accounting_tax_rate_id?: string; /** @description Description of the product. */ description?: string; /** * @description A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog. * @example HT-1234-S-BL * @example SERVICE-67890 */ external_reference?: string; /** * @description Indicates whether the product is inline * @default false */ is_inline: boolean; /** Format: uuid */ ledger_account_id?: string; measure_unit?: components["schemas"]["LineItemProductMeasureUnit"]; /** @description Name of the product. */ name: string; price: components["schemas"]["Price"]; price_after_tax: components["schemas"]["Price"]; /** @description The smallest amount allowed for this product. */ smallest_amount?: number; tax_rate: components["schemas"]["LineItemProductTaxRate"]; /** * @description Specifies whether this offering is a product or service. This may affect the applicable tax rates. * @default product */ type: components["schemas"]["ProductServiceTypeEnum"]; }; LineItemProductCreate: { /** @description Description of the product. */ description?: string; /** * @description A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog. * @example HT-1234-S-BL * @example SERVICE-67890 */ external_reference?: string; /** Format: uuid */ ledger_account_id?: string; measure_unit?: components["schemas"]["UnitRequest"]; /** @description Name of the product. */ name: string; price: components["schemas"]["Price"]; /** @description The smallest amount allowed for this product. */ smallest_amount?: number; /** * @description Specifies whether this offering is a product or service. This may affect the applicable tax rates. * @default product */ type: components["schemas"]["ProductServiceTypeEnum"]; }; LineItemProductMeasureUnit: { /** Format: uuid */ id?: string; description?: string; name: string; }; LineItemProductTaxRate: { /** * Format: uuid * @description Unique identifier of the tax rate object. */ id?: string; /** @description Sub-taxes included in the VAT. */ components?: components["schemas"]["VatRateComponent"][]; /** * @description Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). * @example US */ country: components["schemas"]["AllowedCountries"]; /** * @description Indicates whether this tax rate is defined by user. * @default false */ is_custom: boolean; /** @description Display name of the tax rate. */ name?: string; /** @description Percent minor units. Example: 12.5% is 1250. */ value: number; }; LineItemRequest: { /** * Format: uuid * @description ID of the tax rate reference used for accounting integration. May be used to override auto-picked tax rate reference in accounting platform in case of any platform-specific constraints. * @example dd13735f-ef3a-4312-8c37-835d70341375 */ accounting_tax_rate_id?: string; /** @description Description of the product. */ description?: string; /** * Format: uuid * @description ID of the account record used to store bookkeeping entries for balance-sheet and income-statement transactions. * @example 7df884fd-8be8-4eba-b6ff-417b66efe033 */ ledger_account_id?: string; /** @description Name of the product. */ name?: string; /** * @description The quantity of each of the goods, materials, or services listed in the payable. * @example 1.22 */ quantity?: number; /** * @description Tax rate in percent [minor units](https://docs.monite.com/references/currencies#minor-units). Example: 12.5% is 1250. * @example 1250 */ tax?: number; /** * @description The unit of the product * @example meter */ unit?: string; /** * @description The unit price of the product, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 1200 */ unit_price?: number; }; LineItemResponse: { /** Format: uuid */ id: string; /** * Format: uuid * @description ID of the tax rate reference used for accounting integartion. May be used to override auto-picked tax rate reference in accounting platform in case of any platform-specific constraints. * @example dd13735f-ef3a-4312-8c37-835d70341375 */ accounting_tax_rate_id?: string; /** @description Description of the product. */ description?: string; /** * Format: uuid * @description ID of the account record used to store bookkeeping entries for balance-sheet and income-statement transactions. * @example 7df884fd-8be8-4eba-b6ff-417b66efe033 */ ledger_account_id?: string; /** @description Name of the product. */ name?: string; /** * @description Indicates whether the item's `unit_price` and `quantity` were adjusted by OCR. * @default false * @example false */ ocr_set_quantity_to_one: boolean; /** Format: uuid */ payable_id: string; /** * @description The quantity of each of the goods, materials, or services listed in the payable. * @example 1.22 */ quantity?: number; /** * @description The subtotal (excluding tax), in [minor units](https://docs.monite.com/references/currencies#minor-units). * @example 1250 */ subtotal?: number; /** * @description Tax rate in percent [minor units](https://docs.monite.com/references/currencies#minor-units). Example: 12.5% is 1250. * @example 2000 */ tax?: number; /** * @description Tax amount in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 250 */ tax_amount?: number; /** * @description The actual price of the product. * @example 1200 */ total?: number; /** * @description The unit of the product * @example meter */ unit?: string; /** * @description The unit price of the product, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 1500 */ unit_price?: number; /** * Format: uuid * @description ID of the user who created the tag. * @example ea837e28-509b-4b6a-a600-d54b6aa0b1f5 */ was_created_by_user_id?: string; }; LineItemUpdate: { /** * Format: uuid * @description Unique identifier of the user-defined tax rate object. */ custom_tax_rate_id?: string; /** @description The discount for a product. */ discount?: components["schemas"]["Discount"]; /** @description The actual price of the product in [minor units](https://docs.monite.com/references/currencies#minor-units). */ price?: number; /** @description The quantity of each of the goods, materials, or services listed in the receivable. */ quantity?: number; /** @description Specifies the display name of the tax rate. This field is applicable only when tax_rate_value is also provided. */ tax_rate_name?: string; /** @description Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries. */ tax_rate_value?: number; /** * @description Tax applicability status of the line item. Possible values: * * * `taxable` (default) - Standard tax behavior. Requires the tax rate to be specified. * * `exempt` - Line item is exempt from taxes. Exempt items are not included in total tax calculations. * * `non_taxable` - Line item is outside the tax scope entirely, cannot have tax rates. */ tax_status?: components["schemas"]["TaxStatusEnum"]; }; LineItemsBlock: { amount_due?: string; amount_due_header?: string; /** @description This list contain all amounts that was paid or credits that were issued for this invoice */ amounts_reduced?: components["schemas"]["LineItemsBlockAmountReduced"][]; currency?: string; deductions?: components["schemas"]["LineItemsBlockDeduction"][]; /** @default Discount */ discount_header: string; discounted_subtotal?: string; /** @default Discounted subtotal */ discounted_subtotal_header: string; global_discount?: string; global_discount_data?: components["schemas"]["GlobalDiscount"]; line_items?: components["schemas"]["LineItemsBlockLineItem"][]; subtotal?: string; subtotal_after_tax?: string; subtotal_after_tax_header?: string; /** @default Subtotal */ subtotal_header: string; table_columns_keys?: components["schemas"]["LineItemsColumns"][]; table_headers?: string[]; tax_exemption_rationale?: string; /** @default false */ tax_inclusive_discount: boolean; /** @default false */ tax_mode_inclusive: boolean; total_amount?: string; /** @default Total */ total_header: string; /** @default Total VAT */ total_vat_header: string; total_vats?: components["schemas"]["LineItemsBlockTotalVat"][]; total_withholding_tax?: string; vat_name?: string; /** @default Withholding tax */ withholding_tax_header: string; withholding_tax_rate?: string; }; LineItemsBlockAmountReduced: { amount?: string; header?: string; }; LineItemsBlockDeduction: { amount?: string; memo?: string; name?: string; }; LineItemsBlockLineItem: { description?: string; discount?: string; measure_unit?: string; name?: string; price?: string; price_after_tax?: string; quantity?: string; tax_rate?: string; total_price?: string; total_price_after_tax?: string; vat_amount?: string; }; LineItemsBlockTotalVat: { amount?: string; name?: string; percent?: string; }; /** @enum {string} */ LineItemsColumns: "order" | "name" | "description" | "quantity" | "measure_unit" | "price" | "price_after_tax" | "total_price" | "total_price_after_tax" | "discount" | "tax_rate" | "vat_amount"; LineItemsRenderingSettings: { /** @description Settings for the discount column in the line items table. */ discount?: components["schemas"]["LineItemColumnSettings"]; /** @description Settings for the measure unit column in the line items table. */ measure_unit?: components["schemas"]["LineItemColumnSettings"]; /** @description Settings for the name column in the line items table. */ name?: components["schemas"]["LineItemColumnSettings"]; /** @description Settings for the price column in the line items table. */ price?: components["schemas"]["LineItemNumericColumnSettings"]; /** @description Settings for the price after tax column in the line items table. */ price_after_tax?: components["schemas"]["LineItemNumericColumnSettings"]; /** @description Settings for the quantity column in the line items table. */ quantity?: components["schemas"]["LineItemColumnSettings"]; /** @description Settings for the tax rate column in the line items table. */ tax_rate?: components["schemas"]["LineItemNumericColumnSettings"]; /** @description Settings for the total price column in the line items table. */ total_price?: components["schemas"]["LineItemNumericColumnSettings"]; /** @description Settings for the total price after tax column in the line items table. */ total_price_after_tax?: components["schemas"]["LineItemNumericColumnSettings"]; /** * @description Settings for the VAT amount column in the line items table. * @default { * "display": false * } */ vat_amount: components["schemas"]["LineItemNumericColumnSettings"]; }; LineItemsReplaceRequest: { data: components["schemas"]["LineItemInternalRequest"][]; }; LineItemsReplaceResponse: { data: components["schemas"]["LineItemResponse"][]; }; LineItemsResponse: { data: components["schemas"]["ResponseItem"][]; }; LocationDetail: { /** Format: uuid */ id: string; /** Format: date-time */ createdDateTime: string; members: components["schemas"]["PaginatedResponseOfLocationMember"]; name: string; /** Format: date-time */ updatedDateTime: string; }; LocationListItem: { /** Format: uuid */ id: string; /** Format: date-time */ createdDateTime: string; /** Format: int32 */ memberCount: number | string; name: string; /** Format: date-time */ updatedDateTime: string; }; LocationMember: { /** Format: uuid */ id: string; /** Format: date-time */ createdDateTime: string; email: string; jobTitle?: null | string; /** Format: date-time */ lastLoggedInDateTime?: null | string; name: string; status: string; }; LockCreditCardRequest: { locked: boolean; }; /** @description Contains information about a sent email. */ MailSentEventData: { /** * Format: uuid * @description ID of the email sending operation. Can be used to get the email sending status from `GET /receivables/{receivable_id}/mails/{mail_id}`. * @example d6185c8d-527c-4586-84c9-95881e7ba19f */ mail_id: string; /** @description The overall email sending status across all recipients. */ mail_status: components["schemas"]["ReceivableMailStatusEnum"]; /** @description Contains a list of email recipients (To, CC, BCC) and the email sending status for each recipient. */ recipients: components["schemas"]["ReceivableMailRecipients"]; }; MailSettings: { /** * @description Attach documents as PDF in emails. * @default true */ attach_documents_as_pdf: boolean; from_email_username?: string | null; from_name?: string | null; }; MailboxDataResponse: { data: components["schemas"]["MailboxResponse"][] | null; }; MailboxDomainRequest: { /** Format: uuid */ mailbox_domain_id: string; mailbox_name: string; /** @description Related object type: payable and so on */ related_object_type: components["schemas"]["MailboxObjectTypeEnum"]; }; MailboxMultipleEntitiesRequest: { entity_ids: string[]; }; /** @enum {string} */ MailboxObjectTypeEnum: "payable" | "receipt"; MailboxResponse: { /** * Format: uuid * @description Mailbox UUID */ id: string; mailbox_domain_id: string | null; mailbox_full_address: string; mailbox_name: string; related_object_type: string; status: string; }; /** @description Request to manage access to bank accounts for users (grant or revoke). */ ManageBankAccountAccessRequest: { /** @description List of bank accounts to manage access for. */ bankAccounts: components["schemas"]["BankAccountWithSourceInput"][]; /** @description The type of access operation to perform. */ type: components["schemas"]["BankAccountAccessActionType"]; /** @description List of user IDs to grant or revoke access for. */ userIds: string[]; }; ManuallySpecifiedBankAccountPayload: { bank_id: string; /** @default false */ iframe: boolean; payer_account_country: components["schemas"]["YapilyCountriesCoverageCodes"]; payer_account_holder_name?: string; payer_account_identification: components["schemas"]["AccountIdentification"]; /** @description PSU identification is required for some banks (e.g. some Germany institutions). */ psu_identification?: components["schemas"]["PsuIdentification"]; /** @default false */ save_to_authorized: boolean; /** * @description discriminator enum property added by openapi-typescript * @enum {string} */ type: "manual_input"; }; MeAddressDto: { address1?: null | string; address2?: null | string; city?: null | string; countryCode?: null | components["schemas"]["CountryCode"]; postalCode?: null | string; state?: null | string; }; /** @description Profile information for the currently authenticated user. */ MeResponseDto: { /** Format: uuid */ id: string; address?: null | components["schemas"]["MeAddressDto"]; email: string; isExpenseApprover: boolean; jobTitle?: null | string; /** Format: date-time */ lastLoggedInDateTime?: null | string; name: string; /** Format: uuid */ organizationId: string; permissions: string[]; phoneNumber?: null | string; role: string; status: components["schemas"]["UserStatus"]; }; /** @enum {string} */ MeasureUnitEnum: "volume_in_euro" | "transactions"; Media: { /** Format: uri */ source: string; type: string; }; MemoBlock: { memo?: string; memo_header?: string; }; /** * @description A single Merchant Category Code Group (MCCG) pre-configured for the institution — a named set of * merchant category codes that can be white-listed as an authorization control during card issuance. */ MerchantCategoryGroupResponse: { /** @description Description of the MCC group. */ description?: null | string; /** * Format: date * @description Date the MCCG's effective period ends. */ endDate?: null | string; /** @description Unique identifier for the group of Merchant Category Codes (MCCs). */ groupId: string; /** * Format: date * @description Date the MCCG becomes effective. */ startDate?: null | string; }; MissingFields: { /** @description Missing fields of counterpart. */ counterpart?: string[]; /** @description Missing fields of entity. */ entity?: string[]; /** @description Missing fields of line items. */ products?: components["schemas"]["MissingLineItemFields"][]; /** @description Missing fields of receivable. */ receivable?: string[]; /** @description List of invalid vat rates. */ vat_rates?: string[]; }; MissingLineItemFields: { /** @description Order number of line item. */ line_item_number: number; /** @description Missing fields of line item. */ missing_fields: string[]; }; /** @description Response model for a money movement operation. */ MoneyMovementResponse: { /** * Format: uuid * @description Unique money movement identifier. */ id: string; /** @description Money movement amount. */ amount: components["schemas"]["AmountOutput"]; /** * Format: date * @description Money movement date. */ date: string; /** @description Source bank account information. */ fromBankAccount: components["schemas"]["BankAccountInfo"]; /** @description Payment network: BOOK, ACH, RTP, or FED_NOW. */ network: components["schemas"]["BankAccountTransferNetworkTypeDto"]; /** @description Money movement status. */ status: components["schemas"]["BankAccountTransferStatusDto"]; /** @description Destination bank account information. */ toBankAccount: components["schemas"]["BankAccountInfo"]; }; /** @enum {string} */ MoniteAllPaymentMethods: "SEPA Payments" | "US ACH Payments" | "BLIK" | "Card payments" | "Bacs Direct Debit" | "Bancontact" | "Electronic Payment Standard" | "Giropay" | "iDEAL" | "Przelewy24" | "SEPA Direct Debit" | "SOFORT" | "Apple Pay" | "Google Pay" | "Affirm" | "Klarna"; /** @enum {string} */ MoniteAllPaymentMethodsTypes: "sepa_credit" | "us_ach" | "blik" | "card" | "bacs_direct_debit" | "bancontact" | "eps" | "giropay" | "ideal" | "p24" | "sepa_debit" | "sofort" | "applepay" | "googlepay" | "affirm" | "klarna"; MultipleAmountPredicate: { /** * @description Predicate name * @enum {string} */ name: "amount"; /** * @description Predicate operator (enum property replaced by openapi-typescript) * @enum {string} */ operator: "RANGE"; /** @description Predicate comparison value */ value: number[]; }; MultipleCountryPredicate: { /** * @description Predicate name * @enum {string} */ name: "entity_country" | "counterpart_country" | "entity_vat_country" | "counterpart_vat_country"; /** * @description Predicate operator (enum property replaced by openapi-typescript) * @enum {string} */ operator: "IN" | "NOT_IN"; /** @description Predicate comparison value */ value: components["schemas"]["AllowedCountries"][]; }; MultipleItemTypePredicate: { /** * @description Predicate name * @enum {string} */ name: "item_type"; /** * @description Predicate operator (enum property replaced by openapi-typescript) * @enum {string} */ operator: "IN" | "ALL"; /** @description Predicate comparison value */ value: components["schemas"]["ProductServiceTypeEnum"][]; }; NextDocumentNumbers: { /** * @description Next credit note number * @default 1 */ credit_note: number; /** * @description Next delivery note number * @default 1 */ delivery_note: number; /** * @description Next invoice number * @default 1 */ invoice: number; /** * @description Next purchase order number * @default 1 */ purchase_order: number; /** * @description Next quote number * @default 1 */ quote: number; }; /** @enum {string} */ NorthAmericanIndustryClassificationSystemCode: "SOYBEAN_FARMING" | "OILSEED_EXCEPT_SOYBEAN_FARMING" | "DRY_PEA_AND_BEAN_FARMING" | "WHEAT_FARMING" | "CORN_FARMING" | "RICE_FARMING" | "OILSEED_AND_GRAIN_COMBINATION_FARMING" | "ALL_OTHER_GRAIN_FARMING" | "POTATO_FARMING" | "OTHER_VEGETABLE_EXCEPT_POTATO_AND_MELON_FARMING" | "ORANGE_GROVES" | "CITRUS_EXCEPT_ORANGE_GROVES" | "APPLE_ORCHARDS" | "GRAPE_VINEYARDS" | "STRAWBERRY_FARMING" | "BERRY_EXCEPT_STRAWBERRY_FARMING" | "TREE_NUT_FARMING" | "FRUIT_AND_TREE_NUT_COMBINATION_FARMING" | "OTHER_NONCITRUS_FRUIT_FARMING" | "MUSHROOM_PRODUCTION" | "OTHER_FOOD_CROPS_GROWN_UNDER_COVER" | "NURSERY_AND_TREE_PRODUCTION" | "FLORICULTURE_PRODUCTION" | "TOBACCO_FARMING" | "COTTON_FARMING" | "SUGARCANE_FARMING" | "HAY_FARMING" | "SUGAR_BEET_FARMING" | "PEANUT_FARMING" | "ALL_OTHER_MISCELLANEOUS_CROP_FARMING" | "BEEF_CATTLE_RANCHING_AND_FARMING" | "CATTLE_FEEDLOTS" | "DAIRY_CATTLE_AND_MILK_PRODUCTION" | "DUAL_PURPOSE_CATTLE_RANCHING_AND_FARMING" | "HOG_AND_PIG_FARMING" | "CHICKEN_EGG_PRODUCTION" | "BROILERS_AND_OTHER_MEAT_TYPE_CHICKEN_PRODUCTION" | "TURKEY_PRODUCTION" | "POULTRY_HATCHERIES" | "OTHER_POULTRY_PRODUCTION" | "SHEEP_FARMING" | "GOAT_FARMING" | "FINFISH_FARMING_AND_FISH_HATCHERIES" | "SHELLFISH_FARMING" | "OTHER_AQUACULTURE" | "APICULTURE" | "HORSES_AND_OTHER_EQUINE_PRODUCTION" | "FUR_BEARING_ANIMAL_AND_RABBIT_PRODUCTION" | "ALL_OTHER_ANIMAL_PRODUCTION" | "TIMBER_TRACT_OPERATIONS" | "FOREST_NURSERIES_AND_GATHERING_OF_FOREST_PRODUCTS" | "LOGGING" | "FINFISH_FISHING" | "SHELLFISH_FISHING" | "OTHER_MARINE_FISHING" | "HUNTING_AND_TRAPPING" | "COTTON_GINNING" | "SOIL_PREPARATION_PLANTING_AND_CULTIVATING" | "CROP_HARVESTING_PRIMARILY_BY_MACHINE" | "POSTHARVEST_CROP_ACTIVITIES_EXCEPT_COTTON_GINNING" | "FARM_LABOR_CONTRACTORS_AND_CREW_LEADERS" | "FARM_MANAGEMENT_SERVICES" | "SUPPORT_ACTIVITIES_FOR_ANIMAL_PRODUCTION" | "SUPPORT_ACTIVITIES_FOR_FORESTRY" | "CRUDE_PETROLEUM_EXTRACTION" | "NATURAL_GAS_EXTRACTION" | "SURFACE_COAL_MINING" | "UNDERGROUND_COAL_MINING" | "IRON_ORE_MINING" | "GOLD_ORE_AND_SILVER_ORE_MINING" | "COPPER_NICKEL_LEAD_AND_ZINC_MINING" | "OTHER_METAL_ORE_MINING" | "DIMENSION_STONE_MINING_AND_QUARRYING" | "CRUSHED_AND_BROKEN_LIMESTONE_MINING_AND_QUARRYING" | "CRUSHED_AND_BROKEN_GRANITE_MINING_AND_QUARRYING" | "OTHER_CRUSHED_AND_BROKEN_STONE_MINING_AND_QUARRYING" | "CONSTRUCTION_SAND_AND_GRAVEL_MINING" | "INDUSTRIAL_SAND_MINING" | "KAOLIN_CLAY_AND_CERAMIC_AND_REFRACTORY_MINERALS_MINING" | "OTHER_NONMETALLIC_MINERAL_MINING_AND_QUARRYING" | "DRILLING_OIL_AND_GAS_WELLS" | "SUPPORT_ACTIVITIES_FOR_OIL_AND_GAS_OPERATIONS" | "SUPPORT_ACTIVITIES_FOR_COAL_MINING" | "SUPPORT_ACTIVITIES_FOR_METAL_MINING" | "SUPPORT_ACTIVITIES_FOR_NONMETALLIC_MINERALS_EXCEPT_FUELS_MINING" | "HYDROELECTRIC_POWER_GENERATION" | "FOSSIL_FUEL_ELECTRIC_POWER_GENERATION" | "NUCLEAR_ELECTRIC_POWER_GENERATION" | "SOLAR_ELECTRIC_POWER_GENERATION" | "WIND_ELECTRIC_POWER_GENERATION" | "GEOTHERMAL_ELECTRIC_POWER_GENERATION" | "BIOMASS_ELECTRIC_POWER_GENERATION" | "OTHER_ELECTRIC_POWER_GENERATION" | "ELECTRIC_BULK_POWER_TRANSMISSION_AND_CONTROL" | "ELECTRIC_POWER_DISTRIBUTION" | "NATURAL_GAS_DISTRIBUTION" | "WATER_SUPPLY_AND_IRRIGATION_SYSTEMS" | "SEWAGE_TREATMENT_FACILITIES" | "STEAM_AND_AIR_CONDITIONING_SUPPLY" | "NEW_SINGLE_FAMILY_HOUSING_CONSTRUCTION_EXCEPT_FOR_SALE_BUILDERS" | "NEW_MULTIFAMILY_HOUSING_CONSTRUCTION_EXCEPT_FOR_SALE_BUILDERS" | "NEW_HOUSING_FOR_SALE_BUILDERS" | "RESIDENTIAL_REMODELERS" | "INDUSTRIAL_BUILDING_CONSTRUCTION" | "COMMERCIAL_AND_INSTITUTIONAL_BUILDING_CONSTRUCTION" | "WATER_AND_SEWER_LINE_AND_RELATED_STRUCTURES_CONSTRUCTION" | "OIL_AND_GAS_PIPELINE_AND_RELATED_STRUCTURES_CONSTRUCTION" | "POWER_AND_COMMUNICATION_LINE_AND_RELATED_STRUCTURES_CONSTRUCTION" | "LAND_SUBDIVISION" | "HIGHWAY_STREET_AND_BRIDGE_CONSTRUCTION" | "OTHER_HEAVY_AND_CIVIL_ENGINEERING_CONSTRUCTION" | "POURED_CONCRETE_FOUNDATION_AND_STRUCTURE_CONTRACTORS" | "STRUCTURAL_STEEL_AND_PRECAST_CONCRETE_CONTRACTORS" | "FRAMING_CONTRACTORS" | "MASONRY_CONTRACTORS" | "GLASS_AND_GLAZING_CONTRACTORS" | "ROOFING_CONTRACTORS" | "SIDING_CONTRACTORS" | "OTHER_FOUNDATION_STRUCTURE_AND_BUILDING_EXTERIOR_CONTRACTORS" | "ELECTRICAL_CONTRACTORS_AND_OTHER_WIRING_INSTALLATION_CONTRACTORS" | "PLUMBING_HEATING_AND_AIR_CONDITIONING_CONTRACTORS" | "OTHER_BUILDING_EQUIPMENT_CONTRACTORS" | "DRYWALL_AND_INSULATION_CONTRACTORS" | "PAINTING_AND_WALL_COVERING_CONTRACTORS" | "FLOORING_CONTRACTORS" | "TILE_AND_TERRAZZO_CONTRACTORS" | "FINISH_CARPENTRY_CONTRACTORS" | "OTHER_BUILDING_FINISHING_CONTRACTORS" | "SITE_PREPARATION_CONTRACTORS" | "ALL_OTHER_SPECIALTY_TRADE_CONTRACTORS" | "DOG_AND_CAT_FOOD_MANUFACTURING" | "OTHER_ANIMAL_FOOD_MANUFACTURING" | "FLOUR_MILLING" | "RICE_MILLING" | "MALT_MANUFACTURING" | "WET_CORN_MILLING_AND_STARCH_MANUFACTURING" | "SOYBEAN_AND_OTHER_OILSEED_PROCESSING" | "FATS_AND_OILS_REFINING_AND_BLENDING" | "BREAKFAST_CEREAL_MANUFACTURING" | "BEET_SUGAR_MANUFACTURING" | "CANE_SUGAR_MANUFACTURING" | "NONCHOCOLATE_CONFECTIONERY_MANUFACTURING" | "CHOCOLATE_AND_CONFECTIONERY_MANUFACTURING_FROM_CACAO_BEANS" | "CONFECTIONERY_MANUFACTURING_FROM_PURCHASED_CHOCOLATE" | "FROZEN_FRUIT_JUICE_AND_VEGETABLE_MANUFACTURING" | "FROZEN_SPECIALTY_FOOD_MANUFACTURING" | "FRUIT_AND_VEGETABLE_CANNING" | "SPECIALTY_CANNING" | "DRIED_AND_DEHYDRATED_FOOD_MANUFACTURING" | "FLUID_MILK_MANUFACTURING" | "CREAMERY_BUTTER_MANUFACTURING" | "CHEESE_MANUFACTURING" | "DRY_CONDENSED_AND_EVAPORATED_DAIRY_PRODUCT_MANUFACTURING" | "ICE_CREAM_AND_FROZEN_DESSERT_MANUFACTURING" | "ANIMAL_EXCEPT_POULTRY_SLAUGHTERING" | "MEAT_PROCESSED_FROM_CARCASSES" | "RENDERING_AND_MEAT_BYPRODUCT_PROCESSING" | "POULTRY_PROCESSING" | "SEAFOOD_PRODUCT_PREPARATION_AND_PACKAGING" | "RETAIL_BAKERIES" | "COMMERCIAL_BAKERIES" | "FROZEN_CAKES_PIES_AND_OTHER_PASTRIES_MANUFACTURING" | "COOKIE_AND_CRACKER_MANUFACTURING" | "DRY_PASTA_DOUGH_AND_FLOUR_MIXES_MANUFACTURING_FROM_PURCHASED_FLOUR" | "TORTILLA_MANUFACTURING" | "ROASTED_NUTS_AND_PEANUT_BUTTER_MANUFACTURING" | "OTHER_SNACK_FOOD_MANUFACTURING" | "COFFEE_AND_TEA_MANUFACTURING" | "FLAVORING_SYRUP_AND_CONCENTRATE_MANUFACTURING" | "MAYONNAISE_DRESSING_AND_OTHER_PREPARED_SAUCE_MANUFACTURING" | "SPICE_AND_EXTRACT_MANUFACTURING" | "PERISHABLE_PREPARED_FOOD_MANUFACTURING" | "ALL_OTHER_MISCELLANEOUS_FOOD_MANUFACTURING" | "SOFT_DRINK_MANUFACTURING" | "BOTTLED_WATER_MANUFACTURING" | "ICE_MANUFACTURING" | "BREWERIES" | "WINERIES" | "DISTILLERIES" | "TOBACCO_MANUFACTURING" | "FIBER_YARN_AND_THREAD_MILLS" | "BROADWOVEN_FABRIC_MILLS" | "NARROW_FABRIC_MILLS_AND_SCHIFFLI_MACHINE_EMBROIDERY" | "NONWOVEN_FABRIC_MILLS" | "KNIT_FABRIC_MILLS" | "TEXTILE_AND_FABRIC_FINISHING_MILLS" | "FABRIC_COATING_MILLS" | "CARPET_AND_RUG_MILLS" | "CURTAIN_AND_LINEN_MILLS" | "TEXTILE_BAG_AND_CANVAS_MILLS" | "ROPE_CORDAGE_TWINE_TIRE_CORD_AND_TIRE_FABRIC_MILLS" | "ALL_OTHER_MISCELLANEOUS_TEXTILE_PRODUCT_MILLS" | "APPAREL_KNITTING_MILLS" | "CUT_AND_SEW_APPAREL_CONTRACTORS" | "CUT_AND_SEW_APPAREL_MANUFACTURING_EXCEPT_CONTRACTORS" | "APPAREL_ACCESSORIES_AND_OTHER_APPAREL_MANUFACTURING" | "LEATHER_AND_HIDE_TANNING_AND_FINISHING" | "FOOTWEAR_MANUFACTURING" | "OTHER_LEATHER_AND_ALLIED_PRODUCT_MANUFACTURING" | "SAWMILLS" | "WOOD_PRESERVATION" | "HARDWOOD_VENEER_AND_PLYWOOD_MANUFACTURING" | "SOFTWOOD_VENEER_AND_PLYWOOD_MANUFACTURING" | "ENGINEERED_WOOD_MEMBER_MANUFACTURING" | "RECONSTITUTED_WOOD_PRODUCT_MANUFACTURING" | "WOOD_WINDOW_AND_DOOR_MANUFACTURING" | "CUT_STOCK_RESAWING_LUMBER_AND_PLANING" | "OTHER_MILLWORK_INCLUDING_FLOORING" | "WOOD_CONTAINER_AND_PALLET_MANUFACTURING" | "MANUFACTURED_HOME_MOBILE_HOME_MANUFACTURING" | "PREFABRICATED_WOOD_BUILDING_MANUFACTURING" | "ALL_OTHER_MISCELLANEOUS_WOOD_PRODUCT_MANUFACTURING" | "PULP_MILLS" | "PAPER_MILLS" | "PAPERBOARD_MILLS" | "CORRUGATED_AND_SOLID_FIBER_BOX_MANUFACTURING" | "FOLDING_PAPERBOARD_BOX_MANUFACTURING" | "OTHER_PAPERBOARD_CONTAINER_MANUFACTURING" | "PAPER_BAG_AND_COATED_AND_TREATED_PAPER_MANUFACTURING" | "STATIONERY_PRODUCT_MANUFACTURING" | "SANITARY_PAPER_PRODUCT_MANUFACTURING" | "ALL_OTHER_CONVERTED_PAPER_PRODUCT_MANUFACTURING" | "COMMERCIAL_PRINTING_EXCEPT_SCREEN_AND_BOOKS" | "COMMERCIAL_SCREEN_PRINTING" | "BOOKS_PRINTING" | "SUPPORT_ACTIVITIES_FOR_PRINTING" | "PETROLEUM_REFINERIES" | "ASPHALT_PAVING_MIXTURE_AND_BLOCK_MANUFACTURING" | "ASPHALT_SHINGLE_AND_COATING_MATERIALS_MANUFACTURING" | "PETROLEUM_LUBRICATING_OIL_AND_GREASE_MANUFACTURING" | "ALL_OTHER_PETROLEUM_AND_COAL_PRODUCTS_MANUFACTURING" | "PETROCHEMICAL_MANUFACTURING" | "INDUSTRIAL_GAS_MANUFACTURING" | "SYNTHETIC_DYE_AND_PIGMENT_MANUFACTURING" | "OTHER_BASIC_INORGANIC_CHEMICAL_MANUFACTURING" | "ETHYL_ALCOHOL_MANUFACTURING" | "CYCLIC_CRUDE_INTERMEDIATE_AND_GUM_AND_WOOD_CHEMICAL_MANUFACTURING" | "ALL_OTHER_BASIC_ORGANIC_CHEMICAL_MANUFACTURING" | "PLASTICS_MATERIAL_AND_RESIN_MANUFACTURING" | "SYNTHETIC_RUBBER_MANUFACTURING" | "ARTIFICIAL_AND_SYNTHETIC_FIBERS_AND_FILAMENTS_MANUFACTURING" | "NITROGENOUS_FERTILIZER_MANUFACTURING" | "PHOSPHATIC_FERTILIZER_MANUFACTURING" | "FERTILIZER_MIXING_ONLY_MANUFACTURING" | "COMPOST_MANUFACTURING" | "PESTICIDE_AND_OTHER_AGRICULTURAL_CHEMICAL_MANUFACTURING" | "MEDICINAL_AND_BOTANICAL_MANUFACTURING" | "PHARMACEUTICAL_PREPARATION_MANUFACTURING" | "IN_VITRO_DIAGNOSTIC_SUBSTANCE_MANUFACTURING" | "BIOLOGICAL_PRODUCT_EXCEPT_DIAGNOSTIC_MANUFACTURING" | "PAINT_AND_COATING_MANUFACTURING" | "ADHESIVE_MANUFACTURING" | "SOAP_AND_OTHER_DETERGENT_MANUFACTURING" | "POLISH_AND_OTHER_SANITATION_GOOD_MANUFACTURING" | "SURFACE_ACTIVE_AGENT_MANUFACTURING" | "TOILET_PREPARATION_MANUFACTURING" | "PRINTING_INK_MANUFACTURING" | "EXPLOSIVES_MANUFACTURING" | "CUSTOM_COMPOUNDING_OF_PURCHASED_RESINS" | "PHOTOGRAPHIC_FILM_PAPER_PLATE_CHEMICAL_AND_COPY_TONER_MANUFACTURING" | "ALL_OTHER_MISCELLANEOUS_CHEMICAL_PRODUCT_AND_PREPARATION_MANUFACTURING" | "PLASTICS_BAG_AND_POUCH_MANUFACTURING" | "PLASTICS_PACKAGING_FILM_AND_SHEET_INCLUDING_LAMINATED_MANUFACTURING" | "UNLAMINATED_PLASTICS_FILM_AND_SHEET_EXCEPT_PACKAGING_MANUFACTURING" | "UNLAMINATED_PLASTICS_PROFILE_SHAPE_MANUFACTURING" | "PLASTICS_PIPE_AND_PIPE_FITTING_MANUFACTURING" | "LAMINATED_PLASTICS_PLATE_SHEET_EXCEPT_PACKAGING_AND_SHAPE_MANUFACTURING" | "POLYSTYRENE_FOAM_PRODUCT_MANUFACTURING" | "URETHANE_AND_OTHER_FOAM_PRODUCT_EXCEPT_POLYSTYRENE_MANUFACTURING" | "PLASTICS_BOTTLE_MANUFACTURING" | "PLASTICS_PLUMBING_FIXTURE_MANUFACTURING" | "ALL_OTHER_PLASTICS_PRODUCT_MANUFACTURING" | "TIRE_MANUFACTURING_EXCEPT_RETREADING" | "TIRE_RETREADING" | "RUBBER_AND_PLASTICS_HOSES_AND_BELTING_MANUFACTURING" | "RUBBER_PRODUCT_MANUFACTURING_FOR_MECHANICAL_USE" | "ALL_OTHER_RUBBER_PRODUCT_MANUFACTURING" | "POTTERY_CERAMICS_AND_PLUMBING_FIXTURE_MANUFACTURING" | "CLAY_BUILDING_MATERIAL_AND_REFRACTORIES_MANUFACTURING" | "FLAT_GLASS_MANUFACTURING" | "OTHER_PRESSED_AND_BLOWN_GLASS_AND_GLASSWARE_MANUFACTURING" | "GLASS_CONTAINER_MANUFACTURING" | "GLASS_PRODUCT_MANUFACTURING_MADE_OF_PURCHASED_GLASS" | "CEMENT_MANUFACTURING" | "READY_MIX_CONCRETE_MANUFACTURING" | "CONCRETE_BLOCK_AND_BRICK_MANUFACTURING" | "CONCRETE_PIPE_MANUFACTURING" | "OTHER_CONCRETE_PRODUCT_MANUFACTURING" | "LIME_MANUFACTURING" | "GYPSUM_PRODUCT_MANUFACTURING" | "ABRASIVE_PRODUCT_MANUFACTURING" | "CUT_STONE_AND_STONE_PRODUCT_MANUFACTURING" | "GROUND_OR_TREATED_MINERAL_AND_EARTH_MANUFACTURING" | "MINERAL_WOOL_MANUFACTURING" | "ALL_OTHER_MISCELLANEOUS_NONMETALLIC_MINERAL_PRODUCT_MANUFACTURING" | "IRON_AND_STEEL_MILLS_AND_FERROALLOY_MANUFACTURING" | "IRON_AND_STEEL_PIPE_AND_TUBE_MANUFACTURING_FROM_PURCHASED_STEEL" | "ROLLED_STEEL_SHAPE_MANUFACTURING" | "STEEL_WIRE_DRAWING" | "ALUMINA_REFINING_AND_PRIMARY_ALUMINUM_PRODUCTION" | "SECONDARY_SMELTING_AND_ALLOYING_OF_ALUMINUM" | "ALUMINUM_SHEET_PLATE_AND_FOIL_MANUFACTURING" | "OTHER_ALUMINUM_ROLLING_DRAWING_AND_EXTRUDING" | "NONFERROUS_METAL_EXCEPT_ALUMINUM_SMELTING_AND_REFINING" | "COPPER_ROLLING_DRAWING_EXTRUDING_AND_ALLOYING" | "NONFERROUS_METAL_EXCEPT_COPPER_AND_ALUMINUM_ROLLING_DRAWING_AND_EXTRUDING" | "SECONDARY_SMELTING_REFINING_AND_ALLOYING_OF_NONFERROUS_METAL_EXCEPT_COPPER_AND_ALUMINUM" | "IRON_FOUNDRIES" | "STEEL_INVESTMENT_FOUNDRIES" | "STEEL_FOUNDRIES_EXCEPT_INVESTMENT" | "NONFERROUS_METAL_DIE_CASTING_FOUNDRIES" | "ALUMINUM_FOUNDRIES_EXCEPT_DIE_CASTING" | "OTHER_NONFERROUS_METAL_FOUNDRIES_EXCEPT_DIE_CASTING" | "IRON_AND_STEEL_FORGING" | "NONFERROUS_FORGING" | "CUSTOM_ROLL_FORMING" | "POWDER_METALLURGY_PART_MANUFACTURING" | "METAL_CROWN_CLOSURE_AND_OTHER_METAL_STAMPING_EXCEPT_AUTOMOTIVE" | "METAL_KITCHEN_COOKWARE_UTENSIL_CUTLERY_AND_FLATWARE_EXCEPT_PRECIOUS_MANUFACTURING" | "SAW_BLADE_AND_HANDTOOL_MANUFACTURING" | "PREFABRICATED_METAL_BUILDING_AND_COMPONENT_MANUFACTURING" | "FABRICATED_STRUCTURAL_METAL_MANUFACTURING" | "PLATE_WORK_MANUFACTURING" | "METAL_WINDOW_AND_DOOR_MANUFACTURING" | "SHEET_METAL_WORK_MANUFACTURING" | "ORNAMENTAL_AND_ARCHITECTURAL_METAL_WORK_MANUFACTURING" | "POWER_BOILER_AND_HEAT_EXCHANGER_MANUFACTURING" | "METAL_TANK_HEAVY_GAUGE_MANUFACTURING" | "METAL_CAN_MANUFACTURING" | "OTHER_METAL_CONTAINER_MANUFACTURING" | "HARDWARE_MANUFACTURING" | "SPRING_MANUFACTURING" | "OTHER_FABRICATED_WIRE_PRODUCT_MANUFACTURING" | "MACHINE_SHOPS" | "PRECISION_TURNED_PRODUCT_MANUFACTURING" | "BOLT_NUT_SCREW_RIVET_AND_WASHER_MANUFACTURING" | "METAL_HEAT_TREATING" | "METAL_COATING_ENGRAVING_EXCEPT_JEWELRY_AND_SILVERWARE_AND_ALLIED_SERVICES_TO_MANUFACTURERS" | "ELECTROPLATING_PLATING_POLISHING_ANODIZING_AND_COLORING" | "INDUSTRIAL_VALVE_MANUFACTURING" | "FLUID_POWER_VALVE_AND_HOSE_FITTING_MANUFACTURING" | "PLUMBING_FIXTURE_FITTING_AND_TRIM_MANUFACTURING" | "OTHER_METAL_VALVE_AND_PIPE_FITTING_MANUFACTURING" | "BALL_AND_ROLLER_BEARING_MANUFACTURING" | "SMALL_ARMS_AMMUNITION_MANUFACTURING" | "AMMUNITION_EXCEPT_SMALL_ARMS_MANUFACTURING" | "SMALL_ARMS_ORDNANCE_AND_ORDNANCE_ACCESSORIES_MANUFACTURING" | "FABRICATED_PIPE_AND_PIPE_FITTING_MANUFACTURING" | "ALL_OTHER_MISCELLANEOUS_FABRICATED_METAL_PRODUCT_MANUFACTURING" | "FARM_MACHINERY_AND_EQUIPMENT_MANUFACTURING" | "LAWN_AND_GARDEN_TRACTOR_AND_HOME_LAWN_AND_GARDEN_EQUIPMENT_MANUFACTURING" | "CONSTRUCTION_MACHINERY_MANUFACTURING" | "MINING_MACHINERY_AND_EQUIPMENT_MANUFACTURING" | "OIL_AND_GAS_FIELD_MACHINERY_AND_EQUIPMENT_MANUFACTURING" | "FOOD_PRODUCT_MACHINERY_MANUFACTURING" | "SEMICONDUCTOR_MACHINERY_MANUFACTURING" | "SAWMILL_WOODWORKING_AND_PAPER_MACHINERY_MANUFACTURING" | "ALL_OTHER_INDUSTRIAL_MACHINERY_MANUFACTURING" | "COMMERCIAL_AND_SERVICE_INDUSTRY_MACHINERY_MANUFACTURING" | "INDUSTRIAL_AND_COMMERCIAL_FAN_AND_BLOWER_AND_AIR_PURIFICATION_EQUIPMENT_MANUFACTURING" | "HEATING_EQUIPMENT_EXCEPT_WARM_AIR_FURNACES_MANUFACTURING" | "AIR_CONDITIONING_AND_WARM_AIR_HEATING_EQUIPMENT_AND_COMMERCIAL_AND_INDUSTRIAL_REFRIGERATION_EQUIPMENT_MANUFACTURING" | "INDUSTRIAL_MOLD_MANUFACTURING" | "SPECIAL_DIE_AND_TOOL_DIE_SET_JIG_AND_FIXTURE_MANUFACTURING" | "CUTTING_TOOL_AND_MACHINE_TOOL_ACCESSORY_MANUFACTURING" | "MACHINE_TOOL_MANUFACTURING" | "ROLLING_MILL_AND_OTHER_METALWORKING_MACHINERY_MANUFACTURING" | "TURBINE_AND_TURBINE_GENERATOR_SET_UNITS_MANUFACTURING" | "SPEED_CHANGER_INDUSTRIAL_HIGH_SPEED_DRIVE_AND_GEAR_MANUFACTURING" | "MECHANICAL_POWER_TRANSMISSION_EQUIPMENT_MANUFACTURING" | "OTHER_ENGINE_EQUIPMENT_MANUFACTURING" | "AIR_AND_GAS_COMPRESSOR_MANUFACTURING" | "MEASURING_DISPENSING_AND_OTHER_PUMPING_EQUIPMENT_MANUFACTURING" | "ELEVATOR_AND_MOVING_STAIRWAY_MANUFACTURING" | "CONVEYOR_AND_CONVEYING_EQUIPMENT_MANUFACTURING" | "OVERHEAD_TRAVELING_CRANE_HOIST_AND_MONORAIL_SYSTEM_MANUFACTURING" | "INDUSTRIAL_TRUCK_TRACTOR_TRAILER_AND_STACKER_MACHINERY_MANUFACTURING" | "POWER_DRIVEN_HANDTOOL_MANUFACTURING" | "WELDING_AND_SOLDERING_EQUIPMENT_MANUFACTURING" | "PACKAGING_MACHINERY_MANUFACTURING" | "INDUSTRIAL_PROCESS_FURNACE_AND_OVEN_MANUFACTURING" | "FLUID_POWER_CYLINDER_AND_ACTUATOR_MANUFACTURING" | "FLUID_POWER_PUMP_AND_MOTOR_MANUFACTURING" | "ALL_OTHER_MISCELLANEOUS_GENERAL_PURPOSE_MACHINERY_MANUFACTURING" | "ELECTRONIC_COMPUTER_MANUFACTURING" | "COMPUTER_STORAGE_DEVICE_MANUFACTURING" | "COMPUTER_TERMINAL_AND_OTHER_COMPUTER_PERIPHERAL_EQUIPMENT_MANUFACTURING" | "TELEPHONE_APPARATUS_MANUFACTURING" | "RADIO_AND_TELEVISION_BROADCASTING_AND_WIRELESS_COMMUNICATIONS_EQUIPMENT_MANUFACTURING" | "OTHER_COMMUNICATIONS_EQUIPMENT_MANUFACTURING" | "AUDIO_AND_VIDEO_EQUIPMENT_MANUFACTURING" | "BARE_PRINTED_CIRCUIT_BOARD_MANUFACTURING" | "SEMICONDUCTOR_AND_RELATED_DEVICE_MANUFACTURING" | "CAPACITOR_RESISTOR_COIL_TRANSFORMER_AND_OTHER_INDUCTOR_MANUFACTURING" | "ELECTRONIC_CONNECTOR_MANUFACTURING" | "PRINTED_CIRCUIT_ASSEMBLY_ELECTRONIC_ASSEMBLY_MANUFACTURING" | "OTHER_ELECTRONIC_COMPONENT_MANUFACTURING" | "ELECTROMEDICAL_AND_ELECTROTHERAPEUTIC_APPARATUS_MANUFACTURING" | "SEARCH_DETECTION_NAVIGATION_GUIDANCE_AERONAUTICAL_AND_NAUTICAL_SYSTEM_AND_INSTRUMENT_MANUFACTURING" | "AUTOMATIC_ENVIRONMENTAL_CONTROL_MANUFACTURING_FOR_RESIDENTIAL_COMMERCIAL_AND_APPLIANCE_USE" | "INSTRUMENTS_AND_RELATED_PRODUCTS_MANUFACTURING_FOR_MEASURING_DISPLAYING_AND_CONTROLLING_INDUSTRIAL_PROCESS_VARIABLES" | "TOTALIZING_FLUID_METER_AND_COUNTING_DEVICE_MANUFACTURING" | "INSTRUMENT_MANUFACTURING_FOR_MEASURING_AND_TESTING_ELECTRICITY_AND_ELECTRICAL_SIGNALS" | "ANALYTICAL_LABORATORY_INSTRUMENT_MANUFACTURING" | "IRRADIATION_APPARATUS_MANUFACTURING" | "OTHER_MEASURING_AND_CONTROLLING_DEVICE_MANUFACTURING" | "MANUFACTURING_AND_REPRODUCING_MAGNETIC_AND_OPTICAL_MEDIA" | "RESIDENTIAL_ELECTRIC_LIGHTING_FIXTURE_MANUFACTURING" | "COMMERCIAL_INDUSTRIAL_AND_INSTITUTIONAL_ELECTRIC_LIGHTING_FIXTURE_MANUFACTURING" | "ELECTRIC_LAMP_BULB_AND_OTHER_LIGHTING_EQUIPMENT_MANUFACTURING" | "SMALL_ELECTRICAL_APPLIANCE_MANUFACTURING" | "MAJOR_HOUSEHOLD_APPLIANCE_MANUFACTURING" | "POWER_DISTRIBUTION_AND_SPECIALTY_TRANSFORMER_MANUFACTURING" | "MOTOR_AND_GENERATOR_MANUFACTURING" | "SWITCHGEAR_AND_SWITCHBOARD_APPARATUS_MANUFACTURING" | "RELAY_AND_INDUSTRIAL_CONTROL_MANUFACTURING" | "BATTERY_MANUFACTURING" | "FIBER_OPTIC_CABLE_MANUFACTURING" | "OTHER_COMMUNICATION_AND_ENERGY_WIRE_MANUFACTURING" | "CURRENT_CARRYING_WIRING_DEVICE_MANUFACTURING" | "NONCURRENT_CARRYING_WIRING_DEVICE_MANUFACTURING" | "CARBON_AND_GRAPHITE_PRODUCT_MANUFACTURING" | "ALL_OTHER_MISCELLANEOUS_ELECTRICAL_EQUIPMENT_AND_COMPONENT_MANUFACTURING" | "AUTOMOBILE_AND_LIGHT_DUTY_MOTOR_VEHICLE_MANUFACTURING" | "HEAVY_DUTY_TRUCK_MANUFACTURING" | "MOTOR_VEHICLE_BODY_MANUFACTURING" | "TRUCK_TRAILER_MANUFACTURING" | "MOTOR_HOME_MANUFACTURING" | "TRAVEL_TRAILER_AND_CAMPER_MANUFACTURING" | "MOTOR_VEHICLE_GASOLINE_ENGINE_AND_ENGINE_PARTS_MANUFACTURING" | "MOTOR_VEHICLE_ELECTRICAL_AND_ELECTRONIC_EQUIPMENT_MANUFACTURING" | "MOTOR_VEHICLE_STEERING_AND_SUSPENSION_COMPONENTS_EXCEPT_SPRING_MANUFACTURING" | "MOTOR_VEHICLE_BRAKE_SYSTEM_MANUFACTURING" | "MOTOR_VEHICLE_TRANSMISSION_AND_POWER_TRAIN_PARTS_MANUFACTURING" | "MOTOR_VEHICLE_SEATING_AND_INTERIOR_TRIM_MANUFACTURING" | "MOTOR_VEHICLE_METAL_STAMPING" | "OTHER_MOTOR_VEHICLE_PARTS_MANUFACTURING" | "AIRCRAFT_MANUFACTURING" | "AIRCRAFT_ENGINE_AND_ENGINE_PARTS_MANUFACTURING" | "OTHER_AIRCRAFT_PARTS_AND_AUXILIARY_EQUIPMENT_MANUFACTURING" | "GUIDED_MISSILE_AND_SPACE_VEHICLE_MANUFACTURING" | "GUIDED_MISSILE_AND_SPACE_VEHICLE_PROPULSION_UNIT_AND_PROPULSION_UNIT_PARTS_MANUFACTURING" | "OTHER_GUIDED_MISSILE_AND_SPACE_VEHICLE_PARTS_AND_AUXILIARY_EQUIPMENT_MANUFACTURING" | "RAILROAD_ROLLING_STOCK_MANUFACTURING" | "SHIP_BUILDING_AND_REPAIRING" | "BOAT_BUILDING" | "MOTORCYCLE_BICYCLE_AND_PARTS_MANUFACTURING" | "MILITARY_ARMORED_VEHICLE_TANK_AND_TANK_COMPONENT_MANUFACTURING" | "ALL_OTHER_TRANSPORTATION_EQUIPMENT_MANUFACTURING" | "WOOD_KITCHEN_CABINET_AND_COUNTERTOP_MANUFACTURING" | "UPHOLSTERED_HOUSEHOLD_FURNITURE_MANUFACTURING" | "NONUPHOLSTERED_WOOD_HOUSEHOLD_FURNITURE_MANUFACTURING" | "HOUSEHOLD_FURNITURE_EXCEPT_WOOD_AND_UPHOLSTERED_MANUFACTURING" | "INSTITUTIONAL_FURNITURE_MANUFACTURING" | "WOOD_OFFICE_FURNITURE_MANUFACTURING" | "CUSTOM_ARCHITECTURAL_WOODWORK_AND_MILLWORK_MANUFACTURING" | "OFFICE_FURNITURE_EXCEPT_WOOD_MANUFACTURING" | "SHOWCASE_PARTITION_SHELVING_AND_LOCKER_MANUFACTURING" | "MATTRESS_MANUFACTURING" | "BLIND_AND_SHADE_MANUFACTURING" | "SURGICAL_AND_MEDICAL_INSTRUMENT_MANUFACTURING" | "SURGICAL_APPLIANCE_AND_SUPPLIES_MANUFACTURING" | "DENTAL_EQUIPMENT_AND_SUPPLIES_MANUFACTURING" | "OPHTHALMIC_GOODS_MANUFACTURING" | "DENTAL_LABORATORIES" | "JEWELRY_AND_SILVERWARE_MANUFACTURING" | "SPORTING_AND_ATHLETIC_GOODS_MANUFACTURING" | "DOLL_TOY_AND_GAME_MANUFACTURING" | "OFFICE_SUPPLIES_EXCEPT_PAPER_MANUFACTURING" | "SIGN_MANUFACTURING" | "GASKET_PACKING_AND_SEALING_DEVICE_MANUFACTURING" | "MUSICAL_INSTRUMENT_MANUFACTURING" | "FASTENER_BUTTON_NEEDLE_AND_PIN_MANUFACTURING" | "BROOM_BRUSH_AND_MOP_MANUFACTURING" | "BURIAL_CASKET_MANUFACTURING" | "ALL_OTHER_MISCELLANEOUS_MANUFACTURING" | "AUTOMOBILE_AND_OTHER_MOTOR_VEHICLE_MERCHANT_WHOLESALERS" | "MOTOR_VEHICLE_SUPPLIES_AND_NEW_PARTS_MERCHANT_WHOLESALERS" | "TIRE_AND_TUBE_MERCHANT_WHOLESALERS" | "MOTOR_VEHICLE_PARTS_USED_MERCHANT_WHOLESALERS" | "FURNITURE_MERCHANT_WHOLESALERS" | "HOME_FURNISHING_MERCHANT_WHOLESALERS" | "LUMBER_PLYWOOD_MILLWORK_AND_WOOD_PANEL_MERCHANT_WHOLESALERS" | "BRICK_STONE_AND_RELATED_CONSTRUCTION_MATERIAL_MERCHANT_WHOLESALERS" | "ROOFING_SIDING_AND_INSULATION_MATERIAL_MERCHANT_WHOLESALERS" | "OTHER_CONSTRUCTION_MATERIAL_MERCHANT_WHOLESALERS" | "PHOTOGRAPHIC_EQUIPMENT_AND_SUPPLIES_MERCHANT_WHOLESALERS" | "OFFICE_EQUIPMENT_MERCHANT_WHOLESALERS" | "COMPUTER_AND_COMPUTER_PERIPHERAL_EQUIPMENT_AND_SOFTWARE_MERCHANT_WHOLESALERS" | "OTHER_COMMERCIAL_EQUIPMENT_MERCHANT_WHOLESALERS" | "MEDICAL_DENTAL_AND_HOSPITAL_EQUIPMENT_AND_SUPPLIES_MERCHANT_WHOLESALERS" | "OPHTHALMIC_GOODS_MERCHANT_WHOLESALERS" | "OTHER_PROFESSIONAL_EQUIPMENT_AND_SUPPLIES_MERCHANT_WHOLESALERS" | "METAL_SERVICE_CENTERS_AND_OTHER_METAL_MERCHANT_WHOLESALERS" | "COAL_AND_OTHER_MINERAL_AND_ORE_MERCHANT_WHOLESALERS" | "ELECTRICAL_APPARATUS_AND_EQUIPMENT_WIRING_SUPPLIES_AND_RELATED_EQUIPMENT_MERCHANT_WHOLESALERS" | "HOUSEHOLD_APPLIANCES_ELECTRIC_HOUSEWARES_AND_CONSUMER_ELECTRONICS_MERCHANT_WHOLESALERS" | "OTHER_ELECTRONIC_PARTS_AND_EQUIPMENT_MERCHANT_WHOLESALERS" | "HARDWARE_MERCHANT_WHOLESALERS" | "PLUMBING_AND_HEATING_EQUIPMENT_AND_SUPPLIES_HYDRONICS_MERCHANT_WHOLESALERS" | "WARM_AIR_HEATING_AND_AIR_CONDITIONING_EQUIPMENT_AND_SUPPLIES_MERCHANT_WHOLESALERS" | "REFRIGERATION_EQUIPMENT_AND_SUPPLIES_MERCHANT_WHOLESALERS" | "CONSTRUCTION_AND_MINING_EXCEPT_OIL_WELL_MACHINERY_AND_EQUIPMENT_MERCHANT_WHOLESALERS" | "FARM_AND_GARDEN_MACHINERY_AND_EQUIPMENT_MERCHANT_WHOLESALERS" | "INDUSTRIAL_MACHINERY_AND_EQUIPMENT_MERCHANT_WHOLESALERS" | "INDUSTRIAL_SUPPLIES_MERCHANT_WHOLESALERS" | "SERVICE_ESTABLISHMENT_EQUIPMENT_AND_SUPPLIES_MERCHANT_WHOLESALERS" | "TRANSPORTATION_EQUIPMENT_AND_SUPPLIES_EXCEPT_MOTOR_VEHICLE_MERCHANT_WHOLESALERS" | "SPORTING_AND_RECREATIONAL_GOODS_AND_SUPPLIES_MERCHANT_WHOLESALERS" | "TOY_AND_HOBBY_GOODS_AND_SUPPLIES_MERCHANT_WHOLESALERS" | "RECYCLABLE_MATERIAL_MERCHANT_WHOLESALERS" | "JEWELRY_WATCH_PRECIOUS_STONE_AND_PRECIOUS_METAL_MERCHANT_WHOLESALERS" | "OTHER_MISCELLANEOUS_DURABLE_GOODS_MERCHANT_WHOLESALERS" | "PRINTING_AND_WRITING_PAPER_MERCHANT_WHOLESALERS" | "STATIONERY_AND_OFFICE_SUPPLIES_MERCHANT_WHOLESALERS" | "INDUSTRIAL_AND_PERSONAL_SERVICE_PAPER_MERCHANT_WHOLESALERS" | "DRUGS_AND_DRUGGISTS_SUNDRIES_MERCHANT_WHOLESALERS" | "PIECE_GOODS_NOTIONS_AND_OTHER_DRY_GOODS_MERCHANT_WHOLESALERS" | "FOOTWEAR_MERCHANT_WHOLESALERS" | "CLOTHING_AND_CLOTHING_ACCESSORIES_MERCHANT_WHOLESALERS" | "GENERAL_LINE_GROCERY_MERCHANT_WHOLESALERS" | "PACKAGED_FROZEN_FOOD_MERCHANT_WHOLESALERS" | "DAIRY_PRODUCT_EXCEPT_DRIED_OR_CANNED_MERCHANT_WHOLESALERS" | "POULTRY_AND_POULTRY_PRODUCT_MERCHANT_WHOLESALERS" | "CONFECTIONERY_MERCHANT_WHOLESALERS" | "FISH_AND_SEAFOOD_MERCHANT_WHOLESALERS" | "MEAT_AND_MEAT_PRODUCT_MERCHANT_WHOLESALERS" | "FRESH_FRUIT_AND_VEGETABLE_MERCHANT_WHOLESALERS" | "OTHER_GROCERY_AND_RELATED_PRODUCTS_MERCHANT_WHOLESALERS" | "GRAIN_AND_FIELD_BEAN_MERCHANT_WHOLESALERS" | "LIVESTOCK_MERCHANT_WHOLESALERS" | "OTHER_FARM_PRODUCT_RAW_MATERIAL_MERCHANT_WHOLESALERS" | "PLASTICS_MATERIALS_AND_BASIC_FORMS_AND_SHAPES_MERCHANT_WHOLESALERS" | "OTHER_CHEMICAL_AND_ALLIED_PRODUCTS_MERCHANT_WHOLESALERS" | "PETROLEUM_BULK_STATIONS_AND_TERMINALS" | "PETROLEUM_AND_PETROLEUM_PRODUCTS_MERCHANT_WHOLESALERS_EXCEPT_BULK_STATIONS_AND_TERMINALS" | "BEER_AND_ALE_MERCHANT_WHOLESALERS" | "WINE_AND_DISTILLED_ALCOHOLIC_BEVERAGE_MERCHANT_WHOLESALERS" | "FARM_SUPPLIES_MERCHANT_WHOLESALERS" | "BOOK_PERIODICAL_AND_NEWSPAPER_MERCHANT_WHOLESALERS" | "FLOWER_NURSERY_STOCK_AND_FLORISTS_SUPPLIES_MERCHANT_WHOLESALERS" | "TOBACCO_PRODUCT_AND_ELECTRONIC_CIGARETTE_MERCHANT_WHOLESALERS" | "PAINT_VARNISH_AND_SUPPLIES_MERCHANT_WHOLESALERS" | "OTHER_MISCELLANEOUS_NONDURABLE_GOODS_MERCHANT_WHOLESALERS" | "WHOLESALE_TRADE_AGENTS_AND_BROKERS" | "NEW_CAR_DEALERS" | "USED_CAR_DEALERS" | "RECREATIONAL_VEHICLE_DEALERS" | "BOAT_DEALERS" | "MOTORCYCLE_ATV_AND_ALL_OTHER_MOTOR_VEHICLE_DEALERS" | "AUTOMOTIVE_PARTS_AND_ACCESSORIES_RETAILERS" | "TIRE_DEALERS" | "HOME_CENTERS" | "PAINT_AND_WALLPAPER_RETAILERS" | "HARDWARE_RETAILERS" | "OTHER_BUILDING_MATERIAL_DEALERS" | "OUTDOOR_POWER_EQUIPMENT_RETAILERS" | "NURSERY_GARDEN_CENTER_AND_FARM_SUPPLY_RETAILERS" | "SUPERMARKETS_AND_OTHER_GROCERY_RETAILERS_EXCEPT_CONVENIENCE_RETAILERS" | "CONVENIENCE_RETAILERS" | "VENDING_MACHINE_OPERATORS" | "FRUIT_AND_VEGETABLE_RETAILERS" | "MEAT_RETAILERS" | "FISH_AND_SEAFOOD_RETAILERS" | "BAKED_GOODS_RETAILERS" | "CONFECTIONERY_AND_NUT_RETAILERS" | "ALL_OTHER_SPECIALTY_FOOD_RETAILERS" | "BEER_WINE_AND_LIQUOR_RETAILERS" | "FURNITURE_RETAILERS" | "FLOOR_COVERING_RETAILERS" | "WINDOW_TREATMENT_RETAILERS" | "ALL_OTHER_HOME_FURNISHINGS_RETAILERS" | "ELECTRONICS_AND_APPLIANCE_RETAILERS" | "DEPARTMENT_STORES" | "WAREHOUSE_CLUBS_AND_SUPERCENTERS" | "ALL_OTHER_GENERAL_MERCHANDISE_RETAILERS" | "PHARMACIES_AND_DRUG_RETAILERS" | "COSMETICS_BEAUTY_SUPPLIES_AND_PERFUME_RETAILERS" | "OPTICAL_GOODS_RETAILERS" | "FOOD_HEALTH_SUPPLEMENT_RETAILERS" | "ALL_OTHER_HEALTH_AND_PERSONAL_CARE_RETAILERS" | "GASOLINE_STATIONS_WITH_CONVENIENCE_STORES" | "OTHER_GASOLINE_STATIONS" | "FUEL_DEALERS" | "CLOTHING_AND_CLOTHING_ACCESSORIES_RETAILERS" | "SHOE_RETAILERS" | "JEWELRY_RETAILERS" | "LUGGAGE_AND_LEATHER_GOODS_RETAILERS" | "SPORTING_GOODS_RETAILERS" | "HOBBY_TOY_AND_GAME_RETAILERS" | "SEWING_NEEDLEWORK_AND_PIECE_GOODS_RETAILERS" | "MUSICAL_INSTRUMENT_AND_SUPPLIES_RETAILERS" | "BOOK_RETAILERS_AND_NEWS_DEALERS" | "FLORISTS" | "OFFICE_SUPPLIES_AND_STATIONERY_RETAILERS" | "GIFT_NOVELTY_AND_SOUVENIR_RETAILERS" | "USED_MERCHANDISE_RETAILERS" | "PET_AND_PET_SUPPLIES_RETAILERS" | "ART_DEALERS" | "MANUFACTURED_MOBILE_HOME_DEALERS" | "TOBACCO_ELECTRONIC_CIGARETTE_AND_OTHER_SMOKING_SUPPLIES_RETAILERS" | "ALL_OTHER_MISCELLANEOUS_RETAILERS" | "SCHEDULED_PASSENGER_AIR_TRANSPORTATION" | "SCHEDULED_FREIGHT_AIR_TRANSPORTATION" | "NONSCHEDULED_CHARTERED_PASSENGER_AIR_TRANSPORTATION" | "NONSCHEDULED_CHARTERED_FREIGHT_AIR_TRANSPORTATION" | "OTHER_NONSCHEDULED_AIR_TRANSPORTATION" | "LINE_HAUL_RAILROADS" | "SHORT_LINE_RAILROADS" | "DEEP_SEA_FREIGHT_TRANSPORTATION" | "DEEP_SEA_PASSENGER_TRANSPORTATION" | "COASTAL_AND_GREAT_LAKES_FREIGHT_TRANSPORTATION" | "COASTAL_AND_GREAT_LAKES_PASSENGER_TRANSPORTATION" | "INLAND_WATER_FREIGHT_TRANSPORTATION" | "INLAND_WATER_PASSENGER_TRANSPORTATION" | "GENERAL_FREIGHT_TRUCKING_LOCAL" | "GENERAL_FREIGHT_TRUCKING_LONG_DISTANCE_TRUCKLOAD" | "GENERAL_FREIGHT_TRUCKING_LONG_DISTANCE_LESS_THAN_TRUCKLOAD" | "USED_HOUSEHOLD_AND_OFFICE_GOODS_MOVING" | "SPECIALIZED_FREIGHT_EXCEPT_USED_GOODS_TRUCKING_LOCAL" | "SPECIALIZED_FREIGHT_EXCEPT_USED_GOODS_TRUCKING_LONG_DISTANCE" | "MIXED_MODE_TRANSIT_SYSTEMS" | "COMMUTER_RAIL_SYSTEMS" | "BUS_AND_OTHER_MOTOR_VEHICLE_TRANSIT_SYSTEMS" | "OTHER_URBAN_TRANSIT_SYSTEMS" | "INTERURBAN_AND_RURAL_BUS_TRANSPORTATION" | "TAXI_AND_RIDESHARING_SERVICES" | "LIMOUSINE_SERVICE" | "SCHOOL_AND_EMPLOYEE_BUS_TRANSPORTATION" | "CHARTER_BUS_INDUSTRY" | "SPECIAL_NEEDS_TRANSPORTATION" | "ALL_OTHER_TRANSIT_AND_GROUND_PASSENGER_TRANSPORTATION" | "PIPELINE_TRANSPORTATION_OF_CRUDE_OIL" | "PIPELINE_TRANSPORTATION_OF_NATURAL_GAS" | "PIPELINE_TRANSPORTATION_OF_REFINED_PETROLEUM_PRODUCTS" | "ALL_OTHER_PIPELINE_TRANSPORTATION" | "SCENIC_AND_SIGHTSEEING_TRANSPORTATION_LAND" | "SCENIC_AND_SIGHTSEEING_TRANSPORTATION_WATER" | "SCENIC_AND_SIGHTSEEING_TRANSPORTATION_OTHER" | "AIR_TRAFFIC_CONTROL" | "OTHER_AIRPORT_OPERATIONS" | "OTHER_SUPPORT_ACTIVITIES_FOR_AIR_TRANSPORTATION" | "SUPPORT_ACTIVITIES_FOR_RAIL_TRANSPORTATION" | "PORT_AND_HARBOR_OPERATIONS" | "MARINE_CARGO_HANDLING" | "NAVIGATIONAL_SERVICES_TO_SHIPPING" | "OTHER_SUPPORT_ACTIVITIES_FOR_WATER_TRANSPORTATION" | "MOTOR_VEHICLE_TOWING" | "OTHER_SUPPORT_ACTIVITIES_FOR_ROAD_TRANSPORTATION" | "FREIGHT_TRANSPORTATION_ARRANGEMENT" | "PACKING_AND_CRATING" | "ALL_OTHER_SUPPORT_ACTIVITIES_FOR_TRANSPORTATION" | "POSTAL_SERVICE" | "COURIERS_AND_EXPRESS_DELIVERY_SERVICES" | "LOCAL_MESSENGERS_AND_LOCAL_DELIVERY" | "GENERAL_WAREHOUSING_AND_STORAGE" | "REFRIGERATED_WAREHOUSING_AND_STORAGE" | "FARM_PRODUCT_WAREHOUSING_AND_STORAGE" | "OTHER_WAREHOUSING_AND_STORAGE" | "MOTION_PICTURE_AND_VIDEO_PRODUCTION" | "MOTION_PICTURE_AND_VIDEO_DISTRIBUTION" | "MOTION_PICTURE_THEATERS_EXCEPT_DRIVE_INS" | "DRIVE_IN_MOTION_PICTURE_THEATERS" | "TELEPRODUCTION_AND_OTHER_POSTPRODUCTION_SERVICES" | "OTHER_MOTION_PICTURE_AND_VIDEO_INDUSTRIES" | "MUSIC_PUBLISHERS" | "SOUND_RECORDING_STUDIOS" | "RECORD_PRODUCTION_AND_DISTRIBUTION" | "OTHER_SOUND_RECORDING_INDUSTRIES" | "NEWSPAPER_PUBLISHERS" | "PERIODICAL_PUBLISHERS" | "BOOK_PUBLISHERS" | "DIRECTORY_AND_MAILING_LIST_PUBLISHERS" | "GREETING_CARD_PUBLISHERS" | "ALL_OTHER_PUBLISHERS" | "SOFTWARE_PUBLISHERS" | "RADIO_BROADCASTING_STATIONS" | "TELEVISION_BROADCASTING_STATIONS" | "MEDIA_STREAMING_DISTRIBUTION_SERVICES_SOCIAL_NETWORKS_AND_OTHER_MEDIA_NETWORKS_AND_CONTENT_PROVIDERS" | "WIRED_TELECOMMUNICATIONS_CARRIERS" | "WIRELESS_TELECOMMUNICATIONS_CARRIERS_EXCEPT_SATELLITE" | "TELECOMMUNICATIONS_RESELLERS" | "AGENTS_FOR_WIRELESS_TELECOMMUNICATIONS_SERVICES" | "SATELLITE_TELECOMMUNICATIONS" | "ALL_OTHER_TELECOMMUNICATIONS" | "COMPUTING_INFRASTRUCTURE_PROVIDERS_DATA_PROCESSING_WEB_HOSTING_AND_RELATED_SERVICES" | "LIBRARIES_AND_ARCHIVES" | "WEB_SEARCH_PORTALS_AND_ALL_OTHER_INFORMATION_SERVICES" | "MONETARY_AUTHORITIES_CENTRAL_BANK" | "COMMERCIAL_BANKING" | "CREDIT_UNIONS" | "SAVINGS_INSTITUTIONS_AND_OTHER_DEPOSITORY_CREDIT_INTERMEDIATION" | "CREDIT_CARD_ISSUING" | "SALES_FINANCING" | "CONSUMER_LENDING" | "REAL_ESTATE_CREDIT" | "INTERNATIONAL_SECONDARY_MARKET_AND_ALL_OTHER_NONDEPOSITORY_CREDIT_INTERMEDIATION" | "MORTGAGE_AND_NONMORTGAGE_LOAN_BROKERS" | "FINANCIAL_TRANSACTIONS_PROCESSING_RESERVE_AND_CLEARINGHOUSE_ACTIVITIES" | "OTHER_ACTIVITIES_RELATED_TO_CREDIT_INTERMEDIATION" | "INVESTMENT_BANKING_AND_SECURITIES_INTERMEDIATION" | "COMMODITY_CONTRACTS_INTERMEDIATION" | "SECURITIES_AND_COMMODITY_EXCHANGES" | "MISCELLANEOUS_INTERMEDIATION" | "PORTFOLIO_MANAGEMENT_AND_INVESTMENT_ADVICE" | "TRUST_FIDUCIARY_AND_CUSTODY_ACTIVITIES" | "MISCELLANEOUS_FINANCIAL_INVESTMENT_ACTIVITIES" | "DIRECT_LIFE_INSURANCE_CARRIERS" | "DIRECT_HEALTH_AND_MEDICAL_INSURANCE_CARRIERS" | "DIRECT_PROPERTY_AND_CASUALTY_INSURANCE_CARRIERS" | "DIRECT_TITLE_INSURANCE_CARRIERS" | "OTHER_DIRECT_INSURANCE_EXCEPT_LIFE_HEALTH_AND_MEDICAL_CARRIERS" | "REINSURANCE_CARRIERS" | "INSURANCE_AGENCIES_AND_BROKERAGES" | "CLAIMS_ADJUSTING" | "PHARMACY_BENEFIT_MANAGEMENT_AND_OTHER_THIRD_PARTY_ADMINISTRATION_OF_INSURANCE_AND_PENSION_FUNDS" | "ALL_OTHER_INSURANCE_RELATED_ACTIVITIES" | "PENSION_FUNDS" | "HEALTH_AND_WELFARE_FUNDS" | "OTHER_INSURANCE_FUNDS" | "OPEN_END_INVESTMENT_FUNDS" | "TRUSTS_ESTATES_AND_AGENCY_ACCOUNTS" | "OTHER_FINANCIAL_VEHICLES" | "LESSORS_OF_RESIDENTIAL_BUILDINGS_AND_DWELLINGS" | "LESSORS_OF_NONRESIDENTIAL_BUILDINGS_EXCEPT_MINIWAREHOUSES" | "LESSORS_OF_MINIWAREHOUSES_AND_SELF_STORAGE_UNITS" | "LESSORS_OF_OTHER_REAL_ESTATE_PROPERTY" | "OFFICES_OF_REAL_ESTATE_AGENTS_AND_BROKERS" | "RESIDENTIAL_PROPERTY_MANAGERS" | "NONRESIDENTIAL_PROPERTY_MANAGERS" | "OFFICES_OF_REAL_ESTATE_APPRAISERS" | "OTHER_ACTIVITIES_RELATED_TO_REAL_ESTATE" | "PASSENGER_CAR_RENTAL" | "PASSENGER_CAR_LEASING" | "TRUCK_UTILITY_TRAILER_AND_RV_RECREATIONAL_VEHICLE_RENTAL_AND_LEASING" | "CONSUMER_ELECTRONICS_AND_APPLIANCES_RENTAL" | "FORMAL_WEAR_AND_COSTUME_RENTAL" | "VIDEO_TAPE_AND_DISC_RENTAL" | "HOME_HEALTH_EQUIPMENT_RENTAL" | "RECREATIONAL_GOODS_RENTAL" | "ALL_OTHER_CONSUMER_GOODS_RENTAL" | "GENERAL_RENTAL_CENTERS" | "COMMERCIAL_AIR_RAIL_AND_WATER_TRANSPORTATION_EQUIPMENT_RENTAL_AND_LEASING" | "CONSTRUCTION_MINING_AND_FORESTRY_MACHINERY_AND_EQUIPMENT_RENTAL_AND_LEASING" | "OFFICE_MACHINERY_AND_EQUIPMENT_RENTAL_AND_LEASING" | "OTHER_COMMERCIAL_AND_INDUSTRIAL_MACHINERY_AND_EQUIPMENT_RENTAL_AND_LEASING" | "LESSORS_OF_NONFINANCIAL_INTANGIBLE_ASSETS_EXCEPT_COPYRIGHTED_WORKS" | "OFFICES_OF_LAWYERS" | "OFFICES_OF_NOTARIES" | "TITLE_ABSTRACT_AND_SETTLEMENT_OFFICES" | "ALL_OTHER_LEGAL_SERVICES" | "OFFICES_OF_CERTIFIED_PUBLIC_ACCOUNTANTS" | "TAX_PREPARATION_SERVICES" | "PAYROLL_SERVICES" | "OTHER_ACCOUNTING_SERVICES" | "ARCHITECTURAL_SERVICES" | "LANDSCAPE_ARCHITECTURAL_SERVICES" | "ENGINEERING_SERVICES" | "DRAFTING_SERVICES" | "BUILDING_INSPECTION_SERVICES" | "GEOPHYSICAL_SURVEYING_AND_MAPPING_SERVICES" | "SURVEYING_AND_MAPPING_EXCEPT_GEOPHYSICAL_SERVICES" | "TESTING_LABORATORIES_AND_SERVICES" | "INTERIOR_DESIGN_SERVICES" | "INDUSTRIAL_DESIGN_SERVICES" | "GRAPHIC_DESIGN_SERVICES" | "OTHER_SPECIALIZED_DESIGN_SERVICES" | "CUSTOM_COMPUTER_PROGRAMMING_SERVICES" | "COMPUTER_SYSTEMS_DESIGN_SERVICES" | "COMPUTER_FACILITIES_MANAGEMENT_SERVICES" | "OTHER_COMPUTER_RELATED_SERVICES" | "ADMINISTRATIVE_MANAGEMENT_AND_GENERAL_MANAGEMENT_CONSULTING_SERVICES" | "HUMAN_RESOURCES_CONSULTING_SERVICES" | "MARKETING_CONSULTING_SERVICES" | "PROCESS_PHYSICAL_DISTRIBUTION_AND_LOGISTICS_CONSULTING_SERVICES" | "OTHER_MANAGEMENT_CONSULTING_SERVICES" | "ENVIRONMENTAL_CONSULTING_SERVICES" | "OTHER_SCIENTIFIC_AND_TECHNICAL_CONSULTING_SERVICES" | "RESEARCH_AND_DEVELOPMENT_IN_NANOTECHNOLOGY" | "RESEARCH_AND_DEVELOPMENT_IN_BIOTECHNOLOGY_EXCEPT_NANOBIOTECHNOLOGY" | "RESEARCH_AND_DEVELOPMENT_IN_THE_PHYSICAL_ENGINEERING_AND_LIFE_SCIENCES_EXCEPT_NANOTECHNOLOGY_AND_BIOTECHNOLOGY" | "RESEARCH_AND_DEVELOPMENT_IN_THE_SOCIAL_SCIENCES_AND_HUMANITIES" | "ADVERTISING_AGENCIES" | "PUBLIC_RELATIONS_AGENCIES" | "MEDIA_BUYING_AGENCIES" | "MEDIA_REPRESENTATIVES" | "INDOOR_AND_OUTDOOR_DISPLAY_ADVERTISING" | "DIRECT_MAIL_ADVERTISING" | "ADVERTISING_MATERIAL_DISTRIBUTION_SERVICES" | "OTHER_SERVICES_RELATED_TO_ADVERTISING" | "MARKETING_RESEARCH_AND_PUBLIC_OPINION_POLLING" | "PHOTOGRAPHY_STUDIOS_PORTRAIT" | "COMMERCIAL_PHOTOGRAPHY" | "TRANSLATION_AND_INTERPRETATION_SERVICES" | "VETERINARY_SERVICES" | "ALL_OTHER_PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES" | "OFFICES_OF_BANK_HOLDING_COMPANIES" | "OFFICES_OF_OTHER_HOLDING_COMPANIES" | "CORPORATE_SUBSIDIARY_AND_REGIONAL_MANAGING_OFFICES" | "OFFICE_ADMINISTRATIVE_SERVICES" | "FACILITIES_SUPPORT_SERVICES" | "EMPLOYMENT_PLACEMENT_AGENCIES" | "EXECUTIVE_SEARCH_SERVICES" | "TEMPORARY_HELP_SERVICES" | "PROFESSIONAL_EMPLOYER_ORGANIZATIONS" | "DOCUMENT_PREPARATION_SERVICES" | "TELEPHONE_ANSWERING_SERVICES" | "TELEMARKETING_BUREAUS_AND_OTHER_CONTACT_CENTERS" | "PRIVATE_MAIL_CENTERS" | "OTHER_BUSINESS_SERVICE_CENTERS_INCLUDING_COPY_SHOPS" | "COLLECTION_AGENCIES" | "CREDIT_BUREAUS" | "REPOSSESSION_SERVICES" | "COURT_REPORTING_AND_STENOTYPE_SERVICES" | "ALL_OTHER_BUSINESS_SUPPORT_SERVICES" | "TRAVEL_AGENCIES" | "TOUR_OPERATORS" | "CONVENTION_AND_VISITORS_BUREAUS" | "ALL_OTHER_TRAVEL_ARRANGEMENT_AND_RESERVATION_SERVICES" | "INVESTIGATION_AND_PERSONAL_BACKGROUND_CHECK_SERVICES" | "SECURITY_GUARDS_AND_PATROL_SERVICES" | "ARMORED_CAR_SERVICES" | "SECURITY_SYSTEMS_SERVICES_EXCEPT_LOCKSMITHS" | "LOCKSMITHS" | "EXTERMINATING_AND_PEST_CONTROL_SERVICES" | "JANITORIAL_SERVICES" | "LANDSCAPING_SERVICES" | "CARPET_AND_UPHOLSTERY_CLEANING_SERVICES" | "OTHER_SERVICES_TO_BUILDINGS_AND_DWELLINGS" | "PACKAGING_AND_LABELING_SERVICES" | "CONVENTION_AND_TRADE_SHOW_ORGANIZERS" | "ALL_OTHER_SUPPORT_SERVICES" | "SOLID_WASTE_COLLECTION" | "HAZARDOUS_WASTE_COLLECTION" | "OTHER_WASTE_COLLECTION" | "HAZARDOUS_WASTE_TREATMENT_AND_DISPOSAL" | "SOLID_WASTE_LANDFILL" | "SOLID_WASTE_COMBUSTORS_AND_INCINERATORS" | "OTHER_NONHAZARDOUS_WASTE_TREATMENT_AND_DISPOSAL" | "REMEDIATION_SERVICES" | "MATERIALS_RECOVERY_FACILITIES" | "SEPTIC_TANK_AND_RELATED_SERVICES" | "ALL_OTHER_MISCELLANEOUS_WASTE_MANAGEMENT_SERVICES" | "ELEMENTARY_AND_SECONDARY_SCHOOLS" | "JUNIOR_COLLEGES" | "COLLEGES_UNIVERSITIES_AND_PROFESSIONAL_SCHOOLS" | "BUSINESS_AND_SECRETARIAL_SCHOOLS" | "COMPUTER_TRAINING" | "PROFESSIONAL_AND_MANAGEMENT_DEVELOPMENT_TRAINING" | "COSMETOLOGY_AND_BARBER_SCHOOLS" | "FLIGHT_TRAINING" | "APPRENTICESHIP_TRAINING" | "OTHER_TECHNICAL_AND_TRADE_SCHOOLS" | "FINE_ARTS_SCHOOLS" | "SPORTS_AND_RECREATION_INSTRUCTION" | "LANGUAGE_SCHOOLS" | "EXAM_PREPARATION_AND_TUTORING" | "AUTOMOBILE_DRIVING_SCHOOLS" | "ALL_OTHER_MISCELLANEOUS_SCHOOLS_AND_INSTRUCTION" | "EDUCATIONAL_SUPPORT_SERVICES" | "OFFICES_OF_PHYSICIANS_EXCEPT_MENTAL_HEALTH_SPECIALISTS" | "OFFICES_OF_PHYSICIANS_MENTAL_HEALTH_SPECIALISTS" | "OFFICES_OF_DENTISTS" | "OFFICES_OF_CHIROPRACTORS" | "OFFICES_OF_OPTOMETRISTS" | "OFFICES_OF_MENTAL_HEALTH_PRACTITIONERS_EXCEPT_PHYSICIANS" | "OFFICES_OF_PHYSICAL_OCCUPATIONAL_AND_SPEECH_THERAPISTS_AND_AUDIOLOGISTS" | "OFFICES_OF_PODIATRISTS" | "OFFICES_OF_ALL_OTHER_MISCELLANEOUS_HEALTH_PRACTITIONERS" | "FAMILY_PLANNING_CENTERS" | "OUTPATIENT_MENTAL_HEALTH_AND_SUBSTANCE_ABUSE_CENTERS" | "HMO_MEDICAL_CENTERS" | "KIDNEY_DIALYSIS_CENTERS" | "FREESTANDING_AMBULATORY_SURGICAL_AND_EMERGENCY_CENTERS" | "ALL_OTHER_OUTPATIENT_CARE_CENTERS" | "MEDICAL_LABORATORIES" | "DIAGNOSTIC_IMAGING_CENTERS" | "HOME_HEALTH_CARE_SERVICES" | "AMBULANCE_SERVICES" | "BLOOD_AND_ORGAN_BANKS" | "ALL_OTHER_MISCELLANEOUS_AMBULATORY_HEALTH_CARE_SERVICES" | "GENERAL_MEDICAL_AND_SURGICAL_HOSPITALS" | "PSYCHIATRIC_AND_SUBSTANCE_ABUSE_HOSPITALS" | "SPECIALTY_EXCEPT_PSYCHIATRIC_AND_SUBSTANCE_ABUSE_HOSPITALS" | "NURSING_CARE_FACILITIES_SKILLED_NURSING_FACILITIES" | "RESIDENTIAL_INTELLECTUAL_AND_DEVELOPMENTAL_DISABILITY_FACILITIES" | "RESIDENTIAL_MENTAL_HEALTH_AND_SUBSTANCE_ABUSE_FACILITIES" | "CONTINUING_CARE_RETIREMENT_COMMUNITIES" | "ASSISTED_LIVING_FACILITIES_FOR_THE_ELDERLY" | "OTHER_RESIDENTIAL_CARE_FACILITIES" | "CHILD_AND_YOUTH_SERVICES" | "SERVICES_FOR_THE_ELDERLY_AND_PERSONS_WITH_DISABILITIES" | "OTHER_INDIVIDUAL_AND_FAMILY_SERVICES" | "COMMUNITY_FOOD_SERVICES" | "TEMPORARY_SHELTERS" | "OTHER_COMMUNITY_HOUSING_SERVICES" | "EMERGENCY_AND_OTHER_RELIEF_SERVICES" | "VOCATIONAL_REHABILITATION_SERVICES" | "CHILD_CARE_SERVICES" | "THEATER_COMPANIES_AND_DINNER_THEATERS" | "DANCE_COMPANIES" | "MUSICAL_GROUPS_AND_ARTISTS" | "OTHER_PERFORMING_ARTS_COMPANIES" | "SPORTS_TEAMS_AND_CLUBS" | "RACETRACKS" | "OTHER_SPECTATOR_SPORTS" | "PROMOTERS_OF_PERFORMING_ARTS_SPORTS_AND_SIMILAR_EVENTS_WITH_FACILITIES" | "PROMOTERS_OF_PERFORMING_ARTS_SPORTS_AND_SIMILAR_EVENTS_WITHOUT_FACILITIES" | "AGENTS_AND_MANAGERS_FOR_ARTISTS_ATHLETES_ENTERTAINERS_AND_OTHER_PUBLIC_FIGURES" | "INDEPENDENT_ARTISTS_WRITERS_AND_PERFORMERS" | "MUSEUMS" | "HISTORICAL_SITES" | "ZOOS_AND_BOTANICAL_GARDENS" | "NATURE_PARKS_AND_OTHER_SIMILAR_INSTITUTIONS" | "AMUSEMENT_AND_THEME_PARKS" | "AMUSEMENT_ARCADES" | "CASINOS_EXCEPT_CASINO_HOTELS" | "OTHER_GAMBLING_INDUSTRIES" | "GOLF_COURSES_AND_COUNTRY_CLUBS" | "SKIING_FACILITIES" | "MARINAS" | "FITNESS_AND_RECREATIONAL_SPORTS_CENTERS" | "BOWLING_CENTERS" | "ALL_OTHER_AMUSEMENT_AND_RECREATION_INDUSTRIES" | "HOTELS_EXCEPT_CASINO_HOTELS_AND_MOTELS" | "CASINO_HOTELS" | "BED_AND_BREAKFAST_INNS" | "ALL_OTHER_TRAVELER_ACCOMMODATION" | "RV_RECREATIONAL_VEHICLE_PARKS_AND_CAMPGROUNDS" | "RECREATIONAL_AND_VACATION_CAMPS_EXCEPT_CAMPGROUNDS" | "ROOMING_AND_BOARDING_HOUSES_DORMITORIES_AND_WORKERS_CAMPS" | "FOOD_SERVICE_CONTRACTORS" | "CATERERS" | "MOBILE_FOOD_SERVICES" | "DRINKING_PLACES_ALCOHOLIC_BEVERAGES" | "FULL_SERVICE_RESTAURANTS" | "LIMITED_SERVICE_RESTAURANTS" | "CAFETERIAS_GRILL_BUFFETS_AND_BUFFETS" | "SNACK_AND_NONALCOHOLIC_BEVERAGE_BARS" | "GENERAL_AUTOMOTIVE_REPAIR" | "SPECIALIZED_AUTOMOTIVE_REPAIR" | "AUTOMOTIVE_BODY_PAINT_AND_INTERIOR_REPAIR_AND_MAINTENANCE" | "AUTOMOTIVE_GLASS_REPLACEMENT_SHOPS" | "AUTOMOTIVE_OIL_CHANGE_AND_LUBRICATION_SHOPS" | "CAR_WASHES" | "ALL_OTHER_AUTOMOTIVE_REPAIR_AND_MAINTENANCE" | "ELECTRONIC_AND_PRECISION_EQUIPMENT_REPAIR_AND_MAINTENANCE" | "COMMERCIAL_AND_INDUSTRIAL_MACHINERY_AND_EQUIPMENT_EXCEPT_AUTOMOTIVE_AND_ELECTRONIC_REPAIR_AND_MAINTENANCE" | "HOME_AND_GARDEN_EQUIPMENT_REPAIR_AND_MAINTENANCE" | "APPLIANCE_REPAIR_AND_MAINTENANCE" | "REUPHOLSTERY_AND_FURNITURE_REPAIR" | "FOOTWEAR_AND_LEATHER_GOODS_REPAIR" | "OTHER_PERSONAL_AND_HOUSEHOLD_GOODS_REPAIR_AND_MAINTENANCE" | "BARBER_SHOPS" | "BEAUTY_SALONS" | "NAIL_SALONS" | "DIET_AND_WEIGHT_REDUCING_CENTERS" | "OTHER_PERSONAL_CARE_SERVICES" | "FUNERAL_HOMES_AND_FUNERAL_SERVICES" | "CEMETERIES_AND_CREMATORIES" | "COIN_OPERATED_LAUNDRIES_AND_DRYCLEANERS" | "DRYCLEANING_AND_LAUNDRY_SERVICES_EXCEPT_COIN_OPERATED" | "LINEN_SUPPLY" | "INDUSTRIAL_LAUNDERERS" | "PET_CARE_EXCEPT_VETERINARY_SERVICES" | "PHOTOFINISHING_LABORATORIES_EXCEPT_ONE_HOUR" | "ONE_HOUR_PHOTOFINISHING" | "PARKING_LOTS_AND_GARAGES" | "ALL_OTHER_PERSONAL_SERVICES" | "RELIGIOUS_ORGANIZATIONS" | "GRANTMAKING_FOUNDATIONS" | "VOLUNTARY_HEALTH_ORGANIZATIONS" | "OTHER_GRANTMAKING_AND_GIVING_SERVICES" | "HUMAN_RIGHTS_ORGANIZATIONS" | "ENVIRONMENT_CONSERVATION_AND_WILDLIFE_ORGANIZATIONS" | "OTHER_SOCIAL_ADVOCACY_ORGANIZATIONS" | "CIVIC_AND_SOCIAL_ORGANIZATIONS" | "BUSINESS_ASSOCIATIONS" | "PROFESSIONAL_ORGANIZATIONS" | "LABOR_UNIONS_AND_SIMILAR_LABOR_ORGANIZATIONS" | "POLITICAL_ORGANIZATIONS" | "OTHER_SIMILAR_ORGANIZATIONS_EXCEPT_BUSINESS_PROFESSIONAL_LABOR_AND_POLITICAL_ORGANIZATIONS" | "PRIVATE_HOUSEHOLDS" | "EXECUTIVE_OFFICES" | "LEGISLATIVE_BODIES" | "PUBLIC_FINANCE_ACTIVITIES" | "EXECUTIVE_AND_LEGISLATIVE_OFFICES_COMBINED" | "AMERICAN_INDIAN_AND_ALASKA_NATIVE_TRIBAL_GOVERNMENTS" | "OTHER_GENERAL_GOVERNMENT_SUPPORT" | "COURTS" | "POLICE_PROTECTION" | "LEGAL_COUNSEL_AND_PROSECUTION" | "CORRECTIONAL_INSTITUTIONS" | "PAROLE_OFFICES_AND_PROBATION_OFFICES" | "FIRE_PROTECTION" | "OTHER_JUSTICE_PUBLIC_ORDER_AND_SAFETY_ACTIVITIES" | "ADMINISTRATION_OF_EDUCATION_PROGRAMS" | "ADMINISTRATION_OF_PUBLIC_HEALTH_PROGRAMS" | "ADMINISTRATION_OF_HUMAN_RESOURCE_PROGRAMS_EXCEPT_EDUCATION_PUBLIC_HEALTH_AND_VETERANS_AFFAIRS_PROGRAMS" | "ADMINISTRATION_OF_VETERANS_AFFAIRS" | "ADMINISTRATION_OF_AIR_AND_WATER_RESOURCE_AND_SOLID_WASTE_MANAGEMENT_PROGRAMS" | "ADMINISTRATION_OF_CONSERVATION_PROGRAMS" | "ADMINISTRATION_OF_HOUSING_PROGRAMS" | "ADMINISTRATION_OF_URBAN_PLANNING_AND_COMMUNITY_AND_RURAL_DEVELOPMENT" | "ADMINISTRATION_OF_GENERAL_ECONOMIC_PROGRAMS" | "REGULATION_AND_ADMINISTRATION_OF_TRANSPORTATION_PROGRAMS" | "REGULATION_AND_ADMINISTRATION_OF_COMMUNICATIONS_ELECTRIC_GAS_AND_OTHER_UTILITIES" | "REGULATION_OF_AGRICULTURAL_MARKETING_AND_COMMODITIES" | "REGULATION_LICENSING_AND_INSPECTION_OF_MISCELLANEOUS_COMMERCIAL_SECTORS" | "SPACE_RESEARCH_AND_TECHNOLOGY" | "NATIONAL_SECURITY" | "INTERNATIONAL_AFFAIRS"; /** * @description In general it's compatible with CounterpartAddress model but * * All fields are optional * * There is an additional field original_country_name */ OCRAddress: { /** * @description City name. * @example New York */ city?: string; /** * @description Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). * @example US */ country?: string; /** * @description Street address. * @example 456 Fifth Avenue */ line1?: string; /** @description Additional address information (if any). */ line2?: string; /** * @description Country name as it is stated in the document. * @example United States */ original_country_name?: string; /** * @description ZIP or postal code. * @example 10001 */ postal_code?: string; /** @description State, region, province, or county. */ state?: string; }; OCRAddressDetails: { city?: string; country?: components["schemas"]["AllowedCountries"]; postal_code?: string; state?: string; street_and_number?: string; }; OCRBankDetails: { bank_account_number?: string; iban?: string; swift_bic?: string; }; OCRCounterpartDetails: { address: components["schemas"]["OCRAddressDetails"]; bank_account: components["schemas"]["OCRBankDetails"]; email?: string; name?: string; tax_number?: string; vat_number?: string; }; OCRCreditNote: { currency?: components["schemas"]["CurrencyEnum"]; document_number?: string; /** Format: date */ issue_date?: string; line_items: components["schemas"]["OCRLineItem"][]; original_invoice_number?: string; recipient: components["schemas"]["OCRCounterpartDetails"]; sender: components["schemas"]["OCRCounterpartDetails"]; subtotal?: number; tax_amount?: number; tax_rate?: number; total_amount?: number; /** * @default credit_note * @enum {string} */ type: "credit_note"; }; /** @enum {string} */ OCRDocumentTypeEnum: "invoice" | "credit_note" | "receipt"; OCRFileUpload: { /** Format: binary */ file: Blob; }; OCRInvoice: { amount_paid?: number; currency?: components["schemas"]["CurrencyEnum"]; document_number?: string; /** Format: date */ due_date?: string; /** Format: date */ issue_date?: string; line_items?: components["schemas"]["OCRLineItem"][]; payment_terms?: string; recipient: components["schemas"]["OCRCounterpartDetails"]; sender: components["schemas"]["OCRCounterpartDetails"]; subtotal?: number; tax_amount?: number; tax_rate?: number; total_amount?: number; /** * @default invoice * @enum {string} */ type: "invoice"; }; OCRLineItem: { description?: string; line_reference?: string; name?: string; quantity?: number; subtotal?: number; tax_amount?: number; tax_rate?: number; total_amount?: number; unit?: string; unit_price?: number; }; OCRReceipt: { currency?: components["schemas"]["CurrencyEnum"]; discount?: number; document_number?: string; /** Format: date-time */ issued_at?: string; line_items: components["schemas"]["OCRReceiptLineItem"][]; sender: components["schemas"]["OCRCounterpartDetails"]; subtotal?: number; tax_amount?: number; tax_rate?: number; tax_type?: string; total_amount?: number; /** * @default receipt * @enum {string} */ type: "receipt"; }; OCRReceiptLineItem: { description?: string; discount_amount?: number; line_reference?: string; name?: string; quantity?: number; subtotal?: number; tax_amount?: number; tax_rate?: number; total_amount?: number; unit?: string; unit_price?: number; }; /** @enum {string} */ OCRRequestSource: "internal" | "external"; OCRResponseInvoiceReceiptData: { /** * @description Counterpart bank ID * @example CHASUS33 */ counterpart_account_id?: string; /** @description The bank account number */ counterpart_account_number?: string; /** @description Counterpart address */ counterpart_address?: string; /** @description Counterpart address as a json object compatible with counterparts service */ counterpart_address_object?: components["schemas"]["OCRAddress"]; /** @description The bank branch number */ counterpart_branch_number?: string; /** @description Email address of the counterpart */ counterpart_email?: string; /** * @description Counterpart name * @example Clacksworth Keyboards */ counterpart_name?: string; /** @description The bank routing number */ counterpart_routing_number?: string; /** * @description Counterpart VAT ID * @example 123456789 */ counterpart_vat_id?: string; /** * @description ISO 4217 currency code * @example USD */ currency?: string; /** @description Discount Raw amount */ discount_raw?: number; /** @description Document due date in ISO format */ document_due_date?: string; /** * @description Invoice/receipt ID * @example CST-13341 */ document_id?: string; /** @description Document issuance date in ISO format */ document_issued_at_date?: string; /** @description List of line items from document raw, without minor units conversion. */ line_items_raw?: components["schemas"]["OCRResponseInvoiceReceiptLineItemRaw"][]; /** @description Raw payment terms parsed but not calculated. */ payment_terms_raw?: string[]; /** * @description Purchase Order Number * @example 1234 */ purchase_order_number?: string; /** * @description Tax payer ID * @example 12345678901 */ tax_payer_id?: string; /** * @description Subtotal, without minor units * @example 77 */ total_excl_vat_raw?: number; /** * @description Total paid amount * @default 0 * @example 50 */ total_paid_amount_raw: number; /** * @description Total, without minor units * @example 70 */ total_raw?: number; /** * @description VAT amount, without minor units * @example 7 */ total_vat_amount_raw?: number; /** * @description VAT Percent raw, without minor units. * @example 12.5 */ total_vat_rate_raw?: number; /** * @default invoice * @enum {string} */ type: "invoice"; }; OCRResponseInvoiceReceiptLineItemRaw: { /** * @description Human-readable line item description * @example Impact Players : How to Take the Lead , Play Bigger , and Multiply Your */ description?: string; /** * @description Item Quantity/Unit Price adjusted * @default false */ item_adjusted: boolean; /** @description OCR Id of line item */ line_item_ocr_id?: string; /** * @description Quantity * @example 1.2 */ quantity?: number; /** * @description Total excluded VAT as parsed. * @example 120 */ total_excl_vat?: number; /** * @description Total included VAT as parsed. * @example 135 */ total_incl_vat?: number; /** * @description Unit * @example meters */ unit?: string; /** * @description Price as parsed * @example 100 */ unit_price?: number; /** * @description VAT Amount as parsed. * @example 15 */ vat_amount?: number; /** * @description VAT Percent as parsed. * @example 12.5 */ vat_percentage?: number; }; /** @enum {string} */ OCRTaskStatus: "processing" | "success" | "error"; /** @description A paginated list of ocr requests. */ OCRTasksPaginationResponse: { data: components["schemas"]["OcrTaskResponseSchema"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; /** @enum {string} */ ObjectMatchTypes: "product" | "customer" | "vendor" | "receivable" | "bill" | "payment_record"; /** @enum {string} */ ObjectType: "account" | "accounting_tax_rate" | "approval" | "approval_request" | "approval_policy" | "approval_policy_process" | "audit_trail" | "comment" | "cost_center" | "counterpart" | "counterpart_address" | "counterpart_bank_account" | "counterpart_contact_person" | "counterpart_partner_metadata" | "counterpart_tax_id" | "counterpart_vat_id" | "delivery_note" | "einvoicing" | "entity" | "entity_bank_account" | "entity_settings" | "entity_token" | "entity_user" | "entity_user_token" | "entity_vat_ids" | "export" | "ledger_account" | "mailbox" | "monitescript_process" | "ocr_task" | "onboarding" | "overdue_reminder" | "partner" | "partner_internal_config" | "partner_settings" | "partner_token" | "payable" | "payable_line_item" | "payables_credit_note" | "payables_purchase_order" | "payment" | "payment_intent" | "payment_link" | "payment_record" | "payment_reminder" | "person" | "product" | "project" | "receivable" | "reconciliation" | "recurrence" | "receipt" | "role" | "tag" | "todo_task" | "todo_task_mute" | "transaction" | "transaction_validation" | "webhook" | "workflow" | "workflow_pipeline"; /** @enum {string} */ ObjectTypeAvailableComment: "payable"; /** @enum {string} */ ObjectTypeEnum: "receivable" | "payable"; OcrAutoTaggingSettingsRequest: { /** @description A switch to temporarily disable a keyword without removing it from the list. */ enabled: boolean; /** @description A list of words that will be searched for assigning a tag in the recognized fields of the document after OCR processing. If at least one match is found, the tag will be assigned. Each keyword must be between 2 and 25 characters long. */ keywords: string[]; /** * Format: uuid * @description Tag identifier that will be assigned to the payable document if one of the words listed in keywords is found during OCR. */ tag_id: string; }; /** * @description Contains information about all text blocks extracted from an uploaded invoice by OCR. * The text blocks are grouped into `line_items` (invoice line items) and `summary` (all other information). * Legacy schema used for AWS textract recognition. */ OcrRecognitionResponse: { /** @description Text content of the invoice line items as recognized by OCR. */ line_items?: components["schemas"]["LabelNValue"][]; /** @description Invoice text content other than the line items. Such as the invoice issue and due dates, vendor name and address, and other general information. */ summary?: components["schemas"]["LabelNValue"][]; }; /** @enum {string} */ OcrStatusEnum: "processing" | "error" | "success" | "canceled"; OcrTaskResponseSchema: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; document_type?: components["schemas"]["OCRDocumentTypeEnum"]; recognized_data?: components["schemas"]["OCRInvoice"] | components["schemas"]["OCRCreditNote"] | components["schemas"]["OCRReceipt"]; source: components["schemas"]["OCRRequestSource"]; status: components["schemas"]["OCRTaskStatus"]; }; OnboardingLinkResponse: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ expires_at: string; recipient: components["schemas"]["Recipient"]; /** Format: uri */ refresh_url: string; /** Format: uri */ return_url: string; /** Format: uri */ url: string; }; OnboardingPaymentMethodsResponse: { data: components["schemas"]["PaymentMethod"][]; }; OnboardingRequirementsResponse: { disabled_reason?: components["schemas"]["AccountDisabledReason"]; requirements: components["schemas"]["PaymentRequirements"]; requirements_errors: components["schemas"]["RequirementsError"][]; verification_errors: components["schemas"]["VerificationError"][]; verification_status: components["schemas"]["VerificationStatusEnum"]; }; OptionalFee: { /** @example 32 */ amount?: number; /** @example 0.55 */ percentage?: number; }; /** @description A schema for metadata for updating an individual */ OptionalIndividualSchema: { date_of_birth?: string | null; /** @description A first name of an individual */ first_name?: string | null; id_number?: string | null; /** @description A last name of an individual */ last_name?: string | null; /** @description The last four digits of the individual's Social Security number */ ssn_last_4?: string | null; /** @description A title of an individual */ title?: string | null; }; OptionalOfAddressInput: { hasValue?: boolean; value?: components["schemas"]["AddressInput"]; }; OptionalOfAuthenticationInput: { hasValue?: boolean; value?: components["schemas"]["AuthenticationInput"]; }; OptionalOfBankAccountApplicantInput: { hasValue?: boolean; value?: components["schemas"]["BankAccountApplicantInput"]; }; OptionalOfBankAccountStatus: { hasValue?: boolean; value?: components["schemas"]["BankAccountStatus"]; }; OptionalOfBusinessDetailsInput: { hasValue?: boolean; value?: components["schemas"]["BusinessDetailsInput"]; }; OptionalOfBusinessStructureType: { hasValue?: boolean; value?: components["schemas"]["BusinessStructureType"]; }; OptionalOfCountryCode: { hasValue?: boolean; value?: components["schemas"]["CountryCode"]; }; OptionalOfCreditCardApplicantInput: { hasValue?: boolean; value?: components["schemas"]["CreditCardApplicantInput"]; }; OptionalOfCreditCardBusinessDetailsInput: { hasValue?: boolean; value?: components["schemas"]["CreditCardBusinessDetailsInput"]; }; OptionalOfDateOnly: { hasValue?: boolean; /** Format: date */ value?: null | string; }; OptionalOfExternalBankAccountVerificationInput: { hasValue?: boolean; value?: components["schemas"]["ExternalBankAccountVerificationInput"]; }; /** Format: uuid */ OptionalOfGuid: null | string; OptionalOfListOfBusinessOwnerInput: { hasValue?: boolean; value?: null | components["schemas"]["BusinessOwnerInput"][]; }; OptionalOfNorthAmericanIndustryClassificationSystemCode: { hasValue?: boolean; value?: components["schemas"]["NorthAmericanIndustryClassificationSystemCode"]; }; /** @enum {string} */ OptionalOfOrganizationType: "BANK" | "EMBEDDED" | "PLATFORM" | "TRANSACTOR" | "VERTICAL_SOFTWARE_PROVIDER"; OptionalOfPersonalIdentificationNumberDto: { hasValue?: boolean; value?: components["schemas"]["PersonalIdentificationNumberDto"]; }; OptionalOfTaxIdentificationNumberInput: { hasValue?: boolean; value?: components["schemas"]["TaxIdentificationNumberInput"]; }; OptionalOfboolean: { hasValue?: boolean; value?: null | boolean; }; OptionalOfdecimal: { hasValue?: boolean; /** Format: double */ value?: null | number | string; }; OptionalOfint: { hasValue?: boolean; /** Format: int32 */ value?: null | number | string; }; OptionalOflong: { hasValue?: boolean; /** Format: int64 */ value?: null | number | string; }; OptionalOfstring: { hasValue?: boolean; value?: null | string; }; /** @description A schema contains metadata for updating an organization */ OptionalOrganizationSchema: { /** @description Business structure of the company */ business_structure?: components["schemas"]["EntityBusinessStructure"] | null; directors_provided?: boolean | null; executives_provided?: boolean | null; /** @description A code which identifies uniquely a party of a transaction worldwide */ legal_entity_id?: string | null; /** @description A legal name of an organization */ legal_name?: string | null; owners_provided?: boolean | null; representative_provided?: boolean | null; }; /** @enum {string} */ OrderEnum: "asc" | "desc"; /** @description Response DTO for the organization details endpoint. */ OrganizationDetailsResponseDto: { /** * Format: uuid * @description The unique identifier of the organization. */ id: string; address?: null | components["schemas"]["AddressDto"]; /** * @description Counts of direct child organizations grouped by type (e.g., {"VERTICAL_SOFTWARE_PROVIDER": 3, "EMBEDDED": 2}). * Empty dictionary if the organization has no children. */ childOrganizationTypeCounts?: { [key: string]: number | string; }; /** @description The display name of the organization. */ displayName: string; /** @description The domain name / website of the organization. */ domainName?: null | string; embeddedBusinessData?: null | components["schemas"]["EmbeddedBusinessDataResponseDto"]; /** @description Whether the organization is currently enabled (active within the time window). */ isEnabled: boolean; /** @description The legal name of the organization. */ legalName: string; logo?: null | components["schemas"]["OrganizationLogoResponseDto"]; /** @description The organization's phone number, if available. */ phoneNumber?: null | string; /** @description A short identifier for the organization. */ shortName: string; /** @description The types assigned to the organization (e.g., VSP, Bank). */ types: components["schemas"]["OrganizationType"][]; }; /** @description Response DTO for an individual page within a multi-page logo asset. */ OrganizationLogoPageResponseDto: { /** * Format: uuid * @description The unique identifier of this page. */ id: string; /** @description The MIME type of the page image. */ mimetype: string; /** * Format: int32 * @description The 1-based page number. */ number: number | string; /** * Format: int64 * @description File size in bytes for this page. */ size: number | string; /** @description Public URL to the page image. */ url: string; }; /** @description Response DTO for a generated preview thumbnail of the logo. */ OrganizationLogoPreviewResponseDto: { /** * Format: int32 * @description Height of the preview in pixels. */ height: number | string; /** @description Public URL to the preview image. */ url: string; /** * Format: int32 * @description Width of the preview in pixels. */ width: number | string; }; /** @description Response DTO for an organization's uploaded logo. */ OrganizationLogoResponseDto: { /** * Format: uuid * @description The unique identifier of the logo asset. */ id: string; /** * Format: date-time * @description UTC timestamp indicating when the logo was uploaded. */ createdTsUtc: string; /** @description The general file type category (e.g., "image"). */ fileType: string; /** @description MD5 checksum of the original file. */ md5: string; /** @description The MIME type of the original file (e.g., "image/png"). */ mimetype: string; /** @description Original filename of the uploaded logo. */ name: string; /** @description Per-page representations of the logo asset, when applicable. */ pages?: null | components["schemas"]["OrganizationLogoPageResponseDto"][]; /** @description Generated preview thumbnails for the logo at various dimensions. */ previews?: null | components["schemas"]["OrganizationLogoPreviewResponseDto"][]; /** @description The CDN region the logo asset is served from. */ region: string; /** * Format: int64 * @description File size in bytes. */ size: number | string; /** @description Public URL to the logo asset. */ url: string; }; /** @description Contains data specific to entities of the `organization` type. */ OrganizationResponseSchema: { /** @description Business structure of the company */ business_structure?: components["schemas"]["EntityBusinessStructure"] | null; directors_provided?: boolean | null; executives_provided?: boolean | null; /** @description A code which identifies uniquely a party of a transaction worldwide */ legal_entity_id?: string | null; /** @description The legal name of the organization. */ legal_name: string; owners_provided?: boolean | null; representative_provided?: boolean | null; }; /** @description A schema contains metadata for an organization */ OrganizationSchema: { /** @description Business structure of the company */ business_structure?: components["schemas"]["EntityBusinessStructure"] | null; directors_provided?: boolean | null; executives_provided?: boolean | null; /** @description A code which identifies uniquely a party of a transaction worldwide */ legal_entity_id?: string | null; /** @description The legal name of the organization. If this organization will use Monite payment rails, this name must be up to 100 characters long, otherwise it can be up to 255 characters long. */ legal_name: string; owners_provided?: boolean | null; representative_provided?: boolean | null; }; OrganizationSettingsAccountingDto: { ledgerAccountIds?: null | string[]; taxIds?: null | string[]; }; OrganizationSettingsDocumentIdsDto: { documentTypePrefix?: null | string; includeDate?: null | boolean; /** Format: int32 */ minDigits?: null | number | string; /** Format: int32 */ nextNumber?: null | number | string; prefix?: null | string; separator?: null | string; }; OrganizationSettingsDocumentRenderingDto: { creditNote?: null | components["schemas"]["JsonElement"]; displayEntityBankAccount?: null | boolean; displayLineItems?: null | boolean; invoice?: null | components["schemas"]["JsonElement"]; lineItems?: null | components["schemas"]["JsonElement"]; quote?: null | components["schemas"]["JsonElement"]; }; OrganizationSettingsMailDto: { replyTo?: null | string; }; OrganizationSettingsOcrAutoTaggingDto: { enabled?: null | boolean; keywords?: null | string[]; tagId?: null | string; }; OrganizationSettingsReminderDto: { enabled?: null | boolean; }; OrganizationSettingsResponseDto: { accounting?: null | components["schemas"]["OrganizationSettingsAccountingDto"]; allowPurchaseOrderAutolinking?: null | boolean; currency?: null | string; documentIds?: null | components["schemas"]["OrganizationSettingsDocumentIdsDto"]; documentRendering?: null | components["schemas"]["OrganizationSettingsDocumentRenderingDto"]; generatePaidInvoicePdf?: null | boolean; language?: null | string; mail?: null | components["schemas"]["OrganizationSettingsMailDto"]; payablesOcrAutoTagging?: null | components["schemas"]["OrganizationSettingsOcrAutoTaggingDto"][]; payablesSkipApprovalFlow?: null | boolean; paymentPriority?: null | string; quoteSignatureRequired?: null | boolean; receivableEditFlow?: null | string; reminder?: null | components["schemas"]["OrganizationSettingsReminderDto"]; vatInclusiveDiscountMode?: null | string; vatMode?: null | string; }; /** * @description Filter for organization active status. * @enum {string} */ OrganizationStatusFilter: "ACTIVE" | "ALL" | "INACTIVE"; OrganizationStatusResponseDto: { isEnabled: boolean; /** Format: uuid */ organizationId: string; }; /** @description Summary information for a single organization visible to the caller. */ OrganizationSummary: { /** * Format: int32 * @description The number of bank accounts belonging to this organization. */ accountCount: number | string; /** @description The display name of the organization (organization name). */ name: string; /** * Format: uuid * @description The unique identifier of the organization. */ organizationId: string; /** @description The unique organization reference (FIS Enterprise Customer Reference). */ uniqueReference?: null | string; /** * Format: int32 * @description The number of users with access to bank accounts in this organization. */ userCount: number | string; }; /** @enum {string} */ OrganizationType: "BANK" | "EMBEDDED" | "PLATFORM" | "TRANSACTOR" | "VERTICAL_SOFTWARE_PROVIDER"; /** @enum {string} */ OriginEnum: "upload" | "einvoicing"; OverdueReminderRequest: { name: string; recipients?: components["schemas"]["Recipients"]; /** @description Overdue reminder terms to send for payment */ terms?: components["schemas"]["OverdueReminderTerm"][]; }; OverdueReminderResponse: { /** Format: uuid */ id: string; /** * Format: date-time * @description Time at which the OverdueReminder was created. Timestamps follow the ISO 8601 standard. */ created_at: string; /** * Format: date-time * @description Time at which the OverdueReminder was last updated. Timestamps follow the ISO 8601 standard. */ updated_at: string; name: string; recipients?: components["schemas"]["Recipients"]; /** @description Overdue reminder terms to send for payment */ terms?: components["schemas"]["OverdueReminderTerm"][]; }; OverdueReminderTerm: { body: string; days_after: number; subject: string; }; OverdueReminderUpdateRequest: { name?: string; recipients?: components["schemas"]["Recipients"]; /** @description Overdue reminder terms to send for payment */ terms?: components["schemas"]["OverdueReminderTerm"][]; }; "OwnershipDeclaration-Input": { /** @description The date and time (in the ISO 8601 format) when the beneficial owner attestation was made. */ date?: string | null; /** * @description The IP address from which the beneficial owner attestation was made. If omitted or set to `null` in the request, the IP address is inferred from the request origin or the `X-Forwarded-For` request header. * @example 203.0.113.24 */ ip?: string | null; }; "OwnershipDeclaration-Output": { /** @description The date and time (in the ISO 8601 format) when the beneficial owner attestation was made. */ date?: string | null; /** * @description The IP address from which the beneficial owner attestation was made. If omitted or set to `null` in the request, the IP address is inferred from the request origin or the `X-Forwarded-For` request header. * @example 203.0.113.24 */ ip?: string | null; }; PageCounterBlock: { /** @default for */ for_preposition: string; /** @default of */ of_preposition: string; /** @default Page */ page_text: string; }; /** * @description When a PDF document is uploaded to Monite, it extracts individual pages from the document * and saves them as PNG images. This object contains the image and metadata of a single page. */ PageSchema: { /** * Format: uuid * @description A unique ID of the image. */ id: string; /** * @description The [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types) of the image. * @example image/png */ mimetype: string; /** * @description The page number in the PDF document, from 0. * @example 0 */ number: number; /** * @description Image file size, in bytes. * @example 21972 */ size: number; /** * @description The URL to download the image. * @example https://bucket.s3.amazonaws.com/123/456.png */ url: string; }; /** * @description When a PDF document is uploaded to Monite, it extracts individual pages from the document * and saves them as PNG images. This object contains the image and metadata of a single page. */ PageSchema2: { /** * Format: uuid * @description A unique ID of the image. */ id: string; /** * @description The [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the image. * @example image/png */ mimetype: string; /** * @description The page number in the PDF document, from 0. * @example 0 */ number: number; /** * @description Image file size, in bytes. * @example 21972 */ size: number; /** * @description The URL to download the image. * @example https://bucket.s3.amazonaws.com/123/456.png */ url: string; }; /** * @description When a PDF document is uploaded to Monite, it extracts individual pages from the document * and saves them as PNG images. This object contains the image and metadata of a single page. */ PageSchema3: { /** * Format: uuid * @description A unique ID of the image. */ id: string; /** * @description The [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types) of the image. * @example image/png */ mimetype: string; /** * @description The page number in the PDF document, from 0. * @example 0 */ number: number; /** * @description Image file size, in bytes. * @example 21972 */ size: number; /** * @description The URL to download the image. * @example https://bucket.s3.amazonaws.com/123/456.png */ url: string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfApplicationListResponseDto: { /** @description The items in the current page. */ data: components["schemas"]["ApplicationListResponseDto"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfBankAccountApplicationSummaryResponse: { /** @description The items in the current page. */ data: components["schemas"]["BankAccountApplicationSummaryResponse"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfBankAccountTransactionResponse: { /** @description The items in the current page. */ data: components["schemas"]["BankAccountTransactionResponse"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfBankAccountTransferResponse: { /** @description The items in the current page. */ data: components["schemas"]["BankAccountTransferResponse"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfBankAccountWithBalanceResponse: { /** @description The items in the current page. */ data: components["schemas"]["BankAccountWithBalanceResponse"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfBeneficialOwnerResponse: { /** @description The items in the current page. */ data: components["schemas"]["BeneficialOwnerResponse"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfCreditCardResponse: { /** @description The items in the current page. */ data: components["schemas"]["CreditCardResponse"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfCreditCardTransactionResponse: { /** @description The items in the current page. */ data: components["schemas"]["CreditCardTransactionResponse"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfDepartmentListItem: { /** @description The items in the current page. */ data: components["schemas"]["DepartmentListItem"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfDepartmentMember: { /** @description The items in the current page. */ data: components["schemas"]["DepartmentMember"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfExternalBankAccountResponse: { /** @description The items in the current page. */ data: components["schemas"]["ExternalBankAccountResponse"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfLocationListItem: { /** @description The items in the current page. */ data: components["schemas"]["LocationListItem"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfLocationMember: { /** @description The items in the current page. */ data: components["schemas"]["LocationMember"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfMerchantCategoryGroupResponse: { /** @description The items in the current page. */ data: components["schemas"]["MerchantCategoryGroupResponse"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfRoleMemberResponseDto: { /** @description The items in the current page. */ data: components["schemas"]["RoleMemberResponseDto"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @description A paginated response containing a page of results and navigation tokens. */ PaginatedResponseOfRoleResponseDto: { /** @description The items in the current page. */ data: components["schemas"]["RoleResponseDto"][]; /** @description A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page. */ nextPaginationToken?: null | string; /** @description A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page. */ prevPaginationToken?: null | string; }; /** @enum {string} */ PaidBy: "recipient" | "payer" | "partner"; /** * @description Summary information for a parent organization. * Contains only non-sensitive fields (excludes EIN, TaxId, banking info, etc.). */ ParentOrganizationSummaryDto: { /** * Format: uuid * @description The unique identifier of the organization. */ id: string; /** @description The display name of the organization. */ displayName: string; /** @description Whether the organization is currently enabled. */ isEnabled: boolean; /** @description The types assigned to the organization. */ types: components["schemas"]["OrganizationType"][]; }; PartiallyPaidPayload: { /** @description How much was paid on the invoice (in minor units). */ amount_paid: number; }; PartnerMetadata: { /** @description Metadata for partner needs */ metadata: Record; }; PartnerMetadataResponse: { /** @description Metadata for partner needs */ metadata?: Record; }; "PartnerProjectSettingsPayload-Input": { /** @description Default API version for partner. */ api_version?: components["schemas"]["APIVersion"] | null; /** @description Commercial conditions for receivables. */ commercial_conditions?: string[] | null; /** @description Custom currency exchange rates. */ currency?: components["schemas"]["CurrencySettings-Input"] | null; /** @description A default role to provision upon new entity creation. */ default_role?: { [key: string]: unknown; } | null; /** @description Settings for email and mailboxes. */ mail?: components["schemas"]["MailSettings"] | null; /** @description Settings for the payables module. */ payable?: components["schemas"]["PayableSettings"] | null; /** @description Settings for the payments module. */ payments?: components["schemas"]["PaymentsSettings-Input"] | null; /** @description Settings for the receivables module. */ receivable?: components["schemas"]["ReceivableSettings"] | null; /** @description Measurement units. */ units?: components["schemas"]["Unit"][] | null; website?: string | null; }; "PartnerProjectSettingsPayload-Output": { /** @description Default API version for partner. */ api_version?: components["schemas"]["APIVersion"] | null; /** @description Commercial conditions for receivables. */ commercial_conditions?: string[] | null; /** @description Custom currency exchange rates. */ currency?: components["schemas"]["CurrencySettings-Output"] | null; /** @description A default role to provision upon new entity creation. */ default_role?: { [key: string]: unknown; } | null; /** @description Settings for email and mailboxes. */ mail?: components["schemas"]["MailSettings"] | null; /** @description Settings for the payables module. */ payable?: components["schemas"]["PayableSettings"] | null; /** @description Settings for the payments module. */ payments?: components["schemas"]["PaymentsSettings-Output"] | null; /** @description Settings for the receivables module. */ receivable?: components["schemas"]["ReceivableSettings"] | null; /** @description Measurement units. */ units?: components["schemas"]["Unit"][] | null; website?: string | null; }; PatchApplicationScopesRequestDto: { /** * @description Scopes to add to the application. Each value must be one of the scopes the API * allows to be patched onto an application; unknown values are rejected with 400. */ addScopes?: null | string[]; /** * @description Scopes to remove from the application. Each value must be one of the scopes the API * allows to be patched onto an application; unknown values are rejected with 400. */ removeScopes?: null | string[]; }; PatchDisabledPaymentRailsRequestDto: { /** * @description Payment rails to disable for the organization. Valid values are: * "payment_rail:ach", "payment_rail:fednow", "payment_rail:rtp". */ disable?: null | string[]; /** * @description Payment rails to enable for the organization (remove from disabled list). Valid values are: * "payment_rail:ach", "payment_rail:fednow", "payment_rail:rtp". */ enable?: null | string[]; }; PatchOrganizationSettingsRequestDto: { accounting?: null | components["schemas"]["OrganizationSettingsAccountingDto"]; allowPurchaseOrderAutolinking?: null | boolean; currency?: null | string; documentIds?: null | components["schemas"]["OrganizationSettingsDocumentIdsDto"]; documentRendering?: null | components["schemas"]["OrganizationSettingsDocumentRenderingDto"]; generatePaidInvoicePdf?: null | boolean; language?: null | string; mail?: null | components["schemas"]["OrganizationSettingsMailDto"]; payablesOcrAutoTagging?: null | components["schemas"]["OrganizationSettingsOcrAutoTaggingDto"][]; payablesSkipApprovalFlow?: null | boolean; paymentPriority?: null | string; quoteSignatureRequired?: null | boolean; receivableEditFlow?: null | string; reminder?: null | components["schemas"]["OrganizationSettingsReminderDto"]; vatInclusiveDiscountMode?: null | string; vatMode?: null | string; }; PatchRoleRequestDto: { /** * @description Two states accepted: absent = leave unchanged, value = set (must be a ranked type the owning * org holds). Clearing to null is rejected, roles cannot become unscoped. */ appliesToOrgType?: components["schemas"]["OptionalOfOrganizationType"]; /** @description Three states: absent = leave unchanged, null = clear, value = set. */ description?: components["schemas"]["OptionalOfstring"]; key?: components["schemas"]["OptionalOfstring"]; name?: components["schemas"]["OptionalOfstring"]; }; PatchSettingsPayload: { accounting?: components["schemas"]["AccountingSettings"] | null; /** * @description Automatically attempt to find a corresponding purchase order for all incoming payables. * @default true */ allow_purchase_order_autolinking: boolean | null; currency?: components["schemas"]["CurrencySettings-Input2"] | null; /** @description The organization's single global default bank account. Clients use it to pre-fill the bank account field when creating receivables; it is not applied automatically on the server. Set to `null` to clear it. */ default_bank_account?: components["schemas"]["DefaultBankAccount"] | null; document_ids?: components["schemas"]["DocumentIDsSettingsRequest"] | null; /** @description Settings for rendering documents in PDF format. */ document_rendering?: components["schemas"]["DocumentRenderingSettings-Input"]; /** * @description This setting affects how PDF is generated for paid accounts receivable invoices. If set to `true`, once an invoice is fully paid its PDF version is updated to display the amount paid and the payment-related features are removed. * * The PDF file gets regenerated at the moment when an invoice becomes paid. It is not issued as a separate document, and the original PDF invoice is no longer available. * * This field is deprecated and will be replaced by `document_rendering.invoice.generate_paid_invoice_pdf`. * @default false */ generate_paid_invoice_pdf: boolean; language?: components["schemas"]["LanguageCodeEnum"] | null; /** @description Email settings for the entity */ mail?: components["schemas"]["EntityMailSettings"] | null; /** @description Auto tagging settings for all incoming OCR payable documents. */ payables_ocr_auto_tagging?: components["schemas"]["OcrAutoTaggingSettingsRequest"][] | null; /** * @description If enabled, the approval policy will be skipped and the payable will be moved to `waiting_to_be_paid` status. * @default false */ payables_skip_approval_flow: boolean; /** * @description Payment preferences for entity to automate calculating suggested payment date based on payment terms and entity preferences. * @default working_capital */ payment_priority: components["schemas"]["PaymentPriorityEnum"] | null; /** * @description Sets the default behavior of whether a signature is required to accept quotes. * @default false */ quote_signature_required: boolean; /** @default compliant */ receivable_edit_flow: components["schemas"]["ReceivableEditFlow"] | null; reminder?: components["schemas"]["RemindersSettings"] | null; /** * @description Defines whether the amount discounts (for percentage discounts it does not matter) on tax inclusive invoices will be applied on amounts including tax or excluding tax. * @default exclusive */ tax_inclusive_discount_mode: components["schemas"]["VatModeEnum"]; /** * @description Defines whether the prices of products in receivables will already include tax or not. * @default exclusive */ tax_mode: components["schemas"]["VatModeEnum"] | null; }; /** @enum {string} */ PayableActionEnum: "create" | "read" | "update" | "delete" | "pay" | "approve" | "cancel" | "submit" | "create_from_mail" | "reopen"; PayableActionSchema: { /** * @description Action name * @default read */ action_name: components["schemas"]["PayableActionEnum"]; /** * @description Permission type * @default allowed */ permission: components["schemas"]["PermissionEnum"]; }; PayableAggregatedDataResponse: { /** @description The total count of payables across all statuses. */ count: number; /** @description A list of aggregated items, each representing a status with its associated sum of the amount field and count. */ data: components["schemas"]["PayableAggregatedItem"][]; /** @description The total sum of the amount field for all payables across all statuses. */ sum_total_amount: number; }; PayableAggregatedItem: { /** @description The total count of payables with this specific status. */ count: number; /** @description The status of the payable (e.g., paid, draft, etc.). */ status: components["schemas"]["PayableStateEnum"]; /** @description The total sum of the amount field for all payables with this specific status. */ sum_total_amount: number; }; PayableAnalyticsResponse: { data: components["schemas"]["AnalyticsDataPoint"][]; }; PayableAttachFile: { /** Format: binary */ file: Blob; }; PayableCounterpartInfoBlock: { address?: string; email?: string; first_name?: string; header?: string; last_name?: string; name?: string; phone?: string; tax_id?: string; vat_id?: string; }; PayableCreatedEventData: { payable_source: components["schemas"]["PayableOriginEnum"]; }; PayableCreditNoteData: { /** * Format: uuid * @description The unique identifier of the credit note. * @example 123e4567-e89b-12d3-a456-426614174000 */ id: string; /** * @description The credit note's unique document number. * @example CN-123456 */ document_id?: string; /** * Format: date * @description The date when the credit note was issued, in the YYYY-MM-DD format * @example 2024-01-15 */ issued_at?: string; /** * @description The current status of the credit note in its lifecycle * @example submitted_for_approval */ status: string; /** * @description Credit note total amount. * @example 1000 */ total_amount?: number; }; PayableCreditNoteLinkedEventData: { credit_note_document_id?: string; credit_note_id: string; }; /** @enum {string} */ PayableCreditNoteStateEnum: "new" | "draft" | "applied" | "approved" | "rejected" | "canceled" | "submitted_for_approval"; PayableCreditNoteUnlinkedEventData: { credit_note_document_id?: string; credit_note_id: string; }; /** @enum {string} */ PayableCursorFields: "id" | "created_at" | "issued_at" | "due_date"; /** @enum {string} */ PayableDimensionEnum: "created_at" | "status" | "counterpart_id" | "currency" | "issued_at" | "due_date" | "project_id"; /** @description A schema represents address info of the entity */ PayableEntityAddressSchema: { /** @description A city (a full name) where the entity is registered */ city: string; /** * @description A country name (as ISO code) where the entity is registered * @default DE * @example DE */ country: components["schemas"]["AllowedCountries"]; /** @description A street where the entity is registered */ line1: string; /** @description An alternative street used by the entity */ line2?: string; /** @description A postal code of the address where the entity is registered */ postal_code: string; /** @description A state in a country where the entity is registered */ state?: string; }; /** @description A base for an entity response schema */ PayableEntityIndividualResponse: { /** * Format: uuid * @description UUID entity ID */ id: string; /** * Format: date-time * @description UTC datetime */ created_at: string; /** * Format: date-time * @description UTC datetime */ updated_at: string; address: components["schemas"]["PayableEntityAddressSchema"]; /** @description An official email address of the entity */ email?: string; /** @description A set of metadata describing an individual */ individual: components["schemas"]["PayableIndividualSchema"]; /** @description A logo image of the entity */ logo?: components["schemas"]["FileSchema3"]; /** @description A phone number of the entity */ phone?: string; /** @description record status, 'active' by default */ status: components["schemas"]["StatusEnum"]; /** @description The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered. */ tax_id?: string; /** * Format: uri * @description A website of the entity */ website?: string; }; PayableEntityInfoBlock: { address?: string; first_name?: string; header?: string; last_name?: string; name?: string; tax_id?: string; vat_id?: string; }; /** @description A base for an entity response schema */ PayableEntityOrganizationResponse: { /** * Format: uuid * @description UUID entity ID */ id: string; /** * Format: date-time * @description UTC datetime */ created_at: string; /** * Format: date-time * @description UTC datetime */ updated_at: string; address: components["schemas"]["PayableEntityAddressSchema"]; /** @description An official email address of the entity */ email?: string; /** @description A logo image of the entity */ logo?: components["schemas"]["FileSchema3"]; /** @description A set of metadata describing an organization */ organization: components["schemas"]["PayableOrganizationSchema"]; /** @description A phone number of the entity */ phone?: string; /** @description record status, 'active' by default */ status: components["schemas"]["StatusEnum"]; /** @description The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered. */ tax_id?: string; /** * Format: uri * @description A website of the entity */ website?: string; }; /** @enum {string} */ PayableHistoryCursorFields: "timestamp"; /** @enum {string} */ PayableHistoryEventTypeEnum: "status_changed" | "payable_created" | "payable_updated" | "credit_note_linked" | "credit_note_unlinked" | "file_attached"; /** @description A paginated list of change history records. */ PayableHistoryPaginationResponse: { data: components["schemas"]["PayableHistoryResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; PayableHistoryResponse: { /** * Format: uuid * @description A unique ID of the history record. * @example cd58435b-1c79-4b17-9f79-f898c93e5f97 */ id: string; /** * Format: uuid * @description ID of the entity user who made the change or trigger the event, or `null` if it was done by using a partner access token. * @example d5a577b0-01c0-4566-ac5c-44f41935e8c4 */ entity_user_id?: string; /** @description An object containing additional information about the event or change. The object structure varies based on the `event_type`. */ event_data: components["schemas"]["PayableStatusChangedEventData"] | components["schemas"]["PayableUpdatedEventData"] | components["schemas"]["PayableCreatedEventData"] | components["schemas"]["PayableCreditNoteLinkedEventData"] | components["schemas"]["PayableCreditNoteUnlinkedEventData"] | components["schemas"]["FileAttachedEventData"]; /** @description The type of the event or change. */ event_type: components["schemas"]["PayableHistoryEventTypeEnum"]; /** * Format: uuid * @description ID of the payable document that was changed or triggered an event. * @example f669a8a4-0563-4ab9-b54f-e9d700d282c5 */ payable_id: string; /** * Format: date-time * @description UTC date and time when the event or change occurred. */ timestamp: string; }; /** @description A schema contains metadata for an individual */ PayableIndividualSchema: { /** Format: date */ date_of_birth?: string; /** @description A first name of an individual */ first_name: string; id_number?: string; /** @description A last name of an individual */ last_name: string; /** @description The last four digits of the individual's Social Security number */ ssn_last_4?: string; /** @description A title of an individual */ title?: string; }; PayableInfoBlock: { based_invoice_number?: string; /** @default Related invoice */ based_invoice_number_header: string; due_date?: string; /** @default Due date */ due_date_header: string; issue_date?: string; /** @default Issue date */ issue_date_header: string; }; /** @enum {string} */ PayableMetricEnum: "id" | "total_amount" | "amount_due"; /** @description A schema contains metadata for an organization */ PayableOrganizationSchema: { /** @description Business structure of the company */ business_structure?: components["schemas"]["EntityBusinessStructure"]; directors_provided?: boolean; executives_provided?: boolean; /** @description A code which identifies uniquely a party of a transaction worldwide */ legal_entity_id?: string; /** @description A legal name of an organization */ legal_name: string; owners_provided?: boolean; representative_provided?: boolean; }; /** @enum {string} */ PayableOriginEnum: "upload" | "email" | "einvoicing"; /** @description A paginated list of payables. */ PayablePaginationResponse: { data: components["schemas"]["PayableResponseSchema"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; PayablePaymentTermDiscount: { /** @description The discount percentage in minor units. E.g., 200 means 2%, 1050 means 10.5%. */ discount: number; /** @description The amount of days after the invoice issue date. */ number_of_days: number; }; PayablePaymentTermFinal: { /** @description The amount of days after the invoice issue date. */ number_of_days: number; }; PayablePaymentTermsCreatePayload: { description?: string; name: string; term_1?: components["schemas"]["PayablePaymentTermDiscount"]; term_2?: components["schemas"]["PayablePaymentTermDiscount"]; term_final: components["schemas"]["PayablePaymentTermFinal"]; }; PayableRenderPayload: { /** * @default { * "account_holder_name_header": "Account holder", * "account_number_header": "Account number", * "bank_name_header": "Bank", * "bic_header": "BIC", * "iban_header": "IBAN", * "routing_number_header": "Routing number", * "sort_code_header": "Sort code" * } */ account_data: components["schemas"]["AccountDataBlock"]; /** @default {} */ counterpart_info: components["schemas"]["PayableCounterpartInfoBlock"]; /** @default {} */ entity_info: components["schemas"]["PayableEntityInfoBlock"]; /** @default {} */ header: components["schemas"]["HeaderBlock"]; /** * @default { * "amounts_reduced": [], * "deductions": [], * "discount_header": "Discount", * "discounted_subtotal_header": "Discounted subtotal", * "line_items": [], * "subtotal_header": "Subtotal", * "table_headers": [], * "tax_inclusive_discount": false, * "tax_mode_inclusive": false, * "total_header": "Total", * "total_vat_header": "Total VAT", * "total_vats": [], * "withholding_tax_header": "Withholding tax" * } */ line_items: components["schemas"]["LineItemsBlock"]; /** @default {} */ memo: components["schemas"]["MemoBlock"]; /** * @default { * "for_preposition": "for", * "of_preposition": "of", * "page_text": "Page" * } */ page_counter: components["schemas"]["PageCounterBlock"]; /** * @default { * "based_invoice_number_header": "Related invoice", * "due_date_header": "Due date", * "issue_date_header": "Issue date" * } */ payable_info: components["schemas"]["PayableInfoBlock"]; /** * @description Type of the template (enum property replaced by openapi-typescript) * @enum {string} */ template_type: "payable"; }; /** @description Represents an Accounts Payable document received from a vendor or supplier. */ PayableResponseSchema: { /** * Format: uuid * @description A unique ID assigned to this payable. */ id: string; /** * Format: date-time * @description UTC date and time when this payable was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */ created_at: string; /** * Format: date-time * @description UTC date and time when this payable was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. */ updated_at: string; /** * @description How much is left to be paid on the invoice (in minor units). * @example 1000 */ amount_due?: number; /** * @description How much was paid on the invoice (in minor units). * @example 1000 */ amount_paid?: number; /** * @description How much is left to be paid on the invoice (in minor units) with discounts from payment terms. * @example 1000 */ amount_to_pay?: number; /** * Format: uuid * @description Id of existing approval policy that applies to this payable, if any. A policy is applied if the payable matches the policy trigger conditions. */ approval_policy_id?: string; /** @description Object representing de-normalized counterpart data. Filled at the moment of invoice submitting for approval or payment. */ counterpart?: components["schemas"]["CounterpartRawData"]; /** * Format: uuid * @description The ID of counterpart address object stored in counterparts service */ counterpart_address_id?: string; /** * Format: uuid * @description The ID of counterpart bank account object stored in counterparts service */ counterpart_bank_account_id?: string; /** * Format: uuid * @description The ID of the counterpart object that represents the vendor or supplier. */ counterpart_id?: string; /** @description Object representing counterpart data which was extracted by OCR. Used for informational purposes. */ counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; /** * Format: uuid * @description The ID of counterpart VAT ID object stored in counterparts service */ counterpart_vat_id_id?: string; /** @description The list of linked credit notes of the payable. */ credit_notes: components["schemas"]["PayableCreditNoteData"][]; /** * @description The [currency code](https://docs.monite.com/references/currencies) of the currency used in the payable. * @example USD */ currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; /** @description An arbitrary description of this payable. */ description?: string; /** * @description The value of the additional discount that will be applied to the total amount. in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 500 */ discount?: number; /** * @description A unique invoice number assigned by the invoice issuer for payment tracking purposes. This is different from `id` which is an internal ID created automatically by Monite. * @example INV-2287 */ document_id?: string; /** * Format: date * @description The date by which the payable must be paid, in the YYYY-MM-DD format. If the payable specifies payment terms with early payment discounts, this is the final payment date. */ due_date?: string; /** * @description The URL to download the original e-invoice file. * @example https://bucketname.s3.amazonaws.com/12345/67890.xml */ einvoice_file_url?: string; /** * Format: uuid * @description Id of an existing approval policy that should be enforced when submitting the payable for approval.If this field is set, no other policies will be evaluated via their triggers - the specified policy will always be applied instead. */ enforce_approval_policy_id?: string; /** * Format: uuid * @description The ID of the entity to which the payable was issued. */ entity_id: string; /** @description The original file from which this payable was created. */ file?: components["schemas"]["FileSchema"]; /** * Format: uuid * @description File id to retrieve file info from file saver. */ file_id?: string; /** * Format: date * @description The date when the payable was issued, in the YYYY-MM-DD format. */ issued_at?: string; /** * Format: uuid * @description The ID of the entity user who marked this document as paid. * @example 71e8875a-43b3-434f-b12a-54c84c176ef3 */ marked_as_paid_by_entity_user_id?: string; /** * @description An arbitrary comment that describes how and when this payable was paid. * @example Was paid partly in the end of the month. */ marked_as_paid_with_comment?: string; /** * Format: uuid * @description Id of OCR request to match asynchronous result of processing payable. */ ocr_request_id?: string; /** @description The status of the data recognition process using OCR. The 'processing' status means that the data recognition is in progress and the user needs to wait for the data enrichment. The 'error' status indicates that some error occurred on the OCR side and the user can fill in the data manually. The 'success' status means the data recognition has been successfully completed, after which the user can check the data if desired and enrich or correct it. */ ocr_status?: components["schemas"]["OcrStatusEnum"]; /** @description Data extracted from the uploaded payable by OCR. */ other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; /** * Format: date-time * @description The date by which the payable was paid */ paid_at?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; /** @description Specifies how this payable was created in Monite: `upload` - created via an API call, `email` - sent via email to the entity's mailbox. */ payable_origin: components["schemas"]["PayableOriginEnum"]; /** @description The number of days to pay with potential discount for options shorter than due_date */ payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; /** * Format: uuid * @description Project id of a payable. */ project_id?: string; /** * Format: uuid * @description The identifier of the purchase order to which this payable belongs. */ purchase_order_id?: string; /** * Format: email * @description The email address from which the invoice was sent to the entity. * @example hello@example.com */ sender?: string; /** @description Specifies how the property values of this payable were provided: `ocr` - Monite OCR service extracted the values from the provided PDF or image file, `user_specified` - values were added or updated via an API call. */ source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; /** @description The [status](https://docs.monite.com/accounts-payable/payables/index) of the payable. */ status: components["schemas"]["PayableStateEnum"]; /** * @description The subtotal amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 1250 */ subtotal?: number; /** @description The suggested date and corresponding discount in which payable could be paid. The date is in the YYYY-MM-DD format. The discount is calculated as X * (10^-4) - for example, 100 is 1%, 25 is 0,25%, 10000 is 100 %. Date varies depending on the payment terms and may even be equal to the due date with discount 0. */ suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; /** @description A list of user-defined tags (labels) assigned to this payable. Tags can be used to trigger a specific approval policy for this payable. */ tags?: components["schemas"]["TagReadSchema"][]; /** * @description Registered tax percentage applied for a service price in minor units, e.g. 200 means 2%, 1050 means 10.5%. * @example 2000 */ tax?: number; /** * @description Tax amount in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 250 */ tax_amount?: number; /** * @description The total amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 1500 */ total_amount?: number; /** @description The total price of the payable in [minor units](https://docs.monite.com/references/currencies#minor-units), excluding all issued credit notes. */ total_amount_with_credit_notes?: number; /** Format: uuid */ was_created_by_user_id?: string; }; "PayableSchema-Input": { /** @description List of actions */ actions?: components["schemas"]["PayableActionSchema"][]; /** * @description Object type (enum property replaced by openapi-typescript) * @enum {string} */ object_type: "payable"; }; "PayableSchema-Output": { /** @description List of actions */ actions?: components["schemas"]["PayableActionSchema"][]; /** * @description Object type (enum property replaced by openapi-typescript) * @enum {string} */ object_type: "payable"; }; PayableSettings: { /** @default false */ allow_cancel_duplicates_automatically: boolean | null; /** @default false */ allow_counterpart_autocreation: boolean | null; /** @default false */ allow_counterpart_autolinking: boolean | null; /** @default false */ allow_credit_note_autolinking: boolean | null; /** * Format: uri * @example https://monite.com */ approve_page_url: string; /** * @description A state each new payable will have upon creation * @example new */ default_state?: string | null; /** * @description Partners can set this to True or False to control line item detection in OCR flows. * @default true */ enable_line_items: boolean; /** @default false */ skip_approval_for_paid_invoice: boolean | null; }; /** @enum {string} */ PayableStateEnum: "draft" | "new" | "approve_in_progress" | "waiting_to_be_paid" | "partially_paid" | "paid" | "canceled" | "rejected"; PayableStatusChangedEventData: { new_status: components["schemas"]["PayableStateEnum"]; old_status: components["schemas"]["PayableStateEnum"]; }; PayableTemplatesVariable: { description: string; name: string; }; PayableTemplatesVariablesObject: { object_subtype: components["schemas"]["PayablesVariableType"]; object_type: components["schemas"]["ObjectType"]; variables: components["schemas"]["PayableTemplatesVariable"][]; }; PayableTemplatesVariablesObjectList: { data: components["schemas"]["PayableTemplatesVariablesObject"][]; }; /** @description This schema is used to update the data of an existing payable. */ PayableUpdateSchema: { /** @description How much was paid on the invoice (in minor units). */ amount_paid?: number; /** * Format: uuid * @description The ID of counterpart address object stored in counterparts service */ counterpart_address_id?: string; /** * Format: uuid * @description The ID of counterpart bank account object stored in counterparts service */ counterpart_bank_account_id?: string; /** * Format: uuid * @description The ID of the counterpart object that represents the vendor or supplier. */ counterpart_id?: string; /** @description Allows to fix some data in counterpart recognised fields to correct them in order to make autolinking happen. */ counterpart_raw_data?: components["schemas"]["CounterpartRawDataUpdateRequest"]; /** * Format: uuid * @description The ID of counterpart VAT ID object stored in counterparts service */ counterpart_vat_id_id?: string; /** * @description The [currency code](https://docs.monite.com/references/currencies) of the currency used in the payable. * @example USD */ currency?: components["schemas"]["CurrencyEnum"]; /** @description An arbitrary description of this payable. */ description?: string; /** * @description The value of the additional discount that will be applied to the total amount. in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 500 */ discount?: number; /** * @description A unique invoice number assigned by the invoice issuer for payment tracking purposes. * @example INV-2287 */ document_id?: string; /** * Format: date * @description The date by which the payable must be paid, in the YYYY-MM-DD format. If the payable specifies payment terms with early payment discounts, this is the final payment date. */ due_date?: string; /** * Format: uuid * @description Id of an existing approval policy that should be enforced when submitting the payable for approval.If this field is set, no other policies will be evaluated via their triggers - the specified policy will always be applied instead. */ enforce_approval_policy_id?: string; /** * Format: date * @description The date when the payable was issued, in the YYYY-MM-DD format. */ issued_at?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; /** @description The number of days to pay with potential discount for options shorter than due_date */ payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; /** * Format: uuid * @description The project ID of the payable. */ project_id?: string; /** * Format: uuid * @description The identifier of the purchase order to which this payable belongs. */ purchase_order_id?: string; /** * Format: email * @description The email address from which the invoice was sent to the entity. * @example hello@example.com */ sender?: string; /** * @description The subtotal amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 1250 */ subtotal?: number; /** @description The suggested date and corresponding discount in which payable could be paid. The date is in the YYYY-MM-DD format. The discount is calculated as X * (10^-4) - for example, 100 is 1%, 25 is 0,25%, 10000 is 100 %. Date varies depending on the payment terms and may even be equal to the due date with discount 0. */ suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; /** @description A list of IDs of user-defined tags (labels) assigned to this payable. Tags can be used to trigger a specific approval policy for this payable. */ tag_ids?: string[]; /** * @description Registered tax percentage applied for a service price in minor units, e.g. 200 means 2%, 1050 means 10.5%. * @example 2000 */ tax?: number; /** * @description Tax amount in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 250 */ tax_amount?: number; /** * @description The total amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 15000 */ total_amount?: number; }; PayableUpdatedEventData: Record; PayableUploadFile: { /** Format: binary */ file: Blob; }; /** @description This schema is used to create a new payable by providing its data along with the original file. */ PayableUploadWithDataSchema: { /** * @description Base64-encoded contents of the original issued payable. The file is provided for reference purposes as the original source of the data. * * Any file formats are allowed. The most common formats are PDF, PNG, JPEG, TIFF. */ base64_encoded_file?: string; /** * Format: uuid * @description The ID of counterpart address object stored in counterparts service */ counterpart_address_id?: string; /** * Format: uuid * @description The ID of counterpart bank account object stored in counterparts service */ counterpart_bank_account_id?: string; /** * Format: uuid * @description The ID of the counterpart object that represents the vendor or supplier. */ counterpart_id?: string; /** * Format: uuid * @description The ID of counterpart VAT ID object stored in counterparts service */ counterpart_vat_id_id?: string; /** * @description The [currency code](https://docs.monite.com/references/currencies) of the currency used in the payable. * @example USD */ currency?: components["schemas"]["CurrencyEnum"]; /** @description An arbitrary description of this payable. */ description?: string; /** * @description The value of the additional discount that will be applied to the total amount. in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 500 */ discount?: number; /** * @description A unique invoice number assigned by the invoice issuer for payment tracking purposes. * @example INV-2287 */ document_id?: string; /** * Format: date * @description The date by which the payable must be paid, in the YYYY-MM-DD format. If the payable specifies payment terms with early payment discounts, this is the final payment date. */ due_date?: string; /** * Format: uuid * @description Id of an existing approval policy that should be enforced when submitting the payable for approval.If this field is set, no other policies will be evaluated via their triggers - the specified policy will always be applied instead. */ enforce_approval_policy_id?: string; /** * @description The original file name. * @example invoice.pdf */ file_name?: string; /** * Format: date * @description The date when the payable was issued, in the YYYY-MM-DD format. */ issued_at?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; /** @description The number of days to pay with potential discount for options shorter than due_date */ payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; /** * Format: uuid * @description The ID of a project */ project_id?: string; /** * Format: uuid * @description The identifier of the purchase order to which this payable belongs. */ purchase_order_id?: string; /** * Format: email * @description The email address from which the invoice was sent to the entity. * @example hello@example.com */ sender?: string; /** * @description The subtotal amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 1250 */ subtotal?: number; /** @description The suggested date and corresponding discount in which payable could be paid. The date is in the YYYY-MM-DD format. The discount is calculated as X * (10^-4) - for example, 100 is 1%, 25 is 0,25%, 10000 is 100 %. Date varies depending on the payment terms and may even be equal to the due date with discount 0. */ suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; /** @description A list of IDs of user-defined tags (labels) assigned to this payable. Tags can be used to trigger a specific approval policy for this payable. */ tag_ids?: string[]; /** * @description Registered tax percentage applied for a service price in minor units, e.g. 200 means 2%. 1050 means 10.5%. * @example 2000 */ tax?: number; /** * @description Tax amount in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 250 */ tax_amount?: number; /** * @description The total amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250. * @example 15000 */ total_amount?: number; }; PayableValidationResponse: { /** * Format: uuid * @description A unique ID assigned to this payable. */ id: string; validation_errors?: Record[]; }; PayableValidationsResource: { required_fields: components["schemas"]["PayablesFieldsAllowedForValidate"][]; }; PayableValidationsUpdateRequest: { required_fields: components["schemas"]["PayablesFieldsAllowedForValidate"][]; }; /** @enum {string} */ PayablesFieldsAllowedForValidate: "currency" | "document_id" | "due_date" | "issued_at" | "tax_amount" | "total_amount" | "subtotal" | "description" | "suggested_payment_term" | "payment_terms" | "tax" | "sender" | "file_id" | "counterpart_id" | "counterpart_bank_account_id" | "counterpart_address_id" | "counterpart_vat_id_id" | "line_items" | "line_items.quantity" | "line_items.unit_price" | "line_items.tax" | "line_items.ledger_account_id" | "line_items.accounting_tax_rate_id" | "line_items.unit" | "line_items.name" | "line_items.description" | "line_items.subtotal" | "line_items.total" | "line_items.tax_amount"; /** @enum {string} */ PayablesVariableType: "payables_purchase_order" | "payables_notify_approver"; PayerAccountResponse: { /** * Format: uuid * @description ID of a payment account */ id: string; /** @description List of bank accounts */ bank_accounts?: components["schemas"]["BankAccount"][]; /** @description Display name of a payment account */ name?: string; /** @description Type of a payment account. Can be `entity` or `counterpart` */ type: components["schemas"]["PaymentAccountType"]; }; PayerAccountResponse2: { /** * Format: uuid * @description ID of a payment account */ id: string; /** @description List of authorized bank accounts */ authorized_bank_accounts?: components["schemas"]["AuthorizedBankAccount"][]; /** @description List of bank accounts */ bank_accounts?: components["schemas"]["BankAccount"][]; /** @description Display name of a payment account */ name?: string; /** @description Type of a payment account. Can be `entity` or `counterpart` */ type: components["schemas"]["PaymentAccountType"]; }; PaymentAccountObject: { /** * Format: uuid * @description ID of a payment account */ id: string; /** @description Type of a payment account. Can be `entity` or `counterpart` */ type: components["schemas"]["PaymentAccountType"]; }; /** @enum {string} */ PaymentAccountType: "entity" | "counterpart"; PaymentFeeResponse: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; /** @example USD */ currency: components["schemas"]["CurrencyEnum"]; /** @example 400 */ fee_max_amount?: number; /** @example 20 */ fee_min_amount?: number; monite_fee: components["schemas"]["Fee"]; paid_by: components["schemas"]["PaidBy"]; partner_fee: components["schemas"]["Fee"]; payment_method: string; payment_method_subtype?: components["schemas"]["PaymentMethodSubtype"]; /** @example US */ region: components["schemas"]["FeeRegion"]; /** Format: uuid */ tier_id?: string; }; PaymentFeesListResponse: { /** @description Array of payment fees */ data: components["schemas"]["PaymentFeeResponse"][]; }; PaymentIntent: { /** Format: uuid */ id: string; /** Format: date-time */ updated_at: string; application_fee_amount?: number; object?: components["schemas"]["PaymentObject"]; provider?: string; selected_payment_method?: string; status: string; tesouro_data?: components["schemas"]["TesouroPaymentIntentData"]; }; /** @enum {string} */ PaymentIntentAccountType: "IBAN"; /** @enum {string} */ PaymentIntentCursorFields: "id" | "created_at"; PaymentIntentHistory: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; /** Format: uuid */ payment_intent_id: string; status: string; }; PaymentIntentHistoryResponse: { /** @description Payment intent history */ data: components["schemas"]["PaymentIntentHistory"][]; }; /** @enum {string} */ PaymentIntentPayoutMethod: "bank_account" | "paper_check" | "us_ach" | "wire"; PaymentIntentResponse: { /** Format: uuid */ id: string; /** Format: date-time */ updated_at: string; amount: number; application_fee_amount?: number; /** Format: uuid */ batch_payment_id?: string; currency: string; invoice?: components["schemas"]["Invoice"]; object?: components["schemas"]["PaymentObject"]; payer?: components["schemas"]["PayerAccountResponse"]; /** Format: uuid */ payment_link_id?: string; payment_methods: components["schemas"]["MoniteAllPaymentMethodsTypes"][]; payment_reference?: string; provider?: string; recipient: components["schemas"]["RecipientAccountResponse"]; selected_payment_method?: components["schemas"]["MoniteAllPaymentMethodsTypes"]; status: string; }; PaymentIntentWithSecrets: { /** Format: uuid */ id: string; /** Format: date-time */ updated_at: string; airwallex_data?: components["schemas"]["AirwallexData"]; amount: number; application_fee_amount?: number; /** Format: uuid */ batch_payment_id?: string; /** @default true */ confirm_on_backend: boolean; currency: string; invoice?: components["schemas"]["Invoice"]; key?: components["schemas"]["StripeData"]; object?: components["schemas"]["PaymentObject"]; payer?: components["schemas"]["PayerAccountResponse2"]; /** Format: uuid */ payment_link_id?: string; payment_methods: components["schemas"]["MoniteAllPaymentMethodsTypes"][]; payment_reference?: string; provider?: string; recipient: components["schemas"]["RecipientAccountResponse2"]; selected_payment_method?: components["schemas"]["MoniteAllPaymentMethodsTypes"]; status: string; stripe_data?: components["schemas"]["StripeData"]; tesouro_data?: components["schemas"]["TesouroData"]; }; PaymentIntentsListResponse: { data: components["schemas"]["PaymentIntentResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; PaymentIntentsRecipient: { /** Format: uuid */ id: string; /** Format: uuid */ bank_account_id?: string; /** @default bank_account */ payout_method: components["schemas"]["PaymentIntentPayoutMethod"]; /** @enum {string} */ type: "counterpart"; }; PaymentMethod: { direction: components["schemas"]["PaymentMethodDirection"]; name: components["schemas"]["MoniteAllPaymentMethods"]; status: components["schemas"]["PaymentMethodStatus"]; type: components["schemas"]["MoniteAllPaymentMethodsTypes"]; }; /** @enum {string} */ PaymentMethodDirection: "receive" | "send"; /** @enum {string} */ PaymentMethodStatus: "active" | "inactive"; /** @enum {string} */ PaymentMethodSubtype: "standard" | "premium" | "paper_check" | "bank_account"; PaymentMethodsConfirmPaymentPayload: { payment_method_id: string; }; PaymentMethodsConfirmResponse: { client_secret: string; is_next_action_needed: boolean; }; PaymentObject: { /** Format: uuid */ id: string; type: components["schemas"]["PaymentObjectType"]; }; PaymentObjectPayable: { /** Format: uuid */ id: string; /** @enum {string} */ type: "payable"; }; /** @enum {string} */ PaymentObjectType: "payable" | "receivable"; PaymentPageFooter: { /** @description Url to partner logo image file. If missing, then monite logo will be used. */ logo_url: string | null; /** * @description Url to partner website. * @example https://monite.com */ website_url?: string | null; }; PaymentPageTheme: { background_color?: string | null; border_radius?: string | null; button?: components["schemas"]["ButtonTheme"] | null; card?: components["schemas"]["CardTheme"] | null; font_color?: string | null; font_family?: string | null; font_link_href?: string | null; logo_src?: string | null; }; PaymentPageThemeWithFooter: { background_color?: string | null; border_radius?: string | null; button?: components["schemas"]["ButtonTheme"] | null; card?: components["schemas"]["CardTheme"] | null; font_color?: string | null; font_family?: string | null; font_link_href?: string | null; footer?: components["schemas"]["PaymentPageFooter"] | null; logo_src?: string | null; }; /** @enum {string} */ PaymentPriorityEnum: "working_capital" | "balanced" | "bottom_line"; /** @description Contains information about a payment received for an invoice. */ PaymentReceivedEventData: { /** * @description The remaining amount due of the invoice, in [minor units](https://docs.monite.com/references/currencies#minor-units) of the currency. For example, $12.5 is represented as 1250. * @example 0 */ amount_due: number; /** * @description The payment amount, in minor units of the currency. * @example 1250 */ amount_paid: number; /** @description A user-defined comment about this payment, or `null` if no comment was provided. Comments are available only for payments recorded via `POST /receivables/{receivable_id}/mark_as_paid` and `POST /receivables/{receivable_id}/mark_as_partially_paid`. */ comment?: string; }; /** @enum {string} */ PaymentRecordCursorFields: "paid_at" | "amount" | "overpaid_amount"; PaymentRecordHistoryResponse: { /** Format: uuid */ entity_user_id?: string; status: components["schemas"]["PaymentRecordStatusEnum"]; /** * Format: date-time * @description Timestamp of the change in a history */ timestamp: string; }; PaymentRecordMarkAsSucceededRequest: { /** * Format: date-time * @description Timestamp marking when the payment was executed. */ paid_at: string; /** @description Raw status string of the external payment intent. */ payment_intent_status?: string; }; PaymentRecordObjectRequest: { /** * Format: uuid * @description ID of the invoice */ id: string; type: components["schemas"]["ObjectTypeEnum"]; }; PaymentRecordObjectResponse: { /** * Format: uuid * @description ID of the invoice */ id: string; /** @description Status, in which object has been moved */ new_status: string; /** @description Status, in which object was before payment */ old_status: string; type: components["schemas"]["ObjectTypeEnum"]; }; PaymentRecordRequest: { /** @description Positive amount in case of successful payment, negative amount in case of payment failure or refund, represented in minor currency units (e.g., cents). */ amount: number; /** @description Currency code (ISO 4217) indicating the currency in which the payment was made. */ currency: components["schemas"]["CurrencyEnum"]; /** * Format: uuid * @description ID of the user associated with the payment, if applicable. */ entity_user_id?: string; /** @description Reference object linked to this payment record, indicating the type (receivable or payable) and its identifier. */ object: components["schemas"]["PaymentRecordObjectRequest"]; /** * Format: date-time * @description Timestamp marking when the payment was executed. Null if payment hasn't occurred yet. */ paid_at?: string; /** * Format: uuid * @description Identifier for an payment intent. */ payment_intent_id?: string; /** @description Raw status string of the external payment intent. */ payment_intent_status?: string; /** @description Payment method used or planned for the transaction. */ payment_method?: string; /** * Format: date * @description Scheduled date for future payments, required when the payment is planned but not yet executed. */ planned_payment_date?: string; /** * @description Status of the payment record indicating its current stage (e.g., created, processing, succeeded). * @default succeeded * @enum {string} */ status: "created" | "processing" | "succeeded"; }; PaymentRecordResponse: { /** Format: uuid */ id: string; /** @description Positive amount in case of successful payment, negative amount in case of payment failure or refund, represented in minor currency units (e.g., cents). */ amount: number; /** @description Currency code (ISO 4217) indicating the currency in which the payment was made. */ currency: components["schemas"]["CurrencyEnum"]; /** * Format: uuid * @description ID of the user associated with the payment, if applicable. */ entity_user_id?: string; /** @description History of the payment record. */ history: components["schemas"]["PaymentRecordHistoryResponse"][]; is_external: boolean; object: components["schemas"]["PaymentRecordObjectResponse"]; /** * @description Filled in a case, if payment amount is more, than total_amount * @default 0 */ overpaid_amount: number; /** * Format: date-time * @description Timestamp marking when the payment was executed. Null if payment hasn't occurred yet. */ paid_at?: string; /** * Format: uuid * @description Identifier for an payment intent. */ payment_intent_id?: string; /** @description Raw status string of the external payment intent. */ payment_intent_status?: string; /** @description Payment method used or planned for the transaction. */ payment_method?: string; /** * Format: date * @description Scheduled date for future payments, required when the payment is planned but not yet executed. */ planned_payment_date?: string; /** * @description The current status of the payment record. Possible values: `created`, `processing`, `succeeded`, `canceled`. * @default succeeded */ status: string; }; PaymentRecordResponseList: { data: components["schemas"]["PaymentRecordResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; /** @enum {string} */ PaymentRecordStatusEnum: "created" | "processing" | "succeeded" | "canceled"; PaymentRecordStatusUpdateRequest: { /** @description Raw status string of the external payment intent. */ payment_intent_status?: string; }; PaymentRecordUpdateRequest: { /** @description Positive amount in case of successful payment, negative amount in case of payment failure or refund, represented in minor currency units (e.g., cents). */ amount?: number; /** @description Currency code (ISO 4217) indicating the currency in which the payment was made. */ currency?: components["schemas"]["CurrencyEnum"]; /** * Format: uuid * @description ID of the user associated with the payment, if applicable. */ entity_user_id?: string; /** @description Reference object linked to this payment record, indicating the type (receivable or payable) and its identifier. */ object?: components["schemas"]["PaymentRecordObjectRequest"]; /** * Format: date-time * @description Timestamp marking when the payment was executed. Null if payment hasn't occurred yet. */ paid_at?: string; /** * Format: uuid * @description Identifier for an payment intent. */ payment_intent_id?: string; /** @description Raw status string of the external payment intent. */ payment_intent_status?: string; /** @description Payment method used or planned for the transaction. */ payment_method?: string; /** * Format: date * @description Scheduled date for future payments, required when the payment is planned but not yet executed. */ planned_payment_date?: string; }; PaymentReminder: { name: string; recipients?: components["schemas"]["Recipients"]; /** @description Reminder to send for first payment term */ term_1_reminder?: components["schemas"]["Reminder"]; /** @description Reminder to send for second payment term */ term_2_reminder?: components["schemas"]["Reminder"]; /** @description Reminder to send for final payment term */ term_final_reminder?: components["schemas"]["Reminder"]; }; PaymentReminderResponse: { /** Format: uuid */ id: string; /** * Format: date-time * @description Time at which the PaymentReminder was created. Timestamps follow the ISO 8601 standard. */ created_at: string; /** * Format: date-time * @description Time at which the PaymentReminder was last updated. Timestamps follow the ISO 8601 standard. */ updated_at: string; /** Format: uuid */ entity_id: string; name: string; recipients?: components["schemas"]["Recipients"]; status: components["schemas"]["StatusEnum"]; /** @description Reminder to send for first payment term */ term_1_reminder?: components["schemas"]["Reminder"]; /** @description Reminder to send for second payment term */ term_2_reminder?: components["schemas"]["Reminder"]; /** @description Reminder to send for final payment term */ term_final_reminder?: components["schemas"]["Reminder"]; }; PaymentReminderUpdateRequest: { name?: string; recipients?: components["schemas"]["Recipients"]; /** @description Reminder to send for first payment term */ term_1_reminder?: components["schemas"]["Reminder"]; /** @description Reminder to send for second payment term */ term_2_reminder?: components["schemas"]["Reminder"]; /** @description Reminder to send for final payment term */ term_final_reminder?: components["schemas"]["Reminder"]; }; PaymentRequirements: { /** Format: date-time */ current_deadline?: string; currently_due: string[]; eventually_due: string[]; pending_verification: string[]; }; PaymentTerms: { /** Format: uuid */ id?: string; /** @description Description of the payment term. */ description?: string; name?: string; /** @description The first tier of the payment term. Represents the terms of the first early discount. */ term_1?: components["schemas"]["InlineTermDiscount"]; /** @description The second tier of the payment term. Defines the terms of the second early discount. */ term_2?: components["schemas"]["InlineTermDiscount"]; /** @description The final tier of the payment term. Defines the invoice due date. */ term_final: components["schemas"]["InlineTermFinal"]; }; PaymentTermsBlock: { description?: string; /** @default Payment terms */ header: string; term_1?: string; term_2?: string; term_final?: string; }; PaymentTermsCreatePayload: { description?: string; name: string; /** @description The first tier of the payment term. Represents the terms of the first early discount. */ term_1?: components["schemas"]["TermDiscountDays"]; /** @description The second tier of the payment term. Defines the terms of the second early discount. */ term_2?: components["schemas"]["TermDiscountDays"]; /** @description The final tier of the payment term. Defines the invoice due date. */ term_final: components["schemas"]["TermFinalDays"]; }; PaymentTermsListResponse: { data?: components["schemas"]["PaymentTermsResponse"][]; }; PaymentTermsResponse: { /** Format: uuid */ id: string; description?: string; name: string; /** @description The first tier of the payment term. Represents the terms of the first early discount. */ term_1?: components["schemas"]["TermDiscountDays"]; /** @description The second tier of the payment term. Defines the terms of the second early discount. */ term_2?: components["schemas"]["TermDiscountDays"]; /** @description The final tier of the payment term. Defines the invoice due date. */ term_final: components["schemas"]["TermFinalDays"]; }; PaymentTermsUpdatePayload: { description?: string; name?: string; /** @description The first tier of the payment term. Represents the terms of the first early discount. */ term_1?: components["schemas"]["TermDiscountDays"]; /** @description The second tier of the payment term. Defines the terms of the second early discount. */ term_2?: components["schemas"]["TermDiscountDays"]; /** @description The final tier of the payment term. Defines the invoice due date. */ term_final?: components["schemas"]["TermFinalDays"]; }; PaymentTierResponse: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; higher_range: number; lower_range: number; measure_unit: components["schemas"]["MeasureUnitEnum"]; period: components["schemas"]["PeriodEnum"]; }; PaymentTiersListResponse: { /** @description Array of payment tiers */ data: components["schemas"]["PaymentTierResponse"][]; }; PaymentsBatchPaymentRequest: { /** Format: uuid */ payer_bank_account_id: string; payment_intents: components["schemas"]["SinglePaymentIntent"][]; /** @enum {string} */ payment_method: "us_ach"; }; PaymentsBatchPaymentResponse: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; error?: Record; /** Format: uuid */ payer_bank_account_id: string; payment_intents: components["schemas"]["SinglePaymentIntentResponse"][]; /** @enum {string} */ payment_method: "us_ach"; status: components["schemas"]["PaymentsBatchPaymentStatus"]; total_amount?: number; }; /** @enum {string} */ PaymentsBatchPaymentStatus: "created" | "processing" | "partially_successful" | "succeeded" | "failed" | "expired"; "PaymentsSettings-Input": { payment_page_domain?: string | null; payment_page_theme?: components["schemas"]["PaymentPageTheme"] | null; /** @description The support email address */ support_email?: string | null; }; "PaymentsSettings-Output": { payment_page_domain?: string | null; payment_page_theme?: components["schemas"]["PaymentPageTheme"] | null; /** @description The support email address */ support_email?: string | null; }; PdfCreatedPayload: { /** * Format: uuid * @description Optional field, needed to associate this specific PDF with the corresponding change */ change_id?: string; fields?: components["schemas"]["FileUrlType"][]; /** * Format: uuid * @description ID of the generated PDF file */ file_id: string; /** @description URL to the generated PDF file */ file_url: string; /** @description ID of the object, for which the PDF was generated */ object_id: string; /** @description Object type related to object_id, e.g. payable, payables_credit_note, etc */ object_type?: components["schemas"]["ObjectType"]; /** @description Type of the template */ template_type: string; }; /** @enum {string} */ PdfDocumentTypeEnum: "receivable" | "delivery_note" | "purchase_order" | "payable"; /** @enum {string} */ PeriodEnum: "month" | "day" | "year" | "quarter"; /** @enum {string} */ PermissionEnum: "allowed" | "allowed_for_own" | "not_allowed"; /** @enum {string} */ PermissionKey: "acceptor:application:read" | "acceptor:application:secondaryapproval" | "acceptor:application:write" | "accounting_config:read:org" | "accounting_config:write:org" | "acquiring:report:read" | "approval_policy:read:org" | "approval_policy:write:org" | "approval_request:create:org" | "approval_request:delete:org" | "approval_request:read:org" | "approval_request:update:org" | "authorization_control:read:org" | "bank_account:read:org" | "bank_account:write:org" | "bank_account_application:read:org" | "bank_account_application:write:org" | "beneficial_owner:read:org" | "comment:read:org" | "comment:write:org" | "counterpart:read:org" | "counterpart:write:org" | "credit_card:activate:org" | "credit_card:read:org" | "credit_card_application:read:org" | "credit_card_application:write:org" | "developer_portal" | "dispute:read" | "dispute:write" | "expense:approve:org" | "expense:read:org" | "expense:read:self" | "expense:write:org" | "expense:write:self" | "export:read:org" | "export:write:org" | "external_bank_account:micro_deposit:org" | "external_bank_account:read:org" | "external_bank_account:set_verification:org" | "external_bank_account:write:org" | "invoice:read:org" | "invoice:write:org" | "mailbox:read:org" | "mailbox:write:org" | "notification:subscription:read" | "notification:subscription:write" | "ocr_task:read:org" | "ocr_task:write:org" | "oidc:app:manage" | "oidc:app:read" | "oidc:app:write" | "org:write:all" | "organization:read:org" | "organization:write:org" | "organization_settings:read:org" | "organization_settings:write:org" | "partner_portal" | "payable:approve:org" | "payable:pay:org" | "payable:read:org" | "payable:write:org" | "payment_link:write" | "payment_rail:ach" | "payment_rail:fednow" | "payment_rail:rtp" | "payment_record:read:org" | "payment_record:write:org" | "product:read:org" | "product:write:org" | "role:read:org" | "role:write:org" | "transfer:write:org" | "underwriting:application:approval:escalation" | "underwriting:application:approval:secondary" | "underwriting:application:read" | "underwriting:application:write" | "user:read:org" | "user:write:all" | "user:write:org" | "user_profile:write:all" | "user_profile:write:self"; /** * @description Explicit grant/revoke deltas for a user's permissions. Permissions not listed in * either array are left untouched, so a caller can update permissions within their * own scope without having to round-trip every permission the target already holds. * Mutually exclusive with `permissionIds` and `permissionKeys`. */ PermissionUpdateInput: { /** * @description Permission keys (e.g. `"user:write:org"`) to grant the user. Resolved server-side * to the underlying permission IDs. Unknown keys cause the request to be rejected. */ grant?: null | string[]; /** * @description Permission keys (e.g. `"user:write:org"`) to revoke from the user. Resolved * server-side to the underlying permission IDs. Unknown keys cause the request to * be rejected. The actor must hold every permission they revoke. */ revoke?: null | string[]; }; /** @description DTO for personal identification number (SSN, ITIN, Passport). */ PersonalIdentificationNumberDto: { type?: null | components["schemas"]["PersonalIdentificationNumberType"]; /** @description The personal identification number value. */ value?: null | string; }; /** @enum {string} */ PersonalIdentificationNumberType: "SSN" | "PASSPORT_NUMBER" | "ITIN"; /** @enum {string} */ Platform: "xero" | "quickbooks" | "quickbooks_online" | "quickbooks_online_sandbox"; Predicate: components["schemas"]["AmountPredicate"] | components["schemas"]["CountryPredicate"] | components["schemas"]["ItemTypePredicate"] | components["schemas"]["VatPredicate"] | components["schemas"]["VatTypePredicate"]; /** @enum {string} */ PredicateNameEnum: "amount" | "entity_country" | "counterpart_country" | "item_type" | "entity_vat" | "entity_vat_type" | "entity_vat_country" | "counterpart_vat" | "counterpart_vat_type" | "counterpart_vat_country"; /** @enum {string} */ PredicateOperatorEnum: "EQ" | "NEQ" | "GT" | "GTE" | "LT" | "LTE" | "IN" | "NOT_IN" | "RANGE" | "ALL"; PredicateResponse: { /** @description Predicate name */ name: components["schemas"]["PredicateNameEnum"]; /** @description Predicate operator */ operator: components["schemas"]["PredicateOperatorEnum"]; /** @description Predicate comparison value */ value: string; }; /** @description A preview image generated for a file. */ PreviewSchema: { /** * @description The image height in pixels. * @example 400 */ height: number; /** * @description The image URL. * @example https://bucketname.s3.amazonaws.com/1/2/3.png */ url: string; /** * @description The image width in pixels. * @example 200 */ width: number; }; /** @description A preview image generated for a file. */ PreviewSchema2: { /** * @description The image height in pixels. * @example 400 */ height: number; /** * @description The image URL. * @example https://bucketname.s3.amazonaws.com/1/2/3.png */ url: string; /** * @description The image width in pixels. * @example 200 */ width: number; }; /** @description A preview image generated for a file. */ PreviewSchema3: { /** * @description The image height in pixels. * @example 400 */ height: number; /** * @description The image URL. * @example https://bucketname.s3.amazonaws.com/1/2/3.png */ url: string; /** * @description The image width in pixels. * @example 200 */ width: number; }; PreviewTemplateRequest: { /** @description Body text of the template */ body: string; /** @description Document type of content */ document_type: components["schemas"]["DocumentObjectTypeRequestEnum"]; /** @description Lowercase ISO code of language */ language_code: components["schemas"]["LanguageCodeEnum"]; /** @description Subject text of the template */ subject: string; }; PreviewTemplateResponse: { body_preview: string; subject_preview: string; }; Price: { /** @description The currency in which the price of the product is set. */ currency: components["schemas"]["CurrencyEnum"]; /** @description The actual price of the product. */ value: number; }; /** @description A pricing plan of a financing offer */ PricingPlan: { /** @description Advance rate percentage. 10000 means 100% */ advance_rate_percentage: number; /** @description Transaction fee percentage. 300 means 3.00% */ fee_percentage: number; /** @description This amount of days after which the repayment duration is due. This is only applicable for FIXED_DURATION repayment type */ repayment_duration_days?: number; /** @description Repayment type of the loan. */ repayment_type: components["schemas"]["WCRepaymentType"]; }; ProblemDetails: { detail?: null | string; instance?: null | string; /** Format: int32 */ status?: null | number | string; title?: null | string; type?: null | string; }; ProcessResource: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at?: string; /** Format: uuid */ created_by?: string; /** @description The error for the process. */ error?: Record; /** @description The input for the script. */ input: Record; /** @description The metadata for the process. */ metadata: Record; /** @description The script snapshot taken when script started. */ script_snapshot?: boolean | number | string | unknown[] | Record; /** @description Tthe current status of the approval policy process. */ status: components["schemas"]["ProcessStatusEnum"]; /** Format: uuid */ updated_by?: string; }; /** @enum {string} */ ProcessStatusEnum: "succeeded" | "waiting" | "failed" | "running" | "canceled" | "timed_out"; /** @enum {string} */ ProductCursorFields: "name"; /** @enum {string} */ ProductFieldsEnum: "name" | "price" | "currency" | "quantity" | "description" | "measure_unit" | "tax_rate"; /** @description A paginated list of products and services */ ProductServicePaginationResponse: { data: components["schemas"]["ProductServiceResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; ProductServiceRequest: { /** @description Description of the product. */ description?: string; /** * @description A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog. * @example HT-1234-S-BL * @example SERVICE-67890 */ external_reference?: string; /** Format: uuid */ ledger_account_id?: string; /** * Format: uuid * @description The unique ID reference of the unit used to measure the quantity of this product (e.g. items, meters, kilograms). */ measure_unit_id?: string; /** @description Name of the product. */ name: string; price?: components["schemas"]["Price"]; /** @description The smallest amount allowed for this product. */ smallest_amount?: number; /** * @description Specifies whether this offering is a product or service. This may affect the applicable tax rates. * @default product */ type: components["schemas"]["ProductServiceTypeEnum"]; }; ProductServiceResponse: { /** * Format: uuid * @description Unique ID of the product. */ id: string; /** * Format: date-time * @description Time at which the product was created. Timestamps follow the ISO 8601 standard. */ created_at: string; /** * Format: date-time * @description Time at which the product was last updated. Timestamps follow the ISO 8601 standard. */ updated_at: string; /** @description Description of the product. */ description?: string; /** Format: uuid */ entity_id: string; /** Format: uuid */ entity_user_id?: string; /** * @description A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog. * @example HT-1234-S-BL * @example SERVICE-67890 */ external_reference?: string; /** Format: uuid */ ledger_account_id?: string; /** * Format: uuid * @description The unique ID reference of the unit used to measure the quantity of this product (e.g. items, meters, kilograms). */ measure_unit_id?: string; /** @description Name of the product. */ name: string; price?: components["schemas"]["Price"]; /** @description The smallest amount allowed for this product. */ smallest_amount?: number; /** * @description Specifies whether this offering is a product or service. This may affect the applicable tax rates. * @default product */ type: components["schemas"]["ProductServiceTypeEnum"]; }; /** @enum {string} */ ProductServiceTypeEnum: "product" | "service"; ProductServiceUpdate: { /** @description Description of the product. */ description?: string; /** * @description A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog. * @example HT-1234-S-BL * @example SERVICE-67890 */ external_reference?: string; /** Format: uuid */ ledger_account_id?: string; /** * Format: uuid * @description The unique ID reference of the unit used to measure the quantity of this product (e.g. items, meters, kilograms). */ measure_unit_id?: string; /** @description Name of the product. */ name?: string; price?: components["schemas"]["Price"]; /** @description The smallest amount allowed for this product. */ smallest_amount?: number; /** @description Specifies whether this offering is a product or service. This may affect the applicable tax rates. */ type?: components["schemas"]["ProductServiceTypeEnum"]; }; ProjectCreateRequest: { /** @description Project code */ code?: string; /** @description Project color */ color?: string; /** @description Description of project */ description?: string; /** * Format: date * @description Project end date */ end_date?: string; /** * @description The project name. * @example Marketing */ name: string; /** * Format: uuid * @description Parent project ID */ parent_id?: string; /** @description Project metadata */ partner_metadata?: Record; /** * Format: date * @description Project start date */ start_date?: string; /** * @description A list of IDs of user-defined tags (labels) assigned to this project. * @default [] */ tag_ids: string[]; }; /** @enum {string} */ ProjectCursorFields: "id" | "created_at"; /** @description A paginated list of projects. */ ProjectPaginationResponse: { data: components["schemas"]["ProjectResource"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; ProjectResource: { /** * Format: uuid * @description A unique ID assigned to this project. */ id: string; /** * Format: date-time * @description Project created at */ created_at: string; /** * Format: date-time * @description Last time project was updated at */ updated_at: string; /** @description Project code */ code?: string; /** @description Project color */ color?: string; /** * Format: uuid * @description Project created by entity user */ created_by_entity_user_id?: string; /** @description Description of project */ description?: string; /** * Format: date * @description Project end date */ end_date?: string; /** * Format: uuid * @description The ID of the entity to which the project was issued. */ entity_id: string; /** * @description The project name. * @example Marketing */ name: string; /** * Format: uuid * @description Parent project ID */ parent_id?: string; /** @description Project metadata */ partner_metadata?: Record; /** * Format: date * @description Project start date */ start_date?: string; /** @description A list of user-defined tags (labels) assigned to this project. */ tags?: components["schemas"]["TagReadSchema"][]; }; ProjectUpdateRequest: { /** @description Project code */ code?: string; /** @description Project color */ color?: string; /** @description Description of project */ description?: string; /** * Format: date * @description Project end date */ end_date?: string; /** * @description The project name. * @example Marketing */ name?: string; /** * Format: uuid * @description Parent project ID */ parent_id?: string; /** @description Project metadata */ partner_metadata?: Record; /** * Format: date * @description Project start date */ start_date?: string; /** * @description A list of IDs of user-defined tags (labels) assigned to this project. * @default [] */ tag_ids: string[]; }; PsuIdentification: { type: components["schemas"]["PsuIdentificationType"]; /** @description PSU identification type value. */ value: string; }; /** @enum {string} */ PsuIdentificationType: "psu_id" | "psu_corporate_id" | "psu_ip_address"; PublicBankAccount: { /** * Format: uuid * @description The ID of the bank account. */ id: string; /** * @description The last 4 digits of the bank account number. * @example 5678 */ account_number?: string; /** * @description The currency of the bank account, represented as a three-letter ISO [currency code](https://docs.monite.com/references/currencies). * @example USD */ currency?: components["schemas"]["CurrencyEnum"]; /** * @description User-defined name of this bank account, such as 'Primary account' or 'Savings account'. * @example Primary account */ display_name?: string; /** * @description The last 4 digits of the iban. * @example 5678 */ iban?: string; /** * @description Indicates whether this bank account is the default one for its currency. * @default false */ is_default: boolean; }; PublicPaymentLinkResponse: { /** Format: uuid */ id: string; amount: number; currency: components["schemas"]["CurrencyEnum"]; /** Format: date-time */ expires_at: string; invoice?: components["schemas"]["Invoice"]; payer?: components["schemas"]["PayerAccountResponse"]; payment_intent?: components["schemas"]["PaymentIntent"]; /** Format: uuid */ payment_intent_id: string; payment_methods: string[]; /** Format: uri */ payment_page_url: string; payment_reference?: string; recipient: components["schemas"]["RecipientAccountResponse"]; /** * @description The URL where to redirect the payer after the payment. If `return_url` is specified, then after the payment is completed the payment page will display the "Return to platform" link that navigates to this URL. * @example https://pay.example.com/complete */ return_url?: string; status: string; }; /** @description Address information. */ PurchaseOrderCounterpartAddressSchema: { /** * @description City name. * @example New York */ city: string; /** * @description Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). * @example US */ country: components["schemas"]["AllowedCountries"]; /** * @description Street address. * @example 456 Fifth Avenue */ line1: string; /** @description Additional address information (if any). */ line2?: string; /** * @description ZIP or postal code. * @example 10001 */ postal_code: string; /** @description State, region, province, or county. */ state?: string; }; /** @description Represents counterparts that are individuals (natural persons). */ PurchaseOrderCounterpartIndividualResponse: { /** * Format: email * @description The person's email address. * @example asingh@example.net */ email?: string; /** * @description The person's first name. * @example Adnan */ first_name: string; /** @description Indicates if the counterpart is a customer. */ is_customer: boolean; /** @description Indicates if the counterpart is a vendor. */ is_vendor: boolean; /** * @description The person's last name. * @example Singh */ last_name: string; /** * @description The person's phone number. * @example 5553211234 */ phone?: string; /** * @description The person's title or honorific. Examples: Mr., Ms., Dr., Prof. * @example Mr. */ title?: string; }; /** @description Represents counterparts that are individuals (natural persons). */ PurchaseOrderCounterpartIndividualRootResponse: { /** * Format: uuid * @description Unique ID of the counterpart. */ id: string; /** * Format: date-time * @description Date and time when the counterpart was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. */ created_at: string; /** * Format: date-time * @description Date and time when the counterpart was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. */ updated_at: string; /** * @description `true` if the counterpart was created automatically by Monite when processing incoming invoices with OCR. `false` if the counterpart was created by the API client. * @default false */ created_automatically: boolean; /** * Format: uuid * @description Entity user ID of counterpart creator. */ created_by_entity_user_id?: string; /** * Format: uuid * @description ID of the counterpart's billing address. If the counterpart is US-based and needs to accept ACH payments, this address must have all fields filled in. If `default_billing_address_id` is not defined, the default address is instead used as the billing address for ACH payments. */ default_billing_address_id?: string; /** * Format: uuid * @description ID of the shipping address. */ default_shipping_address_id?: string; individual: components["schemas"]["PurchaseOrderCounterpartIndividualResponse"]; /** @description The language used to generate pdf documents for this counterpart. */ language?: components["schemas"]["LanguageCodeEnum"]; reminders_enabled?: boolean; /** @description The counterpart's taxpayer identification number or tax ID. This field is required for counterparts that are non-VAT registered. */ tax_id?: string; /** @description The counterpart type: `organization` (juridical person) or `individual` (natural person). */ type: components["schemas"]["CounterpartType"]; }; PurchaseOrderCounterpartInfoBlock: { address?: string; email?: string; first_name?: string; header?: string; last_name?: string; organization_name?: string; tax_id?: string; vat_id?: string; }; /** @description Represents counterparts that are organizations (juridical persons). */ PurchaseOrderCounterpartOrganizationResponse: { /** * Format: email * @description The email address of the organization * @example acme@example.com */ email?: string; /** @description Indicates if the counterpart is a customer. */ is_customer: boolean; /** @description Indicates if the counterpart is a vendor. */ is_vendor: boolean; /** * @description The legal name of the organization. * @example Acme Inc. */ legal_name: string; /** * @description The phone number of the organization * @example 5551231234 */ phone?: string; }; /** @description Represents counterparts that are organizations (juridical persons). */ PurchaseOrderCounterpartOrganizationRootResponse: { /** * Format: uuid * @description Unique ID of the counterpart. */ id: string; /** * Format: date-time * @description Date and time when the counterpart was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. */ created_at: string; /** * Format: date-time * @description Date and time when the counterpart was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. */ updated_at: string; /** * @description `true` if the counterpart was created automatically by Monite when processing incoming invoices with OCR. `false` if the counterpart was created by the API client. * @default false */ created_automatically: boolean; /** * Format: uuid * @description Entity user ID of counterpart creator. */ created_by_entity_user_id?: string; /** * Format: uuid * @description ID of the counterpart's billing address. If the counterpart is US-based and needs to accept ACH payments, this address must have all fields filled in. If `default_billing_address_id` is not defined, the default address is instead used as the billing address for ACH payments. */ default_billing_address_id?: string; /** * Format: uuid * @description ID of the shipping address. */ default_shipping_address_id?: string; /** @description The language used to generate pdf documents for this counterpart. */ language?: components["schemas"]["LanguageCodeEnum"]; organization: components["schemas"]["PurchaseOrderCounterpartOrganizationResponse"]; reminders_enabled?: boolean; /** @description The counterpart's taxpayer identification number or tax ID. This field is required for counterparts that are non-VAT registered. */ tax_id?: string; /** @description The counterpart type: `organization` (juridical person) or `individual` (natural person). */ type: components["schemas"]["CounterpartType"]; }; /** * @description A Counterpart object contains information about an organization (juridical person) or * individual (natural person) that provides goods and services to or buys them from an * [SME](https://docs.monite.com/docs/glossary#sme). */ PurchaseOrderCounterpartSchema: components["schemas"]["PurchaseOrderCounterpartIndividualRootResponse"] | components["schemas"]["PurchaseOrderCounterpartOrganizationRootResponse"]; /** @enum {string} */ PurchaseOrderCursorFields: "created_at" | "updated_at"; PurchaseOrderDateBlock: { created_at?: string; }; /** @description A schema for request for preview of purchase order email */ PurchaseOrderEmailPreviewRequest: { body_text: string; subject_text: string; }; /** @description A schema for returning a response for email preview */ PurchaseOrderEmailPreviewResponse: { body_preview: string; subject_preview: string; }; /** @description A schema for returning a response an email with a link to purchase order document has been sent */ PurchaseOrderEmailSentResponse: { /** Format: uuid */ mail_id: string; }; PurchaseOrderItem: { /** @description The currency in which the price of the product is set. */ currency: components["schemas"]["CurrencyEnum"]; /** @description The name of the product to purchase */ name: string; /** @description The subtotal cost (excluding tax), in [minor units](https://docs.monite.com/references/currencies#minor-units). */ price: number; /** @description Number (quantity) of products */ quantity: number; /** @description Tax rate in percent minor units. Example: 12.5% is 1250 */ tax_rate: number; /** @description Units (hours, meters, unit) */ unit: string; }; PurchaseOrderLineItem: { currency?: string; name?: string; price?: string; quantity?: string; tax_rate?: string; total_cost?: string; units?: string; }; PurchaseOrderLineItemsBlock: { currency?: string; head_row?: string; line_items?: components["schemas"]["PurchaseOrderLineItem"][]; }; PurchaseOrderNumberBlock: { document_id?: string; }; /** @description A paginated list of purchase orders. */ PurchaseOrderPaginationResponse: { data: components["schemas"]["PurchaseOrderResponseSchema"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; /** @description Represents an Accounts Purchase Order document created by entity. */ PurchaseOrderPayloadSchema: { /** * Format: uuid * @description The ID of counterpart address object stored in counterparts service. If not provided, counterpart's default address is used. */ counterpart_address_id?: string; /** * Format: uuid * @description Counterpart unique ID. */ counterpart_id: string; /** @description The currency in which the price of the product is set. (all items need to have the same currency) */ currency: components["schemas"]["CurrencyEnum"]; /** * Format: uuid * @description Entity VAT ID identifier that applied to purchase order */ entity_vat_id_id?: string; /** @description List of item to purchase */ items: components["schemas"]["PurchaseOrderItem"][]; /** @description Msg which will be send to counterpart for who the purchase order is issued. */ message: string; /** * Format: uuid * @description Project id of a purchase order */ project_id?: string; /** @description Number of days for which purchase order is valid */ valid_for_days: number; }; PurchaseOrderRenderPayload: { /** * @default { * "tax_id_header": "KVK", * "vat_id_header": "VAT" * } */ entity_contact: components["schemas"]["EntityContactBlock"]; /** * @default { * "tax_id_header": "TAX ID", * "vat_id_header": "VAT" * } */ entity_info: components["schemas"]["EntityInfoBlock"]; /** @default {} */ entity_logo: components["schemas"]["EntityLogoBlock"]; /** @default {} */ header: components["schemas"]["HeaderBlock"]; /** * @default { * "line_items": [] * } */ line_items: components["schemas"]["PurchaseOrderLineItemsBlock"]; /** @default {} */ memo: components["schemas"]["MemoBlock"]; /** * @default { * "header": "Payment terms" * } */ payment_terms: components["schemas"]["PaymentTermsBlock"]; /** @default {} */ purchase_order_counterpart_info: components["schemas"]["PurchaseOrderCounterpartInfoBlock"]; /** @default {} */ purchase_order_date: components["schemas"]["PurchaseOrderDateBlock"]; /** @default {} */ purchase_order_number: components["schemas"]["PurchaseOrderNumberBlock"]; /** * @description Type of the template (enum property replaced by openapi-typescript) * @enum {string} */ template_type: "purchase_order"; }; /** @description Represents response for an Accounts Purchase Order document created by entity. */ PurchaseOrderResponseSchema: { /** * Format: uuid * @description A unique ID assigned to this purchase order. */ id: string; /** * Format: date-time * @description Time at which the receivable was created. Timestamps follow the ISO 8601 standard. */ created_at: string; /** * Format: date-time * @description Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard. */ updated_at: string; /** @description Counterpart information about an organization (juridical person) or individual (natural person) that provides goods and services to or buys them from an */ counterpart: components["schemas"]["PurchaseOrderCounterpartSchema"]; /** @description Counterpart address data saved on creation or update of the purchase order. */ counterpart_address?: components["schemas"]["PurchaseOrderCounterpartAddressSchema"]; /** * Format: uuid * @description The ID of counterpart address object stored in counterparts service. If not provided, counterpart's default address is used. */ counterpart_address_id?: string; /** * Format: uuid * @description Counterpart unique ID. */ counterpart_id: string; /** * Format: uuid * @description ID of the creator of the purchase order */ created_by_user_id?: string; /** @description The currency in which the price of the product is set. (all items need to have the same currency) */ currency: components["schemas"]["CurrencyEnum"]; document_id: string; /** @description Data of the entity (address, name, contact) */ entity: components["schemas"]["PayableEntityIndividualResponse"] | components["schemas"]["PayableEntityOrganizationResponse"]; /** * Format: uuid * @description The ID of the entity which issued the purchase order. */ entity_id: string; entity_vat_id?: components["schemas"]["PurchaseOrderVatId"]; /** Format: uuid */ file_id?: string; file_url?: string; /** * Format: date * @description When status changed from 'draft' to 'send', so after sending purchase order */ issued_at?: string; /** @description List of item to purchase */ items: components["schemas"]["PurchaseOrderItem"][]; /** @description Msg which will be send to counterpart for who the purchase order is issued. */ message: string; /** * Format: uuid * @description Project id of a purchase order */ project_id?: string; /** @description Purchase order can be in 'draft' state before sending it to counterpart. After that state is 'issued' */ status: string; /** @description Number of days for which purchase order is valid */ valid_for_days: number; }; /** @enum {string} */ PurchaseOrderStatusEnum: "draft" | "issued"; PurchaseOrderVatId: { /** Format: uuid */ id: string; country: string; /** Format: uuid */ entity_id: string; type: string; value: string; }; /** @description Fields for the QR code data block */ QRCodeDataBlock: { bic?: string; /** @default BIC */ bic_title: string; entity_name?: string; /** @default Beneficiary's name */ entity_name_title: string; iban?: string; /** @default IBAN */ iban_title: string; invoice_number?: string; /** @default Reference */ invoice_number_header: string; /** @default To pay the invoice amount, please scan the QR code */ payment_option_description: string; qr_code_base64?: string; /** @default Or use the following details */ qr_code_description: string; qr_code_text_below?: string; request_for_payment?: string; }; QuoteAcceptRequest: { /** @description A digital signature, if required for quote acceptance */ signature?: components["schemas"]["Signature"]; }; QuoteRenderingSettings: { /** * @description If set to `true`, the organization's bank account details will be displayed on the quote PDF. * @default true */ display_organization_bank_account: boolean; /** * @description If set to `true`, the signature field will be displayed on the quote PDF. * @default false */ display_signature: boolean; }; QuoteResponsePayload: { /** Format: uuid */ id: string; /** * Format: date-time * @description Time at which the receivable was created. Timestamps follow the ISO 8601 standard. */ created_at: string; /** * Format: date-time * @description Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard. */ updated_at: string; /** @description List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. */ attachments?: components["schemas"]["AttachmentResponse"][]; /** Format: uuid */ bank_account_id?: string; bank_account_snapshot?: components["schemas"]["BankAccountSnapshot"]; bank_account_type?: string; /** * Format: uuid * @description The unique ID of a previous document related to the receivable if applicable. */ based_on?: string; /** @description The unique document ID of a previous document related to the receivable if applicable. */ based_on_document_id?: string; /** @description Field with a comment on why the client declined this Quote */ comment?: string; /** @description The commercial terms of the receivable (e.g. The products must be delivered in X days). */ commercial_condition_description?: string; /** @description Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. */ counterpart_billing_address?: components["schemas"]["ReceivablesRepresentationOfCounterpartAddress"]; /** @description Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. */ counterpart_business_type?: string; /** @description Additional information about counterpart contacts. */ counterpart_contact?: components["schemas"]["ReceivableCounterpartContact"]; /** @description The external reference of the counterpart. */ counterpart_external_reference?: string; /** * Format: uuid * @description Unique ID of the counterpart. */ counterpart_id: string; /** @description A legal name of a counterpart it is an organization or first and last name if it is an individual */ counterpart_name?: string; /** @description Address where goods were shipped / where services were provided. */ counterpart_shipping_address?: components["schemas"]["ReceivablesRepresentationOfCounterpartAddress"]; /** @description The VAT/TAX ID of the counterpart. */ counterpart_tax_id?: string; /** @description The type of the counterpart. */ counterpart_type: components["schemas"]["CounterpartType"]; counterpart_vat_id?: components["schemas"]["ReceivableCounterpartVatIDResponse"]; /** @description The currency used in the receivable. */ currency: components["schemas"]["CurrencyEnum"]; /** * @deprecated * @description The amount of tax deducted in minor units */ deduction_amount?: number; /** * @deprecated * @description A note with additional information about a tax deduction */ deduction_memo?: string; /** @description List of deductions applied to the receivable (maximum 10 deductions allowed) */ deductions?: components["schemas"]["DeductionItem"][]; /** @description The discount for a receivable. */ discount?: components["schemas"]["DiscountResponse"]; /** @description Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units). */ discounted_subtotal?: number; /** @description The sequential code systematically assigned to invoices. */ document_id?: string; /** @description Settings for rendering documents in PDF format, including settings for line items and specific document types. */ document_rendering?: components["schemas"]["DocumentRenderingSettings"]; /** * Format: date * @description Optional field representing date until which invoice should be paid */ due_date?: string; entity: components["schemas"]["ReceivableEntityOrganization"] | components["schemas"]["ReceivableEntityIndividual"]; entity_address: components["schemas"]["ReceivableEntityAddressSchema"]; /** * @deprecated * @description Deprecated. Always null; use `bank_account_snapshot` instead. */ entity_bank_account?: components["schemas"]["ReceivablesRepresentationOfEntityBankAccount"]; /** * Format: uuid * @description The entity user who created this document. */ entity_user_id?: string; entity_vat_id?: components["schemas"]["ReceivableEntityVatIDResponse"]; /** * Format: date * @description The date (in ISO 8601 format) until which the quote is valid. */ expiry_date?: string; /** @description The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated. */ file_language: components["schemas"]["LanguageCodeEnum"]; /** @description The receivable's PDF URL in the counterpart's default language. */ file_url?: string; /** @description Optional text displayed below the line items table in the PDF. */ footer?: string; /** * Format: date-time * @description Optional field for the issue of the entry. */ issue_date?: string; line_items: components["schemas"]["ResponseItem"][]; /** @description A note with additional information for a receivable. */ memo?: string; /** @description The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated. */ original_file_language: components["schemas"]["LanguageCodeEnum"]; /** @description The receivable's PDF URL in the entity's default language. */ original_file_url?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; /** * Format: uuid * @description A project related to current receivable */ project_id?: string; /** * Format: uri * @description Link for custom quote accept page */ quote_accept_page_url?: string; /** @description Whether acceptance a quote requires a signature. */ signature_required?: boolean; /** @description The status of the Quote inside the receivable workflow. */ status: components["schemas"]["QuoteStateEnum"]; /** @description The subtotal (excluding tax), in [minor units](https://docs.monite.com/references/currencies#minor-units). */ subtotal?: number; /** @description The subtotal including tax but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). */ subtotal_after_tax?: number; /** * @description The list of tags for this receivable. * @default [] */ tags: components["schemas"]["TagReadSchema"][]; /** @description Indicates whether the goods, materials, or services listed in the receivable are exempt from tax or not. */ tax_exempt?: boolean; /** @description The reason for the tax exemption, if applicable. */ tax_exemption_rationale?: string; /** * @description Indicates whether the discount is applied to the tax-inclusive or tax-exclusive amount. * @default exclusive */ tax_inclusive_discount_mode: components["schemas"]["VatModeEnum"]; /** * @description Defines whether the prices of products in receivable will already include tax or not. * @default exclusive */ tax_mode: components["schemas"]["VatModeEnum"]; /** * @description Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_tax_amount. * @default 0 */ total_amount: number; /** @description The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units). */ total_deduction_amount?: number; /** @description The total tax of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). */ total_tax_amount: number; /** @description List of total tax amount for each tax rate, presented in receivable */ total_tax_amounts?: components["schemas"]["TotalTaxAmountItem"][]; /** @description Total price of the receivable with tax withheld in minor units */ total_withholding_tax?: number; /** @description Trade name of the entity */ trade_name?: string; /** * @description The type of the document uploaded. * @enum {string} */ type: "quote"; /** @description The amount of tax withheld in percent minor units */ withholding_tax_rate?: number; }; /** @enum {string} */ QuoteStateEnum: "draft" | "issued" | "accepted" | "expired" | "declined" | "deleted"; Rate: { /** @description ISO code of the currency we are going to work with — USD, THB etc. */ currency: components["schemas"]["CurrencyEnum"]; /** @description Exchange rate value with floating point as it is. */ rate: number; }; RatesResponse: { /** @description Action name */ data: components["schemas"]["Rate"][]; }; ReceiptAttachFile: { /** Format: binary */ file: Blob; }; ReceiptCreateSchema: { /** @description Base64-encoded contents of the original receipt file. */ base64_encoded_file?: string; /** * @description Currency code used in the receipt. * @example USD */ currency?: components["schemas"]["CurrencyEnum"]; /** * @description Short transaction description. * @example Payment for lunch with clients */ description?: string; /** * @description Unique receipt number assigned by the issuer. * @example INV-2287 */ document_id?: string; /** * Format: date-time * @description Receipt issued date and time. */ issued_at?: string; /** * @description Location of the merchant. * @example West Street, London, UK */ merchant_location?: string; /** * @description Name of the merchant. * @example Tesco */ merchant_name?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; /** * @description Total amount for the receipt in minor units (e.g. cents). * @example 15000 */ total_amount?: number; /** * Format: uuid * @description Transaction ID. */ transaction_id?: string; }; /** @enum {string} */ ReceiptCursorFields: "id" | "created_at"; /** @enum {string} */ ReceiptDimensionEnum: "created_at" | "currency" | "issued_at"; ReceiptLineItemCreateSchema: { /** @description Line item name/description. */ name?: string; /** @description Line item total in minor units. */ total?: number; }; /** @enum {string} */ ReceiptLineItemCursorFields: "created_at" | "updated_at"; ReceiptLineItemResponseSchema: { /** * Format: uuid * @description Unique line item ID. */ id: string; /** * Format: date-time * @description Created at. */ created_at: string; /** * Format: date-time * @description Updated at. */ updated_at: string; /** * Format: uuid * @description Created by user. */ created_by_entity_user_id?: string; /** @description Line item name. */ name?: string; /** * Format: uuid * @description Receipt ID. */ receipt_id: string; /** @description Total. */ total?: number; }; ReceiptLineItemUpdateSchema: { /** @description Line item name/description. */ name?: string; /** @description Line item total in minor units. */ total?: number; }; ReceiptLineItemsPaginationResponse: { data: components["schemas"]["ReceiptLineItemResponseSchema"][]; /** @description Next page token. */ next_pagination_token?: string; /** @description Previous page token. */ prev_pagination_token?: string; }; /** @enum {string} */ ReceiptLinkSourceEnum: "user" | "automatched"; /** @enum {string} */ ReceiptMetricEnum: "id"; /** @enum {string} */ ReceiptOriginEnum: "upload" | "email"; ReceiptPaginationResponse: { data: components["schemas"]["ReceiptResponseSchema"][]; /** @description Next page token. */ next_pagination_token?: string; /** @description Previous page token. */ prev_pagination_token?: string; }; ReceiptResponseSchema: { /** * Format: uuid * @description Unique receipt ID. */ id: string; /** * Format: date-time * @description Creation timestamp. */ created_at: string; /** * Format: date-time * @description Update timestamp. */ updated_at: string; /** * Format: uuid * @description Entity user who created. */ created_by_entity_user_id?: string; /** @description Currency code. */ currency?: components["schemas"]["CurrencyEnum"]; /** @description Currency exchange details. */ currency_exchange?: Record; /** * @description Short transaction description. * @example Payment for lunch with clients */ description?: string; /** @description Receipt number. */ document_id?: string; /** * Format: uuid * @description The id of the receipt file stored in the file saver. * @example 123e4567-e89b-12d3-a456-426614174000 */ file_id?: string; /** @description The original file name. */ file_name?: string; /** @description The URL of the receipt file stored in the file saver. */ file_url?: string; /** * Format: date-time * @description Date when the receipt was issued. */ issued_at?: string; /** @description How the receipt was linked to a transaction. */ link_source?: components["schemas"]["ReceiptLinkSourceEnum"]; /** @description Merchant location. */ merchant_location?: string; /** @description Merchant name. */ merchant_name?: string; /** * Format: uuid * @description OCR request id. */ ocr_request_id?: string; /** @description OCR status. */ ocr_status?: string; /** @description Specifies how this receipt was created in Monite. */ origin: components["schemas"]["ReceiptOriginEnum"]; /** @description Partner metadata. */ partner_metadata?: Record; /** * Format: email * @description The email address from which the invoice was sent to the entity. * @example hello@example.com */ sender?: string; /** @description Source of data. */ source_of_data?: components["schemas"]["SourceOfReceiptDataEnum"]; /** @description Total amount in minor units. */ total_amount?: number; /** * Format: uuid * @description Transaction ID. */ transaction_id?: string; }; ReceiptUpdateSchema: { /** @description Base64-encoded file contents. */ base64_encoded_file?: string; /** @description Currency code. */ currency?: components["schemas"]["CurrencyEnum"]; /** * @description Short transaction description. * @example Payment for lunch with clients */ description?: string; /** @description Receipt number. */ document_id?: string; /** * Format: date-time * @description Date when the receipt was issued. */ issued_at?: string; /** @description Merchant location. */ merchant_location?: string; /** @description Merchant name. */ merchant_name?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; /** @description Total amount. */ total_amount?: number; /** * Format: uuid * @description Transaction ID. */ transaction_id?: string; }; ReceiptUploadFile: { /** Format: binary */ file: Blob; }; ReceivableCounterpartContact: { /** @description The contact address of the counterpart */ address?: components["schemas"]["ReceivablesRepresentationOfCounterpartAddress"]; /** * Format: email * @description The contact email of the counterpart. * @example marge@example.org */ email?: string; /** * @description The first name of the counterpart contact. * @example Marge */ first_name: string; /** * @description The last name of the counterpart contact. * @example Smith */ last_name: string; /** * @description The contact phone number of the counterpart. * @example 55512378654 */ phone?: string; /** * @description The counterpart contact title (e.g. Dr., Mr., Mrs., Ms., etc). * @example Dr. */ title?: string; }; ReceivableCounterpartVatIDResponse: { /** Format: uuid */ id: string; /** Format: uuid */ counterpart_id: string; country?: components["schemas"]["AllowedCountries"]; /** * @default unknown * @example eu_vat */ type: components["schemas"]["VatIDTypeEnum"]; /** @example 123456789 */ value: string; }; ReceivableCreateBasedOnPayload: { /** * Format: uuid * @description The unique ID of a previous document related to the receivable if applicable. */ based_on: string; /** * @description A list of IDs of user-defined tags (labels) assigned to this receivable. * @default [] */ tag_ids: string[]; /** @description The type of a created receivable. Currently supported transitions:quote -> invoice; invoice -> credit_note */ type: components["schemas"]["BasedOnTransitionType"]; }; ReceivableCreatedEventData: Record; /** @enum {string} */ ReceivableCursorFields: "counterpart_name" | "counterpart_id" | "amount" | "total_amount" | "discounted_subtotal" | "status" | "due_date" | "issue_date" | "document_id" | "created_at" | "project_id"; /** @enum {string} */ ReceivableCursorFields2: "counterpart_name" | "counterpart_id" | "amount" | "total_amount" | "status" | "due_date" | "issue_date" | "document_id" | "created_at" | "project_id"; /** @description Payload for decline a Qoute with a comment */ ReceivableDeclinePayload: { /** * @description Field with a comment on why the client declined this Quote * @example The quote was declined for some reasons */ comment?: string; }; /** @enum {string} */ ReceivableDimensionEnum: "created_at" | "status" | "counterpart_id" | "currency" | "issue_date" | "due_date" | "project_id" | "product_id"; /** @enum {string} */ ReceivableEditFlow: "compliant" | "partially_compliant" | "non_compliant"; /** @description A schema represents address info of the entity */ ReceivableEntityAddressSchema: { /** @description A city (a full name) where the entity is registered */ city: string; /** * @description A country name (as ISO code) where the entity is registered * @default DE * @example DE */ country: components["schemas"]["AllowedCountries"]; /** @description A street where the entity is registered */ line1: string; /** @description An alternative street used by the entity */ line2?: string; /** @description A postal code of the address where the entity is registered */ postal_code: string; /** @description A state in a country where the entity is registered */ state?: string; }; /** @description A base schemas for an entity */ ReceivableEntityBase: { /** * Format: email * @description An email of the entity */ email?: string; /** * Format: uri * @description A link to the entity logo */ logo?: string; /** @description A phone number of the entity */ phone?: string; /** @description The registration authority of the entity */ registration_authority?: string; /** @description The registration number of the entity */ registration_number?: string; /** * Format: uri * @description A website of the entity */ website?: string; }; /** @description A Response schema for an entity of individual type */ ReceivableEntityIndividual: { /** * Format: email * @description An email of the entity */ email?: string; /** @description The first name of the entity issuing the receivable */ first_name: string; /** @description The last name of the entity issuing the receivable */ last_name: string; /** * Format: uri * @description A link to the entity logo */ logo?: string; /** @description A phone number of the entity */ phone?: string; /** @description The registration authority of the entity */ registration_authority?: string; /** @description The registration number of the entity */ registration_number?: string; /** @description The Tax ID of the entity issuing the receivable */ tax_id?: string; /** * @description The entity type * @enum {string} */ type: "individual"; /** * Format: uri * @description A website of the entity */ website?: string; }; /** @description A Request schema for an entity of individual type */ ReceivableEntityIndividualRequest: { /** * Format: email * @description An email of the entity */ email?: string; /** @description The first name of the entity issuing the receivable */ first_name: string; /** @description The last name of the entity issuing the receivable */ last_name: string; /** * Format: uri * @description A link to the entity logo */ logo?: string; /** @description A phone number of the entity */ phone?: string; /** @description The registration authority of the entity */ registration_authority?: string; /** @description The registration number of the entity */ registration_number?: string; /** @description The Tax ID of the entity issuing the receivable */ tax_id?: string; /** * @description The entity type * @enum {string} */ type: "individual"; /** * Format: uri * @description A website of the entity */ website?: string; }; /** @description A Response schema for an entity of organization type */ ReceivableEntityOrganization: { /** * Format: email * @description An email of the entity */ email?: string; /** * Format: uri * @description A link to the entity logo */ logo?: string; /** @description The name of the entity issuing the receivable, when it is an organization. */ name: string; /** @description A phone number of the entity */ phone?: string; /** @description The registration authority of the entity */ registration_authority?: string; /** @description The registration number of the entity */ registration_number?: string; /** @description The Tax ID of the entity issuing the receivable */ tax_id?: string; /** * @description The entity type * @enum {string} */ type: "organization"; /** @description The VAT ID of the entity issuing the receivable, when it is an organization. */ vat_id?: string; /** * Format: uri * @description A website of the entity */ website?: string; }; /** @description A Request schema for an entity of organization type */ ReceivableEntityOrganizationRequest: { /** * Format: email * @description An email of the entity */ email?: string; /** * Format: uri * @description A link to the entity logo */ logo?: string; /** @description The name of the entity issuing the receivable, when it is an organization. */ name: string; /** @description A phone number of the entity */ phone?: string; /** @description The registration authority of the entity */ registration_authority?: string; /** @description The registration number of the entity */ registration_number?: string; /** @description The Tax ID of the entity issuing the receivable */ tax_id?: string; /** * @description The entity type * @enum {string} */ type: "organization"; /** * Format: uri * @description A website of the entity */ website?: string; }; ReceivableEntityVatIDResponse: { /** Format: uuid */ id: string; country: components["schemas"]["AllowedCountries"]; /** Format: uuid */ entity_id: string; /** * @default unknown * @example eu_vat */ type: components["schemas"]["VatIDTypeEnum"]; /** @example 123456789 */ value: string; }; ReceivableFacadeCreateInvoicePayload: { /** @description List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. */ attachments?: components["schemas"]["AttachmentRequest"][]; /** * Format: uuid * @description Bank account ID */ bank_account_id?: string; /** @description Bank account type: INTERNAL, EXTERNAL, or BANK_DETAILS */ bank_account_type?: components["schemas"]["BankAccountTypeEnum"]; commercial_condition_description?: string; /** * Format: uuid * @description Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. */ counterpart_billing_address_id?: string; /** @description Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. */ counterpart_business_type?: string; /** Format: uuid */ counterpart_id: string; /** * Format: uuid * @description Address where goods were shipped / where services were provided. */ counterpart_shipping_address_id?: string; /** * Format: uuid * @description Counterpart VAT ID id */ counterpart_vat_id_id?: string; currency: components["schemas"]["CurrencyEnum"]; /** @description List of deductions applied to the receivable (maximum 10 deductions allowed) */ deductions?: components["schemas"]["DeductionItem"][]; /** @description The discount for a receivable. */ discount?: components["schemas"]["Discount"]; /** * @description The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. * @example INV-0001 * @example 2024-027 * @example CUST/2024/00027 */ document_id?: string; /** @description Settings for rendering documents in PDF format, including settings for line items and specific document types. */ document_rendering?: components["schemas"]["DocumentRenderingSettings"]; entity?: components["schemas"]["ReceivableEntityBase"]; /** * Format: uuid * @description Entity VAT ID id */ entity_vat_id_id?: string; /** @description Optional text displayed below the line items table in the PDF. */ footer?: string; /** * Format: date * @description The date when the goods are shipped or the service is provided. Can be a current, past, or future date. * * Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. * * In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user. */ fulfillment_date?: string; line_items: components["schemas"]["LineItem"][]; /** @description A note with additional information for a receivable */ memo?: string; /** Format: uuid */ overdue_reminder_id?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; /** * Format: uri * @description Link to the invoice's payment page. Either Monite's payment links or your custom payment links. */ payment_page_url?: string; /** Format: uuid */ payment_reminder_id?: string; payment_terms?: components["schemas"]["InlinePaymentTermsRequestPayload"]; /** Format: uuid */ payment_terms_id?: string; /** * Format: uuid * @description A project related to current receivable */ project_id?: string; /** @description Contain purchase order number. */ purchase_order?: string; /** * @description A list of IDs of user-defined tags (labels) assigned to this receivable. * @default [] */ tag_ids: string[]; /** @description Indicates whether the goods, materials, or services listed in the receivable are exempt from tax or not. */ tax_exempt?: boolean; /** @description The reason for the tax exemption, if applicable. */ tax_exemption_rationale?: string; /** @description Defines whether the prices of products in receivable will already include tax or not. */ tax_mode?: components["schemas"]["VatModeEnum"]; /** @description Trade name of the entity */ trade_name?: string; /** * @description The type of the document uploaded. * @enum {string} */ type: "invoice"; /** @description The amount of tax withheld in percent minor units */ withholding_tax_rate?: number; }; ReceivableFacadeCreatePayload: components["schemas"]["ReceivableFacadeCreateQuotePayload"] | components["schemas"]["ReceivableFacadeCreateInvoicePayload"] | components["schemas"]["ReceivableCreateBasedOnPayload"]; ReceivableFacadeCreateQuotePayload: { /** @description List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. */ attachments?: components["schemas"]["AttachmentRequest"][]; /** * Format: uuid * @description Bank account ID */ bank_account_id?: string; /** @description Bank account type: INTERNAL, EXTERNAL, or BANK_DETAILS */ bank_account_type?: components["schemas"]["BankAccountTypeEnum"]; commercial_condition_description?: string; /** * Format: uuid * @description Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. */ counterpart_billing_address_id?: string; /** @description Different types of companies for different countries, ex. GmbH, SAS, SNC, etc. */ counterpart_business_type?: string; /** Format: uuid */ counterpart_id: string; /** * Format: uuid * @description Address where goods were shipped / where services were provided. */ counterpart_shipping_address_id?: string; /** * Format: uuid * @description Counterpart VAT ID id */ counterpart_vat_id_id?: string; currency: components["schemas"]["CurrencyEnum"]; /** @description List of deductions applied to the receivable (maximum 10 deductions allowed) */ deductions?: components["schemas"]["DeductionItem"][]; /** @description The discount for a receivable. */ discount?: components["schemas"]["Discount"]; /** * @description The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. * @example INV-0001 * @example 2024-027 * @example CUST/2024/00027 */ document_id?: string; /** @description Settings for rendering documents in PDF format, including settings for line items and specific document types. */ document_rendering?: components["schemas"]["DocumentRenderingSettings"]; entity?: components["schemas"]["ReceivableEntityBase"]; /** * Format: uuid * @description Entity VAT ID id */ entity_vat_id_id?: string; /** * Format: date * @description The date (in ISO 8601 format) until which the quote is valid. */ expiry_date?: string; /** @description Optional text displayed below the line items table in the PDF. */ footer?: string; line_items: components["schemas"]["LineItem"][]; /** @description A note with additional information for a receivable */ memo?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; /** * Format: uuid * @description A project related to current receivable */ project_id?: string; /** * Format: uri * @description Link for custom quote accept page */ quote_accept_page_url?: string; /** @description Whether acceptance a quote requires a signature. */ signature_required?: boolean; /** * @description A list of IDs of user-defined tags (labels) assigned to this receivable. * @default [] */ tag_ids: string[]; /** @description Indicates whether the goods, materials, or services listed in the receivable are exempt from tax or not. */ tax_exempt?: boolean; /** @description The reason for the tax exemption, if applicable. */ tax_exemption_rationale?: string; /** @description Defines whether the prices of products in receivable will already include tax or not. */ tax_mode?: components["schemas"]["VatModeEnum"]; /** @description Trade name of the entity */ trade_name?: string; /** * @description The type of the document uploaded. * @enum {string} */ type: "quote"; /** @description The amount of tax withheld in percent minor units */ withholding_tax_rate?: number; }; /** @enum {string} */ ReceivableFieldsEnum: "line_items" | "amount" | "currency" | "total_tax_amount" | "counterpart_shipping_address" | "counterpart_billing_address" | "purchase_order" | "counterpart_business_type" | "fulfillment_date" | "issue_date" | "document_id"; ReceivableFileUrl: { /** @description The receivable's PDF URL in the counterpart's default language. */ file_url?: string; /** @description The receivable's PDF URL in the entity's default language. */ original_file_url?: string; }; /** @enum {string} */ ReceivableHistoryCursorFields: "timestamp"; /** @enum {string} */ ReceivableHistoryEventTypeEnum: "status_changed" | "receivable_created" | "receivable_updated" | "based_on_receivable_created" | "payment_received" | "mail_sent" | "payment_reminder_mail_sent" | "overdue_reminder_mail_sent"; /** @description A paginated list of change history records. */ ReceivableHistoryPaginationResponse: { data: components["schemas"]["ReceivableHistoryResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; /** @description Represents an entry in the change history of an accounts receivable document. */ ReceivableHistoryResponse: { /** * Format: uuid * @description A unique ID of the history record. * @example cd58435b-1c79-4b17-9f79-f898c93e5f97 */ id: string; /** * Format: uri * @description A URL of the PDF file that shows the document state after the change. Available only for the following event types: `receivable_created`, `receivable_updated`, `status_changed`, and `payment_received`. In other event types the `current_pdf_url` value is `null`. * * In `payment_received` events, the `current_pdf_url` value is available only in case of full payments and only if the entity setting `generate_paid_invoice_pdf` is `true`. * * Note that Monite generates PDFs asynchronously. This means that the initial value of `current_pdf_url` for the abovementioned events right after they occurred is usually `null` and the value gets populated later after the PDF document has been generated. * @example https://monite-file-saver.example.com/12345/67890.pdf */ current_pdf_url?: string; /** * Format: uuid * @description ID of the entity user who made the change or trigger the event, or `null` if it was done by using a partner access token. * @example d5a577b0-01c0-4566-ac5c-44f41935e8c4 */ entity_user_id?: string; /** @description An object containing additional information about the event or change. The object structure varies based on the `event_type`. In `receivable_created` and `receivable_updated` events, `event_data` is an empty object `{}`. */ event_data: components["schemas"]["StatusChangedEventData"] | components["schemas"]["ReceivableUpdatedEventData"] | components["schemas"]["ReceivableCreatedEventData"] | components["schemas"]["BasedOnReceivableCreatedEventData"] | components["schemas"]["PaymentReceivedEventData"] | components["schemas"]["MailSentEventData"] | components["schemas"]["ReminderMailSentEventData"]; /** @description The type of the event or change. See [Event types](https://docs.monite.com/accounts-receivable/document-history#event-types). */ event_type: components["schemas"]["ReceivableHistoryEventTypeEnum"]; /** * Format: uuid * @description ID of the receivable document that was changed or triggered an event. * @example f669a8a4-0563-4ab9-b54f-e9d700d282c5 */ receivable_id: string; /** * Format: date-time * @description UTC date and time when the event or change occurred. */ timestamp: string; }; /** @enum {string} */ ReceivableMailCursorFields: "status" | "created_at" | "updated_at"; ReceivableMailPaginationResponse: { data: components["schemas"]["ReceivableMailResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; ReceivableMailRecipientState: { /** * Format: email * @description An email address of the recipient. */ email: string; /** @description An error message in case the mailing was unsuccessful. */ error?: string; /** @description Whether mail was sent successfully. */ is_success: boolean; }; ReceivableMailRecipients: { bcc?: components["schemas"]["ReceivableMailRecipientState"][]; cc?: components["schemas"]["ReceivableMailRecipientState"][]; to?: components["schemas"]["ReceivableMailRecipientState"][]; }; ReceivableMailResponse: { /** Format: uuid */ id: string; /** * Format: date-time * @description The time the mail task was created */ created_at: string; /** * Format: date-time * @description The time the mail task was updated */ updated_at: string; recipients?: components["schemas"]["ReceivableMailRecipients"]; /** @description The status of the mail sent by receivable */ status: components["schemas"]["ReceivableMailStatusEnum"]; }; /** @enum {string} */ ReceivableMailStatusEnum: "pending" | "processing" | "sent" | "partially_sent" | "failed"; /** @enum {string} */ ReceivableMetricEnum: "id" | "amount_due" | "product_amount" | "product_quantity" | "total_amount"; ReceivableNumberBlock: { document_id?: string; document_type?: string; /** @default Document number */ header: string; }; /** @description A paginated list of receivables */ ReceivablePaginationResponse: { data: components["schemas"]["ReceivableResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; ReceivablePaidPayload: { /** @description Optional comment explaining how the payment was made. */ comment?: string; /** * Format: date-time * @description Date and time when the invoice was paid. */ paid_at?: string; }; ReceivablePartiallyPaidPayload: { /** @description How much has been paid on the invoice (in minor units). */ amount_paid: number; /** @description Optional comment explaining how the payment was made. */ comment?: string; }; /** @description A schema for receiving a request for previewing an email with a receivable document */ ReceivablePreviewRequest: { /** @description Body text of the content */ body_text: string; /** * @description Language code for localization purposes * @default en */ language: components["schemas"]["LanguageCodeEnum"]; /** @description Subject text of the content */ subject_text: string; /** * @description The type of the preview document. * @default receivable */ type: components["schemas"]["ReceivablesPreviewTypeEnum"]; }; /** @description A schema for receiving a request for previewing an email with a receivable document */ ReceivablePreviewResponse: { body_preview: string; subject_preview: string; }; ReceivableRenderPayload: { /** * @default { * "account_holder_name_header": "Account holder", * "account_number_header": "Account number", * "bank_name_header": "Bank", * "bic_header": "BIC", * "iban_header": "IBAN", * "routing_number_header": "Routing number", * "sort_code_header": "Sort code" * } */ account_data: components["schemas"]["AccountDataBlock"]; /** * @default { * "header": "Commercial conditions" * } */ commercial_conditions: components["schemas"]["CommercialConditionsBlock"]; /** * @default { * "external_reference_header": "Counterpart Reference", * "tax_id_header": "TAX ID" * } */ counterpart_info: components["schemas"]["CounterpartInfoBlock"]; /** * @default { * "tax_id_header": "KVK", * "vat_id_header": "VAT" * } */ entity_contact: components["schemas"]["EntityContactBlock"]; /** * @default { * "tax_id_header": "TAX ID", * "vat_id_header": "VAT" * } */ entity_info: components["schemas"]["EntityInfoBlock"]; /** @default {} */ entity_logo: components["schemas"]["EntityLogoBlock"]; /** @default {} */ footer: components["schemas"]["FooterBlock"]; /** @default {} */ header: components["schemas"]["HeaderBlock"]; /** * @default { * "amounts_reduced": [], * "deductions": [], * "discount_header": "Discount", * "discounted_subtotal_header": "Discounted subtotal", * "line_items": [], * "subtotal_header": "Subtotal", * "table_headers": [], * "tax_inclusive_discount": false, * "tax_mode_inclusive": false, * "total_header": "Total", * "total_vat_header": "Total VAT", * "total_vats": [], * "withholding_tax_header": "Withholding tax" * } */ line_items: components["schemas"]["LineItemsBlock"]; /** @default {} */ memo: components["schemas"]["MemoBlock"]; /** * @default { * "for_preposition": "for", * "of_preposition": "of", * "page_text": "Page" * } */ page_counter: components["schemas"]["PageCounterBlock"]; /** * @default { * "header": "Payment terms" * } */ payment_terms: components["schemas"]["PaymentTermsBlock"]; /** * @default { * "bic_title": "BIC", * "entity_name_title": "Beneficiary's name", * "iban_title": "IBAN", * "invoice_number_header": "Reference", * "payment_option_description": "To pay the invoice amount, please scan the QR code", * "qr_code_description": "Or use the following details" * } */ qr_code_data: components["schemas"]["QRCodeDataBlock"]; /** * @default { * "based_invoice_number_header": "Invoice number", * "client_header": "Client", * "created_at_header": "Invoice date", * "delivery_date_header": "Delivery date", * "delivery_number_header": "Delivery number", * "document_id_header": "Document number", * "due_date_header": "Due date", * "fulfillment_date_header": "Fulfillment date", * "issue_date_header": "Issue date", * "paid_date_header": "Paid date", * "purchase_order_header": "Purchase order", * "quote_expires_header": "Quote expires", * "receivable_number_header": "Number" * } */ receivable_date: components["schemas"]["DocumentInfoBlock"]; /** * @default { * "header": "Document number" * } */ receivable_number: components["schemas"]["ReceivableNumberBlock"]; signature?: components["schemas"]["SignatureBlock"]; /** * @description Type of the template (enum property replaced by openapi-typescript) * @enum {string} */ template_type: "receivable"; }; /** * @example { * "line_item": { * "vat_rate_id": { * "required": true, * "description": "Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan." * }, * "tax_rate_value": { * "required": false, * "description": "Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries." * }, * "measure_unit": { * "required": true, * "description": "Unit used to measure the quantity of the product (e.g. items, meters, kilograms)" * } * }, * "entity": { * "tax_id": { * "required": false, * "description": "The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered." * }, * "vat_id": { * "required": true, * "description": "The entity's VAT (Value Added Tax) identification number. This field is required for entities that are VAT-registered." * } * }, * "counterpart": { * "tax_id": { * "required": false, * "description": "The counterpart's taxpayer identification number or tax ID. For identification purposes, this field may be required for counterparts that are not VAT-registered." * }, * "vat_id": { * "required": true, * "description": "The counterpart's VAT (Value Added Tax) identification number. This field is required for counterparts that are VAT-registered." * } * } * } */ ReceivableRequiredFields: { /** * @description Object describing the required fields for counterpart * @default { * "tax_id": { * "description": "The counterpart's taxpayer identification number or tax ID. For identification purposes, this field may be required for counterparts that are not VAT-registered.", * "required": false * }, * "vat_id": { * "description": "The counterpart's VAT (Value Added Tax) identification number. This field is required for counterparts that are VAT-registered.", * "required": false * } * } */ counterpart: components["schemas"]["CounterpartFields"]; /** * @description Object describing the required fields for entity * @default { * "tax_id": { * "description": "The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered.", * "required": false * }, * "vat_id": { * "description": "The entity's VAT (Value Added Tax) identification number. This field is required for entities that are VAT-registered.", * "required": false * } * } */ entity: components["schemas"]["EntityFields"]; /** * @description Object describing the required fields for line items * @default { * "measure_unit": { * "description": "Unit used to measure the quantity of the product (e.g. items, meters, kilograms)", * "required": false * }, * "tax_rate_value": { * "description": "Percent minor units. Example: 12.5% is 1250. This field is only required on invoices issued by entities in the US, Pakistan, and other unsupported countries.", * "required": false * }, * "vat_rate_id": { * "description": "Unique identifier of the vat rate object. This field is required for all entities in supported countries except the US and Pakistan.", * "required": false * } * } */ line_item: components["schemas"]["LineItemFields"]; }; ReceivableResponse: components["schemas"]["QuoteResponsePayload"] | components["schemas"]["InvoiceResponsePayload"] | components["schemas"]["CreditNoteResponsePayload"]; /** @description A schema for receiving a request for sending a receivable */ ReceivableSendRequest: { /** @description Body text of the content */ body_text: string; recipients?: components["schemas"]["Recipients"]; /** @description Subject text of the content */ subject_text: string; }; /** @description A schema for returning a response an email with a link to receivable document has been sent */ ReceivableSendResponse: { /** Format: uuid */ mail_id: string; }; /** @description Payload for sending a test reminder email */ ReceivableSendTestReminderPayload: { recipients?: components["schemas"]["Recipients"]; /** @description The type of the reminder to be sent. */ reminder_type: components["schemas"]["ReminderTypeEnum"]; }; ReceivableSettings: { create_without_personal_info: boolean; deduction_title?: string | null; }; ReceivableTemplatesVariable: { description: string; name: string; }; ReceivableTemplatesVariablesObject: { object_subtype: components["schemas"]["VariablesType"]; object_type: string; variables: components["schemas"]["ReceivableTemplatesVariable"][]; }; ReceivableTemplatesVariablesObjectList: { data: components["schemas"]["ReceivableTemplatesVariablesObject"][]; }; /** @enum {string} */ ReceivableType: "quote" | "invoice" | "credit_note"; ReceivableUncollectiblePayload: { /** @description Optional comment explains why the Invoice goes uncollectible. */ comment?: string; }; ReceivableUpdatePayload: components["schemas"]["UpdateQuotePayload"] | components["schemas"]["UpdateInvoicePayload"] | components["schemas"]["UpdateCreditNotePayload"] | components["schemas"]["UpdateIssuedInvoicePayload"]; ReceivableUpdatedEventData: Record; ReceivablesAnalyticsDataPoint: { dimension_value?: string; metric_value: number; }; ReceivablesAnalyticsResponse: { data: components["schemas"]["ReceivablesAnalyticsDataPoint"][]; }; /** @description Address information. */ ReceivablesCounterpartAddress: { /** * @description City name. * @example New York */ city: string; /** * @description Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). * @example US */ country: components["schemas"]["AllowedCountries"]; /** * @description Street address. * @example 456 Fifth Avenue */ line1: string; /** @description Additional address information (if any). */ line2?: string; /** * @description ZIP or postal code. * @example 10001 */ postal_code: string; /** @description State, region, province, or county. */ state?: string; }; /** @enum {string} */ ReceivablesPreviewTypeEnum: "receivable" | "discount_reminder" | "final_reminder"; ReceivablesRemindersWarningMessage: { /** @description Warning message for payment reminder */ payment_reminders?: string; }; ReceivablesRepresentationOfCounterpartAddress: { /** * Format: uuid * @description Unique ID of the address in the system */ id?: string; /** * @description City name. * @example New York */ city: string; /** * @description Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). * @example US */ country: components["schemas"]["AllowedCountries"]; /** * @description Street address. * @example 456 Fifth Avenue */ line1: string; /** @description Additional address information (if any). */ line2?: string; /** * @description ZIP or postal code. * @example 10001 */ postal_code: string; /** @description State, region, province, or county. */ state?: string; }; ReceivablesRepresentationOfEntityBankAccount: { /** * Format: uuid * @description Unique ID of the entity bank account. */ id?: string; /** @description Account holder's name */ account_holder_name?: string; /** @description Account number (required if IBAN is not provided) */ account_number?: string; /** @description The name of the entity's bank account. */ bank_name?: string; /** @description The BIC of the entity's bank account. */ bic?: string; /** @description The IBAN of the entity's bank account. */ iban?: string; /** @description Routing number (US) */ routing_number?: string; /** @description Sort code (GB) */ sort_code?: string; }; ReceivablesSearchRequest: { /** * Format: uuid * @description This parameter accepts a quote ID or an invoice ID. * * * Specify a quote ID to find invoices created from this quote. * * Specify an invoice ID to find credit notes created for this invoice. * * Valid but nonexistent IDs do not raise errors but produce no results. */ based_on?: string; /** * Format: uuid * @description Return only receivables created for the counterpart with the specified ID. * * Counterparts that have been deleted but have associated receivables will still return results here because the receivables contain a frozen copy of the counterpart data. * * If the specified counterpart ID does not exist and never existed, no results are returned. */ counterpart_id?: string; counterpart_id__in?: string[]; /** @description Return only receivables created for counterparts with the specified name (exact match, case-sensitive). For counterparts of `type` = `individual`, the full name is formatted as `first_name last_name`. */ counterpart_name?: string; /** @description Return only receivables created for counterparts whose name contains the specified string (case-sensitive). */ counterpart_name__contains?: string; /** @description Return only receivables created for counterparts whose name contains the specified string (case-insensitive). */ counterpart_name__icontains?: string; /** * Format: date-time * @description Return only receivables created after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss][Z|±hh:mm]`. Milliseconds are ignored. */ created_at__gt?: string; /** * Format: date-time * @description Return only receivables created on or after the specified date and time. */ created_at__gte?: string; /** * Format: date-time * @description Return only receivables created before the specified date and time. */ created_at__lt?: string; /** * Format: date-time * @description Return only receivables created before or on the specified date and time. */ created_at__lte?: string; /** @description Return only receivables with the exact specified discounted subtotal. The amount must be specified in the [minor units](https://docs.monite.com/references/currencies#minor-units) of currency. For example, $12.5 is represented as 1250. */ discounted_subtotal?: number; /** @description Return only receivables whose discounted subtotal (in minor units) is greater than the specified value. */ discounted_subtotal__gt?: number; /** @description Return only receivables whose discounted subtotal (in minor units) is greater than or equal to the specified value. */ discounted_subtotal__gte?: number; /** @description Return only receivables whose discounted subtotal (in minor units) is less than the specified value. */ discounted_subtotal__lt?: number; /** @description Return only receivables whose discounted subtotal (in minor units) is less than or equal to the specified value. */ discounted_subtotal__lte?: number; /** @description Return a receivable with the exact specified document number (case-sensitive). The `document_id` is the user-facing document number such as INV-00042, not to be confused with Monite resource IDs (`id`). */ document_id?: string; /** @description Return only receivables whose document number (`document_id`) contains the specified string (case-sensitive). */ document_id__contains?: string; /** @description Return only receivables whose document number (`document_id`) contains the specified string (case-insensitive). */ document_id__icontains?: string; /** * Format: date * @description Return invoices that are due after the specified date (exclusive, `YYYY-MM-DD`). * * This filter excludes quotes, credit notes, and draft invoices. */ due_date__gt?: string; /** * Format: date * @description Return invoices that are due on or after the specified date (`YYYY-MM-DD`). * * This filter excludes quotes, credit notes, and draft invoices. */ due_date__gte?: string; /** * Format: date * @description Return invoices that are due before the specified date (exclusive, `YYYY-MM-DD`). * * This filter excludes quotes, credit notes, and draft invoices. */ due_date__lt?: string; /** * Format: date * @description Return invoices that are due before or on the specified date (`YYYY-MM-DD`). * * This filter excludes quotes, credit notes, and draft invoices. */ due_date__lte?: string; /** * Format: uuid * @description Return only receivables created by the entity user with the specified ID. To query receivables by multiple user IDs at once, use the `entity_user_id__in` parameter instead. * * If the request is authenticated using an entity user token, this user must have the `receivable.read.allowed` (rather than `allowed_for_own`) permission to be able to query receivables created by other users. * * IDs of deleted users will still produce results here if those users had associated receivables. Valid but nonexistent user IDs do not raise errors but produce no results. */ entity_user_id?: string; entity_user_id__in?: string[]; /** @description Return only receivables that have a due date set. true=only invoices with due_date, false=only invoices without due_date */ has_due_date?: boolean; id__in?: string[]; /** * Format: date-time * @description Return only non-draft receivables that were issued after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss][Z|±hh:mm]`. Milliseconds are ignored. */ issue_date__gt?: string; /** * Format: date-time * @description Return only non-draft receivables that were issued on or after the specified date and time. */ issue_date__gte?: string; /** * Format: date-time * @description Return only non-draft receivables that were issued before the specified date and time. */ issue_date__lt?: string; /** * Format: date-time * @description Return only non-draft receivables that were issued before or on the specified date and time. */ issue_date__lte?: string; /** @default 100 */ limit: number; /** @default asc */ order: components["schemas"]["OrderEnum"]; pagination_token?: string; product_ids?: string[]; product_ids__in?: string[]; /** * Format: uuid * @description Return only receivables assigned to the project with the specified ID. Valid but nonexistent project IDs do not raise errors but return no results. */ project_id?: string; project_id__in?: string[]; /** @description Case-insensitive and partial match search for the specified text in the `document_id` and `counterpart_name` fields of the receivables. */ search_text?: string; sort?: components["schemas"]["ReceivableCursorFields2"]; /** * @description Return only receivables that have the specified status. See the applicable [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index), [quote statuses](https://docs.monite.com/accounts-receivable/quotes/index), and [credit note statuses](https://docs.monite.com/accounts-receivable/credit-notes#credit-note-lifecycle). * * To query multiple statuses at once, use the `status__in` parameter instead. * @enum {string} */ status?: "draft" | "issuing" | "issued" | "failed" | "accepted" | "expired" | "declined" | "recurring" | "partially_paid" | "paid" | "overdue" | "uncollectible" | "canceled"; status__in?: string[]; tag_ids?: string[]; tag_ids__in?: string[]; /** @description Return only receivables with the exact specified total amount. The amount must be specified in the [minor units](https://docs.monite.com/references/currencies#minor-units) of currency. For example, $12.5 is represented as 1250. */ total_amount?: number; /** @description Return only receivables whose total amount (in minor units) exceeds the specified value. */ total_amount__gt?: number; /** @description Return only receivables whose total amount (in minor units) is greater than or equal to the specified value. */ total_amount__gte?: number; /** @description Return only receivables whose total amount (in minor units) is less than the specified value. */ total_amount__lt?: number; /** @description Return only receivables whose total amount (in minor units) is less than or equal to the specified value. */ total_amount__lte?: number; /** @description Return only receivables of the specified type. Use this parameter to get only invoices, or only quotes, or only credit notes. */ type?: components["schemas"]["ReceivableType"]; }; /** @description A schema for returning a response with list of ids by which user check sending status */ ReceivablesSendResponse: { mail_ids: string[]; }; /** * @description This Enum the results of combining two types of statuses from * QuoteStateEnum, CreditNoteStateEnum and InvoiceStateEnum. You shouldn't use * it in your scenarios if only for edge cases in workers, but ideally need to * remove this shared Enum. * @enum {string} */ ReceivablesStatusEnum: "draft" | "issuing" | "issued" | "failed" | "accepted" | "expired" | "declined" | "recurring" | "partially_paid" | "paid" | "overdue" | "uncollectible" | "canceled" | "deleted"; /** @description A schema for returning a response with validation results */ ReceivablesVerifyResponse: { /** @description Missing fields of receivable */ errors?: components["schemas"]["MissingFields"]; /** @description Warning message for payment reminder */ warnings?: components["schemas"]["ReceivablesRemindersWarningMessage"]; }; Recipient: { /** Format: uuid */ id: string; type: components["schemas"]["RecipientType"]; }; RecipientAccountResponse: { /** * Format: uuid * @description ID of a payment account */ id: string; /** @description List of bank accounts */ bank_accounts?: components["schemas"]["BankAccount"][]; /** @description Display name of a payment account */ name?: string; /** @description Type of a payment account. Can be `entity` or `counterpart` */ type: components["schemas"]["PaymentAccountType"]; }; RecipientAccountResponse2: { /** * Format: uuid * @description ID of a payment account */ id: string; /** @description List of authorized bank accounts */ authorized_bank_accounts?: components["schemas"]["AuthorizedBankAccount"][]; /** @description List of bank accounts */ bank_accounts?: components["schemas"]["BankAccount"][]; /** @description Display name of a payment account */ name?: string; /** @description Type of a payment account. Can be `entity` or `counterpart` */ type: components["schemas"]["PaymentAccountType"]; }; /** @enum {string} */ RecipientType: "entity" | "counterpart"; Recipients: { bcc?: string[]; cc?: string[]; to?: string[]; }; RecipientsInfo: { /** @default [] */ bcc: string[]; /** @default [] */ cc: string[]; /** @default [] */ to: string[]; }; /** @enum {string} */ RecurrenceFrequency: "day" | "week" | "month" | "quarter" | "year"; RecurrenceIteration: { /** Format: date */ issue_at: string; /** Format: uuid */ issued_invoice_id?: string; /** @default 1 */ iteration: number; status: components["schemas"]["IterationStatus"]; }; RecurrenceResponse: { /** Format: uuid */ id: string; /** * Format: date-time * @description Time at which the recurrence was created. Timestamps follow the ISO 8601 standard. */ created_at: string; /** * Format: date-time * @description Time at which the recurrence was last updated. Timestamps follow the ISO 8601 standard. */ updated_at: string; /** * @description Controls how invoices are processed when generated: * - "draft": Creates invoices in draft status, requiring manual review, issuing, and sending * - "issue": Automatically issues invoices but requires manual sending * - "issue_and_send": Fully automates the process (creates, issues, and sends invoices) * * Default: "issue" (or "issue_and_send" if subject_text and body_text are provided) * * Note: When using "issue_and_send", both subject_text and body_text must be provided. */ automation_level: components["schemas"]["AutomationLevel"]; /** @description The body text for the email that will be sent with the recurring invoice. */ body_text?: string; /** @description Current iteration number */ current_iteration: number; /** * @deprecated * @description Deprecated, use `start_date` instead */ day_of_month: components["schemas"]["DayOfMonth"]; /** * Format: date * @description The end date of the recurring invoice, in the `yyyy-mm-dd` format. The end date is inclusive, that is, the last invoice will be created on this date if the last occurrence falls on this date. `end_date` is mutually exclusive with `max_occurrences`. Either `end_date` or `max_occurrences` must be specified. */ end_date?: string; /** * @deprecated * @description Deprecated, use `end_date` instead */ end_month?: number; /** * @deprecated * @description Deprecated, use `end_date` instead */ end_year?: number; /** @description How often the invoice will be created. */ frequency: components["schemas"]["RecurrenceFrequency"]; /** @description The interval between each occurrence of the invoice. For example, when using monthly frequency, an interval of 1 means invoices will be created every month, an interval of 2 means invoices will be created every 2 months. */ interval: number; /** * Format: uuid * @description ID of the base invoice that will be used as a template for creating recurring invoices. */ invoice_id: string; /** @description List of iterations for the recurrence */ iterations: components["schemas"]["RecurrenceIteration"][]; /** @description How many times the recurring invoice will be created. The recurrence will stop after this number is reached. `max_occurrences` is mutually exclusive with `end_date`. Either `max_occurrences` or `end_date` must be specified. */ max_occurrences?: number; /** @description An object containing the recipients (To, CC, BCC) of the recurring invoices. Can be omitted if the base invoice has the counterpart contact email specified in the `counterpart_contact.email` field. */ recipients?: components["schemas"]["Recipients"]; /** * Format: date * @description The date when the first invoice will be created, in the `yyyy-mm-dd` format. Cannot be a past date. Subsequent invoice dates will be calculated based on `start_date`, `frequency`, and `interval`. */ start_date: string; /** * @deprecated * @description Deprecated, use `start_date` instead */ start_month: number; /** * @deprecated * @description Deprecated, use `start_date` instead */ start_year: number; /** * @description Status of the recurrence * @example active * @example canceled * @example completed */ status: components["schemas"]["RecurrenceStatus"]; /** @description The subject for the email that will be sent with the recurring invoice. */ subject_text?: string; }; RecurrenceResponseList: { data: components["schemas"]["RecurrenceResponse"][]; }; /** * @description Represents the status of a recurrence * * Allowed transitions: * - active -> paused * - active -> canceled * - active -> completed * - paused -> active * - paused -> canceled * @enum {string} */ RecurrenceStatus: "active" | "paused" | "canceled" | "completed"; RegulatoryTemplateRequest: { counterpart: components["schemas"]["CounterpartSchema"]; entity: components["schemas"]["EntitySchema"]; product: components["schemas"]["ProductFieldsEnum"][]; receivable: components["schemas"]["ReceivableFieldsEnum"][]; }; /** * @example { * "id": "f9c78ae8-5fd7-41fa-a37a-04969a08f2c7", * "requirements": { * "receivable": [ * "line_items", * "amount", * "currency", * "total_tax_amount" * ], * "entity": { * "organization": [ * "name", * "address", * "email", * "tax_id", * "vat_id" * ], * "individual": [ * "first_name", * "last_name", * "address", * "email", * "tax_id", * "vat_id" * ] * }, * "counterpart": { * "organization": [ * "legal_name", * "address", * "email", * "vat_id" * ], * "individual": [ * "first_name", * "last_name", * "address", * "email", * "tax_id" * ] * }, * "product": [ * "name", * "price", * "currency", * "quantity", * "description", * "measure_unit", * "tax_rate" * ] * } * } */ RegulatoryTemplateResponse: { /** * Format: uuid * @description Regulatory Settings ID */ id: string; /** @description Components receivable|entity|counterpart|product */ requirements: Record; }; RelatedDocuments: { credit_note_ids?: string[]; /** Format: uuid */ proforma_invoice_id?: string; }; RelatedOrganizationSummaryDto: { /** * Format: uuid * @description The unique identifier of the organization. */ id: string; /** @description URL to fetch full details of this organization. */ detailsUrl: string; /** @description The display name of the organization. */ displayName: string; /** @description Whether the organization is currently enabled. */ isEnabled: boolean; /** @description The MCCs (Merchant Category Codes) allowed for this organization. */ mccsAllowed: string[]; /** @description The types assigned to the organization. */ types: components["schemas"]["OrganizationType"][]; }; /** * @description Public response DTO for GET /identity/v1/organizations. * Distinct from the shared OrganizationSummaryDto on purpose: * the shared one carries metadata (routing number, FIS/TSYS references) that internal callers like the * daily balance export job need, but no public consumer reads — keeping it off the public response keeps * banking/cardholder references out of the public OpenAPI surface. */ RelatedOrganizationsResponseDto: { /** @description The list of organizations. */ data: components["schemas"]["RelatedOrganizationSummaryDto"][]; /** * @description A token to pass as pagination_token to get the next page of results. * Null if there are no more pages after this one. */ nextPaginationToken?: null | string; /** * @description Parent organizations of the specified organization filter. * Populated when either the organizationId or parentOrganizationId query parameter is provided. */ parentOrganizations?: null | components["schemas"]["ParentOrganizationSummaryDto"][]; /** * @description A token to pass as pagination_token to get the previous page of results. * Null if this is the first page. */ prevPaginationToken?: null | string; }; /** @description Summary information for a user from a related organization. */ RelatedUserDto: { /** Format: uuid */ id: string; /** Format: date-time */ createdDateTime: string; department?: null | components["schemas"]["UserDepartmentDto"]; email: string; isExpenseApprover: boolean; jobTitle?: null | string; /** Format: date-time */ lastLoggedInDateTime?: null | string; location?: null | components["schemas"]["UserLocationDto"]; name: string; /** Format: uuid */ organizationId: string; organizationName: string; /** Format: uuid */ reportingManagerUserId?: null | string; role?: null | string; status: string; }; /** @description Response DTO for listing users from related organizations. */ RelatedUsersListResponseDto: { data: components["schemas"]["RelatedUserDto"][]; /** * @description A token to pass as pagination_token to get the next page of results. * Null if there are no more pages after this one. */ nextPaginationToken?: null | string; /** * @description A token to pass as pagination_token to get the previous page of results. * Null if this is the first page. */ prevPaginationToken?: null | string; }; Reminder: { body: string; days_before: number; subject: string; }; /** @description Contains information about an invoice reminder sent via email. */ ReminderMailSentEventData: { /** * Format: uuid * @description ID of the email sending operation. Can be used to get the email sending status from `GET /receivables/{receivable_id}/mails/{mail_id}`. * @example d6185c8d-527c-4586-84c9-95881e7ba19f */ mail_id: string; /** @description The overall email sending status across all recipients. */ mail_status: components["schemas"]["ReceivableMailStatusEnum"]; /** @description Contains a list of email recipients (To, CC, BCC) and the email sending status for each recipient. */ recipients: components["schemas"]["ReceivableMailRecipients"]; /** * @description Invoice reminder type: * * * `term_1` - [payment reminder](https://docs.monite.com/accounts-receivable/invoices/payment-reminders) sent before discount date 1, * * `term_2` - payment reminder sent before discount date 2, * * `term_final` - payment reminder sent before the invoice due date. * * `overdue` - [overdue reminder](https://docs.monite.com/accounts-receivable/invoices/overdue-reminders) sent after the due date. */ term: components["schemas"]["ReminderTypeEnum"]; }; /** @enum {string} */ ReminderTypeEnum: "term_1" | "term_2" | "term_final" | "overdue"; RemindersSettings: { /** @default true */ enabled: boolean; }; RenderPdfRequest: { /** * Format: uuid * @description Optional field, needed to associate this specific PDF with the corresponding change */ change_id?: string; fields?: components["schemas"]["FileUrlType"][]; /** @description Name of the generated file without extension */ file_name?: string; object_id: string; /** @description Object type related to object_id, e.g. payable, payables_credit_note, etc */ object_type?: components["schemas"]["ObjectType"]; payload: components["schemas"]["ReceivableRenderPayload"] | components["schemas"]["DeliveryNoteRenderPayload"] | components["schemas"]["PurchaseOrderRenderPayload"] | components["schemas"]["PayableRenderPayload"]; }; RenderTemplateResponse: { body: string; subject: string; }; /** @description Repayment schedule model */ RepaymentSchedule: { /** @description Repayment amount in minor units */ repayment_amount: number; /** @description Repayment date in ISO 8601 format */ repayment_date: string; /** @description Repayment fee amount in minor units */ repayment_fee_amount: number; /** @description Repayment principal amount in minor units */ repayment_principal_amount: number; }; RequirementsError: { code: string; reason: string; requirement: string; }; ResetDocumentIdRequest: { /** Format: uuid */ entity_id: string; object_type: string; starts_with: number; }; ResponseItem: { /** @description The discount for a product. */ discount?: components["schemas"]["Discount"]; product: components["schemas"]["LineItemProduct"]; /** @description The quantity of each of the goods, materials, or services listed in the receivable. */ quantity: number; /** * @description Tax applicability status of the line item. Possible values: * * * `taxable` (default) - Standard tax behavior. Requires the tax rate to be specified. * * `exempt` - Line item is exempt from taxes. Exempt items are not included in total tax calculations. * * `non_taxable` - Line item is outside the tax scope entirely, cannot have tax rates. * @default taxable */ tax_status: components["schemas"]["TaxStatusEnum"]; /** @description Total of line_item after tax with applied line item discount in [minor units](https://docs.monite.com/references/currencies#minor-units). */ total_after_tax: number; /** @description Total of line_item before tax in [minor units](https://docs.monite.com/references/currencies#minor-units). */ total_before_tax: number; }; ResumeApplicationRequest: { email: string; }; ResumeApplicationResponse: { acknowledged: boolean; }; /** @enum {string} */ RoleCursorFields: "updated_at" | "created_at"; RoleMemberResponseDto: { /** Format: date-time */ assignedDateTime: string; email: string; name: string; status: string; /** Format: uuid */ userId: string; }; RolePaginationResponse: { /** @description array of records */ data: components["schemas"]["RoleResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string | null; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string | null; }; RolePermissionResponseDto: { /** Format: uuid */ id: string; description?: null | string; key: string; name: string; }; RolePermissionsListResponse: { data: components["schemas"]["RolePermissionResponseDto"][]; }; RoleResponse: { /** * Format: uuid * @description UUID role ID */ id: string; /** * Format: date-time * @description UTC datetime */ created_at: string; /** * Format: date-time * @description UTC datetime */ updated_at: string; /** @description Role name */ name: string; /** @description Access permissions */ permissions: components["schemas"]["BizObjectsSchema-Output"]; /** @description record status, 'active' by default */ status: components["schemas"]["StatusEnum"]; }; RoleResponseDto: { /** Format: uuid */ id: string; appliesToOrgType?: null | string; /** Format: date-time */ createdDateTime: string; description?: null | string; icon?: null | string; isSystemRole?: boolean; key: components["schemas"]["SystemRoleKey"] | string; name: string; /** Format: uuid */ organizationId?: null | string; status: string; /** Format: date-time */ updatedDateTime: string; }; "RootSchema-Input": components["schemas"]["CommonSchema-Input"] | components["schemas"]["PayableSchema-Input"]; "RootSchema-Output": components["schemas"]["CommonSchema-Output"] | components["schemas"]["PayableSchema-Output"]; /** @description Request model for initiating an RTP (Real-Time Payments) money movement. */ RtpMoneyMovementRequest: { /** * Format: int64 * @description Amount to transfer. Must be greater than 0. */ amount: number | string; /** * @description ISO 4217 alphabetic currency code (e.g. `USD`). Defaults to `USD` when omitted. * Determines the minor unit precision of long RtpMoneyMovementRequest.Amount. * @default USD */ currencyCode: string; /** * Format: uuid * @description Source bank account identifier. */ fromBankAccountId: string; /** * @description Optional idempotency key for preventing duplicate transfers. * Maximum length: 256 characters. */ idempotencyKey?: null | string; /** * Format: uuid * @description Destination bank account identifier. */ toBankAccountId: string; }; RuleRequest: { /** * @description Object type for the rule * @enum {string} */ object_type: "receivable"; /** @description Predicates for the rule object */ predicates: components["schemas"]["Predicate"][]; /** * Format: uuid * @description The returned object, regulatory settings ID */ result_value_id: string; /** @description One of the vat condition types: entity country, counterpart country, 0 */ vat_condition: components["schemas"]["VatConditionType"]; }; RuleResponse: { /** * Format: uuid * @description Unique identifier of the rule object */ id: string; /** * Format: date-time * @description Time at which the rule was created. Timestamps follow the ISO 8601 standard. */ created_at: string; /** * Format: date-time * @description Time at which the rule was last updated. Timestamps follow the ISO 8601 standard. */ updated_at: string; /** * @description Object type for the rule * @enum {string} */ object_type: "receivable"; /** @description Predicates for the rule object */ predicates: components["schemas"]["PredicateResponse"][]; /** * Format: uuid * @description The returned object, regulatory settings ID */ result_value_id: string; /** @description The status of the rule object */ status: components["schemas"]["StatusEnum"]; /** @description One of the vat condition types: entity country, counterpart country, 0 */ vat_condition: components["schemas"]["VatConditionType"]; }; RuleUpdate: { /** * @description Object type for the rule * @enum {string} */ object_type?: "receivable"; /** @description Predicates for the rule object */ predicates?: components["schemas"]["Predicate"][]; /** * Format: uuid * @description The returned object, regulatory settings ID */ result_value_id?: string; /** @description One of the vat condition types: entity country, counterpart country, 0 */ vat_condition?: components["schemas"]["VatConditionType"]; }; SCAMethod: { id: string; description?: string; information?: string; type: components["schemas"]["SCAMethodType"]; }; /** @enum {string} */ SCAMethodType: "SMS_OTP" | "CHIP_OTP" | "PHOTO_OTP" | "PUSH_OTP"; SendEmailByDocumentSchema: { /** * @description Switcher for enabling pdf document attachment * @default true */ attach_documents_as_pdf: boolean; /** @description Link to additional documents that should be attached. */ attachment_urls?: string[]; /** @description Body text of the template */ body: string; /** @description Key/value variables for putting in the template */ data: { [key: string]: string; }; /** @description Document type of content */ document_type: components["schemas"]["DocumentObjectTypeRequestEnum"]; /** * Format: uuid * @description Entity ID */ entity_id: string; /** @description Lowercase ISO code of language */ language: components["schemas"]["LanguageCodeEnum"]; /** * Format: uuid * @description Partner ID */ partner_id?: string; recipients_info: components["schemas"]["RecipientsInfo"]; /** @description Subject text of the template */ subject: string; }; SendEmailByDocumentTypeResponse: { data?: components["schemas"]["Email"][]; }; SendEmailSchema: { /** @description Dictionary of Mandatory URL and Custom name for attachment */ attachments?: { [key: string]: string; }; /** * Format: uuid * @description Entity ID */ entity_id: string; /** * Format: uuid * @description External user ID */ external_user_id?: string; /** @description Lowercase ISO code of language */ language_code: components["schemas"]["LanguageCodeEnum"]; /** * Format: uuid * @description Partner ID */ partner_id: string; /** @description The names of email recipients */ recipients: string[]; /** Format: email */ sender?: string; /** @description Payload that corresponds with template_name (pydantic.Model with required parameters) */ template_data?: Record; /** @description The name of email template to send */ template_name: string; }; /** @description A schema for request for sending purchase order via email */ SendPurchaseOrderViaEmailRequest: { body_text: string; subject_text: string; }; SendStatelessEmailSchema: { /** @description Dictionary of Mandatory URL and Custom name for attachment */ attachments?: { [key: string]: string; }; /** @description The names of email recipients */ recipients: string[]; /** * Format: email * @description The name of sender email */ sender: string; /** @description Email subject and body JINJA2 templates */ template: components["schemas"]["Template"]; /** @description Payload that corresponds with template_name (pydantic.Model with required parameters) */ template_data?: Record; }; /** @enum {string} */ ServiceProvidersEnum: "codat" | "railz"; SetScaCodePayload: { application_user_id: string; /** @description Confirmation code that the user received from the bank via the selected SCA method. */ sca_code: string; }; SetScaMethodPayload: { application_user_id: string; /** @description Identifier of SCA method obtained during the initialization of the embedded session. */ sca_method_id: string; }; SettingsResponse: { accounting?: components["schemas"]["AccountingSettings"] | null; /** * @description Automatically attempt to find a corresponding purchase order for all incoming payables. * @default true */ allow_purchase_order_autolinking: boolean | null; currency?: components["schemas"]["CurrencySettings-Output2"] | null; /** @description The organization's single global default bank account. Clients use it to pre-fill the bank account field when creating receivables; it is not applied automatically on the server. Set to `null` to clear it. */ default_bank_account?: components["schemas"]["DefaultBankAccount"] | null; document_ids?: components["schemas"]["DocumentIDsSettings"] | null; /** @description Settings for rendering documents in PDF format. */ document_rendering?: components["schemas"]["DocumentRenderingSettings-Output"]; /** * @description This setting affects how PDF is generated for paid accounts receivable invoices. If set to `true`, once an invoice is fully paid its PDF version is updated to display the amount paid and the payment-related features are removed. * * The PDF file gets regenerated at the moment when an invoice becomes paid. It is not issued as a separate document, and the original PDF invoice is no longer available. * * This field is deprecated and will be replaced by `document_rendering.invoice.generate_paid_invoice_pdf`. * @default false */ generate_paid_invoice_pdf: boolean; language?: components["schemas"]["LanguageCodeEnum"] | null; /** @description Email settings for the entity */ mail?: components["schemas"]["EntityMailSettings"] | null; /** @description Auto tagging settings for all incoming OCR payable documents. */ payables_ocr_auto_tagging?: components["schemas"]["OcrAutoTaggingSettingsRequest"][] | null; /** * @description If enabled, the approval policy will be skipped and the payable will be moved to `waiting_to_be_paid` status. * @default false */ payables_skip_approval_flow: boolean; /** * @description Payment preferences for entity to automate calculating suggested payment date based on payment terms and entity preferences. * @default working_capital */ payment_priority: components["schemas"]["PaymentPriorityEnum"] | null; /** * @description Sets the default behavior of whether a signature is required to accept quotes. * @default false */ quote_signature_required: boolean; /** @default compliant */ receivable_edit_flow: components["schemas"]["ReceivableEditFlow"] | null; reminder?: components["schemas"]["RemindersSettings"] | null; /** * @description Defines whether the amount discounts (for percentage discounts it does not matter) on tax inclusive invoices will be applied on amounts including tax or excluding tax. * @default exclusive */ tax_inclusive_discount_mode: components["schemas"]["VatModeEnum"]; /** * @description Defines whether the prices of products in receivables will already include tax or not. * @default exclusive */ tax_mode: components["schemas"]["VatModeEnum"] | null; }; Signature: { /** * Format: email * @description The email of a person who signed a quote */ email: string; /** @description The full name of a person who signed a quote */ full_name: string; /** @description Base64 encoded PNG image of a signature */ signature_image: string; }; SignatureBlock: { email?: string; email_label?: string; full_name?: string; full_name_label?: string; signature_header?: string; signature_image_src?: string; /** @default Signature */ signature_label: string; signed_at?: string; /** @default Date, location */ signed_at_label: string; }; SingleAmountPredicate: { /** * @description Predicate name * @enum {string} */ name: "amount"; /** * @description Predicate operator (enum property replaced by openapi-typescript) * @enum {string} */ operator: "EQ" | "NEQ" | "GT" | "GTE" | "LT" | "LTE"; /** @description Predicate comparison value */ value: number; }; SingleCountryPredicate: { /** * @description Predicate name * @enum {string} */ name: "entity_country" | "counterpart_country" | "entity_vat_country" | "counterpart_vat_country"; /** * @description Predicate operator (enum property replaced by openapi-typescript) * @enum {string} */ operator: "EQ" | "NEQ"; /** @description Predicate comparison value */ value: components["schemas"]["AllowedCountries"]; }; SingleItemTypePredicate: { /** * @description Predicate name * @enum {string} */ name: "item_type"; /** * @description Predicate operator (enum property replaced by openapi-typescript) * @enum {string} */ operator: "EQ" | "NEQ"; /** @description Predicate comparison value */ value: components["schemas"]["ProductServiceTypeEnum"]; }; SinglePaymentIntent: { object: components["schemas"]["PaymentObjectPayable"]; /** @description Must be provided if payable's document id is missing. */ payment_reference?: string; recipient: components["schemas"]["PaymentIntentsRecipient"]; }; SinglePaymentIntentResponse: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; amount: number; currency: components["schemas"]["CurrencyEnum"]; error?: Record; object: components["schemas"]["PaymentObjectPayable"]; payment_reference: string; recipient: components["schemas"]["PaymentIntentsRecipient"]; status: string; }; SourceOfData: { /** @description Source of department_id. */ department_id?: components["schemas"]["FieldSourceEnum"]; /** @description Source of description. */ description?: components["schemas"]["FieldSourceEnum"]; /** @description Source of ledger_account_id. */ ledger_account_id?: components["schemas"]["FieldSourceEnum"]; /** @description Source of location_id. */ location_id?: components["schemas"]["FieldSourceEnum"]; /** @description Source of receipt_id. */ receipt_id?: components["schemas"]["FieldSourceEnum"]; }; /** @enum {string} */ SourceOfPayableDataEnum: "ocr" | "user_specified" | "einvoicing"; /** @enum {string} */ SourceOfReceiptDataEnum: "ocr" | "user_specified"; StatusChangedEventData: { approval_policy_id?: string; approval_policy_name?: string; approval_policy_process_id?: string; approval_request_id?: string; /** @description How the decision was made: 'policy' when driven by an approval policy, otherwise 'force'. */ approval_source?: string; /** @description The expense status after the transition. */ new_status: components["schemas"]["ExpenseStatusEnum"]; /** @description The expense status before the transition. Null for migrated rows. */ old_status?: components["schemas"]["ExpenseStatusEnum"]; /** @description Reason for rejection, if applicable. */ reject_reason?: string; }; /** @enum {string} */ StatusEnum: "active" | "deleted"; /** @enum {string} */ StorecoveEvent: "received" | "failed"; /** @enum {string} */ StorecoveEventGroup: "invoice" | "unknown"; /** @enum {string} */ StorecoveEventType: "received_document"; StorecoveNewDocumentReceivedEventPayload: { /** Format: uuid */ document_guid?: string; event: components["schemas"]["StorecoveEvent"]; event_group: components["schemas"]["StorecoveEventGroup"]; event_type: components["schemas"]["StorecoveEventType"]; /** Format: uuid */ receive_guid?: string; }; StripeData: { publishable?: string; secret: string; }; SuccessResult: { /** @default true */ success: boolean; }; SuggestedCounterpartPayload: { /** Format: uuid */ id: string; /** Format: uuid */ address_id?: string; /** Format: uuid */ bank_account_id?: string; /** Format: uuid */ vat_id_id?: string; }; /** @description Suggested payment date and corresponding discount */ SuggestedPaymentTerm: { /** Format: date */ date: string; discount?: number; }; SuggestedResponse: { suggested_counterpart: components["schemas"]["SuggestedCounterpartPayload"]; }; /** @enum {string} */ SupportedFieldNames: "default_account_code" | "default_tax_rate_code"; SupportedFormatSchema: { available_types: { [key: string]: components["schemas"]["ExportFormat"][]; }; /** @enum {string} */ object_type: "payable" | "receivable"; }; /** @enum {string} */ SupportedPaymentAuthorizationFlow: "redirect" | "embedded"; /** @enum {string} */ SyncRecordCursorFields: "created_at" | "updated_at"; SyncRecordResource: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; errors?: Record; /** Format: date-time */ last_pulled_at: string; /** Format: uuid */ object_id?: string; object_type: components["schemas"]["ObjectMatchTypes"]; /** Format: date-time */ object_updated_at?: string; platform?: components["schemas"]["Platform"]; platform_object_id?: string; /** Format: date-time */ platform_updated_at?: string; provider?: components["schemas"]["ServiceProvidersEnum"]; provider_object_id?: string; /** Format: date-time */ provider_updated_at?: string; sync_status: components["schemas"]["SyncStatus"]; }; SyncRecordResourceList: { data: components["schemas"]["SyncRecordResource"][]; /** * @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). * @example eyJvcmRlciI6ImFzYyIsImxpbWl0IjoyLCJwYWdpbmF0aW9uX2ZpbHRlcnMiOnsiZW50aXR5X2lkIjoiOWQyYjRjOGYtMjA4Ny00NzM4LWJhOTEtNzM1OTY4M2M0OWE0In0sInBhZ2luYXRpb25fdG9rZW5fdHlwZSI6Im5leHQiLCJjdXJzb3JfZmllbGQiOm51bGwsImN1cnNvcl9maWVsZF92YWx1ZSI6bnVsbCwiY3VycmVudF9vaWQiOjR9 */ next_pagination_token?: string; /** * @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). * @example eyJvcmRlciI6ImFzYyIsImxpbWl0IjoyLCJwYWdpbmF0aW9uX2ZpbHRlcnMiOnsiZW50aXR5X2lkIjoiOWQyYjRjOGYtMjA4Ny00NzM4LWJhOTEtNzM1OTY4M2M0OWE0In0sInBhZ2luYXRpb25fdG9rZW5fdHlwZSI6Im5leHQiLCJjdXJzb3JfZmllbGQiOm51bGwsImN1cnNvcl9maWVsZF92YWx1ZSI6bnVsbCwiY3VycmVudF9vaWQiOjR9 */ prev_pagination_token?: string; }; /** @enum {string} */ SyncStatus: "pending" | "error" | "done"; /** @enum {string} */ SystemRoleKey: "admin" | "bookkeeper" | "cfo" | "employee"; SystemTemplateDataSchema: { /** @description Array of templates */ available_templates: components["schemas"]["TemplateDataSchema"][]; /** @description Name of the template */ template_name: string; }; SystemTemplates: { /** @description All pre-defined email templates */ data: components["schemas"]["SystemTemplateDataSchema"][]; }; /** @enum {string} */ TagCategory: "document_type" | "department" | "project" | "cost_center" | "vendor_type" | "payment_method" | "approval_status"; TagCreateSchema: { /** * @description The tag category. * @example department */ category?: components["schemas"]["TagCategory"]; /** * @description The tag description. * @example Tag for the Marketing Department */ description?: string; /** * @description The tag name. Must be unique. * @example Marketing */ name: string; }; /** @enum {string} */ TagCursorFields: "created_at" | "updated_at"; /** @description Represents a user-defined tag that can be assigned to resources to filter them. */ TagReadSchema: { /** * Format: uuid * @description A unique ID of this tag. * @example ea837e28-509b-4b6a-a600-d54b6aa0b1f5 */ id: string; /** * Format: date-time * @description Date and time when the tag was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. * @example 2022-09-07T16:35:18.484507+00:00 */ created_at: string; /** * Format: date-time * @description Date and time when the tag was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard. * @example 2022-09-07T16:35:18.484507+00:00 */ updated_at: string; /** * @description The tag category. * @example department */ category?: components["schemas"]["TagCategory"]; /** * Format: uuid * @description ID of the user who created the tag. * @example ea837e28-509b-4b6a-a600-d54b6aa0b1f5 */ created_by_entity_user_id?: string; /** * @description The tag description. * @example Tag for the Marketing Department */ description?: string; /** * @description The tag name. * @example Marketing */ name: string; }; TagUpdateSchema: { /** * @description The tag category. * @example department */ category?: components["schemas"]["TagCategory"]; /** * @description The tag description. * @example Tag for the Marketing Department */ description?: string; /** * @description The tag name. Must be unique. * @example Marketing */ name?: string; }; /** @description A paginated list of tags. */ TagsPaginationResponse: { data: components["schemas"]["TagReadSchema"][]; /** * @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). * @example eyJvcmRlciI6ImFzYyIsImxpbWl0IjoyLCJwYWdpbmF0aW9uX2ZpbHRlcnMiOnsiZW50aXR5X2lkIjoiOWQyYjRjOGYtMjA4Ny00NzM4LWJhOTEtNzM1OTY4M2M0OWE0In0sInBhZ2luYXRpb25fdG9rZW5fdHlwZSI6Im5leHQiLCJjdXJzb3JfZmllbGQiOm51bGwsImN1cnNvcl9maWVsZF92YWx1ZSI6bnVsbCwiY3VycmVudF9vaWQiOjR9 */ next_pagination_token?: string; /** * @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). * @example eyJvcmRlciI6ImFzYyIsImxpbWl0IjoyLCJwYWdpbmF0aW9uX2ZpbHRlcnMiOnsiZW50aXR5X2lkIjoiOWQyYjRjOGYtMjA4Ny00NzM4LWJhOTEtNzM1OTY4M2M0OWE0In0sInBhZ2luYXRpb25fdG9rZW5fdHlwZSI6Im5leHQiLCJjdXJzb3JfZmllbGQiOm51bGwsImN1cnNvcl9maWVsZF92YWx1ZSI6bnVsbCwiY3VycmVudF9vaWQiOjR9 */ prev_pagination_token?: string; }; TaxComponentResponse: { /** @description A flag to indicate with the tax is calculated using the principle of compounding. */ is_compound?: boolean; name?: string; /** @description Component tax rate in percent [minor units](https://docs.monite.com/references/currencies#minor-units). Example: 12.5% is 1250. */ rate?: number; }; /** @description Response DTO for masked tax identification data. */ TaxIdResponseDto: { /** @description The masked tax ID value showing only the last 2 digits (e.g., "*****34"). */ maskedTaxId: string; /** @description The type of tax ID (e.g., EIN, SSN). */ taxIdType: string; }; /** @description Input model for Tax Identification Number. */ TaxIdentificationNumberInput: { type?: null | components["schemas"]["TaxIdentificationNumberType"]; /** @description The tax identification number value. */ value?: null | string; }; /** @enum {string} */ TaxIdentificationNumberType: "EIN" | "SSN" | "TIN"; /** @enum {string} */ TaxRateAccountCursorFields: "name"; /** @enum {string} */ TaxRateAccountCursorFields2: "name"; /** @enum {string} */ TaxStatusEnum: "taxable" | "exempt" | "non_taxable"; Template: { /** @description Email body JINJA2 template */ body_template: string; /** @description Email subject JINJA2 template */ subject_template: string; }; TemplateDataSchema: { /** @description Jinja2 compatible email body template */ body_template: string; /** @description Lowercase ISO code of language */ language: string; /** @description Jinja2 compatible email subject template */ subject_template: string; }; TemplateDocumentTypeSchema: { /** @description Body text of the template */ body: string; /** @description Key/value variables for putting in the template */ data: { [key: string]: string; }; /** @description Document type of content */ document_type: components["schemas"]["DocumentObjectTypeRequestEnum"]; /** * Format: uuid * @description Entity ID */ entity_id: string; /** @description Lowercase ISO code of language */ language: components["schemas"]["LanguageCodeEnum"]; /** * Format: uuid * @description Partner ID */ partner_id?: string; /** @description Subject text of the template */ subject: string; }; TemplateListResponse: { data?: components["schemas"]["TemplateReceivableResponse"][]; }; TemplateReceivableResponse: { /** Format: uuid */ id: string; /** Format: date-time */ created_at?: string; /** Format: date-time */ updated_at?: string; blocks?: string[]; document_type: components["schemas"]["PdfDocumentTypeEnum"]; is_default: boolean; language: string; name: string; preview?: components["schemas"]["FileResponse"]; template: string; /** @default source_object */ template_type: components["schemas"]["TemplateTypeEnum"]; }; /** @enum {string} */ TemplateTypeEnum: "block" | "source_object"; TermDiscountDays: { /** @description The discount percentage in minor units. E.g., 200 means 2%. 1050 means 10.5%. */ discount: number; /** @description The amount of days after the invoice issue date. */ number_of_days: number; }; TermFinalDays: { /** @description The amount of days after the invoice issue date. */ number_of_days: number; }; "TermsOfServiceAcceptance-Input": { /** @description The date and time (in the ISO 8601 format) when the entity representative accepted the service agreement. */ date?: string | null; /** * @description The IP address from which the entity representative accepted the service agreement. If omitted or set to `null` in the request, the IP address is inferred from the request origin or the `X-Forwarded-For` request header. * @example 203.0.113.24 */ ip?: string | null; }; "TermsOfServiceAcceptance-Output": { /** @description The date and time (in the ISO 8601 format) when the entity representative accepted the service agreement. */ date?: string | null; /** * @description The IP address from which the entity representative accepted the service agreement. If omitted or set to `null` in the request, the IP address is inferred from the request origin or the `X-Forwarded-For` request header. * @example 203.0.113.24 */ ip?: string | null; }; TesouroData: { link_token: string; payment_link_id: string; }; TesouroPaymentIntentData: { link_token: string; payment_link_id: string; }; /** @enum {string} */ TextTemplateDocumentTypeEnum: "quote" | "invoice" | "credit_note" | "discount_reminder" | "final_reminder" | "payables_purchase_order" | "overdue_reminder"; TextTemplateResponse: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; document_type: components["schemas"]["TextTemplateDocumentTypeEnum"]; is_default: boolean; name: string; template: string; type: components["schemas"]["TextTemplateType"]; }; TextTemplateResponseList: { data: components["schemas"]["TextTemplateResponse"][]; next_pagination_token?: string; prev_pagination_token?: string; }; /** @enum {string} */ TextTemplateType: "email_header" | "email_body" | "memo"; TotalTaxAmountItem: { /** Format: uuid */ id?: string; /** @description The total tax of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). */ amount: number; /** @description Sub-taxes included in the VAT. */ components?: components["schemas"]["TotalTaxAmountItemComponent"][]; /** @description Display name of the tax rate. */ name?: string; /** @description The amount on which this VAT is calculated, in [minor units](https://docs.monite.com/references/currencies#minor-units). */ taxable_amount: number; /** @description Percent minor units. Example: 12.5% is 1250. */ value: number; }; TotalTaxAmountItemComponent: { /** @description The total tax of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units). */ amount: number; name: string; /** @description Percent minor units. Example: 12.5% is 1250. */ value: number; }; TransactionAnalyticsResponse: { data: components["schemas"]["AnalyticsDataPoint"][]; }; TransactionBulkObject: { /** * Format: uuid * @description A unique Monite-generated ID assigned to the created transaction. */ id?: string; }; TransactionBulkRequest: { /** @description A list of transactions to create. */ data: components["schemas"]["TransactionRequest"][]; }; TransactionBulkResponse: { data: components["schemas"]["TransactionBulkObject"][]; /** @description The overall status of the bulk creation operation. */ status: components["schemas"]["TransactionBulkStatusEnum"]; }; /** @enum {string} */ TransactionBulkStatusEnum: "success" | "partial_success" | "error"; /** @enum {string} */ TransactionCursorFields: "created_at" | "updated_at" | "started_at" | "amount" | "merchant_amount" | "merchant_name" | "status" | "type" | "external_id"; /** @enum {string} */ TransactionDimensionEnum: "expense_status" | "payment_processing_status" | "created_at"; /** @enum {string} */ TransactionFieldsAllowedForValidate: "receipt_id" | "description"; /** @enum {string} */ TransactionMetricEnum: "id" | "amount"; TransactionPaymentMethod: components["schemas"]["CardPaymentMethod"] | components["schemas"]["BankAccountPaymentMethod"]; /** @enum {string} */ TransactionPaymentMethodTypeEnum: "card" | "bank_account"; TransactionRejectRequest: { /** @description Optional reason explaining why the transaction was rejected. Whitespace is stripped. Pass null to clear. */ reject_reason?: string; }; TransactionRequest: { /** @description The transaction amount in [minor units](https://docs.monite.com/references/currencies#minor-units). Positive values for in-flow, negative values for out-flow. */ amount: number; /** * @description ISO currency code. * @example USD */ currency: components["schemas"]["CurrencyEnum"]; /** * Format: uuid * @description ID of the department associated with this transaction. */ department_id?: string; /** @description A human-readable description of the transaction. */ description?: string; /** * Format: uuid * @description ID of the entity user who made the transaction, if applicable. */ entity_user_id?: string; /** @description External identifier for idempotency, if provided by the source system. */ external_id?: string; /** * Format: uuid * @description ID of the ledger account from the Accounting service. */ ledger_account_id?: string; /** * Format: uuid * @description ID of the location associated with this transaction. */ location_id?: string; /** @description Original merchant transaction amount in minor units. */ merchant_amount: number; /** @description ISO currency code for the `merchant_amount`. */ merchant_currency: components["schemas"]["CurrencyEnum"]; /** * @description The merchant location. * @example New York, US */ merchant_location: string; /** * @description The merchant name. * @example Acme Inc. */ merchant_name: string; /** @description Extensible key-value pairs for storing additional custom information for partner needs. */ partner_metadata?: { [key: string]: string; }; payment_method: components["schemas"]["TransactionPaymentMethod"]; /** * @description The current processing status of the transaction. * @default created */ payment_processing_status: components["schemas"]["TransactionStatusEnum"]; /** * Format: date-time * @description Date and time when the transaction was initiated. */ started_at?: string; /** @description The nature of the transaction. */ type: components["schemas"]["TransactionTypeEnum"]; }; TransactionRequiredFieldItem: { /** @description Minimum transaction amount (in minor currency units) for this field to be required. Applied to the absolute value of the transaction amount, so out-flow (negative) amounts are evaluated by magnitude. If null, the field is always required. */ amount_threshold?: number; field: components["schemas"]["TransactionFieldsAllowedForValidate"]; }; TransactionResponse: { /** * Format: uuid * @description A unique Monite-generated ID assigned to this transaction. */ id: string; /** @description The transaction amount in [minor units](https://docs.monite.com/references/currencies#minor-units). Positive values for in-flow, negative values for out-flow. */ amount: number; /** * Format: uuid * @description ID of the approval policy applied to this transaction, if any. */ applied_policy_id?: string; /** * @description ISO currency code. * @example USD */ currency: components["schemas"]["CurrencyEnum"]; /** * Format: uuid * @description ID of the department associated with this transaction. */ department_id?: string; /** @description A human-readable description of the transaction. */ description?: string; /** * Format: uuid * @description ID of the entity that owns this resource. */ entity_id: string; /** * Format: uuid * @description ID of the entity user who made the transaction, if applicable. */ entity_user_id?: string; /** @description The current expense approval status of the transaction. */ expense_status: components["schemas"]["ExpenseStatusEnum"]; /** @description External identifier for idempotency, if provided by the source system. */ external_id?: string; /** @description Whether the transaction has missing required fields per the entity's TransactionValidation config. Always false when no config is set. */ has_validation_errors: boolean; /** * Format: uuid * @description ID of the ledger account from the Accounting service. */ ledger_account_id?: string; /** * Format: uuid * @description ID of the location associated with this transaction. */ location_id?: string; /** @description Original merchant transaction amount in minor units. */ merchant_amount: number; /** @description ISO currency code for the `merchant_amount`. */ merchant_currency: components["schemas"]["CurrencyEnum"]; /** * @description The merchant location. * @example New York, US */ merchant_location: string; /** * @description The merchant name. * @example Acme Inc. */ merchant_name: string; /** @description Reason provided by the employee when submitting without a receipt (e.g. receipt was lost or unavailable). Set via the submit endpoint; bypasses the receipt_id required-field check. */ no_receipt_reason?: string; /** @description Extensible key-value pairs for storing additional custom information for partner needs. */ partner_metadata?: { [key: string]: string; }; payment_method: components["schemas"]["TransactionPaymentMethod"]; /** * @description The current processing status of the transaction. * @default created */ payment_processing_status: components["schemas"]["TransactionStatusEnum"]; /** @description URL of the attached receipt's file. Present when receipt_id is set and the receipt is reachable; null otherwise. */ receipt_file_url?: string; /** @description ID of the related receipt from payables service, if any. */ receipt_id?: string; /** @description Optional reason explaining why the transaction was rejected. */ reject_reason?: string; /** @description Per-field source tracking. Each field indicates how its value was set: user, generated, or automatched. */ source_of_data?: components["schemas"]["SourceOfData"]; /** * Format: date-time * @description Date and time when the transaction was initiated. */ started_at: string; /** @description The nature of the transaction. */ type: components["schemas"]["TransactionTypeEnum"]; }; /** @description A paginated list of transactions. */ TransactionResponseList: { data: components["schemas"]["TransactionResponse"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string; }; /** @enum {string} */ TransactionStatusEnum: "created" | "processing" | "succeeded" | "declined" | "refunded" | "failed"; TransactionSubmitRequest: { /** @default false */ bypass_receipt_validation: boolean; no_receipt_reason?: string; }; /** @enum {string} */ TransactionTypeEnum: "capture" | "refund" | "cash_withdrawal" | "fee" | "adjustment" | "reversal"; TransactionUpdateRequest: { /** @description The transaction amount in [minor units](https://docs.monite.com/references/currencies#minor-units). Positive values for in-flow, negative values for out-flow. */ amount?: number; /** * @description ISO currency code. * @example USD */ currency?: components["schemas"]["CurrencyEnum"]; /** * Format: uuid * @description ID of the department associated with this transaction. */ department_id?: string; /** @description A human-readable description of the transaction. */ description?: string; /** * Format: uuid * @description ID of the entity user who made the transaction, if applicable. */ entity_user_id?: string; /** @description External identifier for idempotency, if provided by the source system. */ external_id?: string; /** * Format: uuid * @description ID of the ledger account from the Accounting service. */ ledger_account_id?: string; /** * Format: uuid * @description ID of the location associated with this transaction. */ location_id?: string; /** @description Original merchant transaction amount in minor units. */ merchant_amount?: number; /** @description ISO currency code for the `merchant_amount`. */ merchant_currency?: components["schemas"]["CurrencyEnum"]; /** * @description The merchant location. * @example New York, US */ merchant_location?: string; /** * @description The merchant name. * @example Acme Inc. */ merchant_name?: string; /** @description Extensible key-value pairs for storing additional custom information for partner needs. */ partner_metadata?: { [key: string]: string; }; payment_method?: components["schemas"]["TransactionPaymentMethod"]; /** * @description The current processing status of the transaction. * @default created */ payment_processing_status: components["schemas"]["TransactionStatusEnum"]; /** * Format: date-time * @description Date and time when the transaction was initiated. */ started_at?: string; /** @description The nature of the transaction. */ type?: components["schemas"]["TransactionTypeEnum"]; }; TransactionValidateResponse: { /** Format: uuid */ id: string; validation_errors: components["schemas"]["TransactionValidationError"][]; }; TransactionValidationError: { field: string; message: string; }; TransactionValidationResponse: { required_fields: components["schemas"]["TransactionRequiredFieldItem"][]; }; TransactionValidationUpdateRequest: { required_fields: components["schemas"]["TransactionRequiredFieldItem"][]; }; /** @enum {string} */ TransferType: "INTERNAL_TO_EXTERNAL" | "EXTERNAL_TO_INTERNAL" | "INTERNAL_TO_INTERNAL"; Unit: { /** @example kg */ designation: string; /** @example Kilogram */ name: string; }; UnitListResponse: { data: components["schemas"]["UnitResponse"][]; }; UnitRequest: { description?: string; name: string; }; UnitResponse: { /** Format: uuid */ id: string; /** Format: date-time */ created_at: string; /** Format: date-time */ updated_at: string; description?: string; name: string; }; UnitUpdate: { description?: string; name?: string; }; /** * @description Request model for updating an existing bank account application. Uses * `Tesouro.Common.Types.Rest.Optional<T>` for partial-update semantics — see that * type for the absent / explicit-null / explicit-value contract. */ UpdateBankAccountApplicationRequest: { /** @description Applicant details to update. Absent = preserve; explicit value = replace; explicit null = clear. */ applicant?: components["schemas"]["OptionalOfBankAccountApplicantInput"]; /** @description Business details to update. Absent = preserve; explicit value = replace; explicit null = clear. */ businessDetails?: components["schemas"]["OptionalOfBusinessDetailsInput"]; /** * @description List of business owners. Absent = preserve existing owners. Explicit empty array = clear all owners. * The resulting list replaces the stored owner list. */ businessOwners?: components["schemas"]["OptionalOfListOfBusinessOwnerInput"]; /** @description Validation source for individual KYC (bypass-KYC partners only). Absent = preserve. */ individualValidationSource?: components["schemas"]["OptionalOfstring"]; /** @description Validation source for organization KYC (bypass-KYC partners only). Absent = preserve. */ organizationValidationSource?: components["schemas"]["OptionalOfstring"]; }; /** @description Request model for updating a bank account. */ UpdateBankAccountRequest: { /** * @description The reference identifier associated with the bank account. * Must be alphanumeric (letters, numbers, hyphens, underscores, and dots) and max 50 characters. Set to null to clear. */ bankAccountReference?: components["schemas"]["OptionalOfstring"]; /** @description The new nickname for the bank account. */ nickname?: components["schemas"]["OptionalOfstring"]; /** @description The new status for the bank account. Set to CLOSED to close the account. */ status?: components["schemas"]["OptionalOfBankAccountStatus"]; }; UpdateCounterpartBankAccount: { /** * @description The name of the person or business that owns this bank account. Required for US bank accounts to accept ACH payments. * @example Bob Jones */ account_holder_name?: string; /** * @description The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. * @example 12345678 */ account_number?: string; /** * @description The BIC/SWIFT code of the bank. * @example CHASUS33XXX */ bic?: string; country?: components["schemas"]["AllowedCountries"]; currency?: components["schemas"]["CurrencyEnum"]; /** * @description The IBAN of the bank account. * @example GB29NWBK60161331926819 */ iban?: string; name?: string; /** @description Metadata for partner needs. */ partner_metadata?: Record; /** @description The bank's routing transit number (RTN). Required for US bank accounts to accept ACH payments. US routing numbers consist of 9 digits. */ routing_number?: string; /** * @description The bank's sort code. * @example 123456 */ sort_code?: string; }; /** @description The contact person for an organization. */ UpdateCounterpartContactPayload: { /** @description The address of a contact person. */ address?: components["schemas"]["CounterpartAddress"]; /** * Format: email * @description The email address of a contact person. * @example contact@example.org */ email?: string; /** * @description The first name of a contact person. * @example Mary */ first_name?: string; /** * @description The last name of a contact person. * @example O'Brien */ last_name?: string; /** * @description The phone number of a contact person * @example 5551235476 */ phone?: string; /** * @description The title or honorific of a contact person. Examples: Mr., Ms., Dr., Prof. * @example Ms. */ title?: string; }; UpdateCounterpartEinvoicingCredentialSchema: { network_identifier?: string; network_schema?: components["schemas"]["EinvoiceSchemaTypeEnum"]; }; /** @description Request model for updating an existing credit card application. */ UpdateCreditCardApplicationRequest: { /** @description Applicant details to update. Absent = preserve; explicit value = replace. */ applicant?: components["schemas"]["OptionalOfCreditCardApplicantInput"]; /** @description Business details to update. Absent = preserve; explicit value = replace. */ businessDetails?: components["schemas"]["OptionalOfCreditCardBusinessDetailsInput"]; /** * @description List of business owners. Absent = preserve existing owners. Explicit empty array = clear all owners. * Supply an existing owner's id to merge with the stored record; omit the id for a new owner. * The resulting list replaces the stored owner list. */ businessOwners?: components["schemas"]["OptionalOfListOfBusinessOwnerInput"]; }; UpdateCreditNote: { /** @description List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. */ attachments?: components["schemas"]["AttachmentRequest"][]; /** * Format: uuid * @description Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. */ counterpart_billing_address_id?: string; /** @description Additional information about counterpart contacts. */ counterpart_contact?: components["schemas"]["ReceivableCounterpartContact"]; /** * Format: uuid * @description Address where goods were shipped / where services were provided. */ counterpart_shipping_address_id?: string; /** @description Settings for rendering documents in PDF format, including settings for line items and specific document types. */ document_rendering?: components["schemas"]["DocumentRenderingSettings"]; entity?: components["schemas"]["ReceivableEntityBase"]; /** @description Optional text displayed below the line items table in the PDF. */ footer?: string; line_items?: components["schemas"]["UpdateLineItemForCreditNote"]; /** @description A note with additional information for a receivable */ memo?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; /** * Format: uuid * @description A project related to current receivable */ project_id?: string; /** @description A list of IDs of user-defined tags (labels) assigned to this receivable. */ tag_ids?: string[]; }; /** * @description Helper class that provides a standard way to create an ABC using * inheritance. */ UpdateCreditNotePayload: { credit_note: components["schemas"]["UpdateCreditNote"]; }; UpdateCustomTemplateSchemaRequest: { /** @description Jinja2 compatible string with email body */ body_template?: string; /** @description Lowercase ISO code of language */ language?: components["schemas"]["LanguageCodeEnum"]; /** @description Custom template name */ name?: string; /** @description Jinja2 compatible string with email subject */ subject_template?: string; }; UpdateDepartmentRequest: { name: string; }; UpdateEntityAddressSchema: { /** @description A city (a full name) where the entity is registered */ city?: string | null; /** @description A street where the entity is registered */ line1?: string | null; /** @description An alternative street used by the entity */ line2?: string | null; /** @description A postal code of the address where the entity is registered */ postal_code?: string | null; /** @description A state in a country where the entity is registered */ state?: string | null; }; /** @description Data that can be updated in existing bank accounts of an entity. */ UpdateEntityBankAccountRequest: { /** * @description The name of the person or business that owns this bank account. If the account currency is GBP or USD, the holder name cannot be changed to an empty string. * @example Cayla Lloyd */ account_holder_name?: string; /** * @description User-defined name of this bank account, such as 'Primary account' or 'Savings account'. * @example Primary account */ display_name?: string; }; /** @description A schema for a request to update an entity */ UpdateEntityRequest: { /** @description An address description of the entity */ address?: components["schemas"]["UpdateEntityAddressSchema"] | null; /** @description An official email address of the entity */ email?: string | null; /** @description A set of meta data describing the individual */ individual?: components["schemas"]["OptionalIndividualSchema"] | null; /** @description A set of meta data describing the organization */ organization?: components["schemas"]["OptionalOrganizationSchema"] | null; /** @description The contact phone number of the entity. Required for US organizations to use payments. */ phone?: string | null; /** * @description (Germany only) The name of the local district court (_Amtsgericht_) where the entity is registered. Required if `registration_number` is provided. * @example Amtsgericht Charlottenburg */ registration_authority?: string | null; /** * @description (Germany only) The entity's commercial register number (_Handelsregisternummer_) in the German Commercial Register, if available. * @example HRB 202324 */ registration_number?: string | null; /** @description The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered. */ tax_id?: string | null; /** @description A website of the entity */ website?: string | null; }; UpdateEntityUserRequest: { /** @description An entity user business email */ email?: string | null; /** * @description First name * @example Casey */ first_name?: string | null; /** * @description Last name * @example Peters */ last_name?: string | null; /** * @description Login * @example caseyp */ login?: string | null; /** @description An entity user phone number in the international format */ phone?: string | null; /** * @description Title * @example Finance Manager */ title?: string | null; }; /** * @description Request to update an external bank account. Uses * `Tesouro.Common.Types.Rest.Optional<T>` with non-nullable inner types — FIS does * not support clearing any of these fields, so absent fields preserve the stored value. */ UpdateExternalBankAccountRequest: { /** @description New name on the external bank account. Absent = preserve. */ nameOnAccount?: components["schemas"]["OptionalOfstring"]; /** @description New nickname for the external bank account. Absent = preserve. */ nickname?: components["schemas"]["OptionalOfstring"]; /** @description Verification status update. Requires 'CanSetExternalBankAccountVerification' permission. Absent = preserve. */ verification?: components["schemas"]["OptionalOfExternalBankAccountVerificationInput"]; }; UpdateInvoice: { /** @description List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. */ attachments?: components["schemas"]["AttachmentRequest"][]; /** * Format: uuid * @description Bank account ID */ bank_account_id?: string; /** @description Bank account type: INTERNAL, EXTERNAL, or BANK_DETAILS */ bank_account_type?: components["schemas"]["BankAccountTypeEnum"]; /** * Format: uuid * @description Unique ID of the counterpart contact. */ contact_id?: string; /** * Format: uuid * @description Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. */ counterpart_billing_address_id?: string; /** * Format: uuid * @description Unique ID of the counterpart. */ counterpart_id?: string; /** * Format: uuid * @description Address where goods were shipped / where services were provided. */ counterpart_shipping_address_id?: string; /** * Format: uuid * @description Counterpart VAT ID id */ counterpart_vat_id_id?: string; currency?: components["schemas"]["CurrencyEnum"]; /** @description List of deductions applied to the receivable (maximum 10 deductions allowed) */ deductions?: components["schemas"]["DeductionItem"][]; /** @description The discount for a receivable. */ discount?: components["schemas"]["Discount"]; /** * @description The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. * @example INV-0001 * @example 2024-027 * @example CUST/2024/00027 */ document_id?: string; /** @description Settings for rendering documents in PDF format, including settings for line items and specific document types. */ document_rendering?: components["schemas"]["DocumentRenderingSettings"]; /** * Format: date * @description The date by which the invoice must be paid. */ due_date?: string; entity?: components["schemas"]["ReceivableEntityBase"]; /** * Format: uuid * @description Entity VAT ID id */ entity_vat_id_id?: string; /** @description Optional text displayed below the line items table in the PDF. */ footer?: string; /** * Format: date * @description The date when the goods are shipped or the service is provided. Can be a current, past, or future date. * * Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. * * In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user. */ fulfillment_date?: string; line_items?: components["schemas"]["LineItemUpdate"][]; /** @description A note with additional information for a receivable */ memo?: string; /** Format: uuid */ overdue_reminder_id?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; /** * Format: uri * @description Link to your invoice's custom payment rails or external payment link. */ payment_page_url?: string; /** Format: uuid */ payment_reminder_id?: string; payment_terms?: components["schemas"]["InlinePaymentTermsRequestPayload"]; /** * Format: uuid * @description Unique ID of the payment terms. */ payment_terms_id?: string; /** * Format: uuid * @description A project related to current receivable */ project_id?: string; /** @description A list of IDs of user-defined tags (labels) assigned to this receivable. */ tag_ids?: string[]; /** @description Indicates whether the goods, materials, or services listed in the receivable are exempt from tax or not. */ tax_exempt?: boolean; /** @description The reason for the tax exemption, if applicable. */ tax_exemption_rationale?: string; /** @description Trade name of the entity */ trade_name?: string; /** @description The amount of tax withheld in percent minor units */ withholding_tax_rate?: number; }; /** * @description Helper class that provides a standard way to create an ABC using * inheritance. */ UpdateInvoicePayload: { invoice: components["schemas"]["UpdateInvoice"]; }; UpdateIssuedInvoice: { /** @description List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. */ attachments?: components["schemas"]["AttachmentRequest"][]; /** * Format: uuid * @description Unique ID of the counterpart contact. */ contact_id?: string; /** * Format: uuid * @description Id of a new or updated counterpart */ counterpart_id?: string; /** * Format: uuid * @description Counterpart VAT ID id */ counterpart_vat_id_id?: string; /** * @description The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. * @example INV-0001 * @example 2024-027 * @example CUST/2024/00027 */ document_id?: string; /** @description Settings for rendering documents in PDF format, including settings for line items and specific document types. */ document_rendering?: components["schemas"]["DocumentRenderingSettings"]; /** * Format: date * @description The date by which the invoice must be paid. */ due_date?: string; entity?: components["schemas"]["ReceivableEntityOrganizationRequest"] | components["schemas"]["ReceivableEntityIndividualRequest"]; entity_address?: components["schemas"]["ReceivableEntityAddressSchema"]; /** * Format: uuid * @description Entity VAT ID id */ entity_vat_id_id?: string; /** @description Optional text displayed below the line items table in the PDF. */ footer?: string; /** * Format: date * @description The date when the goods are shipped or the service is provided. Can be a current, past, or future date. * * Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued. * * In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user. */ fulfillment_date?: string; /** * Format: date-time * @description The datetime when the invoice was issued */ issue_date?: string; /** @description A note with additional information for a receivable */ memo?: string; /** Format: uuid */ overdue_reminder_id?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; /** Format: uuid */ payment_reminder_id?: string; payment_terms?: components["schemas"]["InlinePaymentTermsRequestPayload"]; /** Format: uuid */ payment_terms_id?: string; /** * Format: uuid * @description A project related to current receivable */ project_id?: string; /** * @description A list of IDs of user-defined tags (labels) assigned to this receivable. * @default [] */ tag_ids: string[]; }; /** * @description Helper class that provides a standard way to create an ABC using * inheritance. */ UpdateIssuedInvoicePayload: { issued_invoice: components["schemas"]["UpdateIssuedInvoice"]; }; /** * @description Line item with given product id can be changed only once * @example { * "6639ac63-0622-4bd9-b340-31c25e2096b8": { * "quantity": 5, * "price_diff": 100, * "old_price": 400 * } * } */ UpdateLineItemForCreditNote: { [key: string]: components["schemas"]["UpdateProductForCreditNote"]; }; UpdateLineItems: { data: components["schemas"]["LineItem"][]; }; UpdateLocationRequest: { name: string; }; UpdateMeEntityUserRequest: { /** @description An entity user business email */ email?: string | null; /** * @description First name * @example Casey */ first_name?: string | null; /** * @description Last name * @example Peters */ last_name?: string | null; /** @description An entity user phone number in the international format */ phone?: string | null; /** * @description Title * @example Finance Manager */ title?: string | null; }; /** @description Request body for updating an organization. All fields are optional; only provided fields are updated. */ UpdateOrganizationRequestDto: { address?: null | components["schemas"]["AddressDto"]; /** @description The display name of the organization. */ displayName?: null | string; /** @description The official legal name of the organization. */ legalName?: null | string; /** @description The organization's phone number. */ phoneNumber?: null | string; }; UpdatePaymentFeePayload: { /** @example USD */ currency?: components["schemas"]["CurrencyEnum"]; /** @example 400 */ fee_max_amount?: number; /** @example 20 */ fee_min_amount?: number; monite_fee?: components["schemas"]["OptionalFee"]; paid_by?: components["schemas"]["PaidBy"]; partner_fee?: components["schemas"]["OptionalFee"]; payment_method?: components["schemas"]["MoniteAllPaymentMethodsTypes"]; payment_method_subtype?: components["schemas"]["PaymentMethodSubtype"]; /** @example US */ region?: components["schemas"]["FeeRegion"]; /** Format: uuid */ tier_id?: string; }; UpdatePaymentIntentPayload: { amount: number; }; UpdatePaymentTierPayload: { /** @example 500 */ higher_range?: number; /** @example 100 */ lower_range?: number; measure_unit?: components["schemas"]["MeasureUnitEnum"]; period?: components["schemas"]["PeriodEnum"]; }; UpdateProductForCreditNote: { /** @description The old price of the line item. Used to choose for which line item new price should be applied */ old_price?: number; /** @description The price diff of the line item, i.e. applied discount */ price_diff?: number; /** @description The quantity of each of the goods, materials, or services listed in the receivable. */ quantity: number; }; /** @description Represents an Accounts Purchase Order document created by entity. */ UpdatePurchaseOrderPayloadSchema: { /** * Format: uuid * @description The ID of counterpart address object stored in counterparts service. If not provided, counterpart's default address is used. */ counterpart_address_id?: string; /** * Format: uuid * @description Counterpart unique ID. */ counterpart_id?: string; /** * Format: uuid * @description Entity VAT ID identifier that applied to purchase order */ entity_vat_id_id?: string; /** @description List of item to purchase */ items?: components["schemas"]["PurchaseOrderItem"][]; /** @description Msg which will be send to counterpart for who the purchase order is issued. */ message?: string; /** * Format: uuid * @description Project id of a purchase order */ project_id?: string; /** @description Number of days for which purchase order is valid */ valid_for_days?: number; }; UpdateQuote: { /** @description List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated. */ attachments?: components["schemas"]["AttachmentRequest"][]; /** * Format: uuid * @description Bank account ID */ bank_account_id?: string; /** @description Bank account type: INTERNAL, EXTERNAL, or BANK_DETAILS */ bank_account_type?: components["schemas"]["BankAccountTypeEnum"]; /** * Format: uuid * @description Unique ID of the counterpart contact. */ contact_id?: string; /** * Format: uuid * @description Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company. */ counterpart_billing_address_id?: string; /** * Format: uuid * @description Unique ID of the counterpart. */ counterpart_id?: string; /** * Format: uuid * @description Address where goods were shipped / where services were provided. */ counterpart_shipping_address_id?: string; /** * Format: uuid * @description Counterpart VAT ID id */ counterpart_vat_id_id?: string; currency?: components["schemas"]["CurrencyEnum"]; /** @description List of deductions applied to the receivable (maximum 10 deductions allowed) */ deductions?: components["schemas"]["DeductionItem"][]; /** @description The discount for a receivable. */ discount?: components["schemas"]["Discount"]; /** * @description The document number of the receivable, which will appear in the PDF document. Can be set manually only in the [non-compliant mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance). Otherwise (or if omitted), it will be generated automatically based on the entity's [document number customization](https://docs.monite.com/advanced/document-number-customization) settings when the document is issued. * @example INV-0001 * @example 2024-027 * @example CUST/2024/00027 */ document_id?: string; /** @description Settings for rendering documents in PDF format, including settings for line items and specific document types. */ document_rendering?: components["schemas"]["DocumentRenderingSettings"]; /** * Format: date * @description The date by which the invoice must be paid. */ due_date?: string; entity?: components["schemas"]["ReceivableEntityBase"]; /** * Format: uuid * @description Entity VAT ID id */ entity_vat_id_id?: string; /** * Format: date * @description The date (in ISO 8601 format) until which the quote is valid. */ expiry_date?: string; /** @description Optional text displayed below the line items table in the PDF. */ footer?: string; line_items?: components["schemas"]["LineItemUpdate"][]; /** @description A note with additional information for a receivable */ memo?: string; /** @description Metadata for partner needs */ partner_metadata?: Record; payment_terms?: components["schemas"]["InlinePaymentTermsRequestPayload"]; /** * Format: uuid * @description Unique ID of the payment terms. */ payment_terms_id?: string; /** * Format: uuid * @description A project related to current receivable */ project_id?: string; /** * Format: uri * @description Link for custom quote accept page */ quote_accept_page_url?: string; /** @description Whether acceptance a quote requires a signature. */ signature_required?: boolean; /** @description A list of IDs of user-defined tags (labels) assigned to this receivable. */ tag_ids?: string[]; /** @description Indicates whether the goods, materials, or services listed in the receivable are exempt from tax or not. */ tax_exempt?: boolean; /** @description The reason for the tax exemption, if applicable. */ tax_exemption_rationale?: string; /** @description Trade name of the entity */ trade_name?: string; /** @description The amount of tax withheld in percent minor units */ withholding_tax_rate?: number; }; /** * @description Helper class that provides a standard way to create an ABC using * inheritance. */ UpdateQuotePayload: { quote: components["schemas"]["UpdateQuote"]; }; UpdateRecurrencePayload: { /** * @description Controls how invoices are processed when generated: * - "draft": Creates invoices in draft status, requiring manual review, issuing, and sending * - "issue": Automatically issues invoices but requires manual sending * - "issue_and_send": Fully automates the process (creates, issues, and sends invoices) * * Default: "issue" (or "issue_and_send" if subject_text and body_text are provided) * * Note: When using "issue_and_send", both subject_text and body_text must be provided. */ automation_level?: components["schemas"]["AutomationLevel"]; /** @description The body text for the email that will be sent with the recurring invoice. */ body_text?: string; /** * @deprecated * @description Deprecated, use `start_date` instead */ day_of_month?: components["schemas"]["DayOfMonth"]; /** * Format: date * @description The end date of the recurring invoice, in the `yyyy-mm-dd` format. The end date is inclusive, that is, the last invoice will be created on this date if the last occurrence falls on this date. `end_date` is mutually exclusive with `max_occurrences`. Either `end_date` or `max_occurrences` must be specified. */ end_date?: string; /** * @deprecated * @description Deprecated, use `end_date` instead */ end_month?: number; /** * @deprecated * @description Deprecated, use `end_date` instead */ end_year?: number; /** @description How often the invoice will be created. */ frequency?: components["schemas"]["RecurrenceFrequency"]; /** @description The interval between each occurrence of the invoice. For example, when using monthly frequency, an interval of 1 means invoices will be created every month, an interval of 2 means invoices will be created every 2 months. */ interval?: number; /** @description How many times the recurring invoice will be created. The recurrence will stop after this number is reached. `max_occurrences` is mutually exclusive with `end_date`. Either `max_occurrences` or `end_date` must be specified. */ max_occurrences?: number; /** @description An object containing the recipients (To, CC, BCC) of the recurring invoices. Can be omitted if the base invoice has the counterpart contact email specified in the `counterpart_contact.email` field. */ recipients?: components["schemas"]["Recipients"]; /** * Format: date * @description The date when the first invoice will be created, in the `yyyy-mm-dd` format. Cannot be a past date. Subsequent invoice dates will be calculated based on `start_date`, `frequency`, and `interval`. */ start_date?: string; /** @description The subject for the email that will be sent with the recurring invoice. */ subject_text?: string; }; UpdateRoleRequest: { /** @description Role name */ name?: string | null; /** @description Access permissions */ permissions?: components["schemas"]["BizObjectsSchema-Input"] | null; }; UpdateTextTemplatePayload: { name?: string; template?: string; }; UpdateUserRequest: { address1?: null | string; address2?: null | string; city?: null | string; country?: null | string; isExpenseApprover?: null | boolean; jobTitle?: null | string; name?: null | string; permissions?: null | components["schemas"]["PermissionUpdateInput"]; phoneNumber?: null | string; postalCode?: null | string; /** * @description The ID of the user's reporting manager. Three states: * absent = leave unchanged, null = clear, value = set to the provided ID. */ reportingManagerUserId?: components["schemas"]["OptionalOfGuid"]; stateOrProvince?: null | string; }; UpdateUserResponse: { /** Format: uuid */ id: string; address1?: null | string; address2?: null | string; city?: null | string; country?: null | string; email: string; isExpenseApprover: boolean; jobTitle?: null | string; name: string; /** Format: uuid */ organizationId: string; phoneNumber?: null | string; postalCode?: null | string; /** Format: uuid */ reportingManagerUserId?: null | string; stateOrProvince?: null | string; status: string; }; UpdateWebhookSubscriptionRequest: { event_types?: string[] | null; object_type?: components["schemas"]["WebhookObjectType"] | null; url?: string | null; }; UploadFile: { /** Format: binary */ file: Blob; file_type: components["schemas"]["AllowedFileTypes"]; }; UploadOrganizationLogoPageDto: { /** Format: uuid */ id: string; mimetype: string; /** Format: int32 */ number: number | string; /** Format: int64 */ size: number | string; url: string; }; UploadOrganizationLogoPreviewDto: { /** Format: int32 */ height: number | string; url: string; /** Format: int32 */ width: number | string; }; UploadOrganizationLogoResponseDto: { /** Format: uuid */ id: string; /** Format: date-time */ createdAt: string; fileType: string; md5: string; mimetype: string; name: string; pages?: null | components["schemas"]["UploadOrganizationLogoPageDto"][]; previews?: null | components["schemas"]["UploadOrganizationLogoPreviewDto"][]; region: string; /** Format: int64 */ size: number | string; url: string; }; UpsertUserDataRequest: { value: components["schemas"]["JsonElement"]; }; UserDataResponse: { value: components["schemas"]["JsonElement"]; }; /** @description A department reference on a user response. */ UserDepartmentDto: { /** Format: uuid */ id: string; name: string; }; /** @description A location reference on a user response. */ UserLocationDto: { /** Format: uuid */ id: string; name: string; }; /** @enum {string} */ UserStatus: "ACTIVE" | "INACTIVE" | "INVITED"; /** * @description Filter for user status when querying users. * @enum {string} */ UserStatusFilter: "ACTIVE" | "INACTIVE" | "INVITED" | "ALL"; UserStatusResponseDto: { isEnabled: boolean; /** Format: uuid */ userId: string; }; /** @description Request to validate an external bank account using micro-deposits. */ ValidateExternalBankAccountRequest: { /** * Format: int64 * @description First micro-deposit verification amount in minor units (e.g. cents for USD). */ firstAmount: number | string; /** * Format: int64 * @description Second micro-deposit verification amount in minor units (e.g. cents for USD). */ secondAmount: number | string; }; ValidationError: { loc: (string | number)[]; msg: string; type: string; }; Variable: { description: string; name: string; }; VariablesObject: { object_subtype: components["schemas"]["DocumentTypeEnum"]; object_type: string; variables: components["schemas"]["Variable"][]; }; VariablesObjectList: { data: components["schemas"]["VariablesObject"][]; }; /** @enum {string} */ VariablesType: "quote" | "invoice" | "credit_note" | "discount_reminder" | "final_reminder" | "overdue_reminder"; /** @enum {string} */ VatConditionType: "entity_country" | "counterpart_country" | "zero"; /** @enum {string} */ VatIDTypeEnum: "ae_trn" | "au_abn" | "au_arn" | "bg_uic" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "kr_brn" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "no_vat" | "nz_gst" | "ru_inn" | "ru_kpp" | "sa_vat" | "sg_gst" | "sg_uen" | "si_tin" | "th_vat" | "tw_vat" | "ua_vat" | "us_ein" | "za_vat" | "unknown"; /** @enum {string} */ VatModeEnum: "exclusive" | "inclusive"; VatPredicate: { /** * @description Predicate name (enum property replaced by openapi-typescript) * @enum {string} */ name: "entity_vat" | "counterpart_vat"; /** * @description Predicate operator * @enum {string} */ operator: "EQ" | "NEQ"; /** @description Predicate comparison value */ value: components["schemas"]["VatValidityEnum"]; }; VatRateComponent: { /** @description Display name of the Tax. */ name: string; /** @description Percent multiplied by a 100. Example: 12.125% is 1212.5. Will be rounded to 2 decimal places */ value: number; }; VatRateListResponse: { data: components["schemas"]["VatRateResponse"][]; }; VatRateResponse: { /** * Format: uuid * @description Unique identifier of the vat rate object. */ id: string; /** * Format: date-time * @description Date/time when this rate was recorded in the table. */ created_at: string; /** * Format: date-time * @description Date/time when this rate was updated in the table. */ updated_at: string; /** @description Sub-taxes included in the VAT. */ components?: components["schemas"]["VatRateComponent"][]; /** * @description Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). * @example US */ country: components["schemas"]["AllowedCountries"]; /** @description Status for this vat rate: active | inactive. */ status?: components["schemas"]["VatRateStatusEnum"]; /** * Format: date * @description Date starting from when this rate can be used. */ valid_from?: string; /** * Format: date * @description Date when this rate was depreciated, after this date rate cannot be used. */ valid_until?: string; /** @description Total value of the VAT rate. Percent multiplied by a 100. Example: 12.125% is 1212.5. */ value: number; }; /** @enum {string} */ VatRateStatusEnum: "active" | "inactive"; VatTypePredicate: { /** * @description Predicate name (enum property replaced by openapi-typescript) * @enum {string} */ name: "entity_vat_type" | "counterpart_vat_type"; /** * @description Predicate operator * @enum {string} */ operator: "EQ" | "NEQ"; /** @description Predicate comparison value */ value: components["schemas"]["VatIDTypeEnum"]; }; /** @enum {string} */ VatValidityEnum: "has_valid" | "has_no_valid"; VerificationError: { code: string; details: string; }; /** @enum {string} */ VerificationStatusEnum: "enabled" | "disabled" | "pending"; /** @description Response model for business verification (KYC/KYB). */ VerifyBusinessResponse: { /** @description The status of the business verification. */ status: components["schemas"]["BusinessVerificationStatusDto"]; }; /** @description Request model for verifying an applicant's email verification code. */ VerifyEmailRequest: { /** @description The email verification code sent to the applicant. */ verificationCode: string; }; /** @description Response model for email verification. */ VerifyEmailResponse: { /** @description Indicates whether the email verification was successful. */ isVerified: boolean; }; VerifyResponse: { /** * Format: uuid * @description Entry UUID */ id: string; /** * Format: hostname * @description The domain name. */ domain: string; status: string; }; /** @description Response DTO containing the list of organization IDs visible to the caller. */ VisibleOrganizationIdsResponseDto: { /** @description The list of organization IDs that are visible to the caller (children, grandchildren, etc. in the hierarchy). */ organizationIds: string[]; }; /** * @description - NEW: A business has been created within Kanmon * - ONBOARDED: A business has completed all of the onboarding steps within Kanmon and is now awaiting underwriting. * - INPUT_REQUIRED: A business will be asked to provide required data * @enum {string} */ WCBusinessStatus: "NEW" | "INPUT_REQUIRED" | "ONBOARDED"; /** * @description - DRAFT: The invoice is in draft state. The business has not submitted the invoice for funding. * - NEW: The business has submitted an invoice and it is under review. * - FUNDED: The funds for the invoice have been disbursed. The business is now expected to pay back the funds. * - PAID: A payment was made that fully paid off an outstanding invoice. * - LATE: A payment was not made towards an outstanding invoice. * - REJECTED: An invoice was rejected during the funding step. * - DEFAULTED: A payment was not made towards an outstanding invoice. * @enum {string} */ WCInvoiceStatus: "DRAFT" | "NEW" | "FUNDED" | "PAID" | "LATE" | "REJECTED" | "DEFAULTED"; /** * @description - NEW: A new offer has been extended to the business. * - ACCEPTED: Business has accepted an offer and is waiting on the closing process. * - EXPIRED: Business has not accepted the offer, and the offer has expired. * - CURRENT: A loan has been originated and does not currently have any outstanding delayed payments. * - LATE: One or more repayments on the issued product have failed. * - CLOSED: The issued product is no longer available to the business. * - DEFAULTED: The business has failed to meet agreed-upon terms of the loan agreement. * @enum {string} */ WCOfferStatus: "NEW" | "ACCEPTED" | "EXPIRED" | "CURRENT" | "LATE" | "CLOSED" | "DEFAULTED"; /** * @description - MULTIPLE_DURATION: The business can repay the loan over multiple durations. * - FIXED_DURATION: The business must repay the loan over a fixed duration. * - FIXED_DATE: The business must repay the loan on a fixed date. * @enum {string} */ WCRepaymentType: "MULTIPLE_DURATION" | "FIXED_DURATION" | "FIXED_DATE"; /** @enum {string} */ WebhookDeliveryCursorFields: "created_at" | "updated_at"; WebhookDeliveryPaginationResource: { /** @description A set of webhooks returned per page */ data: components["schemas"]["WebhookDeliveryResource"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string | null; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string | null; }; WebhookDeliveryResource: { /** Format: uuid */ id: string; /** Format: uuid */ event_id: string; requests_made_count: number; response?: string | null; response_status_code?: number | null; /** Format: uri */ url: string; was_successful?: boolean | null; }; /** @enum {string} */ WebhookObjectType: "account" | "accounting_connection" | "approval" | "approval_request" | "approval_policy" | "approval_policy_process" | "batch_payment" | "comment" | "counterpart" | "counterpart_address" | "counterpart_bank_account" | "counterpart_contact_person" | "counterpart_partner_metadata" | "counterpart_tax_id" | "entity" | "entity_bank_account" | "entity_settings" | "entity_user" | "export" | "overdue_reminder" | "partner_settings" | "payable" | "payables_credit_note" | "payables_purchase_order" | "payable.line_item" | "payment" | "payment_intent" | "payment_link" | "payment_reminder" | "product" | "project" | "receivable" | "recurrence" | "role" | "tag" | "todo_task" | "workflow" | "workflow_pipeline" | "ocr_task" | "delivery_note" | "receipt" | "transaction"; /** @enum {string} */ WebhookSubscriptionCursorFields: "created_at" | "updated_at"; WebhookSubscriptionPaginationResource: { /** @description A set of webhook settings of different types returned per page */ data: components["schemas"]["WebhookSubscriptionResource"][]; /** @description A token that can be sent in the `pagination_token` query parameter to get the next page of results, or `null` if there is no next page (i.e. you've reached the last page). */ next_pagination_token?: string | null; /** @description A token that can be sent in the `pagination_token` query parameter to get the previous page of results, or `null` if there is no previous page (i.e. you've reached the first page). */ prev_pagination_token?: string | null; }; WebhookSubscriptionResource: { /** Format: uuid */ id: string; event_types: string[]; object_type: components["schemas"]["WebhookObjectType"]; status: components["schemas"]["WebhookSubscriptionStatus"]; /** Format: uri */ url: string; }; WebhookSubscriptionResourceWithSecret: { /** Format: uuid */ id: string; event_types: string[]; object_type: components["schemas"]["WebhookObjectType"]; secret: string; status: components["schemas"]["WebhookSubscriptionStatus"]; /** Format: uri */ url: string; }; /** @enum {string} */ WebhookSubscriptionStatus: "enabled" | "disabled"; WidgetGatewayErrorResponse: { error: string; message?: null | string; }; WidgetGatewayRequestDto: { body?: null | string; method: string; path: string; }; WidgetInitResponse: { bankName?: null | string; /** Format: uuid */ organizationId?: null | string; organizationTypes?: null | components["schemas"]["OrganizationType"][]; scopes: string[]; status?: components["schemas"]["WidgetUserStatus"]; /** Format: uuid */ userId?: null | string; vspName?: null | string; }; /** @enum {string} */ WidgetUserStatus: "ACTIVE" | "INACTIVE" | "INVITED" | "NOT_FOUND"; /** @enum {string} */ YapilyCountriesCoverageCodes: "BE" | "GB" | "IT" | "IE" | "NL" | "DE" | "AT"; }; responses: never; parameters: never; requestBodies: never; headers: never; pathItems: never; } type $defs = Record; interface operations { GetApiWidgetGatewayInit: { parameters: { query?: never; header?: { "X-Widget-Token"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetInitResponse"]; "application/json": components["schemas"]["WidgetInitResponse"]; "text/json": components["schemas"]["WidgetInitResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Unprocessable Entity */ 422: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; PostApiWidgetGatewayProxy: { parameters: { query?: never; header?: { "X-Widget-Token"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["WidgetGatewayRequestDto"]; "text/json": components["schemas"]["WidgetGatewayRequestDto"]; "application/*+json": components["schemas"]["WidgetGatewayRequestDto"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Unprocessable Entity */ 422: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetApiWidgetGatewayProxyPath: { parameters: { query?: never; header?: { "X-Widget-Token"?: string; "X-Client-Secret"?: string; }; path: { path: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Unprocessable Entity */ 422: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; PutApiWidgetGatewayProxyPath: { parameters: { query?: never; header?: { "X-Widget-Token"?: string; "X-Client-Secret"?: string; }; path: { path: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Unprocessable Entity */ 422: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; PostApiWidgetGatewayProxyPath: { parameters: { query?: never; header?: { "X-Widget-Token"?: string; "X-Client-Secret"?: string; }; path: { path: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Unprocessable Entity */ 422: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; DeleteApiWidgetGatewayProxyPath: { parameters: { query?: never; header?: { "X-Widget-Token"?: string; "X-Client-Secret"?: string; }; path: { path: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Unprocessable Entity */ 422: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; PatchApiWidgetGatewayProxyPath: { parameters: { query?: never; header?: { "X-Widget-Token"?: string; "X-Client-Secret"?: string; }; path: { path: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Unprocessable Entity */ 422: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; PostApiWidgetGatewayRevoke: { parameters: { query?: never; header?: { "X-Widget-Token"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Unprocessable Entity */ 422: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["WidgetGatewayErrorResponse"]; "application/json": components["schemas"]["WidgetGatewayErrorResponse"]; "text/json": components["schemas"]["WidgetGatewayErrorResponse"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetApplicationStatus: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Status retrieved successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApplicationStatusResponse"]; }; }; /** @description Required header is missing or invalid. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; }; }; GetMerchantCategoryGroups: { parameters: { query?: { groupId?: string; pagination_token?: string; }; header?: { /** @description ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400. */ "X-Organization-ID"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaginatedResponseOfMerchantCategoryGroupResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Bad Gateway */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetBankAccountApplications: { parameters: { query?: { /** @description Number of items to return (default 25, max 100). */ limit?: number | string; /** @description Opaque pagination token from a previous response. */ pagination_token?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Applications retrieved successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaginatedResponseOfBankAccountApplicationSummaryResponse"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Applicant tokens may not list applications. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; CreateApplication: { parameters: { query?: never; header?: { /** @description ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400. */ "X-Organization-ID"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateBankAccountApplicationRequest"]; "application/*+json": components["schemas"]["CreateBankAccountApplicationRequest"]; }; }; responses: { /** @description Application created successfully. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreateBankAccountApplicationWithSecretResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Organization not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; ResumeApplication: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ResumeApplicationRequest"]; "application/*+json": components["schemas"]["ResumeApplicationRequest"]; }; }; responses: { /** @description Request acknowledged. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ResumeApplicationResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; }; }; GetBankAccountApplication: { parameters: { query?: never; header?: never; path: { /** @description The application ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Application retrieved successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BankAccountApplicationResponse"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Application not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; UpdateApplication: { parameters: { query?: never; header?: never; path: { /** @description The application ID. */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateBankAccountApplicationRequest"]; "application/*+json": components["schemas"]["UpdateBankAccountApplicationRequest"]; }; }; responses: { /** @description Application updated successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BankAccountApplicationResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Application not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; VerifyBusiness: { parameters: { query?: never; header?: never; path: { /** @description The application ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Verification processed successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["VerifyBusinessResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Application not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; SubmitApplication: { parameters: { query?: never; header?: never; path: { /** @description The application ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Application submitted successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BankAccountApplicationResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Application not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; VerifyEmailCode: { parameters: { query?: never; header?: never; path: { /** @description The application ID. */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["VerifyEmailRequest"]; "application/*+json": components["schemas"]["VerifyEmailRequest"]; }; }; responses: { /** @description Email verified successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["VerifyEmailResponse"]; }; }; /** @description Invalid verification code. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Application not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; SendVerificationEmail: { parameters: { query?: never; header?: never; path: { /** @description The application ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Verification email sent successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BankAccountApplicationResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Application not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetBankAccounts: { parameters: { query?: { /** @description Number of items to return (default 25, max 100). */ limit?: number | string; /** @description Opaque pagination token from a previous response. */ pagination_token?: string; /** @description Optional filter by bank account status. See `BankAccountStatus` for supported values. */ status?: components["schemas"]["BankAccountStatus"]; }; header?: { /** @description ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400. */ "X-Organization-ID"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Returns bank accounts with balances. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaginatedResponseOfBankAccountWithBalanceResponse"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; }; }; CreateBankAccount: { parameters: { query?: never; header?: { /** @description ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400. */ "X-Organization-ID"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateBankAccountRequest"]; "application/*+json": components["schemas"]["CreateBankAccountRequest"]; }; }; responses: { /** @description Bank account created successfully. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BankAccountResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; ManageBankAccountAccess: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ManageBankAccountAccessRequest"]; "application/*+json": components["schemas"]["ManageBankAccountAccessRequest"]; }; }; responses: { /** @description Access updated successfully. */ 204: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Invalid request or self-revoke attempted. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Insufficient permissions. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetBankAccount: { parameters: { query?: never; header?: never; path: { /** @description The bank account ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns bank account with balance. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BankAccountWithBalanceResponse"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; UpdateBankAccount: { parameters: { query?: never; header?: never; path: { /** @description The bank account ID. */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateBankAccountRequest"]; "application/*+json": components["schemas"]["UpdateBankAccountRequest"]; }; }; responses: { /** @description Bank account updated successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BankAccountResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetBankAccountAccess: { parameters: { query?: never; header?: never; path: { /** @description The bank account ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns user IDs with access. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": string[]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GrantBankAccountAccess: { parameters: { query?: never; header?: never; path: { /** @description The bank account ID. */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["GrantUsersAccessRequest"]; "application/*+json": components["schemas"]["GrantUsersAccessRequest"]; }; }; responses: { /** @description Access granted successfully. */ 204: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; RevokeBankAccountAccess: { parameters: { query?: never; header?: never; path: { /** @description The bank account ID. */ id: string; /** @description The user ID to revoke access from. */ userId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Access revoked successfully. */ 204: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Invalid request or self-revoke attempted. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetBankAccountTransactions: { parameters: { query?: { /** @description Optional start date filter. */ startDate?: string; /** @description Optional end date filter. */ endDate?: string; /** @description Number of items to return (default 25, max 100). */ limit?: number | string; /** @description Opaque pagination token from a previous response. */ pagination_token?: string; }; header?: never; path: { /** @description The bank account ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns transactions. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaginatedResponseOfBankAccountTransactionResponse"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetBankAccountTransfers: { parameters: { query?: { /** @description Number of items to return (default 25, max 100). */ limit?: number | string; /** @description Opaque pagination token from a previous response. */ pagination_token?: string; }; header?: never; path: { /** @description The bank account ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns transfers. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaginatedResponseOfBankAccountTransferResponse"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetBeneficialOwners: { parameters: { query?: { /** @description Number of items to return (default 25, max 100). */ limit?: number | string; /** @description Opaque pagination token from a previous response. */ pagination_token?: string; }; header?: { /** @description ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400. */ "X-Organization-ID"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Beneficial owners retrieved successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaginatedResponseOfBeneficialOwnerResponse"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Access denied - only BANK and PLATFORM organization types can access this endpoint. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; CreateCreditCardApplication: { parameters: { query?: never; header?: { /** @description ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400. */ "X-Organization-ID"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateCreditCardApplicationRequest"]; "application/*+json": components["schemas"]["CreateCreditCardApplicationRequest"]; }; }; responses: { /** @description Application created successfully. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreateCreditCardApplicationWithSecretResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Caller lacks the required credit card application scope. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Organization not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; ResumeCreditCardApplication: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ResumeApplicationRequest"]; "application/*+json": components["schemas"]["ResumeApplicationRequest"]; }; }; responses: { /** @description Request acknowledged. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ResumeApplicationResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetCreditCardApplication: { parameters: { query?: never; header?: never; path: { /** @description The application ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Application retrieved successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditCardApplicationResponse"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Application not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; UpdateCreditCardApplication: { parameters: { query?: never; header?: never; path: { /** @description The application ID. */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateCreditCardApplicationRequest"]; "application/*+json": components["schemas"]["UpdateCreditCardApplicationRequest"]; }; }; responses: { /** @description Application updated successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditCardApplicationResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Caller lacks the required credit card application scope. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Application not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; SubmitCreditCardApplication: { parameters: { query?: never; header?: never; path: { /** @description The application ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Application submitted successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditCardApplicationResponse"]; }; }; /** @description Invalid request or application not in a submittable state. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Caller lacks the required credit card application scope. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Application not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; VerifyCreditCardEmailCode: { parameters: { query?: never; header?: never; path: { /** @description The credit card application ID. */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["VerifyEmailRequest"]; "application/*+json": components["schemas"]["VerifyEmailRequest"]; }; }; responses: { /** @description Email verified successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["VerifyEmailResponse"]; }; }; /** @description Invalid verification code. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Application not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; SendCreditCardVerificationEmail: { parameters: { query?: never; header?: never; path: { /** @description The credit card application ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Verification email sent successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditCardApplicationResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Application not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetCreditCards: { parameters: { query?: { limit?: number | string; paginationToken?: string; userId?: string; }; header?: { /** @description ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400. */ "X-Organization-ID"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaginatedResponseOfCreditCardResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; CreateAdditionalCard: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateAdditionalCardRequest"]; "application/*+json": components["schemas"]["CreateAdditionalCardRequest"]; }; }; responses: { /** @description Created */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditCardResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Unprocessable Entity */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Bad Gateway */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetCreditCardById: { parameters: { query?: never; header?: { /** @description ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400. */ "X-Organization-ID"?: string; }; path: { cardId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditCardResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Bad Gateway */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; CloseCreditCard: { parameters: { query?: never; header?: never; path: { cardId: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CloseCreditCardRequest"]; "application/*+json": components["schemas"]["CloseCreditCardRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditCardResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Bad Gateway */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; SetCreditCardLockStatus: { parameters: { query?: never; header?: never; path: { cardId: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["LockCreditCardRequest"]; "application/*+json": components["schemas"]["LockCreditCardRequest"]; }; }; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditCardResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Bad Gateway */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; ActivateCreditCard: { parameters: { query?: never; header?: never; path: { id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditCardResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetCreditCardTransactions: { parameters: { query?: { startDate?: string; endDate?: string; limit?: number | string; pagination_token?: string; }; header?: never; path: { id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaginatedResponseOfCreditCardTransactionResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Bad Gateway */ 502: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Service Unavailable */ 503: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; AcceptDisclosuresWithToken: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["AcceptDisclosuresWithTokenRequest"]; "application/*+json": components["schemas"]["AcceptDisclosuresWithTokenRequest"]; }; }; responses: { /** @description Disclosures accepted successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DisclosureAcceptanceResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Application token required. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; AcceptDisclosures: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Disclosures accepted successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DisclosureAcceptanceResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; }; }; GetExternalBankAccounts: { parameters: { query?: { /** @description Number of items to return (default 25, max 100). */ limit?: number | string; /** @description Opaque pagination token from a previous response. */ pagination_token?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Returns external bank accounts. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaginatedResponseOfExternalBankAccountResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; ConnectExternalBankAccount: { parameters: { query?: never; header?: { /** @description ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400. */ "X-Organization-ID"?: string; }; path?: never; cookie?: never; }; /** @description The connect request. */ requestBody: { content: { "application/json": components["schemas"]["ConnectExternalBankAccountRequest"]; "application/*+json": components["schemas"]["ConnectExternalBankAccountRequest"]; }; }; responses: { /** @description External bank account connected. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExternalBankAccountResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Insufficient permissions for verification at creation. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetExternalBankAccount: { parameters: { query?: never; header?: never; path: { id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns external bank account. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExternalBankAccountResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description External bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; UnlinkExternalBankAccount: { parameters: { query?: never; header?: { /** @description ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400. */ "X-Organization-ID"?: string; }; path: { /** @description The external bank account ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description External bank account unlinked. */ 204: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description External bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; UpdateExternalBankAccount: { parameters: { query?: never; header?: { /** @description ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400. */ "X-Organization-ID"?: string; }; path: { /** @description The external bank account ID. */ id: string; }; cookie?: never; }; /** @description The update request. */ requestBody: { content: { "application/json": components["schemas"]["UpdateExternalBankAccountRequest"]; "application/*+json": components["schemas"]["UpdateExternalBankAccountRequest"]; }; }; responses: { /** @description External bank account updated. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExternalBankAccountResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Insufficient permissions for verification update. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description External bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetExternalBankAccountAccess: { parameters: { query?: never; header?: never; path: { /** @description The external bank account ID. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns user IDs with access. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": string[]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description External bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GrantExternalBankAccountAccess: { parameters: { query?: never; header?: never; path: { /** @description The external bank account ID. */ id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["GrantUsersAccessRequest"]; "application/*+json": components["schemas"]["GrantUsersAccessRequest"]; }; }; responses: { /** @description Access granted successfully. */ 204: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description External bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; RevokeExternalBankAccountAccess: { parameters: { query?: never; header?: never; path: { /** @description The external bank account ID. */ id: string; /** @description The user ID to revoke access from. */ userId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Access revoked successfully. */ 204: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Invalid request or self-revoke attempted. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description External bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; LinkExternalBankAccount: { parameters: { query?: never; header?: never; path: { id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Micro-deposit verification initiated. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExternalBankAccountResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description External bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; ValidateExternalBankAccount: { parameters: { query?: never; header?: { /** @description ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400. */ "X-Organization-ID"?: string; }; path: { /** @description The external bank account ID. */ id: string; }; cookie?: never; }; /** @description The validate request. */ requestBody: { content: { "application/json": components["schemas"]["ValidateExternalBankAccountRequest"]; "application/*+json": components["schemas"]["ValidateExternalBankAccountRequest"]; }; }; responses: { /** @description External bank account validated. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExternalBankAccountResponse"]; }; }; /** @description Invalid request or incorrect amounts. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description External bank account not found. */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; CreateAchMoneyMovement: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["AchMoneyMovementRequest"]; "application/*+json": components["schemas"]["AchMoneyMovementRequest"]; }; }; responses: { /** @description Money movement created successfully. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoneyMovementResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Insufficient permissions or missing payment rail scope. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Duplicate idempotency key. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; CreateBookTransfer: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["BookTransferRequest"]; "application/*+json": components["schemas"]["BookTransferRequest"]; }; }; responses: { /** @description Transfer created successfully. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoneyMovementResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Insufficient permissions. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Duplicate idempotency key. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; CreateFedNowMoneyMovement: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["FedNowMoneyMovementRequest"]; "application/*+json": components["schemas"]["FedNowMoneyMovementRequest"]; }; }; responses: { /** @description Money movement created successfully. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoneyMovementResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Insufficient permissions or missing payment rail scope. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Duplicate idempotency key. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; CreateRtpMoneyMovement: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["RtpMoneyMovementRequest"]; "application/*+json": components["schemas"]["RtpMoneyMovementRequest"]; }; }; responses: { /** @description Money movement created successfully. */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MoneyMovementResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Insufficient permissions or missing payment rail scope. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Duplicate idempotency key. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; GetOrganizationSummary: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Returns organization summary. */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AdminPortalSummaryResponse"]; }; }; /** @description Invalid request. */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; /** @description Authentication required. */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Organization context required. */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbedProblemDetails"]; }; }; }; }; PostFilesBoardingApplicationsApplicationidAttachments: { parameters: { query?: never; header?: never; path: { /** @description the id of the application you wish to upload an attachment for */ applicationId: string; }; cookie?: never; }; requestBody: { content: { "multipart/form-data": { file: components["schemas"]["IFormFile"]; } & { description?: string; } & { decisionComponentIds?: string[]; }; }; }; responses: { 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; }; }; GetFilesBoardingApplicationsApplicationidAttachmentsAttachmentid: { parameters: { query?: never; header?: never; path: { applicationId: string; attachmentId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; }; }; DeleteFilesBoardingApplicationsApplicationidAttachmentsAttachmentid: { parameters: { query?: never; header?: never; path: { applicationId: string; attachmentId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description No Content */ 204: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; }; }; PostFilesDisputesDisputeidAttachments: { parameters: { query?: never; header?: never; path: { /** @description the id of the dispute you wish to upload an attachment for */ disputeId: string; }; cookie?: never; }; requestBody: { content: { "multipart/form-data": { file: components["schemas"]["IFormFile"]; } & { description?: string; }; }; }; responses: { 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; }; }; GetFilesDisputesDisputeidAttachmentsAttachmentid: { parameters: { query?: never; header?: never; path: { disputeId: string; attachmentId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; }; }; PostFilesReportingTypeIdDownload: { parameters: { query?: { "api-version"?: string; }; header?: never; path: { type: components["schemas"]["DownloadType"]; id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/octet-stream": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/octet-stream": unknown; }; }; }; }; PostFilesUnderwritingApplicationsApplicationidAttachments: { parameters: { query?: never; header?: never; path: { /** @description the id of the application you wish to upload an attachment for */ applicationId: string; }; cookie?: never; }; requestBody: { content: { "multipart/form-data": { file: components["schemas"]["IFormFile"]; } & { description?: string; } & { decisionComponentIds?: string[]; }; }; }; responses: { 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; }; }; GetFilesUnderwritingApplicationsApplicationidAttachmentsAttachmentid: { parameters: { query?: never; header?: never; path: { applicationId: string; attachmentId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description OK */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; }; }; DeleteFilesUnderwritingApplicationsApplicationidAttachmentsAttachmentid: { parameters: { query?: never; header?: never; path: { applicationId: string; attachmentId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description No Content */ 204: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; }; }; "get_accounting-connections": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingConnectionList"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_accounting-connections": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingConnectionResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_accounting-connections_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { connection_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingConnectionResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_accounting-connections_id_disconnect": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { connection_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingConnectionResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_accounting-connections_id_sync": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { connection_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 202: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingMessageResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_accounting-synced-records": { parameters: { query: { object_type: components["schemas"]["ObjectMatchTypes"]; /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** * @description The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. * * When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["SyncRecordCursorFields"]; object_id?: string; object_id__in?: string[]; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; updated_at__gt?: string; updated_at__lt?: string; updated_at__gte?: string; updated_at__lte?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SyncRecordResourceList"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_accounting-synced-records_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { synced_record_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SyncRecordResource"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_accounting-synced-records_id_push": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { synced_record_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SyncRecordResource"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_accounting-tax-rates": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** * @description The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. * * When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["TaxRateAccountCursorFields2"]; /** @description Filter by external/internal tax rates */ is_external?: boolean; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingTaxRateListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_accounting-tax-rates": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["AccountingTaxRateCreateRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingTaxRateResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_accounting-tax-rates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { tax_rate_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingTaxRateResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_accounting-tax-rates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { tax_rate_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_accounting-tax-rates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { tax_rate_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["AccountingTaxRateUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingTaxRateResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_accounting_payables: { parameters: { query?: { /** @description Number of results per page. */ limit?: number; /** @description Number of results to skip before selecting items to return. */ offset?: number; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingPayableList"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_accounting_payables_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { /** @description An internal ID of the payable invoice (bill) in the accounting system. You can get these IDs from `GET /accounting/payables`. */ payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingPayable"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_accounting_receivables: { parameters: { query?: { /** @description Number of results per page. */ limit?: number; /** @description Number of results to skip before selecting items to return. */ offset?: number; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingReceivableList"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_accounting_receivables_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { /** @description An internal ID of the invoice in the accounting system. You can get these IDs from `GET /accounting/receivables`. */ invoice_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingReceivable"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_analytics_credit-notes": { parameters: { query: { dimension?: components["schemas"]["CreditNoteDimensionEnum"]; metric: components["schemas"]["CreditNoteMetricEnum"]; aggregation_function: components["schemas"]["AggregationFunctionEnum"]; date_dimension_breakdown?: components["schemas"]["DateDimensionBreakdownEnum"]; /** @description The number of items (0 .. 400) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; issued_at?: string; issued_at__gt?: string; issued_at__lt?: string; issued_at__gte?: string; issued_at__lte?: string; document_id?: string; document_id__iexact?: string; document_id__contains?: string; document_id__icontains?: string; has_file?: boolean; total_amount__gt?: number; total_amount__lt?: number; total_amount__gte?: number; total_amount__lte?: number; subtotal__gt?: number; subtotal__lt?: number; subtotal__gte?: number; subtotal__lte?: number; based_on?: string; counterpart_id?: string; created_by_entity_user_id?: string; status?: components["schemas"]["PayableCreditNoteStateEnum"]; status__in?: components["schemas"]["PayableCreditNoteStateEnum"][]; status__not_in?: components["schemas"]["PayableCreditNoteStateEnum"][]; origin?: components["schemas"]["OriginEnum"]; currency?: components["schemas"]["CurrencyEnum"]; project_id?: string; project_id__in?: string[]; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableAnalyticsResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_analytics_payables: { parameters: { query: { dimension?: components["schemas"]["PayableDimensionEnum"]; metric: components["schemas"]["PayableMetricEnum"]; aggregation_function: components["schemas"]["AggregationFunctionEnum"]; date_dimension_breakdown?: components["schemas"]["DateDimensionBreakdownEnum"]; /** @description The number of items (0 .. 400) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** @description Return only payables created in Monite after the specified date and time. The value must be in the ISO 8601 format YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm]. */ created_at__gt?: string; /** @description Return only payables created in Monite before the specified date and time. */ created_at__lt?: string; /** @description Return only payables created in Monite on or after the specified date and time. */ created_at__gte?: string; /** @description Return only payables created in Monite before or on the specified date and time. */ created_at__lte?: string; /** * @description Return only payables that have the specified [status](https://docs.monite.com/accounts-payable/payables/index). * * To query multiple statuses at once, use the `status__in` parameter instead. */ status?: components["schemas"]["PayableStateEnum"]; /** * @description Return only payables that have the specified [statuses](https://docs.monite.com/accounts-payable/payables/index). * * To specify multiple statuses, repeat this parameter for each value: `status__in=draft&status__in=new` */ status__in?: components["schemas"]["PayableStateEnum"][]; /** * @description Return only payables with specified IDs. Valid but nonexistent IDs do not raise errors but produce no results. * * To specify multiple IDs, repeat this parameter for each value: `id__in=&id__in=` */ id__in?: string[]; /** @description Return only payables with the exact specified total amount. The amount must be specified in the minor units of currency. For example, $12.5 is represented as 1250. */ total_amount?: number; /** @description Return only payables whose total amount (in minor units) exceeds the specified value. */ total_amount__gt?: number; /** @description Return only payables whose total amount (in minor units) is less than the specified value. */ total_amount__lt?: number; /** @description Return only payables whose total amount (in minor units) is greater than or equal to the specified value. */ total_amount__gte?: number; /** @description Return only payables whose total amount (in minor units) is less than or equal to the specified value. */ total_amount__lte?: number; /** @description Return only payables with the specified amount. */ amount?: number; /** @description Return only payables whose amount (in minor units) exceeds the specified value. */ amount__gt?: number; /** @description Return only payables whose amount (in minor units) is less than the specified value. */ amount__lt?: number; /** @description Return only payables whose amount (in minor units) is greater than or equal to the specified value. */ amount__gte?: number; /** @description Return only payables whose amount (in minor units) is less than or equal to the specified value. */ amount__lte?: number; /** @description Return only payables that use the specified currency. */ currency?: components["schemas"]["CurrencyEnum"]; /** * @description Return only payables received from counterparts with the specified name (exact match, case-sensitive). * * For counterparts of `type = individual`, the full name is formatted as `first_name last_name`. */ counterpart_name?: string; /** @description Return only payables received from counterparts whose name contains the specified string (case-sensitive). */ counterpart_name__contains?: string; /** @description Return only payables received from counterparts whose name contains the specified string (case-insensitive). */ counterpart_name__icontains?: string; /** @description Apply the `icontains` condition to search for the specified text in the `document_id` and `counterpart_name` fields in the payables. */ search_text?: string; /** @description Return payables that are due on the specified date (YYYY-MM-DD) */ due_date?: string; /** @description Return payables that are due after the specified date (exclusive, YYYY-MM-DD). */ due_date__gt?: string; /** @description Return payables that are due before the specified date (exclusive, YYYY-MM-DD). */ due_date__lt?: string; /** @description Return payables that are due on or after the specified date (YYYY-MM-DD). */ due_date__gte?: string; /** @description Return payables that are due before or on the specified date (YYYY-MM-DD). */ due_date__lte?: string; /** @description Return payables that are issued at the specified date (YYYY-MM-DD) */ issued_at?: string; /** @description Return payables that are issued after the specified date (exclusive, YYYY-MM-DD). */ issued_at__gt?: string; /** @description Return payables that are issued before the specified date (exclusive, YYYY-MM-DD). */ issued_at__lt?: string; /** @description Return payables that are issued on or after the specified date (YYYY-MM-DD). */ issued_at__gte?: string; /** @description Return payables that are issued before or on the specified date (YYYY-MM-DD). */ issued_at__lte?: string; /** * @description Return a payable with the exact specified document number (case-sensitive). * * The `document_id` is the user-facing document number such as INV-00042, not to be confused with Monite resource IDs (`id`). */ document_id?: string; /** @description Return only payables whose document number (`document_id`) contains the specified string (case-sensitive). */ document_id__contains?: string; /** @description Return only payables whose document number (`document_id`) contains the specified string (case-insensitive). */ document_id__icontains?: string; /** @description Return only payables created in Monite by the entity user with the specified ID. */ was_created_by_user_id?: string; /** * @description Return only payables received from the counterpart with the specified ID. * * Counterparts that have been deleted but have associated payables will still return results here because the payables contain a frozen copy of the counterpart data. * * If the specified counterpart ID does not exist and never existed, no results are returned. */ counterpart_id?: string; /** * @description Return only payables received from the counterparts with the specified IDs. Valid but nonexistent IDs do not raise errors but produce no results. * * To specify multiple IDs, repeat this parameter for each value: `counterpart_id__in=&counterpart_id__in=` */ counterpart_id__in?: string[]; /** @description Return only payables coming from the specified source. */ source_of_payable_data?: components["schemas"]["SourceOfPayableDataEnum"]; /** @description Return only payables with specific OCR statuses. */ ocr_status?: components["schemas"]["OcrStatusEnum"]; /** @description Search for a payable by the identifier of the line item associated with it. */ line_item_id?: string; /** @description Search for a payable by the identifier of the purchase order associated with it. */ purchase_order_id?: string; /** * @description Return only payables assigned to the project with the specified ID. * * Valid but nonexistent project IDs do not raise errors but return no results. */ project_id?: string; /** @description Return only payables whose `project_id` include at least one of the project_id with the specified IDs. Valid but nonexistent project IDs do not raise errors but produce no results. */ project_id__in?: string[]; /** @description Return only payables whose `tags` include at least one of the tags with the specified IDs. Valid but nonexistent tag IDs do not raise errors but produce no results. */ tag_ids?: string[]; /** @description Return only payables whose `tags` do not include any of the tags with the specified IDs. Valid but nonexistent tag IDs do not raise errors but produce the results. */ tag_ids__not_in?: string[]; /** @description Filter objects based on whether they have tags. If true, only objects with tags are returned. If false, only objects without tags are returned. */ has_tags?: boolean; /** @description Return only payables from a given origin ['einvoice', 'upload', 'email'] */ origin?: components["schemas"]["PayableOriginEnum"]; /** @description Return only payables with or without attachments (files) */ has_file?: boolean; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableAnalyticsResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_analytics_receipts: { parameters: { query: { dimension?: components["schemas"]["ReceiptDimensionEnum"]; metric: components["schemas"]["ReceiptMetricEnum"]; aggregation_function: components["schemas"]["AggregationFunctionEnum"]; date_dimension_breakdown?: components["schemas"]["DateDimensionBreakdownEnum"]; /** @description The number of items (0 .. 400) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; id__in?: string[]; currency?: components["schemas"]["CurrencyEnum"]; document_id?: string; document_id__contains?: string; document_id__icontains?: string; total_amount__gt?: number; total_amount__lt?: number; total_amount__gte?: number; total_amount__lte?: number; has_file?: boolean; has_transaction?: boolean; transaction_id?: string; transaction_id__in?: string[]; merchant_name__icontains?: string; created_by_entity_user_id?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableAnalyticsResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_analytics_receivables: { parameters: { query: { dimension?: components["schemas"]["ReceivableDimensionEnum"]; metric: components["schemas"]["ReceivableMetricEnum"]; aggregation_function: components["schemas"]["AggregationFunctionEnum"]; date_dimension_breakdown?: components["schemas"]["DateDimensionBreakdownEnum"]; /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** * @description The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. * * When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** * @description Return only receivables with the specified IDs. Valid but nonexistent IDs do not raise errors but produce no results. * * To specify multiple IDs, repeat this parameter for each value: * `id__in=&id__in=` */ id__in?: string[]; /** * @description Return only receivables created for the counterparts with the specified IDs. * * To specify multiple IDs, repeat this parameter for each value: * `counterpart_id__in=&counterpart_id__in=` * * Valid but nonexistent IDs do not raise errors but produce no results. */ counterpart_id__in?: string[]; /** * @description Return only receivables that have the specified statuses. See the applicable [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index), [quote statuses](https://docs.monite.com/accounts-receivable/quotes/index), and [credit note statuses](https://docs.monite.com/accounts-receivable/credit-notes#credit-note-lifecycle). * * To specify multiple statuses, repeat this parameter for each value: * `status__in=draft&status__in=issued` */ status__in?: ("draft" | "issuing" | "issued" | "failed" | "accepted" | "expired" | "declined" | "recurring" | "partially_paid" | "paid" | "overdue" | "uncollectible" | "canceled")[]; /** * @description Return only receivables created by the entity users with the specified IDs.To specify multiple user IDs, repeat this parameter for each ID: * `entity_user_id__in=&entity_user_id__in=` * * If the request is authenticated using an entity user token, this user must have the `receivable.read.allowed` (rather than `allowed_for_own`) permission to be able to query receivables created by other users. * * IDs of deleted users will still produce results here if those users had associated receivables. Valid but nonexistent user IDs do not raise errors but produce no results. */ entity_user_id__in?: string[]; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["ReceivableCursorFields"]; /** * @description Return only receivables whose [tags](https://docs.monite.com/common/tags) include at least one of the tags with the specified IDs. * * For example, given receivables with the following tags: * 1. tagA * 2. tagB * 3. tagA, tagB * 4. tagC * 5. tagB, tagC * * * `tag_ids__in=&tag_ids__in=` will return receivables 1, 2, 3, and 5. * * Valid but nonexistent tag IDs do not raise errors but produce no results. */ tag_ids__in?: string[]; /** * @description Return only receivables whose [tags](https://docs.monite.com/common/tags) include all of the tags with the specified IDs and optionally other tags that are not specified. * * For example, given receivables with the following tags: * 1. tagA * 2. tagB * 3. tagA, tagB * 4. tagC * 5. tagA, tagB, tagC * * * `tag_ids=&tag_ids=` will return receivables 3 and 5. */ tag_ids?: string[]; /** * @description Return only receivables whose line items include at least one of the product IDs with the specified IDs. * * To specify multiple product IDs, repeat this parameter for each ID: * `product_ids__in=&product_ids__in=` * * For example, given receivables with the following product IDs: * 1. productA * 2. productB * 3. productA, productB * 4. productC * 5. productB, productC * * * `product_ids__in=&product_ids__in=` will return receivables 1, 2, 3, and 5.Valid but nonexistent product IDs do not raise errors but produce no results. */ product_ids__in?: string[]; /** * @description Return only receivables whose line items include all of the product IDs with the specified IDs and optionally other products that are not specified. * * To specify multiple product IDs, repeat this parameter for each ID: * `product_ids=&product_ids=` * * For example, given receivables with the following product IDs: * 1. productA * 2. productB * 3. productA, productB * 4. productC * 5. productA, productB, productC * * * `product_ids=&product_ids=` will return receivables 3 and 5. */ product_ids?: string[]; /** @description Return only receivables whose `project_id` include at least one of the project_id with the specified IDs. Valid but nonexistent project IDs do not raise errors but produce no results. */ project_id__in?: string[]; type?: components["schemas"]["ReceivableType"]; document_id?: string; document_id__contains?: string; document_id__icontains?: string; issue_date__gt?: string; issue_date__lt?: string; issue_date__gte?: string; issue_date__lte?: string; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; counterpart_id?: string; counterpart_name?: string; counterpart_name__contains?: string; counterpart_name__icontains?: string; total_amount?: number; total_amount__gt?: number; total_amount__lt?: number; total_amount__gte?: number; total_amount__lte?: number; discounted_subtotal?: number; discounted_subtotal__gt?: number; discounted_subtotal__lt?: number; discounted_subtotal__gte?: number; discounted_subtotal__lte?: number; status?: "draft" | "issuing" | "issued" | "failed" | "accepted" | "expired" | "declined" | "recurring" | "partially_paid" | "paid" | "overdue" | "uncollectible" | "canceled"; entity_user_id?: string; based_on?: string; due_date__gt?: string; due_date__lt?: string; due_date__gte?: string; due_date__lte?: string; has_due_date?: boolean; project_id?: string; search_text?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivablesAnalyticsResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_analytics_transactions: { parameters: { query: { dimension?: components["schemas"]["TransactionDimensionEnum"]; metric: components["schemas"]["TransactionMetricEnum"]; aggregation_function: components["schemas"]["AggregationFunctionEnum"]; date_dimension_breakdown?: components["schemas"]["DateDimensionBreakdownEnum"]; limit?: number; has_validation_errors?: boolean; /** @description Created after this datetime (exclusive) */ created_at__gt?: string; /** @description Created before this datetime (exclusive) */ created_at__lt?: string; /** @description Updated after this datetime (exclusive) */ updated_at__gt?: string; /** @description Updated before this datetime (exclusive) */ updated_at__lt?: string; /** @description Transaction started after this datetime (exclusive) */ started_at__gt?: string; /** @description Transaction started before this datetime (exclusive) */ started_at__lt?: string; /** @description One or multiple of the transaction statuses */ payment_processing_status__in?: components["schemas"]["TransactionStatusEnum"][]; /** @description One or multiple of the transaction types */ type__in?: components["schemas"]["TransactionTypeEnum"][]; /** @description One or multiple of the entity users */ entity_user_id__in?: string[]; /** @description One or multiple of the transaction external ids */ external_id__in?: string[]; /** @description Amount greater than (exclusive) */ amount__gt?: number; /** @description Amount less than (exclusive) */ amount__lt?: number; /** @description One or multiple of the transaction currencies */ currency__in?: components["schemas"]["CurrencyEnum"][]; /** @description Merchant amount greater than (exclusive) */ merchant_amount__gt?: number; /** @description Merchant amount less than (exclusive) */ merchant_amount__lt?: number; /** @description One or multiple of the transaction merchant currencies */ merchant_currency__in?: components["schemas"]["CurrencyEnum"][]; /** @description Partially matched merchant name */ merchant_name__icontains?: string; /** @description Payment method type of the transaction */ payment_method?: components["schemas"]["TransactionPaymentMethodTypeEnum"]; /** @description One or multiple of the payment method types */ payment_method__in?: components["schemas"]["TransactionPaymentMethodTypeEnum"][]; /** @description Filter by expense status */ expense_status?: components["schemas"]["ExpenseStatusEnum"]; /** @description One or multiple expense statuses */ expense_status__in?: components["schemas"]["ExpenseStatusEnum"][]; /** @description Filter by presence of a linked receipt. true — return only transactions that have a receipt attached. false — return only transactions without a receipt. Omit to return all transactions. */ has_receipt?: boolean; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionAnalyticsResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_approval-policies": { parameters: { query?: { process_id?: string; /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["ApprovalPolicyCursorFields"]; id__in?: string[]; status?: "active" | "pending"; status__in?: ("active" | "pending")[]; name?: string; name__contains?: string; name__ncontains?: string; created_by?: string; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; updated_at__gt?: string; updated_at__lt?: string; updated_at__gte?: string; updated_at__lte?: string; object_type?: components["schemas"]["ObjectType"]; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApprovalPolicyResourceList"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_approval-policies": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ApprovalPolicyCreate"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApprovalPolicyResource"]; }; }; /** @description Possible responses: `Script validation error: {errors}.` */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_approval-policies_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { approval_policy_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApprovalPolicyResource"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_approval-policies_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { approval_policy_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_approval-policies_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { approval_policy_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ApprovalPolicyUpdate"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApprovalPolicyResource"]; }; }; /** @description Possible responses: `Script validation error: {errors}.` */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_approval-policies_id_processes": { parameters: { query?: { object_id?: string; object_type?: components["schemas"]["ObjectType"]; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { approval_policy_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApprovalProcessResourceList"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_approval-policies_id_processes_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { approval_policy_id: string; process_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProcessResource"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Possible responses: `Approval policy with ID {id} not found.`, `Approval policy process with ID {id} not found.` */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_approval-policies_id_processes_id_cancel": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { approval_policy_id: string; process_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProcessResource"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Possible responses: `Approval policy with ID {id} not found.`, `Approval policy process with ID {id} not found.` */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Possible responses: `Action is not allowed for approval policy process with id {id} because it is not in one of the following statuses: {possible_statuses}` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_approval-policies_id_processes_id_steps": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { approval_policy_id: string; process_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApprovalProcessStepResourceList"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Possible responses: `Approval policy with ID {id} not found.`, `Approval policy process with ID {id} not found.` */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_approval-requests": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["ApprovalRequestCursorFields"]; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; updated_at__gt?: string; updated_at__lt?: string; updated_at__gte?: string; updated_at__lte?: string; object_id?: string; object_id__in?: string[]; status?: components["schemas"]["ApprovalRequestStatus"]; status__in?: components["schemas"]["ApprovalRequestStatus"][]; user_id?: string; object_type?: components["schemas"]["ObjectType"]; object_type__in?: components["schemas"]["ObjectType"][]; created_by?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApprovalRequestResourceList"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_approval-requests": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ApprovalRequestCreateRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApprovalRequestResourceWithMetadata"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_approval-requests_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { approval_request_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApprovalRequestResourceWithMetadata"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_approval-requests_id_approve": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { approval_request_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApprovalRequestResourceWithMetadata"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_approval-requests_id_cancel": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { approval_request_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApprovalRequestResourceWithMetadata"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_approval-requests_id_reject": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { approval_request_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ApprovalRequestRejectRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApprovalRequestResourceWithMetadata"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_bank-details": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityBankAccountPaginationResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_bank-details": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateEntityBankAccountRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityBankAccountResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_bank-details_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { bank_account_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityBankAccountResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_bank-details_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { bank_account_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_bank-details_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { bank_account_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateEntityBankAccountRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityBankAccountResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_batch-payment-links": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["BatchPaymentLinkRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BatchPaymentLinkResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_batch-payment-links_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { batch_payment_link_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BatchPaymentLinkWithPaymentIntents"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_batch-payment-links_id_expire": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { batch_payment_link_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BatchPaymentLinkWithPaymentIntents"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_batch-payments": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PaymentsBatchPaymentRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentsBatchPaymentResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_batch-payments_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { batch_payment_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentsBatchPaymentResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_comments: { parameters: { query: { object_type: components["schemas"]["ObjectTypeAvailableComment"]; object_id: string; /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string | null; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["CommentCursorFields"] | null; created_at__gt?: string | null; created_at__lt?: string | null; created_at__gte?: string | null; created_at__lte?: string | null; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CommentResourceList"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Possible responses: `Action {action} for {object_type} not allowed`, `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}``{operation}: status has not changed` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_comments: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CommentCreateRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CommentResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Possible responses: `Could not notify groups: {not_valid_recipients}. Recipients dont exists`, `groups with ids: {','.join(missed_ids)} dont exists`, `Could not notify groups: {missed_groups}. Only {available_groups} are available`, `Action {action} for {object_type} not allowed`, `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}``{operation}: status has not changed` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_comments_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { comment_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CommentResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Possible responses: `Action {action} for {object_type} not allowed`, `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}``{operation}: status has not changed` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; delete_comments_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { comment_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Possible responses: `Action {action} for {object_type} not allowed`, `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}``{operation}: status has not changed` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_comments_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { comment_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CommentUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CommentResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Possible responses: `Action {action} for {object_type} not allowed`, `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}``{operation}: status has not changed` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; delete_companies: { parameters: { query: { connection_id: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_cost-centers": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** * @description The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. * * When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["TaxRateAccountCursorFields"]; /** @description Filter by external/internal cost centers */ is_external?: boolean; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingCostCenterListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_cost-centers": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["AccountingCostCenterCreateRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingCostCenterResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_cost-centers_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { cost_center_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingCostCenterResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_cost-centers_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { cost_center_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_cost-centers_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { cost_center_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["AccountingCostCenterUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AccountingCostCenterResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_counterparts: { parameters: { query?: { /** @description The IBAN of the counterpart's bank account. */ iban?: string; /** * @description The bank's sort code. * @example 123456 */ sort_code?: string; /** @description The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits. */ account_number?: string; /** @description The tax ID of the counterpart. */ tax_id?: string; /** @description The VAT ID of the counterpart. */ vat_id?: string; /** @description A list of counterpart IDs to search through. */ id__in?: string[]; /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["CounterpartCursorFields"]; type?: components["schemas"]["CounterpartType"]; counterpart_name?: string; counterpart_name__iexact?: string; counterpart_name__contains?: string; counterpart_name__icontains?: string; is_vendor?: boolean; is_customer?: boolean; email?: string; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; "address.country"?: string; "address.city"?: string; "address.postal_code"?: string; "address.state"?: string; "address.line1"?: string; "address.line2"?: string; tag_ids__in?: string[]; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartPaginationResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_counterparts: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CounterpartCreatePayload"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_counterparts_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; delete_counterparts_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_counterparts_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CounterpartUpdatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_counterparts_id_addresses: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartAddressResourceList"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_counterparts_id_addresses: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CounterpartAddress"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartAddressResponseWithCounterpartID"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_counterparts_id_addresses_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { address_id: string; counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartAddressResponseWithCounterpartID"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; delete_counterparts_id_addresses_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { address_id: string; counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_counterparts_id_addresses_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { address_id: string; counterpart_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CounterpartUpdateAddress"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartAddressResponseWithCounterpartID"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_counterparts_id_bank-accounts": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartBankAccountResourceList"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_counterparts_id_bank-accounts": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateCounterpartBankAccount"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartBankAccountResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_counterparts_id_bank-accounts_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { bank_account_id: string; counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartBankAccountResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_counterparts_id_bank-accounts_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { bank_account_id: string; counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_counterparts_id_bank-accounts_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { bank_account_id: string; counterpart_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateCounterpartBankAccount"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartBankAccountResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_counterparts_id_bank-accounts_id_make-default": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { bank_account_id: string; counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_counterparts_id_contacts: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartContactsResourceList"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_counterparts_id_contacts: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateCounterpartContactPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartContactResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_counterparts_id_contacts_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { contact_id: string; counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartContactResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; delete_counterparts_id_contacts_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { contact_id: string; counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_counterparts_id_contacts_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { contact_id: string; counterpart_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateCounterpartContactPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartContactResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_counterparts_id_contacts_id_make-default": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { contact_id: string; counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartContactResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_counterparts_id_einvoicing-credentials": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartEinvoicingCredentialResponseList"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_counterparts_id_einvoicing-credentials": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateCounterpartEinvoicingCredentialPayload"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartEinvoicingCredentialResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_counterparts_id_einvoicing-credentials_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { credential_id: string; counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartEinvoicingCredentialResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_counterparts_id_einvoicing-credentials_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { credential_id: string; counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_counterparts_id_einvoicing-credentials_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { credential_id: string; counterpart_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateCounterpartEinvoicingCredentialSchema"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartEinvoicingCredentialResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_counterparts_id_partner-metadata": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PartnerMetadataResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "put_counterparts_id_partner-metadata": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PartnerMetadata"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PartnerMetadataResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_counterparts_id_vat-ids": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartVatIDResourceList"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_counterparts_id_vat-ids": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { counterpart_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CounterpartVatID"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartVatIDResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_counterparts_id_vat-ids_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { vat_id: string; counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartVatIDResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_counterparts_id_vat-ids_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { vat_id: string; counterpart_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_counterparts_id_vat-ids_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { vat_id: string; counterpart_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CounterpartUpdateVatID"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartVatIDResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_custom-tax-rates": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CustomTaxRateResponseList"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_custom-tax-rates": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CustomTaxRateRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CustomTaxRateResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_custom-tax-rates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { custom_tax_rate_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CustomTaxRateResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_custom-tax-rates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { custom_tax_rate_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_custom-tax-rates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { custom_tax_rate_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CustomTaxRateUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CustomTaxRateResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_data-exports": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["DataExportCursorFields"]; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; created_by_entity_user_id?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AllDocumentExportResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_data-exports": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ExportPayloadSchema"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreateExportTaskResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Possible responses: `Not all statuses are available: {missed_statuses}. Available ones: {object_statuses},`{missed_objects} are not allowed. Available only {objects}` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_data-exports_extra-data": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["ExportSettingCursorFields"]; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; updated_at__gt?: string; updated_at__lt?: string; updated_at__gte?: string; updated_at__lte?: string; object_id?: string; field_name?: string; field_value?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtraDataResourceList"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_data-exports_extra-data": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ExtraDataCreateRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtraDataResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_data-exports_extra-data_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { extra_data_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtraDataResource"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_data-exports_extra-data_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { extra_data_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtraDataResource"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_data-exports_extra-data_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { extra_data_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ExtraDataUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExtraDataResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_data-exports_supported-formats": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SupportedFormatSchema"][]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_data-exports_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { document_export_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DocumentExportResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_delivery-notes": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["DeliveryNoteCursorFields"]; id__in?: string[]; status?: components["schemas"]["DeliveryNoteStatusEnum"]; status__in?: components["schemas"]["DeliveryNoteStatusEnum"][]; document_id?: string; document_id__contains?: string; document_id__icontains?: string; created_by_entity_user_id?: string; counterpart_id?: string; based_on?: string; based_on_document_id?: string; based_on_document_id__contains?: string; based_on_document_id__icontains?: string; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; delivery_date__gt?: string; delivery_date__lt?: string; delivery_date__gte?: string; delivery_date__lte?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeliveryNoteResourceList"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_delivery-notes": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["DeliveryNoteCreateRequest"] | components["schemas"]["DeliveryNoteCreateBasedOnRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeliveryNoteResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_delivery-notes_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { delivery_note_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeliveryNoteResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_delivery-notes_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { delivery_note_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_delivery-notes_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { delivery_note_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["DeliveryNoteUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeliveryNoteResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_delivery-notes_id_cancel": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { delivery_note_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeliveryNoteResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_delivery-notes_id_mark-as-delivered": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { delivery_note_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DeliveryNoteResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_document-templates": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TemplateListResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_document-templates_system": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TemplateListResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_document-templates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { document_template_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TemplateReceivableResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_document-templates_id_make-default": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { document_template_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TemplateReceivableResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_document-templates_id_preview": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { document_template_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/pdf": unknown; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_documents_generate: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["GenerateDocumentIdRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DocumentResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_documents_last: { parameters: { query: { object_type: string; entity_id: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DocumentResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_documents_reset: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ResetDocumentIdRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_documents_id_next-numbers": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { /** @description Unique ID of the entity */ entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["NextDocumentNumbers"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_einvoice-search": { parameters: { query: { network_identifier: string; network_schema: components["schemas"]["EinvoiceSchemaTypeEnum"]; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CounterpartEinvoicingCredentialExistenceResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_entities: { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string | null; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["EntityCursorFields"] | null; type?: components["schemas"]["EntityTypeEnum"] | null; created_at__gt?: string | null; created_at__lt?: string | null; created_at__gte?: string | null; created_at__lte?: string | null; id__in?: string[] | null; id__not_in?: string[] | null; email?: string | null; email__in?: string[] | null; email__not_in?: string[] | null; status?: components["schemas"]["EntityStatusEnum"] | null; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityPaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_entities: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateEntityRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_entities_me: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_entities_me: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateEntityRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_entities_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { /** @description A unique ID to specify the entity. */ entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_entities_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { /** @description A unique ID to specify the entity. */ entity_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateEntityRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_entities_id_activate: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { /** @description A unique ID to specify the entity. */ entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_entities_id_deactivate: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { /** @description A unique ID to specify the entity. */ entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_entities_id_documents: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; put_entities_id_logo: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { /** @description A unique ID to specify the entity. */ entity_id: string; }; cookie?: never; }; requestBody: { content: { "multipart/form-data": components["schemas"]["Body_put_entities_id_logo"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FileSchema2"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; delete_entities_id_logo: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { /** @description A unique ID to specify the entity. */ entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_entities_id_onboarding-data": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityOnboardingDataResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "put_entities_id_onboarding-data": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { entity_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["EntityOnboardingDataRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityOnboardingDataResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_entities_id_onboarding-data": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { entity_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["EntityOnboardingDataRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityOnboardingDataResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_entities_id_onboarding-requirements": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OnboardingRequirementsResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_entities_id_partner-metadata": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PartnerMetadataResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "put_entities_id_partner-metadata": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { entity_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PartnerMetadata"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PartnerMetadataResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_entities_id_payment-methods": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OnboardingPaymentMethodsResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "put_entities_id_payment-methods": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { entity_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["EnabledPaymentMethods"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OnboardingPaymentMethodsResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_entities_id_settings: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { /** @description A unique ID to specify the entity. */ entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SettingsResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_entities_id_settings: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { /** @description A unique ID to specify the entity. */ entity_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PatchSettingsPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SettingsResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_entities_id_vat-ids": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityVatIDResourceList"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_entities_id_vat-ids": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { entity_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["EntityVatID"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityVatIDResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_entities_id_vat-ids_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { id: string; entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityVatIDResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_entities_id_vat-ids_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { id: string; entity_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_entities_id_vat-ids_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { id: string; entity_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["EntityUpdateVatID"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityVatIDResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_entity-users": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string | null; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["EntityUserCursorFields"] | null; id__in?: string[] | null; id__not_in?: string[] | null; login?: string | null; email?: string | null; status?: string | null; first_name?: string | null; name__istartswith?: string | null; created_at__gt?: string | null; created_at__lt?: string | null; created_at__gte?: string | null; created_at__lte?: string | null; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityUserPaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_entity-users": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateEntityUserRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityUserResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_entity-users_me": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityUserResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_entity-users_me": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateMeEntityUserRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityUserResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_entity-users_my-entity": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_entity-users_my-entity": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateEntityRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_entity-users_my-role": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RoleResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_entity-users_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { entity_user_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityUserResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_entity-users_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { entity_user_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_entity-users_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { entity_user_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateEntityUserRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EntityUserResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_events: { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string | null; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["EventCursorFields"] | null; object_type?: components["schemas"]["WebhookObjectType"] | null; created_at__gt?: string | null; created_at__lt?: string | null; created_at__gte?: string | null; created_at__lte?: string | null; }; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EventPaginationResource"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_events_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { /** @description ID of the webhook event. This is the `id` value you might have received in a webhook or retrieved from `GET /events`. */ event_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EventResource"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_files: { parameters: { query?: { id__in?: string[] | null; file_type?: components["schemas"]["AllowedFileTypes"] | null; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FilesResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_files: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "multipart/form-data": components["schemas"]["UploadFile"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FileResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_files_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { file_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FileResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; delete_files_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { file_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_financing-invoices": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["FinancingInvoiceCursorFields"]; /** @description ID of a payable or receivable invoice. */ invoice_id?: string; /** @description List of invoice IDs. */ invoice_id__in?: string[]; /** @description Status of the invoice. */ status?: components["schemas"]["WCInvoiceStatus"]; /** @description List of invoice statuses. */ status__in?: components["schemas"]["WCInvoiceStatus"][]; /** @description Type of the invoice. payable or receivable. */ type?: components["schemas"]["FinancingInvoiceType"]; /** @description List of invoice types. */ type__in?: components["schemas"]["FinancingInvoiceType"][]; /** @description Document ID of the invoice. */ document_id?: string; /** @description List of document IDs. */ document_id__in?: string[]; /** @description Issue date greater than. */ issue_date__gt?: string; /** @description Issue date less than. */ issue_date__lt?: string; /** @description Issue date greater than or equal. */ issue_date__gte?: string; /** @description Issue date less than or equal. */ issue_date__lte?: string; /** @description Due date greater than. */ due_date__gt?: string; /** @description Due date less than. */ due_date__lt?: string; /** @description Due date greater than or equal. */ due_date__gte?: string; /** @description Due date less than or equal. */ due_date__lte?: string; /** @description Created date greater than. */ created_at__gt?: string; /** @description Created date less than. */ created_at__lt?: string; /** @description Created date greater than or equal. */ created_at__gte?: string; /** @description Created date less than or equal. */ created_at__lte?: string; /** @description Total amount of the invoice in minor units. */ total_amount?: number; /** @description Total amount greater than. */ total_amount__gt?: number; /** @description Total amount less than. */ total_amount__lt?: number; /** @description Total amount greater than or equal. */ total_amount__gte?: number; /** @description Total amount less than or equal. */ total_amount__lte?: number; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FinancingInvoiceListResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_financing-invoices": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["FinancingPushInvoicesRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FinancingPushInvoicesResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_financing-offers": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FinancingOffersResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_financing-tokens": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["FinancingTokenResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_get-rates-v2": { parameters: { query: { /** @description ISO code of the currency we are going to work with — USD, THB etc */ currency: components["schemas"]["CurrencyEnum"]; /** @description List of target currencies to convert to */ currencies_to?: components["schemas"]["CurrencyEnum"][] | null; /** @description Date of the exchange rate */ date?: string | null; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RatesResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_internal_batch-payment-links_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { batch_payment_link_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InternalBatchPaymentLinkResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_internal_currencies: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": { [key: string]: components["schemas"]["CurrencyDetails"]; }; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_internal_payment-intents_id_authorize": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { payment_intent_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["AuthPaymentIntentPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AuthPaymentIntentResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_internal_payment-intents_id_authorize-embedded": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { payment_intent_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["EmbeddedAuthPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbeddedAuthorizationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_internal_payment-intents_id_authorize-embedded_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { payment_intent_id: string; consent_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbeddedAuthorizationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_internal_payment-intents_id_authorize-embedded_id_set-sca-code": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { payment_intent_id: string; consent_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["SetScaCodePayload"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbeddedAuthorizationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Payment consent rejected. You need to reinitialize session to start again */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_internal_payment-intents_id_authorize-embedded_id_set-sca-method": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { payment_intent_id: string; consent_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["SetScaMethodPayload"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["EmbeddedAuthorizationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_internal_payment-intents_id_banks": { parameters: { query?: { auth_flow?: components["schemas"]["SupportedPaymentAuthorizationFlow"][]; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { payment_intent_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["BanksResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_internal_payment-intents_id_confirm-payment": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; "user-agent"?: string; }; path: { payment_intent_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PaymentMethodsConfirmPaymentPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentMethodsConfirmResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_internal_payment-intents_id_confirm-tesouro": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { payment_intent_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_internal_payment-intents_id_payments": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { payment_intent_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ConsentPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentIntentResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_internal_payment-links_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { payment_link_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InternalPaymentLinkResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_internal_payment-links_id_regenerate": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { payment_link_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["InternalPaymentLinkResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_internal_payment-page-theme": { parameters: { query: { partner_id: string; project_id: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentPageThemeWithFooter"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_ledger-accounts": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** * @description The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. * * When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["LedgerAccountCursorFields"]; /** @description Filter by external/internal ledger accounts */ is_external?: boolean; /** @description Filter by a list of ledger account IDs */ id__in?: string[]; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LedgerAccountListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_ledger-accounts": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["LedgerAccountCreateRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LedgerAccountResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_ledger-accounts_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { ledger_account_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LedgerAccountResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_ledger-accounts_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { ledger_account_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_ledger-accounts_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { ledger_account_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["LedgerAccountUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LedgerAccountResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_mail-templates": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["CustomTemplatesCursorFields"]; type?: components["schemas"]["DocumentObjectTypeRequestEnum"]; type__in?: components["schemas"]["DocumentObjectTypeRequestEnum"][]; type__not_in?: components["schemas"]["DocumentObjectTypeRequestEnum"][]; is_default?: boolean; name?: string; name__iexact?: string; name__contains?: string; name__icontains?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CustomTemplatesPaginationResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_mail-templates": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["AddCustomTemplateSchema"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CustomTemplateDataSchema"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_mail-templates_preview": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PreviewTemplateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PreviewTemplateResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_mail-templates_system": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SystemTemplates"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_mail-templates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { template_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CustomTemplateDataSchema"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_mail-templates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { template_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_mail-templates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { template_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateCustomTemplateSchemaRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CustomTemplateDataSchema"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_mail-templates_id_make-default": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { template_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CustomTemplateDataSchema"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_mailbox-domains": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DomainListResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_mailbox-domains": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["DomainRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["DomainResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_mailbox-domains_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { domain_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_mailbox-domains_id_verify": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { domain_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["VerifyResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_mailboxes: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MailboxDataResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_mailboxes: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["MailboxDomainRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MailboxResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_mailboxes_search: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["MailboxMultipleEntitiesRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["MailboxDataResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; delete_mailboxes_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { mailbox_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_measure-units": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_measure-units": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UnitRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_measure-units_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { unit_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_measure-units_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { unit_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_measure-units_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { unit_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UnitUpdate"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["UnitResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_ocr-tasks": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["CursorFields"]; /** @description Return only ocr tasks created after the specified date and time. The value must be in the ISO 8601 format YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm]. */ created_at__gt?: string; /** @description Return only ocr tasks created in Monite before the specified date and time. */ created_at__lt?: string; /** @description Return only ocr tasks created on or after the specified date and time. */ created_at__gte?: string; /** @description Return only ocr tasks created before or on the specified date and time. */ created_at__lte?: string; /** @description Return only ocr tasks that have the specified status. */ status?: components["schemas"]["OCRTaskStatus"]; /** @description Return only OCR tasks related to documents of a specific type. */ document_type?: components["schemas"]["OCRDocumentTypeEnum"]; /** @description Return only OCR tasks created by the specified source (internal or external). */ source?: components["schemas"]["OCRRequestSource"]; /** * @description Return only ocr tasks with specified IDs. Valid but nonexistent IDs do not raise errors but produce no results. * * To specify multiple IDs, repeat this parameter for each value: `id__in=&id__in=` */ id__in?: string[]; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OCRTasksPaginationResponse"]; }; }; /** @description OCR request is not found */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_ocr-tasks": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateOCRRequestPayload"]; }; }; responses: { /** @description OCR task has been accepted for execution. */ 202: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OcrTaskResponseSchema"]; }; }; /** @description OCR previously tried to recognize this file and failed. */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description File size exceeds the limit for OCR processing. */ 413: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unsupported file format. OCR supports only PNG, JPG, and PDF. */ 415: { headers: { [name: string]: unknown; }; content?: never; }; /** @description The specified file URL is not reachable. */ 421: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description The specified file URL is reachable but returned an HTTP error status code. */ 424: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_ocr-tasks_upload-from-file": { parameters: { query?: { document_type?: components["schemas"]["OCRDocumentTypeEnum"]; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "multipart/form-data": components["schemas"]["OCRFileUpload"]; }; }; responses: { /** @description OCR task has been accepted for execution. */ 202: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OcrTaskResponseSchema"]; }; }; /** @description OCR failed to process the specified file. */ 400: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description File size exceeds the limit for OCR processing. */ 413: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unsupported file format. OCR supports only PNG, JPG, and PDF. */ 415: { headers: { [name: string]: unknown; }; content?: never; }; /** @description File name is too long. */ 422: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_ocr-tasks_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { task_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OcrTaskResponseSchema"]; }; }; /** @description OCR task with the specified ID was not found. */ 404: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_overdue-reminders": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["AllOverdueRemindersResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_overdue-reminders": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["OverdueReminderRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OverdueReminderResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_overdue-reminders_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { overdue_reminder_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OverdueReminderResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_overdue-reminders_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { overdue_reminder_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_overdue-reminders_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { overdue_reminder_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["OverdueReminderUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OverdueReminderResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payable-credit-notes": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["CreditNoteCursorFields"]; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; issued_at?: string; issued_at__gt?: string; issued_at__lt?: string; issued_at__gte?: string; issued_at__lte?: string; document_id?: string; document_id__iexact?: string; document_id__contains?: string; document_id__icontains?: string; has_file?: boolean; total_amount__gt?: number; total_amount__lt?: number; total_amount__gte?: number; total_amount__lte?: number; subtotal__gt?: number; subtotal__lt?: number; subtotal__gte?: number; subtotal__lte?: number; based_on?: string; counterpart_id?: string; created_by_entity_user_id?: string; status?: components["schemas"]["PayableCreditNoteStateEnum"]; status__in?: components["schemas"]["PayableCreditNoteStateEnum"][]; status__not_in?: components["schemas"]["PayableCreditNoteStateEnum"][]; origin?: components["schemas"]["OriginEnum"]; currency?: components["schemas"]["CurrencyEnum"]; project_id?: string; project_id__in?: string[]; }; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNotePaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payable-credit-notes": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreditNoteCreateRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payable-credit-notes_upload-from-file": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path?: never; cookie?: never; }; requestBody: { content: { "multipart/form-data": components["schemas"]["CreditNoteUploadFile"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Error uploading the file. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "get_payable-credit-notes_validations": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteValidationsResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "put_payable-credit-notes_validations": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreditNoteValidationsResource"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteValidationsResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payable-credit-notes_validations_reset": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteValidationsResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "get_payable-credit-notes_id": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "delete_payable-credit-notes_id": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "patch_payable-credit-notes_id": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreditNoteUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payable-credit-notes_id_approve": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payable-credit-notes_id_cancel": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payable-credit-notes_id_cancel-ocr": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Credit Note couldn't be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "get_payable-credit-notes_id_line-items": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["CreditNoteLineItemCursorFields"]; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; name?: string; name__iexact?: string; name__contains?: string; name__icontains?: string; description?: string; description__contains?: string; description__icontains?: string; total__gt?: number; total__lt?: number; total__gte?: number; total__lte?: number; subtotal__gt?: number; subtotal__lt?: number; subtotal__gte?: number; subtotal__lte?: number; unit_price__gt?: number; unit_price__lt?: number; unit_price__gte?: number; unit_price__lte?: number; quantity__gt?: number; quantity__lt?: number; quantity__gte?: number; quantity__lte?: number; tax__gt?: number; tax__lt?: number; tax__gte?: number; tax__lte?: number; tax_amount__gt?: number; tax_amount__lt?: number; tax_amount__gte?: number; tax_amount__lte?: number; created_by_user_id?: string; unit?: string; unit__iexact?: string; source?: string; source_id?: string; }; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteLineItemPaginationResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "put_payable-credit-notes_id_line-items": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreditNoteLineItemReplaceRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteLineItemPaginationResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payable-credit-notes_id_line-items": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreditNoteLineItemCreateRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteLineItemResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "get_payable-credit-notes_id_line-items_id": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; line_item_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteLineItemResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "delete_payable-credit-notes_id_line-items_id": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; line_item_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteLineItemPaginationResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "patch_payable-credit-notes_id_line-items_id": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; line_item_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreditNoteLineItemUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteLineItemResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payable-credit-notes_id_reject": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payable-credit-notes_id_submit-for-approval": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "get_payable-credit-notes_id_validate": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { credit_note_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["CreditNoteValidationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "get_payable-purchase-orders": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["PurchaseOrderCursorFields"]; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; updated_at__gt?: string; updated_at__lt?: string; updated_at__gte?: string; updated_at__lte?: string; issued_at__gt?: string; issued_at__lt?: string; issued_at__gte?: string; issued_at__lte?: string; status?: components["schemas"]["PurchaseOrderStatusEnum"]; document_id?: string; document_id__in?: string[]; created_by?: string; counterpart_id?: string; counterpart_id__in?: string[]; "counterpart.name"?: string; currency?: components["schemas"]["CurrencyEnum"]; currency__in?: components["schemas"]["CurrencyEnum"][]; project_id?: string; }; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PurchaseOrderPaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payable-purchase-orders": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PurchaseOrderPayloadSchema"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PurchaseOrderResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "get_payable-purchase-orders_variables": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["VariablesObjectList"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "get_payable-purchase-orders_id": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { purchase_order_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PurchaseOrderResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "delete_payable-purchase-orders_id": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { purchase_order_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "patch_payable-purchase-orders_id": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { purchase_order_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdatePurchaseOrderPayloadSchema"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PurchaseOrderResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payable-purchase-orders_id_preview": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { purchase_order_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PurchaseOrderEmailPreviewRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PurchaseOrderEmailPreviewResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payable-purchase-orders_id_send": { parameters: { query?: never; header: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id": string; }; path: { purchase_order_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["SendPurchaseOrderViaEmailRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PurchaseOrderEmailSentResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_payables: { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["PayableCursorFields"]; /** @description Return only payables created in Monite after the specified date and time. The value must be in the ISO 8601 format YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm]. */ created_at__gt?: string; /** @description Return only payables created in Monite before the specified date and time. */ created_at__lt?: string; /** @description Return only payables created in Monite on or after the specified date and time. */ created_at__gte?: string; /** @description Return only payables created in Monite before or on the specified date and time. */ created_at__lte?: string; /** * @description Return only payables that have the specified [status](https://docs.monite.com/accounts-payable/payables/index). * * To query multiple statuses at once, use the `status__in` parameter instead. */ status?: components["schemas"]["PayableStateEnum"]; /** * @description Return only payables that have the specified [statuses](https://docs.monite.com/accounts-payable/payables/index). * * To specify multiple statuses, repeat this parameter for each value: `status__in=draft&status__in=new` */ status__in?: components["schemas"]["PayableStateEnum"][]; /** * @description Return only payables with specified IDs. Valid but nonexistent IDs do not raise errors but produce no results. * * To specify multiple IDs, repeat this parameter for each value: `id__in=&id__in=` */ id__in?: string[]; /** @description Return only payables with the exact specified total amount. The amount must be specified in the minor units of currency. For example, $12.5 is represented as 1250. */ total_amount?: number; /** @description Return only payables whose total amount (in minor units) exceeds the specified value. */ total_amount__gt?: number; /** @description Return only payables whose total amount (in minor units) is less than the specified value. */ total_amount__lt?: number; /** @description Return only payables whose total amount (in minor units) is greater than or equal to the specified value. */ total_amount__gte?: number; /** @description Return only payables whose total amount (in minor units) is less than or equal to the specified value. */ total_amount__lte?: number; /** @description Return only payables with the specified amount. */ amount?: number; /** @description Return only payables whose amount (in minor units) exceeds the specified value. */ amount__gt?: number; /** @description Return only payables whose amount (in minor units) is less than the specified value. */ amount__lt?: number; /** @description Return only payables whose amount (in minor units) is greater than or equal to the specified value. */ amount__gte?: number; /** @description Return only payables whose amount (in minor units) is less than or equal to the specified value. */ amount__lte?: number; /** @description Return only payables that use the specified currency. */ currency?: components["schemas"]["CurrencyEnum"]; /** * @description Return only payables received from counterparts with the specified name (exact match, case-sensitive). * * For counterparts of `type = individual`, the full name is formatted as `first_name last_name`. */ counterpart_name?: string; /** @description Return only payables received from counterparts whose name contains the specified string (case-sensitive). */ counterpart_name__contains?: string; /** @description Return only payables received from counterparts whose name contains the specified string (case-insensitive). */ counterpart_name__icontains?: string; /** @description Apply the `icontains` condition to search for the specified text in the `document_id` and `counterpart_name` fields in the payables. */ search_text?: string; /** @description Return payables that are due on the specified date (YYYY-MM-DD) */ due_date?: string; /** @description Return payables that are due after the specified date (exclusive, YYYY-MM-DD). */ due_date__gt?: string; /** @description Return payables that are due before the specified date (exclusive, YYYY-MM-DD). */ due_date__lt?: string; /** @description Return payables that are due on or after the specified date (YYYY-MM-DD). */ due_date__gte?: string; /** @description Return payables that are due before or on the specified date (YYYY-MM-DD). */ due_date__lte?: string; /** @description Return payables that are issued at the specified date (YYYY-MM-DD) */ issued_at?: string; /** @description Return payables that are issued after the specified date (exclusive, YYYY-MM-DD). */ issued_at__gt?: string; /** @description Return payables that are issued before the specified date (exclusive, YYYY-MM-DD). */ issued_at__lt?: string; /** @description Return payables that are issued on or after the specified date (YYYY-MM-DD). */ issued_at__gte?: string; /** @description Return payables that are issued before or on the specified date (YYYY-MM-DD). */ issued_at__lte?: string; /** * @description Return a payable with the exact specified document number (case-sensitive). * * The `document_id` is the user-facing document number such as INV-00042, not to be confused with Monite resource IDs (`id`). */ document_id?: string; /** @description Return only payables whose document number (`document_id`) contains the specified string (case-sensitive). */ document_id__contains?: string; /** @description Return only payables whose document number (`document_id`) contains the specified string (case-insensitive). */ document_id__icontains?: string; /** @description Return only payables created in Monite by the entity user with the specified ID. */ was_created_by_user_id?: string; /** * @description Return only payables received from the counterpart with the specified ID. * * Counterparts that have been deleted but have associated payables will still return results here because the payables contain a frozen copy of the counterpart data. * * If the specified counterpart ID does not exist and never existed, no results are returned. */ counterpart_id?: string; /** * @description Return only payables received from the counterparts with the specified IDs. Valid but nonexistent IDs do not raise errors but produce no results. * * To specify multiple IDs, repeat this parameter for each value: `counterpart_id__in=&counterpart_id__in=` */ counterpart_id__in?: string[]; /** @description Return only payables coming from the specified source. */ source_of_payable_data?: components["schemas"]["SourceOfPayableDataEnum"]; /** @description Return only payables with specific OCR statuses. */ ocr_status?: components["schemas"]["OcrStatusEnum"]; /** @description Search for a payable by the identifier of the line item associated with it. */ line_item_id?: string; /** @description Search for a payable by the identifier of the purchase order associated with it. */ purchase_order_id?: string; /** * @description Return only payables assigned to the project with the specified ID. * * Valid but nonexistent project IDs do not raise errors but return no results. */ project_id?: string; /** @description Return only payables whose `project_id` include at least one of the project_id with the specified IDs. Valid but nonexistent project IDs do not raise errors but produce no results. */ project_id__in?: string[]; /** @description Return only payables whose `tags` include at least one of the tags with the specified IDs. Valid but nonexistent tag IDs do not raise errors but produce no results. */ tag_ids?: string[]; /** @description Return only payables whose `tags` do not include any of the tags with the specified IDs. Valid but nonexistent tag IDs do not raise errors but produce the results. */ tag_ids__not_in?: string[]; /** @description Filter objects based on whether they have tags. If true, only objects with tags are returned. If false, only objects without tags are returned. */ has_tags?: boolean; /** @description Return only payables from a given origin ['einvoice', 'upload', 'email'] */ origin?: components["schemas"]["PayableOriginEnum"]; /** @description Return only payables with or without attachments (files) */ has_file?: boolean; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayablePaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; post_payables: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PayableUploadWithDataSchema"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_payables_analytics: { parameters: { query?: { /** @description Return only payables created in Monite after the specified date and time. The value must be in the ISO 8601 format YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm]. */ created_at__gt?: string; /** @description Return only payables created in Monite before the specified date and time. */ created_at__lt?: string; /** @description Return only payables created in Monite on or after the specified date and time. */ created_at__gte?: string; /** @description Return only payables created in Monite before or on the specified date and time. */ created_at__lte?: string; /** * @description Return only payables that have the specified [status](https://docs.monite.com/accounts-payable/payables/index). * * To query multiple statuses at once, use the `status__in` parameter instead. */ status?: components["schemas"]["PayableStateEnum"]; /** * @description Return only payables that have the specified [statuses](https://docs.monite.com/accounts-payable/payables/index). * * To specify multiple statuses, repeat this parameter for each value: `status__in=draft&status__in=new` */ status__in?: components["schemas"]["PayableStateEnum"][]; /** * @description Return only payables with specified IDs. Valid but nonexistent IDs do not raise errors but produce no results. * * To specify multiple IDs, repeat this parameter for each value: `id__in=&id__in=` */ id__in?: string[]; /** @description Return only payables with the exact specified total amount. The amount must be specified in the minor units of currency. For example, $12.5 is represented as 1250. */ total_amount?: number; /** @description Return only payables whose total amount (in minor units) exceeds the specified value. */ total_amount__gt?: number; /** @description Return only payables whose total amount (in minor units) is less than the specified value. */ total_amount__lt?: number; /** @description Return only payables whose total amount (in minor units) is greater than or equal to the specified value. */ total_amount__gte?: number; /** @description Return only payables whose total amount (in minor units) is less than or equal to the specified value. */ total_amount__lte?: number; /** @description Return only payables with the specified amount. */ amount?: number; /** @description Return only payables whose amount (in minor units) exceeds the specified value. */ amount__gt?: number; /** @description Return only payables whose amount (in minor units) is less than the specified value. */ amount__lt?: number; /** @description Return only payables whose amount (in minor units) is greater than or equal to the specified value. */ amount__gte?: number; /** @description Return only payables whose amount (in minor units) is less than or equal to the specified value. */ amount__lte?: number; /** @description Return only payables that use the specified currency. */ currency?: components["schemas"]["CurrencyEnum"]; /** * @description Return only payables received from counterparts with the specified name (exact match, case-sensitive). * * For counterparts of `type = individual`, the full name is formatted as `first_name last_name`. */ counterpart_name?: string; /** @description Return only payables received from counterparts whose name contains the specified string (case-sensitive). */ counterpart_name__contains?: string; /** @description Return only payables received from counterparts whose name contains the specified string (case-insensitive). */ counterpart_name__icontains?: string; /** @description Apply the `icontains` condition to search for the specified text in the `document_id` and `counterpart_name` fields in the payables. */ search_text?: string; /** @description Return payables that are due on the specified date (YYYY-MM-DD) */ due_date?: string; /** @description Return payables that are due after the specified date (exclusive, YYYY-MM-DD). */ due_date__gt?: string; /** @description Return payables that are due before the specified date (exclusive, YYYY-MM-DD). */ due_date__lt?: string; /** @description Return payables that are due on or after the specified date (YYYY-MM-DD). */ due_date__gte?: string; /** @description Return payables that are due before or on the specified date (YYYY-MM-DD). */ due_date__lte?: string; /** @description Return payables that are issued at the specified date (YYYY-MM-DD) */ issued_at?: string; /** @description Return payables that are issued after the specified date (exclusive, YYYY-MM-DD). */ issued_at__gt?: string; /** @description Return payables that are issued before the specified date (exclusive, YYYY-MM-DD). */ issued_at__lt?: string; /** @description Return payables that are issued on or after the specified date (YYYY-MM-DD). */ issued_at__gte?: string; /** @description Return payables that are issued before or on the specified date (YYYY-MM-DD). */ issued_at__lte?: string; /** * @description Return a payable with the exact specified document number (case-sensitive). * * The `document_id` is the user-facing document number such as INV-00042, not to be confused with Monite resource IDs (`id`). */ document_id?: string; /** @description Return only payables whose document number (`document_id`) contains the specified string (case-sensitive). */ document_id__contains?: string; /** @description Return only payables whose document number (`document_id`) contains the specified string (case-insensitive). */ document_id__icontains?: string; /** @description Return only payables created in Monite by the entity user with the specified ID. */ was_created_by_user_id?: string; /** * @description Return only payables received from the counterpart with the specified ID. * * Counterparts that have been deleted but have associated payables will still return results here because the payables contain a frozen copy of the counterpart data. * * If the specified counterpart ID does not exist and never existed, no results are returned. */ counterpart_id?: string; /** * @description Return only payables received from the counterparts with the specified IDs. Valid but nonexistent IDs do not raise errors but produce no results. * * To specify multiple IDs, repeat this parameter for each value: `counterpart_id__in=&counterpart_id__in=` */ counterpart_id__in?: string[]; /** @description Return only payables coming from the specified source. */ source_of_payable_data?: components["schemas"]["SourceOfPayableDataEnum"]; /** @description Return only payables with specific OCR statuses. */ ocr_status?: components["schemas"]["OcrStatusEnum"]; /** @description Search for a payable by the identifier of the line item associated with it. */ line_item_id?: string; /** @description Search for a payable by the identifier of the purchase order associated with it. */ purchase_order_id?: string; /** * @description Return only payables assigned to the project with the specified ID. * * Valid but nonexistent project IDs do not raise errors but return no results. */ project_id?: string; /** @description Return only payables whose `project_id` include at least one of the project_id with the specified IDs. Valid but nonexistent project IDs do not raise errors but produce no results. */ project_id__in?: string[]; /** @description Return only payables whose `tags` include at least one of the tags with the specified IDs. Valid but nonexistent tag IDs do not raise errors but produce no results. */ tag_ids?: string[]; /** @description Return only payables whose `tags` do not include any of the tags with the specified IDs. Valid but nonexistent tag IDs do not raise errors but produce the results. */ tag_ids__not_in?: string[]; /** @description Filter objects based on whether they have tags. If true, only objects with tags are returned. If false, only objects without tags are returned. */ has_tags?: boolean; /** @description Return only payables from a given origin ['einvoice', 'upload', 'email'] */ origin?: components["schemas"]["PayableOriginEnum"]; /** @description Return only payables with or without attachments (files) */ has_file?: boolean; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableAggregatedDataResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; post_payables_storecove: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["StorecoveNewDocumentReceivedEventPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse2"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse2"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse2"]; }; }; }; }; "post_payables_upload-from-file": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "multipart/form-data": components["schemas"]["PayableUploadFile"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** * @description Error uploading the file. You can check the upload * [limitations in the documentation](https://docs.monite.com/accounts-payable/payables/collect#about-monite-ocr). */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_payables_validations: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableValidationsResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; put_payables_validations: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PayableValidationsUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableValidationsResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; post_payables_validations_reset: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableValidationsResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_payables_variables: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableTemplatesVariablesObjectList"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_payables_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableResponseSchema"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn't be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; delete_payables_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; patch_payables_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PayableUpdateSchema"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn't be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payables_id_approve-payment-operation": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn't be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payables_id_attach-file": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody: { content: { "multipart/form-data": components["schemas"]["PayableAttachFile"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn't be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; post_payables_id_cancel: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn't be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payables_id_cancel-ocr": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn't be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_payables_id_history: { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["PayableHistoryCursorFields"]; /** @description Return only the specified event types */ event_type__in?: components["schemas"]["PayableHistoryEventTypeEnum"][]; /** * @description Return only events caused by the entity users with the specified IDs. To specify multiple user IDs, repeat this parameter for each ID: * `entity_user_id__in=&entity_user_id__in=` */ entity_user_id__in?: string[]; /** @description Return only events that occurred after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm]`. */ timestamp__gt?: string; /** @description Return only events that occurred before the specified date and time. */ timestamp__lt?: string; /** @description Return only events that occurred on or after the specified date and time. */ timestamp__gte?: string; /** @description Return only events that occurred before or on the specified date and time. */ timestamp__lte?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableHistoryPaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "get_payables_id_line-items": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["LineItemCursorFields"]; was_created_by_user_id?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LineItemPaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "put_payables_id_line-items": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["LineItemsReplaceRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LineItemsReplaceResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payables_id_line-items": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["LineItemRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LineItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "get_payables_id_line-items_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { line_item_id: string; payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LineItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "delete_payables_id_line-items_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { line_item_id: string; payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "patch_payables_id_line-items_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { line_item_id: string; payable_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["LineItemRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LineItemResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payables_id_mark-as-paid": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["CommentPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn't be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payables_id_mark-as-partially-paid": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PartiallyPaidPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn't be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; post_payables_id_reject: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn't be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; post_payables_id_reopen: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn't be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_payables_id_submit-for-approval": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn't be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_payables_id_suggestions: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SuggestedResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; delete_payables_id_suggestions: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; post_payables_id_validate: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PayableValidationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`, `Object type at permissions not found: {object_type}`, `Action {action} for {object_type} not allowed`, `Payable couldn't be updated due to current state`, `The file cannot be attached because another file is already attached. Please note that only one file attachment is allowed.` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "get_payment-fees": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentFeesListResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_payment-fees": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreatePaymentFeePayload"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentFeeResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-fees_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { fee_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentFeeResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_payment-fees_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { fee_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_payment-fees_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { fee_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdatePaymentFeePayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentFeeResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-intents": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["PaymentIntentCursorFields"]; /** @description ID of a payable or receivable invoice. If provided, returns only payment intents associated with the specified invoice. */ object_id?: string; /** @description A list of payable IDs and/or receivable IDs. If provided, returns only payment intents associated with the specified payable and receivable invoices. Valid but nonexistent IDs do not raise errors but produce no results. */ object_id__in?: string[]; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentIntentsListResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-intents_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_intent_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentIntentResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_payment-intents_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_intent_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdatePaymentIntentPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentIntentResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-intents_id_history": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_intent_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentIntentHistoryResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_payment-links": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreatePaymentLinkRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PublicPaymentLinkResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-links_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_link_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PublicPaymentLinkResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_payment-links_id_expire": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_link_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PublicPaymentLinkResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_payment-onboarding-links": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateOnboardingLinkRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["OnboardingLinkResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-pages": { parameters: { query: { receivable_id: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-records": { parameters: { query?: { /** @description Order by */ order?: components["schemas"]["OrderEnum"]; /** @description Max is 100 */ limit?: number; /** @description A token, obtained from previous page. Prior over other filters */ pagination_token?: string; /** @description Allowed sort fields */ sort?: components["schemas"]["PaymentRecordCursorFields"]; /** @description Identifies whether payment is from our rails or external system */ is_external?: boolean; /** @description ID of the object, that is connected to payment */ object_id?: string; /** @description List of IDs of the objects, that are connected to payments */ object_id__in?: string[]; /** @description Type of an object, which is connected with payment */ object_type?: components["schemas"]["ObjectTypeEnum"]; /** @description Created after this datetime (exclusive) */ created_at__gt?: string; /** @description Created before this datetime (exclusive) */ created_at__lt?: string; /** @description Updated after this datetime (exclusive) */ updated_at__gt?: string; /** @description Updated before this datetime (exclusive) */ updated_at__lt?: string; /** @description Paid after this datetime (exclusive) */ paid_at__gt?: string; /** @description Paid before this datetime (exclusive) */ paid_at__lt?: string; /** @description Optional date of the upcoming payment (equality) */ planned_payment_date?: string; /** @description Planned after this date (exclusive) */ planned_payment_date__gt?: string; /** @description Planned before this date (exclusive) */ planned_payment_date__lt?: string; /** @description Planned at or after this date (inclusive) */ planned_payment_date__gte?: string; /** @description Planned at or before this date (inclusive) */ planned_payment_date__lte?: string; /** @description One of the payment record statuses */ status?: components["schemas"]["PaymentRecordStatusEnum"]; /** @description Payment intent status as a raw string */ payment_intent_status?: string; /** @description Payment method used for the transaction */ payment_method?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentRecordResponseList"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_payment-records": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PaymentRecordRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentRecordResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-records_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_record_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentRecordResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_payment-records_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_record_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PaymentRecordUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentRecordResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_payment-records_id_cancel": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_record_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["PaymentRecordStatusUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentRecordResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_payment-records_id_mark-as-succeeded": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_record_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PaymentRecordMarkAsSucceededRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentRecordResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_payment-records_id_start-processing": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_record_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["PaymentRecordStatusUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentRecordResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-reminders": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["GetAllPaymentReminders"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_payment-reminders": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PaymentReminder"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentReminderResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-reminders_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_reminder_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentReminderResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_payment-reminders_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_reminder_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_payment-reminders_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_reminder_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PaymentReminderUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentReminderResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-terms": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentTermsListResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_payment-terms": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PaymentTermsCreatePayload"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentTermsResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-terms_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_terms_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentTermsResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_payment-terms_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_terms_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_payment-terms_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { payment_terms_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PaymentTermsUpdatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentTermsResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-tiers": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentTiersListResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_payment-tiers": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreatePaymentTierPayload"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentTierResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_payment-tiers_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { tier_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentTierResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_payment-tiers_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { tier_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_payment-tiers_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { tier_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdatePaymentTierPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PaymentTierResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_persons_id_documents: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { person_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_products: { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["ProductCursorFields"]; id__in?: string[]; name?: string; name__contains?: string; name__icontains?: string; type?: components["schemas"]["ProductServiceTypeEnum"]; price?: number; price__gt?: number; price__lt?: number; price__gte?: number; price__lte?: number; currency?: components["schemas"]["CurrencyEnum"]; currency__in?: components["schemas"]["CurrencyEnum"][]; measure_unit_id?: string; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProductServicePaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_products: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ProductServiceRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProductServiceResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_products_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { product_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProductServiceResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; delete_products_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { product_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_products_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { product_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ProductServiceUpdate"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProductServiceResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_projects: { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["ProjectCursorFields"]; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; start_date?: string; start_date__gt?: string; start_date__lt?: string; start_date__gte?: string; start_date__lte?: string; end_date?: string; end_date__gt?: string; end_date__lt?: string; end_date__gte?: string; end_date__lte?: string; name?: string; name__iexact?: string; name__contains?: string; name__icontains?: string; code?: string; created_by_entity_user_id?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectPaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; post_projects: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ProjectCreateRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_projects_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { project_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; delete_projects_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { project_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; patch_projects_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { project_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ProjectUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ProjectResource"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_receipts: { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["ReceiptCursorFields"]; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; id__in?: string[]; currency?: components["schemas"]["CurrencyEnum"]; document_id?: string; document_id__contains?: string; document_id__icontains?: string; total_amount__gt?: number; total_amount__lt?: number; total_amount__gte?: number; total_amount__lte?: number; has_file?: boolean; has_transaction?: boolean; transaction_id?: string; transaction_id__in?: string[]; merchant_name__icontains?: string; created_by_entity_user_id?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceiptPaginationResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; post_receipts: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ReceiptCreateSchema"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceiptResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_receipts_upload-from-file": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "multipart/form-data": components["schemas"]["ReceiptUploadFile"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceiptResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Error uploading the file. */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_receipts_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receipt_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceiptResponseSchema"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; delete_receipts_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receipt_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; patch_receipts_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receipt_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ReceiptUpdateSchema"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceiptResponseSchema"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_receipts_id_attach-file": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receipt_id: string; }; cookie?: never; }; requestBody: { content: { "multipart/form-data": components["schemas"]["ReceiptAttachFile"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceiptResponseSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "get_receipts_id_line-items": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["ReceiptLineItemCursorFields"]; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; name?: string; name__iexact?: string; name__contains?: string; name__icontains?: string; total__gt?: number; total__lt?: number; total__gte?: number; total__lte?: number; created_by_user_id?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receipt_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceiptLineItemsPaginationResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "post_receipts_id_line-items": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receipt_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ReceiptLineItemCreateSchema"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceiptLineItemResponseSchema"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "delete_receipts_id_line-items_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receipt_id: string; line_item_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "patch_receipts_id_line-items_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receipt_id: string; line_item_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ReceiptLineItemUpdateSchema"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceiptLineItemResponseSchema"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_receivables: { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** * @description The number of items (0 .. 250) to return in a single page of the response. Default is 100. The response may contain fewer items if it is the last or only page. * * When using pagination with a non-default `limit`, you must provide the `limit` value alongside `pagination_token` in all subsequent pagination requests. Unlike other query parameters, `limit` is not inferred from `pagination_token`. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters except `limit` are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** * @description Return only receivables with the specified IDs. Valid but nonexistent IDs do not raise errors but produce no results. * * To specify multiple IDs, repeat this parameter for each value: * `id__in=&id__in=` */ id__in?: string[]; /** * @description Return only receivables created for the counterparts with the specified IDs. * * To specify multiple IDs, repeat this parameter for each value: * `counterpart_id__in=&counterpart_id__in=` * * Valid but nonexistent IDs do not raise errors but produce no results. */ counterpart_id__in?: string[]; /** * @description Return only receivables that have the specified statuses. See the applicable [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index), [quote statuses](https://docs.monite.com/accounts-receivable/quotes/index), and [credit note statuses](https://docs.monite.com/accounts-receivable/credit-notes#credit-note-lifecycle). * * To specify multiple statuses, repeat this parameter for each value: * `status__in=draft&status__in=issued` */ status__in?: ("draft" | "issuing" | "issued" | "failed" | "accepted" | "expired" | "declined" | "recurring" | "partially_paid" | "paid" | "overdue" | "uncollectible" | "canceled")[]; /** * @description Return only receivables created by the entity users with the specified IDs.To specify multiple user IDs, repeat this parameter for each ID: * `entity_user_id__in=&entity_user_id__in=` * * If the request is authenticated using an entity user token, this user must have the `receivable.read.allowed` (rather than `allowed_for_own`) permission to be able to query receivables created by other users. * * IDs of deleted users will still produce results here if those users had associated receivables. Valid but nonexistent user IDs do not raise errors but produce no results. */ entity_user_id__in?: string[]; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["ReceivableCursorFields"]; /** * @description Return only receivables whose [tags](https://docs.monite.com/common/tags) include at least one of the tags with the specified IDs. * * For example, given receivables with the following tags: * 1. tagA * 2. tagB * 3. tagA, tagB * 4. tagC * 5. tagB, tagC * * * `tag_ids__in=&tag_ids__in=` will return receivables 1, 2, 3, and 5. * * Valid but nonexistent tag IDs do not raise errors but produce no results. */ tag_ids__in?: string[]; /** * @description Return only receivables whose [tags](https://docs.monite.com/common/tags) include all of the tags with the specified IDs and optionally other tags that are not specified. * * For example, given receivables with the following tags: * 1. tagA * 2. tagB * 3. tagA, tagB * 4. tagC * 5. tagA, tagB, tagC * * * `tag_ids=&tag_ids=` will return receivables 3 and 5. */ tag_ids?: string[]; /** * @description Return only receivables whose line items include at least one of the product IDs with the specified IDs. * * To specify multiple product IDs, repeat this parameter for each ID: * `product_ids__in=&product_ids__in=` * * For example, given receivables with the following product IDs: * 1. productA * 2. productB * 3. productA, productB * 4. productC * 5. productB, productC * * * `product_ids__in=&product_ids__in=` will return receivables 1, 2, 3, and 5.Valid but nonexistent product IDs do not raise errors but produce no results. */ product_ids__in?: string[]; /** * @description Return only receivables whose line items include all of the product IDs with the specified IDs and optionally other products that are not specified. * * To specify multiple product IDs, repeat this parameter for each ID: * `product_ids=&product_ids=` * * For example, given receivables with the following product IDs: * 1. productA * 2. productB * 3. productA, productB * 4. productC * 5. productA, productB, productC * * * `product_ids=&product_ids=` will return receivables 3 and 5. */ product_ids?: string[]; /** @description Return only receivables whose `project_id` include at least one of the project_id with the specified IDs. Valid but nonexistent project IDs do not raise errors but produce no results. */ project_id__in?: string[]; type?: components["schemas"]["ReceivableType"]; document_id?: string; document_id__contains?: string; document_id__icontains?: string; issue_date__gt?: string; issue_date__lt?: string; issue_date__gte?: string; issue_date__lte?: string; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; counterpart_id?: string; counterpart_name?: string; counterpart_name__contains?: string; counterpart_name__icontains?: string; total_amount?: number; total_amount__gt?: number; total_amount__lt?: number; total_amount__gte?: number; total_amount__lte?: number; discounted_subtotal?: number; discounted_subtotal__gt?: number; discounted_subtotal__lt?: number; discounted_subtotal__gte?: number; discounted_subtotal__lte?: number; status?: "draft" | "issuing" | "issued" | "failed" | "accepted" | "expired" | "declined" | "recurring" | "partially_paid" | "paid" | "overdue" | "uncollectible" | "canceled"; entity_user_id?: string; based_on?: string; due_date__gt?: string; due_date__lt?: string; due_date__gte?: string; due_date__lte?: string; has_due_date?: boolean; project_id?: string; search_text?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivablePaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`,`Object type at permissions not found: {object_type}`,`Action {action} for {object_type} not allowed` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_receivables: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ReceivableFacadeCreatePayload"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_receivables_required-fields": { parameters: { query?: { counterpart_id?: string; counterpart_billing_address_id?: string; counterpart_country?: components["schemas"]["AllowedCountries"]; counterpart_type?: components["schemas"]["CounterpartType"]; entity_vat_id_id?: string; counterpart_vat_id_id?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableRequiredFields"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_receivables_search: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ReceivablesSearchRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivablePaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Possible responses: `Action for {object_type} at permissions not found: {action}`,`Object type at permissions not found: {object_type}`,`Action {action} for {object_type} not allowed` */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_receivables_variables: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableTemplatesVariablesObjectList"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_receivables_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; delete_receivables_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_receivables_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ReceivableUpdatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_receivables_id_accept: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["QuoteAcceptRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SuccessResult"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_receivables_id_cancel: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_receivables_id_clone: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_receivables_id_decline: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ReceivableDeclinePayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SuccessResult"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_receivables_id_history: { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["ReceivableHistoryCursorFields"]; /** * @description Return only the specified [event types](https://docs.monite.com/accounts-receivable/document-history#event-types). To include multiple types, repeat this parameter for each value: * `event_type__in=receivable_updated&event_type__in=status_changed` */ event_type__in?: components["schemas"]["ReceivableHistoryEventTypeEnum"][]; /** * @description Return only events caused by the entity users with the specified IDs. To specify multiple user IDs, repeat this parameter for each ID: * `entity_user_id__in=&entity_user_id__in=` */ entity_user_id__in?: string[]; /** @description Return only events that occurred after the specified date and time. The value must be in the ISO 8601 format `YYYY-MM-DDThh:mm[:ss[.ffffff]][Z|±hh:mm]`. */ timestamp__gt?: string; /** @description Return only events that occurred before the specified date and time. */ timestamp__lt?: string; /** @description Return only events that occurred on or after the specified date and time. */ timestamp__gte?: string; /** @description Return only events that occurred before or on the specified date and time. */ timestamp__lte?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { /** @description ID of the accounts receivable document whose history you want to get. */ receivable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableHistoryPaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_receivables_id_history_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { /** @description ID of the history record to return. You can get these IDs from `GET /receivables/{receivable_id}/history`. */ receivable_history_id: string; /** @description ID of the accounts receivable document whose history you want to get. */ receivable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableHistoryResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_receivables_id_issue: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "put_receivables_id_line-items": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateLineItems"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["LineItemsResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_receivables_id_mails: { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["ReceivableMailCursorFields"]; status?: components["schemas"]["ReceivableMailStatusEnum"]; status__in?: components["schemas"]["ReceivableMailStatusEnum"][]; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableMailPaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_receivables_id_mails_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; mail_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableMailResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_receivables_id_mark-as-paid": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ReceivablePaidPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_receivables_id_mark-as-partially-paid": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ReceivablePartiallyPaidPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_receivables_id_mark-as-uncollectible": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["ReceivableUncollectiblePayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_receivables_id_pdf-link": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableFileUrl"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_receivables_id_preview: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ReceivablePreviewRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivablePreviewResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_receivables_id_send: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ReceivableSendRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivableSendResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_receivables_id_send-test-reminder": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ReceivableSendTestReminderPayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivablesSendResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_receivables_id_verify: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; authorization?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { receivable_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ReceivablesVerifyResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_recurrences: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RecurrenceResponseList"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_recurrences: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateRecurrencePayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RecurrenceResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_recurrences_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { recurrence_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RecurrenceResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_recurrences_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { recurrence_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateRecurrencePayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RecurrenceResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_recurrences_id_cancel: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { recurrence_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_recurrences_id_pause: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { recurrence_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_recurrences_id_resume: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { recurrence_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_regulatory-templates": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RegulatoryTemplateResponse"][]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_regulatory-templates": { parameters: { query: { receivable: components["schemas"]["ReceivableFieldsEnum"][]; entity_organization: components["schemas"]["EntityOrganizationFieldsEnum"][]; entity_individual: components["schemas"]["EntityIndividualFieldsEnum"][]; counterpart_organization: components["schemas"]["CounterpartOrganizationFieldsEnum"][]; counterpart_individual: components["schemas"]["CounterpartIndividualFieldsEnum"][]; product: components["schemas"]["ProductFieldsEnum"][]; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RegulatoryTemplateResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_regulatory-templates_download-template-ids-vat-rates": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": unknown; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_regulatory-templates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { regulatory_template_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RegulatoryTemplateResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_regulatory-templates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { regulatory_template_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_regulatory-templates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { regulatory_template_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["RegulatoryTemplateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RegulatoryTemplateResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_render-pdf": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["RenderPdfRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PdfCreatedPayload"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_roles: { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string | null; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["RoleCursorFields"] | null; id__in?: string[] | null; name?: string | null; created_at?: string | null; created_at__gt?: string | null; created_at__lt?: string | null; created_at__gte?: string | null; created_at__lte?: string | null; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RolePaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_roles: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateRoleRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RoleResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_roles_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { role_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RoleResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; delete_roles_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { role_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_roles_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { role_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateRoleRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RoleResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_rules: { parameters: { query?: { object_type?: "receivable"; predicates__name__in?: components["schemas"]["PredicateNameEnum"][]; result_value_id?: string; created_at?: string; created_at__gt?: string; created_at__lt?: string; created_at__gte?: string; created_at__lte?: string; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RuleResponse"][]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_rules: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["RuleRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RuleResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_rules_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { rule_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RuleResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; delete_rules_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { rule_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_rules_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { rule_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["RuleUpdate"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RuleResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_send-email": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["SendEmailSchema"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": boolean; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_send-email_render-template": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["TemplateDocumentTypeSchema"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["RenderTemplateResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_send-email_send-email-by-document-type": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["SendEmailByDocumentSchema"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["SendEmailByDocumentTypeResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_send-email_stateless": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["SendStatelessEmailSchema"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": boolean; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_settings: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PartnerProjectSettingsPayload-Output"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_settings: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["PartnerProjectSettingsPayload-Input"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["PartnerProjectSettingsPayload-Output"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_tags: { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["TagCursorFields"]; created_by_entity_user_id?: string; name__in?: string[]; id__in?: string[]; /** @description Filter tags by a single category value. */ category?: components["schemas"]["TagCategory"]; /** @description Filter tags by any of the provided categories. */ category__in?: components["schemas"]["TagCategory"][]; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TagsPaginationResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; post_tags: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["TagCreateSchema"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TagReadSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; get_tags_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { tag_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TagReadSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; delete_tags_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { tag_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; patch_tags_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { tag_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["TagUpdateSchema"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TagReadSchema"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Not Acceptable */ 406: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse3"]; }; }; }; }; "get_text-templates": { parameters: { query?: { type?: components["schemas"]["TextTemplateType"]; document_type?: components["schemas"]["TextTemplateDocumentTypeEnum"]; is_default?: boolean; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TextTemplateResponseList"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_text-templates": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateTextTemplatePayload"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TextTemplateResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_text-templates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { text_template_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TextTemplateResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_text-templates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { /** @description UUID text_template ID */ text_template_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_text-templates_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { /** @description UUID text_template ID */ text_template_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateTextTemplatePayload"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TextTemplateResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_text-templates_id_make-default": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { /** @description UUID text_template ID */ text_template_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TextTemplateResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_transactions: { parameters: { query?: { /** @description Filter transactions by validation errors. A transaction has validation errors when it is missing one or more fields required by the entity's TransactionValidation config (e.g. receipt_id, description). true — return only transactions with at least one missing required field. false — return only transactions where all required fields are present. Omit to return all transactions regardless of validation state. */ has_validation_errors?: boolean; /** @description Order by */ order?: components["schemas"]["OrderEnum"]; /** @description Max is 100 */ limit?: number; /** @description A token, obtained from previous page. Prior over other filters */ pagination_token?: string; /** @description Allowed sort fields */ sort?: components["schemas"]["TransactionCursorFields"]; /** @description Created after this datetime (exclusive) */ created_at__gt?: string; /** @description Created before this datetime (exclusive) */ created_at__lt?: string; /** @description Updated after this datetime (exclusive) */ updated_at__gt?: string; /** @description Updated before this datetime (exclusive) */ updated_at__lt?: string; /** @description Transaction started after this datetime (exclusive) */ started_at__gt?: string; /** @description Transaction started before this datetime (exclusive) */ started_at__lt?: string; /** @description One or multiple of the transaction statuses */ payment_processing_status__in?: components["schemas"]["TransactionStatusEnum"][]; /** @description One or multiple of the transaction types */ type__in?: components["schemas"]["TransactionTypeEnum"][]; /** @description One or multiple of the entity users */ entity_user_id__in?: string[]; /** @description One or multiple of the transaction external ids */ external_id__in?: string[]; /** @description Amount greater than (exclusive) */ amount__gt?: number; /** @description Amount less than (exclusive) */ amount__lt?: number; /** @description One or multiple of the transaction currencies */ currency__in?: components["schemas"]["CurrencyEnum"][]; /** @description Merchant amount greater than (exclusive) */ merchant_amount__gt?: number; /** @description Merchant amount less than (exclusive) */ merchant_amount__lt?: number; /** @description One or multiple of the transaction merchant currencies */ merchant_currency__in?: components["schemas"]["CurrencyEnum"][]; /** @description Partially matched merchant name */ merchant_name__icontains?: string; /** @description Payment method type of the transaction */ payment_method?: components["schemas"]["TransactionPaymentMethodTypeEnum"]; /** @description One or multiple of the payment method types */ payment_method__in?: components["schemas"]["TransactionPaymentMethodTypeEnum"][]; /** @description Filter by expense status */ expense_status?: components["schemas"]["ExpenseStatusEnum"]; /** @description One or multiple expense statuses */ expense_status__in?: components["schemas"]["ExpenseStatusEnum"][]; /** @description Filter by presence of a linked receipt. true — return only transactions that have a receipt attached. false — return only transactions without a receipt. Omit to return all transactions. */ has_receipt?: boolean; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionResponseList"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_transactions: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["TransactionRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_transactions_bulk: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["TransactionBulkRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionBulkResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_transactions_validations: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionValidationResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; put_transactions_validations: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["TransactionValidationUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionValidationResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_transactions_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { transaction_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; delete_transactions_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { transaction_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; patch_transactions_id: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { transaction_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["TransactionUpdateRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_transactions_id_approve: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { transaction_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_transactions_id_cancel: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { transaction_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; get_transactions_id_expense_history: { parameters: { query?: { /** @description Filter by event type (e.g. status_changed) */ event_type?: components["schemas"]["ExpenseHistoryEventTypeEnum"]; /** @description Sort order by timestamp */ order?: "asc" | "desc"; /** @description Maximum number of records to return */ limit?: number; /** @description Number of records to skip */ offset?: number; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { transaction_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ExpenseHistoryResponseList"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_transactions_id_expense_history: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { transaction_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["ApprovalActionRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ApprovalActionCreatedResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_transactions_id_reject: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { transaction_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["TransactionRejectRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_transactions_id_reopen: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { transaction_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_transactions_id_submit: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { transaction_id: string; }; cookie?: never; }; requestBody?: { content: { "application/json": components["schemas"]["TransactionSubmitRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Business logic error */ 409: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; post_transactions_id_validate: { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path: { transaction_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["TransactionValidateResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_vat-rates": { parameters: { query?: { counterpart_address_id?: string; counterpart_id?: string; counterpart_vat_id_id?: string; entity_vat_id_id?: string; product_type?: components["schemas"]["ProductServiceTypeEnum"]; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["VatRateListResponse"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Unauthorized */ 401: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Forbidden */ 403: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Not found */ 404: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_webhook-deliveries": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string | null; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["WebhookDeliveryCursorFields"] | null; event_id?: string | null; object_type?: components["schemas"]["WebhookObjectType"] | null; event_action?: string | null; created_at__gt?: string | null; created_at__lt?: string | null; created_at__gte?: string | null; created_at__lte?: string | null; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; /** @description The ID of the entity that owns the requested resource. */ "x-organization-id"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["WebhookDeliveryPaginationResource"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_webhook-subscriptions": { parameters: { query?: { /** @description Sort order (ascending by default). Typically used together with the `sort` parameter. */ order?: components["schemas"]["OrderEnum"]; /** @description The number of items (0 .. 100) to return in a single page of the response. The response may contain fewer items if it is the last or only page. */ limit?: number; /** * @description A pagination token obtained from a previous call to this endpoint. Use it to get the next or previous page of results for your initial query. If `pagination_token` is specified, all other query parameters are ignored and inferred from the initial query. * * If not specified, the first page of results will be returned. */ pagination_token?: string | null; /** @description The field to sort the results by. Typically used together with the `order` parameter. */ sort?: components["schemas"]["WebhookSubscriptionCursorFields"] | null; object_type?: components["schemas"]["WebhookObjectType"] | null; created_at__gt?: string | null; created_at__lt?: string | null; created_at__gte?: string | null; created_at__lte?: string | null; }; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["WebhookSubscriptionPaginationResource"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_webhook-subscriptions": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path?: never; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["CreateWebhookSubscriptionRequest"]; }; }; responses: { /** @description Successful Response */ 201: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["WebhookSubscriptionResourceWithSecret"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "get_webhook-subscriptions_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { webhook_subscription_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["WebhookSubscriptionResource"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "delete_webhook-subscriptions_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { webhook_subscription_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "patch_webhook-subscriptions_id": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { webhook_subscription_id: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpdateWebhookSubscriptionRequest"]; }; }; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["WebhookSubscriptionResource"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_webhook-subscriptions_id_disable": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { webhook_subscription_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["WebhookSubscriptionResource"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_webhook-subscriptions_id_enable": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { webhook_subscription_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["WebhookSubscriptionResource"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; "post_webhook-subscriptions_id_regenerate-secret": { parameters: { query?: never; header?: { /** @example 2025-06-23 */ "x-finops-version"?: string; }; path: { webhook_subscription_id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Successful Response */ 200: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["WebhookSubscriptionResourceWithSecret"]; }; }; /** @description Method Not Allowed */ 405: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; /** @description Validation Error */ 422: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["HTTPValidationError"]; }; }; /** @description Internal Server Error */ 500: { headers: { [name: string]: unknown; }; content: { "application/json": components["schemas"]["ErrorSchemaResponse"]; }; }; }; }; ListDepartments: { parameters: { query?: { /** @description Maximum number of results to return. */ limit?: number | string; /** @description Opaque pagination token from a previous response. */ paginationToken?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the paginated list of departments. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["PaginatedResponseOfDepartmentListItem"]; "application/json": components["schemas"]["PaginatedResponseOfDepartmentListItem"]; "text/json": components["schemas"]["PaginatedResponseOfDepartmentListItem"]; }; }; /** @description Bad request - limit out of range. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; CreateDepartment: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["CreateDepartmentRequest"]; "text/json": components["schemas"]["CreateDepartmentRequest"]; "application/*+json": components["schemas"]["CreateDepartmentRequest"]; }; }; responses: { /** @description Department created successfully. */ 201: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["DepartmentListItem"]; "application/json": components["schemas"]["DepartmentListItem"]; "text/json": components["schemas"]["DepartmentListItem"]; }; }; /** @description Bad request - invalid or missing required fields. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Conflict - a department with this name already exists. */ 409: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetDepartment: { parameters: { query?: { /** @description Maximum number of members to return. */ limit?: number | string; /** @description Opaque pagination token from a previous response. */ paginationToken?: string; }; header?: never; path: { /** @description The ID of the department. */ departmentId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the department. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["DepartmentDetail"]; "application/json": components["schemas"]["DepartmentDetail"]; "text/json": components["schemas"]["DepartmentDetail"]; }; }; /** @description Bad request - limit out of range. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - department does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; UpdateDepartment: { parameters: { query?: never; header?: never; path: { /** @description The ID of the department to update. */ departmentId: string; }; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["UpdateDepartmentRequest"]; "text/json": components["schemas"]["UpdateDepartmentRequest"]; "application/*+json": components["schemas"]["UpdateDepartmentRequest"]; }; }; responses: { /** @description Department updated successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["DepartmentListItem"]; "application/json": components["schemas"]["DepartmentListItem"]; "text/json": components["schemas"]["DepartmentListItem"]; }; }; /** @description Bad request - invalid or missing required fields. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - department does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Conflict - a department with this name already exists. */ 409: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; DeactivateDepartment: { parameters: { query?: never; header?: never; path: { /** @description The ID of the department to deactivate. */ departmentId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Department deactivated successfully. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - department does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; BulkUpdateDepartmentMembers: { parameters: { query?: never; header?: never; path: { /** @description The ID of the department. */ departmentId: string; }; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["BulkUpdateMembershipsRequest"]; "text/json": components["schemas"]["BulkUpdateMembershipsRequest"]; "application/*+json": components["schemas"]["BulkUpdateMembershipsRequest"]; }; }; responses: { /** @description Memberships updated successfully. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad request - invalid fields or users not in caller's organization. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - department not found or deactivated. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; AssignUserToDepartment: { parameters: { query?: never; header?: never; path: { /** @description The ID of the department. */ departmentId: string; /** @description The ID of the user to assign. */ userId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description User assigned successfully. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - department or user does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; RemoveUserFromDepartment: { parameters: { query?: never; header?: never; path: { /** @description The ID of the department. */ departmentId: string; /** @description The ID of the user to remove. */ userId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description User removed successfully. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - department or user does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; ListLocations: { parameters: { query?: { /** @description Maximum number of results to return. */ limit?: number | string; /** @description Opaque pagination token from a previous response. */ paginationToken?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the paginated list of locations. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["PaginatedResponseOfLocationListItem"]; "application/json": components["schemas"]["PaginatedResponseOfLocationListItem"]; "text/json": components["schemas"]["PaginatedResponseOfLocationListItem"]; }; }; /** @description Bad request - limit out of range. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; CreateLocation: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["CreateLocationRequest"]; "text/json": components["schemas"]["CreateLocationRequest"]; "application/*+json": components["schemas"]["CreateLocationRequest"]; }; }; responses: { /** @description Location created successfully. */ 201: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["LocationListItem"]; "application/json": components["schemas"]["LocationListItem"]; "text/json": components["schemas"]["LocationListItem"]; }; }; /** @description Bad request - invalid or missing required fields. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetLocation: { parameters: { query?: { /** @description Maximum number of members to return. */ limit?: number | string; /** @description Opaque pagination token from a previous response. */ paginationToken?: string; }; header?: never; path: { /** @description The ID of the location. */ locationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the location. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["LocationDetail"]; "application/json": components["schemas"]["LocationDetail"]; "text/json": components["schemas"]["LocationDetail"]; }; }; /** @description Bad Request */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - location does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; UpdateLocation: { parameters: { query?: never; header?: never; path: { /** @description The ID of the location to update. */ locationId: string; }; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["UpdateLocationRequest"]; "text/json": components["schemas"]["UpdateLocationRequest"]; "application/*+json": components["schemas"]["UpdateLocationRequest"]; }; }; responses: { /** @description Location updated successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["LocationListItem"]; "application/json": components["schemas"]["LocationListItem"]; "text/json": components["schemas"]["LocationListItem"]; }; }; /** @description Bad request - invalid or missing required fields. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - location does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Conflict */ 409: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; DeactivateLocation: { parameters: { query?: never; header?: never; path: { /** @description The ID of the location to deactivate. */ locationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Location deactivated successfully. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - location does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; BulkUpdateLocationMembers: { parameters: { query?: never; header?: never; path: { /** @description The ID of the location. */ locationId: string; }; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["BulkUpdateMembershipsRequest"]; "text/json": components["schemas"]["BulkUpdateMembershipsRequest"]; "application/*+json": components["schemas"]["BulkUpdateMembershipsRequest"]; }; }; responses: { /** @description Memberships updated successfully. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad request - invalid fields or users not in caller's organization. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - location not found or deactivated. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; AssignUserToLocation: { parameters: { query?: never; header?: never; path: { /** @description The ID of the location. */ locationId: string; /** @description The ID of the user to assign. */ userId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description User assigned successfully. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - location or user does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; RemoveUserFromLocation: { parameters: { query?: never; header?: never; path: { /** @description The ID of the location. */ locationId: string; /** @description The ID of the user to remove. */ userId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description User removed successfully. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - location or user does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; ListApplications: { parameters: { query?: { /** @description Maximum number of results to return (default: 20, max: 100). */ limit?: number | string; /** @description Opaque pagination token from a previous response for cursor-based navigation. */ paginationToken?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the paginated list of applications. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["PaginatedResponseOfApplicationListResponseDto"]; "application/json": components["schemas"]["PaginatedResponseOfApplicationListResponseDto"]; "text/json": components["schemas"]["PaginatedResponseOfApplicationListResponseDto"]; }; }; /** @description Bad request - limit out of range. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetApplication: { parameters: { query?: never; header?: never; path: { /** @description The ID of the application. */ applicationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the application. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ApplicationStatusResponseDto"]; "application/json": components["schemas"]["ApplicationStatusResponseDto"]; "text/json": components["schemas"]["ApplicationStatusResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or cannot access the application. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - application does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; PatchApplicationScopes: { parameters: { query?: never; header?: never; path: { /** @description The ID of the application to update. */ applicationId: string; }; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["PatchApplicationScopesRequestDto"]; "text/json": components["schemas"]["PatchApplicationScopesRequestDto"]; "application/*+json": components["schemas"]["PatchApplicationScopesRequestDto"]; }; }; responses: { /** @description Scopes updated successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ApplicationScopesResponseDto"]; "application/json": components["schemas"]["ApplicationScopesResponseDto"]; "text/json": components["schemas"]["ApplicationScopesResponseDto"]; }; }; /** @description Bad request - invalid scopes provided. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or cannot access the application. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - application does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; DisableApplication: { parameters: { query?: never; header?: never; path: { /** @description The ID of the application to disable. */ applicationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Application disabled successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ApplicationStatusResponseDto"]; "application/json": components["schemas"]["ApplicationStatusResponseDto"]; "text/json": components["schemas"]["ApplicationStatusResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or cannot access the application. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - application does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; EnableApplication: { parameters: { query?: never; header?: never; path: { /** @description The ID of the application to enable. */ applicationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Application enabled successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ApplicationStatusResponseDto"]; "application/json": components["schemas"]["ApplicationStatusResponseDto"]; "text/json": components["schemas"]["ApplicationStatusResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or cannot access the application. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - application does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetOrganizations: { parameters: { query?: { /** @description Maximum number of results to return (default: 20, max: 100). */ Limit?: number | string; /** @description Opaque pagination token from a previous response for cursor-based navigation. */ PaginationToken?: string; /** @description Filter by active status (default: ACTIVE = only active orgs). */ Status?: components["schemas"]["OrganizationStatusFilter"]; /** @description Optional filter by organization type. */ Type?: components["schemas"]["OrganizationType"]; /** @description Optional filter to return only direct children of this parent organization. */ ParentOrganizationId?: string; /** * @description Optional filter to return the specified organization, its children, and parent. * Mutually exclusive with parentOrganizationId. */ OrganizationId?: string; }; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the list of related organizations. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["RelatedOrganizationsResponseDto"]; "application/json": components["schemas"]["RelatedOrganizationsResponseDto"]; "text/json": components["schemas"]["RelatedOrganizationsResponseDto"]; }; }; /** @description Bad request - invalid query parameters. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or missing organization claim. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; CreateOrganization: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["CreateOrganizationRequestDto"]; "text/json": components["schemas"]["CreateOrganizationRequestDto"]; "application/*+json": components["schemas"]["CreateOrganizationRequestDto"]; }; }; responses: { /** @description Organization created successfully. */ 201: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["CreateOrganizationResponseDto"]; "application/json": components["schemas"]["CreateOrganizationResponseDto"]; "text/json": components["schemas"]["CreateOrganizationResponseDto"]; }; }; /** @description Bad request - invalid or missing required fields. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or missing organization claim. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetVisibleOrganizationIds: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the list of visible organization IDs. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["VisibleOrganizationIdsResponseDto"]; "application/json": components["schemas"]["VisibleOrganizationIdsResponseDto"]; "text/json": components["schemas"]["VisibleOrganizationIdsResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or missing organization claim. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetOrganization: { parameters: { query?: never; header?: never; path: { /** @description The unique identifier of the organization to retrieve. */ organizationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the organization details. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["OrganizationDetailsResponseDto"]; "application/json": components["schemas"]["OrganizationDetailsResponseDto"]; "text/json": components["schemas"]["OrganizationDetailsResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or has no relationship with the organization. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - organization does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; UpdateOrganization: { parameters: { query?: never; header?: never; path: { /** @description The unique identifier of the organization to update. */ organizationId: string; }; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["UpdateOrganizationRequestDto"]; "text/json": components["schemas"]["UpdateOrganizationRequestDto"]; "application/*+json": components["schemas"]["UpdateOrganizationRequestDto"]; }; }; responses: { /** @description Returns the updated organization details. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["OrganizationDetailsResponseDto"]; "application/json": components["schemas"]["OrganizationDetailsResponseDto"]; "text/json": components["schemas"]["OrganizationDetailsResponseDto"]; }; }; /** @description Bad request - invalid field values. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or has no relationship with the organization. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - organization does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; DisableOrganization: { parameters: { query?: never; header?: never; path: { /** @description The organization ID to disable. */ organizationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Organization disabled successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["OrganizationStatusResponseDto"]; "application/json": components["schemas"]["OrganizationStatusResponseDto"]; "text/json": components["schemas"]["OrganizationStatusResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or target is not VSP/EMBEDDED. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - organization does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; DisableOrganizationApplications: { parameters: { query?: never; header?: never; path: { /** @description The organization ID. */ organizationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Applications disabled successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["BulkApplicationStatusResponseDto"]; "application/json": components["schemas"]["BulkApplicationStatusResponseDto"]; "text/json": components["schemas"]["BulkApplicationStatusResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or cannot access the organization. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetOrganizationPaymentRails: { parameters: { query?: never; header?: never; path: { /** @description The organization ID. */ organizationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the disabled payment rails. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["DisabledPaymentRailsResponseDto"]; "application/json": components["schemas"]["DisabledPaymentRailsResponseDto"]; "text/json": components["schemas"]["DisabledPaymentRailsResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or missing organization claim. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - organization does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; PatchOrganizationPaymentRails: { parameters: { query?: never; header?: never; path: { /** @description The organization ID. */ organizationId: string; }; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["PatchDisabledPaymentRailsRequestDto"]; "text/json": components["schemas"]["PatchDisabledPaymentRailsRequestDto"]; "application/*+json": components["schemas"]["PatchDisabledPaymentRailsRequestDto"]; }; }; responses: { /** @description Payment rails updated successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["DisabledPaymentRailsResponseDto"]; "application/json": components["schemas"]["DisabledPaymentRailsResponseDto"]; "text/json": components["schemas"]["DisabledPaymentRailsResponseDto"]; }; }; /** @description Bad request - invalid payment rails provided. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or cannot access the organization. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - organization does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; EnableOrganization: { parameters: { query?: never; header?: never; path: { /** @description The organization ID to enable. */ organizationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Organization enabled successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["OrganizationStatusResponseDto"]; "application/json": components["schemas"]["OrganizationStatusResponseDto"]; "text/json": components["schemas"]["OrganizationStatusResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or target is not VSP/EMBEDDED. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - organization does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; EnableOrganizationApplications: { parameters: { query?: never; header?: never; path: { /** @description The organization ID. */ organizationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Applications enabled successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["BulkApplicationStatusResponseDto"]; "application/json": components["schemas"]["BulkApplicationStatusResponseDto"]; "text/json": components["schemas"]["BulkApplicationStatusResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or cannot access the organization. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; UploadOrganizationLogo: { parameters: { query?: never; header?: never; path: { /** @description The organization ID. */ organizationId: string; }; cookie?: never; }; requestBody: { content: { "multipart/form-data": { /** Format: binary */ file: Blob; }; }; }; responses: { /** @description Returns the uploaded logo file metadata. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["UploadOrganizationLogoResponseDto"]; "application/json": components["schemas"]["UploadOrganizationLogoResponseDto"]; "text/json": components["schemas"]["UploadOrganizationLogoResponseDto"]; }; }; /** @description Bad request - missing file, unsupported content type, file content does not match its declared image format, file exceeds 10 MB, or request body exceeds the multipart upload limit (returned as a model-state validation error by the framework). */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or missing organization claim. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unsupported media type - request must be multipart/form-data. */ 415: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; DeleteOrganizationLogo: { parameters: { query?: never; header?: never; path: { /** @description The organization ID. */ organizationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Logo deleted successfully. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or missing organization claim. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetOrganizationApplications: { parameters: { query?: never; header?: never; path: { /** @description The organization ID. */ organizationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the list of applications. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ApplicationListResponseDto"][]; "application/json": components["schemas"]["ApplicationListResponseDto"][]; "text/json": components["schemas"]["ApplicationListResponseDto"][]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or cannot access the organization. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetOrganizationSettings: { parameters: { query?: never; header?: never; path: { /** @description The organization ID. */ organizationId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the organization settings. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["OrganizationSettingsResponseDto"]; "application/json": components["schemas"]["OrganizationSettingsResponseDto"]; "text/json": components["schemas"]["OrganizationSettingsResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or missing organization claim. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; PatchOrganizationSettings: { parameters: { query?: never; header?: never; path: { /** @description The organization ID. */ organizationId: string; }; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["PatchOrganizationSettingsRequestDto"]; "text/json": components["schemas"]["PatchOrganizationSettingsRequestDto"]; "application/*+json": components["schemas"]["PatchOrganizationSettingsRequestDto"]; }; }; responses: { /** @description Returns the updated organization settings. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["OrganizationSettingsResponseDto"]; "application/json": components["schemas"]["OrganizationSettingsResponseDto"]; "text/json": components["schemas"]["OrganizationSettingsResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or missing organization claim. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; ListRoles: { parameters: { query?: { /** @description Maximum number of results to return. */ limit?: number | string; /** @description Opaque pagination token from a previous response. */ paginationToken?: string; }; header?: { /** @description ID of the organization to scope this operation to. When omitted, roles for the caller's own organization are returned. Must be a valid non-empty UUID. Present but empty or malformed values return 400. */ "X-Organization-ID"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the paginated list of roles. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["PaginatedResponseOfRoleResponseDto"]; "application/json": components["schemas"]["PaginatedResponseOfRoleResponseDto"]; "text/json": components["schemas"]["PaginatedResponseOfRoleResponseDto"]; }; }; /** @description Bad request - limit out of range. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; CreateRole: { parameters: { query?: never; header?: { /** @description ID of the organization to scope this operation to. When omitted, the role is created in the caller's own organization. Must be a valid non-empty UUID. Present but empty or malformed values return 400. */ "X-Organization-ID"?: string; }; path?: never; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["CreateRoleRequestDto"]; "text/json": components["schemas"]["CreateRoleRequestDto"]; "application/*+json": components["schemas"]["CreateRoleRequestDto"]; }; }; responses: { /** @description Role created successfully. */ 201: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["RoleResponseDto"]; "application/json": components["schemas"]["RoleResponseDto"]; "text/json": components["schemas"]["RoleResponseDto"]; }; }; /** @description Bad request - invalid or missing required fields. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Conflict - a role with this key already exists. */ 409: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetRole: { parameters: { query?: never; header?: { /** @description ID of the organization to scope this operation to. When omitted, the role is looked up in the caller's own organization. Must be a valid non-empty UUID. Present but empty or malformed values return 400. */ "X-Organization-ID"?: string; }; path: { /** @description The ID of the role. */ roleId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the role. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["RoleResponseDto"]; "application/json": components["schemas"]["RoleResponseDto"]; "text/json": components["schemas"]["RoleResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - role does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; DeleteRole: { parameters: { query?: never; header?: { /** @description ID of the organization to scope this operation to. When omitted, the role is disabled in the caller's own organization. Must be a valid non-empty UUID. Present but empty or malformed values return 400. */ "X-Organization-ID"?: string; }; path: { /** @description The ID of the role to deactivate. */ roleId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Role deactivated successfully. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - role does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; UpdateRole: { parameters: { query?: never; header?: { /** @description ID of the organization to scope this operation to. When omitted, the role is updated in the caller's own organization. Must be a valid non-empty UUID. Present but empty or malformed values return 400. */ "X-Organization-ID"?: string; }; path: { /** @description The ID of the role to update. */ roleId: string; }; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["PatchRoleRequestDto"]; "text/json": components["schemas"]["PatchRoleRequestDto"]; "application/*+json": components["schemas"]["PatchRoleRequestDto"]; }; }; responses: { /** @description Role updated successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["RoleResponseDto"]; "application/json": components["schemas"]["RoleResponseDto"]; "text/json": components["schemas"]["RoleResponseDto"]; }; }; /** @description Bad request - invalid or missing required fields. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - role does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Conflict - a role with this key already exists. */ 409: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; ListRoleMembers: { parameters: { query?: { /** @description Maximum number of results to return. */ limit?: number | string; /** @description Opaque pagination token from a previous response. */ paginationToken?: string; }; header?: never; path: { /** @description The ID of the role. */ roleId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the paginated list of members. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["PaginatedResponseOfRoleMemberResponseDto"]; "application/json": components["schemas"]["PaginatedResponseOfRoleMemberResponseDto"]; "text/json": components["schemas"]["PaginatedResponseOfRoleMemberResponseDto"]; }; }; /** @description Bad request - limit out of range. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - role does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; BulkUpdateRoleMembers: { parameters: { query?: never; header?: never; path: { /** @description The ID of the role. */ roleId: string; }; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["BulkUpdateMembershipsRequest"]; "text/json": components["schemas"]["BulkUpdateMembershipsRequest"]; "application/*+json": components["schemas"]["BulkUpdateMembershipsRequest"]; }; }; responses: { /** @description Members updated successfully. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad request - invalid fields or user IDs not valid. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - role does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; ListRolePermissions: { parameters: { query?: never; header?: never; path: { /** @description The ID of the role. */ roleId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the list of permissions. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["RolePermissionsListResponse"]; "application/json": components["schemas"]["RolePermissionsListResponse"]; "text/json": components["schemas"]["RolePermissionsListResponse"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - role does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; BulkUpdateRolePermissions: { parameters: { query?: never; header?: never; path: { /** @description The ID of the role. */ roleId: string; }; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["BulkUpdatePermissionsRequest"]; "text/json": components["schemas"]["BulkUpdatePermissionsRequest"]; "application/*+json": components["schemas"]["BulkUpdatePermissionsRequest"]; }; }; responses: { /** @description Permissions updated successfully. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad request - invalid fields or permission IDs not valid. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or no organization ID in token. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - role does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetUserData: { parameters: { query?: never; header?: never; path: { key: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description The stored value, wrapped in UserDataResponse. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["UserDataResponse"]; "application/json": components["schemas"]["UserDataResponse"]; "text/json": components["schemas"]["UserDataResponse"]; }; }; /** @description Bad request - the key is malformed. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - missing or invalid bearer token. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - the token does not contain a user id. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - no value is stored under this key for the authenticated user. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; UpsertUserData: { parameters: { query?: never; header?: never; path: { key: string; }; cookie?: never; }; requestBody: { content: { "application/json": components["schemas"]["UpsertUserDataRequest"]; "text/json": components["schemas"]["UpsertUserDataRequest"]; "application/*+json": components["schemas"]["UpsertUserDataRequest"]; }; }; responses: { /** @description The value was stored. */ 204: { headers: { [name: string]: unknown; }; content?: never; }; /** @description Bad request - the key is malformed or the body is missing the value field. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - missing or invalid bearer token. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - the token does not contain a user id. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Payload too large - the request body exceeds the size limit. */ 413: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetUsers: { parameters: { query?: { /** @description Filter by organization type (VERTICAL_SOFTWARE_PROVIDER, EMBEDDED). */ OrganizationType?: components["schemas"]["OrganizationType"]; /** @description Maximum number of results to return (default: 20, max: 100). */ Limit?: number | string; /** @description Opaque pagination token from a previous response for cursor-based navigation. */ PaginationToken?: string; /** @description Filter by reporting manager user ID. Returns only users whose reporting_manager_user_id equals this value. */ ReportingManagerUserId?: string; /** @description Filter by user status (default: ACTIVE). */ Status?: components["schemas"]["UserStatusFilter"]; }; header?: { /** @description ID of the organization to scope this operation to. When omitted, users from the target org and all its descendants are returned. Must be a valid non-empty UUID. Present but empty or malformed values return 400. */ "X-Organization-ID"?: string; }; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the list of users from related organizations. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["RelatedUsersListResponseDto"]; "application/json": components["schemas"]["RelatedUsersListResponseDto"]; "text/json": components["schemas"]["RelatedUsersListResponseDto"]; }; }; /** @description Bad request - invalid query parameters. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or missing organization claim. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; CreateUser: { parameters: { query?: never; header?: { /** @description ID of the organization to scope this operation to. When omitted, the request creates the user in the caller's own organization. Must be a valid non-empty UUID. Present but empty or malformed values return 400. */ "X-Organization-ID"?: string; }; path?: never; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["CreateUserRequestDto"]; "text/json": components["schemas"]["CreateUserRequestDto"]; "application/*+json": components["schemas"]["CreateUserRequestDto"]; }; }; responses: { /** @description User created successfully. */ 201: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["CreateUserResponseDto"]; "application/json": components["schemas"]["CreateUserResponseDto"]; "text/json": components["schemas"]["CreateUserResponseDto"]; }; }; /** @description Bad request - invalid or missing required fields. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unprocessable entity - business rule violation (e.g. duplicate email, domain mismatch). */ 422: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetMe: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the authenticated user's profile. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["MeResponseDto"]; "application/json": components["schemas"]["MeResponseDto"]; "text/json": components["schemas"]["MeResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - token is missing required claims. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - no profile matches the caller's claims. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; GetUser: { parameters: { query?: never; header?: never; path: { /** @description The user ID to retrieve. */ id: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description Returns the user from a related organization. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["RelatedUserDto"]; "application/json": components["schemas"]["RelatedUserDto"]; "text/json": components["schemas"]["RelatedUserDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope or missing organization claim. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - user does not exist or is not in a downstream organization. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; UpdateUser: { parameters: { query?: never; header?: never; path: { /** @description The user ID to update. */ id: string; }; cookie?: never; }; /** @description Cancellation token. */ requestBody: { content: { "application/json": components["schemas"]["UpdateUserRequest"]; "text/json": components["schemas"]["UpdateUserRequest"]; "application/*+json": components["schemas"]["UpdateUserRequest"]; }; }; responses: { /** @description User updated successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["UpdateUserResponse"]; "application/json": components["schemas"]["UpdateUserResponse"]; "text/json": components["schemas"]["UpdateUserResponse"]; }; }; /** @description Bad request - invalid field values. */ 400: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope, user not in hierarchy, or user in BANK/PLATFORM organization. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - user does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Unprocessable entity - business rule violation (e.g. invalid reporting manager). */ 422: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; DisableUser: { parameters: { query?: never; header?: never; path: { /** @description The user ID to disable. */ userId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description User disabled successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["UserStatusResponseDto"]; "application/json": components["schemas"]["UserStatusResponseDto"]; "text/json": components["schemas"]["UserStatusResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope, user not in hierarchy, or user in BANK/PLATFORM organization. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - user does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; EnableUser: { parameters: { query?: never; header?: never; path: { /** @description The user ID to enable. */ userId: string; }; cookie?: never; }; requestBody?: never; responses: { /** @description User enabled successfully. */ 200: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["UserStatusResponseDto"]; "application/json": components["schemas"]["UserStatusResponseDto"]; "text/json": components["schemas"]["UserStatusResponseDto"]; }; }; /** @description Unauthorized - no valid JWT token provided. */ 401: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Forbidden - caller lacks required scope, user not in hierarchy, or user in BANK/PLATFORM organization. */ 403: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Not found - user does not exist. */ 404: { headers: { [name: string]: unknown; }; content: { "text/plain": components["schemas"]["ProblemDetails"]; "application/json": components["schemas"]["ProblemDetails"]; "text/json": components["schemas"]["ProblemDetails"]; }; }; /** @description Internal server error. */ 500: { headers: { [name: string]: unknown; }; content?: never; }; }; }; } type schema_d_$defs = $defs; type schema_d_components = components; type schema_d_operations = operations; type schema_d_paths = paths; type schema_d_webhooks = webhooks; declare namespace schema_d { export type { schema_d_$defs as $defs, schema_d_components as components, schema_d_operations as operations, schema_d_paths as paths, schema_d_webhooks as webhooks }; } interface ApiService { /** @summary Initializes widget and returns user context */ getApiWidgetGatewayInit: ServiceOperationQuery<{ method: 'get'; url: '/api/widget-gateway/init'; security: ['HTTPBearer']; }, paths['/api/widget-gateway/init']['get']['responses']['200']['content']['text/plain'], paths['/api/widget-gateway/init']['get']['parameters'], paths['/api/widget-gateway/init']['get']['responses']['401']['content']['text/plain'] | paths['/api/widget-gateway/init']['get']['responses']['422']['content']['text/plain']>; /** @summary Proxies requests to banking services for active users (legacy DTO-based approach) */ postApiWidgetGatewayProxy: ServiceOperationMutation<{ method: 'post'; url: '/api/widget-gateway/proxy'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], unknown, paths['/api/widget-gateway/proxy']['post']['parameters'], paths['/api/widget-gateway/proxy']['post']['responses']['401']['content']['text/plain'] | paths['/api/widget-gateway/proxy']['post']['responses']['422']['content']['text/plain']>; /** * @summary Proxies requests to banking services using transparent HTTP method and path routing. * Note: ASP.NET Core gives literal route segments priority over catch-all parameters, * so POST /api/widget-gateway/proxy (no extra path) matches ProxyRequestAsync, not this action. */ getApiWidgetGatewayProxyPath: ServiceOperationQuery<{ method: 'get'; url: '/api/widget-gateway/proxy/{path}'; security: ['HTTPBearer']; }, unknown, paths['/api/widget-gateway/proxy/{path}']['get']['parameters'], paths['/api/widget-gateway/proxy/{path}']['get']['responses']['400']['content']['text/plain'] | paths['/api/widget-gateway/proxy/{path}']['get']['responses']['401']['content']['text/plain'] | paths['/api/widget-gateway/proxy/{path}']['get']['responses']['422']['content']['text/plain']>; /** * @summary Proxies requests to banking services using transparent HTTP method and path routing. * Note: ASP.NET Core gives literal route segments priority over catch-all parameters, * so POST /api/widget-gateway/proxy (no extra path) matches ProxyRequestAsync, not this action. */ postApiWidgetGatewayProxyPath: ServiceOperationMutation<{ method: 'post'; url: '/api/widget-gateway/proxy/{path}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/api/widget-gateway/proxy/{path}']['post']['parameters'], paths['/api/widget-gateway/proxy/{path}']['post']['responses']['400']['content']['text/plain'] | paths['/api/widget-gateway/proxy/{path}']['post']['responses']['401']['content']['text/plain'] | paths['/api/widget-gateway/proxy/{path}']['post']['responses']['422']['content']['text/plain']>; /** * @summary Proxies requests to banking services using transparent HTTP method and path routing. * Note: ASP.NET Core gives literal route segments priority over catch-all parameters, * so POST /api/widget-gateway/proxy (no extra path) matches ProxyRequestAsync, not this action. */ putApiWidgetGatewayProxyPath: ServiceOperationMutation<{ method: 'put'; url: '/api/widget-gateway/proxy/{path}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/api/widget-gateway/proxy/{path}']['put']['parameters'], paths['/api/widget-gateway/proxy/{path}']['put']['responses']['400']['content']['text/plain'] | paths['/api/widget-gateway/proxy/{path}']['put']['responses']['401']['content']['text/plain'] | paths['/api/widget-gateway/proxy/{path}']['put']['responses']['422']['content']['text/plain']>; /** * @summary Proxies requests to banking services using transparent HTTP method and path routing. * Note: ASP.NET Core gives literal route segments priority over catch-all parameters, * so POST /api/widget-gateway/proxy (no extra path) matches ProxyRequestAsync, not this action. */ patchApiWidgetGatewayProxyPath: ServiceOperationMutation<{ method: 'patch'; url: '/api/widget-gateway/proxy/{path}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/api/widget-gateway/proxy/{path}']['patch']['parameters'], paths['/api/widget-gateway/proxy/{path}']['patch']['responses']['400']['content']['text/plain'] | paths['/api/widget-gateway/proxy/{path}']['patch']['responses']['401']['content']['text/plain'] | paths['/api/widget-gateway/proxy/{path}']['patch']['responses']['422']['content']['text/plain']>; /** * @summary Proxies requests to banking services using transparent HTTP method and path routing. * Note: ASP.NET Core gives literal route segments priority over catch-all parameters, * so POST /api/widget-gateway/proxy (no extra path) matches ProxyRequestAsync, not this action. */ deleteApiWidgetGatewayProxyPath: ServiceOperationMutation<{ method: 'delete'; url: '/api/widget-gateway/proxy/{path}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/api/widget-gateway/proxy/{path}']['delete']['parameters'], paths['/api/widget-gateway/proxy/{path}']['delete']['responses']['400']['content']['text/plain'] | paths['/api/widget-gateway/proxy/{path}']['delete']['responses']['401']['content']['text/plain'] | paths['/api/widget-gateway/proxy/{path}']['delete']['responses']['422']['content']['text/plain']>; /** @summary Revokes cached OAuth tokens for the current user session */ postApiWidgetGatewayRevoke: ServiceOperationMutation<{ method: 'post'; url: '/api/widget-gateway/revoke'; security: ['HTTPBearer']; }, undefined, unknown, paths['/api/widget-gateway/revoke']['post']['parameters'], paths['/api/widget-gateway/revoke']['post']['responses']['401']['content']['text/plain'] | paths['/api/widget-gateway/revoke']['post']['responses']['422']['content']['text/plain']>; } interface EmbeddedBankingService { /** * @summary Get the latest application status per product for the current widget session. * @description Intended for widget initialization, before an application (and its client secret) exists. * For each product it returns the latest application matching the widget session's organization * reference — preferring the current applicant's own in-progress application — and whether that * applicant started it: STARTED_BY_YOU when the applicant email matches, otherwise STARTED_BY_OTHER. * ApplicationId is returned only for STARTED_BY_YOU, so another applicant's handle is never leaked. * The organization reference and applicant email come from trusted headers injected by the widget * gateway, not from the app token's organization. * * **Token types:** APP | **Required scopes:** `bank_account_application:read:org` */ getApplicationStatus: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/application-status'; security: ['APPToken']; }, paths['/embedded-banking/v1/application-status']['get']['responses']['200']['content']['application/json'], undefined, paths['/embedded-banking/v1/application-status']['get']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/application-status']['get']['responses']['401']['content']['application/json']>; /** * @summary Lists the Merchant Category Code Groups (MCCGs) pre-configured for the institution — * named sets of merchant category codes. Consumed during card issuance to choose which * groups to white-list as authorization controls on a card. * Each group carries its identifier, description, and effective start and end dates. * Results are paginated; pass the opaque pagination_token from a prior response * to fetch the next page. * @description **Token types:** APP, USER | **Required scopes:** `authorization_control:read:org` */ getMerchantCategoryGroups: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/authorization-controls/merchant-category-groups'; security: ['APPToken', 'USERToken']; }, paths['/embedded-banking/v1/authorization-controls/merchant-category-groups']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/authorization-controls/merchant-category-groups']['get']['parameters'], paths['/embedded-banking/v1/authorization-controls/merchant-category-groups']['get']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/authorization-controls/merchant-category-groups']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/authorization-controls/merchant-category-groups']['get']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/authorization-controls/merchant-category-groups']['get']['responses']['500']['content']['application/json'] | paths['/embedded-banking/v1/authorization-controls/merchant-category-groups']['get']['responses']['502']['content']['application/json']>; /** * @summary List bank account applications. * @description Returns a paginated summary of the bank account applications belonging to the calling * application (tenant). Only non-sensitive fields are included so partners can observe the * progress of their applications. Applicant-scoped (client-secret) tokens are not permitted. * * **Token types:** APP | **Required scopes:** `bank_account_application:read:org` */ getBankAccountApplications: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/bank-account-applications'; security: ['APPToken']; }, paths['/embedded-banking/v1/bank-account-applications']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/bank-account-applications']['get']['parameters'], paths['/embedded-banking/v1/bank-account-applications']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications']['get']['responses']['403']['content']['application/json']>; /** * @summary Create a new bank account application. * @description Creates a new application to apply for an embedded bank account with optional applicant details, business details, and/or business owners. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ createApplication: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/bank-account-applications'; mediaType: 'application/json'; security: ['APPToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/bank-account-applications']['post']['responses']['201']['content']['application/json'], paths['/embedded-banking/v1/bank-account-applications']['post']['parameters'], paths['/embedded-banking/v1/bank-account-applications']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications']['post']['responses']['404']['content']['application/json']>; /** * @summary Resume a bank account application by email. * @description Looks up a DRAFT application by email and reissues a client secret, sending it to the applicant via email. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ resumeApplication: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/bank-account-applications/resume'; mediaType: 'application/json'; security: ['APPToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/bank-account-applications/resume']['post']['responses']['200']['content']['application/json'], undefined, paths['/embedded-banking/v1/bank-account-applications/resume']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications/resume']['post']['responses']['401']['content']['application/json']>; /** * @summary Get a bank account application by ID. * @description Retrieves a bank account application by its ID. * * **Token types:** APP | **Required scopes:** `bank_account_application:read:org` */ getBankAccountApplication: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/bank-account-applications/{id}'; security: ['APPToken']; }, paths['/embedded-banking/v1/bank-account-applications/{id}']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/bank-account-applications/{id}']['get']['parameters'], paths['/embedded-banking/v1/bank-account-applications/{id}']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications/{id}']['get']['responses']['404']['content']['application/json']>; /** * @summary Update an existing bank account application. * @description Updates an existing application with applicant details, business details, and/or business owners in a single request. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ updateApplication: ServiceOperationMutation<{ method: 'patch'; url: '/embedded-banking/v1/bank-account-applications/{id}'; mediaType: 'application/json'; security: ['APPToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/bank-account-applications/{id}']['patch']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/bank-account-applications/{id}']['patch']['parameters'], paths['/embedded-banking/v1/bank-account-applications/{id}']['patch']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications/{id}']['patch']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications/{id}']['patch']['responses']['404']['content']['application/json']>; /** * @summary Process KYC/KYB verification for a bank account application. * @description Processes KYC/KYB verification for a bank account application. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ verifyBusiness: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/bank-account-applications/{id}/business-verification'; security: ['APPToken']; }, undefined, paths['/embedded-banking/v1/bank-account-applications/{id}/business-verification']['post']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/bank-account-applications/{id}/business-verification']['post']['parameters'], paths['/embedded-banking/v1/bank-account-applications/{id}/business-verification']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications/{id}/business-verification']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications/{id}/business-verification']['post']['responses']['404']['content']['application/json']>; /** * @summary Submit a bank account application for processing. * @description Processes an application for an embedded bank account. This triggers KYC/KYB verification. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ submitApplication: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/bank-account-applications/{id}/submission'; security: ['APPToken']; }, undefined, paths['/embedded-banking/v1/bank-account-applications/{id}/submission']['post']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/bank-account-applications/{id}/submission']['post']['parameters'], paths['/embedded-banking/v1/bank-account-applications/{id}/submission']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications/{id}/submission']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications/{id}/submission']['post']['responses']['404']['content']['application/json']>; /** * @summary Verify an applicant's email using a verification code. * @description Verifies an email verification code for a bank account application. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ verifyEmailCode: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/bank-account-applications/{id}/verification'; mediaType: 'application/json'; security: ['APPToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/bank-account-applications/{id}/verification']['post']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/bank-account-applications/{id}/verification']['post']['parameters'], paths['/embedded-banking/v1/bank-account-applications/{id}/verification']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications/{id}/verification']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications/{id}/verification']['post']['responses']['404']['content']['application/json']>; /** * @summary Send an email verification code to the applicant. * @description Sends an email verification code to the work email address associated with a bank account application. * * **Token types:** APP | **Required scopes:** `bank_account_application:write:org` */ sendVerificationEmail: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/bank-account-applications/{id}/verification-codes'; security: ['APPToken']; }, undefined, paths['/embedded-banking/v1/bank-account-applications/{id}/verification-codes']['post']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/bank-account-applications/{id}/verification-codes']['post']['parameters'], paths['/embedded-banking/v1/bank-account-applications/{id}/verification-codes']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications/{id}/verification-codes']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-account-applications/{id}/verification-codes']['post']['responses']['404']['content']['application/json']>; /** * @summary Get all bank accounts with balances. * @description Retrieves all embedded bank accounts for the authenticated user with their current balances. Bank and platform users can optionally filter by organization ID to see accounts for a specific VSP. * * **Token types:** APP, USER | **Required scopes:** `bank_account:read:org` */ getBankAccounts: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/bank-accounts'; security: ['APPToken', 'USERToken']; }, paths['/embedded-banking/v1/bank-accounts']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/bank-accounts']['get']['parameters'], paths['/embedded-banking/v1/bank-accounts']['get']['responses']['401']['content']['application/json']>; /** * @summary Create a new bank account. * @description Creates a new embedded bank account for the authenticated user. * * **Token types:** APP, USER | **Required scopes:** `bank_account:write:org` */ createBankAccount: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/bank-accounts'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/bank-accounts']['post']['responses']['201']['content']['application/json'], paths['/embedded-banking/v1/bank-accounts']['post']['parameters'], paths['/embedded-banking/v1/bank-accounts']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts']['post']['responses']['404']['content']['application/json']>; /** * @summary Manage access to bank accounts for users (grant or revoke). * @description Grants or revokes access to bank accounts for the specified users. * Set type to 'GRANT' to grant access or 'REVOKE' to revoke access. * Users cannot revoke their own access. * * **Token types:** APP, USER | **Required scopes:** `bank_account:write:org` */ manageBankAccountAccess: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/bank-accounts/access'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], unknown, undefined, paths['/embedded-banking/v1/bank-accounts/access']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts/access']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts/access']['post']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts/access']['post']['responses']['404']['content']['application/json']>; /** * @summary Get a bank account by ID. * @description Retrieves a specific bank account with its current balance. * * **Token types:** APP, USER | **Required scopes:** `bank_account:read:org` */ getBankAccount: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/bank-accounts/{id}'; security: ['APPToken', 'USERToken']; }, paths['/embedded-banking/v1/bank-accounts/{id}']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/bank-accounts/{id}']['get']['parameters'], paths['/embedded-banking/v1/bank-accounts/{id}']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts/{id}']['get']['responses']['404']['content']['application/json']>; /** * @summary Update a bank account. * @description Updates a specific bank account. Supports: * - Updating the nickname and/or bankAccountReference * - Closing the account by setting status to CLOSED * When closing an account, nickname and bankAccountReference can be updated in the same request, and they will be applied after the account is closed. * * **Token types:** APP, USER | **Required scopes:** `bank_account:write:org` */ updateBankAccount: ServiceOperationMutation<{ method: 'patch'; url: '/embedded-banking/v1/bank-accounts/{id}'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/bank-accounts/{id}']['patch']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/bank-accounts/{id}']['patch']['parameters'], paths['/embedded-banking/v1/bank-accounts/{id}']['patch']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts/{id}']['patch']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts/{id}']['patch']['responses']['404']['content']['application/json']>; /** * @summary Get users with access to a bank account. * @description Retrieves all users with access to the specified bank account. * * **Token types:** APP, USER | **Required scopes:** `bank_account:read:org` */ getBankAccountAccess: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/bank-accounts/{id}/access'; security: ['APPToken', 'USERToken']; }, paths['/embedded-banking/v1/bank-accounts/{id}/access']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/bank-accounts/{id}/access']['get']['parameters'], paths['/embedded-banking/v1/bank-accounts/{id}/access']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts/{id}/access']['get']['responses']['404']['content']['application/json']>; /** * @summary Grant access to a bank account. * @description Grants access to the specified bank account for the given users. * * **Token types:** APP, USER | **Required scopes:** `bank_account:write:org` */ grantBankAccountAccess: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/bank-accounts/{id}/access'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], unknown, paths['/embedded-banking/v1/bank-accounts/{id}/access']['post']['parameters'], paths['/embedded-banking/v1/bank-accounts/{id}/access']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts/{id}/access']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts/{id}/access']['post']['responses']['404']['content']['application/json']>; /** * @summary Revoke access from a bank account. * @description Revokes access to the specified bank account from the given user. Cannot revoke your own access. * * **Token types:** APP, USER | **Required scopes:** `bank_account:write:org` */ revokeBankAccountAccess: ServiceOperationMutation<{ method: 'delete'; url: '/embedded-banking/v1/bank-accounts/{id}/access/{userId}'; security: ['APPToken', 'USERToken']; }, undefined, unknown, paths['/embedded-banking/v1/bank-accounts/{id}/access/{userId}']['delete']['parameters'], paths['/embedded-banking/v1/bank-accounts/{id}/access/{userId}']['delete']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts/{id}/access/{userId}']['delete']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts/{id}/access/{userId}']['delete']['responses']['404']['content']['application/json']>; /** * @summary Get transactions for a bank account. * @description Retrieves transactions for a specific bank account with optional date filtering and pagination. * * **Token types:** APP, USER | **Required scopes:** `bank_account:read:org` */ getBankAccountTransactions: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/bank-accounts/{id}/transactions'; security: ['APPToken', 'USERToken']; }, paths['/embedded-banking/v1/bank-accounts/{id}/transactions']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/bank-accounts/{id}/transactions']['get']['parameters'], paths['/embedded-banking/v1/bank-accounts/{id}/transactions']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts/{id}/transactions']['get']['responses']['404']['content']['application/json']>; /** * @summary Get transfers for a bank account. * @description Retrieves transfers for a specific bank account with cursor-based pagination. * * **Token types:** APP, USER | **Required scopes:** `bank_account:read:org` */ getBankAccountTransfers: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/bank-accounts/{id}/transfers'; security: ['APPToken', 'USERToken']; }, paths['/embedded-banking/v1/bank-accounts/{id}/transfers']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/bank-accounts/{id}/transfers']['get']['parameters'], paths['/embedded-banking/v1/bank-accounts/{id}/transfers']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/bank-accounts/{id}/transfers']['get']['responses']['404']['content']['application/json']>; /** * @summary Get beneficial owners. * @description Retrieves beneficial owners (business stakeholders) for bank account applications. * BANK callers see all stakeholders across their partner VSPs. * PLATFORM callers see stakeholders for their visible organizations. * When available, the last 4 digits of the SSN are returned via the ssnLast4 field. * * **Token types:** APP, USER | **Required scopes:** `beneficial_owner:read:org` */ getBeneficialOwners: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/beneficial-owners'; security: ['APPToken', 'USERToken']; }, paths['/embedded-banking/v1/beneficial-owners']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/beneficial-owners']['get']['parameters'], paths['/embedded-banking/v1/beneficial-owners']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/beneficial-owners']['get']['responses']['403']['content']['application/json']>; /** * @summary Create a new credit card application. * @description Creates a new application to apply for an embedded credit card with optional applicant details, business details, and/or business owners. * * **Token types:** APP | **Required scopes:** `credit_card_application:write:org` */ createCreditCardApplication: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/credit-card-applications'; mediaType: 'application/json'; security: ['APPToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/credit-card-applications']['post']['responses']['201']['content']['application/json'], paths['/embedded-banking/v1/credit-card-applications']['post']['parameters'], paths['/embedded-banking/v1/credit-card-applications']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications']['post']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications']['post']['responses']['404']['content']['application/json']>; /** * @summary Resume a credit card application by email. * @description Looks up a DRAFT credit card application by email and reissues a client secret, sending it to the applicant via email. * * **Token types:** APP | **Required scopes:** `credit_card_application:write:org` */ resumeCreditCardApplication: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/credit-card-applications/resume'; mediaType: 'application/json'; security: ['APPToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/credit-card-applications/resume']['post']['responses']['200']['content']['application/json'], undefined, paths['/embedded-banking/v1/credit-card-applications/resume']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications/resume']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications/resume']['post']['responses']['403']['content']['application/json']>; /** * @summary Get a credit card application by ID. * @description Retrieves a credit card application by its ID. * * **Token types:** APP | **Required scopes:** `credit_card_application:read:org` */ getCreditCardApplication: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/credit-card-applications/{id}'; security: ['APPToken']; }, paths['/embedded-banking/v1/credit-card-applications/{id}']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/credit-card-applications/{id}']['get']['parameters'], paths['/embedded-banking/v1/credit-card-applications/{id}']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications/{id}']['get']['responses']['404']['content']['application/json']>; /** * @summary Update an existing credit card application. * @description Merges applicant details, business details, and/or business owners into the stored * record. Omit a section to preserve its stored value; within a section, null fields * preserve existing values. Encrypted PII (SSN, password, tax id) is only re-encrypted * when a new plaintext value is supplied. * * **Token types:** APP | **Required scopes:** `credit_card_application:write:org` */ updateCreditCardApplication: ServiceOperationMutation<{ method: 'patch'; url: '/embedded-banking/v1/credit-card-applications/{id}'; mediaType: 'application/json'; security: ['APPToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/credit-card-applications/{id}']['patch']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/credit-card-applications/{id}']['patch']['parameters'], paths['/embedded-banking/v1/credit-card-applications/{id}']['patch']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications/{id}']['patch']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications/{id}']['patch']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications/{id}']['patch']['responses']['404']['content']['application/json']>; /** * @summary Submit a credit card application for processing. * @description Runs Alloy KYB/KYC on the application, persists the verification outcome on the row, * and transitions the application out of DRAFT. APPROVED verifications move the * application to PENDING_UNDERWRITING, DENIED verifications move it to REJECTED, and * MANUAL_REVIEW / PENDING verifications move it to SUBMITTED. The client secret is * invalidated on every successful submission. TSYS integration is tracked separately * in EMBD-2118 — this endpoint does not yet call TSYS. * * **Token types:** APP | **Required scopes:** `credit_card_application:write:org` */ submitCreditCardApplication: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/credit-card-applications/{id}/submission'; security: ['APPToken']; }, undefined, paths['/embedded-banking/v1/credit-card-applications/{id}/submission']['post']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/credit-card-applications/{id}/submission']['post']['parameters'], paths['/embedded-banking/v1/credit-card-applications/{id}/submission']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications/{id}/submission']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications/{id}/submission']['post']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications/{id}/submission']['post']['responses']['404']['content']['application/json']>; /** * @summary Verify an applicant's email using a verification code. * @description Verifies an email verification code for a credit card application. * * **Token types:** APP | **Required scopes:** `credit_card_application:write:org` */ verifyCreditCardEmailCode: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/credit-card-applications/{id}/verification'; mediaType: 'application/json'; security: ['APPToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/credit-card-applications/{id}/verification']['post']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/credit-card-applications/{id}/verification']['post']['parameters'], paths['/embedded-banking/v1/credit-card-applications/{id}/verification']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications/{id}/verification']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications/{id}/verification']['post']['responses']['404']['content']['application/json']>; /** * @summary Send an email verification code to the applicant. * @description Sends an email verification code to the work email address associated with a credit card application. * * **Token types:** APP | **Required scopes:** `credit_card_application:write:org` */ sendCreditCardVerificationEmail: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/credit-card-applications/{id}/verification-codes'; security: ['APPToken']; }, undefined, paths['/embedded-banking/v1/credit-card-applications/{id}/verification-codes']['post']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/credit-card-applications/{id}/verification-codes']['post']['parameters'], paths['/embedded-banking/v1/credit-card-applications/{id}/verification-codes']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications/{id}/verification-codes']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-card-applications/{id}/verification-codes']['post']['responses']['404']['content']['application/json']>; /** @description **Token types:** APP, USER | **Required scopes:** `credit_card:read:org` */ getCreditCards: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/credit-cards'; security: ['APPToken', 'USERToken']; }, paths['/embedded-banking/v1/credit-cards']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/credit-cards']['get']['parameters'], paths['/embedded-banking/v1/credit-cards']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards']['get']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards']['get']['responses']['500']['content']['application/json']>; /** @description **Token types:** APP, USER | **Required scopes:** `credit_card:issue:org` */ createAdditionalCard: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/credit-cards'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/credit-cards']['post']['responses']['201']['content']['application/json'], undefined, paths['/embedded-banking/v1/credit-cards']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards']['post']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards']['post']['responses']['404']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards']['post']['responses']['422']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards']['post']['responses']['500']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards']['post']['responses']['502']['content']['application/json']>; /** @description **Token types:** APP, USER | **Required scopes:** `credit_card:read:org` */ getCreditCardById: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/credit-cards/{cardId}'; security: ['APPToken', 'USERToken']; }, paths['/embedded-banking/v1/credit-cards/{cardId}']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/credit-cards/{cardId}']['get']['parameters'], paths['/embedded-banking/v1/credit-cards/{cardId}']['get']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{cardId}']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{cardId}']['get']['responses']['404']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{cardId}']['get']['responses']['500']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{cardId}']['get']['responses']['502']['content']['application/json']>; /** @description **Token types:** USER | **Required scopes:** `credit_card:close:org` */ closeCreditCard: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/credit-cards/{cardId}/close'; mediaType: 'application/json'; security: ['USERToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/credit-cards/{cardId}/close']['post']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/credit-cards/{cardId}/close']['post']['parameters'], paths['/embedded-banking/v1/credit-cards/{cardId}/close']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{cardId}/close']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{cardId}/close']['post']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{cardId}/close']['post']['responses']['404']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{cardId}/close']['post']['responses']['500']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{cardId}/close']['post']['responses']['502']['content']['application/json']>; /** @description **Token types:** APP, USER | **Required scopes:** `credit_card:lock:org` */ setCreditCardLockStatus: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/credit-cards/{cardId}/lock-status'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/credit-cards/{cardId}/lock-status']['post']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/credit-cards/{cardId}/lock-status']['post']['parameters'], paths['/embedded-banking/v1/credit-cards/{cardId}/lock-status']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{cardId}/lock-status']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{cardId}/lock-status']['post']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{cardId}/lock-status']['post']['responses']['500']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{cardId}/lock-status']['post']['responses']['502']['content']['application/json']>; /** @description **Token types:** USER | **Required scopes:** `credit_card:activate:org` */ activateCreditCard: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/credit-cards/{id}/activate'; security: ['USERToken']; }, undefined, paths['/embedded-banking/v1/credit-cards/{id}/activate']['post']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/credit-cards/{id}/activate']['post']['parameters'], paths['/embedded-banking/v1/credit-cards/{id}/activate']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{id}/activate']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{id}/activate']['post']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{id}/activate']['post']['responses']['409']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{id}/activate']['post']['responses']['500']['content']['application/json']>; /** @description **Token types:** APP, USER | **Required scopes:** `credit_card:read:org` */ getCreditCardTransactions: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/credit-cards/{id}/transactions'; security: ['APPToken', 'USERToken']; }, paths['/embedded-banking/v1/credit-cards/{id}/transactions']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/credit-cards/{id}/transactions']['get']['parameters'], paths['/embedded-banking/v1/credit-cards/{id}/transactions']['get']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{id}/transactions']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{id}/transactions']['get']['responses']['404']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{id}/transactions']['get']['responses']['502']['content']['application/json'] | paths['/embedded-banking/v1/credit-cards/{id}/transactions']['get']['responses']['503']['content']['application/json']>; /** * @summary Accept bank disclosures using an invitation token. * Requires an application (APP) token. * @description Accepts bank disclosures using an invitation token for a specific user. Requires an application (APP) token. */ acceptDisclosuresWithToken: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/disclosure-acceptances'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/disclosure-acceptances']['post']['responses']['200']['content']['application/json'], undefined, paths['/embedded-banking/v1/disclosure-acceptances']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/disclosure-acceptances']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/disclosure-acceptances']['post']['responses']['403']['content']['application/json']>; /** * @summary Accept bank disclosures for the authenticated user. * @description Accepts bank disclosures for the authenticated user. */ acceptDisclosures: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/disclosures/accept'; security: ['HTTPBearer']; }, undefined, paths['/embedded-banking/v1/disclosures/accept']['post']['responses']['200']['content']['application/json'], undefined, paths['/embedded-banking/v1/disclosures/accept']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/disclosures/accept']['post']['responses']['401']['content']['application/json']>; /** * @summary Gets all external bank accounts for the authenticated user. * @description Retrieves all external bank accounts for the authenticated user. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:read:org` */ getExternalBankAccounts: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/external-bank-accounts'; security: ['APPToken', 'USERToken']; }, paths['/embedded-banking/v1/external-bank-accounts']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/external-bank-accounts']['get']['parameters'], paths['/embedded-banking/v1/external-bank-accounts']['get']['responses']['400']['content']['application/json']>; /** * @summary Connects a new external bank account. * @description Connects a new external bank account. Optionally pass a verification object to set the account as verified immediately (MANUAL method only). Requires 'external_bank_account:set_verification:org' scope when verification is provided. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org` */ connectExternalBankAccount: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/external-bank-accounts'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/external-bank-accounts']['post']['responses']['201']['content']['application/json'], paths['/embedded-banking/v1/external-bank-accounts']['post']['parameters'], paths['/embedded-banking/v1/external-bank-accounts']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/external-bank-accounts']['post']['responses']['403']['content']['application/json']>; /** * @summary Gets an external bank account by ID. * @description Retrieves a specific external bank account by ID. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:read:org` */ getExternalBankAccount: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/external-bank-accounts/{id}'; security: ['APPToken', 'USERToken']; }, paths['/embedded-banking/v1/external-bank-accounts/{id}']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/external-bank-accounts/{id}']['get']['parameters'], paths['/embedded-banking/v1/external-bank-accounts/{id}']['get']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/external-bank-accounts/{id}']['get']['responses']['404']['content']['application/json']>; /** * @summary Updates an external bank account. * @description Updates an external bank account's nickname and/or verification status. Updating verification status requires 'CanSetExternalBankAccountVerification' permission. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org` */ updateExternalBankAccount: ServiceOperationMutation<{ method: 'patch'; url: '/embedded-banking/v1/external-bank-accounts/{id}'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/external-bank-accounts/{id}']['patch']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/external-bank-accounts/{id}']['patch']['parameters'], paths['/embedded-banking/v1/external-bank-accounts/{id}']['patch']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/external-bank-accounts/{id}']['patch']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/external-bank-accounts/{id}']['patch']['responses']['404']['content']['application/json']>; /** * @summary Unlinks an external bank account. * @description Unlinks (deactivates) an external bank account. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org` */ unlinkExternalBankAccount: ServiceOperationMutation<{ method: 'delete'; url: '/embedded-banking/v1/external-bank-accounts/{id}'; security: ['APPToken', 'USERToken']; }, undefined, unknown, paths['/embedded-banking/v1/external-bank-accounts/{id}']['delete']['parameters'], paths['/embedded-banking/v1/external-bank-accounts/{id}']['delete']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/external-bank-accounts/{id}']['delete']['responses']['404']['content']['application/json']>; /** * @summary Get users with access to an external bank account. * @description Retrieves all users with access to the specified external bank account. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:read:org` */ getExternalBankAccountAccess: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/external-bank-accounts/{id}/access'; security: ['APPToken', 'USERToken']; }, paths['/embedded-banking/v1/external-bank-accounts/{id}/access']['get']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/external-bank-accounts/{id}/access']['get']['parameters'], paths['/embedded-banking/v1/external-bank-accounts/{id}/access']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/external-bank-accounts/{id}/access']['get']['responses']['404']['content']['application/json']>; /** * @summary Grant access to an external bank account. * @description Grants access to the specified external bank account for the given users. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org` */ grantExternalBankAccountAccess: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/external-bank-accounts/{id}/access'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], unknown, paths['/embedded-banking/v1/external-bank-accounts/{id}/access']['post']['parameters'], paths['/embedded-banking/v1/external-bank-accounts/{id}/access']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/external-bank-accounts/{id}/access']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/external-bank-accounts/{id}/access']['post']['responses']['404']['content']['application/json']>; /** * @summary Revoke access from an external bank account. * @description Revokes access to the specified external bank account from the given user. Cannot revoke your own access. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org` */ revokeExternalBankAccountAccess: ServiceOperationMutation<{ method: 'delete'; url: '/embedded-banking/v1/external-bank-accounts/{id}/access/{userId}'; security: ['APPToken', 'USERToken']; }, undefined, unknown, paths['/embedded-banking/v1/external-bank-accounts/{id}/access/{userId}']['delete']['parameters'], paths['/embedded-banking/v1/external-bank-accounts/{id}/access/{userId}']['delete']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/external-bank-accounts/{id}/access/{userId}']['delete']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/external-bank-accounts/{id}/access/{userId}']['delete']['responses']['404']['content']['application/json']>; /** * @summary Links an external bank account by initiating micro-deposit verification. * @description Initiates micro-deposit verification for an existing external bank account. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:micro_deposit:org` */ linkExternalBankAccount: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/external-bank-accounts/{id}/link'; security: ['APPToken', 'USERToken']; }, undefined, paths['/embedded-banking/v1/external-bank-accounts/{id}/link']['post']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/external-bank-accounts/{id}/link']['post']['parameters'], paths['/embedded-banking/v1/external-bank-accounts/{id}/link']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/external-bank-accounts/{id}/link']['post']['responses']['404']['content']['application/json']>; /** * @summary Validates an external bank account using micro-deposits. * @description Validates an external bank account using micro-deposit amounts. * * **Token types:** APP, USER | **Required scopes:** `external_bank_account:write:org` */ validateExternalBankAccount: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/external-bank-accounts/{id}/validate'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/external-bank-accounts/{id}/validate']['post']['responses']['200']['content']['application/json'], paths['/embedded-banking/v1/external-bank-accounts/{id}/validate']['post']['parameters'], paths['/embedded-banking/v1/external-bank-accounts/{id}/validate']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/external-bank-accounts/{id}/validate']['post']['responses']['404']['content']['application/json']>; /** * @summary Creates an ACH money movement. * @description Creates an ACH (Automated Clearing House) money movement between accounts. * * **Token types:** APP, USER | **Required scopes:** `transfer:write:org` */ createAchMoneyMovement: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/money-movements/ach'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/money-movements/ach']['post']['responses']['201']['content']['application/json'], undefined, paths['/embedded-banking/v1/money-movements/ach']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/money-movements/ach']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/money-movements/ach']['post']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/money-movements/ach']['post']['responses']['409']['content']['application/json']>; /** * @summary Creates a book transfer (internal-to-internal) between bank accounts. * @description Creates a book transfer (internal-to-internal) between two bank accounts within the same organization. * * **Token types:** APP, USER | **Required scopes:** `transfer:write:org` */ createBookTransfer: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/money-movements/book'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/money-movements/book']['post']['responses']['201']['content']['application/json'], undefined, paths['/embedded-banking/v1/money-movements/book']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/money-movements/book']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/money-movements/book']['post']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/money-movements/book']['post']['responses']['409']['content']['application/json']>; /** * @summary Creates a FedNow (Federal Reserve instant payment) money movement. * @description Creates a FedNow (Federal Reserve instant payment) money movement. * * **Token types:** APP, USER | **Required scopes:** `transfer:write:org` */ createFedNowMoneyMovement: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/money-movements/fednow'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/money-movements/fednow']['post']['responses']['201']['content']['application/json'], undefined, paths['/embedded-banking/v1/money-movements/fednow']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/money-movements/fednow']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/money-movements/fednow']['post']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/money-movements/fednow']['post']['responses']['409']['content']['application/json']>; /** * @summary Creates an RTP (Real-Time Payments) money movement. * @description Creates an RTP (Real-Time Payments) money movement for instant transfers. * * **Token types:** APP, USER | **Required scopes:** `transfer:write:org` */ createRtpMoneyMovement: ServiceOperationMutation<{ method: 'post'; url: '/embedded-banking/v1/money-movements/rtp'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/embedded-banking/v1/money-movements/rtp']['post']['responses']['201']['content']['application/json'], undefined, paths['/embedded-banking/v1/money-movements/rtp']['post']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/money-movements/rtp']['post']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/money-movements/rtp']['post']['responses']['403']['content']['application/json'] | paths['/embedded-banking/v1/money-movements/rtp']['post']['responses']['409']['content']['application/json']>; /** * @summary Get a summary of organization data for the authenticated user's organization hierarchy. * @description Returns aggregated counts for applications, bank accounts, and external bank accounts within the caller's visible organization hierarchy. */ getOrganizationSummary: ServiceOperationQuery<{ method: 'get'; url: '/embedded-banking/v1/organization/summary'; security: ['HTTPBearer']; }, paths['/embedded-banking/v1/organization/summary']['get']['responses']['200']['content']['application/json'], undefined, paths['/embedded-banking/v1/organization/summary']['get']['responses']['400']['content']['application/json'] | paths['/embedded-banking/v1/organization/summary']['get']['responses']['401']['content']['application/json'] | paths['/embedded-banking/v1/organization/summary']['get']['responses']['403']['content']['application/json']>; } interface FilesService { /** @summary Provides a way to upload an attachment for a given application */ postFilesBoardingApplicationsApplicationidAttachments: ServiceOperationMutation<{ method: 'post'; url: '/files/boarding/applications/{applicationId}/attachments'; mediaType: 'multipart/form-data'; security: ['HTTPBearer']; }, NonNullable['content']['multipart/form-data'], unknown, paths['/files/boarding/applications/{applicationId}/attachments']['post']['parameters'], unknown>; getFilesBoardingApplicationsApplicationidAttachmentsAttachmentid: ServiceOperationQuery<{ method: 'get'; url: '/files/boarding/applications/{applicationId}/attachments/{attachmentId}'; security: ['HTTPBearer']; }, unknown, paths['/files/boarding/applications/{applicationId}/attachments/{attachmentId}']['get']['parameters'], unknown>; deleteFilesBoardingApplicationsApplicationidAttachmentsAttachmentid: ServiceOperationMutation<{ method: 'delete'; url: '/files/boarding/applications/{applicationId}/attachments/{attachmentId}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/files/boarding/applications/{applicationId}/attachments/{attachmentId}']['delete']['parameters'], unknown>; /** * @summary Provides a way to upload an attachment for a given dispute * @description **Required scopes:** `dispute:write` */ postFilesDisputesDisputeidAttachments: ServiceOperationMutation<{ method: 'post'; url: '/files/disputes/{disputeId}/attachments'; mediaType: 'multipart/form-data'; security: ['HTTPBearer']; }, NonNullable['content']['multipart/form-data'], unknown, paths['/files/disputes/{disputeId}/attachments']['post']['parameters'], unknown>; /** @description **Required scopes:** `dispute:read` */ getFilesDisputesDisputeidAttachmentsAttachmentid: ServiceOperationQuery<{ method: 'get'; url: '/files/disputes/{disputeId}/attachments/{attachmentId}'; security: ['HTTPBearer']; }, unknown, paths['/files/disputes/{disputeId}/attachments/{attachmentId}']['get']['parameters'], unknown>; postFilesReportingTypeIdDownload: ServiceOperationMutation<{ method: 'post'; url: '/files/reporting/{type}/{id}/download'; security: ['HTTPBearer']; }, undefined, unknown, paths['/files/reporting/{type}/{id}/download']['post']['parameters'], paths['/files/reporting/{type}/{id}/download']['post']['responses']['401']['content']['application/octet-stream'] | unknown>; /** @summary Provides a way to upload an attachment for a given application */ postFilesUnderwritingApplicationsApplicationidAttachments: ServiceOperationMutation<{ method: 'post'; url: '/files/underwriting/applications/{applicationId}/attachments'; mediaType: 'multipart/form-data'; security: ['HTTPBearer']; }, NonNullable['content']['multipart/form-data'], unknown, paths['/files/underwriting/applications/{applicationId}/attachments']['post']['parameters'], unknown>; getFilesUnderwritingApplicationsApplicationidAttachmentsAttachmentid: ServiceOperationQuery<{ method: 'get'; url: '/files/underwriting/applications/{applicationId}/attachments/{attachmentId}'; security: ['HTTPBearer']; }, unknown, paths['/files/underwriting/applications/{applicationId}/attachments/{attachmentId}']['get']['parameters'], unknown>; deleteFilesUnderwritingApplicationsApplicationidAttachmentsAttachmentid: ServiceOperationMutation<{ method: 'delete'; url: '/files/underwriting/applications/{applicationId}/attachments/{attachmentId}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/files/underwriting/applications/{applicationId}/attachments/{attachmentId}']['delete']['parameters'], unknown>; } interface FinopsService { /** * @summary Get accounting connections * @description Get all connections */ getAccountingConnections: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/accounting-connections'; security: ['HTTPBearer']; }, paths['/finops/v1/accounting-connections']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/accounting-connections']['get']['parameters'], paths['/finops/v1/accounting-connections']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting-connections']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting-connections']['get']['responses']['500']['content']['application/json']>; /** * @summary Connect to an accounting system * @description Create new connection */ postAccountingConnections: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/accounting-connections'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/accounting-connections']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/accounting-connections']['post']['parameters'], paths['/finops/v1/accounting-connections']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting-connections']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting-connections']['post']['responses']['500']['content']['application/json']>; /** * @summary Get an accounting connection by ID * @description Get connection by id */ getAccountingConnectionsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/accounting-connections/{connection_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/accounting-connections/{connection_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/accounting-connections/{connection_id}']['get']['parameters'], paths['/finops/v1/accounting-connections/{connection_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting-connections/{connection_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting-connections/{connection_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Disconnect from an accounting system * @description Disconnect */ postAccountingConnectionsIdDisconnect: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/accounting-connections/{connection_id}/disconnect'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/accounting-connections/{connection_id}/disconnect']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/accounting-connections/{connection_id}/disconnect']['post']['parameters'], paths['/finops/v1/accounting-connections/{connection_id}/disconnect']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting-connections/{connection_id}/disconnect']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting-connections/{connection_id}/disconnect']['post']['responses']['500']['content']['application/json']>; /** @summary Force Sync */ postAccountingConnectionsIdSync: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/accounting-connections/{connection_id}/sync'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/accounting-connections/{connection_id}/sync']['post']['responses']['202']['content']['application/json'], paths['/finops/v1/accounting-connections/{connection_id}/sync']['post']['parameters'], paths['/finops/v1/accounting-connections/{connection_id}/sync']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting-connections/{connection_id}/sync']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting-connections/{connection_id}/sync']['post']['responses']['500']['content']['application/json']>; /** * @summary Get Synced Records * @description Get synchronized records */ getAccountingSyncedRecords: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/accounting-synced-records'; security: ['HTTPBearer']; }, paths['/finops/v1/accounting-synced-records']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/accounting-synced-records']['get']['parameters'], paths['/finops/v1/accounting-synced-records']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting-synced-records']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting-synced-records']['get']['responses']['500']['content']['application/json']>; /** * @summary Get Single Synced Record * @description Get synchronized record by id */ getAccountingSyncedRecordsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/accounting-synced-records/{synced_record_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/accounting-synced-records/{synced_record_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/accounting-synced-records/{synced_record_id}']['get']['parameters'], paths['/finops/v1/accounting-synced-records/{synced_record_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting-synced-records/{synced_record_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting-synced-records/{synced_record_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Push Object * @description Push object to the accounting system manually */ postAccountingSyncedRecordsIdPush: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/accounting-synced-records/{synced_record_id}/push'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/accounting-synced-records/{synced_record_id}/push']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/accounting-synced-records/{synced_record_id}/push']['post']['parameters'], paths['/finops/v1/accounting-synced-records/{synced_record_id}/push']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting-synced-records/{synced_record_id}/push']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting-synced-records/{synced_record_id}/push']['post']['responses']['500']['content']['application/json']>; /** * @summary Get tax rate accounts * @description Get all tax rate accounts */ getAccountingTaxRates: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/accounting-tax-rates'; security: ['HTTPBearer']; }, paths['/finops/v1/accounting-tax-rates']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/accounting-tax-rates']['get']['parameters'], paths['/finops/v1/accounting-tax-rates']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates']['get']['responses']['500']['content']['application/json']>; /** * @summary Create a new tax rate * @description Create a new tax rate account */ postAccountingTaxRates: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/accounting-tax-rates'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/accounting-tax-rates']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/accounting-tax-rates']['post']['parameters'], paths['/finops/v1/accounting-tax-rates']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates']['post']['responses']['500']['content']['application/json']>; /** * @summary Get a tax rate account by ID * @description Get tax rate account by id */ getAccountingTaxRatesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/accounting-tax-rates/{tax_rate_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['get']['parameters'], paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update a tax rate * @description Update an existing tax rate account */ patchAccountingTaxRatesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/accounting-tax-rates/{tax_rate_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['patch']['parameters'], paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['patch']['responses']['409']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Delete a tax rate * @description Delete a tax rate account */ deleteAccountingTaxRatesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/accounting-tax-rates/{tax_rate_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['delete']['parameters'], paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['delete']['responses']['409']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting-tax-rates/{tax_rate_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Get payables list from accounting system * @description Returns a list of accounts payable invoices (bills) that exist in the entity's accounting system. This requires that an accounting connection has been previously established. Refer to the [Accounting integration guide](https://docs.monite.com/accounting/integration/index) for details. * * This endpoint only provides read-only access to the accounting system's data but does not pull those payables into Monite. You can use it to review the data in the accounting system and find out which of those payables already exist or do not exist in Monite. * * Data is actual as of the date and time of the last accounting synchronization, which is specified by the `last_pull` value in the response from `GET /accounting-connections/{connection_id}`. To make sure you are accessing the most up-to-date accounting data, you can use `POST /accounting-connections/{connection_id}/sync` to trigger on-demand synchronization before getting the list of payables. */ getAccountingPayables: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/accounting/payables'; security: ['HTTPBearer']; }, paths['/finops/v1/accounting/payables']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/accounting/payables']['get']['parameters'], paths['/finops/v1/accounting/payables']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting/payables']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting/payables']['get']['responses']['500']['content']['application/json']>; /** * @summary Get payable details from accounting system * @description Returns information about an individual payable invoice (bill) that exists in the entity's accounting system. This payable may or may not also exist in Monite. */ getAccountingPayablesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/accounting/payables/{payable_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/accounting/payables/{payable_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/accounting/payables/{payable_id}']['get']['parameters'], paths['/finops/v1/accounting/payables/{payable_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting/payables/{payable_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting/payables/{payable_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Get invoice list from accounting system * @description Returns a list of invoices that exist in the entity's accounting system. This requires that an accounting connection has been previously established. Refer to the [Accounting integration guide](https://docs.monite.com/accounting/integration/index) for details. * * This endpoint only provides read-only access to the accounting system's data but does not pull those invoices into Monite. You can use it to review the data in the accounting system and find out which of those invoices already exist or do not exist in Monite. * * Data is actual as of the date and time of the last accounting synchronization, which is specified by the `last_pull` value in the response from `GET /accounting-connections/{connection_id}`. To make sure you are accessing the most up-to-date accounting data, you can use `POST /accounting-connections/{connection_id}/sync` to trigger on-demand synchronization before getting the invoice list. */ getAccountingReceivables: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/accounting/receivables'; security: ['HTTPBearer']; }, paths['/finops/v1/accounting/receivables']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/accounting/receivables']['get']['parameters'], paths['/finops/v1/accounting/receivables']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting/receivables']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting/receivables']['get']['responses']['500']['content']['application/json']>; /** * @summary Get invoice details from accounting system * @description Returns information about an individual invoice that exists in the entity's accounting system. This invoice may or may not also exist in Monite. */ getAccountingReceivablesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/accounting/receivables/{invoice_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/accounting/receivables/{invoice_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/accounting/receivables/{invoice_id}']['get']['parameters'], paths['/finops/v1/accounting/receivables/{invoice_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/accounting/receivables/{invoice_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/accounting/receivables/{invoice_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Get credit notes analytics * @description Retrieve aggregated statistics for payables with different breakdowns. */ getAnalyticsCreditNotes: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/analytics/credit-notes'; security: ['HTTPBearer']; }, paths['/finops/v1/analytics/credit-notes']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/analytics/credit-notes']['get']['parameters'], paths['/finops/v1/analytics/credit-notes']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/analytics/credit-notes']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/analytics/credit-notes']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/analytics/credit-notes']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/analytics/credit-notes']['get']['responses']['500']['content']['application/json']>; /** * @summary Get payables analytics * @description Retrieve aggregated statistics for payables with different breakdowns. */ getAnalyticsPayables: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/analytics/payables'; security: ['HTTPBearer']; }, paths['/finops/v1/analytics/payables']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/analytics/payables']['get']['parameters'], paths['/finops/v1/analytics/payables']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/analytics/payables']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/analytics/payables']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/analytics/payables']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/analytics/payables']['get']['responses']['500']['content']['application/json']>; /** * @summary Get receipts analytics * @description Retrieve aggregated statistics for payables with different breakdowns. */ getAnalyticsReceipts: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/analytics/receipts'; security: ['HTTPBearer']; }, paths['/finops/v1/analytics/receipts']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/analytics/receipts']['get']['parameters'], paths['/finops/v1/analytics/receipts']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/analytics/receipts']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/analytics/receipts']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/analytics/receipts']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/analytics/receipts']['get']['responses']['500']['content']['application/json']>; /** * @summary Get receivables analytics * @description Retrieve aggregated statistics for receivables with different breakdowns. */ getAnalyticsReceivables: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/analytics/receivables'; security: ['HTTPBearer']; }, paths['/finops/v1/analytics/receivables']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/analytics/receivables']['get']['parameters'], paths['/finops/v1/analytics/receivables']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/analytics/receivables']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/analytics/receivables']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/analytics/receivables']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/analytics/receivables']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/analytics/receivables']['get']['responses']['500']['content']['application/json']>; /** @summary Get transaction analytics */ getAnalyticsTransactions: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/analytics/transactions'; security: ['HTTPBearer']; }, paths['/finops/v1/analytics/transactions']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/analytics/transactions']['get']['parameters'], paths['/finops/v1/analytics/transactions']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/analytics/transactions']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/analytics/transactions']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/analytics/transactions']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/analytics/transactions']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/analytics/transactions']['get']['responses']['500']['content']['application/json']>; /** * @summary Get approval policies * @description Retrieve a list of all approval policies with pagination. */ getApprovalPolicies: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/approval-policies'; security: ['HTTPBearer']; }, paths['/finops/v1/approval-policies']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/approval-policies']['get']['parameters'], paths['/finops/v1/approval-policies']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-policies']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-policies']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/approval-policies']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-policies']['get']['responses']['500']['content']['application/json']>; /** * @summary Create an approval policy * @description Create a new approval policy. */ postApprovalPolicies: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/approval-policies'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/approval-policies']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/approval-policies']['post']['parameters'], paths['/finops/v1/approval-policies']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/approval-policies']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-policies']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-policies']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/approval-policies']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-policies']['post']['responses']['500']['content']['application/json']>; /** * @summary Get an approval policy by ID * @description Retrieve a specific approval policy. */ getApprovalPoliciesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/approval-policies/{approval_policy_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/approval-policies/{approval_policy_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/approval-policies/{approval_policy_id}']['get']['parameters'], paths['/finops/v1/approval-policies/{approval_policy_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update an approval policy * @description Update an existing approval policy. */ patchApprovalPoliciesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/approval-policies/{approval_policy_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/approval-policies/{approval_policy_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/approval-policies/{approval_policy_id}']['patch']['parameters'], paths['/finops/v1/approval-policies/{approval_policy_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['patch']['responses']['409']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Delete an approval policy * @description Delete an existing approval policy. */ deleteApprovalPoliciesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/approval-policies/{approval_policy_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/approval-policies/{approval_policy_id}']['delete']['parameters'], paths['/finops/v1/approval-policies/{approval_policy_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['delete']['responses']['409']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Get approval processes created from a policy * @description Retrieve a list of approval policy processes. The response is capped at the 500 most recent processes; use the `object_id` + `object_type` filters to narrow results for a specific resource. */ getApprovalPoliciesIdProcesses: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/approval-policies/{approval_policy_id}/processes'; security: ['HTTPBearer']; }, paths['/finops/v1/approval-policies/{approval_policy_id}/processes']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/approval-policies/{approval_policy_id}/processes']['get']['parameters'], paths['/finops/v1/approval-policies/{approval_policy_id}/processes']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes']['get']['responses']['500']['content']['application/json']>; /** * @summary Get an approval process by ID * @description Retrieve a specific approval policy process. */ getApprovalPoliciesIdProcessesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}']['get']['parameters'], paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Cancel an approval process * @description Cancel an ongoing approval process for a specific approval policy. */ postApprovalPoliciesIdProcessesIdCancel: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/cancel'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/cancel']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/cancel']['post']['parameters'], paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/cancel']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/cancel']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/cancel']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/cancel']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/cancel']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/cancel']['post']['responses']['500']['content']['application/json']>; /** * @summary Get the steps of an approval process * @description Retrieve a list of approval policy process steps. */ getApprovalPoliciesIdProcessesIdSteps: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/steps'; security: ['HTTPBearer']; }, paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/steps']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/steps']['get']['parameters'], paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/steps']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/steps']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/steps']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/steps']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/steps']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-policies/{approval_policy_id}/processes/{process_id}/steps']['get']['responses']['500']['content']['application/json']>; /** @summary Get approval requests */ getApprovalRequests: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/approval-requests'; security: ['HTTPBearer']; }, paths['/finops/v1/approval-requests']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/approval-requests']['get']['parameters'], paths['/finops/v1/approval-requests']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/approval-requests']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-requests']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/approval-requests']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-requests']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/approval-requests']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-requests']['get']['responses']['500']['content']['application/json']>; /** @summary Create an approval request */ postApprovalRequests: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/approval-requests'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/approval-requests']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/approval-requests']['post']['parameters'], paths['/finops/v1/approval-requests']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/approval-requests']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-requests']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/approval-requests']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/approval-requests']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-requests']['post']['responses']['406']['content']['application/json'] | paths['/finops/v1/approval-requests']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-requests']['post']['responses']['500']['content']['application/json']>; /** @summary Get an approval request by ID */ getApprovalRequestsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/approval-requests/{approval_request_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/approval-requests/{approval_request_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/approval-requests/{approval_request_id}']['get']['parameters'], paths['/finops/v1/approval-requests/{approval_request_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Approve an approval request */ postApprovalRequestsIdApprove: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/approval-requests/{approval_request_id}/approve'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/approval-requests/{approval_request_id}/approve']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/approval-requests/{approval_request_id}/approve']['post']['parameters'], paths['/finops/v1/approval-requests/{approval_request_id}/approve']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/approve']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/approve']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/approve']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/approve']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/approve']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/approve']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/approve']['post']['responses']['500']['content']['application/json']>; /** @summary Cancel an approval request */ postApprovalRequestsIdCancel: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/approval-requests/{approval_request_id}/cancel'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/approval-requests/{approval_request_id}/cancel']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/approval-requests/{approval_request_id}/cancel']['post']['parameters'], paths['/finops/v1/approval-requests/{approval_request_id}/cancel']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/cancel']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/cancel']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/cancel']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/cancel']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/cancel']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/cancel']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/cancel']['post']['responses']['500']['content']['application/json']>; /** @summary Reject an approval request */ postApprovalRequestsIdReject: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/approval-requests/{approval_request_id}/reject'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/approval-requests/{approval_request_id}/reject']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/approval-requests/{approval_request_id}/reject']['post']['parameters'], paths['/finops/v1/approval-requests/{approval_request_id}/reject']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/reject']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/reject']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/reject']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/reject']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/reject']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/reject']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/approval-requests/{approval_request_id}/reject']['post']['responses']['500']['content']['application/json']>; /** * @summary Get an entity's bank accounts * @description Get all bank accounts of this entity. */ getBankDetails: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/bank-details'; security: ['HTTPBearer']; }, paths['/finops/v1/bank-details']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/bank-details']['get']['parameters'], paths['/finops/v1/bank-details']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/bank-details']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/bank-details']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/bank-details']['get']['responses']['500']['content']['application/json']>; /** * @summary Create an entity bank account * @description Add a new US bank account for the specified entity. * * Required fields are `account_holder_name`, `account_number` and `routing_number`. Optionally provide * `bank_name` and `display_name`. */ postBankDetails: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/bank-details'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/bank-details']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/bank-details']['post']['parameters'], paths['/finops/v1/bank-details']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/bank-details']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/bank-details']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/bank-details']['post']['responses']['500']['content']['application/json']>; /** * @summary Get an entity's bank account * @description Retrieve a bank account by its ID. */ getBankDetailsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/bank-details/{bank_account_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/bank-details/{bank_account_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/bank-details/{bank_account_id}']['get']['parameters'], paths['/finops/v1/bank-details/{bank_account_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/bank-details/{bank_account_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/bank-details/{bank_account_id}']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/bank-details/{bank_account_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/bank-details/{bank_account_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update an entity's bank account * @description Change the specified fields with the provided values. */ patchBankDetailsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/bank-details/{bank_account_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/bank-details/{bank_account_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/bank-details/{bank_account_id}']['patch']['parameters'], paths['/finops/v1/bank-details/{bank_account_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/bank-details/{bank_account_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/bank-details/{bank_account_id}']['patch']['responses']['409']['content']['application/json'] | paths['/finops/v1/bank-details/{bank_account_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/bank-details/{bank_account_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Delete an entity's bank account * @description Delete the bank account specified by its ID. */ deleteBankDetailsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/bank-details/{bank_account_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/bank-details/{bank_account_id}']['delete']['parameters'], paths['/finops/v1/bank-details/{bank_account_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/bank-details/{bank_account_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/bank-details/{bank_account_id}']['delete']['responses']['409']['content']['application/json'] | paths['/finops/v1/bank-details/{bank_account_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/bank-details/{bank_account_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Create a batch payment link */ postBatchPaymentLinks: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/batch-payment-links'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/batch-payment-links']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/batch-payment-links']['post']['parameters'], paths['/finops/v1/batch-payment-links']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/batch-payment-links']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/batch-payment-links']['post']['responses']['500']['content']['application/json']>; /** @summary Get a batch payment link by ID */ getBatchPaymentLinksId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/batch-payment-links/{batch_payment_link_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/batch-payment-links/{batch_payment_link_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/batch-payment-links/{batch_payment_link_id}']['get']['parameters'], paths['/finops/v1/batch-payment-links/{batch_payment_link_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/batch-payment-links/{batch_payment_link_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/batch-payment-links/{batch_payment_link_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Expire a batch payment link */ postBatchPaymentLinksIdExpire: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/batch-payment-links/{batch_payment_link_id}/expire'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/batch-payment-links/{batch_payment_link_id}/expire']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/batch-payment-links/{batch_payment_link_id}/expire']['post']['parameters'], paths['/finops/v1/batch-payment-links/{batch_payment_link_id}/expire']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/batch-payment-links/{batch_payment_link_id}/expire']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/batch-payment-links/{batch_payment_link_id}/expire']['post']['responses']['500']['content']['application/json']>; /** @summary Create a batch payment */ postBatchPayments: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/batch-payments'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/batch-payments']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/batch-payments']['post']['parameters'], paths['/finops/v1/batch-payments']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/batch-payments']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/batch-payments']['post']['responses']['500']['content']['application/json']>; /** @summary Get batch payment by ID */ getBatchPaymentsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/batch-payments/{batch_payment_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/batch-payments/{batch_payment_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/batch-payments/{batch_payment_id}']['get']['parameters'], paths['/finops/v1/batch-payments/{batch_payment_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/batch-payments/{batch_payment_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/batch-payments/{batch_payment_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Get comments * @description Get comments */ getComments: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/comments'; security: ['HTTPBearer']; }, paths['/finops/v1/comments']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/comments']['get']['parameters'], paths['/finops/v1/comments']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/comments']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/comments']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/comments']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/comments']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/comments']['get']['responses']['500']['content']['application/json']>; /** * @summary Create a comment * @description Create new comment */ postComments: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/comments'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/comments']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/comments']['post']['parameters'], paths['/finops/v1/comments']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/comments']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/comments']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/comments']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/comments']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/comments']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/comments']['post']['responses']['500']['content']['application/json']>; /** * @summary Get a comment by ID * @description Get comment */ getCommentsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/comments/{comment_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/comments/{comment_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/comments/{comment_id}']['get']['parameters'], paths['/finops/v1/comments/{comment_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update a comment * @description Update comment */ patchCommentsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/comments/{comment_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/comments/{comment_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/comments/{comment_id}']['patch']['parameters'], paths['/finops/v1/comments/{comment_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['patch']['responses']['409']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Delete a comment * @description Delete comment */ deleteCommentsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/comments/{comment_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/comments/{comment_id}']['delete']['parameters'], paths['/finops/v1/comments/{comment_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['delete']['responses']['409']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/comments/{comment_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Delete * @description Delete company */ deleteCompanies: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/companies'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/companies']['delete']['parameters'], paths['/finops/v1/companies']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/companies']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/companies']['delete']['responses']['500']['content']['application/json']>; /** * @summary Get cost centers * @description Get all cost centers */ getCostCenters: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/cost-centers'; security: ['HTTPBearer']; }, paths['/finops/v1/cost-centers']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/cost-centers']['get']['parameters'], paths['/finops/v1/cost-centers']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/cost-centers']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/cost-centers']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/cost-centers']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/cost-centers']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/cost-centers']['get']['responses']['500']['content']['application/json']>; /** * @summary Create a new cost center * @description Create a new cost center */ postCostCenters: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/cost-centers'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/cost-centers']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/cost-centers']['post']['parameters'], paths['/finops/v1/cost-centers']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/cost-centers']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/cost-centers']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/cost-centers']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/cost-centers']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/cost-centers']['post']['responses']['500']['content']['application/json']>; /** * @summary Get a cost center by ID * @description Get cost center by id */ getCostCentersId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/cost-centers/{cost_center_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/cost-centers/{cost_center_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/cost-centers/{cost_center_id}']['get']['parameters'], paths['/finops/v1/cost-centers/{cost_center_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update a cost center * @description Update an existing cost center */ patchCostCentersId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/cost-centers/{cost_center_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/cost-centers/{cost_center_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/cost-centers/{cost_center_id}']['patch']['parameters'], paths['/finops/v1/cost-centers/{cost_center_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['patch']['responses']['409']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Delete a cost center * @description Delete a cost center */ deleteCostCentersId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/cost-centers/{cost_center_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/cost-centers/{cost_center_id}']['delete']['parameters'], paths['/finops/v1/cost-centers/{cost_center_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['delete']['responses']['409']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/cost-centers/{cost_center_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get all counterparts */ getCounterparts: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/counterparts'; security: ['HTTPBearer']; }, paths['/finops/v1/counterparts']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts']['get']['parameters'], paths['/finops/v1/counterparts']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts']['get']['responses']['500']['content']['application/json']>; /** @summary Create a counterpart */ postCounterparts: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/counterparts'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/counterparts']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/counterparts']['post']['parameters'], paths['/finops/v1/counterparts']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts']['post']['responses']['500']['content']['application/json']>; /** @summary Get a counterpart */ getCounterpartsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/counterparts/{counterpart_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/counterparts/{counterpart_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}']['get']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a counterpart */ patchCounterpartsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/counterparts/{counterpart_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}']['patch']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a counterpart */ deleteCounterpartsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/counterparts/{counterpart_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/counterparts/{counterpart_id}']['delete']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get a counterpart's addresses */ getCounterpartsIdAddresses: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/counterparts/{counterpart_id}/addresses'; security: ['HTTPBearer']; }, paths['/finops/v1/counterparts/{counterpart_id}/addresses']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/addresses']['get']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/addresses']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses']['get']['responses']['500']['content']['application/json']>; /** @summary Create a counterpart address */ postCounterpartsIdAddresses: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/counterparts/{counterpart_id}/addresses'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/addresses']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/addresses']['post']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/addresses']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses']['post']['responses']['500']['content']['application/json']>; /** @summary Get a counterpart's address */ getCounterpartsIdAddressesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['get']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a counterpart's address */ patchCounterpartsIdAddressesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['patch']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a counterpart's address */ deleteCounterpartsIdAddressesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['delete']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/addresses/{address_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get a counterpart's bank accounts */ getCounterpartsIdBankAccounts: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/counterparts/{counterpart_id}/bank-accounts'; security: ['HTTPBearer']; }, paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['get']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['get']['responses']['500']['content']['application/json']>; /** @summary Create a counterpart bank account */ postCounterpartsIdBankAccounts: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/counterparts/{counterpart_id}/bank-accounts'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['post']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts']['post']['responses']['500']['content']['application/json']>; /** @summary Get a counterpart's bank account */ getCounterpartsIdBankAccountsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['get']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a counterpart's bank account */ patchCounterpartsIdBankAccountsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['patch']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a counterpart's bank account */ deleteCounterpartsIdBankAccountsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['delete']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Set a counterpart's bank account as default for its currency */ postCounterpartsIdBankAccountsIdMakeDefault: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}/make-default'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}/make-default']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}/make-default']['post']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}/make-default']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}/make-default']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}/make-default']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}/make-default']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}/make-default']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/bank-accounts/{bank_account_id}/make-default']['post']['responses']['500']['content']['application/json']>; /** @summary Get a counterpart's contacts */ getCounterpartsIdContacts: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/counterparts/{counterpart_id}/contacts'; security: ['HTTPBearer']; }, paths['/finops/v1/counterparts/{counterpart_id}/contacts']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/contacts']['get']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/contacts']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts']['get']['responses']['500']['content']['application/json']>; /** @summary Create a counterpart contact */ postCounterpartsIdContacts: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/counterparts/{counterpart_id}/contacts'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/contacts']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/contacts']['post']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/contacts']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts']['post']['responses']['500']['content']['application/json']>; /** @summary Get a counterpart's contact */ getCounterpartsIdContactsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['get']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a counterpart's contact */ patchCounterpartsIdContactsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['patch']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['patch']['responses']['409']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a counterpart's contact */ deleteCounterpartsIdContactsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['delete']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['delete']['responses']['409']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Set a counterpart's default contact */ postCounterpartsIdContactsIdMakeDefault: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}/make-default'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}/make-default']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}/make-default']['post']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}/make-default']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}/make-default']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}/make-default']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}/make-default']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}/make-default']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}/make-default']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/contacts/{contact_id}/make-default']['post']['responses']['500']['content']['application/json']>; /** @summary Get a list of a counterpart's e-invoicing credentials */ getCounterpartsIdEinvoicingCredentials: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials'; security: ['HTTPBearer']; }, paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials']['get']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials']['get']['responses']['500']['content']['application/json']>; /** @summary Add e-invoicing credentials for a counterpart */ postCounterpartsIdEinvoicingCredentials: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials']['post']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials']['post']['responses']['500']['content']['application/json']>; /** @summary Get a counterpart's e-invoicing credentials by ID */ getCounterpartsIdEinvoicingCredentialsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['get']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a counterpart's e-invoicing credentials */ patchCounterpartsIdEinvoicingCredentialsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['patch']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a counterpart's e-invoicing credentials */ deleteCounterpartsIdEinvoicingCredentialsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['delete']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/einvoicing-credentials/{credential_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get counterpart metadata */ getCounterpartsIdPartnerMetadata: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/counterparts/{counterpart_id}/partner-metadata'; security: ['HTTPBearer']; }, paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['get']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['get']['responses']['500']['content']['application/json']>; /** @summary Replace counterpart metadata */ putCounterpartsIdPartnerMetadata: ServiceOperationMutation<{ method: 'put'; url: '/finops/v1/counterparts/{counterpart_id}/partner-metadata'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['put']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['put']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['put']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['put']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['put']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['put']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['put']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/partner-metadata']['put']['responses']['500']['content']['application/json']>; /** @summary Get a counterpart's VAT IDs */ getCounterpartsIdVatIds: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/counterparts/{counterpart_id}/vat-ids'; security: ['HTTPBearer']; }, paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['get']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['get']['responses']['500']['content']['application/json']>; /** @summary Create a counterpart VAT ID */ postCounterpartsIdVatIds: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/counterparts/{counterpart_id}/vat-ids'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['post']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids']['post']['responses']['500']['content']['application/json']>; /** @summary Get a counterpart's VAT ID */ getCounterpartsIdVatIdsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['get']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a counterpart's VAT ID */ patchCounterpartsIdVatIdsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['patch']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a counterpart's VAT ID */ deleteCounterpartsIdVatIdsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['delete']['parameters'], paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/counterparts/{counterpart_id}/vat-ids/{vat_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get custom tax rates */ getCustomTaxRates: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/custom-tax-rates'; security: ['HTTPBearer']; }, paths['/finops/v1/custom-tax-rates']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/custom-tax-rates']['get']['parameters'], paths['/finops/v1/custom-tax-rates']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/custom-tax-rates']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/custom-tax-rates']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/custom-tax-rates']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/custom-tax-rates']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/custom-tax-rates']['get']['responses']['500']['content']['application/json']>; /** @summary Create a custom tax rate */ postCustomTaxRates: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/custom-tax-rates'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/custom-tax-rates']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/custom-tax-rates']['post']['parameters'], paths['/finops/v1/custom-tax-rates']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/custom-tax-rates']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/custom-tax-rates']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/custom-tax-rates']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/custom-tax-rates']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/custom-tax-rates']['post']['responses']['500']['content']['application/json']>; /** @summary Get a custom tax rate by ID */ getCustomTaxRatesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/custom-tax-rates/{custom_tax_rate_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['get']['parameters'], paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a custom tax rate */ patchCustomTaxRatesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/custom-tax-rates/{custom_tax_rate_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['patch']['parameters'], paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a custom tax rate */ deleteCustomTaxRatesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/custom-tax-rates/{custom_tax_rate_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['delete']['parameters'], paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/custom-tax-rates/{custom_tax_rate_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get all export jobs */ getDataExports: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/data-exports'; security: ['HTTPBearer']; }, paths['/finops/v1/data-exports']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/data-exports']['get']['parameters'], paths['/finops/v1/data-exports']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/data-exports']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/data-exports']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/data-exports']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/data-exports']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/data-exports']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/data-exports']['get']['responses']['500']['content']['application/json']>; /** * @summary Create an export job * @description Request the export of payable and receivable documents with the specified statuses. */ postDataExports: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/data-exports'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/data-exports']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/data-exports']['post']['parameters'], paths['/finops/v1/data-exports']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/data-exports']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/data-exports']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/data-exports']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/data-exports']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/data-exports']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/data-exports']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/data-exports']['post']['responses']['500']['content']['application/json']>; /** @summary Get extra fields included in data export */ getDataExportsExtraData: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/data-exports/extra-data'; security: ['HTTPBearer']; }, paths['/finops/v1/data-exports/extra-data']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/data-exports/extra-data']['get']['parameters'], paths['/finops/v1/data-exports/extra-data']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data']['get']['responses']['500']['content']['application/json']>; /** @summary Add a field to be included in data export */ postDataExportsExtraData: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/data-exports/extra-data'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/data-exports/extra-data']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/data-exports/extra-data']['post']['parameters'], paths['/finops/v1/data-exports/extra-data']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data']['post']['responses']['500']['content']['application/json']>; /** @summary Get an extra field by ID */ getDataExportsExtraDataId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/data-exports/extra-data/{extra_data_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['get']['parameters'], paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update the configuration of an extra field */ patchDataExportsExtraDataId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/data-exports/extra-data/{extra_data_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['patch']['parameters'], paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete an extra field */ deleteDataExportsExtraDataId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/data-exports/extra-data/{extra_data_id}'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['delete']['responses']['200']['content']['application/json'], paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['delete']['parameters'], paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/data-exports/extra-data/{extra_data_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get supported export formats */ getDataExportsSupportedFormats: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/data-exports/supported-formats'; security: ['HTTPBearer']; }, paths['/finops/v1/data-exports/supported-formats']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/data-exports/supported-formats']['get']['parameters'], paths['/finops/v1/data-exports/supported-formats']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/data-exports/supported-formats']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/data-exports/supported-formats']['get']['responses']['500']['content']['application/json']>; /** @summary Get the export job status by ID */ getDataExportsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/data-exports/{document_export_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/data-exports/{document_export_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/data-exports/{document_export_id}']['get']['parameters'], paths['/finops/v1/data-exports/{document_export_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/data-exports/{document_export_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/data-exports/{document_export_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/data-exports/{document_export_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/data-exports/{document_export_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/data-exports/{document_export_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/data-exports/{document_export_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Get delivery notes * @description Get all delivery notes with filtering and pagination. */ getDeliveryNotes: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/delivery-notes'; security: ['HTTPBearer']; }, paths['/finops/v1/delivery-notes']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/delivery-notes']['get']['parameters'], paths['/finops/v1/delivery-notes']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/delivery-notes']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/delivery-notes']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/delivery-notes']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/delivery-notes']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/delivery-notes']['get']['responses']['500']['content']['application/json']>; /** @summary Create a delivery note */ postDeliveryNotes: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/delivery-notes'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/delivery-notes']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/delivery-notes']['post']['parameters'], paths['/finops/v1/delivery-notes']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/delivery-notes']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/delivery-notes']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/delivery-notes']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/delivery-notes']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/delivery-notes']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/delivery-notes']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/delivery-notes']['post']['responses']['500']['content']['application/json']>; /** @summary Get a delivery note by ID */ getDeliveryNotesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/delivery-notes/{delivery_note_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/delivery-notes/{delivery_note_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/delivery-notes/{delivery_note_id}']['get']['parameters'], paths['/finops/v1/delivery-notes/{delivery_note_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a delivery note */ patchDeliveryNotesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/delivery-notes/{delivery_note_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/delivery-notes/{delivery_note_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/delivery-notes/{delivery_note_id}']['patch']['parameters'], paths['/finops/v1/delivery-notes/{delivery_note_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['patch']['responses']['409']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a delivery note */ deleteDeliveryNotesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/delivery-notes/{delivery_note_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/delivery-notes/{delivery_note_id}']['delete']['parameters'], paths['/finops/v1/delivery-notes/{delivery_note_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Cancel a delivery note */ postDeliveryNotesIdCancel: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/delivery-notes/{delivery_note_id}/cancel'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/delivery-notes/{delivery_note_id}/cancel']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/delivery-notes/{delivery_note_id}/cancel']['post']['parameters'], paths['/finops/v1/delivery-notes/{delivery_note_id}/cancel']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/cancel']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/cancel']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/cancel']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/cancel']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/cancel']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/cancel']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/cancel']['post']['responses']['500']['content']['application/json']>; /** @summary Mark a delivery note as delivered */ postDeliveryNotesIdMarkAsDelivered: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/delivery-notes/{delivery_note_id}/mark-as-delivered'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/delivery-notes/{delivery_note_id}/mark-as-delivered']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/delivery-notes/{delivery_note_id}/mark-as-delivered']['post']['parameters'], paths['/finops/v1/delivery-notes/{delivery_note_id}/mark-as-delivered']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/mark-as-delivered']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/mark-as-delivered']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/mark-as-delivered']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/mark-as-delivered']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/mark-as-delivered']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/mark-as-delivered']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/delivery-notes/{delivery_note_id}/mark-as-delivered']['post']['responses']['500']['content']['application/json']>; /** * @summary Get PDF templates * @description This API call returns all supported templates with language codes. */ getDocumentTemplates: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/document-templates'; security: ['HTTPBearer']; }, paths['/finops/v1/document-templates']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/document-templates']['get']['parameters'], paths['/finops/v1/document-templates']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/document-templates']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/document-templates']['get']['responses']['500']['content']['application/json']>; /** * @summary Get built-in PDF templates * @description This API call returns all supported system templates with language codes. */ getDocumentTemplatesSystem: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/document-templates/system'; security: ['HTTPBearer']; }, paths['/finops/v1/document-templates/system']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/document-templates/system']['get']['parameters'], paths['/finops/v1/document-templates/system']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/document-templates/system']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/document-templates/system']['get']['responses']['500']['content']['application/json']>; /** @summary Get a PDF template by ID */ getDocumentTemplatesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/document-templates/{document_template_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/document-templates/{document_template_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/document-templates/{document_template_id}']['get']['parameters'], paths['/finops/v1/document-templates/{document_template_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/document-templates/{document_template_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/document-templates/{document_template_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Set the default PDF template */ postDocumentTemplatesIdMakeDefault: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/document-templates/{document_template_id}/make-default'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/document-templates/{document_template_id}/make-default']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/document-templates/{document_template_id}/make-default']['post']['parameters'], paths['/finops/v1/document-templates/{document_template_id}/make-default']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/document-templates/{document_template_id}/make-default']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/document-templates/{document_template_id}/make-default']['post']['responses']['500']['content']['application/json']>; /** * @summary Preview a PDF template * @description Returns a sample PDF invoice generated using the specified template. */ getDocumentTemplatesIdPreview: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/document-templates/{document_template_id}/preview'; security: ['HTTPBearer']; }, unknown, paths['/finops/v1/document-templates/{document_template_id}/preview']['get']['parameters'], paths['/finops/v1/document-templates/{document_template_id}/preview']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/document-templates/{document_template_id}/preview']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/document-templates/{document_template_id}/preview']['get']['responses']['500']['content']['application/json']>; /** * @summary Generate Document Id * @description Generate an ID for given document */ postDocumentsGenerate: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/documents/generate'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/documents/generate']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/documents/generate']['post']['parameters'], paths['/finops/v1/documents/generate']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/documents/generate']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/documents/generate']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/documents/generate']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/documents/generate']['post']['responses']['500']['content']['application/json']>; /** @summary Get Last Document */ getDocumentsLast: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/documents/last'; security: ['HTTPBearer']; }, paths['/finops/v1/documents/last']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/documents/last']['get']['parameters'], paths['/finops/v1/documents/last']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/documents/last']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/documents/last']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/documents/last']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/documents/last']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/documents/last']['get']['responses']['500']['content']['application/json']>; /** @summary Create Doc Id */ postDocumentsReset: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/documents/reset'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/documents/reset']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/documents/reset']['post']['parameters'], paths['/finops/v1/documents/reset']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/documents/reset']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/documents/reset']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/documents/reset']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/documents/reset']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/documents/reset']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/documents/reset']['post']['responses']['500']['content']['application/json']>; /** @summary Get the next document numbers for an entity */ getDocumentsIdNextNumbers: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/documents/{entity_id}/next-numbers'; security: ['HTTPBearer']; }, paths['/finops/v1/documents/{entity_id}/next-numbers']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/documents/{entity_id}/next-numbers']['get']['parameters'], paths['/finops/v1/documents/{entity_id}/next-numbers']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/documents/{entity_id}/next-numbers']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/documents/{entity_id}/next-numbers']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/documents/{entity_id}/next-numbers']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/documents/{entity_id}/next-numbers']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/documents/{entity_id}/next-numbers']['get']['responses']['500']['content']['application/json']>; /** @summary Check if e-invoicing credentials exist in the network. */ getEinvoiceSearch: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/einvoice-search'; security: ['HTTPBearer']; }, paths['/finops/v1/einvoice-search']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/einvoice-search']['get']['parameters'], paths['/finops/v1/einvoice-search']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/einvoice-search']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/einvoice-search']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/einvoice-search']['get']['responses']['500']['content']['application/json']>; /** * @summary Get all entities * @description Retrieve a list of all entities. */ getEntities: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entities'; security: ['HTTPBearer']; }, paths['/finops/v1/entities']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entities']['get']['parameters'], paths['/finops/v1/entities']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/entities']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/entities']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/entities']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/entities']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities']['get']['responses']['500']['content']['application/json']>; /** * @summary Create an entity * @description Create a new entity from the specified values. */ postEntities: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/entities'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entities']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/entities']['post']['parameters'], paths['/finops/v1/entities']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/entities']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/entities']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities']['post']['responses']['500']['content']['application/json']>; /** * @deprecated * @summary Get the current entity * @description Deprecated. Use `GET /entity_users/my_entity` instead. */ getEntitiesMe: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entities/me'; security: ['HTTPBearer']; }, paths['/finops/v1/entities/me']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/me']['get']['parameters'], paths['/finops/v1/entities/me']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/entities/me']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/me']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/me']['get']['responses']['500']['content']['application/json']>; /** * @deprecated * @summary Update the current entity * @description Deprecated. Use `PATCH /entity_users/my_entity` instead. */ patchEntitiesMe: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/entities/me'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entities/me']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/me']['patch']['parameters'], paths['/finops/v1/entities/me']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/entities/me']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/me']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/me']['patch']['responses']['500']['content']['application/json']>; /** * @summary Get an entity * @description Retrieve an entity by its ID. */ getEntitiesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entities/{entity_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/entities/{entity_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}']['get']['parameters'], paths['/finops/v1/entities/{entity_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update an entity * @description Change the specified fields with the provided values. */ patchEntitiesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/entities/{entity_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entities/{entity_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}']['patch']['parameters'], paths['/finops/v1/entities/{entity_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Activate an entity * @description Activate an entity to allow it to perform any operations. */ postEntitiesIdActivate: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/entities/{entity_id}/activate'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/entities/{entity_id}/activate']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/activate']['post']['parameters'], paths['/finops/v1/entities/{entity_id}/activate']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/activate']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/activate']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/activate']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/activate']['post']['responses']['500']['content']['application/json']>; /** * @summary Deactivate an entity * @description Deactivate an entity to stop it from performing any operations. */ postEntitiesIdDeactivate: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/entities/{entity_id}/deactivate'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/entities/{entity_id}/deactivate']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/deactivate']['post']['parameters'], paths['/finops/v1/entities/{entity_id}/deactivate']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/deactivate']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/deactivate']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/deactivate']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/deactivate']['post']['responses']['500']['content']['application/json']>; /** * @deprecated * @summary Update entity onboarding documents * @description Deprecated. Use `POST /onboarding_documents` instead. Update the onboarding documents of an entity. */ postEntitiesIdDocuments: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/entities/{entity_id}/documents'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/entities/{entity_id}/documents']['post']['parameters'], paths['/finops/v1/entities/{entity_id}/documents']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/documents']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/documents']['post']['responses']['500']['content']['application/json']>; /** * @summary Upload an entity logo * @description Entity logo can be PNG, JPG, or GIF, up to 10 MB in size. The logo is used, for example, in PDF documents created by this entity. */ putEntitiesIdLogo: ServiceOperationMutation<{ method: 'put'; url: '/finops/v1/entities/{entity_id}/logo'; mediaType: 'multipart/form-data'; security: ['HTTPBearer']; }, NonNullable['content']['multipart/form-data'], paths['/finops/v1/entities/{entity_id}/logo']['put']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/logo']['put']['parameters'], paths['/finops/v1/entities/{entity_id}/logo']['put']['responses']['400']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/logo']['put']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/logo']['put']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/logo']['put']['responses']['500']['content']['application/json']>; /** @summary Delete an entity's logo */ deleteEntitiesIdLogo: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/entities/{entity_id}/logo'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/entities/{entity_id}/logo']['delete']['parameters'], paths['/finops/v1/entities/{entity_id}/logo']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/logo']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/logo']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/logo']['delete']['responses']['500']['content']['application/json']>; /** @summary Get entity onboarding data */ getEntitiesIdOnboardingData: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entities/{entity_id}/onboarding-data'; security: ['HTTPBearer']; }, paths['/finops/v1/entities/{entity_id}/onboarding-data']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/onboarding-data']['get']['parameters'], paths['/finops/v1/entities/{entity_id}/onboarding-data']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-data']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-data']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-data']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-data']['get']['responses']['500']['content']['application/json']>; /** * @deprecated * @summary Update entity onboarding data * @description Deprecated. Use `PATCH /entities/{entity_id}/onboarding_data` instead. Update entity onboarding data. */ putEntitiesIdOnboardingData: ServiceOperationMutation<{ method: 'put'; url: '/finops/v1/entities/{entity_id}/onboarding-data'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entities/{entity_id}/onboarding-data']['put']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/onboarding-data']['put']['parameters'], paths['/finops/v1/entities/{entity_id}/onboarding-data']['put']['responses']['404']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-data']['put']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-data']['put']['responses']['409']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-data']['put']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-data']['put']['responses']['500']['content']['application/json']>; /** @summary Patch entity onboarding data */ patchEntitiesIdOnboardingData: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/entities/{entity_id}/onboarding-data'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entities/{entity_id}/onboarding-data']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/onboarding-data']['patch']['parameters'], paths['/finops/v1/entities/{entity_id}/onboarding-data']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-data']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-data']['patch']['responses']['409']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-data']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-data']['patch']['responses']['500']['content']['application/json']>; /** * @deprecated * @summary Get onboarding requirements * @description Deprecated. Use `GET /onboarding-requirements` instead. Check the information required to complete the onboarding process. */ getEntitiesIdOnboardingRequirements: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entities/{entity_id}/onboarding-requirements'; security: ['HTTPBearer']; }, paths['/finops/v1/entities/{entity_id}/onboarding-requirements']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/onboarding-requirements']['get']['parameters'], paths['/finops/v1/entities/{entity_id}/onboarding-requirements']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-requirements']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/onboarding-requirements']['get']['responses']['500']['content']['application/json']>; /** * @summary Get entity metadata * @description Retrieve a metadata object associated with this entity, usually in a JSON format. */ getEntitiesIdPartnerMetadata: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entities/{entity_id}/partner-metadata'; security: ['HTTPBearer']; }, paths['/finops/v1/entities/{entity_id}/partner-metadata']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/partner-metadata']['get']['parameters'], paths['/finops/v1/entities/{entity_id}/partner-metadata']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/partner-metadata']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/partner-metadata']['get']['responses']['500']['content']['application/json']>; /** * @summary Replace entity metadata * @description Fully replace the current metadata object with the specified instance. */ putEntitiesIdPartnerMetadata: ServiceOperationMutation<{ method: 'put'; url: '/finops/v1/entities/{entity_id}/partner-metadata'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entities/{entity_id}/partner-metadata']['put']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/partner-metadata']['put']['parameters'], paths['/finops/v1/entities/{entity_id}/partner-metadata']['put']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/partner-metadata']['put']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/partner-metadata']['put']['responses']['500']['content']['application/json']>; /** * @summary Get Enabled Payment Methods * @description Get all enabled payment methods. */ getEntitiesIdPaymentMethods: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entities/{entity_id}/payment-methods'; security: ['HTTPBearer']; }, paths['/finops/v1/entities/{entity_id}/payment-methods']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/payment-methods']['get']['parameters'], paths['/finops/v1/entities/{entity_id}/payment-methods']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/payment-methods']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/payment-methods']['get']['responses']['500']['content']['application/json']>; /** * @summary Enable Payment Methods * @description Set which payment methods should be enabled. */ putEntitiesIdPaymentMethods: ServiceOperationMutation<{ method: 'put'; url: '/finops/v1/entities/{entity_id}/payment-methods'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entities/{entity_id}/payment-methods']['put']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/payment-methods']['put']['parameters'], paths['/finops/v1/entities/{entity_id}/payment-methods']['put']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/payment-methods']['put']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/payment-methods']['put']['responses']['500']['content']['application/json']>; /** * @summary Get entity settings * @description Retrieve all settings for this entity. */ getEntitiesIdSettings: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entities/{entity_id}/settings'; security: ['HTTPBearer']; }, paths['/finops/v1/entities/{entity_id}/settings']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/settings']['get']['parameters'], paths['/finops/v1/entities/{entity_id}/settings']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/settings']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/settings']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/settings']['get']['responses']['500']['content']['application/json']>; /** * @summary Update entity settings * @description Change the specified fields with the provided values. */ patchEntitiesIdSettings: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/entities/{entity_id}/settings'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entities/{entity_id}/settings']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/settings']['patch']['parameters'], paths['/finops/v1/entities/{entity_id}/settings']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/settings']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/settings']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/settings']['patch']['responses']['500']['content']['application/json']>; /** @summary Get an entity's VAT IDs */ getEntitiesIdVatIds: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entities/{entity_id}/vat-ids'; security: ['HTTPBearer']; }, paths['/finops/v1/entities/{entity_id}/vat-ids']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/vat-ids']['get']['parameters'], paths['/finops/v1/entities/{entity_id}/vat-ids']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids']['get']['responses']['500']['content']['application/json']>; /** @summary Create an entity VAT ID */ postEntitiesIdVatIds: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/entities/{entity_id}/vat-ids'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entities/{entity_id}/vat-ids']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/vat-ids']['post']['parameters'], paths['/finops/v1/entities/{entity_id}/vat-ids']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids']['post']['responses']['500']['content']['application/json']>; /** @summary Get an entity's VAT ID */ getEntitiesIdVatIdsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entities/{entity_id}/vat-ids/{id}'; security: ['HTTPBearer']; }, paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['get']['parameters'], paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update an entity's VAT ID */ patchEntitiesIdVatIdsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/entities/{entity_id}/vat-ids/{id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['patch']['parameters'], paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete an entity's VAT ID */ deleteEntitiesIdVatIdsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/entities/{entity_id}/vat-ids/{id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['delete']['parameters'], paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/entities/{entity_id}/vat-ids/{id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Get all entity users * @description Retrieve a list of all entity users. */ getEntityUsers: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entity-users'; security: ['HTTPBearer']; }, paths['/finops/v1/entity-users']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entity-users']['get']['parameters'], paths['/finops/v1/entity-users']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/entity-users']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/entity-users']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/entity-users']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entity-users']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/entity-users']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entity-users']['get']['responses']['500']['content']['application/json']>; /** * @summary Create an entity user * @description Create a new entity user from the specified values. */ postEntityUsers: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/entity-users'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entity-users']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/entity-users']['post']['parameters'], paths['/finops/v1/entity-users']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/entity-users']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/entity-users']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/entity-users']['post']['responses']['500']['content']['application/json']>; /** * @summary Get current entity user * @description Retrieve an entity user by its ID. */ getEntityUsersMe: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entity-users/me'; security: ['HTTPBearer']; }, paths['/finops/v1/entity-users/me']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entity-users/me']['get']['parameters'], paths['/finops/v1/entity-users/me']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/entity-users/me']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entity-users/me']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entity-users/me']['get']['responses']['500']['content']['application/json']>; /** * @summary Update current entity user * @description Change the specified fields with provided values. */ patchEntityUsersMe: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/entity-users/me'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entity-users/me']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/entity-users/me']['patch']['parameters'], paths['/finops/v1/entity-users/me']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/entity-users/me']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/entity-users/me']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/entity-users/me']['patch']['responses']['500']['content']['application/json']>; /** * @summary Get an entity of this user * @description Retrieves information of an entity, which this entity user belongs to. */ getEntityUsersMyEntity: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entity-users/my-entity'; security: ['HTTPBearer']; }, paths['/finops/v1/entity-users/my-entity']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entity-users/my-entity']['get']['parameters'], paths['/finops/v1/entity-users/my-entity']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/entity-users/my-entity']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entity-users/my-entity']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entity-users/my-entity']['get']['responses']['500']['content']['application/json']>; /** * @summary Update an entity of this user * @description Update information of an entity, which this entity user belongs to. */ patchEntityUsersMyEntity: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/entity-users/my-entity'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entity-users/my-entity']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/entity-users/my-entity']['patch']['parameters'], paths['/finops/v1/entity-users/my-entity']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/entity-users/my-entity']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/entity-users/my-entity']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/entity-users/my-entity']['patch']['responses']['500']['content']['application/json']>; /** * @summary Get a role of this entity user * @description Retrieves information of a role assigned to this entity user. */ getEntityUsersMyRole: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entity-users/my-role'; security: ['HTTPBearer']; }, paths['/finops/v1/entity-users/my-role']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entity-users/my-role']['get']['parameters'], paths['/finops/v1/entity-users/my-role']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entity-users/my-role']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entity-users/my-role']['get']['responses']['500']['content']['application/json']>; /** * @summary Get an entity user * @description Retrieve an entity user by its ID. */ getEntityUsersId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/entity-users/{entity_user_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/entity-users/{entity_user_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/entity-users/{entity_user_id}']['get']['parameters'], paths['/finops/v1/entity-users/{entity_user_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/entity-users/{entity_user_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/entity-users/{entity_user_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/entity-users/{entity_user_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update an entity user * @description Change the specified fields with provided values. */ patchEntityUsersId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/entity-users/{entity_user_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/entity-users/{entity_user_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/entity-users/{entity_user_id}']['patch']['parameters'], paths['/finops/v1/entity-users/{entity_user_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/entity-users/{entity_user_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/entity-users/{entity_user_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/entity-users/{entity_user_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete an entity user */ deleteEntityUsersId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/entity-users/{entity_user_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/entity-users/{entity_user_id}']['delete']['parameters'], paths['/finops/v1/entity-users/{entity_user_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/entity-users/{entity_user_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/entity-users/{entity_user_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/entity-users/{entity_user_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Get events * @description Returns all webhook events that were triggered for the specified entity based on your enabled webhook subscriptions. These are the same events that were sent to your configured webhook listener endpoints, aggregated into a single list. Results can be filtered by the related object type or time period. * * You can use this to get the missed events for the time periods when your webhook listener was temporarily unavailable. * * We guarantee access to event data only from the last three months. Earlier events may be unavailable. */ getEvents: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/events'; security: ['HTTPBearer']; }, paths['/finops/v1/events']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/events']['get']['parameters'], paths['/finops/v1/events']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/events']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/events']['get']['responses']['500']['content']['application/json']>; /** * @summary Get an event by ID * @description Get a webhook event by its ID. The data is the same as you might have previously received in a webhook sent by Monite to your server. */ getEventsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/events/{event_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/events/{event_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/events/{event_id}']['get']['parameters'], paths['/finops/v1/events/{event_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/events/{event_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/events/{event_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Get files */ getFiles: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/files'; security: ['HTTPBearer']; }, paths['/finops/v1/files']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/files']['get']['parameters'], paths['/finops/v1/files']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/files']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/files']['get']['responses']['500']['content']['application/json']>; /** @summary Upload a file */ postFiles: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/files'; mediaType: 'multipart/form-data'; security: ['HTTPBearer']; }, NonNullable['content']['multipart/form-data'], paths['/finops/v1/files']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/files']['post']['parameters'], paths['/finops/v1/files']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/files']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/files']['post']['responses']['500']['content']['application/json']>; /** @summary Get a file by ID */ getFilesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/files/{file_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/files/{file_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/files/{file_id}']['get']['parameters'], paths['/finops/v1/files/{file_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/files/{file_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/files/{file_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Delete a file */ deleteFilesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/files/{file_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/files/{file_id}']['delete']['parameters'], paths['/finops/v1/files/{file_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/files/{file_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/files/{file_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Get invoices * @description Returns a list of invoices requested for financing */ getFinancingInvoices: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/financing-invoices'; security: ['HTTPBearer']; }, paths['/finops/v1/financing-invoices']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/financing-invoices']['get']['parameters'], paths['/finops/v1/financing-invoices']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/financing-invoices']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/financing-invoices']['get']['responses']['500']['content']['application/json']>; /** * @summary Request financing for invoices * @description Returns a session token and a connect token to open Kanmon SDK for confirming invoice details. */ postFinancingInvoices: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/financing-invoices'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/financing-invoices']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/financing-invoices']['post']['parameters'], paths['/finops/v1/financing-invoices']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/financing-invoices']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/financing-invoices']['post']['responses']['500']['content']['application/json']>; /** * @summary Get financing offers and the business status * @description Returns a list of financing offers and the business's onboarding status */ getFinancingOffers: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/financing-offers'; security: ['HTTPBearer']; }, paths['/finops/v1/financing-offers']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/financing-offers']['get']['parameters'], paths['/finops/v1/financing-offers']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/financing-offers']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/financing-offers']['get']['responses']['500']['content']['application/json']>; /** * @summary Create a token for Kanmon SDK * @description Returns a token for Kanmon SDK. Creates a business and user on Kanmon if not already exist. */ postFinancingTokens: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/financing-tokens'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/financing-tokens']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/financing-tokens']['post']['parameters'], paths['/finops/v1/financing-tokens']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/financing-tokens']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/financing-tokens']['post']['responses']['500']['content']['application/json']>; /** * @summary Get Rates V2 * @description Get exchange rates between specified currency and others */ getGetRatesV2: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/get-rates-v2'; security: ['HTTPBearer']; }, paths['/finops/v1/get-rates-v2']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/get-rates-v2']['get']['parameters'], paths['/finops/v1/get-rates-v2']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/get-rates-v2']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/get-rates-v2']['get']['responses']['500']['content']['application/json']>; /** @summary Get Payment Link */ getInternalBatchPaymentLinksId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/internal/batch-payment-links/{batch_payment_link_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/internal/batch-payment-links/{batch_payment_link_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/internal/batch-payment-links/{batch_payment_link_id}']['get']['parameters'], paths['/finops/v1/internal/batch-payment-links/{batch_payment_link_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/batch-payment-links/{batch_payment_link_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/batch-payment-links/{batch_payment_link_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Get Currencies */ getInternalCurrencies: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/internal/currencies'; security: ['HTTPBearer']; }, paths['/finops/v1/internal/currencies']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/internal/currencies']['get']['parameters'], paths['/finops/v1/internal/currencies']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/currencies']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/currencies']['get']['responses']['500']['content']['application/json']>; /** @summary Authorize Payment Link */ postInternalPaymentIntentsIdAuthorize: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/internal/payment-intents/{payment_intent_id}/authorize'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize']['post']['parameters'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize']['post']['responses']['500']['content']['application/json']>; /** @summary Authorize Payment Link Embedded */ postInternalPaymentIntentsIdAuthorizeEmbedded: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded']['post']['parameters'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded']['post']['responses']['500']['content']['application/json']>; /** @summary Get Consent Data */ getInternalPaymentIntentsIdAuthorizeEmbeddedId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}']['get']['parameters'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Authorize Payment Link Embedded Set Sca Code */ postInternalPaymentIntentsIdAuthorizeEmbeddedIdSetScaCode: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-code'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-code']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-code']['post']['parameters'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-code']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-code']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-code']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-code']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-code']['post']['responses']['500']['content']['application/json']>; /** @summary Authorize Payment Link Embedded Set Sca Method */ postInternalPaymentIntentsIdAuthorizeEmbeddedIdSetScaMethod: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-method'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-method']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-method']['post']['parameters'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-method']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-method']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-method']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/authorize-embedded/{consent_id}/set-sca-method']['post']['responses']['500']['content']['application/json']>; /** @summary Get Banks For Payment Intent */ getInternalPaymentIntentsIdBanks: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/internal/payment-intents/{payment_intent_id}/banks'; security: ['HTTPBearer']; }, paths['/finops/v1/internal/payment-intents/{payment_intent_id}/banks']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/banks']['get']['parameters'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/banks']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/banks']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/banks']['get']['responses']['500']['content']['application/json']>; /** @summary Confirm Payment */ postInternalPaymentIntentsIdConfirmPayment: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/internal/payment-intents/{payment_intent_id}/confirm-payment'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/confirm-payment']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/confirm-payment']['post']['parameters'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/confirm-payment']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/confirm-payment']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/confirm-payment']['post']['responses']['500']['content']['application/json']>; /** @summary Confirm Tesouro Payment */ postInternalPaymentIntentsIdConfirmTesouro: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/internal/payment-intents/{payment_intent_id}/confirm-tesouro'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/internal/payment-intents/{payment_intent_id}/confirm-tesouro']['post']['parameters'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/confirm-tesouro']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/confirm-tesouro']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/confirm-tesouro']['post']['responses']['500']['content']['application/json']>; /** @summary Create Yapily Payment */ postInternalPaymentIntentsIdPayments: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/internal/payment-intents/{payment_intent_id}/payments'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/payments']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/payments']['post']['parameters'], paths['/finops/v1/internal/payment-intents/{payment_intent_id}/payments']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/payments']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/payment-intents/{payment_intent_id}/payments']['post']['responses']['500']['content']['application/json']>; /** @summary Get Payment Link */ getInternalPaymentLinksId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/internal/payment-links/{payment_link_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/internal/payment-links/{payment_link_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/internal/payment-links/{payment_link_id}']['get']['parameters'], paths['/finops/v1/internal/payment-links/{payment_link_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/payment-links/{payment_link_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/payment-links/{payment_link_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Regenerate Payment Link */ postInternalPaymentLinksIdRegenerate: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/internal/payment-links/{payment_link_id}/regenerate'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/internal/payment-links/{payment_link_id}/regenerate']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/internal/payment-links/{payment_link_id}/regenerate']['post']['parameters'], paths['/finops/v1/internal/payment-links/{payment_link_id}/regenerate']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/payment-links/{payment_link_id}/regenerate']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/payment-links/{payment_link_id}/regenerate']['post']['responses']['500']['content']['application/json']>; /** @summary Get partner payment page theme settings for frontend */ getInternalPaymentPageTheme: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/internal/payment-page-theme'; security: ['HTTPBearer']; }, paths['/finops/v1/internal/payment-page-theme']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/internal/payment-page-theme']['get']['parameters'], paths['/finops/v1/internal/payment-page-theme']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/internal/payment-page-theme']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/internal/payment-page-theme']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/internal/payment-page-theme']['get']['responses']['500']['content']['application/json']>; /** * @summary Get ledger accounts * @description Get all ledger accounts */ getLedgerAccounts: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/ledger-accounts'; security: ['HTTPBearer']; }, paths['/finops/v1/ledger-accounts']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/ledger-accounts']['get']['parameters'], paths['/finops/v1/ledger-accounts']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/ledger-accounts']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/ledger-accounts']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/ledger-accounts']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/ledger-accounts']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/ledger-accounts']['get']['responses']['500']['content']['application/json']>; /** * @summary Create a new ledger account * @description Create a new ledger account */ postLedgerAccounts: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/ledger-accounts'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/ledger-accounts']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/ledger-accounts']['post']['parameters'], paths['/finops/v1/ledger-accounts']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/ledger-accounts']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/ledger-accounts']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/ledger-accounts']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/ledger-accounts']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/ledger-accounts']['post']['responses']['500']['content']['application/json']>; /** * @summary Get a ledger account by ID * @description Get ledger account by id */ getLedgerAccountsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/ledger-accounts/{ledger_account_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/ledger-accounts/{ledger_account_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/ledger-accounts/{ledger_account_id}']['get']['parameters'], paths['/finops/v1/ledger-accounts/{ledger_account_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update a ledger account * @description Update an existing ledger account */ patchLedgerAccountsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/ledger-accounts/{ledger_account_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/ledger-accounts/{ledger_account_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/ledger-accounts/{ledger_account_id}']['patch']['parameters'], paths['/finops/v1/ledger-accounts/{ledger_account_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['patch']['responses']['409']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Delete a ledger account * @description Delete a ledger account */ deleteLedgerAccountsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/ledger-accounts/{ledger_account_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/ledger-accounts/{ledger_account_id}']['delete']['parameters'], paths['/finops/v1/ledger-accounts/{ledger_account_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['delete']['responses']['409']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/ledger-accounts/{ledger_account_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Get All With Filters * @description Get all custom templates */ getMailTemplates: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/mail-templates'; security: ['HTTPBearer']; }, paths['/finops/v1/mail-templates']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/mail-templates']['get']['parameters'], paths['/finops/v1/mail-templates']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/mail-templates']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/mail-templates']['get']['responses']['500']['content']['application/json']>; /** * @summary Create * @description Create custom template */ postMailTemplates: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/mail-templates'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/mail-templates']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/mail-templates']['post']['parameters'], paths['/finops/v1/mail-templates']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/mail-templates']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/mail-templates']['post']['responses']['500']['content']['application/json']>; /** * @summary Preview * @description Preview rendered template */ postMailTemplatesPreview: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/mail-templates/preview'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/mail-templates/preview']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/mail-templates/preview']['post']['parameters'], paths['/finops/v1/mail-templates/preview']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/mail-templates/preview']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/mail-templates/preview']['post']['responses']['500']['content']['application/json']>; /** * @summary Get All System Templates * @description Get all system templates */ getMailTemplatesSystem: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/mail-templates/system'; security: ['HTTPBearer']; }, paths['/finops/v1/mail-templates/system']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/mail-templates/system']['get']['parameters'], paths['/finops/v1/mail-templates/system']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/mail-templates/system']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/mail-templates/system']['get']['responses']['500']['content']['application/json']>; /** * @summary Get * @description Get custom template by ID */ getMailTemplatesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/mail-templates/{template_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/mail-templates/{template_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/mail-templates/{template_id}']['get']['parameters'], paths['/finops/v1/mail-templates/{template_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/mail-templates/{template_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/mail-templates/{template_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update * @description Update custom template by ID */ patchMailTemplatesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/mail-templates/{template_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/mail-templates/{template_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/mail-templates/{template_id}']['patch']['parameters'], paths['/finops/v1/mail-templates/{template_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/mail-templates/{template_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/mail-templates/{template_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Delete * @description Delete custom template bt ID */ deleteMailTemplatesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/mail-templates/{template_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/mail-templates/{template_id}']['delete']['parameters'], paths['/finops/v1/mail-templates/{template_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/mail-templates/{template_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/mail-templates/{template_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Make Default * @description Make template default */ postMailTemplatesIdMakeDefault: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/mail-templates/{template_id}/make-default'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/mail-templates/{template_id}/make-default']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/mail-templates/{template_id}/make-default']['post']['parameters'], paths['/finops/v1/mail-templates/{template_id}/make-default']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/mail-templates/{template_id}/make-default']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/mail-templates/{template_id}/make-default']['post']['responses']['500']['content']['application/json']>; /** * @summary Get mailbox domains * @description Get all domains owned by partner_id */ getMailboxDomains: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/mailbox-domains'; security: ['HTTPBearer']; }, paths['/finops/v1/mailbox-domains']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/mailbox-domains']['get']['parameters'], paths['/finops/v1/mailbox-domains']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/mailbox-domains']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/mailbox-domains']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/mailbox-domains']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/mailbox-domains']['get']['responses']['500']['content']['application/json']>; /** * @summary Create a mailbox domain * @description Create domain for the partner_id */ postMailboxDomains: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/mailbox-domains'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/mailbox-domains']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/mailbox-domains']['post']['parameters'], paths['/finops/v1/mailbox-domains']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/mailbox-domains']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/mailbox-domains']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/mailbox-domains']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/mailbox-domains']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/mailbox-domains']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/mailbox-domains']['post']['responses']['500']['content']['application/json']>; /** * @summary Delete a mailbox domain * @description Delete domain for the partner_id */ deleteMailboxDomainsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/mailbox-domains/{domain_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/mailbox-domains/{domain_id}']['delete']['parameters'], paths['/finops/v1/mailbox-domains/{domain_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/mailbox-domains/{domain_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/mailbox-domains/{domain_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/mailbox-domains/{domain_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/mailbox-domains/{domain_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/mailbox-domains/{domain_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Verify a mailbox domain * @description Verify domain for the partner_id */ postMailboxDomainsIdVerify: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/mailbox-domains/{domain_id}/verify'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/mailbox-domains/{domain_id}/verify']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/mailbox-domains/{domain_id}/verify']['post']['parameters'], paths['/finops/v1/mailbox-domains/{domain_id}/verify']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/mailbox-domains/{domain_id}/verify']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/mailbox-domains/{domain_id}/verify']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/mailbox-domains/{domain_id}/verify']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/mailbox-domains/{domain_id}/verify']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/mailbox-domains/{domain_id}/verify']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/mailbox-domains/{domain_id}/verify']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/mailbox-domains/{domain_id}/verify']['post']['responses']['500']['content']['application/json']>; /** * @summary Get mailboxes * @description Get all mailboxes owned by Entity */ getMailboxes: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/mailboxes'; security: ['HTTPBearer']; }, paths['/finops/v1/mailboxes']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/mailboxes']['get']['parameters'], paths['/finops/v1/mailboxes']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/mailboxes']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/mailboxes']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/mailboxes']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/mailboxes']['get']['responses']['500']['content']['application/json']>; /** * @summary Create a mailbox * @description Create a new mailbox */ postMailboxes: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/mailboxes'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/mailboxes']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/mailboxes']['post']['parameters'], paths['/finops/v1/mailboxes']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/mailboxes']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/mailboxes']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/mailboxes']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/mailboxes']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/mailboxes']['post']['responses']['500']['content']['application/json']>; /** * @summary Get mailboxes by IDs * @description Get all mailboxes owned by Entity */ postMailboxesSearch: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/mailboxes/search'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/mailboxes/search']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/mailboxes/search']['post']['parameters'], paths['/finops/v1/mailboxes/search']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/mailboxes/search']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/mailboxes/search']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/mailboxes/search']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/mailboxes/search']['post']['responses']['500']['content']['application/json']>; /** * @summary Delete a mailbox * @description Delete mailbox */ deleteMailboxesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/mailboxes/{mailbox_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/mailboxes/{mailbox_id}']['delete']['parameters'], paths['/finops/v1/mailboxes/{mailbox_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/mailboxes/{mailbox_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/mailboxes/{mailbox_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/mailboxes/{mailbox_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/mailboxes/{mailbox_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/mailboxes/{mailbox_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get measure units */ getMeasureUnits: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/measure-units'; security: ['HTTPBearer']; }, paths['/finops/v1/measure-units']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/measure-units']['get']['parameters'], paths['/finops/v1/measure-units']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/measure-units']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/measure-units']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/measure-units']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/measure-units']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/measure-units']['get']['responses']['500']['content']['application/json']>; /** @summary Create a measure unit */ postMeasureUnits: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/measure-units'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/measure-units']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/measure-units']['post']['parameters'], paths['/finops/v1/measure-units']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/measure-units']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/measure-units']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/measure-units']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/measure-units']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/measure-units']['post']['responses']['500']['content']['application/json']>; /** @summary Get a measure unit by ID */ getMeasureUnitsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/measure-units/{unit_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/measure-units/{unit_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/measure-units/{unit_id}']['get']['parameters'], paths['/finops/v1/measure-units/{unit_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a measure unit */ patchMeasureUnitsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/measure-units/{unit_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/measure-units/{unit_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/measure-units/{unit_id}']['patch']['parameters'], paths['/finops/v1/measure-units/{unit_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a measure unit */ deleteMeasureUnitsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/measure-units/{unit_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/measure-units/{unit_id}']['delete']['parameters'], paths['/finops/v1/measure-units/{unit_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/measure-units/{unit_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get OCR tasks */ getOcrTasks: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/ocr-tasks'; security: ['HTTPBearer']; }, paths['/finops/v1/ocr-tasks']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/ocr-tasks']['get']['parameters'], paths['/finops/v1/ocr-tasks']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/ocr-tasks']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/ocr-tasks']['get']['responses']['500']['content']['application/json']>; /** @summary OCR a file from URL */ postOcrTasks: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/ocr-tasks'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/ocr-tasks']['post']['responses']['202']['content']['application/json'], paths['/finops/v1/ocr-tasks']['post']['parameters'], paths['/finops/v1/ocr-tasks']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/ocr-tasks']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/ocr-tasks']['post']['responses']['500']['content']['application/json']>; /** @summary Upload a file for OCR */ postOcrTasksUploadFromFile: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/ocr-tasks/upload-from-file'; mediaType: 'multipart/form-data'; security: ['HTTPBearer']; }, NonNullable['content']['multipart/form-data'], paths['/finops/v1/ocr-tasks/upload-from-file']['post']['responses']['202']['content']['application/json'], paths['/finops/v1/ocr-tasks/upload-from-file']['post']['parameters'], paths['/finops/v1/ocr-tasks/upload-from-file']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/ocr-tasks/upload-from-file']['post']['responses']['500']['content']['application/json']>; /** @summary Get an OCR task by ID */ getOcrTasksId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/ocr-tasks/{task_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/ocr-tasks/{task_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/ocr-tasks/{task_id}']['get']['parameters'], paths['/finops/v1/ocr-tasks/{task_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/ocr-tasks/{task_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/ocr-tasks/{task_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Get overdue reminder configurations */ getOverdueReminders: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/overdue-reminders'; security: ['HTTPBearer']; }, paths['/finops/v1/overdue-reminders']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/overdue-reminders']['get']['parameters'], paths['/finops/v1/overdue-reminders']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/overdue-reminders']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/overdue-reminders']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/overdue-reminders']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/overdue-reminders']['get']['responses']['500']['content']['application/json']>; /** @summary Create an overdue reminder configuration */ postOverdueReminders: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/overdue-reminders'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/overdue-reminders']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/overdue-reminders']['post']['parameters'], paths['/finops/v1/overdue-reminders']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/overdue-reminders']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/overdue-reminders']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/overdue-reminders']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/overdue-reminders']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/overdue-reminders']['post']['responses']['500']['content']['application/json']>; /** @summary Get an overdue reminder configuration by ID */ getOverdueRemindersId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/overdue-reminders/{overdue_reminder_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['get']['parameters'], paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update an overdue reminder configuration */ patchOverdueRemindersId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/overdue-reminders/{overdue_reminder_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['patch']['parameters'], paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete an overdue reminder configuration */ deleteOverdueRemindersId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/overdue-reminders/{overdue_reminder_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['delete']['parameters'], paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/overdue-reminders/{overdue_reminder_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get credit notes */ getPayableCreditNotes: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payable-credit-notes'; security: ['HTTPBearer']; }, paths['/finops/v1/payable-credit-notes']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes']['get']['parameters'], paths['/finops/v1/payable-credit-notes']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-credit-notes']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/payable-credit-notes']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes']['get']['responses']['500']['content']['application/json']>; /** @summary Create a credit note */ postPayableCreditNotes: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payable-credit-notes'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payable-credit-notes']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/payable-credit-notes']['post']['parameters'], paths['/finops/v1/payable-credit-notes']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-credit-notes']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes']['post']['responses']['500']['content']['application/json']>; /** * @summary Upload a credit note from a file * @description Upload an incoming credit note (payable) in PDF, PNG, or JPEG format and scan its contents. The maximum file size is 20MB. */ postPayableCreditNotesUploadFromFile: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payable-credit-notes/upload-from-file'; mediaType: 'multipart/form-data'; security: ['HTTPBearer']; }, NonNullable['content']['multipart/form-data'], paths['/finops/v1/payable-credit-notes/upload-from-file']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/payable-credit-notes/upload-from-file']['post']['parameters'], paths['/finops/v1/payable-credit-notes/upload-from-file']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/upload-from-file']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/upload-from-file']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/upload-from-file']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/upload-from-file']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/upload-from-file']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/upload-from-file']['post']['responses']['500']['content']['application/json']>; /** * @summary Get credit note validations * @description Get credit notes validations. */ getPayableCreditNotesValidations: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payable-credit-notes/validations'; security: ['HTTPBearer']; }, paths['/finops/v1/payable-credit-notes/validations']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/validations']['get']['parameters'], paths['/finops/v1/payable-credit-notes/validations']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations']['get']['responses']['500']['content']['application/json']>; /** * @summary Update credit note validations * @description Update credit notes validations. */ putPayableCreditNotesValidations: ServiceOperationMutation<{ method: 'put'; url: '/finops/v1/payable-credit-notes/validations'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payable-credit-notes/validations']['put']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/validations']['put']['parameters'], paths['/finops/v1/payable-credit-notes/validations']['put']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations']['put']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations']['put']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations']['put']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations']['put']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations']['put']['responses']['500']['content']['application/json']>; /** * @summary Reset credit note validations * @description Reset credit notes validations. */ postPayableCreditNotesValidationsReset: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payable-credit-notes/validations/reset'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payable-credit-notes/validations/reset']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/validations/reset']['post']['parameters'], paths['/finops/v1/payable-credit-notes/validations/reset']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations/reset']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations/reset']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations/reset']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations/reset']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/validations/reset']['post']['responses']['500']['content']['application/json']>; /** @summary Get a credit note by ID */ getPayableCreditNotesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payable-credit-notes/{credit_note_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/payable-credit-notes/{credit_note_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}']['get']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a credit note */ patchPayableCreditNotesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/payable-credit-notes/{credit_note_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}']['patch']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a credit note */ deletePayableCreditNotesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/payable-credit-notes/{credit_note_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/payable-credit-notes/{credit_note_id}']['delete']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['delete']['responses']['409']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Approve a credit note * @description Approve the credit note for appliance. */ postPayableCreditNotesIdApprove: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payable-credit-notes/{credit_note_id}/approve'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payable-credit-notes/{credit_note_id}/approve']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/approve']['post']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/approve']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/approve']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/approve']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/approve']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/approve']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/approve']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/approve']['post']['responses']['500']['content']['application/json']>; /** * @summary Cancel a credit note * @description Cancel the credit note that was not confirmed during the review. */ postPayableCreditNotesIdCancel: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payable-credit-notes/{credit_note_id}/cancel'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel']['post']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel']['post']['responses']['500']['content']['application/json']>; /** * @summary Cancel OCR of a credit note * @description Request to cancel the OCR processing of the specified credit note. */ postPayableCreditNotesIdCancelOcr: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payable-credit-notes/{credit_note_id}/cancel-ocr'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel-ocr']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel-ocr']['post']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel-ocr']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel-ocr']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel-ocr']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel-ocr']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel-ocr']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel-ocr']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel-ocr']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/cancel-ocr']['post']['responses']['500']['content']['application/json']>; /** @summary Get all line items of a credit note */ getPayableCreditNotesIdLineItems: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payable-credit-notes/{credit_note_id}/line-items'; security: ['HTTPBearer']; }, paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['get']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['get']['responses']['500']['content']['application/json']>; /** @summary Add a new line item to a credit note */ postPayableCreditNotesIdLineItems: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payable-credit-notes/{credit_note_id}/line-items'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['post']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['post']['responses']['500']['content']['application/json']>; /** @summary Replace all line items of a credit note */ putPayableCreditNotesIdLineItems: ServiceOperationMutation<{ method: 'put'; url: '/finops/v1/payable-credit-notes/{credit_note_id}/line-items'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['put']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['put']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['put']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['put']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['put']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['put']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['put']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items']['put']['responses']['500']['content']['application/json']>; /** @summary Get a single line item of a credit note */ getPayableCreditNotesIdLineItemsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['get']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a line item of a credit note */ patchPayableCreditNotesIdLineItemsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['patch']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a line item from a credit note */ deletePayableCreditNotesIdLineItemsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['delete']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['delete']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/line-items/{line_item_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Reject a credit note * @description Decline the credit note when an approver finds any mismatch or discrepancies. */ postPayableCreditNotesIdReject: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payable-credit-notes/{credit_note_id}/reject'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payable-credit-notes/{credit_note_id}/reject']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/reject']['post']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/reject']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/reject']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/reject']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/reject']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/reject']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/reject']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/reject']['post']['responses']['500']['content']['application/json']>; /** * @summary Submit a credit note for approval * @description Start the approval process once the uploaded credit note is validated. */ postPayableCreditNotesIdSubmitForApproval: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payable-credit-notes/{credit_note_id}/submit-for-approval'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payable-credit-notes/{credit_note_id}/submit-for-approval']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/submit-for-approval']['post']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/submit-for-approval']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/submit-for-approval']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/submit-for-approval']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/submit-for-approval']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/submit-for-approval']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/submit-for-approval']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/submit-for-approval']['post']['responses']['500']['content']['application/json']>; /** @summary Validate a credit note */ getPayableCreditNotesIdValidate: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payable-credit-notes/{credit_note_id}/validate'; security: ['HTTPBearer']; }, paths['/finops/v1/payable-credit-notes/{credit_note_id}/validate']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/validate']['get']['parameters'], paths['/finops/v1/payable-credit-notes/{credit_note_id}/validate']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/validate']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/validate']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/validate']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/validate']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-credit-notes/{credit_note_id}/validate']['get']['responses']['500']['content']['application/json']>; /** @summary Get purchase orders */ getPayablePurchaseOrders: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payable-purchase-orders'; security: ['HTTPBearer']; }, paths['/finops/v1/payable-purchase-orders']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-purchase-orders']['get']['parameters'], paths['/finops/v1/payable-purchase-orders']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders']['get']['responses']['500']['content']['application/json']>; /** @summary Create a purchase order */ postPayablePurchaseOrders: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payable-purchase-orders'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payable-purchase-orders']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/payable-purchase-orders']['post']['parameters'], paths['/finops/v1/payable-purchase-orders']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders']['post']['responses']['500']['content']['application/json']>; /** * @summary Get the available variables for purchase orders * @description Get a list of placeholders allowed to insert into an email template for customization */ getPayablePurchaseOrdersVariables: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payable-purchase-orders/variables'; security: ['HTTPBearer']; }, paths['/finops/v1/payable-purchase-orders/variables']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-purchase-orders/variables']['get']['parameters'], paths['/finops/v1/payable-purchase-orders/variables']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/variables']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/variables']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/variables']['get']['responses']['500']['content']['application/json']>; /** @summary Get a purchase order by ID */ getPayablePurchaseOrdersId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payable-purchase-orders/{purchase_order_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['get']['parameters'], paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a purchase order */ patchPayablePurchaseOrdersId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/payable-purchase-orders/{purchase_order_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['patch']['parameters'], paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a purchase order */ deletePayablePurchaseOrdersId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/payable-purchase-orders/{purchase_order_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['delete']['parameters'], paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Preview a purchase order's email message */ postPayablePurchaseOrdersIdPreview: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payable-purchase-orders/{purchase_order_id}/preview'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/preview']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/preview']['post']['parameters'], paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/preview']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/preview']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/preview']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/preview']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/preview']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/preview']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/preview']['post']['responses']['500']['content']['application/json']>; /** @summary Send a purchase order via email */ postPayablePurchaseOrdersIdSend: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payable-purchase-orders/{purchase_order_id}/send'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/send']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/send']['post']['parameters'], paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/send']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/send']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/send']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/send']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/send']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/send']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/send']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payable-purchase-orders/{purchase_order_id}/send']['post']['responses']['500']['content']['application/json']>; /** * @summary Get payables * @description Lists all payables from the connected entity. * * If you already have the data of the payable (amount in [minor units]( * https://docs.monite.com/references/currencies#minor-units), currency, vendor information, and other details) * stored somewhere as individual attributes, you can create a payable with these attributes by calling [POST * /payables](https://docs.monite.com/api/payables/post-payables) and providing the [base64-encoded]( * https://en.wikipedia.org/wiki/Base64) contents of the original invoice file in the field `base64_encoded_file`. * * A payable is a financial document given by an entity`s supplier itemizing the purchase of a good or a service and * demanding payment. * * The `file_name` field is optional. If omitted, it defaults to “default_file_name”. If the settings are configured * to automatically set `suggested_payment_term`, this object can be omitted from the request body. * * The `id` generated for this payable can be used in other API calls to update the data of this payable or trigger [ * status transitions](https://docs.monite.com/accounts-payable/approvals/manual-transition), for example. essential data * fields to move from `draft` to `new` * * Related guide: [Create a payable from data](https://docs.monite.com/accounts-payable/payables/collect#create-a-payable-from-data) * * See also: * * * [Automatic calculation of due date](https://docs.monite.com/accounts-payable/payables/collect#automatic-calculation-of-due-date) * * [Suggested payment date](https://docs.monite.com/accounts-payable/payables/collect#suggested-payment-date) * * [Attach file](https://docs.monite.com/accounts-payable/payables/collect#attach-file) * * [Collect payables by email](https://docs.monite.com/accounts-payable/payables/collect#send-payables-by-email) * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) */ getPayables: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payables'; security: ['HTTPBearer']; }, paths['/finops/v1/payables']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payables']['get']['parameters'], paths['/finops/v1/payables']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/payables']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables']['get']['responses']['500']['content']['application/json']>; /** * @summary Create a payable * @description Add a new payable by providing the amount, currency, vendor name, and other details. * You can provide the base64_encoded contents of the original invoice file in the field `base64_encoded_file`. * * You can use this endpoint to bypass the Monite OCR service and provide the data directly * (for example, if you already have the data in place). * * A newly created payable has the the `draft` [status](https://docs.monite.com/accounts-payable/payables/index). */ postPayables: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payables']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payables']['post']['parameters'], paths['/finops/v1/payables']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables']['post']['responses']['500']['content']['application/json']>; /** * @deprecated * @summary Get payables analytics * @description Retrieve aggregated statistics for payables, including total amount and count, both overall and by status. * * For more flexible configuration and retrieval of other data types, use `GET /analytics/payables`. */ getPayablesAnalytics: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payables/analytics'; security: ['HTTPBearer']; }, paths['/finops/v1/payables/analytics']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/analytics']['get']['parameters'], paths['/finops/v1/payables/analytics']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/analytics']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/analytics']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/analytics']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/analytics']['get']['responses']['500']['content']['application/json']>; /** * @summary Webhook to receive e-invoicing events from Storecove for new documents * @description A webhook endpoint designed to handle e-invoicing events from Storecove. It listens for events about newly received documents and validates them for further processing in a background. More information about Storecove webhooks is [here](https://www.storecove.com/docs#_receiving_documents). */ postPayablesStorecove: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/storecove'; mediaType: 'application/json'; security: ['HTTPBasic']; }, NonNullable['content']['application/json'], paths['/finops/v1/payables/storecove']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/storecove']['post']['parameters'], paths['/finops/v1/payables/storecove']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/storecove']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/storecove']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/storecove']['post']['responses']['500']['content']['application/json']>; /** * @summary Upload a payable from a file * @description Upload an incoming invoice (payable) in PDF, PNG, or JPEG format and scan its contents. The maximum file size is 20MB. */ postPayablesUploadFromFile: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/upload-from-file'; mediaType: 'multipart/form-data'; security: ['HTTPBearer']; }, NonNullable['content']['multipart/form-data'], paths['/finops/v1/payables/upload-from-file']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/payables/upload-from-file']['post']['parameters'], paths['/finops/v1/payables/upload-from-file']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/upload-from-file']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/upload-from-file']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/upload-from-file']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/upload-from-file']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/upload-from-file']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/upload-from-file']['post']['responses']['500']['content']['application/json']>; /** * @summary Get payables validations * @description Get payable validations. */ getPayablesValidations: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payables/validations'; security: ['HTTPBearer']; }, paths['/finops/v1/payables/validations']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/validations']['get']['parameters'], paths['/finops/v1/payables/validations']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/validations']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/validations']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/validations']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/validations']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/validations']['get']['responses']['500']['content']['application/json']>; /** * @summary Update payables validations * @description Update payable validations. */ putPayablesValidations: ServiceOperationMutation<{ method: 'put'; url: '/finops/v1/payables/validations'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payables/validations']['put']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/validations']['put']['parameters'], paths['/finops/v1/payables/validations']['put']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/validations']['put']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/validations']['put']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/validations']['put']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/validations']['put']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/validations']['put']['responses']['500']['content']['application/json']>; /** * @summary Reset payables validations * @description Reset payable validations to default ones. */ postPayablesValidationsReset: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/validations/reset'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payables/validations/reset']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/validations/reset']['post']['parameters'], paths['/finops/v1/payables/validations/reset']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/validations/reset']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/validations/reset']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/validations/reset']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/validations/reset']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/validations/reset']['post']['responses']['500']['content']['application/json']>; /** * @summary Get the available variables for payable email templates * @description Get a list of placeholders allowed to insert into an email template for customization */ getPayablesVariables: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payables/variables'; security: ['HTTPBearer']; }, paths['/finops/v1/payables/variables']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/variables']['get']['parameters'], paths['/finops/v1/payables/variables']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/variables']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/variables']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/variables']['get']['responses']['500']['content']['application/json']>; /** * @summary Get a payable by ID * @description Retrieves information about a specific payable with the given ID. */ getPayablesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payables/{payable_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/payables/{payable_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}']['get']['parameters'], paths['/finops/v1/payables/{payable_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update a payable * @description Updates the information about a specific payable. */ patchPayablesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/payables/{payable_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payables/{payable_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}']['patch']['parameters'], paths['/finops/v1/payables/{payable_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['patch']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Delete a payable * @description Deletes a specific payable. */ deletePayablesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/payables/{payable_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/payables/{payable_id}']['delete']['parameters'], paths['/finops/v1/payables/{payable_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['delete']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Approve a payable for payment * @description Confirms that the payable is ready to be paid. */ postPayablesIdApprovePaymentOperation: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/{payable_id}/approve-payment-operation'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payables/{payable_id}/approve-payment-operation']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/approve-payment-operation']['post']['parameters'], paths['/finops/v1/payables/{payable_id}/approve-payment-operation']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/approve-payment-operation']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/approve-payment-operation']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/approve-payment-operation']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/approve-payment-operation']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/approve-payment-operation']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/approve-payment-operation']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/approve-payment-operation']['post']['responses']['500']['content']['application/json']>; /** * @summary Attach a file to a payable * @description Attach file to payable without existing attachment. */ postPayablesIdAttachFile: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/{payable_id}/attach-file'; mediaType: 'multipart/form-data'; security: ['HTTPBearer']; }, NonNullable['content']['multipart/form-data'], paths['/finops/v1/payables/{payable_id}/attach-file']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/attach-file']['post']['parameters'], paths['/finops/v1/payables/{payable_id}/attach-file']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/attach-file']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/attach-file']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/attach-file']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/attach-file']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/attach-file']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/attach-file']['post']['responses']['500']['content']['application/json']>; /** * @summary Cancel a payable * @description Cancels the payable that was not confirmed during the review. */ postPayablesIdCancel: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/{payable_id}/cancel'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payables/{payable_id}/cancel']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/cancel']['post']['parameters'], paths['/finops/v1/payables/{payable_id}/cancel']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel']['post']['responses']['500']['content']['application/json']>; /** * @summary Cancel OCR of a payable * @description Request to cancel the OCR processing of the specified payable. */ postPayablesIdCancelOcr: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/{payable_id}/cancel-ocr'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payables/{payable_id}/cancel-ocr']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/cancel-ocr']['post']['parameters'], paths['/finops/v1/payables/{payable_id}/cancel-ocr']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel-ocr']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel-ocr']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel-ocr']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel-ocr']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel-ocr']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel-ocr']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/cancel-ocr']['post']['responses']['500']['content']['application/json']>; /** @summary Returns the history of the specified accounts payable document. */ getPayablesIdHistory: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payables/{payable_id}/history'; security: ['HTTPBearer']; }, paths['/finops/v1/payables/{payable_id}/history']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/history']['get']['parameters'], paths['/finops/v1/payables/{payable_id}/history']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/history']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/history']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/history']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/history']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/history']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/history']['get']['responses']['500']['content']['application/json']>; /** * @summary Get the line items of a payable * @description Get a list of all line items related to a specific payable. * Related guide: [List all payable line items](https://docs.monite.com/accounts-payable/payables/line-items#list-all-line-items-of-a-payable) * * See also: * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) * * [Collect payables](https://docs.monite.com/accounts-payable/payables/collect) */ getPayablesIdLineItems: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payables/{payable_id}/line-items'; security: ['HTTPBearer']; }, paths['/finops/v1/payables/{payable_id}/line-items']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/line-items']['get']['parameters'], paths['/finops/v1/payables/{payable_id}/line-items']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['get']['responses']['500']['content']['application/json']>; /** * @summary Add a line item to a payable * @description Add a new line item to a specific payable. * * The `subtotal` and `total` fields of line items are automatically calculated based on the `unit_price`, * `quantity`, and `tax` fields, therefore, are read-only and appear only in the response schema. The field * `ledger_account_id` is required **only** for account integration, otherwise, it is optional. * * Related guide: [Add line items to a payable](https://docs.monite.com/accounts-payable/payables/line-items#add-line-items-to-a-payable) * * See also: * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) * * [Collect payables](https://docs.monite.com/accounts-payable/payables/collect) */ postPayablesIdLineItems: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/{payable_id}/line-items'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payables/{payable_id}/line-items']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/line-items']['post']['parameters'], paths['/finops/v1/payables/{payable_id}/line-items']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['post']['responses']['406']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['post']['responses']['500']['content']['application/json']>; /** * @summary Replaces the lines items in a payable * @description Replaces the information of all line items of a specific payable. * * Related guide: [Replace all line items](https://docs.monite.com/accounts-payable/payables/line-items#replace-all-line-items) * * See also: * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) * * [Collect payables](https://docs.monite.com/accounts-payable/payables/collect) */ putPayablesIdLineItems: ServiceOperationMutation<{ method: 'put'; url: '/finops/v1/payables/{payable_id}/line-items'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payables/{payable_id}/line-items']['put']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/line-items']['put']['parameters'], paths['/finops/v1/payables/{payable_id}/line-items']['put']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['put']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['put']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['put']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['put']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['put']['responses']['406']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['put']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['put']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items']['put']['responses']['500']['content']['application/json']>; /** * @summary Get a single line item of a payable * @description Get information about a specific line item with a given ID. * * Related guide: [Retrieve a line item](https://docs.monite.com/accounts-payable/payables/line-items#retrieve-a-line-item) * * See also: * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) * * [Collect payables](https://docs.monite.com/accounts-payable/payables/collect) */ getPayablesIdLineItemsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payables/{payable_id}/line-items/{line_item_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['get']['parameters'], paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update a line item in a payable * @description Edits the information of a specific line item. * * Related guide: [Update a line item](https://docs.monite.com/accounts-payable/payables/line-items#update-a-line-item) * * See also: * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) * * [Collect payables](https://docs.monite.com/accounts-payable/payables/collect) */ patchPayablesIdLineItemsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/payables/{payable_id}/line-items/{line_item_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['patch']['parameters'], paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['patch']['responses']['406']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Delete a line item from a payable * @description Delete the line item with the given ID. * * Related guide: [Remove a line item](https://docs.monite.com/accounts-payable/payables/line-items#remove-a-line-item) * * See also: * * [Manage line items](https://docs.monite.com/accounts-payable/payables/line-items) * * [Collect payables](https://docs.monite.com/accounts-payable/payables/collect) */ deletePayablesIdLineItemsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/payables/{payable_id}/line-items/{line_item_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['delete']['parameters'], paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['delete']['responses']['406']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/line-items/{line_item_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Mark a payable as paid * @description Mark a payable as paid. * * Payables can be paid using the payment channels offered by Monite or through external payment channels. In the latter * case, the invoice is not automatically marked as paid in the system and needs to be converted to the paid status * manually. * * Optionally, it is possible to pass the `comment` field in the request body, to describe how and when the invoice was * paid. * * Notes: * - To use this endpoint with an entity user token, this entity user must have a role that includes the `pay` permission * for payables. * - The `amount_to_pay` field is automatically calculated based on the `amount_due` less the percentage described * in the `payment_terms.discount` value. * * Related guide: [Mark a payable as paid](https://docs.monite.com/accounts-payable/approvals/manual-transition#mark-as-paid) * * See also: * * [Payables lifecycle](https://docs.monite.com/accounts-payable/payables/index) * * [Payables status transitions](https://docs.monite.com/accounts-payable/payables/collect#suggested-payment-date) */ postPayablesIdMarkAsPaid: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/{payable_id}/mark-as-paid'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payables/{payable_id}/mark-as-paid']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/mark-as-paid']['post']['parameters'], paths['/finops/v1/payables/{payable_id}/mark-as-paid']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-paid']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-paid']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-paid']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-paid']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-paid']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-paid']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-paid']['post']['responses']['500']['content']['application/json']>; /** * @summary Mark a payable as partially paid * @description Mark a payable as partially paid. * * If the payable is partially paid, its status is moved to `partially_paid`. The value of the `amount_paid` field must be * the sum of all payments made, not only the last one. * * Notes: * - This endpoint can be used for payables in the `waiting_to_be_paid` status. * - The `amount_paid` must be greater than 0 and less than the total payable amount specified by the `amount` field. * - You can use this endpoint multiple times for the same payable to reflect multiple partial payments, always setting the * sum of all payments made. * - To use this endpoint with an entity user token, this entity user must have a role that includes the `pay` * permission for payables. * - The `amount_to_pay` field is automatically calculated based on the `amount_due` less the percentage described * in the `payment_terms.discount` value. * * Related guide: [Mark a payable as partially paid](https://docs.monite.com/accounts-payable/approvals/manual-transition#mark-as-partially-paid) * * See also: * * [Payables lifecycle](https://docs.monite.com/accounts-payable/payables/index) * * [Payables status transitions](https://docs.monite.com/accounts-payable/payables/collect#suggested-payment-date) * * [Mark a payable as paid](https://docs.monite.com/accounts-payable/approvals/manual-transition#mark-as-paid) */ postPayablesIdMarkAsPartiallyPaid: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/{payable_id}/mark-as-partially-paid'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payables/{payable_id}/mark-as-partially-paid']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/mark-as-partially-paid']['post']['parameters'], paths['/finops/v1/payables/{payable_id}/mark-as-partially-paid']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-partially-paid']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-partially-paid']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-partially-paid']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-partially-paid']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-partially-paid']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-partially-paid']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/mark-as-partially-paid']['post']['responses']['500']['content']['application/json']>; /** * @summary Reject a payable * @description Declines the payable when an approver finds any mismatch or discrepancies. */ postPayablesIdReject: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/{payable_id}/reject'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payables/{payable_id}/reject']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/reject']['post']['parameters'], paths['/finops/v1/payables/{payable_id}/reject']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reject']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reject']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reject']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reject']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reject']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reject']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reject']['post']['responses']['500']['content']['application/json']>; /** * @summary Reopen a rejected or waiting_to_be_paid payable * @description Reset payable state from rejected or waiting_to_be_paid to new. */ postPayablesIdReopen: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/{payable_id}/reopen'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payables/{payable_id}/reopen']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/reopen']['post']['parameters'], paths['/finops/v1/payables/{payable_id}/reopen']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reopen']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reopen']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reopen']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reopen']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reopen']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reopen']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/reopen']['post']['responses']['500']['content']['application/json']>; /** * @summary Submit a payable for approval * @description Starts the approval process once the uploaded payable is validated. */ postPayablesIdSubmitForApproval: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/{payable_id}/submit-for-approval'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payables/{payable_id}/submit-for-approval']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/submit-for-approval']['post']['parameters'], paths['/finops/v1/payables/{payable_id}/submit-for-approval']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/submit-for-approval']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/submit-for-approval']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/submit-for-approval']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/submit-for-approval']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/submit-for-approval']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/submit-for-approval']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/submit-for-approval']['post']['responses']['500']['content']['application/json']>; /** * @summary Get suggestions * @description Get AI suggestions */ getPayablesIdSuggestions: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payables/{payable_id}/suggestions'; security: ['HTTPBearer']; }, paths['/finops/v1/payables/{payable_id}/suggestions']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/suggestions']['get']['parameters'], paths['/finops/v1/payables/{payable_id}/suggestions']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/suggestions']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/suggestions']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/suggestions']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/suggestions']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/suggestions']['get']['responses']['500']['content']['application/json']>; /** * @summary Delete suggestions * @description Remove AI suggestions */ deletePayablesIdSuggestions: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/payables/{payable_id}/suggestions'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payables/{payable_id}/suggestions']['delete']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/suggestions']['delete']['parameters'], paths['/finops/v1/payables/{payable_id}/suggestions']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/suggestions']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/suggestions']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/suggestions']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/suggestions']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/suggestions']['delete']['responses']['500']['content']['application/json']>; /** * @summary Validate a payable * @description Check the invoice for compliance with the requirements for movement from draft to new status. */ postPayablesIdValidate: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payables/{payable_id}/validate'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payables/{payable_id}/validate']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payables/{payable_id}/validate']['post']['parameters'], paths['/finops/v1/payables/{payable_id}/validate']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/validate']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/validate']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/validate']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/validate']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/validate']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payables/{payable_id}/validate']['post']['responses']['500']['content']['application/json']>; /** @summary Get Payment Fees */ getPaymentFees: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-fees'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-fees']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-fees']['get']['parameters'], paths['/finops/v1/payment-fees']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-fees']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-fees']['get']['responses']['500']['content']['application/json']>; /** @summary Create Payment Fee */ postPaymentFees: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payment-fees'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-fees']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/payment-fees']['post']['parameters'], paths['/finops/v1/payment-fees']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-fees']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-fees']['post']['responses']['500']['content']['application/json']>; /** @summary Get Payment Fee By Id */ getPaymentFeesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-fees/{fee_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-fees/{fee_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-fees/{fee_id}']['get']['parameters'], paths['/finops/v1/payment-fees/{fee_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-fees/{fee_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-fees/{fee_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update Payment Fee By Id */ patchPaymentFeesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/payment-fees/{fee_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-fees/{fee_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-fees/{fee_id}']['patch']['parameters'], paths['/finops/v1/payment-fees/{fee_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-fees/{fee_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-fees/{fee_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete Payment Fee By Id */ deletePaymentFeesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/payment-fees/{fee_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/payment-fees/{fee_id}']['delete']['parameters'], paths['/finops/v1/payment-fees/{fee_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-fees/{fee_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-fees/{fee_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get payment intents */ getPaymentIntents: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-intents'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-intents']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-intents']['get']['parameters'], paths['/finops/v1/payment-intents']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-intents']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-intents']['get']['responses']['500']['content']['application/json']>; /** @summary Get payment intent by ID */ getPaymentIntentsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-intents/{payment_intent_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-intents/{payment_intent_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-intents/{payment_intent_id}']['get']['parameters'], paths['/finops/v1/payment-intents/{payment_intent_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-intents/{payment_intent_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-intents/{payment_intent_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update the payment intent amount */ patchPaymentIntentsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/payment-intents/{payment_intent_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-intents/{payment_intent_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-intents/{payment_intent_id}']['patch']['parameters'], paths['/finops/v1/payment-intents/{payment_intent_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-intents/{payment_intent_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-intents/{payment_intent_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Get the payment intent history */ getPaymentIntentsIdHistory: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-intents/{payment_intent_id}/history'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-intents/{payment_intent_id}/history']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-intents/{payment_intent_id}/history']['get']['parameters'], paths['/finops/v1/payment-intents/{payment_intent_id}/history']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-intents/{payment_intent_id}/history']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-intents/{payment_intent_id}/history']['get']['responses']['500']['content']['application/json']>; /** @summary Create a payment link */ postPaymentLinks: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payment-links'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-links']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/payment-links']['post']['parameters'], paths['/finops/v1/payment-links']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-links']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-links']['post']['responses']['500']['content']['application/json']>; /** @summary Get payment link by ID */ getPaymentLinksId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-links/{payment_link_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-links/{payment_link_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-links/{payment_link_id}']['get']['parameters'], paths['/finops/v1/payment-links/{payment_link_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-links/{payment_link_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-links/{payment_link_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Expire a payment link */ postPaymentLinksIdExpire: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payment-links/{payment_link_id}/expire'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/payment-links/{payment_link_id}/expire']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-links/{payment_link_id}/expire']['post']['parameters'], paths['/finops/v1/payment-links/{payment_link_id}/expire']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-links/{payment_link_id}/expire']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-links/{payment_link_id}/expire']['post']['responses']['500']['content']['application/json']>; /** @summary Create an onboarding link */ postPaymentOnboardingLinks: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payment-onboarding-links'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-onboarding-links']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-onboarding-links']['post']['parameters'], paths['/finops/v1/payment-onboarding-links']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-onboarding-links']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-onboarding-links']['post']['responses']['500']['content']['application/json']>; /** * @summary Get a receivable by ID * @description GET /payment-pages */ getPaymentPages: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-pages'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-pages']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-pages']['get']['parameters'], paths['/finops/v1/payment-pages']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/payment-pages']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payment-pages']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payment-pages']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payment-pages']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-pages']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-pages']['get']['responses']['500']['content']['application/json']>; /** @summary Get payment records */ getPaymentRecords: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-records'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-records']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-records']['get']['parameters'], paths['/finops/v1/payment-records']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-records']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-records']['get']['responses']['500']['content']['application/json']>; /** @summary Create a payment record */ postPaymentRecords: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payment-records'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-records']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/payment-records']['post']['parameters'], paths['/finops/v1/payment-records']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-records']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-records']['post']['responses']['500']['content']['application/json']>; /** @summary Get a payment record */ getPaymentRecordsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-records/{payment_record_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-records/{payment_record_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-records/{payment_record_id}']['get']['parameters'], paths['/finops/v1/payment-records/{payment_record_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-records/{payment_record_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-records/{payment_record_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a payment record */ patchPaymentRecordsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/payment-records/{payment_record_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-records/{payment_record_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-records/{payment_record_id}']['patch']['parameters'], paths['/finops/v1/payment-records/{payment_record_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-records/{payment_record_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-records/{payment_record_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Cancel a payment record */ postPaymentRecordsIdCancel: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payment-records/{payment_record_id}/cancel'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-records/{payment_record_id}/cancel']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-records/{payment_record_id}/cancel']['post']['parameters'], paths['/finops/v1/payment-records/{payment_record_id}/cancel']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-records/{payment_record_id}/cancel']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-records/{payment_record_id}/cancel']['post']['responses']['500']['content']['application/json']>; /** @summary Mark a payment record as succeeded */ postPaymentRecordsIdMarkAsSucceeded: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payment-records/{payment_record_id}/mark-as-succeeded'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-records/{payment_record_id}/mark-as-succeeded']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-records/{payment_record_id}/mark-as-succeeded']['post']['parameters'], paths['/finops/v1/payment-records/{payment_record_id}/mark-as-succeeded']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-records/{payment_record_id}/mark-as-succeeded']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-records/{payment_record_id}/mark-as-succeeded']['post']['responses']['500']['content']['application/json']>; /** @summary Start processing a payment record */ postPaymentRecordsIdStartProcessing: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payment-records/{payment_record_id}/start-processing'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-records/{payment_record_id}/start-processing']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-records/{payment_record_id}/start-processing']['post']['parameters'], paths['/finops/v1/payment-records/{payment_record_id}/start-processing']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-records/{payment_record_id}/start-processing']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-records/{payment_record_id}/start-processing']['post']['responses']['500']['content']['application/json']>; /** @summary Get payment reminder configurations */ getPaymentReminders: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-reminders'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-reminders']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-reminders']['get']['parameters'], paths['/finops/v1/payment-reminders']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payment-reminders']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payment-reminders']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-reminders']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-reminders']['get']['responses']['500']['content']['application/json']>; /** @summary Create a payment reminder configuration */ postPaymentReminders: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payment-reminders'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-reminders']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/payment-reminders']['post']['parameters'], paths['/finops/v1/payment-reminders']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payment-reminders']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payment-reminders']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payment-reminders']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-reminders']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-reminders']['post']['responses']['500']['content']['application/json']>; /** @summary Get a payment reminder configuration by ID */ getPaymentRemindersId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-reminders/{payment_reminder_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-reminders/{payment_reminder_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-reminders/{payment_reminder_id}']['get']['parameters'], paths['/finops/v1/payment-reminders/{payment_reminder_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a payment reminder configuration */ patchPaymentRemindersId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/payment-reminders/{payment_reminder_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-reminders/{payment_reminder_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-reminders/{payment_reminder_id}']['patch']['parameters'], paths['/finops/v1/payment-reminders/{payment_reminder_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a payment reminder configuration */ deletePaymentRemindersId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/payment-reminders/{payment_reminder_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/payment-reminders/{payment_reminder_id}']['delete']['parameters'], paths['/finops/v1/payment-reminders/{payment_reminder_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-reminders/{payment_reminder_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get payment terms */ getPaymentTerms: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-terms'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-terms']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-terms']['get']['parameters'], paths['/finops/v1/payment-terms']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payment-terms']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payment-terms']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-terms']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-terms']['get']['responses']['500']['content']['application/json']>; /** @summary Create a payment term */ postPaymentTerms: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payment-terms'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-terms']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/payment-terms']['post']['parameters'], paths['/finops/v1/payment-terms']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/payment-terms']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/payment-terms']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/payment-terms']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-terms']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-terms']['post']['responses']['500']['content']['application/json']>; /** @summary Get a payment term by ID */ getPaymentTermsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-terms/{payment_terms_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-terms/{payment_terms_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-terms/{payment_terms_id}']['get']['parameters'], paths['/finops/v1/payment-terms/{payment_terms_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a payment term */ patchPaymentTermsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/payment-terms/{payment_terms_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-terms/{payment_terms_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-terms/{payment_terms_id}']['patch']['parameters'], paths['/finops/v1/payment-terms/{payment_terms_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a payment term */ deletePaymentTermsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/payment-terms/{payment_terms_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/payment-terms/{payment_terms_id}']['delete']['parameters'], paths['/finops/v1/payment-terms/{payment_terms_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-terms/{payment_terms_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get Payment Tiers */ getPaymentTiers: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-tiers'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-tiers']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-tiers']['get']['parameters'], paths['/finops/v1/payment-tiers']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-tiers']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-tiers']['get']['responses']['500']['content']['application/json']>; /** @summary Create Payment Tier */ postPaymentTiers: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/payment-tiers'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-tiers']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/payment-tiers']['post']['parameters'], paths['/finops/v1/payment-tiers']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-tiers']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-tiers']['post']['responses']['500']['content']['application/json']>; /** @summary Get Payment Tier By Id */ getPaymentTiersId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/payment-tiers/{tier_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/payment-tiers/{tier_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-tiers/{tier_id}']['get']['parameters'], paths['/finops/v1/payment-tiers/{tier_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-tiers/{tier_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-tiers/{tier_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update Payment Tier By Id */ patchPaymentTiersId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/payment-tiers/{tier_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/payment-tiers/{tier_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/payment-tiers/{tier_id}']['patch']['parameters'], paths['/finops/v1/payment-tiers/{tier_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-tiers/{tier_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-tiers/{tier_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete Payment Tier By Id */ deletePaymentTiersId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/payment-tiers/{tier_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/payment-tiers/{tier_id}']['delete']['parameters'], paths['/finops/v1/payment-tiers/{tier_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/payment-tiers/{tier_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/payment-tiers/{tier_id}']['delete']['responses']['500']['content']['application/json']>; /** * @deprecated * @summary Update person onboarding documents * @description Deprecated. Use `POST /persons/{person_id}/onboarding_documents` instead. Update the onboarding documents of a person. */ postPersonsIdDocuments: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/persons/{person_id}/documents'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/persons/{person_id}/documents']['post']['parameters'], paths['/finops/v1/persons/{person_id}/documents']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/persons/{person_id}/documents']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/persons/{person_id}/documents']['post']['responses']['500']['content']['application/json']>; /** @summary Get products */ getProducts: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/products'; security: ['HTTPBearer']; }, paths['/finops/v1/products']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/products']['get']['parameters'], paths['/finops/v1/products']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/products']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/products']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/products']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/products']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/products']['get']['responses']['500']['content']['application/json']>; /** @summary Create a product */ postProducts: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/products'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/products']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/products']['post']['parameters'], paths['/finops/v1/products']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/products']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/products']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/products']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/products']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/products']['post']['responses']['500']['content']['application/json']>; /** @summary Get a product by ID */ getProductsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/products/{product_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/products/{product_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/products/{product_id}']['get']['parameters'], paths['/finops/v1/products/{product_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a product */ patchProductsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/products/{product_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/products/{product_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/products/{product_id}']['patch']['parameters'], paths['/finops/v1/products/{product_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a product */ deleteProductsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/products/{product_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/products/{product_id}']['delete']['parameters'], paths['/finops/v1/products/{product_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/products/{product_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Get all projects for entity * @description Get all projects for an entity */ getProjects: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/projects'; security: ['HTTPBearer']; }, paths['/finops/v1/projects']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/projects']['get']['parameters'], paths['/finops/v1/projects']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/projects']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/projects']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/projects']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/projects']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/projects']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/projects']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/projects']['get']['responses']['500']['content']['application/json']>; /** * @summary Create a project * @description Create a new project. */ postProjects: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/projects'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/projects']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/projects']['post']['parameters'], paths['/finops/v1/projects']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/projects']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/projects']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/projects']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/projects']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/projects']['post']['responses']['500']['content']['application/json']>; /** * @summary Get a project by ID * @description Get a project with the given ID. */ getProjectsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/projects/{project_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/projects/{project_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/projects/{project_id}']['get']['parameters'], paths['/finops/v1/projects/{project_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update a project * @description Update a project. */ patchProjectsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/projects/{project_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/projects/{project_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/projects/{project_id}']['patch']['parameters'], paths['/finops/v1/projects/{project_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Delete a project * @description Delete a project. */ deleteProjectsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/projects/{project_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/projects/{project_id}']['delete']['parameters'], paths['/finops/v1/projects/{project_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/projects/{project_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get receipts */ getReceipts: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/receipts'; security: ['HTTPBearer']; }, paths['/finops/v1/receipts']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/receipts']['get']['parameters'], paths['/finops/v1/receipts']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/receipts']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/receipts']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/receipts']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/receipts']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/receipts']['get']['responses']['500']['content']['application/json']>; /** @summary Create a receipt */ postReceipts: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receipts'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receipts']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/receipts']['post']['parameters'], paths['/finops/v1/receipts']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receipts']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receipts']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receipts']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receipts']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receipts']['post']['responses']['500']['content']['application/json']>; /** * @summary Upload a receipt from a file * @description Upload an incoming receipt in the PDF, PNG, or JPEG format and scan its contents. The maximum file size is 20 MB. */ postReceiptsUploadFromFile: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receipts/upload-from-file'; mediaType: 'multipart/form-data'; security: ['HTTPBearer']; }, NonNullable['content']['multipart/form-data'], paths['/finops/v1/receipts/upload-from-file']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/receipts/upload-from-file']['post']['parameters'], paths['/finops/v1/receipts/upload-from-file']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receipts/upload-from-file']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receipts/upload-from-file']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receipts/upload-from-file']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receipts/upload-from-file']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receipts/upload-from-file']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receipts/upload-from-file']['post']['responses']['500']['content']['application/json']>; /** @summary Get a receipt by ID */ getReceiptsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/receipts/{receipt_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/receipts/{receipt_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/receipts/{receipt_id}']['get']['parameters'], paths['/finops/v1/receipts/{receipt_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a receipt */ patchReceiptsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/receipts/{receipt_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receipts/{receipt_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/receipts/{receipt_id}']['patch']['parameters'], paths['/finops/v1/receipts/{receipt_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a receipt */ deleteReceiptsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/receipts/{receipt_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/receipts/{receipt_id}']['delete']['parameters'], paths['/finops/v1/receipts/{receipt_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['delete']['responses']['409']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Attach a file to a receipt * @description Attach a file to a receipt without an existing attachment. */ postReceiptsIdAttachFile: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receipts/{receipt_id}/attach-file'; mediaType: 'multipart/form-data'; security: ['HTTPBearer']; }, NonNullable['content']['multipart/form-data'], paths['/finops/v1/receipts/{receipt_id}/attach-file']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/receipts/{receipt_id}/attach-file']['post']['parameters'], paths['/finops/v1/receipts/{receipt_id}/attach-file']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/attach-file']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/attach-file']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/attach-file']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/attach-file']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/attach-file']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/attach-file']['post']['responses']['500']['content']['application/json']>; /** @summary Get all line items of a receipt */ getReceiptsIdLineItems: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/receipts/{receipt_id}/line-items'; security: ['HTTPBearer']; }, paths['/finops/v1/receipts/{receipt_id}/line-items']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/receipts/{receipt_id}/line-items']['get']['parameters'], paths['/finops/v1/receipts/{receipt_id}/line-items']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items']['get']['responses']['500']['content']['application/json']>; /** @summary Add a new line item to a receipt */ postReceiptsIdLineItems: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receipts/{receipt_id}/line-items'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receipts/{receipt_id}/line-items']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/receipts/{receipt_id}/line-items']['post']['parameters'], paths['/finops/v1/receipts/{receipt_id}/line-items']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items']['post']['responses']['500']['content']['application/json']>; /** @summary Update a line item of a receipt */ patchReceiptsIdLineItemsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['patch']['parameters'], paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a line item from a receipt */ deleteReceiptsIdLineItemsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['delete']['parameters'], paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/receipts/{receipt_id}/line-items/{line_item_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Get receivables * @description Returns a list of [accounts receivable](https://docs.monite.com/accounts-receivable/index) documents - invoices, quotes, and credit notes - of the specified entity. * * Results can be filtered by amount, counterpart, due date, and other criteria. Multiple filters are combined using logical AND unless specified otherwise. If no documents matching the search criteria are found, the endpoint returns a successful response with an empty `data` array. * * This endpoint supports [pagination](https://docs.monite.com/api/concepts/pagination-sorting-filtering) and sorting. By default, results are sorted by the creation date in ascending order (from oldest to newest). * * #### Examples * * ##### Invoices * * * Get all overdue invoices: * ``` * GET /receivables?type=invoice&status=overdue * ``` * * * Get all invoices created for the counterpart named "Solarwind" (case-insensitive): * * ``` * GET /receivables?type=invoice?counterpart_name__icontains=Solarwind * ``` * * * Get invoices whose total amount starts from 500 EUR: * * ``` * GET /receivables?type=invoice&total_amount__gte=50000 * ``` * * * Get invoices that are due for payment in September 2024: * * ``` * GET /receivables?type=invoice&due_date__gte=2024-09-01&due_date__lt=2024-10-01 * ``` * **Note:** This will only return invoices with a set due date. Invoices without due dates are excluded from date range filters. * * * * Get invoices without a due date: * * ``` * GET /receivables?type=invoice&has_due_date=false * ``` * * * * Get invoices with any due date (excluding those without due dates): * * ``` * GET /receivables?type=invoice&has_due_date=true * ``` * * * * Get invoices created on or after September 1, 2024: * * ``` * GET /receivables?type=invoice&created_at__gte=2024-09-01T00:00:00Z * ``` * * * Find an invoice created from a specific quote: * * ``` * GET /receivables?type=invoice?based_on=QUOTE_ID * ``` * * ##### Quotes * * * Get the latest created quote: * * ``` * GET /receivables?type=quote&sort=created_at&order=desc&limit=1 * ``` * * * Get the latest issued quote: * * ``` * GET /receivables?type=quote&sort=issue_date&order=desc&limit=1 * ``` * * ##### Credit notes * * * Find all credit notes created for a specific invoice: * * ``` * GET /receivables?type=credit_note?based_on=INVOICE_ID * ``` */ getReceivables: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/receivables'; security: ['HTTPBearer']; }, paths['/finops/v1/receivables']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables']['get']['parameters'], paths['/finops/v1/receivables']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/receivables']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables']['get']['responses']['500']['content']['application/json']>; /** @summary Create a receivable */ postReceivables: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receivables']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/receivables']['post']['parameters'], paths['/finops/v1/receivables']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables']['post']['responses']['500']['content']['application/json']>; /** * @summary Get required field names for invoice creation * @description Get field requirements for invoice creation given the entity and counterpart details. */ getReceivablesRequiredFields: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/receivables/required-fields'; security: ['HTTPBearer']; }, paths['/finops/v1/receivables/required-fields']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/required-fields']['get']['parameters'], paths['/finops/v1/receivables/required-fields']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/required-fields']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/required-fields']['get']['responses']['500']['content']['application/json']>; /** * @summary Search receivables * @description This is a POST version of the `GET /receivables` endpoint. Use it to send search and filter parameters in the request body instead of the URL query string in case the query is too long and exceeds the URL length limit of your HTTP client. */ postReceivablesSearch: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables/search'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receivables/search']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/search']['post']['parameters'], paths['/finops/v1/receivables/search']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/search']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/search']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/search']['post']['responses']['406']['content']['application/json'] | paths['/finops/v1/receivables/search']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/search']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/search']['post']['responses']['500']['content']['application/json']>; /** * @summary Get email template variables * @description Get a list of placeholders that can be used in email templates for customization. */ getReceivablesVariables: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/receivables/variables'; security: ['HTTPBearer']; }, paths['/finops/v1/receivables/variables']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/variables']['get']['parameters'], paths['/finops/v1/receivables/variables']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/variables']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/variables']['get']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/variables']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/variables']['get']['responses']['500']['content']['application/json']>; /** @summary Get a receivable by ID */ getReceivablesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/receivables/{receivable_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/receivables/{receivable_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}']['get']['parameters'], paths['/finops/v1/receivables/{receivable_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a receivable */ patchReceivablesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/receivables/{receivable_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}']['patch']['parameters'], paths['/finops/v1/receivables/{receivable_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['patch']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a receivable */ deleteReceivablesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/receivables/{receivable_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/receivables/{receivable_id}']['delete']['parameters'], paths['/finops/v1/receivables/{receivable_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['delete']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Accept a quote */ postReceivablesIdAccept: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables/{receivable_id}/accept'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/accept']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/accept']['post']['parameters'], paths['/finops/v1/receivables/{receivable_id}/accept']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/accept']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/accept']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/accept']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/accept']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/accept']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/accept']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/accept']['post']['responses']['500']['content']['application/json']>; /** @summary Cancel an invoice */ postReceivablesIdCancel: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables/{receivable_id}/cancel'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/receivables/{receivable_id}/cancel']['post']['parameters'], paths['/finops/v1/receivables/{receivable_id}/cancel']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/cancel']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/cancel']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/cancel']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/cancel']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/cancel']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/cancel']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/cancel']['post']['responses']['500']['content']['application/json']>; /** @summary Clone a receivable */ postReceivablesIdClone: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables/{receivable_id}/clone'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/receivables/{receivable_id}/clone']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/clone']['post']['parameters'], paths['/finops/v1/receivables/{receivable_id}/clone']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/clone']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/clone']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/clone']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/clone']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/clone']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/clone']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/clone']['post']['responses']['500']['content']['application/json']>; /** @summary Decline a quote */ postReceivablesIdDecline: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables/{receivable_id}/decline'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/decline']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/decline']['post']['parameters'], paths['/finops/v1/receivables/{receivable_id}/decline']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/decline']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/decline']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/decline']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/decline']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/decline']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/decline']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/decline']['post']['responses']['500']['content']['application/json']>; /** * @summary Get a receivable's history * @description Returns the history of the specified accounts receivable document. The history contains all revisions of the document, status updates, and other events that occurred during the document's lifecycle. For more information, see [Document history](https://docs.monite.com/accounts-receivable/document-history). * * You can filter the history by the date range and event type. Events are sorted from oldest to newest by default. */ getReceivablesIdHistory: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/receivables/{receivable_id}/history'; security: ['HTTPBearer']; }, paths['/finops/v1/receivables/{receivable_id}/history']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/history']['get']['parameters'], paths['/finops/v1/receivables/{receivable_id}/history']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/history']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/history']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/history']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/history']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/history']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/history']['get']['responses']['500']['content']['application/json']>; /** * @summary Get a receivable's history record by ID * @description Returns a single record from the change history of the specified accounts receivable document. */ getReceivablesIdHistoryId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/receivables/{receivable_id}/history/{receivable_history_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/receivables/{receivable_id}/history/{receivable_history_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/history/{receivable_history_id}']['get']['parameters'], paths['/finops/v1/receivables/{receivable_id}/history/{receivable_history_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/history/{receivable_history_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/history/{receivable_history_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/history/{receivable_history_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/history/{receivable_history_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/history/{receivable_history_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/history/{receivable_history_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Issue a receivable */ postReceivablesIdIssue: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables/{receivable_id}/issue'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/receivables/{receivable_id}/issue']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/issue']['post']['parameters'], paths['/finops/v1/receivables/{receivable_id}/issue']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/issue']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/issue']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/issue']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/issue']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/issue']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/issue']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/issue']['post']['responses']['500']['content']['application/json']>; /** * @summary Update the line items of a receivable * @description Replace all line items of an existing invoice or quote with a new list of line items. */ putReceivablesIdLineItems: ServiceOperationMutation<{ method: 'put'; url: '/finops/v1/receivables/{receivable_id}/line-items'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/line-items']['put']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/line-items']['put']['parameters'], paths['/finops/v1/receivables/{receivable_id}/line-items']['put']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/line-items']['put']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/line-items']['put']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/line-items']['put']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/line-items']['put']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/line-items']['put']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/line-items']['put']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/line-items']['put']['responses']['500']['content']['application/json']>; /** @summary Get a list of all mails sent by receivable */ getReceivablesIdMails: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/receivables/{receivable_id}/mails'; security: ['HTTPBearer']; }, paths['/finops/v1/receivables/{receivable_id}/mails']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/mails']['get']['parameters'], paths['/finops/v1/receivables/{receivable_id}/mails']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mails']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mails']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mails']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mails']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mails']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mails']['get']['responses']['500']['content']['application/json']>; /** @summary Get a mail sent by receivable */ getReceivablesIdMailsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/receivables/{receivable_id}/mails/{mail_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/receivables/{receivable_id}/mails/{mail_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/mails/{mail_id}']['get']['parameters'], paths['/finops/v1/receivables/{receivable_id}/mails/{mail_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mails/{mail_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mails/{mail_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mails/{mail_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mails/{mail_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mails/{mail_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mails/{mail_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Mark an invoice as paid */ postReceivablesIdMarkAsPaid: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables/{receivable_id}/mark-as-paid'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/mark-as-paid']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/mark-as-paid']['post']['parameters'], paths['/finops/v1/receivables/{receivable_id}/mark-as-paid']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-paid']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-paid']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-paid']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-paid']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-paid']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-paid']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-paid']['post']['responses']['500']['content']['application/json']>; /** * @deprecated * @summary Mark an invoice as partially paid * @description Deprecated. Use `POST /payment_records` to record an invoice payment. */ postReceivablesIdMarkAsPartiallyPaid: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables/{receivable_id}/mark-as-partially-paid'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/mark-as-partially-paid']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/mark-as-partially-paid']['post']['parameters'], paths['/finops/v1/receivables/{receivable_id}/mark-as-partially-paid']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-partially-paid']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-partially-paid']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-partially-paid']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-partially-paid']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-partially-paid']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-partially-paid']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-partially-paid']['post']['responses']['500']['content']['application/json']>; /** @summary Mark an invoice as uncollectible */ postReceivablesIdMarkAsUncollectible: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables/{receivable_id}/mark-as-uncollectible'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/mark-as-uncollectible']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/mark-as-uncollectible']['post']['parameters'], paths['/finops/v1/receivables/{receivable_id}/mark-as-uncollectible']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-uncollectible']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-uncollectible']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-uncollectible']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-uncollectible']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-uncollectible']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-uncollectible']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/mark-as-uncollectible']['post']['responses']['500']['content']['application/json']>; /** @summary Get a link to the PDF version of a receivable */ getReceivablesIdPdfLink: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/receivables/{receivable_id}/pdf-link'; security: ['HTTPBearer']; }, paths['/finops/v1/receivables/{receivable_id}/pdf-link']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/pdf-link']['get']['parameters'], paths['/finops/v1/receivables/{receivable_id}/pdf-link']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/pdf-link']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/pdf-link']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/pdf-link']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/pdf-link']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/pdf-link']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/pdf-link']['get']['responses']['500']['content']['application/json']>; /** @summary Preview a receivable's email message */ postReceivablesIdPreview: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables/{receivable_id}/preview'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/preview']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/preview']['post']['parameters'], paths['/finops/v1/receivables/{receivable_id}/preview']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/preview']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/preview']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/preview']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/preview']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/preview']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/preview']['post']['responses']['500']['content']['application/json']>; /** @summary Send a receivable via email */ postReceivablesIdSend: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables/{receivable_id}/send'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/send']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/send']['post']['parameters'], paths['/finops/v1/receivables/{receivable_id}/send']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send']['post']['responses']['500']['content']['application/json']>; /** @summary Send a test reminder */ postReceivablesIdSendTestReminder: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables/{receivable_id}/send-test-reminder'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/send-test-reminder']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/send-test-reminder']['post']['parameters'], paths['/finops/v1/receivables/{receivable_id}/send-test-reminder']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send-test-reminder']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send-test-reminder']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send-test-reminder']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send-test-reminder']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send-test-reminder']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send-test-reminder']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/send-test-reminder']['post']['responses']['500']['content']['application/json']>; /** @summary Verify a receivable */ postReceivablesIdVerify: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/receivables/{receivable_id}/verify'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/receivables/{receivable_id}/verify']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/receivables/{receivable_id}/verify']['post']['parameters'], paths['/finops/v1/receivables/{receivable_id}/verify']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/verify']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/verify']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/verify']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/verify']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/verify']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/receivables/{receivable_id}/verify']['post']['responses']['500']['content']['application/json']>; /** @summary Get recurrences */ getRecurrences: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/recurrences'; security: ['HTTPBearer']; }, paths['/finops/v1/recurrences']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/recurrences']['get']['parameters'], paths['/finops/v1/recurrences']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/recurrences']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/recurrences']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/recurrences']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/recurrences']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/recurrences']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/recurrences']['get']['responses']['500']['content']['application/json']>; /** @summary Create a recurrence */ postRecurrences: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/recurrences'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/recurrences']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/recurrences']['post']['parameters'], paths['/finops/v1/recurrences']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/recurrences']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/recurrences']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/recurrences']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/recurrences']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/recurrences']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/recurrences']['post']['responses']['500']['content']['application/json']>; /** @summary Get a recurrence by ID */ getRecurrencesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/recurrences/{recurrence_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/recurrences/{recurrence_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/recurrences/{recurrence_id}']['get']['parameters'], paths['/finops/v1/recurrences/{recurrence_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a recurrence */ patchRecurrencesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/recurrences/{recurrence_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/recurrences/{recurrence_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/recurrences/{recurrence_id}']['patch']['parameters'], paths['/finops/v1/recurrences/{recurrence_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Cancel a recurrence */ postRecurrencesIdCancel: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/recurrences/{recurrence_id}/cancel'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/recurrences/{recurrence_id}/cancel']['post']['parameters'], paths['/finops/v1/recurrences/{recurrence_id}/cancel']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/cancel']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/cancel']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/cancel']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/cancel']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/cancel']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/cancel']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/cancel']['post']['responses']['500']['content']['application/json']>; /** @summary Pause a recurrence */ postRecurrencesIdPause: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/recurrences/{recurrence_id}/pause'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/recurrences/{recurrence_id}/pause']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/recurrences/{recurrence_id}/pause']['post']['parameters'], paths['/finops/v1/recurrences/{recurrence_id}/pause']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/pause']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/pause']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/pause']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/pause']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/pause']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/pause']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/pause']['post']['responses']['500']['content']['application/json']>; /** @summary Resume a recurrence */ postRecurrencesIdResume: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/recurrences/{recurrence_id}/resume'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/recurrences/{recurrence_id}/resume']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/recurrences/{recurrence_id}/resume']['post']['parameters'], paths['/finops/v1/recurrences/{recurrence_id}/resume']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/resume']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/resume']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/resume']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/resume']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/resume']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/resume']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/recurrences/{recurrence_id}/resume']['post']['responses']['500']['content']['application/json']>; /** @summary Get All */ getRegulatoryTemplates: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/regulatory-templates'; security: ['HTTPBearer']; }, paths['/finops/v1/regulatory-templates']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/regulatory-templates']['get']['parameters'], paths['/finops/v1/regulatory-templates']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/regulatory-templates']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/regulatory-templates']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/regulatory-templates']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/regulatory-templates']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/regulatory-templates']['get']['responses']['500']['content']['application/json']>; /** @summary Create */ postRegulatoryTemplates: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/regulatory-templates'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/regulatory-templates']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/regulatory-templates']['post']['parameters'], paths['/finops/v1/regulatory-templates']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/regulatory-templates']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/regulatory-templates']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/regulatory-templates']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/regulatory-templates']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/regulatory-templates']['post']['responses']['500']['content']['application/json']>; /** * @summary Download Template Ids Vat Rates * @description Returns 'template-ids-vat-rates.json' file */ getRegulatoryTemplatesDownloadTemplateIdsVatRates: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/regulatory-templates/download-template-ids-vat-rates'; security: ['HTTPBearer']; }, paths['/finops/v1/regulatory-templates/download-template-ids-vat-rates']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/regulatory-templates/download-template-ids-vat-rates']['get']['parameters'], paths['/finops/v1/regulatory-templates/download-template-ids-vat-rates']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/regulatory-templates/download-template-ids-vat-rates']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/regulatory-templates/download-template-ids-vat-rates']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/regulatory-templates/download-template-ids-vat-rates']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/regulatory-templates/download-template-ids-vat-rates']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/regulatory-templates/download-template-ids-vat-rates']['get']['responses']['500']['content']['application/json']>; /** @summary Get By Id */ getRegulatoryTemplatesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/regulatory-templates/{regulatory_template_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['get']['parameters'], paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update By Id */ patchRegulatoryTemplatesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/regulatory-templates/{regulatory_template_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['patch']['parameters'], paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete By Id */ deleteRegulatoryTemplatesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/regulatory-templates/{regulatory_template_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['delete']['parameters'], paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/regulatory-templates/{regulatory_template_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Render Pdf */ postRenderPdf: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/render-pdf'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/render-pdf']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/render-pdf']['post']['parameters'], paths['/finops/v1/render-pdf']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/render-pdf']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/render-pdf']['post']['responses']['500']['content']['application/json']>; /** * @summary Search roles * @description Find all roles that match the search criteria. */ getRoles: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/roles'; security: ['HTTPBearer']; }, paths['/finops/v1/roles']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/roles']['get']['parameters'], paths['/finops/v1/roles']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/roles']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/roles']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/roles']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/roles']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/roles']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/roles']['get']['responses']['500']['content']['application/json']>; /** * @summary Create a role * @description Create a new role from the specified values. */ postRoles: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/roles'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/roles']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/roles']['post']['parameters'], paths['/finops/v1/roles']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/roles']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/roles']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/roles']['post']['responses']['500']['content']['application/json']>; /** @summary Get a role by ID */ getRolesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/roles/{role_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/roles/{role_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/roles/{role_id}']['get']['parameters'], paths['/finops/v1/roles/{role_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/roles/{role_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/roles/{role_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/roles/{role_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update a role * @description Change the specified fields with the provided values. */ patchRolesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/roles/{role_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/roles/{role_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/roles/{role_id}']['patch']['parameters'], paths['/finops/v1/roles/{role_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/roles/{role_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/roles/{role_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/roles/{role_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Delete a role * @description Delete a role with the specified ID. The role being deleted must not be in use by any entity users, otherwise a 409 error is returned. To check if there are entity users that have this role, call `GET /entity_users?role_id=ROLE_ID`. */ deleteRolesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/roles/{role_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/roles/{role_id}']['delete']['parameters'], paths['/finops/v1/roles/{role_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/roles/{role_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/roles/{role_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/roles/{role_id}']['delete']['responses']['409']['content']['application/json'] | paths['/finops/v1/roles/{role_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/roles/{role_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Get All */ getRules: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/rules'; security: ['HTTPBearer']; }, paths['/finops/v1/rules']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/rules']['get']['parameters'], paths['/finops/v1/rules']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/rules']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/rules']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/rules']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/rules']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/rules']['get']['responses']['500']['content']['application/json']>; /** @summary Create */ postRules: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/rules'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/rules']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/rules']['post']['parameters'], paths['/finops/v1/rules']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/rules']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/rules']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/rules']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/rules']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/rules']['post']['responses']['500']['content']['application/json']>; /** @summary Get By Id */ getRulesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/rules/{rule_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/rules/{rule_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/rules/{rule_id}']['get']['parameters'], paths['/finops/v1/rules/{rule_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update Rule By Id */ patchRulesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/rules/{rule_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/rules/{rule_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/rules/{rule_id}']['patch']['parameters'], paths['/finops/v1/rules/{rule_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete By Id */ deleteRulesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/rules/{rule_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/rules/{rule_id}']['delete']['parameters'], paths['/finops/v1/rules/{rule_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/rules/{rule_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Send Email * @description Send email to the entity */ postSendEmail: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/send-email'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/send-email']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/send-email']['post']['parameters'], paths['/finops/v1/send-email']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/send-email']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/send-email']['post']['responses']['500']['content']['application/json']>; /** * @summary Render Template * @description Render template */ postSendEmailRenderTemplate: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/send-email/render-template'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/send-email/render-template']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/send-email/render-template']['post']['parameters'], paths['/finops/v1/send-email/render-template']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/send-email/render-template']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/send-email/render-template']['post']['responses']['500']['content']['application/json']>; /** * @summary Send Email By Document Type * @description Send Email by Document type */ postSendEmailSendEmailByDocumentType: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/send-email/send-email-by-document-type'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/send-email/send-email-by-document-type']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/send-email/send-email-by-document-type']['post']['parameters'], paths['/finops/v1/send-email/send-email-by-document-type']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/send-email/send-email-by-document-type']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/send-email/send-email-by-document-type']['post']['responses']['500']['content']['application/json']>; /** * @summary Send Stateless Email * @description Stateless email sender */ postSendEmailStateless: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/send-email/stateless'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/send-email/stateless']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/send-email/stateless']['post']['parameters'], paths['/finops/v1/send-email/stateless']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/send-email/stateless']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/send-email/stateless']['post']['responses']['500']['content']['application/json']>; /** * @summary Get partner settings * @description Retrieve all settings for this partner. */ getSettings: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/settings'; security: ['HTTPBearer']; }, paths['/finops/v1/settings']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/settings']['get']['parameters'], paths['/finops/v1/settings']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/settings']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/settings']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/settings']['get']['responses']['500']['content']['application/json']>; /** * @summary Update partner settings * @description Change the specified fields with the provided values. */ patchSettings: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/settings'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/settings']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/settings']['patch']['parameters'], paths['/finops/v1/settings']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/settings']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/settings']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/settings']['patch']['responses']['500']['content']['application/json']>; /** * @summary Get tags * @description Get a list of all tags. Tags can be assigned to resources to assist with searching and filtering. * Tags can also be used as trigger conditions in payable approval policies. * * Optional filters: * - `category`: Return only tags that belong to the specified category. * - `category__in`: Return tags that belong to any of the specified categories. */ getTags: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/tags'; security: ['HTTPBearer']; }, paths['/finops/v1/tags']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/tags']['get']['parameters'], paths['/finops/v1/tags']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/tags']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/tags']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/tags']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/tags']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/tags']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/tags']['get']['responses']['500']['content']['application/json']>; /** * @summary Create a tag * @description Create a new tag. The tag name must be unique. * Tag names are case-sensitive, that is `Marketing` and `marketing` are two different tags. * * * The response returns an auto-generated ID assigned to this tag. * To assign this tag to a resource, send the tag ID in the `tag_ids` list when creating or updating a resource. */ postTags: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/tags'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/tags']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/tags']['post']['parameters'], paths['/finops/v1/tags']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/tags']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/tags']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/tags']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/tags']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/tags']['post']['responses']['406']['content']['application/json'] | paths['/finops/v1/tags']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/tags']['post']['responses']['500']['content']['application/json']>; /** * @summary Get a tag by ID * @description Get information about a tag with the given ID. */ getTagsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/tags/{tag_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/tags/{tag_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/tags/{tag_id}']['get']['parameters'], paths['/finops/v1/tags/{tag_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['get']['responses']['406']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update a tag * @description Change the tag name. The new name must be unique among existing tags. * Tag names are case-sensitive, that is `Marketing` and `marketing` are two different tags. */ patchTagsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/tags/{tag_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/tags/{tag_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/tags/{tag_id}']['patch']['parameters'], paths['/finops/v1/tags/{tag_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['patch']['responses']['406']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Delete a tag * @description Delete a tag with the given ID. This tag will be automatically deleted from all resources where it was used. */ deleteTagsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/tags/{tag_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/tags/{tag_id}']['delete']['parameters'], paths['/finops/v1/tags/{tag_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['delete']['responses']['406']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/tags/{tag_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Get text templates * @description Get text templates */ getTextTemplates: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/text-templates'; security: ['HTTPBearer']; }, paths['/finops/v1/text-templates']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/text-templates']['get']['parameters'], paths['/finops/v1/text-templates']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/text-templates']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/text-templates']['get']['responses']['500']['content']['application/json']>; /** * @summary Create a text template * @description Create a text template */ postTextTemplates: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/text-templates'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/text-templates']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/text-templates']['post']['parameters'], paths['/finops/v1/text-templates']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/text-templates']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/text-templates']['post']['responses']['500']['content']['application/json']>; /** * @summary Get a text template by ID * @description Get all custom contents */ getTextTemplatesId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/text-templates/{text_template_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/text-templates/{text_template_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/text-templates/{text_template_id}']['get']['parameters'], paths['/finops/v1/text-templates/{text_template_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/text-templates/{text_template_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/text-templates/{text_template_id}']['get']['responses']['500']['content']['application/json']>; /** * @summary Update a text template by ID * @description Update custom content by ID */ patchTextTemplatesId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/text-templates/{text_template_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/text-templates/{text_template_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/text-templates/{text_template_id}']['patch']['parameters'], paths['/finops/v1/text-templates/{text_template_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/text-templates/{text_template_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/text-templates/{text_template_id}']['patch']['responses']['500']['content']['application/json']>; /** * @summary Delete a text template * @description Delete custom content by ID */ deleteTextTemplatesId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/text-templates/{text_template_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/text-templates/{text_template_id}']['delete']['parameters'], paths['/finops/v1/text-templates/{text_template_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/text-templates/{text_template_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/text-templates/{text_template_id}']['delete']['responses']['500']['content']['application/json']>; /** * @summary Make a text template default * @description Make text template default */ postTextTemplatesIdMakeDefault: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/text-templates/{text_template_id}/make-default'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/text-templates/{text_template_id}/make-default']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/text-templates/{text_template_id}/make-default']['post']['parameters'], paths['/finops/v1/text-templates/{text_template_id}/make-default']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/text-templates/{text_template_id}/make-default']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/text-templates/{text_template_id}/make-default']['post']['responses']['500']['content']['application/json']>; /** @summary Get transactions */ getTransactions: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/transactions'; security: ['HTTPBearer']; }, paths['/finops/v1/transactions']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/transactions']['get']['parameters'], paths['/finops/v1/transactions']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/transactions']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/transactions']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/transactions']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions']['get']['responses']['500']['content']['application/json']>; /** @summary Create a transaction */ postTransactions: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/transactions'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/transactions']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/transactions']['post']['parameters'], paths['/finops/v1/transactions']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/transactions']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/transactions']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/transactions']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions']['post']['responses']['500']['content']['application/json']>; /** @summary Create multiple transactions */ postTransactionsBulk: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/transactions/bulk'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/transactions/bulk']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/transactions/bulk']['post']['parameters'], paths['/finops/v1/transactions/bulk']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/transactions/bulk']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/transactions/bulk']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/transactions/bulk']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/bulk']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/bulk']['post']['responses']['500']['content']['application/json']>; /** @summary Get required fields configuration */ getTransactionsValidations: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/transactions/validations'; security: ['HTTPBearer']; }, paths['/finops/v1/transactions/validations']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/transactions/validations']['get']['parameters'], paths['/finops/v1/transactions/validations']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/validations']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/validations']['get']['responses']['500']['content']['application/json']>; /** @summary Update required fields configuration */ putTransactionsValidations: ServiceOperationMutation<{ method: 'put'; url: '/finops/v1/transactions/validations'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/transactions/validations']['put']['responses']['200']['content']['application/json'], paths['/finops/v1/transactions/validations']['put']['parameters'], paths['/finops/v1/transactions/validations']['put']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/validations']['put']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/validations']['put']['responses']['500']['content']['application/json']>; /** @summary Get a transaction */ getTransactionsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/transactions/{transaction_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/transactions/{transaction_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}']['get']['parameters'], paths['/finops/v1/transactions/{transaction_id}']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a transaction */ patchTransactionsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/transactions/{transaction_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}']['patch']['parameters'], paths['/finops/v1/transactions/{transaction_id}']['patch']['responses']['400']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['patch']['responses']['401']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['patch']['responses']['403']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['patch']['responses']['404']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['patch']['responses']['409']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a transaction */ deleteTransactionsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/transactions/{transaction_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/transactions/{transaction_id}']['delete']['parameters'], paths['/finops/v1/transactions/{transaction_id}']['delete']['responses']['400']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['delete']['responses']['401']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['delete']['responses']['403']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['delete']['responses']['404']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Approve a transaction */ postTransactionsIdApprove: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/transactions/{transaction_id}/approve'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/transactions/{transaction_id}/approve']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}/approve']['post']['parameters'], paths['/finops/v1/transactions/{transaction_id}/approve']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/approve']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/approve']['post']['responses']['500']['content']['application/json']>; /** @summary Cancel a transaction */ postTransactionsIdCancel: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/transactions/{transaction_id}/cancel'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/transactions/{transaction_id}/cancel']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}/cancel']['post']['parameters'], paths['/finops/v1/transactions/{transaction_id}/cancel']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/cancel']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/cancel']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/cancel']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/cancel']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/cancel']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/cancel']['post']['responses']['500']['content']['application/json']>; /** @summary Get expense history for a transaction */ getTransactionsIdExpenseHistory: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/transactions/{transaction_id}/expense_history'; security: ['HTTPBearer']; }, paths['/finops/v1/transactions/{transaction_id}/expense_history']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}/expense_history']['get']['parameters'], paths['/finops/v1/transactions/{transaction_id}/expense_history']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/expense_history']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/expense_history']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/expense_history']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/expense_history']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/expense_history']['get']['responses']['500']['content']['application/json']>; /** @summary Record an approval action in expense history */ postTransactionsIdExpenseHistory: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/transactions/{transaction_id}/expense_history'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}/expense_history']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}/expense_history']['post']['parameters'], paths['/finops/v1/transactions/{transaction_id}/expense_history']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/expense_history']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/expense_history']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/expense_history']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/expense_history']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/expense_history']['post']['responses']['500']['content']['application/json']>; /** @summary Reject a transaction */ postTransactionsIdReject: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/transactions/{transaction_id}/reject'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}/reject']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}/reject']['post']['parameters'], paths['/finops/v1/transactions/{transaction_id}/reject']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/reject']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/reject']['post']['responses']['500']['content']['application/json']>; /** @summary Reopen a rejected transaction */ postTransactionsIdReopen: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/transactions/{transaction_id}/reopen'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/transactions/{transaction_id}/reopen']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}/reopen']['post']['parameters'], paths['/finops/v1/transactions/{transaction_id}/reopen']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/reopen']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/reopen']['post']['responses']['500']['content']['application/json']>; /** @summary Submit a transaction for approval */ postTransactionsIdSubmit: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/transactions/{transaction_id}/submit'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}/submit']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}/submit']['post']['parameters'], paths['/finops/v1/transactions/{transaction_id}/submit']['post']['responses']['400']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/submit']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/submit']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/submit']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/submit']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/submit']['post']['responses']['409']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/submit']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/submit']['post']['responses']['500']['content']['application/json']>; /** @summary Validate a transaction against required fields configuration */ postTransactionsIdValidate: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/transactions/{transaction_id}/validate'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/transactions/{transaction_id}/validate']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/transactions/{transaction_id}/validate']['post']['parameters'], paths['/finops/v1/transactions/{transaction_id}/validate']['post']['responses']['401']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/validate']['post']['responses']['403']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/validate']['post']['responses']['404']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/validate']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/validate']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/transactions/{transaction_id}/validate']['post']['responses']['500']['content']['application/json']>; /** @summary Get VAT rates */ getVatRates: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/vat-rates'; security: ['HTTPBearer']; }, paths['/finops/v1/vat-rates']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/vat-rates']['get']['parameters'], paths['/finops/v1/vat-rates']['get']['responses']['400']['content']['application/json'] | paths['/finops/v1/vat-rates']['get']['responses']['401']['content']['application/json'] | paths['/finops/v1/vat-rates']['get']['responses']['403']['content']['application/json'] | paths['/finops/v1/vat-rates']['get']['responses']['404']['content']['application/json'] | paths['/finops/v1/vat-rates']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/vat-rates']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/vat-rates']['get']['responses']['500']['content']['application/json']>; /** * @summary Get the webhook delivery log * @description Returns an aggregated log of webhook delivery attempts. The data contains a list of triggered webhook events, how many times Monite tried to send each event to your server, the last HTTP status code returned by your webhook listener endpoint, and whether the final attempt to deliver that event was successful. * * We guarantee access to webhook delivery data only from the last three months. Earlier data may be unavailable. * * Note that if the same event type is included in multiple webhook subscriptions, the results will include several entries for each occurrence of this event - one entry per subscription. */ getWebhookDeliveries: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/webhook-deliveries'; security: ['HTTPBearer']; }, paths['/finops/v1/webhook-deliveries']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/webhook-deliveries']['get']['parameters'], paths['/finops/v1/webhook-deliveries']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/webhook-deliveries']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/webhook-deliveries']['get']['responses']['500']['content']['application/json']>; /** @summary Get webhook subscriptions */ getWebhookSubscriptions: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/webhook-subscriptions'; security: ['HTTPBearer']; }, paths['/finops/v1/webhook-subscriptions']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/webhook-subscriptions']['get']['parameters'], paths['/finops/v1/webhook-subscriptions']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions']['get']['responses']['500']['content']['application/json']>; /** @summary Subscribe to a webhook */ postWebhookSubscriptions: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/webhook-subscriptions'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/webhook-subscriptions']['post']['responses']['201']['content']['application/json'], paths['/finops/v1/webhook-subscriptions']['post']['parameters'], paths['/finops/v1/webhook-subscriptions']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions']['post']['responses']['500']['content']['application/json']>; /** @summary Get a webhook subscription */ getWebhookSubscriptionsId: ServiceOperationQuery<{ method: 'get'; url: '/finops/v1/webhook-subscriptions/{webhook_subscription_id}'; security: ['HTTPBearer']; }, paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['get']['responses']['200']['content']['application/json'], paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['get']['parameters'], paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['get']['responses']['405']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['get']['responses']['422']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['get']['responses']['500']['content']['application/json']>; /** @summary Update a webhook subscription */ patchWebhookSubscriptionsId: ServiceOperationMutation<{ method: 'patch'; url: '/finops/v1/webhook-subscriptions/{webhook_subscription_id}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['patch']['responses']['200']['content']['application/json'], paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['patch']['parameters'], paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['patch']['responses']['405']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['patch']['responses']['422']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['patch']['responses']['500']['content']['application/json']>; /** @summary Delete a webhook subscription */ deleteWebhookSubscriptionsId: ServiceOperationMutation<{ method: 'delete'; url: '/finops/v1/webhook-subscriptions/{webhook_subscription_id}'; security: ['HTTPBearer']; }, undefined, unknown, paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['delete']['parameters'], paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['delete']['responses']['405']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['delete']['responses']['422']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}']['delete']['responses']['500']['content']['application/json']>; /** @summary Disable a webhook subscription */ postWebhookSubscriptionsIdDisable: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/webhook-subscriptions/{webhook_subscription_id}/disable'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/disable']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/disable']['post']['parameters'], paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/disable']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/disable']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/disable']['post']['responses']['500']['content']['application/json']>; /** @summary Enable a webhook subscription */ postWebhookSubscriptionsIdEnable: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/webhook-subscriptions/{webhook_subscription_id}/enable'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/enable']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/enable']['post']['parameters'], paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/enable']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/enable']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/enable']['post']['responses']['500']['content']['application/json']>; /** @summary Regenerate a webhook secret and return the new webhook subscription */ postWebhookSubscriptionsIdRegenerateSecret: ServiceOperationMutation<{ method: 'post'; url: '/finops/v1/webhook-subscriptions/{webhook_subscription_id}/regenerate-secret'; security: ['HTTPBearer']; }, undefined, paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/regenerate-secret']['post']['responses']['200']['content']['application/json'], paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/regenerate-secret']['post']['parameters'], paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/regenerate-secret']['post']['responses']['405']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/regenerate-secret']['post']['responses']['422']['content']['application/json'] | paths['/finops/v1/webhook-subscriptions/{webhook_subscription_id}/regenerate-secret']['post']['responses']['500']['content']['application/json']>; } interface IdentityService { /** * @summary Lists all departments for the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:read:org` */ listDepartments: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/departments'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/departments']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/departments']['get']['parameters'], paths['/identity/v1/departments']['get']['responses']['400']['content']['text/plain'] | paths['/identity/v1/departments']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/departments']['get']['responses']['403']['content']['text/plain']>; /** * @summary Creates a new department in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ createDepartment: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/departments'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/identity/v1/departments']['post']['responses']['201']['content']['text/plain'], undefined, paths['/identity/v1/departments']['post']['responses']['400']['content']['text/plain'] | paths['/identity/v1/departments']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/departments']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/departments']['post']['responses']['409']['content']['text/plain']>; /** * @summary Gets a department by ID. * @description **Token types:** APP, USER | **Required scopes:** `user:read:org` */ getDepartment: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/departments/{departmentId}'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/departments/{departmentId}']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/departments/{departmentId}']['get']['parameters'], paths['/identity/v1/departments/{departmentId}']['get']['responses']['400']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}']['get']['responses']['403']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}']['get']['responses']['404']['content']['text/plain']>; /** * @summary Updates a department in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ updateDepartment: ServiceOperationMutation<{ method: 'put'; url: '/identity/v1/departments/{departmentId}'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/identity/v1/departments/{departmentId}']['put']['responses']['200']['content']['text/plain'], paths['/identity/v1/departments/{departmentId}']['put']['parameters'], paths['/identity/v1/departments/{departmentId}']['put']['responses']['400']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}']['put']['responses']['401']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}']['put']['responses']['403']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}']['put']['responses']['404']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}']['put']['responses']['409']['content']['text/plain']>; /** * @summary Deactivates a department in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ deactivateDepartment: ServiceOperationMutation<{ method: 'delete'; url: '/identity/v1/departments/{departmentId}'; security: ['APPToken', 'USERToken']; }, undefined, unknown, paths['/identity/v1/departments/{departmentId}']['delete']['parameters'], paths['/identity/v1/departments/{departmentId}']['delete']['responses']['401']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}']['delete']['responses']['403']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}']['delete']['responses']['404']['content']['text/plain']>; /** * @summary Bulk assigns or removes users from a department. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ bulkUpdateDepartmentMembers: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/departments/{departmentId}/members'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], unknown, paths['/identity/v1/departments/{departmentId}/members']['post']['parameters'], paths['/identity/v1/departments/{departmentId}/members']['post']['responses']['400']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}/members']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}/members']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}/members']['post']['responses']['404']['content']['text/plain']>; /** * @summary Assigns a user to a department. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ assignUserToDepartment: ServiceOperationMutation<{ method: 'put'; url: '/identity/v1/departments/{departmentId}/members/{userId}'; security: ['APPToken', 'USERToken']; }, undefined, unknown, paths['/identity/v1/departments/{departmentId}/members/{userId}']['put']['parameters'], paths['/identity/v1/departments/{departmentId}/members/{userId}']['put']['responses']['401']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}/members/{userId}']['put']['responses']['403']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}/members/{userId}']['put']['responses']['404']['content']['text/plain']>; /** * @summary Removes a user from a department. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ removeUserFromDepartment: ServiceOperationMutation<{ method: 'delete'; url: '/identity/v1/departments/{departmentId}/members/{userId}'; security: ['APPToken', 'USERToken']; }, undefined, unknown, paths['/identity/v1/departments/{departmentId}/members/{userId}']['delete']['parameters'], paths['/identity/v1/departments/{departmentId}/members/{userId}']['delete']['responses']['401']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}/members/{userId}']['delete']['responses']['403']['content']['text/plain'] | paths['/identity/v1/departments/{departmentId}/members/{userId}']['delete']['responses']['404']['content']['text/plain']>; /** * @summary Lists all locations for the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:read:org` */ listLocations: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/locations'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/locations']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/locations']['get']['parameters'], paths['/identity/v1/locations']['get']['responses']['400']['content']['text/plain'] | paths['/identity/v1/locations']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/locations']['get']['responses']['403']['content']['text/plain']>; /** * @summary Creates a new location in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ createLocation: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/locations'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/identity/v1/locations']['post']['responses']['201']['content']['text/plain'], undefined, paths['/identity/v1/locations']['post']['responses']['400']['content']['text/plain'] | paths['/identity/v1/locations']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/locations']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/locations']['post']['responses']['409']['content']['text/plain']>; /** * @summary Gets a location by ID. * @description **Token types:** APP, USER | **Required scopes:** `user:read:org` */ getLocation: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/locations/{locationId}'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/locations/{locationId}']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/locations/{locationId}']['get']['parameters'], paths['/identity/v1/locations/{locationId}']['get']['responses']['400']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}']['get']['responses']['403']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}']['get']['responses']['404']['content']['text/plain']>; /** * @summary Updates a location in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ updateLocation: ServiceOperationMutation<{ method: 'put'; url: '/identity/v1/locations/{locationId}'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/identity/v1/locations/{locationId}']['put']['responses']['200']['content']['text/plain'], paths['/identity/v1/locations/{locationId}']['put']['parameters'], paths['/identity/v1/locations/{locationId}']['put']['responses']['400']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}']['put']['responses']['401']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}']['put']['responses']['403']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}']['put']['responses']['404']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}']['put']['responses']['409']['content']['text/plain']>; /** * @summary Deactivates a location in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ deactivateLocation: ServiceOperationMutation<{ method: 'delete'; url: '/identity/v1/locations/{locationId}'; security: ['APPToken', 'USERToken']; }, undefined, unknown, paths['/identity/v1/locations/{locationId}']['delete']['parameters'], paths['/identity/v1/locations/{locationId}']['delete']['responses']['401']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}']['delete']['responses']['403']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}']['delete']['responses']['404']['content']['text/plain']>; /** * @summary Bulk assigns or removes users from a location. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ bulkUpdateLocationMembers: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/locations/{locationId}/members'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], unknown, paths['/identity/v1/locations/{locationId}/members']['post']['parameters'], paths['/identity/v1/locations/{locationId}/members']['post']['responses']['400']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}/members']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}/members']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}/members']['post']['responses']['404']['content']['text/plain']>; /** * @summary Assigns a user to a location. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ assignUserToLocation: ServiceOperationMutation<{ method: 'put'; url: '/identity/v1/locations/{locationId}/members/{userId}'; security: ['APPToken', 'USERToken']; }, undefined, unknown, paths['/identity/v1/locations/{locationId}/members/{userId}']['put']['parameters'], paths['/identity/v1/locations/{locationId}/members/{userId}']['put']['responses']['401']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}/members/{userId}']['put']['responses']['403']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}/members/{userId}']['put']['responses']['404']['content']['text/plain']>; /** * @summary Removes a user from a location. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ removeUserFromLocation: ServiceOperationMutation<{ method: 'delete'; url: '/identity/v1/locations/{locationId}/members/{userId}'; security: ['APPToken', 'USERToken']; }, undefined, unknown, paths['/identity/v1/locations/{locationId}/members/{userId}']['delete']['parameters'], paths['/identity/v1/locations/{locationId}/members/{userId}']['delete']['responses']['401']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}/members/{userId}']['delete']['responses']['403']['content']['text/plain'] | paths['/identity/v1/locations/{locationId}/members/{userId}']['delete']['responses']['404']['content']['text/plain']>; /** * @summary Lists all applications across the caller's organization hierarchy with child organization type counts. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:read` */ listApplications: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/oidc-applications'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/oidc-applications']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/oidc-applications']['get']['parameters'], paths['/identity/v1/oidc-applications']['get']['responses']['400']['content']['text/plain'] | paths['/identity/v1/oidc-applications']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/oidc-applications']['get']['responses']['403']['content']['text/plain']>; /** * @summary Gets an application by ID, including its scopes and enabled status. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:read` */ getApplication: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/oidc-applications/{applicationId}'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/oidc-applications/{applicationId}']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/oidc-applications/{applicationId}']['get']['parameters'], paths['/identity/v1/oidc-applications/{applicationId}']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/oidc-applications/{applicationId}']['get']['responses']['403']['content']['text/plain'] | paths['/identity/v1/oidc-applications/{applicationId}']['get']['responses']['404']['content']['text/plain']>; /** * @summary Updates payment rail scopes for an application. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:write` */ patchApplicationScopes: ServiceOperationMutation<{ method: 'patch'; url: '/identity/v1/oidc-applications/{applicationId}'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/identity/v1/oidc-applications/{applicationId}']['patch']['responses']['200']['content']['text/plain'], paths['/identity/v1/oidc-applications/{applicationId}']['patch']['parameters'], paths['/identity/v1/oidc-applications/{applicationId}']['patch']['responses']['400']['content']['text/plain'] | paths['/identity/v1/oidc-applications/{applicationId}']['patch']['responses']['401']['content']['text/plain'] | paths['/identity/v1/oidc-applications/{applicationId}']['patch']['responses']['403']['content']['text/plain'] | paths['/identity/v1/oidc-applications/{applicationId}']['patch']['responses']['404']['content']['text/plain']>; /** * @summary Disables an application. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:write` */ disableApplication: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/oidc-applications/{applicationId}/disable'; security: ['APPToken', 'USERToken']; }, undefined, paths['/identity/v1/oidc-applications/{applicationId}/disable']['post']['responses']['200']['content']['text/plain'], paths['/identity/v1/oidc-applications/{applicationId}/disable']['post']['parameters'], paths['/identity/v1/oidc-applications/{applicationId}/disable']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/oidc-applications/{applicationId}/disable']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/oidc-applications/{applicationId}/disable']['post']['responses']['404']['content']['text/plain']>; /** * @summary Enables an application. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:write` */ enableApplication: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/oidc-applications/{applicationId}/enable'; security: ['APPToken', 'USERToken']; }, undefined, paths['/identity/v1/oidc-applications/{applicationId}/enable']['post']['responses']['200']['content']['text/plain'], paths['/identity/v1/oidc-applications/{applicationId}/enable']['post']['parameters'], paths['/identity/v1/oidc-applications/{applicationId}/enable']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/oidc-applications/{applicationId}/enable']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/oidc-applications/{applicationId}/enable']['post']['responses']['404']['content']['text/plain']>; /** * @summary Lists organizations that have a relationship with the caller's organization. * @description Returns organizations that the caller's organization has a relationship with. * Supports optional filtering by organization type and pagination via limit/offset. * Requires the organization:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:read:org` */ getOrganizations: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/organizations'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/organizations']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/organizations']['get']['parameters'], paths['/identity/v1/organizations']['get']['responses']['400']['content']['text/plain'] | paths['/identity/v1/organizations']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations']['get']['responses']['403']['content']['text/plain']>; /** * @summary Creates a new organization as a child of the caller's organization. * @description Creates an EMBEDDED, TRANSACTOR, or VERTICAL_SOFTWARE_PROVIDER organization under the caller's org. * A BANKING_SERVICES relationship is automatically established between the caller and the new org. * Requires the organization:write:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:write:org` */ createOrganization: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/organizations'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/identity/v1/organizations']['post']['responses']['201']['content']['text/plain'], undefined, paths['/identity/v1/organizations']['post']['responses']['400']['content']['text/plain'] | paths['/identity/v1/organizations']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations']['post']['responses']['403']['content']['text/plain']>; /** * @summary Gets all organization IDs visible to the caller by traversing the hierarchy downward. * @description Returns all organizations below the caller in the hierarchy (e.g., a bank sees its VSPs and their acceptors). * Does NOT return organizations above the caller in the hierarchy. * This endpoint returns only IDs for minimal payload size - ideal for caching by consuming services. * Requires the organization:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:read:org` */ getVisibleOrganizationIds: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/organizations/visible-ids'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/organizations/visible-ids']['get']['responses']['200']['content']['text/plain'], undefined, paths['/identity/v1/organizations/visible-ids']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/visible-ids']['get']['responses']['403']['content']['text/plain']>; /** * @summary Gets details for a specific organization. * @description The caller must have a relationship with the target organization to access its details. * Requires the organization:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:read:org` */ getOrganization: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/organizations/{organizationId}'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/organizations/{organizationId}']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/organizations/{organizationId}']['get']['parameters'], paths['/identity/v1/organizations/{organizationId}']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}']['get']['responses']['403']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}']['get']['responses']['404']['content']['text/plain']>; /** * @summary Updates an organization's fields. Only provided fields are updated; omitted fields remain unchanged. * @description The caller must have visibility of the target organization in their hierarchy. * Requires the organization:write:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:write:org` */ updateOrganization: ServiceOperationMutation<{ method: 'patch'; url: '/identity/v1/organizations/{organizationId}'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/identity/v1/organizations/{organizationId}']['patch']['responses']['200']['content']['text/plain'], paths['/identity/v1/organizations/{organizationId}']['patch']['parameters'], paths['/identity/v1/organizations/{organizationId}']['patch']['responses']['400']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}']['patch']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}']['patch']['responses']['403']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}']['patch']['responses']['404']['content']['text/plain']>; /** * @summary Disables an organization by setting its deactivation timestamp. * @description Only VSP or EMBEDDED organizations can be disabled. * The target organization must be visible in the caller's hierarchy. * Requires org:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `org:write:all` */ disableOrganization: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/organizations/{organizationId}/disable'; security: ['APPToken', 'USERToken']; }, undefined, paths['/identity/v1/organizations/{organizationId}/disable']['post']['responses']['200']['content']['text/plain'], paths['/identity/v1/organizations/{organizationId}/disable']['post']['parameters'], paths['/identity/v1/organizations/{organizationId}/disable']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/disable']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/disable']['post']['responses']['404']['content']['text/plain']>; /** * @summary Disables all applications for an organization. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:write` */ disableOrganizationApplications: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/organizations/{organizationId}/disable-applications'; security: ['APPToken', 'USERToken']; }, undefined, paths['/identity/v1/organizations/{organizationId}/disable-applications']['post']['responses']['200']['content']['text/plain'], paths['/identity/v1/organizations/{organizationId}/disable-applications']['post']['parameters'], paths['/identity/v1/organizations/{organizationId}/disable-applications']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/disable-applications']['post']['responses']['403']['content']['text/plain']>; /** * @summary Gets disabled payment rails for an organization. * @description Returns the list of payment rails that are disabled for the organization. * Empty list means all rails are enabled. Requires the organization:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:read:org` */ getOrganizationPaymentRails: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/organizations/{organizationId}/disabled-payment-rails'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/organizations/{organizationId}/disabled-payment-rails']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/organizations/{organizationId}/disabled-payment-rails']['get']['parameters'], paths['/identity/v1/organizations/{organizationId}/disabled-payment-rails']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/disabled-payment-rails']['get']['responses']['403']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/disabled-payment-rails']['get']['responses']['404']['content']['text/plain']>; /** * @summary Updates payment rail status for an organization. * @description Allows disabling or enabling payment rails (payment_rail:ach, payment_rail:fednow, payment_rail:rtp). * Requires the org:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `org:write:all` */ patchOrganizationPaymentRails: ServiceOperationMutation<{ method: 'patch'; url: '/identity/v1/organizations/{organizationId}/disabled-payment-rails'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/identity/v1/organizations/{organizationId}/disabled-payment-rails']['patch']['responses']['200']['content']['text/plain'], paths['/identity/v1/organizations/{organizationId}/disabled-payment-rails']['patch']['parameters'], paths['/identity/v1/organizations/{organizationId}/disabled-payment-rails']['patch']['responses']['400']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/disabled-payment-rails']['patch']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/disabled-payment-rails']['patch']['responses']['403']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/disabled-payment-rails']['patch']['responses']['404']['content']['text/plain']>; /** * @summary Enables an organization by clearing its deactivation timestamp. * @description Only VSP or EMBEDDED organizations can be enabled. * The target organization must be visible in the caller's hierarchy. * Requires org:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `org:write:all` */ enableOrganization: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/organizations/{organizationId}/enable'; security: ['APPToken', 'USERToken']; }, undefined, paths['/identity/v1/organizations/{organizationId}/enable']['post']['responses']['200']['content']['text/plain'], paths['/identity/v1/organizations/{organizationId}/enable']['post']['parameters'], paths['/identity/v1/organizations/{organizationId}/enable']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/enable']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/enable']['post']['responses']['404']['content']['text/plain']>; /** * @summary Enables all applications for an organization. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:write` */ enableOrganizationApplications: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/organizations/{organizationId}/enable-applications'; security: ['APPToken', 'USERToken']; }, undefined, paths['/identity/v1/organizations/{organizationId}/enable-applications']['post']['responses']['200']['content']['text/plain'], paths['/identity/v1/organizations/{organizationId}/enable-applications']['post']['parameters'], paths['/identity/v1/organizations/{organizationId}/enable-applications']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/enable-applications']['post']['responses']['403']['content']['text/plain']>; /** * @summary Uploads a logo for an organization. * @description Requires the org:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `org:write:all` */ uploadOrganizationLogo: ServiceOperationMutation<{ method: 'put'; url: '/identity/v1/organizations/{organizationId}/logo'; mediaType: 'multipart/form-data'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['multipart/form-data'], paths['/identity/v1/organizations/{organizationId}/logo']['put']['responses']['200']['content']['text/plain'], paths['/identity/v1/organizations/{organizationId}/logo']['put']['parameters'], paths['/identity/v1/organizations/{organizationId}/logo']['put']['responses']['400']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/logo']['put']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/logo']['put']['responses']['403']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/logo']['put']['responses']['415']['content']['text/plain']>; /** * @summary Deletes a logo for an organization. * @description Requires the org:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `org:write:all` */ deleteOrganizationLogo: ServiceOperationMutation<{ method: 'delete'; url: '/identity/v1/organizations/{organizationId}/logo'; security: ['APPToken', 'USERToken']; }, undefined, unknown, paths['/identity/v1/organizations/{organizationId}/logo']['delete']['parameters'], paths['/identity/v1/organizations/{organizationId}/logo']['delete']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/logo']['delete']['responses']['403']['content']['text/plain']>; /** * @summary Gets all applications for an organization. * @description **Token types:** APP, USER | **Required scopes:** `oidc:app:read` */ getOrganizationApplications: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/organizations/{organizationId}/oidc-applications'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/organizations/{organizationId}/oidc-applications']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/organizations/{organizationId}/oidc-applications']['get']['parameters'], paths['/identity/v1/organizations/{organizationId}/oidc-applications']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/oidc-applications']['get']['responses']['403']['content']['text/plain']>; /** * @summary Gets settings for an organization from Monite Platform. * @description Requires the organization:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `organization:read:org` */ getOrganizationSettings: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/organizations/{organizationId}/settings'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/organizations/{organizationId}/settings']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/organizations/{organizationId}/settings']['get']['parameters'], paths['/identity/v1/organizations/{organizationId}/settings']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/settings']['get']['responses']['403']['content']['text/plain']>; /** * @summary Updates settings for an organization in Monite Platform. * @description Requires the org:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `org:write:all` */ patchOrganizationSettings: ServiceOperationMutation<{ method: 'patch'; url: '/identity/v1/organizations/{organizationId}/settings'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/identity/v1/organizations/{organizationId}/settings']['patch']['responses']['200']['content']['text/plain'], paths['/identity/v1/organizations/{organizationId}/settings']['patch']['parameters'], paths['/identity/v1/organizations/{organizationId}/settings']['patch']['responses']['401']['content']['text/plain'] | paths['/identity/v1/organizations/{organizationId}/settings']['patch']['responses']['403']['content']['text/plain']>; /** * @summary Lists all roles for the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `role:read:org` */ listRoles: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/roles'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/roles']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/roles']['get']['parameters'], paths['/identity/v1/roles']['get']['responses']['400']['content']['text/plain'] | paths['/identity/v1/roles']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/roles']['get']['responses']['403']['content']['text/plain']>; /** * @summary Creates a new role in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `role:write:org` */ createRole: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/roles'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/identity/v1/roles']['post']['responses']['201']['content']['text/plain'], paths['/identity/v1/roles']['post']['parameters'], paths['/identity/v1/roles']['post']['responses']['400']['content']['text/plain'] | paths['/identity/v1/roles']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/roles']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/roles']['post']['responses']['409']['content']['text/plain']>; /** * @summary Gets a role by ID. * @description **Token types:** APP, USER | **Required scopes:** `role:read:org` */ getRole: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/roles/{roleId}'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/roles/{roleId}']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/roles/{roleId}']['get']['parameters'], paths['/identity/v1/roles/{roleId}']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}']['get']['responses']['403']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}']['get']['responses']['404']['content']['text/plain']>; /** * @summary Updates a role in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `role:write:org` */ updateRole: ServiceOperationMutation<{ method: 'patch'; url: '/identity/v1/roles/{roleId}'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/identity/v1/roles/{roleId}']['patch']['responses']['200']['content']['text/plain'], paths['/identity/v1/roles/{roleId}']['patch']['parameters'], paths['/identity/v1/roles/{roleId}']['patch']['responses']['400']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}']['patch']['responses']['401']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}']['patch']['responses']['403']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}']['patch']['responses']['404']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}']['patch']['responses']['409']['content']['text/plain']>; /** * @summary Deactivates a role in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `role:write:org` */ deleteRole: ServiceOperationMutation<{ method: 'delete'; url: '/identity/v1/roles/{roleId}'; security: ['APPToken', 'USERToken']; }, undefined, unknown, paths['/identity/v1/roles/{roleId}']['delete']['parameters'], paths['/identity/v1/roles/{roleId}']['delete']['responses']['401']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}']['delete']['responses']['403']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}']['delete']['responses']['404']['content']['text/plain']>; /** * @summary Lists all members assigned to a role in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `role:read:org` */ listRoleMembers: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/roles/{roleId}/members'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/roles/{roleId}/members']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/roles/{roleId}/members']['get']['parameters'], paths['/identity/v1/roles/{roleId}/members']['get']['responses']['400']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}/members']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}/members']['get']['responses']['403']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}/members']['get']['responses']['404']['content']['text/plain']>; /** * @summary Assigns or removes users (members) for a role in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `user:write:org` */ bulkUpdateRoleMembers: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/roles/{roleId}/members'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], unknown, paths['/identity/v1/roles/{roleId}/members']['post']['parameters'], paths['/identity/v1/roles/{roleId}/members']['post']['responses']['400']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}/members']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}/members']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}/members']['post']['responses']['404']['content']['text/plain']>; /** * @summary Lists all permissions assigned to a role. * @description **Token types:** APP, USER | **Required scopes:** `role:read:org` */ listRolePermissions: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/roles/{roleId}/permissions'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/roles/{roleId}/permissions']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/roles/{roleId}/permissions']['get']['parameters'], paths['/identity/v1/roles/{roleId}/permissions']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}/permissions']['get']['responses']['403']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}/permissions']['get']['responses']['404']['content']['text/plain']>; /** * @summary Assigns or removes permissions for a role in the caller's organization. * @description **Token types:** APP, USER | **Required scopes:** `role:write:org` */ bulkUpdateRolePermissions: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/roles/{roleId}/permissions'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], unknown, paths['/identity/v1/roles/{roleId}/permissions']['post']['parameters'], paths['/identity/v1/roles/{roleId}/permissions']['post']['responses']['400']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}/permissions']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}/permissions']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/roles/{roleId}/permissions']['post']['responses']['404']['content']['text/plain']>; /** * @summary Reads the opaque JSON value previously stored under the given key for the * authenticated user. */ getUserData: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/user-data/{key}'; security: ['HTTPBearer']; }, paths['/identity/v1/user-data/{key}']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/user-data/{key}']['get']['parameters'], paths['/identity/v1/user-data/{key}']['get']['responses']['400']['content']['text/plain'] | paths['/identity/v1/user-data/{key}']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/user-data/{key}']['get']['responses']['403']['content']['text/plain'] | paths['/identity/v1/user-data/{key}']['get']['responses']['404']['content']['text/plain']>; /** * @summary Upserts an opaque JSON value under the given key for the authenticated user. * The service stores and returns the value verbatim; it does not interpret or * validate its shape. */ upsertUserData: ServiceOperationMutation<{ method: 'put'; url: '/identity/v1/user-data/{key}'; mediaType: 'application/json'; security: ['HTTPBearer']; }, NonNullable['content']['application/json'], unknown, paths['/identity/v1/user-data/{key}']['put']['parameters'], paths['/identity/v1/user-data/{key}']['put']['responses']['400']['content']['text/plain'] | paths['/identity/v1/user-data/{key}']['put']['responses']['401']['content']['text/plain'] | paths['/identity/v1/user-data/{key}']['put']['responses']['403']['content']['text/plain'] | paths['/identity/v1/user-data/{key}']['put']['responses']['413']['content']['text/plain']>; /** * @summary Lists users from the target organization and all its descendants. * @description Returns users from the target organization AND all organizations below it in the hierarchy. * When X-Organization-ID header is provided, uses that org as target (if visible to caller). * When no header is provided, defaults to the caller's own organization. * Supports optional filtering by organization type, user status, reporting manager, and pagination. * Requires the user:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `user:read:org` */ getUsers: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/users'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/users']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/users']['get']['parameters'], paths['/identity/v1/users']['get']['responses']['400']['content']['text/plain'] | paths['/identity/v1/users']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/users']['get']['responses']['403']['content']['text/plain']>; /** * @summary Creates a new user in the specified organization. * @description Creates an ACTIVE or INVITED user in any organization accessible to the caller. * Requires the user:write:all scope. * * **Token types:** APP, USER | **Required scopes:** `user:write:all` */ createUser: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/users'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/identity/v1/users']['post']['responses']['201']['content']['text/plain'], paths['/identity/v1/users']['post']['parameters'], paths['/identity/v1/users']['post']['responses']['400']['content']['text/plain'] | paths['/identity/v1/users']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/users']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/users']['post']['responses']['422']['content']['text/plain']>; /** * @summary Gets the currently authenticated user's profile. * @description Resolves the caller from their JWT claims (user id, organization id, client id) and returns * their profile. */ getMe: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/users/me'; security: ['HTTPBearer']; }, paths['/identity/v1/users/me']['get']['responses']['200']['content']['text/plain'], undefined, paths['/identity/v1/users/me']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/users/me']['get']['responses']['403']['content']['text/plain'] | paths['/identity/v1/users/me']['get']['responses']['404']['content']['text/plain']>; /** * @summary Gets a single user from a downstream organization in the hierarchy. * @description Returns the user only if they belong to an organization below the caller in the hierarchy. * Requires the user:read:org scope. * * **Token types:** APP, USER | **Required scopes:** `user:read:org` */ getUser: ServiceOperationQuery<{ method: 'get'; url: '/identity/v1/users/{id}'; security: ['APPToken', 'USERToken']; }, paths['/identity/v1/users/{id}']['get']['responses']['200']['content']['text/plain'], paths['/identity/v1/users/{id}']['get']['parameters'], paths['/identity/v1/users/{id}']['get']['responses']['401']['content']['text/plain'] | paths['/identity/v1/users/{id}']['get']['responses']['403']['content']['text/plain'] | paths['/identity/v1/users/{id}']['get']['responses']['404']['content']['text/plain']>; /** * @summary Updates profile fields for a user in a downstream organization. * @description Requires user_profile:write:self (own org) or user_profile:write:all (cross-org). * A caller cannot update their own profile. * * **Token types:** APP, USER */ updateUser: ServiceOperationMutation<{ method: 'patch'; url: '/identity/v1/users/{id}'; mediaType: 'application/json'; security: ['APPToken', 'USERToken']; }, NonNullable['content']['application/json'], paths['/identity/v1/users/{id}']['patch']['responses']['200']['content']['text/plain'], paths['/identity/v1/users/{id}']['patch']['parameters'], paths['/identity/v1/users/{id}']['patch']['responses']['400']['content']['text/plain'] | paths['/identity/v1/users/{id}']['patch']['responses']['401']['content']['text/plain'] | paths['/identity/v1/users/{id}']['patch']['responses']['403']['content']['text/plain'] | paths['/identity/v1/users/{id}']['patch']['responses']['404']['content']['text/plain'] | paths['/identity/v1/users/{id}']['patch']['responses']['422']['content']['text/plain']>; /** * @summary Disables a user by setting their status to INACTIVE. * @description The target user must be visible in the caller's organization hierarchy. * Requires user:write:org scope. * * **Token types:** APP, USER | **Required scopes:** `user:write:org` */ disableUser: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/users/{userId}/disable'; security: ['APPToken', 'USERToken']; }, undefined, paths['/identity/v1/users/{userId}/disable']['post']['responses']['200']['content']['text/plain'], paths['/identity/v1/users/{userId}/disable']['post']['parameters'], paths['/identity/v1/users/{userId}/disable']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/users/{userId}/disable']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/users/{userId}/disable']['post']['responses']['404']['content']['text/plain']>; /** * @summary Enables a user by setting their status to ACTIVE. * @description The target user must be visible in the caller's organization hierarchy. * Requires user:write:org scope. * * **Token types:** APP, USER | **Required scopes:** `user:write:org` */ enableUser: ServiceOperationMutation<{ method: 'post'; url: '/identity/v1/users/{userId}/enable'; security: ['APPToken', 'USERToken']; }, undefined, paths['/identity/v1/users/{userId}/enable']['post']['responses']['200']['content']['text/plain'], paths['/identity/v1/users/{userId}/enable']['post']['parameters'], paths['/identity/v1/users/{userId}/enable']['post']['responses']['401']['content']['text/plain'] | paths['/identity/v1/users/{userId}/enable']['post']['responses']['403']['content']['text/plain'] | paths['/identity/v1/users/{userId}/enable']['post']['responses']['404']['content']['text/plain']>; } type Services = { api: ApiService; embeddedBanking: EmbeddedBankingService; files: FilesService; finops: FinopsService; identity: IdentityService; }; declare const FILTER_TYPE_SEARCH$3 = "search"; declare const FILTER_TYPE_TYPE$1 = "type"; declare const FILTER_TYPE_IS_CUSTOMER = "is_customer"; interface BaseCounterpartOCR { email: string; phone?: string; isCustomer: boolean; isVendor: boolean; line1: string; line2: string; city: string; state: string; postalCode: string; country?: components['schemas']['AllowedCountries']; } interface DefaultValuesOCR { tax_id: string; counterpart: T; } type DefaultValuesOCRIndividual = DefaultValuesOCR; type DefaultValuesOCROrganization = DefaultValuesOCR; /** * Represents the type of a counterpart in the system. */ type CustomerType = 'customer' | 'vendor'; /** * Array of available customer types, an array that should contain either customer, vendor, or both. * This array can't be empty and if only one option is passed, the customer type section will be hidden * and the default customer type will be the one passed. * It is set to undefined at component level but defaults to ['customer', 'vendor'] through componentSettings */ type CustomerTypes = CustomerType[]; interface GenericCounterpartContact { id: string; counterpart_id: string; /** * @description Is default contact person */ is_default?: boolean; /** @description The address of a contact person. */ address?: components['schemas']['CounterpartAddress']; /** * Format: email * @description The email address of a contact person. * @example contact@example.org */ email?: string; /** * @description The person's first name. * @example Adnan */ first_name: string; /** @description Indicates if the counterpart is a customer. */ is_customer: boolean; /** @description Indicates if the counterpart is a vendor. */ is_vendor: boolean; /** * @description The person's last name. * @example Singh */ last_name: string; /** * @description The person's phone number. * @example 5553211234 */ phone?: string; /** * @description The person's title or honorific. Examples: Mr., Ms., Dr., Prof. * @example Mr. */ title?: string; } type Filters$1 = { [FILTER_TYPE_SEARCH$3]?: string | null; [FILTER_TYPE_TYPE$1]?: components['schemas']['CounterpartType'] | null; [FILTER_TYPE_IS_CUSTOMER]?: string | null; }; type FilterValue$3 = components['schemas']['PayableStateEnum'] | 'all' | Date | string | null; type VendorDetailsProps = { counterpartId: string; customerType: CustomerType; open: boolean; isEditMode?: boolean; showActionsMenu?: boolean; onClose?: () => void; /** Enables the "Send a payment" button in vendor mode; the host owns navigation. */ onPayVendor?: (vendorId: string) => void; /** Enables the "Issue an invoice" button in customer mode; the host owns navigation. */ onCreateInvoiceForCustomer?: (customerId: string) => void; /** Shows the "View all" bills button in vendor mode; the host owns navigation. */ onViewVendorBills?: (vendorId: string) => void; /** Shows the "View all" invoices button in customer mode; the host owns navigation. */ onViewCustomerInvoices?: (customerId: string) => void; }; declare const CounterpartDetails: (props: VendorDetailsProps) => _emotion_react_jsx_runtime.JSX.Element; type CounterPartProps = { type: CustomerType; pageTitleComponent: (children: ReactNode) => ReactNode; /** Enables the "Send a payment" button in vendor details; the host owns navigation. */ onPayVendor?: (vendorId: string) => void; /** Enables the "Issue an invoice" button in customer details; the host owns navigation. */ onCreateInvoiceForCustomer?: (customerId: string) => void; /** Shows the "View all" bills button in vendor details; the host owns navigation. */ onViewVendorBills?: (vendorId: string) => void; /** Shows the "View all" invoices button in customer details; the host owns navigation. */ onViewCustomerInvoices?: (customerId: string) => void; }; declare const Counterparts: (props: CounterPartProps) => _emotion_react_jsx_runtime.JSX.Element; interface CounterpartsAutocompleteOptionProps { id: string; label: string; } interface CounterpartAutocompleteProps { control: Control; name: FieldPath; label: string; disabled?: boolean; required?: boolean; getCounterpartDefaultValues?: (type?: string) => DefaultValuesOCRIndividual | DefaultValuesOCROrganization; multiple?: boolean; customerType: CustomerType; counterpartRawName?: string; counterpartMatchingToOCR?: components['schemas']['CounterpartResponse']; counterpartAISuggested?: components['schemas']['CounterpartResponse']; /** * A counterpart to seed as a selectable option so an externally preselected * value (e.g. a cross-link that opens the create form with a vendor already * chosen) resolves its label even when it is not on the default list page. * Display-only: unlike the OCR/AI props it does not auto-select or render any * match UI. */ preselectedCounterpart?: components['schemas']['CounterpartResponse']; setShowEditCounterpartDialog?: (value: SetStateAction) => void; showEditCounterpartButton?: boolean; } declare const CounterpartAutocomplete: ({ control, name, label, required, getCounterpartDefaultValues, multiple, disabled, customerType, counterpartRawName, counterpartMatchingToOCR, counterpartAISuggested, preselectedCounterpart, setShowEditCounterpartDialog, showEditCounterpartButton, }: CounterpartAutocompleteProps) => _emotion_react_jsx_runtime.JSX.Element; interface VendorGridSortModel { field: components['schemas']['CounterpartCursorFields']; sort: NonNullable; } interface VendorsTableProps { onRowClick?: (id: string) => void; onChangeSort?: (params: VendorGridSortModel) => void; onChangeFilter?: (filter: { field: keyof Filters$1; value: FilterValue$3; }) => void; openModal?: (open: boolean) => void; } declare const VendorsTable: (props: VendorsTableProps) => _emotion_react_jsx_runtime.JSX.Element; interface CustomerGridSortModel { field: components['schemas']['CounterpartCursorFields']; sort: NonNullable; } interface CustomersTableProps { onRowClick?: (id: string) => void; onChangeSort?: (params: CustomerGridSortModel) => void; onChangeFilter?: (filter: { field: keyof Filters$1; value: FilterValue$3; }) => void; openModal?: (open: boolean) => void; } declare const CustomersTable: (props: CustomersTableProps) => _emotion_react_jsx_runtime.JSX.Element; declare const useCounterpartById: (id?: string) => _tanstack_react_query.UseQueryResult<{ id: string; created_at: string; updated_at: string; created_automatically: boolean; created_by_entity_user_id?: string; default_billing_address_id?: string; default_shipping_address_id?: string; external_reference?: string; individual: components["schemas"]["CounterpartIndividualResponse"]; is_customer: boolean; is_vendor: boolean; language?: components["schemas"]["LanguageCodeEnum"]; reminders_enabled?: boolean; tax_id?: string; type: components["schemas"]["CounterpartType"]; } | { id: string; created_at: string; updated_at: string; created_automatically: boolean; created_by_entity_user_id?: string; default_billing_address_id?: string; default_shipping_address_id?: string; external_reference?: string; is_customer: boolean; is_vendor: boolean; language?: components["schemas"]["LanguageCodeEnum"]; organization: components["schemas"]["CounterpartOrganizationResponse"]; reminders_enabled?: boolean; tax_id?: string; type: components["schemas"]["CounterpartType"]; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; type CounterpartResponse = components['schemas']['CounterpartIndividualRootResponse'] | components['schemas']['CounterpartOrganizationRootResponse']; declare const useCounterpartList: (parameters?: Services["finops"]["getCounterparts"]["types"]["parameters"]) => _tanstack_react_query.UseQueryResult<{ data: components["schemas"]["CounterpartResponse"][]; next_pagination_token?: string; prev_pagination_token?: string; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare const useCounterpartAddresses: (counterpartId?: string) => _tanstack_react_query.UseQueryResult<{ data: components["schemas"]["CounterpartAddressResponseWithCounterpartID"][]; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare const useCounterpartVatList: (counterpartId?: string) => _tanstack_react_query.UseQueryResult<{ data: components["schemas"]["CounterpartVatIDResponse"][]; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare const useCounterpartContactList: (counterpartId: string | undefined) => { data?: GenericCounterpartContact[]; error?: Error | { error: { message: string; }; } | { detail?: { loc: (string | number)[]; msg: string; type: string; }[] | undefined; } | null; isLoading: boolean; }; declare const useEntityUserById: (id: string | undefined) => _tanstack_react_query.UseQueryResult<{ id: string; created_at: string; updated_at: string; email?: string | null; first_name?: string; last_name?: string | null; login: string; phone?: string | null; status: components["schemas"]["StatusEnum"]; userpic_file_id?: string | null; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare const useEntityUserByAuthToken: () => _tanstack_react_query.UseQueryResult<{ id: string; created_at: string; updated_at: string; email?: string | null; first_name?: string; last_name?: string | null; login: string; phone?: string | null; status: components["schemas"]["StatusEnum"]; userpic_file_id?: string | null; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare const useApprovalPolicyById: (approvalPolicyId: string | undefined) => _tanstack_react_query.UseQueryResult<{ id: string; created_at: string; updated_at: string; created_by: string; description?: string; ends_at?: string; name: string; object_type: components["schemas"]["ObjectType"]; priority: number; script: (boolean | number | string | unknown[] | Record)[]; starts_at?: string; status: "active" | "pending"; trigger?: boolean | number | string | unknown[] | Record; updated_by?: string; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare const useFileById: (fileId: string | undefined) => _tanstack_react_query.UseQueryResult<{ id: string; created_at: string; updated_at: string; file_type: string; md5: string; mimetype: string; name: string; region: string; s3_bucket: string; s3_file_path: string; size: number; url: string; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare type DefaultError = Register extends { defaultError: infer TError; } ? TError : Error; declare type DefinedQueryObserverResult = QueryObserverRefetchErrorResult | QueryObserverSuccessResult; declare type FetchStatus = 'fetching' | 'paused' | 'idle'; declare interface QueryObserverBaseResult { /** * The last successfully resolved data for the query. */ data: TData | undefined; /** * The timestamp for when the query most recently returned the `status` as `"success"`. */ dataUpdatedAt: number; /** * The error object for the query, if an error was thrown. * - Defaults to `null`. */ error: TError | null; /** * The timestamp for when the query most recently returned the `status` as `"error"`. */ errorUpdatedAt: number; /** * The failure count for the query. * - Incremented every time the query fails. * - Reset to `0` when the query succeeds. */ failureCount: number; /** * The failure reason for the query retry. * - Reset to `null` when the query succeeds. */ failureReason: TError | null; /** * The sum of all errors. */ errorUpdateCount: number; /** * A derived boolean from the `status` variable, provided for convenience. * - `true` if the query attempt resulted in an error. */ isError: boolean; /** * Will be `true` if the query has been fetched. */ isFetched: boolean; /** * Will be `true` if the query has been fetched after the component mounted. * - This property can be used to not show any previously cached data. */ isFetchedAfterMount: boolean; /** * A derived boolean from the `fetchStatus` variable, provided for convenience. * - `true` whenever the `queryFn` is executing, which includes initial `pending` as well as background refetch. */ isFetching: boolean; /** * Is `true` whenever the first fetch for a query is in-flight. * - Is the same as `isFetching && isPending`. */ isLoading: boolean; /** * Will be `pending` if there's no cached data and no query attempt was finished yet. */ isPending: boolean; /** * Will be `true` if the query failed while fetching for the first time. */ isLoadingError: boolean; /** * @deprecated `isInitialLoading` is being deprecated in favor of `isLoading` * and will be removed in the next major version. */ isInitialLoading: boolean; /** * A derived boolean from the `fetchStatus` variable, provided for convenience. * - The query wanted to fetch, but has been `paused`. */ isPaused: boolean; /** * Will be `true` if the data shown is the placeholder data. */ isPlaceholderData: boolean; /** * Will be `true` if the query failed while refetching. */ isRefetchError: boolean; /** * Is `true` whenever a background refetch is in-flight, which _does not_ include initial `pending`. * - Is the same as `isFetching && !isPending`. */ isRefetching: boolean; /** * Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`. */ isStale: boolean; /** * A derived boolean from the `status` variable, provided for convenience. * - `true` if the query has received a response with no errors and is ready to display its data. */ isSuccess: boolean; /** * `true` if this observer is enabled, `false` otherwise. */ isEnabled: boolean; /** * A function to manually refetch the query. */ refetch: (options?: RefetchOptions) => Promise>; /** * The status of the query. * - Will be: * - `pending` if there's no cached data and no query attempt was finished yet. * - `error` if the query attempt resulted in an error. * - `success` if the query has received a response with no errors and is ready to display its data. */ status: QueryStatus; /** * The fetch status of the query. * - `fetching`: Is `true` whenever the queryFn is executing, which includes initial `pending` as well as background refetch. * - `paused`: The query wanted to fetch, but has been `paused`. * - `idle`: The query is not fetching. * - See [Network Mode](https://tanstack.com/query/latest/docs/framework/react/guides/network-mode) for more information. */ fetchStatus: FetchStatus; /** * A stable promise that will be resolved with the data of the query. * Requires the `experimental_prefetchInRender` feature flag to be enabled. * @example * * ### Enabling the feature flag * ```ts * const client = new QueryClient({ * defaultOptions: { * queries: { * experimental_prefetchInRender: true, * }, * }, * }) * ``` * * ### Usage * ```tsx * import { useQuery } from '@tanstack/react-query' * import React from 'react' * import { fetchTodos, type Todo } from './api' * * function TodoList({ query }: { query: UseQueryResult }) { * const data = React.use(query.promise) * * return ( *
    * {data.map(todo => ( *
  • {todo.title}
    • * ))} *
* ) * } * * export function App() { * const query = useQuery({ queryKey: ['todos'], queryFn: fetchTodos }) * * return ( * <> *

Todos

* Loading...}> * * * * ) * } * ``` */ promise: Promise; } declare interface QueryObserverLoadingErrorResult extends QueryObserverBaseResult { data: undefined; error: TError; isError: true; isPending: false; isLoading: false; isLoadingError: true; isRefetchError: false; isSuccess: false; isPlaceholderData: false; status: 'error'; } declare interface QueryObserverLoadingResult extends QueryObserverBaseResult { data: undefined; error: null; isError: false; isPending: true; isLoading: true; isLoadingError: false; isRefetchError: false; isSuccess: false; isPlaceholderData: false; status: 'pending'; } declare interface QueryObserverPendingResult extends QueryObserverBaseResult { data: undefined; error: null; isError: false; isPending: true; isLoadingError: false; isRefetchError: false; isSuccess: false; isPlaceholderData: false; status: 'pending'; } declare interface QueryObserverPlaceholderResult extends QueryObserverBaseResult { data: TData; isError: false; error: null; isPending: false; isLoading: false; isLoadingError: false; isRefetchError: false; isSuccess: true; isPlaceholderData: true; status: 'success'; } declare interface QueryObserverRefetchErrorResult extends QueryObserverBaseResult { data: TData; error: TError; isError: true; isPending: false; isLoading: false; isLoadingError: false; isRefetchError: true; isSuccess: false; isPlaceholderData: false; status: 'error'; } declare type QueryObserverResult = DefinedQueryObserverResult | QueryObserverLoadingErrorResult | QueryObserverLoadingResult | QueryObserverPendingResult | QueryObserverPlaceholderResult; declare interface QueryObserverSuccessResult extends QueryObserverBaseResult { data: TData; error: null; isError: false; isPending: false; isLoading: false; isLoadingError: false; isRefetchError: false; isSuccess: true; isPlaceholderData: false; status: 'success'; } declare type QueryStatus = 'pending' | 'error' | 'success'; declare interface RefetchOptions extends ResultOptions { /** * If set to `true`, a currently running request will be cancelled before a new request is made * * If set to `false`, no refetch will be made if there is already a request running. * * Defaults to `true`. */ cancelRefetch?: boolean; } declare interface Register { } declare interface ResultOptions { throwOnError?: boolean; } /** * @note We are deviating from the default query configuration because the data * does not require frequent refetching or retries as the data fetched * (user entity information) is relatively static * * @returns {QueryResult} The result of the user entity fetch. */ declare const useMe: () => _tanstack_react_query.UseQueryResult<{ id: string; created_at: string; updated_at: string; email?: string | null; first_name?: string; last_name?: string | null; login: string; phone?: string | null; status: components["schemas"]["StatusEnum"]; userpic_file_id?: string | null; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare const useMyEntity: () => { entityName: string; isNonVatSupported: boolean; isUSEntity: boolean; isNonCompliantFlow: boolean; data: { id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; individual: components["schemas"]["IndividualResponseSchema"]; logo?: components["schemas"]["FileSchema2"] | null; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "individual"; website?: string | null; } | { id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; logo?: components["schemas"]["FileSchema2"] | null; organization: components["schemas"]["OrganizationResponseSchema"]; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "organization"; website?: string | null; }; error: { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error; isError: true; isPending: false; isLoading: false; isLoadingError: false; isRefetchError: true; isSuccess: false; isPlaceholderData: false; status: "error"; dataUpdatedAt: number; errorUpdatedAt: number; failureCount: number; failureReason: { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error | null; errorUpdateCount: number; isFetched: boolean; isFetchedAfterMount: boolean; isFetching: boolean; isInitialLoading: boolean; isPaused: boolean; isRefetching: boolean; isStale: boolean; isEnabled: boolean; refetch: (options?: RefetchOptions) => Promise>; fetchStatus: FetchStatus; promise: Promise<{ id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; individual: components["schemas"]["IndividualResponseSchema"]; logo?: components["schemas"]["FileSchema2"] | null; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "individual"; website?: string | null; } | { id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; logo?: components["schemas"]["FileSchema2"] | null; organization: components["schemas"]["OrganizationResponseSchema"]; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "organization"; website?: string | null; }>; } | { entityName: string; isNonVatSupported: boolean; isUSEntity: boolean; isNonCompliantFlow: boolean; data: { id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; individual: components["schemas"]["IndividualResponseSchema"]; logo?: components["schemas"]["FileSchema2"] | null; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "individual"; website?: string | null; } | { id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; logo?: components["schemas"]["FileSchema2"] | null; organization: components["schemas"]["OrganizationResponseSchema"]; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "organization"; website?: string | null; }; error: null; isError: false; isPending: false; isLoading: false; isLoadingError: false; isRefetchError: false; isSuccess: true; isPlaceholderData: false; status: "success"; dataUpdatedAt: number; errorUpdatedAt: number; failureCount: number; failureReason: { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error | null; errorUpdateCount: number; isFetched: boolean; isFetchedAfterMount: boolean; isFetching: boolean; isInitialLoading: boolean; isPaused: boolean; isRefetching: boolean; isStale: boolean; isEnabled: boolean; refetch: (options?: RefetchOptions) => Promise>; fetchStatus: FetchStatus; promise: Promise<{ id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; individual: components["schemas"]["IndividualResponseSchema"]; logo?: components["schemas"]["FileSchema2"] | null; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "individual"; website?: string | null; } | { id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; logo?: components["schemas"]["FileSchema2"] | null; organization: components["schemas"]["OrganizationResponseSchema"]; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "organization"; website?: string | null; }>; } | { entityName: string; isNonVatSupported: boolean; isUSEntity: boolean; isNonCompliantFlow: boolean; data: undefined; error: { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error; isError: true; isPending: false; isLoading: false; isLoadingError: true; isRefetchError: false; isSuccess: false; isPlaceholderData: false; status: "error"; dataUpdatedAt: number; errorUpdatedAt: number; failureCount: number; failureReason: { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error | null; errorUpdateCount: number; isFetched: boolean; isFetchedAfterMount: boolean; isFetching: boolean; isInitialLoading: boolean; isPaused: boolean; isRefetching: boolean; isStale: boolean; isEnabled: boolean; refetch: (options?: RefetchOptions) => Promise>; fetchStatus: FetchStatus; promise: Promise<{ id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; individual: components["schemas"]["IndividualResponseSchema"]; logo?: components["schemas"]["FileSchema2"] | null; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "individual"; website?: string | null; } | { id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; logo?: components["schemas"]["FileSchema2"] | null; organization: components["schemas"]["OrganizationResponseSchema"]; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "organization"; website?: string | null; }>; } | { entityName: string; isNonVatSupported: boolean; isUSEntity: boolean; isNonCompliantFlow: boolean; data: undefined; error: null; isError: false; isPending: true; isLoading: true; isLoadingError: false; isRefetchError: false; isSuccess: false; isPlaceholderData: false; status: "pending"; dataUpdatedAt: number; errorUpdatedAt: number; failureCount: number; failureReason: { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error | null; errorUpdateCount: number; isFetched: boolean; isFetchedAfterMount: boolean; isFetching: boolean; isInitialLoading: boolean; isPaused: boolean; isRefetching: boolean; isStale: boolean; isEnabled: boolean; refetch: (options?: RefetchOptions) => Promise>; fetchStatus: FetchStatus; promise: Promise<{ id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; individual: components["schemas"]["IndividualResponseSchema"]; logo?: components["schemas"]["FileSchema2"] | null; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "individual"; website?: string | null; } | { id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; logo?: components["schemas"]["FileSchema2"] | null; organization: components["schemas"]["OrganizationResponseSchema"]; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "organization"; website?: string | null; }>; } | { entityName: string; isNonVatSupported: boolean; isUSEntity: boolean; isNonCompliantFlow: boolean; data: undefined; error: null; isError: false; isPending: true; isLoadingError: false; isRefetchError: false; isSuccess: false; isPlaceholderData: false; status: "pending"; dataUpdatedAt: number; errorUpdatedAt: number; failureCount: number; failureReason: { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error | null; errorUpdateCount: number; isFetched: boolean; isFetchedAfterMount: boolean; isFetching: boolean; isLoading: boolean; isInitialLoading: boolean; isPaused: boolean; isRefetching: boolean; isStale: boolean; isEnabled: boolean; refetch: (options?: RefetchOptions) => Promise>; fetchStatus: FetchStatus; promise: Promise<{ id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; individual: components["schemas"]["IndividualResponseSchema"]; logo?: components["schemas"]["FileSchema2"] | null; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "individual"; website?: string | null; } | { id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; logo?: components["schemas"]["FileSchema2"] | null; organization: components["schemas"]["OrganizationResponseSchema"]; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "organization"; website?: string | null; }>; } | { entityName: string; isNonVatSupported: boolean; isUSEntity: boolean; isNonCompliantFlow: boolean; data: { id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; individual: components["schemas"]["IndividualResponseSchema"]; logo?: components["schemas"]["FileSchema2"] | null; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "individual"; website?: string | null; } | { id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; logo?: components["schemas"]["FileSchema2"] | null; organization: components["schemas"]["OrganizationResponseSchema"]; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "organization"; website?: string | null; }; isError: false; error: null; isPending: false; isLoading: false; isLoadingError: false; isRefetchError: false; isSuccess: true; isPlaceholderData: true; status: "success"; dataUpdatedAt: number; errorUpdatedAt: number; failureCount: number; failureReason: { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error | null; errorUpdateCount: number; isFetched: boolean; isFetchedAfterMount: boolean; isFetching: boolean; isInitialLoading: boolean; isPaused: boolean; isRefetching: boolean; isStale: boolean; isEnabled: boolean; refetch: (options?: RefetchOptions) => Promise>; fetchStatus: FetchStatus; promise: Promise<{ id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; individual: components["schemas"]["IndividualResponseSchema"]; logo?: components["schemas"]["FileSchema2"] | null; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "individual"; website?: string | null; } | { id: string; created_at: string; updated_at: string; address: components["schemas"]["EntityAddressResponseSchema"]; email?: string | null; logo?: components["schemas"]["FileSchema2"] | null; organization: components["schemas"]["OrganizationResponseSchema"]; phone?: string | null; registration_authority?: string | null; registration_number?: string | null; status: components["schemas"]["EntityStatusEnum"]; tax_id?: string | null; type: "organization"; website?: string | null; }>; }; declare const getEntityName: (entity?: EntityResponse) => string; type OptionalFields = { invoiceDate?: boolean; tags?: boolean; }; type OcrRequiredField = 'currency' | 'invoiceDate' | 'counterpart' | 'invoiceNumber' | 'counterpartBankAccount' | 'document_issued_at_date' | 'dueDate' | 'tags' | 'counterpartName' | 'contactPerson' | 'issueDate' | 'amount' | 'appliedPolicy' | 'addedByUser' | 'addedOn' | 'updatedOn'; type OcrRequiredFields = Partial> | undefined; type PaymentRecordWithIntent = { intent: string; record: components['schemas']['PaymentRecordResponse']; }; declare const usePaymentRecords: (query: Services["finops"]["getPaymentRecords"]["types"]["parameters"]["query"], enabled?: boolean) => _tanstack_react_query.UseQueryResult<{ data: components["schemas"]["PaymentRecordResponse"][]; next_pagination_token?: string; prev_pagination_token?: string; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; /** * Hook to fetch payment records for a list of payables. * Sorts the payment records by paid_at in descending order. * * @param payableIds - Array of payable IDs to fetch payment records for * @returns {Object} * - payablesPaymentIntentsRecord: Payment intents with most recent record per intent, grouped by payable ID * - isLoading: Loading state boolean * - error: Error state if request fails * * Example data returned in payablesPaymentIntentsRecord: * ``` * { * "payable-id-1": [ * { intent: "payment-intent-id-1", record: record2 }, * { intent: "payment-intent-id-2", record: record3 } * ], * "payable-id-2": [ * { intent: "payment-intent-id-3", record: record6 }, * { intent: "payment-intent-id-4", record: record8 } * ] * } * ``` */ declare const usePayablePaymentIntentsAndRecords: (payableIds?: string[]) => { allPaymentRecords: { id: string; amount: number; currency: components["schemas"]["CurrencyEnum"]; entity_user_id?: string; history: components["schemas"]["PaymentRecordHistoryResponse"][]; is_external: boolean; object: components["schemas"]["PaymentRecordObjectResponse"]; overpaid_amount: number; paid_at?: string; payment_intent_id?: string; payment_intent_status?: string; payment_method?: string; planned_payment_date?: string; status: string; }[] | undefined; payablesPaymentIntentsRecord: Record; isLoading: boolean; error: { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error | null; refetch: () => void; }; declare const useCreatePaymentRecord: () => _tanstack_react_query.UseMutationResult<{ id: string; amount: number; currency: components["schemas"]["CurrencyEnum"]; entity_user_id?: string; history: components["schemas"]["PaymentRecordHistoryResponse"][]; is_external: boolean; object: components["schemas"]["PaymentRecordObjectResponse"]; overpaid_amount: number; paid_at?: string; payment_intent_id?: string; payment_intent_status?: string; payment_method?: string; planned_payment_date?: string; status: string; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, { amount: number; currency: components["schemas"]["CurrencyEnum"]; entity_user_id?: string; object: components["schemas"]["PaymentRecordObjectRequest"]; paid_at?: string; payment_intent_id?: string; payment_intent_status?: string; payment_method?: string; planned_payment_date?: string; status: "created" | "processing" | "succeeded"; }, unknown>; declare const usePaymentRecordById: (payment_record_id: string) => _tanstack_react_query.UseQueryResult<{ id: string; amount: number; currency: components["schemas"]["CurrencyEnum"]; entity_user_id?: string; history: components["schemas"]["PaymentRecordHistoryResponse"][]; is_external: boolean; object: components["schemas"]["PaymentRecordObjectResponse"]; overpaid_amount: number; paid_at?: string; payment_intent_id?: string; payment_intent_status?: string; payment_method?: string; planned_payment_date?: string; status: string; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare const usePaymentIntentById: (payment_intent_id: string) => _tanstack_react_query.UseQueryResult<{ id: string; updated_at: string; amount: number; application_fee_amount?: number; batch_payment_id?: string; currency: string; invoice?: components["schemas"]["Invoice"]; object?: components["schemas"]["PaymentObject"]; payer?: components["schemas"]["PayerAccountResponse"]; payment_link_id?: string; payment_methods: components["schemas"]["MoniteAllPaymentMethodsTypes"][]; payment_reference?: string; provider?: string; recipient: components["schemas"]["RecipientAccountResponse"]; selected_payment_method?: components["schemas"]["MoniteAllPaymentMethodsTypes"]; status: string; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare const usePatchEntitiesIdSettings: () => _tanstack_react_query.UseMutationResult<{ accounting?: components["schemas"]["AccountingSettings"] | null; allow_purchase_order_autolinking: boolean | null; currency?: components["schemas"]["CurrencySettings-Output2"] | null; default_bank_account?: components["schemas"]["DefaultBankAccount"] | null; document_ids?: components["schemas"]["DocumentIDsSettings"] | null; document_rendering?: components["schemas"]["DocumentRenderingSettings-Output"]; generate_paid_invoice_pdf: boolean; language?: components["schemas"]["LanguageCodeEnum"] | null; mail?: components["schemas"]["EntityMailSettings"] | null; payables_ocr_auto_tagging?: components["schemas"]["OcrAutoTaggingSettingsRequest"][] | null; payables_skip_approval_flow: boolean; payment_priority: components["schemas"]["PaymentPriorityEnum"] | null; quote_signature_required: boolean; receivable_edit_flow: components["schemas"]["ReceivableEditFlow"] | null; reminder?: components["schemas"]["RemindersSettings"] | null; tax_inclusive_discount_mode: components["schemas"]["VatModeEnum"]; tax_mode: components["schemas"]["VatModeEnum"] | null; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, { accounting?: components["schemas"]["AccountingSettings"] | null; allow_purchase_order_autolinking: boolean | null; currency?: components["schemas"]["CurrencySettings-Input2"] | null; default_bank_account?: components["schemas"]["DefaultBankAccount"] | null; document_ids?: components["schemas"]["DocumentIDsSettingsRequest"] | null; document_rendering?: components["schemas"]["DocumentRenderingSettings-Input"]; generate_paid_invoice_pdf: boolean; language?: components["schemas"]["LanguageCodeEnum"] | null; mail?: components["schemas"]["EntityMailSettings"] | null; payables_ocr_auto_tagging?: components["schemas"]["OcrAutoTaggingSettingsRequest"][] | null; payables_skip_approval_flow: boolean; payment_priority: components["schemas"]["PaymentPriorityEnum"] | null; quote_signature_required: boolean; receivable_edit_flow: components["schemas"]["ReceivableEditFlow"] | null; reminder?: components["schemas"]["RemindersSettings"] | null; tax_inclusive_discount_mode: components["schemas"]["VatModeEnum"]; tax_mode: components["schemas"]["VatModeEnum"] | null; }, unknown>; declare const useEntitySettings: (enabled?: boolean) => _tanstack_react_query.UseQueryResult<{ accounting?: components["schemas"]["AccountingSettings"] | null; allow_purchase_order_autolinking: boolean | null; currency?: components["schemas"]["CurrencySettings-Output2"] | null; default_bank_account?: components["schemas"]["DefaultBankAccount"] | null; document_ids?: components["schemas"]["DocumentIDsSettings"] | null; document_rendering?: components["schemas"]["DocumentRenderingSettings-Output"]; generate_paid_invoice_pdf: boolean; language?: components["schemas"]["LanguageCodeEnum"] | null; mail?: components["schemas"]["EntityMailSettings"] | null; payables_ocr_auto_tagging?: components["schemas"]["OcrAutoTaggingSettingsRequest"][] | null; payables_skip_approval_flow: boolean; payment_priority: components["schemas"]["PaymentPriorityEnum"] | null; quote_signature_required: boolean; receivable_edit_flow: components["schemas"]["ReceivableEditFlow"] | null; reminder?: components["schemas"]["RemindersSettings"] | null; tax_inclusive_discount_mode: components["schemas"]["VatModeEnum"]; tax_mode: components["schemas"]["VatModeEnum"] | null; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; /** * Fetches receivable by provided `id` * * @see {@link https://docs.monite.com/reference/get_receivables_id} Monite backend call API */ declare const useGetReceivableById: (receivable_id: string, enabled?: boolean) => _tanstack_react_query.UseQueryResult<{ id: string; created_at: string; updated_at: string; attachments?: components["schemas"]["AttachmentResponse"][]; bank_account_id?: string; bank_account_snapshot?: components["schemas"]["BankAccountSnapshot"]; bank_account_type?: string; based_on?: string; based_on_document_id?: string; commercial_condition_description?: string; counterpart_billing_address?: components["schemas"]["ReceivablesRepresentationOfCounterpartAddress"]; counterpart_business_type?: string; counterpart_contact?: components["schemas"]["ReceivableCounterpartContact"]; counterpart_external_reference?: string; counterpart_id: string; counterpart_name?: string; counterpart_shipping_address?: components["schemas"]["ReceivablesRepresentationOfCounterpartAddress"]; counterpart_tax_id?: string; counterpart_type: components["schemas"]["CounterpartType"]; counterpart_vat_id?: components["schemas"]["ReceivableCounterpartVatIDResponse"]; currency: components["schemas"]["CurrencyEnum"]; deduction_amount?: number; deduction_memo?: string; deductions?: components["schemas"]["DeductionItem"][]; discount?: components["schemas"]["DiscountResponse"]; discounted_subtotal?: number; document_id?: string; document_rendering?: components["schemas"]["DocumentRenderingSettings"]; due_date?: string; entity: components["schemas"]["ReceivableEntityOrganization"] | components["schemas"]["ReceivableEntityIndividual"]; entity_address: components["schemas"]["ReceivableEntityAddressSchema"]; entity_bank_account?: components["schemas"]["ReceivablesRepresentationOfEntityBankAccount"]; entity_user_id?: string; entity_vat_id?: components["schemas"]["ReceivableEntityVatIDResponse"]; file_language: components["schemas"]["LanguageCodeEnum"]; file_url?: string; footer?: string; issue_date?: string; line_items: components["schemas"]["ResponseItem"][]; memo?: string; original_file_language: components["schemas"]["LanguageCodeEnum"]; original_file_url?: string; partner_metadata?: Record; project_id?: string; purchase_order?: string; status: components["schemas"]["CreditNoteStateEnum"]; subtotal?: number; subtotal_after_tax?: number; tags: components["schemas"]["TagReadSchema"][]; tax_exempt?: boolean; tax_exemption_rationale?: string; tax_inclusive_discount_mode: components["schemas"]["VatModeEnum"]; tax_mode: components["schemas"]["VatModeEnum"]; total_amount: number; total_deduction_amount?: number; total_tax_amount: number; total_tax_amounts?: components["schemas"]["TotalTaxAmountItem"][]; total_withholding_tax?: number; trade_name?: string; type: "credit_note"; withholding_tax_rate?: number; } | { id: string; created_at: string; updated_at: string; amount_due: number; amount_paid: number; amount_to_pay?: number; attachments?: components["schemas"]["AttachmentResponse"][]; bank_account_id?: string; bank_account_snapshot?: components["schemas"]["BankAccountSnapshot"]; bank_account_type?: string; based_on?: string; based_on_document_id?: string; comment?: string; commercial_condition_description?: string; counterpart_billing_address?: components["schemas"]["ReceivablesRepresentationOfCounterpartAddress"]; counterpart_business_type?: string; counterpart_contact?: components["schemas"]["ReceivableCounterpartContact"]; counterpart_external_reference?: string; counterpart_id: string; counterpart_name?: string; counterpart_shipping_address?: components["schemas"]["ReceivablesRepresentationOfCounterpartAddress"]; counterpart_tax_id?: string; counterpart_type: components["schemas"]["CounterpartType"]; counterpart_vat_id?: components["schemas"]["ReceivableCounterpartVatIDResponse"]; currency: components["schemas"]["CurrencyEnum"]; deduction_amount?: number; deduction_memo?: string; deductions?: components["schemas"]["DeductionItem"][]; discount?: components["schemas"]["DiscountResponse"]; discounted_subtotal?: number; document_id?: string; document_rendering?: components["schemas"]["DocumentRenderingSettings"]; due_date?: string; entity: components["schemas"]["ReceivableEntityOrganization"] | components["schemas"]["ReceivableEntityIndividual"]; entity_address: components["schemas"]["ReceivableEntityAddressSchema"]; entity_bank_account?: components["schemas"]["ReceivablesRepresentationOfEntityBankAccount"]; entity_user_id?: string; entity_vat_id?: components["schemas"]["ReceivableEntityVatIDResponse"]; file_language: components["schemas"]["LanguageCodeEnum"]; file_url?: string; footer?: string; fulfillment_date?: string; issue_date?: string; line_items: components["schemas"]["ResponseItem"][]; memo?: string; original_file_language: components["schemas"]["LanguageCodeEnum"]; original_file_url?: string; overdue_reminder_id?: string; paid_at?: string; partner_metadata?: Record; payment_page_url?: string; payment_reminder_id?: string; payment_terms?: components["schemas"]["PaymentTerms"]; project_id?: string; purchase_order?: string; recurrence_id?: string; related_documents: components["schemas"]["RelatedDocuments"]; status: components["schemas"]["ReceivablesStatusEnum"]; subtotal?: number; subtotal_after_tax?: number; tags: components["schemas"]["TagReadSchema"][]; tax_exempt?: boolean; tax_exemption_rationale?: string; tax_inclusive_discount_mode: components["schemas"]["VatModeEnum"]; tax_mode: components["schemas"]["VatModeEnum"]; total_amount: number; total_amount_with_credit_notes: number; total_deduction_amount?: number; total_tax_amount: number; total_tax_amounts?: components["schemas"]["TotalTaxAmountItem"][]; total_withholding_tax?: number; trade_name?: string; type: "invoice"; withholding_tax_rate?: number; } | { id: string; created_at: string; updated_at: string; attachments?: components["schemas"]["AttachmentResponse"][]; bank_account_id?: string; bank_account_snapshot?: components["schemas"]["BankAccountSnapshot"]; bank_account_type?: string; based_on?: string; based_on_document_id?: string; comment?: string; commercial_condition_description?: string; counterpart_billing_address?: components["schemas"]["ReceivablesRepresentationOfCounterpartAddress"]; counterpart_business_type?: string; counterpart_contact?: components["schemas"]["ReceivableCounterpartContact"]; counterpart_external_reference?: string; counterpart_id: string; counterpart_name?: string; counterpart_shipping_address?: components["schemas"]["ReceivablesRepresentationOfCounterpartAddress"]; counterpart_tax_id?: string; counterpart_type: components["schemas"]["CounterpartType"]; counterpart_vat_id?: components["schemas"]["ReceivableCounterpartVatIDResponse"]; currency: components["schemas"]["CurrencyEnum"]; deduction_amount?: number; deduction_memo?: string; deductions?: components["schemas"]["DeductionItem"][]; discount?: components["schemas"]["DiscountResponse"]; discounted_subtotal?: number; document_id?: string; document_rendering?: components["schemas"]["DocumentRenderingSettings"]; due_date?: string; entity: components["schemas"]["ReceivableEntityOrganization"] | components["schemas"]["ReceivableEntityIndividual"]; entity_address: components["schemas"]["ReceivableEntityAddressSchema"]; entity_bank_account?: components["schemas"]["ReceivablesRepresentationOfEntityBankAccount"]; entity_user_id?: string; entity_vat_id?: components["schemas"]["ReceivableEntityVatIDResponse"]; expiry_date?: string; file_language: components["schemas"]["LanguageCodeEnum"]; file_url?: string; footer?: string; issue_date?: string; line_items: components["schemas"]["ResponseItem"][]; memo?: string; original_file_language: components["schemas"]["LanguageCodeEnum"]; original_file_url?: string; partner_metadata?: Record; project_id?: string; quote_accept_page_url?: string; signature_required?: boolean; status: components["schemas"]["QuoteStateEnum"]; subtotal?: number; subtotal_after_tax?: number; tags: components["schemas"]["TagReadSchema"][]; tax_exempt?: boolean; tax_exemption_rationale?: string; tax_inclusive_discount_mode: components["schemas"]["VatModeEnum"]; tax_mode: components["schemas"]["VatModeEnum"]; total_amount: number; total_deduction_amount?: number; total_tax_amount: number; total_tax_amounts?: components["schemas"]["TotalTaxAmountItem"][]; total_withholding_tax?: number; trade_name?: string; type: "quote"; withholding_tax_rate?: number; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare function getCounterpartName(counterpart: CounterpartResponse | undefined): string; type EntityResponse = components['schemas']['EntityOrganizationResponse'] | components['schemas']['EntityIndividualResponse']; interface ApprovalPolicyDetailsProps { /** Approval policy ID */ id?: string; /** Callback is fired when a policy is created and sync with server is successful * * @param id - the ID of the created policy */ onCreated?: (id: string) => void; /** Callback is fired when a policy is updated and sync with server is successful * * @param id - the ID of the updated policy */ onUpdated?: (id: string) => void; } /** * ApprovalPolicyDetails component * * This component renders the approval policy details form. It includes fields for the policy name, description, trigger, and script. * The `useApprovalPolicyDetails` hook is used to handle the creation of a new approval policy. * */ declare const ApprovalPolicyDetails: ({ id, onCreated, onUpdated, }: ApprovalPolicyDetailsProps) => _emotion_react_jsx_runtime.JSX.Element; type API = Services; interface CreateMoniteAPIClientResult { requestFn: typeof requestFn; api: API; version: string; } interface CreateMoniteAPIClientOptions { context?: Context; /** Custom headers to include in every request (e.g. x-widget-token) */ customHeaders?: Record; } declare const createAPIClient: ({ customHeaders, ...qraftClientOptions }?: CreateMoniteAPIClientOptions | undefined) => CreateMoniteAPIClientResult; type FilterTypes$1 = Partial<{ [FILTER_TYPE_SEARCH$2]: string | null; [FILTER_TYPE_STATUS]: components['schemas']['PayableStateEnum'] | null; [FILTER_TYPE_DUE_DATE]: Date | null; [FILTER_TYPE_SUMMARY_CARD]: PayablesTabFilter | null; }>; type FilterValue$2 = components['schemas']['PayableStateEnum'] | 'all' | Date | string | null; type FieldValueTypes = 'counterpart_id' | 'document_id' | 'amount' | 'due_date' | 'was_created_by_user_id' | 'created_at' | 'issued_at' | 'status' | 'pay'; interface MonitePayableTableProps { isShowingSummaryCards?: boolean; fieldOrder?: [FieldValueTypes, ...FieldValueTypes[]]; summaryCardFilters?: Record; requiredColumns?: [FieldValueTypes, ...FieldValueTypes[]]; displayColumns?: [FieldValueTypes, ...FieldValueTypes[]]; } type PayablesTabFilter = NonNullable; declare const FILTER_TYPE_SEARCH$2 = "search"; declare const FILTER_TYPE_STATUS = "status"; declare const FILTER_TYPE_CREATED_AT = "created_at"; declare const FILTER_TYPE_DUE_DATE = "due_date"; declare const FILTER_TYPE_SUMMARY_CARD = "summary_card_filter"; /** * The single invoice-form validation schema, used by both the create and the * edit flows. The two flows render the same sections and carry the same form * shape (`CreateReceivablesFormProps`); the only differences between POST and * PATCH — line-item transport, `purchase_order` not being PATCHable, `type` * being create-only — are handled at serialization time in each flow's * `persistDraft`, not here. Keeping one schema means a rule added for create is * automatically enforced on edit. */ declare const getInvoiceValidationSchema: (i18n: I18n, shouldEnableBankAccount: boolean, canCreateCounterpart?: boolean, minRecurrenceOccurrences?: number) => z.ZodObject<{ counterpart_id: z.ZodOptional; counterpart_name: z.ZodOptional; counterpart_email: z.ZodOptional]>>; entity_vat_id_id: z.ZodOptional; purchase_order: z.ZodOptional; terms_and_conditions: z.ZodOptional; default_billing_address_id: z.ZodOptional; default_shipping_address_id: z.ZodOptional; tax_rate: z.ZodOptional; memo: z.ZodOptional; payment_terms_id: z.ZodString; payment_terms_custom_date: z.ZodOptional>; footer: z.ZodOptional; line_items: z.ZodArray; quantity: z.ZodNumber; product_id: z.ZodOptional; taxable: z.ZodOptional; product: z.ZodObject<{ name: z.ZodString; description: z.ZodOptional; price: z.ZodObject<{ currency: z.ZodEnum<{ BTN: "BTN"; MKD: "MKD"; SLE: "SLE"; AED: "AED"; AFN: "AFN"; ALL: "ALL"; AMD: "AMD"; ANG: "ANG"; AOA: "AOA"; ARS: "ARS"; AUD: "AUD"; AWG: "AWG"; AZN: "AZN"; BAM: "BAM"; BBD: "BBD"; BDT: "BDT"; BGN: "BGN"; BHD: "BHD"; BIF: "BIF"; BMD: "BMD"; BND: "BND"; BOB: "BOB"; BRL: "BRL"; BSD: "BSD"; BWP: "BWP"; BYN: "BYN"; BZD: "BZD"; CAD: "CAD"; CDF: "CDF"; CHF: "CHF"; CLP: "CLP"; CNY: "CNY"; COP: "COP"; CRC: "CRC"; CVE: "CVE"; CZK: "CZK"; DJF: "DJF"; DKK: "DKK"; DOP: "DOP"; DZD: "DZD"; EGP: "EGP"; ETB: "ETB"; EUR: "EUR"; FJD: "FJD"; FKP: "FKP"; GBP: "GBP"; GEL: "GEL"; GHS: "GHS"; GIP: "GIP"; GMD: "GMD"; GNF: "GNF"; GTQ: "GTQ"; GYD: "GYD"; HKD: "HKD"; HNL: "HNL"; HTG: "HTG"; HUF: "HUF"; IDR: "IDR"; ILS: "ILS"; INR: "INR"; IQD: "IQD"; ISK: "ISK"; JMD: "JMD"; JOD: "JOD"; JPY: "JPY"; KES: "KES"; KGS: "KGS"; KHR: "KHR"; KMF: "KMF"; KRW: "KRW"; KWD: "KWD"; KYD: "KYD"; KZT: "KZT"; LAK: "LAK"; LBP: "LBP"; LKR: "LKR"; LRD: "LRD"; LSL: "LSL"; LYD: "LYD"; MAD: "MAD"; MDL: "MDL"; MGA: "MGA"; MMK: "MMK"; MNT: "MNT"; MOP: "MOP"; MUR: "MUR"; MVR: "MVR"; MWK: "MWK"; MXN: "MXN"; MYR: "MYR"; MZN: "MZN"; NAD: "NAD"; NGN: "NGN"; NIO: "NIO"; NOK: "NOK"; NPR: "NPR"; NZD: "NZD"; OMR: "OMR"; PAB: "PAB"; PEN: "PEN"; PGK: "PGK"; PHP: "PHP"; PKR: "PKR"; PLN: "PLN"; PYG: "PYG"; QAR: "QAR"; RON: "RON"; RSD: "RSD"; RUB: "RUB"; RWF: "RWF"; SAR: "SAR"; SBD: "SBD"; SCR: "SCR"; SEK: "SEK"; SGD: "SGD"; SHP: "SHP"; SOS: "SOS"; SRD: "SRD"; SSP: "SSP"; SVC: "SVC"; SZL: "SZL"; THB: "THB"; TJS: "TJS"; TMT: "TMT"; TND: "TND"; TOP: "TOP"; TRY: "TRY"; TTD: "TTD"; TWD: "TWD"; TZS: "TZS"; UAH: "UAH"; UGX: "UGX"; USD: "USD"; UYU: "UYU"; UZS: "UZS"; VND: "VND"; VUV: "VUV"; WST: "WST"; XAF: "XAF"; XCD: "XCD"; XOF: "XOF"; XPF: "XPF"; YER: "YER"; ZAR: "ZAR"; ZMW: "ZMW"; }>; value: z.ZodNumber; }, z.core.$strip>; measure_unit_id: z.ZodOptional; type: z.ZodEnum<{ product: "product"; service: "service"; }>; }, z.core.$strip>; tax_rate_value: z.ZodOptional; }, z.core.$strip>>; overdue_reminder_id: z.ZodOptional>; payment_reminder_id: z.ZodOptional>; tax_mode: z.ZodEnum<{ exclusive: "exclusive"; inclusive: "inclusive"; }>; frequency: z.ZodEnum<{ month: "month"; day: "day"; year: "year"; quarter: "quarter"; week: "week"; once: "once"; }>; recurrence_start_date: z.ZodOptional; recurrence_end_date: z.ZodOptional; recurrence_issue_mode: z.ZodOptional; recurrence_days_of_week: z.ZodOptional>; recurrence_end_mode: z.ZodOptional>; recurrence_max_occurrences: z.ZodOptional>; recurrence_subject_text: z.ZodOptional; recurrence_body_text: z.ZodOptional; type: z.ZodString; bank_account_id: z.ZodString | z.ZodOptional; bank_account_type: z.ZodOptional>; attachments: z.ZodDefault>>; }, z.core.$strip>; /** * The unified invoice-form value shape, inferred from * {@link getInvoiceValidationSchema}. Retains the `CreateReceivablesFormProps` * name because the section components and helpers across this domain already * type their `useFormContext` against it; it is the form shape for both the * create and edit flows. */ type CreateReceivablesFormProps = z.infer>; type ReceivableFilterType = Pick, 'document_id__contains' | 'status' | 'counterpart_id' | 'due_date__lte'>; type ReceivablesTabFilter = NonNullable; declare const FILTER_TYPE_SEARCH$1: "search"; declare const FILTER_TYPE_CREATED_BY = "created_by"; type FilterTypes = { [FILTER_TYPE_SEARCH$1]?: string | null; [FILTER_TYPE_CREATED_AT]?: Date | null; [FILTER_TYPE_CREATED_BY]?: string | null; }; type FilterValue$1 = Date | string | null; interface onFilterChangeParams { field: keyof FilterTypes; value: FilterValue$1; } interface ApprovalPoliciesTableProps { onChangeFilter?: (filter: onFilterChangeParams) => void; onRowClick?: (id: string) => void; onCreateClick?: () => void; } /** * ApprovalPoliciesTable component * * This component renders a table of approval policies. It includes pagination and filtering functionality. */ declare const ApprovalPoliciesTable: (props: ApprovalPoliciesTableProps) => _emotion_react_jsx_runtime.JSX.Element; /** * ApprovalPolicies component * TODO: Check if this component is still needed * * This component renders the approval policies page. It includes a table of approval policies, a dialog for creating new approval policies, * and a header with a button for opening the create dialog. */ declare const ApprovalPolicies: () => _emotion_react_jsx_runtime.JSX.Element; declare const ApprovalRequests: () => _emotion_react_jsx_runtime.JSX.Element; type ApprovalRequestsTableRowAction = 'approve' | 'reject'; interface UseApprovalRequestActionsCellProps { /** * The event handler for an approval row action. * If not provided, the action menu will not be displayed. * @param props.id - The identifier of the clicked row, a string. * @param props.action - The action to be performed, an `InvoicesTableRowAction`. */ onRowActionClick: (props: { id: string; action: ApprovalRequestsTableRowAction; }) => Promise | undefined; } interface ApprovalRequestsTableBaseProps { /** * The event handler for a row click. * * @param id - The identifier of the clicked row, a string. */ onRowClick?: (id: string) => void; } type ApprovalRequestsTableProps = ApprovalRequestsTableBaseProps | (ApprovalRequestsTableBaseProps & UseApprovalRequestActionsCellProps); declare const ApprovalRequestsTable: (props: ApprovalRequestsTableProps) => _emotion_react_jsx_runtime.JSX.Element; type FinanceStepListItem = { id: string; text: string; }; type FinanceStep = { id: number | string; title: string; description: string; description2?: string; list?: { listTitle: string; listItems: FinanceStepListItem[]; }; }; type OcrMismatchField = keyof Pick; type OcrMismatchFields = Partial> | undefined; interface MonitePayableDetailsInfoProps { optionalFields?: OptionalFields; ocrRequiredFields?: OcrRequiredFields; ocrMismatchFields?: OcrMismatchFields; isTagsDisabled?: boolean; } type PayableResponseSchema$1 = components['schemas']['PayableResponseSchema']; type CreditNotesTableProps = { /** * The event handler for a row click. * * @param id - The identifier of the clicked row, a string. */ onRowClick?: (id: string) => void; /** * The event handler for the creation new invoice for no data state * @param {boolean} isOpen - A boolean value indicating whether the dialog should be open (true) or closed (false). */ setIsCreateInvoiceDialogOpen?: (isOpen: boolean) => void; /** * The query to be used for the Table */ query?: ReceivablesTabFilter; /** Filters to be applied to the table */ filters?: Array; }; interface CreditNotesTableSortModel { field: components['schemas']['ReceivableCursorFields']; sort: NonNullable; } declare const CreditNotesTable: (props: CreditNotesTableProps) => _emotion_react_jsx_runtime.JSX.Element; interface UseInvoiceRowActionMenuCellProps { /** * The event handler for an invoice row action. * If not provided, the action menu will not be displayed. * @param props.id - The identifier of the clicked row, a string. * @param props.action - The action to be performed, an `InvoicesTableRowAction`. */ onRowActionClick?: (props: { id: string; action?: InvoicesTableRowAction; }) => void; /** * The actions to be displayed in the row's action menu. * If not provided, default actions will be displayed, * in case if `onRowActionClick` is provided. * * @example * ```ts * { * "draft": ['edit', 'download', 'duplicate', 'delete'], * "issued": ['send', 'download', 'duplicate'], * "partially_paid": ['send', 'download', 'duplicate'], * } * ``` */ rowActions?: Partial; } /** * Represents the possible actions that can be performed on an Invoice row. * * @property {'edit'} edit - Edits a draft invoice. * @property {'download'} download - Downloads an invoice. * @property {'duplicate'} duplicate - Copies an invoice, creating a new draft. * @property {'send'} send - Sends an invoice via email (issued and partially_paid only). * @property {'delete'} delete - Deletes a draft invoice. */ type InvoicesTableRowAction = 'edit' | 'download' | 'duplicate' | 'send' | 'delete'; /** * Represents the possible actions that can be performed on an Invoice row for each status. */ interface InvoicesTableRowActionSchema extends Record { draft: Array<'edit' | 'download' | 'duplicate' | 'delete'>; issued: Array<'send' | 'download' | 'duplicate'>; canceled: Array<'download' | 'duplicate'>; partially_paid: Array<'send' | 'download' | 'duplicate'>; overdue: Array<'download' | 'duplicate'>; paid: Array<'download' | 'duplicate'>; uncollectible: Array<'download' | 'duplicate'>; expired: Array<'download' | 'duplicate'>; accepted: Array<'download' | 'duplicate'>; declined: Array<'download' | 'duplicate'>; recurring: Array<'download' | 'duplicate'>; deleted: Array; } /** * `useCurrencies` hook used for working with currencies * - Display price based on amount, currency and locale.code parameters * - Convert minor units into main currency and vise-versa */ declare const useCurrencies: () => { currencyList: { [key: string]: { minor_units: number; name: string; symbol: string; }; } | undefined; getSymbolFromCurrency: (currency?: CurrencyEnum$1 | string) => string | undefined; formatCurrencyToDisplay: (amountInMinorUnits: string | number, currency: CurrencyEnum$1, isCurrencyDisplayed?: boolean) => string | null; formatToMinorUnits: (amount: string | number, currency: CurrencyEnum$1) => number | null; formatFromMinorUnits: (amount: number, currency: CurrencyEnum$1) => number | null; isSuccess: boolean; }; type CurrencyEnum$1 = components['schemas']['CurrencyEnum']; type ShowFields = { [K in keyof T as `show${Capitalize}`]: boolean; }; declare const useOptionalFields: (optionalFields: T | boolean | undefined, defaultOptionalFields: ShowFields) => ShowFields; type MenuType = Pick & { container: Element | undefined; }; type ButtonType = Pick; declare const useMenuButton: () => { open: boolean; menuProps: MenuType; buttonProps: ButtonType; closeMenu: (event?: SyntheticEvent | {}) => void; }; declare const OCR_SUPPORTED_FORMATS: string[]; /** * Formats accepted by the backend logo endpoints * (`PUT /finops/v1/entities/{entity_id}/logo` and * `PUT /identity/v1/organizations/{organizationId}/logo`): PNG, JPG, or GIF * only — PDF is rejected. */ declare const LOGO_SUPPORTED_FORMATS: string[]; /** Maximum logo size (in MB) accepted by the backend logo endpoints. */ declare const LOGO_MAX_FILE_SIZE_IN_MB = 10; interface UseFileInputOptions { /** * MIME types accepted by the input and validated by `checkFileError`. * Defaults to {@link OCR_SUPPORTED_FORMATS}. */ acceptedFormats?: string[]; /** * Maximum file size in megabytes enforced by `checkFileError`. * Defaults to 20 MB (the OCR upload limit). */ maxFileSizeInMB?: number; } /** * `useFileInput` is a React hook that creates an invisible `` and `open()` method for interacting with it. * * @returns {Object} An object containing two properties: * - `FileInput`: A component that renders an invisible file input element. It takes all the standard HTML input attributes and forwardRefs the underlying input element. * - `openFileInput`: A function that programmatically opens the file input dialog. It can be used to open the file input dialog when another element is clicked. * - `checkFileError`: A function that checks for file errors based on type and size. It returns an error message if there is an issue, or null if the file is valid. * * @example * ```jsx * const { FileInput, openFileInput, checkFileError } = useFileInput(); * * return ( * <> * * { * const file = event.target.files?.item(0); * const error = checkFileError(file); * if (error) { * // handle the error (e.g., show a message) * console.error(error); * } else { * // handle the selected file * } * }} * /> * * ); * ``` */ declare const useFileInput: ({ acceptedFormats, maxFileSizeInMB, }?: UseFileInputOptions) => { FileInput: ({ ref: externalRef, ...props }: ComponentProps<"input"> & { ref?: Ref; }) => _emotion_react_jsx_runtime.JSX.Element; openFileInput: () => void; checkFileError: (file: File) => string | null; resetInput: () => void; }; declare const defaultCounterpartColumnWidth = 250; declare function useAreCounterpartsLoading(rows?: { counterpart_id?: string; }[]): boolean; declare function useAutosizeGridColumns(rows: any, columns: GridColDef[], areCounterpartsLoading: boolean, columnSerializationKey: string): React.RefObject<_mui_x_data_grid_internals.GridApiCommunity>; declare const useFormPersist: (name: string, getValues: () => { [key: string]: any; }, setValue: SetFieldValue) => void; /** * Hook for persistent storage of form fields with SSR safety * @param componentPrefix - Prefix to avoid key collisions between different components * @param key - The key to store the value under * @param initialValue - The initial value to use if none is stored */ declare const useLocalStorageFields: (componentPrefix: string, key: string, initialValue: T) => [T, (value: T) => void, boolean, (checked: boolean) => void]; /** * Hook to debounce a value * @template T - The type of the value to debounce * @param value The value to debounce * @param delay The delay in milliseconds * @returns The debounced value */ declare const useDebounce: (value: T, delay?: number) => T; /** * Hook to debounce a callback function with auto-cleanup on unmount * @template Args - The argument types of the callback function * @template R - The return type of the callback function * @param callback The function to be debounced * @param delay The delay in milliseconds * @returns The debounced callback function */ declare const useDebounceCallback: (callback: (...args: Args) => R, delay?: number) => ((...args: Args) => void); declare function useIsMobile(): boolean; declare const useComponentSettings: () => { componentSettings: ComponentSettings; receivablesCallbacks: { onUpdate: ((receivableId: string, invoice?: components["schemas"]["InvoiceResponsePayload"]) => void) | undefined; onDelete: ((receivableId: string) => void) | undefined; onCreate: ((receivableId: string) => void) | undefined; }; onboardingCallbacks: { onWorkingCapitalOnboardingComplete: ((entityId: string) => void) | undefined; onPaymentsOnboardingComplete: ((entityId: string) => void) | undefined; onComplete: ((entityId: string) => void) | undefined; onContinue: (() => void) | undefined; }; payablesCallbacks: { onSaved: ((id: string) => void) | undefined; onCanceled: ((id: string) => void) | undefined; onSubmitted: ((id: string) => void) | undefined; onRejected: ((id: string) => void) | undefined; onApproved: ((id: string) => void) | undefined; onReopened: ((id: string) => void) | undefined; onDeleted: ((id: string) => void) | undefined; onPay: ((id: string, _data?: unknown, actions?: PayActionHandlers) => void) | undefined; }; }; /** * Hook that tracks whether the component is currently mounted. * Useful for preventing state updates on unmounted components. * * @returns A ref object with current boolean indicating mount status */ declare const useIsMounted: () => React.RefObject; declare const breakpoints: { readonly sm: 640; readonly md: 768; readonly lg: 1024; readonly xl: 1280; readonly '2xl': 1536; }; type Breakpoint = keyof typeof breakpoints; /** * Hook for responsive design using shadcn/ui standard breakpoints * * @param query - Media query string or breakpoint key * @returns boolean indicating if the media query matches * * @example * ```tsx * // Using breakpoint keys * const isMobile = useMediaQuery('sm'); // true when width < 640px * const isTablet = useMediaQuery('md'); // true when width >= 768px * const isDesktop = useMediaQuery('lg'); // true when width >= 1024px * * // Using custom media queries * const isLandscape = useMediaQuery('(orientation: landscape)'); * const isHighDpi = useMediaQuery('(min-resolution: 2dppx)'); * * // Using min/max width queries * const isMediumUp = useMediaQuery('(min-width: 768px)'); * const isLargeDown = useMediaQuery('(max-width: 1023px)'); * ``` */ declare function useMediaQuery(query: Breakpoint | string): boolean; /** * Convenience hooks for common breakpoints */ declare const useIsMobileScreen: () => boolean; declare const useIsTabletScreen: () => boolean; declare const useIsDesktopScreen: () => boolean; declare const useIsLargeDesktopScreen: () => boolean; declare const useIsExtraLargeDesktopScreen: () => boolean; /** * Hook for checking if screen is smaller than a breakpoint * * @param breakpoint - The breakpoint to check against * @returns boolean indicating if screen is smaller than the breakpoint * * @example * ```tsx * const isSmallerThanLg = useIsSmallerThan('lg'); // true when width < 1024px * ``` */ declare function useIsSmallerThan(breakpoint: Breakpoint): boolean; /** * Hook for checking if screen is larger than a breakpoint * * @param breakpoint - The breakpoint to check against * @returns boolean indicating if screen is larger than the breakpoint * * @example * ```tsx * const isLargerThanMd = useIsLargerThan('md'); // true when width > 768px * ``` */ declare function useIsLargerThan(breakpoint: Breakpoint): boolean; interface InvoicesTableBaseProps { /** * Arrival prop: seeds the counterpart filter once (customer "View all" cross-link). */ initialCounterpartId?: string; /** * The event handler for a row click. * * @param id - The identifier of the clicked row, a string. */ onRowClick?: (id: string) => void; /** * The event handler for the creation new invoice for no data state * @param {boolean} isOpen - A boolean value indicating whether the dialog should be open (true) or closed (false). */ setIsCreateInvoiceDialogOpen?: (isOpen: boolean) => void; /** * The query to be used for the Table */ query?: ReceivablesTabFilter; } type InvoicesTableProps = InvoicesTableBaseProps | (UseInvoiceRowActionMenuCellProps & InvoicesTableBaseProps); interface ReceivableGridSortModel { field: components['schemas']['ReceivableCursorFields']; sort: NonNullable; } declare const InvoicesTable: (props: InvoicesTableProps) => _emotion_react_jsx_runtime.JSX.Element; interface QuotesTableSortModel { field: components['schemas']['ReceivableCursorFields']; sort: NonNullable; } type QuotesTableProps = { /** * The event handler for a row click. * * @param id - The identifier of the clicked row, a string. */ onRowClick?: (id: string) => void; /** * The event handler for a sort change. * * @param {QuotesTableSortModel} params - The sort model. */ onChangeSort?: (params: QuotesTableSortModel) => void; /** * The event handler for the creation new invoice for no data state * @param {boolean} isOpen - A boolean value indicating whether the dialog should be open (true) or closed (false). */ setIsCreateInvoiceDialogOpen?: (isOpen: boolean) => void; /** * The query to be used for the Table */ query?: ReceivablesTabFilter; /** Filters to be applied to the table */ filters?: Array; }; declare const QuotesTable: (props: QuotesTableProps) => _emotion_react_jsx_runtime.JSX.Element; declare const ReceivablesTableTabEnum: { readonly Invoices: 0; readonly Quotes: 1; readonly CreditNotes: 2; readonly Financing: 3; }; type ReceivablesTableTabEnum = (typeof ReceivablesTableTabEnum)[keyof typeof ReceivablesTableTabEnum]; interface ReceivablesTableControlledProps { /** Event handler for tab change */ onTabChange: (tab: ReceivablesTableTabEnum) => void; /** Active-selected tab */ tab: ReceivablesTableTabEnum; } interface ReceivablesTableUncontrolledProps { /** Active-selected tab */ tab?: ReceivablesTableTabEnum; onTabChange?: never; } /** * Receivables Table props for customisation via Monite Provider */ interface MoniteReceivablesTableProps { /** Active-selected tab */ tab?: ReceivablesTableTabEnum; /** * The tabs to display in the ReceivablesTable. * By default, the component will display tabs for Invoices, Quotes, and Credit Notes. */ tabs?: Array; /** * The event handler for the creation of a new invoice * @param {string} receivableId - The ID of the receivable that was created. */ onCreate?: (receivableId: string) => void; } interface ReceivablesTableBaseProps { /** * Arrival prop: seeds the invoices-list counterpart filter once (customer * "View all" cross-link). Only the Invoices tab consumes it. */ initialCounterpartId?: string; /** * The event handler for a row click. * * @param id - The identifier of the clicked row, a string. */ onRowClick?: (id: string) => void; /** * The event handler for the creation new invoice for no data state * @param {boolean} isOpen - A boolean value indicating whether the dialog should be open (true) or closed (false). */ setIsCreateInvoiceDialogOpen?: (isOpen: boolean) => void; } type ReceivablesTableProps = (ReceivablesTableControlledProps & ReceivablesTableBaseProps) | (ReceivablesTableUncontrolledProps & ReceivablesTableBaseProps); /** * ReceivablesTable component * Displays Invoices, Quotes, Credit Notes * * @example Monite Provider customisation * ```ts * // You can configure the component through Monite Provider property `componentSettings` like this: * const componentSettings = { * receivables: { * tab: 0, // The default tab index to display * tabs: [ * { * label: 'Draft Invoices', // The label of the Tab * query: { // The query parameters for the Tab * type: 'invoice', // The type of the Receivables, *required* * sort: 'created_at', * order: 'desc', * status__in: ['draft'], * }, * filters: [ // The UI filters for the Tab * 'document_id__contains', * 'counterpart_id', * 'due_date__lte', * ], * }, * { * label: 'Recurring invoices', * query: { * type: 'invoice', * status__in: ['recurring'], * }, * filters: ['document_id__contains', 'counterpart_id'], * }, * { * label: 'Other Invoices', * query: { * type: 'invoice', * sort: 'created_at', * order: 'desc', * status__in: [ // The "status" filter for the Tab will * 'issued', // only contain the values specified in "status__in" * 'overdue', * 'partially_paid', * 'paid', * 'uncollectible', * 'canceled', * ], * // If no "filters" are specified, default UI filters will be displayed * }, * }, * { * label: 'Credit notes', * query: { * type: 'credit_note', * }, * }, * ], * }, * }); * ``` */ declare const ReceivablesTable: (props: ReceivablesTableProps) => _emotion_react_jsx_runtime.JSX.Element; type MoniteReceivablesTab = { label: string; query?: ReceivablesTabFilter | { type: 'financing'; }; filters?: Array; }; declare const useReceivablesTableProps: (inProps?: Partial) => { tab: ReceivablesTableTabEnum | undefined; tabs: MoniteReceivablesTab[] | undefined; }; /** * How the form was submitted: * - `draft` — the receivable was only created (stays in draft). * - `issue` — the receivable was created and then issued. * - `recurrence` — a recurring billing schedule was activated. */ type CreateReceivableSubmitMode = 'draft' | 'issue' | 'recurrence'; interface CreateReceivableResult { /** Which action the user submitted with. */ mode: CreateReceivableSubmitMode; /** The receivable's counterpart, so callers can open a customer-scoped UI. */ counterpartId: string; /** * Line items the user typed inline (not picked from the product catalog). * Provided so the caller can prompt to save them as catalog products. */ inlineLineItems: CreateReceivablesFormProps['line_items']; /** * Whether the customer has an email — the caller only offers the send/email * step (in the ActionsModal) when true. */ hasCustomerEmail: boolean; } interface CreateReceivablesProps { /** The type of the receivable */ type: components['schemas']['ReceivableResponse']['type']; /** * Indicates that the invoice has been successfully created. * * @param receivableId Invoice ID * @param result Submit mode and the inline line items typed on the form */ onCreate?: (receivableId: string, result: CreateReceivableResult) => void; open: boolean; onOpenChange: (open: boolean) => void; /** * Display name of the sponsor bank that powers embedded bank accounts, e.g. * "Zenith Bank". Forwarded to the payment account picker. */ embeddedBankName?: string; /** Preselects this counterpart in the create-invoice form. */ initialCounterpartId?: string; } /** * A component for creating a new Receivable * Supported only `invoice` type */ declare const CreateReceivables: (props: CreateReceivablesProps) => _emotion_react_jsx_runtime.JSX.Element; type ARDocumentType = 'invoice' | 'quote' | 'credit_note' | 'delivery_note'; type APDocumentType = 'purchase_order'; interface IconWrapperEvents { onHover?: (event: MouseEvent) => void; onFocus?: (event: FocusEvent) => void; onBlur?: (event: FocusEvent) => void; } interface MoniteIconWrapperProps extends IconButtonProps, IconWrapperEvents { showCloseIcon?: boolean; icon?: ReactNode; fallbackIcon?: ReactNode; tooltip?: string; color?: 'inherit' | 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning'; sx?: SxProps; isDynamic?: boolean; ariaLabelOverride?: string; ref?: Ref; } type PaginationLayout = 'default' | 'reversed' | 'centered' | 'custom'; type PaginationPosition = 'left' | 'right' | 'center'; interface TablePaginationSettings { /** Controls the layout of pagination controls */ paginationLayout?: PaginationLayout; /** Position of navigation arrows when paginationLayout is 'custom' */ navigationPosition?: PaginationPosition; /** Position of page size selector when paginationLayout is 'custom' */ pageSizePosition?: PaginationPosition; } interface ReceivableSettings extends MoniteReceivablesTableProps, TablePaginationSettings { pageSizeOptions: number[]; /** Callback to be called when an invoice is updated */ onUpdate?: (receivableId: string, invoice?: components['schemas']['InvoiceResponsePayload']) => void; /** Callback to be called when an invoice is deleted */ onDelete?: (receivableId: string) => void; /** Enables bank account creation on invoice creation flow */ enableEntityBankAccount?: boolean; /** List of available countries, ISO format */ bankAccountCountries?: components['schemas']['AllowedCountries'][]; /** List of available currencies, ISO format */ bankAccountCurrencies?: components['schemas']['CurrencyEnum'][]; } /** * Configuration settings for the onboarding component. * * ## Onboarding Callback Architecture * * The Monite SDK supports different types of onboarding flows with corresponding callbacks: * * ### 1. General Onboarding (`onComplete`) * - **Trigger**: When all onboarding requirements are fulfilled (requirements.length === 0) * - **Use Case**: General onboarding completion, backward compatibility * - **Business Logic**: Called when the onboarding component completes all required steps * * ### 2. Payments Onboarding (`onPaymentsOnboardingComplete`) * - **Trigger**: When payments onboarding requirements are fulfilled * - **Use Case**: Specific to payments onboarding completion * - **Business Logic**: Called when entity can make/receive payments via Monite payment rails * - **Note**: Currently triggered alongside `onComplete` as they represent the same flow * * ### 3. Working Capital Onboarding (`onWorkingCapitalOnboardingComplete`) * - **Trigger**: When business status transitions from 'INPUT_REQUIRED' or 'NEW' to 'WAITING_FOR_OFFERS' * - **Use Case**: Financing/working capital onboarding completion * - **Business Logic**: Called when entity completes onboarding for working capital services * - **Implementation**: Handled in the financing flow (useFinancing hook) * * ### Event Flow Architecture * * ``` * Component → useComponentSettings() → [domain]Callbacks → MoniteEvents.enhance[Domain]Settings() → EVENT emission * ``` * * All callbacks are enhanced with event emission capabilities in the drop-in package. */ interface OnboardingSettings { /** * Custom footer logo URL for the Onboarding pages. * If provided, the logo will be displayed instead of the Monite logo. * Requires `onboardingFooterWebsiteUrl` to be provided as well. */ footerLogoUrl?: string; /** * Custom footer website URL for the Onboarding pages. * If provided, the onboardingFooterLogoUrl logo will link to this URL. */ footerWebsiteUrl?: string; /** * If true, hides the footer on the Onboarding pages. * Defaults to false. */ hideFooter?: boolean; /** * Whether to show the continue button on the onboarding completed page. * * @default false */ showContinueButton?: boolean; /** * Allowed currencies to restrict options in the onboarding forms. * The first currency in the array will be used as the default value. * * @example ['USD', 'EUR'] */ allowedCurrencies?: components['schemas']['CurrencyEnum'][]; /** * Allowed country codes to restrict options in the onboarding forms. * The first country code in the array will be used as the default value. * * @example ['US', 'GB'] */ allowedCountries?: components['schemas']['AllowedCountries'][]; /** * Called when the onboarding process is completed. * This happens when all onboarding requirements have been fulfilled. * * @param {string} entityId - The ID of the entity * @returns {void} */ onComplete?: (entityId: string) => void; /** * Called when the continue button is clicked on the onboarding completed page. * * @returns {void} */ onContinue?: () => void; /** * Called when working capital onboarding is completed. * This happens when the business status transitions to 'ONBOARDED'. * * @param {string} entityId - The ID of the entity * @returns {void} */ onWorkingCapitalOnboardingComplete?: (entityId: string) => void; /** * Called when payments onboarding is completed. * Note: This is currently triggered when all onboarding requirements are completed. * Future versions may tie this to a specific payments onboarding status. * * @param {string} entityId - The ID of the entity * @returns {void} */ onPaymentsOnboardingComplete?: (entityId: string) => void; } interface FinancingSettings { /** * Enables finance widget buttons inside finance card in My financing tab when true, if false, * buttons are shown on the top right corner instead. */ enableFinanceWidgetButton?: boolean; /** * Describes the step by step of how financing an invoice works, this is shown in a drawer when clicking on * `How does invoice financing work?` button */ financeSteps: FinanceStep[]; } /** TemplateSettings now only supports 2 settings */ interface TemplateSettings$1 { /** * List of available AR documents for customisation, defaults to all of the documents. */ availableARDocuments: ARDocumentType[]; /** * List of available AP documents for customisation, defaults to all of the documents. */ availableAPDocuments: APDocumentType[]; } /** * Action handlers for custom payment flows in payable operations. * * These handlers provide fine-grained control over payment workflows, allowing customers to: * - Integrate external payment providers * - Implement custom approval processes or multi-step authentication * - Add specialized banking solutions or enterprise payment workflows * - Control UI feedback and data refresh timing after payment completion * * @example Custom payment provider integration: * ```typescript * const onPay = (id: string, _data?: unknown, actions?: PayActionHandlers) => { * // Start custom payment flow * initiatePayment(id) * .then(() => { * // Payment successful - update SDK state and show success message * actions?.resolve({ showToast: true }); * }) * .catch((error) => { * // Payment failed - update SDK state and show error message * actions?.reject(error, { showToast: true }); * }); * }; * ``` */ type PayActionHandlers = { /** * Call when a custom payment flow has been successfully initiated/completed. * This triggers SDK's built-in state management: refreshes payable data, * payment records, and optionally displays success feedback to the user. * * @param options.showToast - Whether to display a success toast notification */ resolve: (options?: { showToast?: boolean; }) => void; /** * Call when a custom payment flow failed or was cancelled by the user. * This triggers SDK's built-in state management: refreshes payable data, * payment records, and optionally displays error feedback to the user. * * @param error - Optional error details from the failed payment attempt * @param options.showToast - Whether to display an error toast notification */ reject: (error?: unknown, options?: { showToast?: boolean; }) => void; }; interface PayableSettings extends MonitePayableTableProps, MonitePayableDetailsInfoProps, TablePaginationSettings { pageSizeOptions: number[]; enableGLCodes?: boolean; hideAddDiscountButton?: boolean; hideAddBankAccountButton?: boolean; /** List of available countries for payables forms, ISO format */ availableCountries?: components['schemas']['AllowedCountries'][]; /** List of available currencies for payables forms, ISO format */ availableCurrencies?: components['schemas']['CurrencyEnum'][]; onSaved?: (id: string) => void; onCanceled?: (id: string) => void; onSubmitted?: (id: string) => void; onRejected?: (id: string) => void; onApproved?: (id: string) => void; onReopened?: (id: string) => void; onDeleted?: (id: string) => void; /** * Called when the user clicks Pay button on a payable. * * **Legacy Usage (Backward Compatible):** * ```typescript * onPay: (id: string) => { * console.log('Payment initiated for:', id); * } * ``` * * **Enhanced Usage (Custom Payment Flow):** * ```typescript * onPay: (id: string, _data?: unknown, actions?: PayActionHandlers) => { * // Custom payment implementation * processPaymentWithCustomProvider(id) * .then(() => actions?.resolve({ showToast: true })) * .catch(err => actions?.reject(err, { showToast: true })); * } * ``` * * @param id - The payable ID being paid * @param _data - Reserved for future use (currently undefined) * @param actions - Optional handlers for custom payment flows. When provided, * enables custom payment integration. Call actions.resolve() * on success or actions.reject() on failure to update SDK state. */ onPay?: (id: string, _data?: unknown, actions?: PayActionHandlers) => void; } interface ComponentSettings { general: { iconWrapper: Partial; }; approvalPolicies: { pageSizeOptions: number[]; } & TablePaginationSettings; approvalRequests: { pageSizeOptions: number[]; } & TablePaginationSettings; counterparts: { pageSizeOptions: number[]; /** * @see {@link CustomerTypes} * @param customerTypes - Array of customer types, defaults to ['customer', 'vendor'] */ customerTypes?: CustomerTypes; } & TablePaginationSettings; payables: Partial; products: { pageSizeOptions: number[]; } & TablePaginationSettings; receivables: Partial; tags: { pageSizeOptions: number[]; } & TablePaginationSettings; userRoles: { pageSizeOptions: number[]; } & TablePaginationSettings; onboarding: Partial; financing: Partial; templateSettings: Partial; } type UsePayableDetailsProps = { /** * The ID of the payable */ id?: string; /** when provided it takes precedence over component settings */ enableGLCodes?: boolean; /** when provided it makes the payable open in edit mode */ shouldOpenInEditMode?: boolean; /** * Callback function that is called when the payable is saved * * @param {string} id - The ID of the payable * * @returns {void} */ onSaved?: (id: string) => void; /** * Callback function that is called when the payable is canceled * * @param {string} id - The ID of the payable * * @returns {void} */ onCanceled?: (id: string) => void; /** * Callback function that is called when the payable is submitted * * @param {string} id - The ID of the payable * * @returns {void} */ onSubmitted?: (id: string) => void; /** * Callback function that is called when the payable is rejected * * @param {string} id - The ID of the payable * * @returns {void} */ onRejected?: (id: string) => void; /** * Callback function that is called when the payable is approved * * @param {string} id - The ID of the payable * * @returns {void} */ onApproved?: (id: string) => void; /** Callback function that is called when the payable is reopened * * @param {string} id - The ID of the payable * * @returns {void} */ onReopened?: (id: string) => void; /** Callback function that is called when the payable is deleted * * @param {string} id - The ID of the payable * * @returns {void} */ onDeleted?: (id: string) => void; /** * Callback function that is called when the user press the Pay button * * @param {string} id - The ID of the payable * * @returns {void} */ onPay?: (id: string, _data?: unknown, actions?: PayActionHandlers) => void; }; interface PayablesDetailsProps extends UsePayableDetailsProps { optionalFields?: OptionalFields; enableGLCodes?: boolean; hideAddDiscountButton?: boolean; hideAddBankAccountButton?: boolean; onClose?: () => void; shouldOpenInEditMode?: boolean; /** Preselects this counterpart when creating a new payable. */ initialCounterpartId?: string; } declare const PayableDetails: (props: PayablesDetailsProps) => _emotion_react_jsx_runtime.JSX.Element; interface PayablesTableProps extends MonitePayableTableProps { /** * Arrival prop: seeds the counterpart filter once (vendor "View all" cross-link). */ initialCounterpartId?: string; /** * The event handler for a row click. * * @param id - The identifier of the clicked row, a string. */ onRowClick?: (id: string) => void; /** * The event handler for the pay action * * @param id - The identifier of the row to perform the pay action on, a string. */ onPay?: (id: string, _data?: unknown, actions?: PayActionHandlers) => void; onSubmitted?: (id: string) => void; onApproved?: (id: string) => void; onCanceled?: (id: string) => void; /** * Triggered when the filtering options are changed * * @param filter - An object containing the filter parameters. * @param filter.field - The field to filter by, specified as a keyof FilterTypes. * @param filter.value - The value to be applied to the filter, of type FilterValue. */ onChangeFilter?: (filter: { field: keyof FilterTypes$1; value: FilterValue$2; }) => void; /** * The event handler for the file input when no data is present. * This triggers the file upload process when the user selects a file. */ openFileInput?: () => void; /** * The event handler for opening the "New Invoice" dialog when no data is present. * This function controls the visibility of the dialog for invoice creation. * * @param {boolean} isOpen - A boolean value indicating whether the dialog should be open (true) or closed (false). */ setIsCreateInvoiceDialogOpen?: (isOpen: boolean) => void; openEditDialog?: (id: string) => void; } declare const PayablesTable: (props: PayablesTableProps) => _emotion_react_jsx_runtime.JSX.Element; type PayablesProps = { pageTitleComponent: (children: ReactNode) => ReactNode; /** * Enable GL code selection for payable line items. * When true, users can assign GL codes to individual line items. * GL codes are fetched from the connected accounting system. */ enableGLCodes?: boolean; /** Arrival prop: 'create' opens the create-bill dialog on mount. */ initialView?: 'create'; /** Arrival prop: preselects this counterpart in the create-bill form. */ initialCounterpartId?: string; } & Partial>; declare const Payables: (props: PayablesProps) => _emotion_react_jsx_runtime.JSX.Element; declare const useGetPayableCounterpart: ({ payable, }: { payable?: components["schemas"]["PayableResponseSchema"]; }) => { counterpart: { id: string; created_at: string; updated_at: string; created_automatically: boolean; created_by_entity_user_id?: string; default_billing_address_id?: string; default_shipping_address_id?: string; external_reference?: string; individual: components["schemas"]["CounterpartIndividualResponse"]; is_customer: boolean; is_vendor: boolean; language?: components["schemas"]["LanguageCodeEnum"]; reminders_enabled?: boolean; tax_id?: string; type: components["schemas"]["CounterpartType"]; } | { id: string; created_at: string; updated_at: string; created_automatically: boolean; created_by_entity_user_id?: string; default_billing_address_id?: string; default_shipping_address_id?: string; external_reference?: string; is_customer: boolean; is_vendor: boolean; language?: components["schemas"]["LanguageCodeEnum"]; organization: components["schemas"]["CounterpartOrganizationResponse"]; reminders_enabled?: boolean; tax_id?: string; type: components["schemas"]["CounterpartType"]; } | undefined; counterpartRawName: string | undefined; isCounterpartAIMatched: boolean; isCounterpartMatchingToOCRFound: boolean; isCounterpartLoading: boolean; AISuggestions: { suggested_counterpart: components["schemas"]["SuggestedCounterpartPayload"]; } | undefined; }; declare const usePayableDetailsThemeProps: (inProps?: Partial) => { optionalFields: OptionalFields | undefined; ocrRequiredFields: OcrRequiredFields; ocrMismatchFields: OcrMismatchFields; isTagsDisabled: boolean | undefined; }; type PayableCallbackProps = Pick; /** * Custom hook that creates memoized payable callbacks. * Each callback calls both the direct prop callback and the component settings callback. * Returns undefined for callbacks when neither the direct prop nor component settings callback is defined. * * @param props - Direct callback props from component props * @returns Object with memoized callback handlers (or undefined when no callbacks are defined) */ declare const usePayableCallbacks: (props: PayableCallbackProps) => { handleSaved: ((id: string) => void) | undefined; handleCanceled: ((id: string) => void) | undefined; handleSubmitted: ((id: string) => void) | undefined; handleRejected: ((id: string) => void) | undefined; handleApproved: ((id: string) => void) | undefined; handleReopened: ((id: string) => void) | undefined; handleDeleted: ((id: string) => void) | undefined; handlePay: ((id: string, data?: unknown, actions?: PayActionHandlers) => void) | undefined; }; interface UsePayButtonVisibilityProps { payable?: components['schemas']['PayableResponseSchema']; payableRecentPaymentRecordByIntent: PaymentRecordWithIntent[]; } interface PaymentIntentsAnalysis { scheduledIntents: PaymentRecordWithIntent[]; processingIntents: PaymentRecordWithIntent[]; succeededIntents: PaymentRecordWithIntent[]; createdRecords: PaymentRecordWithIntent[]; hasAnyIntentOtherThanCreated: boolean; aggregation: Record; }>; idPaymentIntentInCreated?: string; } declare const usePayButtonVisibility: ({ payable, payableRecentPaymentRecordByIntent, }: UsePayButtonVisibilityProps) => { showPayButton: boolean; isPayAllowed: boolean; payableStatusCanBePaid: boolean; intentsAnalysis: PaymentIntentsAnalysis; }; declare const useLedgerAccounts: (enabled?: boolean) => _tanstack_react_query.UseQueryResult<{ data: components["schemas"]["LedgerAccountResponse"][]; next_pagination_token?: string; prev_pagination_token?: string; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; type PayableResponseSchema = components['schemas']['PayableResponseSchema']; declare function getPayableRefetchInterval({ isEditing, isOcrProcessing, payable, }: { isEditing?: boolean; isOcrProcessing?: boolean; payable?: PayableResponseSchema; }): number | false; declare const useGetPayableById: (payableId: string, isOcrProcessing?: boolean, isEditing?: boolean) => _tanstack_react_query.UseQueryResult<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare const useGetPayableLineItems: (payableId: string) => _tanstack_react_query.UseQueryResult<{ data: components["schemas"]["LineItemResponse"][]; next_pagination_token?: string; prev_pagination_token?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare const useGetPayableApprovalRequests: (payableId: string, status?: components["schemas"]["PayableStateEnum"]) => _tanstack_react_query.UseQueryResult<{ data: components["schemas"]["ApprovalRequestResourceWithMetadata"][]; next_pagination_token?: string; prev_pagination_token?: string; }, { error: components["schemas"]["ErrorSchema"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; declare const useCreatePayable: () => _tanstack_react_query.UseMutationResult<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, void | { base64_encoded_file?: string; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_vat_id_id?: string; currency?: components["schemas"]["CurrencyEnum"]; description?: string; discount?: number; document_id?: string; due_date?: string; enforce_approval_policy_id?: string; file_name?: string; issued_at?: string; partner_metadata?: Record; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tag_ids?: string[]; tax?: number; tax_amount?: number; total_amount?: number; }, unknown>; declare const useUpdatePayable: () => _tanstack_react_query.UseMutationResult<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, { body?: { amount_paid?: number; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawDataUpdateRequest"]; counterpart_vat_id_id?: string; currency?: components["schemas"]["CurrencyEnum"]; description?: string; discount?: number; document_id?: string; due_date?: string; enforce_approval_policy_id?: string; issued_at?: string; partner_metadata?: Record; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tag_ids?: string[]; tax?: number; tax_amount?: number; total_amount?: number; } | undefined; } & { query?: never; header?: { "x-finops-version"?: string; "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }, unknown>; declare const useCreatePayableLineItem: (payableId: string) => _tanstack_react_query.UseMutationResult<{ id: string; accounting_tax_rate_id?: string; description?: string; ledger_account_id?: string; name?: string; ocr_set_quantity_to_one: boolean; payable_id: string; quantity?: number; subtotal?: number; tax?: number; tax_amount?: number; total?: number; unit?: string; unit_price?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, { body?: { accounting_tax_rate_id?: string; description?: string; ledger_account_id?: string; name?: string; quantity?: number; tax?: number; unit?: string; unit_price?: number; } | undefined; } & { query?: never; header?: { "x-finops-version"?: string; "x-organization-id"?: string; }; path: { payable_id: string; }; cookie?: never; }, unknown>; declare const useUpdatePayableLineItem: (payableId: string) => _tanstack_react_query.UseMutationResult<{ id: string; accounting_tax_rate_id?: string; description?: string; ledger_account_id?: string; name?: string; ocr_set_quantity_to_one: boolean; payable_id: string; quantity?: number; subtotal?: number; tax?: number; tax_amount?: number; total?: number; unit?: string; unit_price?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, { body?: { accounting_tax_rate_id?: string; description?: string; ledger_account_id?: string; name?: string; quantity?: number; tax?: number; unit?: string; unit_price?: number; } | undefined; } & { query?: never; header?: { "x-finops-version"?: string; "x-organization-id"?: string; }; path: { line_item_id: string; payable_id: string; }; cookie?: never; }, unknown>; declare const useDeletePayableLineItem: (payableId: string) => _tanstack_react_query.UseMutationResult; declare const useCancelPayableById: (payableId: string, onCanceled?: (id: string) => void) => _tanstack_react_query.UseMutationResult<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, void | undefined, unknown>; type UseSubmitPayableForApprovalProps = { payableId: string; counterpartId?: string; isCounterpartAIMatched?: boolean; AISuggestions?: components['schemas']['SuggestedCounterpartPayload']; onSubmitted?: (id: string) => void; }; declare const useSubmitPayableForApproval: ({ payableId, counterpartId, isCounterpartAIMatched, AISuggestions, onSubmitted, }: UseSubmitPayableForApprovalProps) => { data: undefined; variables: undefined; error: null; isError: false; isIdle: true; isPending: false; isSuccess: false; status: "idle"; mutate: _tanstack_react_query.UseMutateFunction<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, void | undefined, unknown>; reset: () => void; context: unknown; failureCount: number; failureReason: { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error | null; isPaused: boolean; submittedAt: number; mutateAsync: _tanstack_react_query.UseMutateAsyncFunction<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, void | undefined, unknown>; submitForApproval: () => Promise; } | { data: undefined; variables: void | undefined; error: null; isError: false; isIdle: false; isPending: true; isSuccess: false; status: "pending"; mutate: _tanstack_react_query.UseMutateFunction<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, void | undefined, unknown>; reset: () => void; context: unknown; failureCount: number; failureReason: { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error | null; isPaused: boolean; submittedAt: number; mutateAsync: _tanstack_react_query.UseMutateAsyncFunction<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, void | undefined, unknown>; submitForApproval: () => Promise; } | { data: undefined; error: { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error; variables: void | undefined; isError: true; isIdle: false; isPending: false; isSuccess: false; status: "error"; mutate: _tanstack_react_query.UseMutateFunction<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, void | undefined, unknown>; reset: () => void; context: unknown; failureCount: number; failureReason: { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error | null; isPaused: boolean; submittedAt: number; mutateAsync: _tanstack_react_query.UseMutateAsyncFunction<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, void | undefined, unknown>; submitForApproval: () => Promise; } | { data: { id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }; error: null; variables: void | undefined; isError: false; isIdle: false; isPending: false; isSuccess: true; status: "success"; mutate: _tanstack_react_query.UseMutateFunction<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, void | undefined, unknown>; reset: () => void; context: unknown; failureCount: number; failureReason: { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error | null; isPaused: boolean; submittedAt: number; mutateAsync: _tanstack_react_query.UseMutateAsyncFunction<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, void | undefined, unknown>; submitForApproval: () => Promise; }; declare const useForceRejectPayable: (payableId: string, onRejected?: (id: string) => void) => _tanstack_react_query.UseMutationResult<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, void | undefined, unknown>; declare const useForceApprovePayable: (payableId: string, onApproved?: (id: string) => void) => _tanstack_react_query.UseMutationResult<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, void | undefined, unknown>; declare const useReopenPayable: (payableId: string, onReopened?: (id: string) => void) => _tanstack_react_query.UseMutationResult<{ id: string; created_at: string; updated_at: string; amount_due?: number; amount_paid?: number; amount_to_pay?: number; approval_policy_id?: string; counterpart?: components["schemas"]["CounterpartRawData"]; counterpart_address_id?: string; counterpart_bank_account_id?: string; counterpart_id?: string; counterpart_raw_data?: components["schemas"]["CounterpartRawData"]; counterpart_vat_id_id?: string; credit_notes: components["schemas"]["PayableCreditNoteData"][]; currency?: components["schemas"]["CurrencyEnum"]; currency_exchange?: components["schemas"]["CurrencyExchangeSchema2"]; description?: string; discount?: number; document_id?: string; due_date?: string; einvoice_file_url?: string; enforce_approval_policy_id?: string; entity_id: string; file?: components["schemas"]["FileSchema"]; file_id?: string; issued_at?: string; marked_as_paid_by_entity_user_id?: string; marked_as_paid_with_comment?: string; ocr_request_id?: string; ocr_status?: components["schemas"]["OcrStatusEnum"]; other_extracted_data?: components["schemas"]["OCRResponseInvoiceReceiptData"] | components["schemas"]["OcrRecognitionResponse"]; paid_at?: string; partner_metadata?: Record; payable_origin: components["schemas"]["PayableOriginEnum"]; payment_terms?: components["schemas"]["PayablePaymentTermsCreatePayload"]; project_id?: string; purchase_order_id?: string; sender?: string; source_of_payable_data: components["schemas"]["SourceOfPayableDataEnum"]; status: components["schemas"]["PayableStateEnum"]; subtotal?: number; suggested_payment_term?: components["schemas"]["SuggestedPaymentTerm"]; tags?: components["schemas"]["TagReadSchema"][]; tax?: number; tax_amount?: number; total_amount?: number; total_amount_with_credit_notes?: number; was_created_by_user_id?: string; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error, void | undefined, unknown>; declare const useDeletePayable: (payableId: string, onDeleted?: (id: string) => void) => _tanstack_react_query.UseMutationResult; declare const useGetPayablesAnalytics: (query: Services["finops"]["getAnalyticsPayables"]["types"]["parameters"]["query"], enabled?: boolean) => _tanstack_react_query.UseQueryResult<{ data: components["schemas"]["AnalyticsDataPoint"][]; }, { error: components["schemas"]["ErrorSchema3"]; } | { detail?: components["schemas"]["ValidationError"][]; } | Error>; type ReceivablesProps = { pageTitleComponent: (children: ReactNode) => ReactNode; /** * Display name of the sponsor bank that powers embedded bank accounts, e.g. * "Zenith Bank". Shown next to embedded accounts as "Powered by * {embeddedBankName}" in the invoice payment account picker, on both the * create and the edit form. */ embeddedBankName?: string; /** Arrival prop: 'create' opens the create-invoice dialog on mount. */ initialView?: 'create'; /** Arrival prop: preselects this counterpart in the create-invoice form. */ initialCounterpartId?: string; }; declare const Receivables: (props: ReceivablesProps) => _emotion_react_jsx_runtime.JSX.Element; type ProductsProps = { pageTitleComponent: (children: ReactNode) => ReactNode; }; declare const Products: (props: ProductsProps) => _emotion_react_jsx_runtime.JSX.Element; declare const FILTER_TYPE_SEARCH = "search"; declare const FILTER_TYPE_TYPE = "type"; declare const FILTER_TYPE_UNITS = "units"; type Filters = { [FILTER_TYPE_SEARCH]?: string | null; [FILTER_TYPE_TYPE]?: ProductServiceTypeEnum | null; [FILTER_TYPE_UNITS]?: string | null; }; type FilterValue = ProductServiceTypeEnum | 'all' | string | null; type ProductServiceTypeEnum = components['schemas']['ProductServiceTypeEnum']; type ProductServiceResponse = components['schemas']['ProductServiceResponse']; type ProductCursorFields = components['schemas']['ProductCursorFields']; interface ProductsTableSortModel { field: ProductCursorFields; sort: NonNullable; } interface ProductTableProps { onFilterChanged?: (filter: { field: keyof Filters; value: FilterValue; }) => void; onSortChanged?: (params: ProductsTableSortModel) => void; onRowClick?: (id: string) => void; onDeleted?: (productId: string) => void; openCreateModal?: () => void; } declare const ProductsTable: (props: ProductTableProps) => _emotion_react_jsx_runtime.JSX.Element; interface CreateProductProps { open: boolean; onClose: () => void; onCreated?: (product: ProductServiceResponse) => void; } declare const CreateProduct: (props: CreateProductProps) => _emotion_react_jsx_runtime.JSX.Element; interface ProductDetailsProps { id: string; open: boolean; onClose: () => void; onUpdated?: (product: ProductServiceResponse) => void; onDeleted?: (productId: ProductServiceResponse['id']) => void; showActionsMenu?: boolean; } declare const ProductDetails: (props: ProductDetailsProps) => _emotion_react_jsx_runtime.JSX.Element; interface TagsTableSortModel { field: components['schemas']['TagCursorFields']; sort: NonNullable; } interface TagsTableProps { onChangeSort?: (params: TagsTableSortModel) => void; showCreationModal?: () => void; } declare const TagsTable: (props: TagsTableProps) => _emotion_react_jsx_runtime.JSX.Element; interface ITag { id: string; name: string; category?: components['schemas']['TagCategory']; keywords?: string[] | string; } interface TagFormModalProps { tag?: ITag; onCreate?: (tag: components['schemas']['TagReadSchema']) => void; onUpdate?: (tag: components['schemas']['TagReadSchema']) => void; onClose?: () => void; onDelete?: (tag: components['schemas']['TagReadSchema']) => void; isDeleteAllowed: boolean; /** Whether the modal is open or not */ open: boolean; } /** * `TagFormModal` is responsible for creating or updating * the tag. * If no `tag` provided then the form is working on `creating` mode * If `tag` provided then the form is working on `updating` mode */ declare const TagFormModal: (props: TagFormModalProps) => _emotion_react_jsx_runtime.JSX.Element; declare const Tags: () => _emotion_react_jsx_runtime.JSX.Element; declare const typographyVariants: (props?: ({ variant?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "body1" | "body2" | "caption" | null | undefined; color?: "default" | "primary" | "destructive" | "muted" | null | undefined; } & class_variance_authority_types.ClassProp) | undefined) => string; type TypographyElement = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'span' | 'div'; type TypographyVariants = VariantProps; interface TypographyProps extends Omit, 'color'>, TypographyVariants { component?: TypographyElement; } declare function Typography({ className, variant, color, component, children, ...props }: TypographyProps): React.DetailedReactHTMLElement<{ id?: string | undefined; style?: React.CSSProperties | undefined; role?: React.AriaRole | undefined; content?: string | undefined; translate?: "yes" | "no" | undefined; hidden?: boolean | undefined; slot?: string | undefined; title?: string | undefined; defaultChecked?: boolean | undefined; defaultValue?: string | number | readonly string[] | undefined; suppressContentEditableWarning?: boolean | undefined; suppressHydrationWarning?: boolean | undefined; accessKey?: string | undefined; autoCapitalize?: "off" | "none" | "on" | "sentences" | "words" | "characters" | undefined | (string & {}); autoFocus?: boolean | undefined; contentEditable?: (boolean | "true" | "false") | "inherit" | "plaintext-only" | undefined; contextMenu?: string | undefined; dir?: string | undefined; draggable?: (boolean | "true" | "false") | undefined; enterKeyHint?: "enter" | "done" | "go" | "next" | "previous" | "search" | "send" | undefined; lang?: string | undefined; nonce?: string | undefined; spellCheck?: (boolean | "true" | "false") | undefined; tabIndex?: number | undefined; radioGroup?: string | undefined; about?: string | undefined; datatype?: string | undefined; inlist?: any; prefix?: string | undefined; property?: string | undefined; rel?: string | undefined; resource?: string | undefined; rev?: string | undefined; typeof?: string | undefined; vocab?: string | undefined; autoCorrect?: string | undefined; autoSave?: string | undefined; itemProp?: string | undefined; itemScope?: boolean | undefined; itemType?: string | undefined; itemID?: string | undefined; itemRef?: string | undefined; results?: number | undefined; security?: string | undefined; unselectable?: "on" | "off" | undefined; popover?: "" | "auto" | "manual" | "hint" | undefined; popoverTargetAction?: "toggle" | "show" | "hide" | undefined; popoverTarget?: string | undefined; inert?: boolean | undefined; inputMode?: "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search" | undefined; is?: string | undefined; exportparts?: string | undefined; part?: string | undefined; "aria-activedescendant"?: string | undefined; "aria-atomic"?: (boolean | "true" | "false") | undefined; "aria-autocomplete"?: "none" | "inline" | "list" | "both" | undefined; "aria-braillelabel"?: string | undefined; "aria-brailleroledescription"?: string | undefined; "aria-busy"?: (boolean | "true" | "false") | undefined; "aria-checked"?: boolean | "false" | "mixed" | "true" | undefined; "aria-colcount"?: number | undefined; "aria-colindex"?: number | undefined; "aria-colindextext"?: string | undefined; "aria-colspan"?: number | undefined; "aria-controls"?: string | undefined; "aria-current"?: boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time" | undefined; "aria-describedby"?: string | undefined; "aria-description"?: string | undefined; "aria-details"?: string | undefined; "aria-disabled"?: (boolean | "true" | "false") | undefined; "aria-dropeffect"?: "none" | "copy" | "execute" | "link" | "move" | "popup" | undefined; "aria-errormessage"?: string | undefined; "aria-expanded"?: (boolean | "true" | "false") | undefined; "aria-flowto"?: string | undefined; "aria-grabbed"?: (boolean | "true" | "false") | undefined; "aria-haspopup"?: boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog" | undefined; "aria-hidden"?: (boolean | "true" | "false") | undefined; "aria-invalid"?: boolean | "false" | "true" | "grammar" | "spelling" | undefined; "aria-keyshortcuts"?: string | undefined; "aria-label"?: string | undefined; "aria-labelledby"?: string | undefined; "aria-level"?: number | undefined; "aria-live"?: "off" | "assertive" | "polite" | undefined; "aria-modal"?: (boolean | "true" | "false") | undefined; "aria-multiline"?: (boolean | "true" | "false") | undefined; "aria-multiselectable"?: (boolean | "true" | "false") | undefined; "aria-orientation"?: "horizontal" | "vertical" | undefined; "aria-owns"?: string | undefined; "aria-placeholder"?: string | undefined; "aria-posinset"?: number | undefined; "aria-pressed"?: boolean | "false" | "mixed" | "true" | undefined; "aria-readonly"?: (boolean | "true" | "false") | undefined; "aria-relevant"?: "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text" | "text additions" | "text removals" | undefined; "aria-required"?: (boolean | "true" | "false") | undefined; "aria-roledescription"?: string | undefined; "aria-rowcount"?: number | undefined; "aria-rowindex"?: number | undefined; "aria-rowindextext"?: string | undefined; "aria-rowspan"?: number | undefined; "aria-selected"?: (boolean | "true" | "false") | undefined; "aria-setsize"?: number | undefined; "aria-sort"?: "none" | "ascending" | "descending" | "other" | undefined; "aria-valuemax"?: number | undefined; "aria-valuemin"?: number | undefined; "aria-valuenow"?: number | undefined; "aria-valuetext"?: string | undefined; dangerouslySetInnerHTML?: { __html: string | TrustedHTML; } | undefined; onCopy?: React.ClipboardEventHandler | undefined; onCopyCapture?: React.ClipboardEventHandler | undefined; onCut?: React.ClipboardEventHandler | undefined; onCutCapture?: React.ClipboardEventHandler | undefined; onPaste?: React.ClipboardEventHandler | undefined; onPasteCapture?: React.ClipboardEventHandler | undefined; onCompositionEnd?: React.CompositionEventHandler | undefined; onCompositionEndCapture?: React.CompositionEventHandler | undefined; onCompositionStart?: React.CompositionEventHandler | undefined; onCompositionStartCapture?: React.CompositionEventHandler | undefined; onCompositionUpdate?: React.CompositionEventHandler | undefined; onCompositionUpdateCapture?: React.CompositionEventHandler | undefined; onFocus?: React.FocusEventHandler | undefined; onFocusCapture?: React.FocusEventHandler | undefined; onBlur?: React.FocusEventHandler | undefined; onBlurCapture?: React.FocusEventHandler | undefined; onChange?: React.ChangeEventHandler | undefined; onChangeCapture?: React.ChangeEventHandler | undefined; onBeforeInput?: React.InputEventHandler | undefined; onBeforeInputCapture?: React.InputEventHandler | undefined; onInput?: React.InputEventHandler | undefined; onInputCapture?: React.InputEventHandler | undefined; onReset?: React.ReactEventHandler | undefined; onResetCapture?: React.ReactEventHandler | undefined; onSubmit?: React.SubmitEventHandler | undefined; onSubmitCapture?: React.SubmitEventHandler | undefined; onInvalid?: React.ReactEventHandler | undefined; onInvalidCapture?: React.ReactEventHandler | undefined; onLoad?: React.ReactEventHandler | undefined; onLoadCapture?: React.ReactEventHandler | undefined; onError?: React.ReactEventHandler | undefined; onErrorCapture?: React.ReactEventHandler | undefined; onKeyDown?: React.KeyboardEventHandler | undefined; onKeyDownCapture?: React.KeyboardEventHandler | undefined; onKeyPress?: React.KeyboardEventHandler | undefined; onKeyPressCapture?: React.KeyboardEventHandler | undefined; onKeyUp?: React.KeyboardEventHandler | undefined; onKeyUpCapture?: React.KeyboardEventHandler | undefined; onAbort?: React.ReactEventHandler | undefined; onAbortCapture?: React.ReactEventHandler | undefined; onCanPlay?: React.ReactEventHandler | undefined; onCanPlayCapture?: React.ReactEventHandler | undefined; onCanPlayThrough?: React.ReactEventHandler | undefined; onCanPlayThroughCapture?: React.ReactEventHandler | undefined; onDurationChange?: React.ReactEventHandler | undefined; onDurationChangeCapture?: React.ReactEventHandler | undefined; onEmptied?: React.ReactEventHandler | undefined; onEmptiedCapture?: React.ReactEventHandler | undefined; onEncrypted?: React.ReactEventHandler | undefined; onEncryptedCapture?: React.ReactEventHandler | undefined; onEnded?: React.ReactEventHandler | undefined; onEndedCapture?: React.ReactEventHandler | undefined; onLoadedData?: React.ReactEventHandler | undefined; onLoadedDataCapture?: React.ReactEventHandler | undefined; onLoadedMetadata?: React.ReactEventHandler | undefined; onLoadedMetadataCapture?: React.ReactEventHandler | undefined; onLoadStart?: React.ReactEventHandler | undefined; onLoadStartCapture?: React.ReactEventHandler | undefined; onPause?: React.ReactEventHandler | undefined; onPauseCapture?: React.ReactEventHandler | undefined; onPlay?: React.ReactEventHandler | undefined; onPlayCapture?: React.ReactEventHandler | undefined; onPlaying?: React.ReactEventHandler | undefined; onPlayingCapture?: React.ReactEventHandler | undefined; onProgress?: React.ReactEventHandler | undefined; onProgressCapture?: React.ReactEventHandler | undefined; onRateChange?: React.ReactEventHandler | undefined; onRateChangeCapture?: React.ReactEventHandler | undefined; onSeeked?: React.ReactEventHandler | undefined; onSeekedCapture?: React.ReactEventHandler | undefined; onSeeking?: React.ReactEventHandler | undefined; onSeekingCapture?: React.ReactEventHandler | undefined; onStalled?: React.ReactEventHandler | undefined; onStalledCapture?: React.ReactEventHandler | undefined; onSuspend?: React.ReactEventHandler | undefined; onSuspendCapture?: React.ReactEventHandler | undefined; onTimeUpdate?: React.ReactEventHandler | undefined; onTimeUpdateCapture?: React.ReactEventHandler | undefined; onVolumeChange?: React.ReactEventHandler | undefined; onVolumeChangeCapture?: React.ReactEventHandler | undefined; onWaiting?: React.ReactEventHandler | undefined; onWaitingCapture?: React.ReactEventHandler | undefined; onAuxClick?: React.MouseEventHandler | undefined; onAuxClickCapture?: React.MouseEventHandler | undefined; onClick?: React.MouseEventHandler | undefined; onClickCapture?: React.MouseEventHandler | undefined; onContextMenu?: React.MouseEventHandler | undefined; onContextMenuCapture?: React.MouseEventHandler | undefined; onDoubleClick?: React.MouseEventHandler | undefined; onDoubleClickCapture?: React.MouseEventHandler | undefined; onDrag?: React.DragEventHandler | undefined; onDragCapture?: React.DragEventHandler | undefined; onDragEnd?: React.DragEventHandler | undefined; onDragEndCapture?: React.DragEventHandler | undefined; onDragEnter?: React.DragEventHandler | undefined; onDragEnterCapture?: React.DragEventHandler | undefined; onDragExit?: React.DragEventHandler | undefined; onDragExitCapture?: React.DragEventHandler | undefined; onDragLeave?: React.DragEventHandler | undefined; onDragLeaveCapture?: React.DragEventHandler | undefined; onDragOver?: React.DragEventHandler | undefined; onDragOverCapture?: React.DragEventHandler | undefined; onDragStart?: React.DragEventHandler | undefined; onDragStartCapture?: React.DragEventHandler | undefined; onDrop?: React.DragEventHandler | undefined; onDropCapture?: React.DragEventHandler | undefined; onMouseDown?: React.MouseEventHandler | undefined; onMouseDownCapture?: React.MouseEventHandler | undefined; onMouseEnter?: React.MouseEventHandler | undefined; onMouseLeave?: React.MouseEventHandler | undefined; onMouseMove?: React.MouseEventHandler | undefined; onMouseMoveCapture?: React.MouseEventHandler | undefined; onMouseOut?: React.MouseEventHandler | undefined; onMouseOutCapture?: React.MouseEventHandler | undefined; onMouseOver?: React.MouseEventHandler | undefined; onMouseOverCapture?: React.MouseEventHandler | undefined; onMouseUp?: React.MouseEventHandler | undefined; onMouseUpCapture?: React.MouseEventHandler | undefined; onSelect?: React.ReactEventHandler | undefined; onSelectCapture?: React.ReactEventHandler | undefined; onTouchCancel?: React.TouchEventHandler | undefined; onTouchCancelCapture?: React.TouchEventHandler | undefined; onTouchEnd?: React.TouchEventHandler | undefined; onTouchEndCapture?: React.TouchEventHandler | undefined; onTouchMove?: React.TouchEventHandler | undefined; onTouchMoveCapture?: React.TouchEventHandler | undefined; onTouchStart?: React.TouchEventHandler | undefined; onTouchStartCapture?: React.TouchEventHandler | undefined; onPointerDown?: React.PointerEventHandler | undefined; onPointerDownCapture?: React.PointerEventHandler | undefined; onPointerMove?: React.PointerEventHandler | undefined; onPointerMoveCapture?: React.PointerEventHandler | undefined; onPointerUp?: React.PointerEventHandler | undefined; onPointerUpCapture?: React.PointerEventHandler | undefined; onPointerCancel?: React.PointerEventHandler | undefined; onPointerCancelCapture?: React.PointerEventHandler | undefined; onPointerEnter?: React.PointerEventHandler | undefined; onPointerLeave?: React.PointerEventHandler | undefined; onPointerOver?: React.PointerEventHandler | undefined; onPointerOverCapture?: React.PointerEventHandler | undefined; onPointerOut?: React.PointerEventHandler | undefined; onPointerOutCapture?: React.PointerEventHandler | undefined; onGotPointerCapture?: React.PointerEventHandler | undefined; onGotPointerCaptureCapture?: React.PointerEventHandler | undefined; onLostPointerCapture?: React.PointerEventHandler | undefined; onLostPointerCaptureCapture?: React.PointerEventHandler | undefined; onScroll?: React.UIEventHandler | undefined; onScrollCapture?: React.UIEventHandler | undefined; onScrollEnd?: React.UIEventHandler | undefined; onScrollEndCapture?: React.UIEventHandler | undefined; onWheel?: React.WheelEventHandler | undefined; onWheelCapture?: React.WheelEventHandler | undefined; onAnimationStart?: React.AnimationEventHandler | undefined; onAnimationStartCapture?: React.AnimationEventHandler | undefined; onAnimationEnd?: React.AnimationEventHandler | undefined; onAnimationEndCapture?: React.AnimationEventHandler | undefined; onAnimationIteration?: React.AnimationEventHandler | undefined; onAnimationIterationCapture?: React.AnimationEventHandler | undefined; onToggle?: React.ToggleEventHandler | undefined; onBeforeToggle?: React.ToggleEventHandler | undefined; onTransitionCancel?: React.TransitionEventHandler | undefined; onTransitionCancelCapture?: React.TransitionEventHandler | undefined; onTransitionEnd?: React.TransitionEventHandler | undefined; onTransitionEndCapture?: React.TransitionEventHandler | undefined; onTransitionRun?: React.TransitionEventHandler | undefined; onTransitionRunCapture?: React.TransitionEventHandler | undefined; onTransitionStart?: React.TransitionEventHandler | undefined; onTransitionStartCapture?: React.TransitionEventHandler | undefined; className: string; }, HTMLElement>; type PageHeaderProps = { title: ReactNode; extra?: ReactNode; className?: string; /** Title size. Defaults to `h2` (30px) for standalone Monite pages; the * settings-embedded surfaces pass `h3` (24px) to match the first-party * section headings they sit alongside. */ titleVariant?: ComponentProps['variant']; }; declare const PageHeader: ({ title, extra, className, titleVariant, }: PageHeaderProps) => _emotion_react_jsx_runtime.JSX.Element; type ALIGN_DIALOG_TYPES = 'left' | 'right'; declare module '@mui/material/transitions' { interface TransitionProps { alignDialog?: ALIGN_DIALOG_TYPES; } } interface MoniteDialogProps extends DialogProps { alignDialog?: ALIGN_DIALOG_TYPES; onClosed?: () => void; } interface DialogContextType { isDialogContent: boolean; onClose?: (...args: any[]) => void; } declare const useDialog: () => DialogContextType | undefined; declare const Dialog: ({ ref, ...props }: MoniteDialogProps & { ref?: Ref; }) => _emotion_react_jsx_runtime.JSX.Element; declare function Integrations(): _emotion_react_jsx_runtime.JSX.Element; type TemplateSettingsProps = { /** Flag that controls whether settings are shown inside a side panel or not */ isDialog?: boolean; /** Flag that controls whether dialog is open or not. It's meant to be passed in when isDialog is true */ isOpen?: boolean; /** Callback function that is called when you close the dialog. It's meant to be passed in when isDialog is true */ handleCloseDialog?: () => void; }; declare const TemplateSettings: (props: TemplateSettingsProps) => _emotion_react_jsx_runtime.JSX.Element; declare const FinanceBanner: (props: FinanceBannerProps) => _emotion_react_jsx_runtime.JSX.Element; type FinanceBannerProps = { /** `enableServicingBanner` is a boolean flag that enables the `FinanceBanner` to be a small summarized version of the financing tab, but only works when entity is onboarded and is servicing. */ enableServicingBanner?: boolean; /** Function that is called when clicking on View Details button. * The button will only appear when entity is servicing, enableServicingBanner is true and handleViewDetails is passed. * The purpose of this button is to give the user a way to navigate to the financing page through it. */ handleViewDetails?: () => void; }; declare const FinanceIntegrationCard: () => _emotion_react_jsx_runtime.JSX.Element | null; interface FinanceInvoiceProps { invoice: components['schemas']['InvoiceResponsePayload']; } declare const FinanceInvoice: ({ invoice }: FinanceInvoiceProps) => _emotion_react_jsx_runtime.JSX.Element | null; declare const FinanceTab: ({ onRowClick, }: { onRowClick?: (invoice_id: string) => void; }) => _emotion_react_jsx_runtime.JSX.Element | null; declare const Combobox: typeof Combobox$1.Root; declare function ComboboxValue({ ...props }: Combobox$1.Value.Props): _emotion_react_jsx_runtime.JSX.Element; declare function ComboboxTrigger({ className, children, ...props }: Combobox$1.Trigger.Props): _emotion_react_jsx_runtime.JSX.Element; declare function ComboboxInput({ className, children, disabled, showTrigger, showClear, ...props }: Combobox$1.Input.Props & { showTrigger?: boolean; showClear?: boolean; }): _emotion_react_jsx_runtime.JSX.Element; declare function ComboboxContent({ className, side, sideOffset, align, alignOffset, anchor, container, ...props }: Combobox$1.Popup.Props & Pick & { container?: HTMLElement | React.RefObject | null; }): _emotion_react_jsx_runtime.JSX.Element; declare function ComboboxList({ className, ...props }: Combobox$1.List.Props): _emotion_react_jsx_runtime.JSX.Element; declare function ComboboxItem({ className, children, ...props }: Combobox$1.Item.Props): _emotion_react_jsx_runtime.JSX.Element; declare function ComboboxGroup({ className, ...props }: Combobox$1.Group.Props): _emotion_react_jsx_runtime.JSX.Element; declare function ComboboxLabel({ className, ...props }: Combobox$1.GroupLabel.Props): _emotion_react_jsx_runtime.JSX.Element; declare function ComboboxCollection({ ...props }: Combobox$1.Collection.Props): _emotion_react_jsx_runtime.JSX.Element; declare function ComboboxEmpty({ className, ...props }: Combobox$1.Empty.Props): _emotion_react_jsx_runtime.JSX.Element; declare function ComboboxSeparator({ className, ...props }: Combobox$1.Separator.Props): _emotion_react_jsx_runtime.JSX.Element; declare function ComboboxChips({ className, ...props }: React.ComponentPropsWithRef & Combobox$1.Chips.Props): _emotion_react_jsx_runtime.JSX.Element; declare function ComboboxChip({ className, children, showRemove, ...props }: Combobox$1.Chip.Props & { showRemove?: boolean; }): _emotion_react_jsx_runtime.JSX.Element; declare function ComboboxChipsInput({ className, children, ...props }: Combobox$1.Input.Props): _emotion_react_jsx_runtime.JSX.Element; declare function useComboboxAnchor(): React.RefObject; type MoniteSupportedMessages = Messages; type MoniteLocale = { /** * `code` responsible for internationalised Widgets language, internationalised number and currency formatting. * By default, it uses `navigator.language` as a fallback in MoniteProvider. * Intl format values are accepted and won't cause any trouble. * * E.g. 'en-GB', 'de-DE', etc. */ code?: string; /** * `messages` responsible for internationalised Widgets translation. * By default, it uses `enLocaleMessages` as a fallback in MoniteProvider. * * The message object is a key-value pair where the key is the Message ID, * and the value is the message string or a `LinguiContextMessage` object. * * If you need to use context (`msgctxt`) for differentiating messages with the same ID, * you can use the LinguiContextMessage object. * * @example Without context: * ```ts * { * "Hello": "Hallo" * } * ``` * * @example With the context: * ```ts * { * "View": [ * { msgstr: "Rechnung ansehen", msgctxt: "InvoicesTableRowActionMenu" }, * { msgstr: "Siehe" }, * ] * } * ``` * In the example with context, `InvoicesTableRowActionMenu` is the context for the message "View". * This can be useful when the same message ID needs to be translated differently in different contexts. */ messages?: MoniteSupportedMessages; /** * `currencyNumberFormat` responsible for currency formatting. */ currencyNumberFormat?: { /** * Determines the format in which currency values are displayed. * * Possible values are: * - 'symbol': The currency is represented using its symbol (e.g., $ for USD) * - 'code': The currency is represented using its ISO code (e.g., USD for US Dollar) * - 'name': The currency is represented using its full name (e.g., US Dollar) */ display?: 'symbol' | 'code' | 'name'; /** * The locale code to use for formatting the currency number. * If not provided, the `code` will be used. * * @example 'en-US', 'de-DE', 'en-150', etc. */ localeCode?: string; }; /** * `dateFormat` responsible for date & time formatting. It is used in the `Intl.DateTimeFormat` constructor. * * By default, it uses the following options: * ```ts * { * day: '2-digit', * month: 'short', * year: 'numeric', * hour: '2-digit', * minute: '2-digit', * } * ``` */ dateFormat?: Pick; }; type MoniteLocaleWithRequired = DeepRequired> & Partial> & { dateTimeFormat?: Intl.DateTimeFormatOptions; }; type TypographyStyle = { fontSize?: string | number; fontWeight?: string | number; lineHeight?: string | number; textTransform?: 'uppercase' | 'lowercase' | 'capitalize'; }; /** * Configuration for customizing button styles * Supports all CSS properties including gradients for backgrounds * * @example * ```typescript * const buttonConfig: ButtonStyleConfig = { * background: 'linear-gradient(135deg, #667eea 0%, #764ba2 100%)', * color: '#ffffff', * border: '2px solid #667eea', * borderRadius: 12, * fontWeight: 600, * hover: { * background: 'linear-gradient(135deg, #5568d3 0%, #65408b 100%)', * }, * }; * ``` */ interface ButtonStyleConfig { /** * Background color or CSS gradient * @example '#667eea' * @example 'linear-gradient(135deg, #667eea 0%, #764ba2 100%)' */ background?: string; /** * Text color * @example '#ffffff' */ color?: string; /** * Border style (CSS shorthand) * @example '2px solid #667eea' * @example 'none' */ border?: string; /** * Border radius in pixels or CSS value * @example 8 * @example '0.5rem' */ borderRadius?: string | number; /** * Font weight * @example 400 * @example 600 * @example 'bold' */ fontWeight?: string | number; /** * Box shadow for elevation effects * @example '0 4px 6px rgba(0, 0, 0, 0.1)' * @example '0 10px 25px rgba(0, 0, 0, 0.15), 0 4px 10px rgba(0, 0, 0, 0.08)' */ boxShadow?: string; /** * CSS transition duration * @example '200ms' * @example '0.3s' */ transitionDuration?: string; /** * CSS transition timing function * @example 'ease-in-out' * @example 'cubic-bezier(0.4, 0, 0.2, 1)' */ transitionTimingFunction?: string; /** * CSS transition property (which properties to animate) * @example 'all' * @example 'background, color, box-shadow' */ transitionProperty?: string; hover?: Partial>; active?: Partial>; focus?: Partial>; disabled?: Partial>; } type ThemeConfig = { borderRadius?: number; spacing?: number; colors?: { primary?: string; primaryForeground?: string; secondary?: string; neutral?: string; info?: string; success?: string; warning?: string; error?: string; background?: string; text?: string; rowBorder?: string; }; typography?: { fontFamily?: string; fontSize?: number; h1?: TypographyStyle; h2?: TypographyStyle; h3?: TypographyStyle; subtitle1?: TypographyStyle; subtitle2?: TypographyStyle; body1?: TypographyStyle; body2?: TypographyStyle; }; components?: { invoiceStatusChip?: Partial; payableStatusChip?: Partial; approvalRequestStatusChip?: Partial; invoiceRecurrenceStatusChip?: Partial; invoiceRecurrenceIterationStatusChip?: Partial; counterpartStatusChip?: Partial; approvalStatusChip?: Partial; styles?: { payables?: { button?: { primary?: ButtonStyleConfig; secondary?: ButtonStyleConfig; tertiary?: ButtonStyleConfig; destructive?: ButtonStyleConfig; }; }; }; }; }; interface BaseChipProps { /** The variant of the Chip. */ variant?: 'filled' | 'outlined'; /** The size of the Chip. */ size?: 'small' | 'medium'; } interface BaseStatusChipProps extends BaseChipProps { /** Display status icon? Set to false for dot, true for full icon, null to hide completely */ icon?: boolean | null; } type MoniteCounterpartType = 'customer' | 'vendor'; interface MoniteInvoiceStatusChipProps extends BaseStatusChipProps { /** The status of the invoice. */ status: components['schemas']['ReceivablesStatusEnum']; } interface MoniteInvoiceRecurrenceStatusChipProps extends BaseStatusChipProps { /** The status of the recurrence. */ status: components['schemas']['RecurrenceStatus']; } interface MoniteInvoiceRecurrenceIterationStatusChipProps extends BaseStatusChipProps { /** The status of the iteration. */ status: components['schemas']['IterationStatus']; } interface MonitePayableStatusChipProps extends BaseStatusChipProps { /** The status of the payable. */ status: components['schemas']['PayableStateEnum']; /** Custom colors for each payable status */ colors?: Partial>; } interface MoniteCounterpartStatusChipProps extends BaseChipProps { /** The status of the invoice. */ status: MoniteCounterpartType; } interface MoniteApprovalRequestStatusChipProps extends BaseStatusChipProps { /** The status of the approval request. */ status: components['schemas']['ApprovalRequestStatus']; } interface MoniteApprovalStatusChipProps extends BaseStatusChipProps { /** The status of the payable. */ status: components['schemas']['ApprovalPolicyStatus']; } interface MoniteSettings { entityId: string; apiUrl?: string; fetchToken: () => Promise<{ access_token: string; expires_in: number; token_type: string; }>; /** Custom headers to include in every Monite API request (e.g. x-widget-token) */ headers?: Record; /** * Custom `fetch` used for every Monite API request. Lets a host route Monite * traffic through its own request pipeline (e.g. a gateway proxy that injects * auth) instead of hitting `apiUrl` directly. */ fetch?: typeof fetch; } interface MoniteProviderProps { children?: ReactNode; /** * `theme` responsible for global styling of all Widgets provided. * If `theme` is not provided, `Monite` uses default theme. */ theme?: ThemeConfig; /** Monite initial settings */ monite: MoniteSettings; /** * `locale` responsible for internationalisation * of all Widgets provided. */ locale?: MoniteLocale; /** * Component settings */ componentSettings?: Partial; /** * Callback function that is called when the theme is mounted */ onThemeMounted?: () => void; /** * Raw scope strings from `/me` (e.g. `invoice:read:org`). * Used by components that gate UI with `userPermissions.has(Scope.*)`. */ userPermissions?: ReadonlySet; } declare const MoniteProvider: ({ monite, theme, componentSettings, children, locale, onThemeMounted, userPermissions, }: MoniteProviderProps) => _emotion_react_jsx_runtime.JSX.Element; declare const RootElementsContext: React.Context<{ styles: HTMLElement | undefined; root: HTMLElement | undefined; }>; declare const useRootElements: () => { styles: HTMLElement | undefined; root: HTMLElement | undefined; }; declare const RootElementsProvider: ({ children, elements, }: { children: ReactNode; elements?: ContextType; }) => _emotion_react_jsx_runtime.JSX.Element; interface MoniteContextBaseValue { locale: MoniteLocaleWithRequired; i18n: I18n; dateFnsLocale: Locale; } type FetchToken = () => Promise<{ access_token: string; expires_in: number; token_type: string; }>; /** * MoniteTheme extends the MUI Theme with custom palette properties. * The custom palette structure is defined via module augmentation in mui-styles.d.ts */ type MoniteTheme = Theme$1 & { components?: ThemeConfig['components']; }; interface MoniteContextValue extends MoniteContextBaseValue, CreateMoniteAPIClientResult { environment: 'dev' | 'sandbox' | 'production'; entityId: string; sentryHub: Scope | undefined; queryClient: QueryClient; apiUrl: string; theme: MoniteTheme; componentSettings: ComponentSettings; fetchToken: FetchToken; userPermissions: ReadonlySet; } /** * @internal */ declare function useMoniteContext(): MoniteContextValue; type CountriesType = Record; type CountryType = { code: AllowedCountries; label: string; }; declare const getCountriesArray: (i18n: I18n) => CountryType[]; declare const getCountries: (i18n: I18n) => CountriesType; declare const defaultAvailableCountries: AllowedCountries[]; declare const countryCurrencyList: { country: string; currency: string; }[]; type AllowedCountries = components['schemas']['AllowedCountries']; type CurrenciesType = Record; type CurrencyType = { code: CurrencyEnum; label: string; }; declare const getCurrencies: (i18n: I18n) => CurrenciesType; declare const defaultAvailableCurrencies: CurrencyEnum[]; declare const getCurrenciesArray: (i18n: I18n) => Array; type CurrencyEnum = components['schemas']['CurrencyEnum']; interface CurrencyGroup { title: string; predicate: (option: CurrencyType) => boolean; } declare const filterOptions: (options: CurrencyType[], state: { inputValue: string; }) => CurrencyType[]; declare const getGroupTitleForOption: (option: CurrencyType, groups?: CurrencyGroup[]) => { title: string; index: number; }; declare const sortCurrencyOptionsByGroup: (options: CurrencyType[], groups?: CurrencyGroup[]) => CurrencyType[]; /** * Converts a currency rate from minor units (API format) to major units (UI display format) * Example: 2000 -> 20 * Uses core currency conversion utilities for consistency and precision. * Rates always use 2 decimal places. * @param rateMinor The rate value in minor units (as received from API) * @returns The rate value in major units (for UI display) */ declare const rateMinorToMajor: (rateMinor: number) => number; /** * Converts a currency rate from major units (UI display format) to minor units (API format) * Example: 20 -> 2000 * Uses core currency conversion utilities for consistency and precision. * Rates always use 2 decimal places. * @param rateMajor The rate value in major units (from UI) * @returns The rate value in minor units (for API) */ declare const rateMajorToMinor: (rateMajor: number) => number; /** * Utility functions for handling user names and display logic */ /** * Combines first and last name into a full name string. * Handles both object and separate parameter formats. * * @param firstName - First name string or object with first_name and last_name properties * @param lastName - Last name string (only used when firstName is a string) * @returns Combined full name with proper spacing and trimming */ declare function getIndividualName(name: { first_name: string | undefined; last_name: string | undefined; }): string; declare function getIndividualName(firstName: string | undefined, lastName: string | undefined): string; /** * Gets individual name with fallback to login if name is empty. * Useful for user display components that need to show something meaningful. * * @param user - User object with name and login properties * @returns Full name if available, otherwise login, or empty string */ declare function getIndividualNameWithFallback(user: { first_name?: string | null; last_name?: string | null; login?: string | null; }): string; /** * Gets the display name for a user based on preferences. * Shows email if requested, otherwise shows full name with login fallback. * * @param user - User object with name, email, and login properties * @param showEmail - Whether to prioritize email over name * @returns Appropriate display name based on preferences */ declare function getUserDisplayName(user: { first_name?: string | null; last_name?: string | null; email?: string | null; login?: string | null; }, showEmail?: boolean): string; declare const dateStringToLocalDate: (dateString: string) => Date; /** * Filter chip date-range segment (without the field prefix), e.g. `Jan 1, 2026 - Jan 31, 2026`. * Each bound uses `MMM d, yyyy` in the runtime locale. */ declare function formatDateRangeFilterChip(from?: Date, to?: Date): string; /** * Value segment for a multi-select filter chip (field prefix added by caller), e.g. * `New` or `New + 2 more` when additional selections exist. * * @param selectedLabels Human-readable labels in display order. */ declare function formatFilterChipMultiSelectValueSegment(selectedLabels: string[]): string; /** * Provides a single instance of `` component, * `` and `` components. * This component prevents the creation of multiple `div` wrappers with the same styles, * and multiple Emotion Caches */ declare const MoniteScopedProviders: ({ children, }: { children: ReactNode; }) => _emotion_react_jsx_runtime.JSX.Element; declare const MoniteAPIProvider: ({ children, APIContext, }: { children?: ReactNode; APIContext: Context; }) => _emotion_react_jsx_runtime.JSX.Element; export { schema_d as APISchema, ApprovalPolicies, ApprovalPoliciesTable, ApprovalPolicyDetails, ApprovalRequests, ApprovalRequestsTable, Combobox, ComboboxChip, ComboboxChips, ComboboxChipsInput, ComboboxCollection, ComboboxContent, ComboboxEmpty, ComboboxGroup, ComboboxInput, ComboboxItem, ComboboxLabel, ComboboxList, ComboboxSeparator, ComboboxTrigger, ComboboxValue, CounterpartAutocomplete, CounterpartDetails, Counterparts, CreateProduct, CreateReceivables, CreditNotesTable, CustomersTable, Dialog, FinanceBanner, FinanceIntegrationCard, FinanceInvoice, FinanceTab, Integrations, InvoicesTable, LOGO_MAX_FILE_SIZE_IN_MB, LOGO_SUPPORTED_FORMATS, MoniteAPIProvider, MoniteProvider, MoniteScopedProviders, OCR_SUPPORTED_FORMATS, PageHeader, PayableDetails, Payables, PayablesTable, ProductDetails, Products, ProductsTable, QuotesTable, Receivables, ReceivablesTable, ReceivablesTableTabEnum, RootElementsProvider, TagFormModal, Tags, TagsTable, TemplateSettings, VendorsTable, breakpoints, countryCurrencyList, createAPIClient, dateStringToLocalDate, defaultAvailableCountries, defaultAvailableCurrencies, defaultCounterpartColumnWidth, filterOptions, formatDateRangeFilterChip, formatFilterChipMultiSelectValueSegment, getCounterpartName, getCountries, getCountriesArray, getCurrencies, getCurrenciesArray, getEntityName, getGroupTitleForOption, getIndividualName, getIndividualNameWithFallback, getPayableRefetchInterval, getUserDisplayName, rateMajorToMinor, rateMinorToMajor, sortCurrencyOptionsByGroup, useApprovalPolicyById, useAreCounterpartsLoading, useAutosizeGridColumns, useCancelPayableById, useComboboxAnchor, useComponentSettings, useCounterpartAddresses, useCounterpartById, useCounterpartContactList, useCounterpartList, useCounterpartVatList, useCreatePayable, useCreatePayableLineItem, useCreatePaymentRecord, useCurrencies, useDebounce, useDebounceCallback, useDeletePayable, useDeletePayableLineItem, useDialog, useEntitySettings, useEntityUserByAuthToken, useEntityUserById, useFileById, useFileInput, useForceApprovePayable, useForceRejectPayable, useFormPersist, useGetPayableApprovalRequests, useGetPayableById, useGetPayableCounterpart, useGetPayableLineItems, useGetPayablesAnalytics, useGetReceivableById, useIsDesktopScreen, useIsExtraLargeDesktopScreen, useIsLargeDesktopScreen, useIsLargerThan, useIsMobile, useIsMobileScreen, useIsMounted, useIsSmallerThan, useIsTabletScreen, useLedgerAccounts, useLocalStorageFields, useMe, useMediaQuery, useMenuButton, useMoniteContext, useMyEntity, useOptionalFields, usePatchEntitiesIdSettings, usePayButtonVisibility, usePayableCallbacks, usePayableDetailsThemeProps, usePayablePaymentIntentsAndRecords, usePaymentIntentById, usePaymentRecordById, usePaymentRecords, useReceivablesTableProps, useReopenPayable, useRootElements, useSubmitPayableForApproval, useUpdatePayable, useUpdatePayableLineItem }; export type { ApprovalPolicyDetailsProps, ComponentSettings, CounterpartResponse, CounterpartsAutocompleteOptionProps, CountriesType, CountryType, CreateMoniteAPIClientOptions, CreateMoniteAPIClientResult, CreateProductProps, CreateReceivableResult, CreateReceivableSubmitMode, CreateReceivablesProps, CreditNotesTableSortModel, CurrenciesType, CurrencyGroup, CurrencyType, CustomersTableProps, InvoicesTableProps, MoniteApprovalRequestStatusChipProps, MoniteApprovalStatusChipProps, MoniteCounterpartStatusChipProps, MoniteDialogProps, MoniteInvoiceRecurrenceIterationStatusChipProps, MoniteInvoiceRecurrenceStatusChipProps, MoniteInvoiceStatusChipProps, MonitePayableStatusChipProps, MoniteReceivablesTableProps, MoniteSettings, PaginationLayout, PaginationPosition, PayActionHandlers, PayablesDetailsProps, PayablesProps, ProductDetailsProps, ProductTableProps, ProductsProps, QuotesTableSortModel, ReceivableGridSortModel, ReceivablesProps, ReceivablesTableProps, TemplateSettingsProps, UseFileInputOptions, VendorDetailsProps, VendorsTableProps };