openapi: 3.2.0 info: title: Monite Partner settings API contact: name: Monite team url: https://monite.com/about/ email: developers@monite.com termsOfService: https://monite.com/terms version: '1.0' description: 'Operations tagged Partner settings across 3 of this provider''s published API definitions: monite-openapi-2023-09-01.json, monite-openapi-2024-05-25.json, monite-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment tags: - name: Partner settings paths: /settings: get: tags: - Partner settings summary: Get partner settings description: Retrieve all settings for this partner. operationId: get_settings parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PartnerProjectSettingsPayload-Output' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] patch: tags: - Partner settings summary: Update partner settings description: Change the specified fields with the provided values. operationId: patch_settings parameters: - required: true schema: type: string format: date example: '2023-09-01' name: x-monite-version in: header requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PartnerProjectSettingsPayload-Input' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PartnerProjectSettingsPayload-Output' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorSchemaResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] servers: - url: https://api.dev.monite.com/v1 description: Development environment - url: https://api.sandbox.monite.com/v1 description: Sandbox environment - url: https://api.monite.com/v1 description: Production environment (Europe) - url: https://us.api.monite.com/v1 description: Production environment (North America) - url: https://api.monite.oaknorth.co.uk/v1 description: Oak POC environment components: schemas: CardTheme: properties: background_color: anyOf: - type: string format: color - type: 'null' type: object PaymentsSettings-Input: properties: payment_page_domain: anyOf: - type: string - type: 'null' payment_page_theme: anyOf: - $ref: '#/components/schemas/PaymentPageTheme-Input' - type: 'null' support_email: anyOf: - type: string format: email - type: 'null' description: The support email address type: object PaymentPageTheme-Output: properties: background_color: anyOf: - type: string format: color - type: 'null' border_radius: anyOf: - type: string - type: 'null' button: anyOf: - $ref: '#/components/schemas/ButtonTheme' - type: 'null' card: anyOf: - $ref: '#/components/schemas/CardTheme' - type: 'null' font_color: anyOf: - type: string format: color - type: 'null' font_family: anyOf: - type: string - type: 'null' font_link_href: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' logo_src: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' type: object CardTheme-Input: properties: background_color: anyOf: - type: string format: color - type: 'null' type: object PaymentsSettings-Output: properties: payment_page_domain: anyOf: - type: string - type: 'null' payment_page_theme: anyOf: - $ref: '#/components/schemas/PaymentPageTheme-Output' - type: 'null' support_email: anyOf: - type: string format: email - type: 'null' description: The support email address type: object CurrencySettings-Input: properties: default: $ref: '#/components/schemas/CurrencyEnum' exchange_rates: items: anyOf: - $ref: '#/components/schemas/ExchangeRate' - type: 'null' type: array additionalProperties: false type: object required: - default ButtonTheme-Input: properties: primary_color: anyOf: - type: string format: color - type: 'null' primary_hover_color: anyOf: - type: string format: color - type: 'null' secondary_color: anyOf: - type: string format: color - type: 'null' secondary_hover_color: anyOf: - type: string format: color - type: 'null' type: object Unit: properties: designation: type: string minLength: 1 examples: - kg name: type: string minLength: 1 examples: - Kilogram type: object required: - designation - name PayableSettings: properties: allow_cancel_duplicates_automatically: anyOf: - type: boolean - type: 'null' default: false allow_counterpart_autocreation: anyOf: - type: boolean - type: 'null' default: false allow_counterpart_autolinking: anyOf: - type: boolean - type: 'null' default: false approve_page_url: type: string minLength: 1 format: uri examples: - https://monite.com default_state: anyOf: - type: string - type: 'null' description: A state each new payable will have upon creation examples: - new enable_line_items: type: boolean description: Partners can set this to True or False to control line item detection in OCR flows. default: true skip_approval_for_paid_invoice: anyOf: - type: boolean - type: 'null' default: false type: object required: - approve_page_url AccountingProviderEnum: type: string enum: - codat - railz ExchangeRate: properties: base: $ref: '#/components/schemas/CurrencyEnum' examples: - USD rate: type: number exclusiveMinimum: 0.0 examples: - 0.98 to: $ref: '#/components/schemas/CurrencyEnum' examples: - EUR additionalProperties: false type: object required: - base - to - rate CurrencySettings-Output: properties: default: $ref: '#/components/schemas/CurrencyEnum' exchange_rates: items: anyOf: - $ref: '#/components/schemas/ExchangeRate' - type: 'null' type: array additionalProperties: false type: object required: - default PartnerProjectSettingsPayload-Input: properties: accounting: anyOf: - $ref: '#/components/schemas/AccountingSettings2' - type: 'null' description: Settings for the accounting module. deprecated: true api_version: anyOf: - $ref: '#/components/schemas/APIVersion' - type: 'null' description: Default API version for partner. commercial_conditions: anyOf: - items: type: string type: array - type: 'null' description: Commercial conditions for receivables. currency: anyOf: - $ref: '#/components/schemas/CurrencySettings-Input' - type: 'null' description: Custom currency exchange rates. default_role: anyOf: - additionalProperties: true type: object - type: 'null' description: A default role to provision upon new entity creation. mail: anyOf: - $ref: '#/components/schemas/MailSettings' - type: 'null' description: Settings for email and mailboxes. payable: anyOf: - $ref: '#/components/schemas/PayableSettings' - type: 'null' description: Settings for the payables module. payments: anyOf: - $ref: '#/components/schemas/PaymentsSettings-Input' - type: 'null' description: Settings for the payments module. receivable: anyOf: - $ref: '#/components/schemas/ReceivableSettings' - type: 'null' description: Settings for the receivables module. units: anyOf: - items: $ref: '#/components/schemas/Unit' type: array - type: 'null' description: Measurement units. website: anyOf: - type: string - type: 'null' type: object PaymentPageTheme-Input: properties: background_color: anyOf: - type: string format: color - type: 'null' border_radius: anyOf: - type: string - type: 'null' button: anyOf: - $ref: '#/components/schemas/ButtonTheme-Input' - type: 'null' card: anyOf: - $ref: '#/components/schemas/CardTheme-Input' - type: 'null' font_color: anyOf: - type: string format: color - type: 'null' font_family: anyOf: - type: string - type: 'null' font_link_href: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' logo_src: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' type: object AccountingSettings2: properties: provider: $ref: '#/components/schemas/AccountingProviderEnum' minLength: 1 token: anyOf: - type: string minLength: 1 - type: 'null' description: Token for the accounting provider (Codat only) type: object required: - provider ReceivableSettings: properties: create_without_personal_info: type: boolean deduction_title: anyOf: - type: string maxLength: 32 minLength: 1 - type: 'null' type: object required: - create_without_personal_info MailSettings: properties: attach_documents_as_pdf: type: boolean description: Attach documents as PDF in emails. default: true from_email_username: anyOf: - type: string maxLength: 64 minLength: 1 - type: 'null' from_name: anyOf: - type: string maxLength: 30 minLength: 1 - type: 'null' type: object ErrorSchema: properties: message: type: string type: object required: - message APIVersion: type: string enum: - '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' HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array type: object PartnerProjectSettingsPayload-Output: properties: accounting: anyOf: - $ref: '#/components/schemas/AccountingSettings2' - type: 'null' description: Settings for the accounting module. deprecated: true api_version: anyOf: - $ref: '#/components/schemas/APIVersion' - type: 'null' description: Default API version for partner. commercial_conditions: anyOf: - items: type: string type: array - type: 'null' description: Commercial conditions for receivables. currency: anyOf: - $ref: '#/components/schemas/CurrencySettings-Output' - type: 'null' description: Custom currency exchange rates. default_role: anyOf: - additionalProperties: true type: object - type: 'null' description: A default role to provision upon new entity creation. mail: anyOf: - $ref: '#/components/schemas/MailSettings' - type: 'null' description: Settings for email and mailboxes. payable: anyOf: - $ref: '#/components/schemas/PayableSettings' - type: 'null' description: Settings for the payables module. payments: anyOf: - $ref: '#/components/schemas/PaymentsSettings-Output' - type: 'null' description: Settings for the payments module. receivable: anyOf: - $ref: '#/components/schemas/ReceivableSettings' - type: 'null' description: Settings for the receivables module. units: anyOf: - items: $ref: '#/components/schemas/Unit' type: array - type: 'null' description: Measurement units. website: anyOf: - type: string - type: 'null' type: object ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array msg: type: string type: type: string type: object required: - loc - msg - type ButtonTheme: properties: primary_color: anyOf: - type: string format: color - type: 'null' primary_hover_color: anyOf: - type: string format: color - type: 'null' secondary_color: anyOf: - type: string format: color - type: 'null' secondary_hover_color: anyOf: - type: string format: color - type: 'null' type: object ErrorSchemaResponse: properties: error: $ref: '#/components/schemas/ErrorSchema' type: object required: - error CurrencyEnum: type: string enum: - 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 PaymentsSettings-Input_2: properties: payment_page_domain: anyOf: - type: string - type: 'null' payment_page_theme: anyOf: - $ref: '#/components/schemas/PaymentPageTheme' - type: 'null' support_email: anyOf: - type: string format: email - type: 'null' description: The support email address type: object PaymentsSettings-Output_2: properties: payment_page_domain: anyOf: - type: string - type: 'null' payment_page_theme: anyOf: - $ref: '#/components/schemas/PaymentPageTheme' - type: 'null' support_email: anyOf: - type: string format: email - type: 'null' description: The support email address type: object PayableSettings_2: properties: allow_cancel_duplicates_automatically: anyOf: - type: boolean - type: 'null' default: false allow_counterpart_autocreation: anyOf: - type: boolean - type: 'null' default: false allow_counterpart_autolinking: anyOf: - type: boolean - type: 'null' default: false allow_credit_note_autolinking: anyOf: - type: boolean - type: 'null' default: false approve_page_url: type: string minLength: 1 format: uri examples: - https://monite.com default_state: anyOf: - type: string - type: 'null' description: A state each new payable will have upon creation examples: - new enable_line_items: type: boolean description: Partners can set this to True or False to control line item detection in OCR flows. default: true skip_approval_for_paid_invoice: anyOf: - type: boolean - type: 'null' default: false type: object required: - approve_page_url PartnerProjectSettingsPayload-Input_2: properties: api_version: anyOf: - $ref: '#/components/schemas/APIVersion' - type: 'null' description: Default API version for partner. commercial_conditions: anyOf: - items: type: string type: array - type: 'null' description: Commercial conditions for receivables. currency: anyOf: - $ref: '#/components/schemas/CurrencySettings-Input' - type: 'null' description: Custom currency exchange rates. default_role: anyOf: - additionalProperties: true type: object - type: 'null' description: A default role to provision upon new entity creation. mail: anyOf: - $ref: '#/components/schemas/MailSettings' - type: 'null' description: Settings for email and mailboxes. payable: anyOf: - $ref: '#/components/schemas/PayableSettings_2' - type: 'null' description: Settings for the payables module. payments: anyOf: - $ref: '#/components/schemas/PaymentsSettings-Input_2' - type: 'null' description: Settings for the payments module. receivable: anyOf: - $ref: '#/components/schemas/ReceivableSettings' - type: 'null' description: Settings for the receivables module. units: anyOf: - items: $ref: '#/components/schemas/Unit' type: array - type: 'null' description: Measurement units. website: anyOf: - type: string - type: 'null' type: object PaymentPageTheme: properties: background_color: anyOf: - type: string format: color - type: 'null' border_radius: anyOf: - type: string - type: 'null' button: anyOf: - $ref: '#/components/schemas/ButtonTheme' - type: 'null' card: anyOf: - $ref: '#/components/schemas/CardTheme' - type: 'null' font_color: anyOf: - type: string format: color - type: 'null' font_family: anyOf: - type: string - type: 'null' font_link_href: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' logo_src: anyOf: - type: string maxLength: 2083 minLength: 1 format: uri - type: 'null' type: object PartnerProjectSettingsPayload-Output_2: properties: api_version: anyOf: - $ref: '#/components/schemas/APIVersion' - type: 'null' description: Default API version for partner. commercial_conditions: anyOf: - items: type: string type: array - type: 'null' description: Commercial conditions for receivables. currency: anyOf: - $ref: '#/components/schemas/CurrencySettings-Output' - type: 'null' description: Custom currency exchange rates. default_role: anyOf: - additionalProperties: true type: object - type: 'null' description: A default role to provision upon new entity creation. mail: anyOf: - $ref: '#/components/schemas/MailSettings' - type: 'null' description: Settings for email and mailboxes. payable: anyOf: - $ref: '#/components/schemas/PayableSettings_2' - type: 'null' description: Settings for the payables module. payments: anyOf: - $ref: '#/components/schemas/PaymentsSettings-Output_2' - type: 'null' description: Settings for the payments module. receivable: anyOf: - $ref: '#/components/schemas/ReceivableSettings' - type: 'null' description: Settings for the receivables module. units: anyOf: - items: $ref: '#/components/schemas/Unit' type: array - type: 'null' description: Measurement units. website: anyOf: - type: string - type: 'null' type: object PaymentsSettings-Input_3: properties: payment_page_domain: anyOf: - type: string - type: 'null' payment_page_theme: anyOf: - $ref: '#/components/schemas/PaymentPageTheme' - type: 'null' support_email: anyOf: - type: string format: email - type: 'null' description: The support email address type: object PaymentsSettings-Output_3: properties: payment_page_domain: anyOf: - type: string - type: 'null' payment_page_theme: anyOf: - $ref: '#/components/schemas/PaymentPageTheme' - type: 'null' support_email: anyOf: - type: string format: email - type: 'null' description: The support email address type: object PayableSettings_3: properties: allow_cancel_duplicates_automatically: anyOf: - type: boolean - type: 'null' default: false allow_counterpart_autocreation: anyOf: - type: boolean - type: 'null' default: false allow_counterpart_autolinking: anyOf: - type: boolean - type: 'null' default: false allow_credit_note_autolinking: anyOf: - type: boolean - type: 'null' default: false approve_page_url: type: string minLength: 1 format: uri examples: - https://monite.com default_state: anyOf: - type: string - type: 'null' description: A state each new payable will have upon creation examples: - new enable_line_items: type: boolean description: Partners can set this to True or False to control line item detection in OCR flows. default: true skip_approval_for_paid_invoice: anyOf: - type: boolean - type: 'null' default: false type: object required: - approve_page_url PartnerProjectSettingsPayload-Input_3: properties: api_version: anyOf: - $ref: '#/components/schemas/APIVersion' - type: 'null' description: Default API version for partner. commercial_conditions: anyOf: - items: type: string type: array - type: 'null' description: Commercial conditions for receivables. currency: anyOf: - $ref: '#/components/schemas/CurrencySettings-Input' - type: 'null' description: Custom currency exchange rates. default_role: anyOf: - additionalProperties: true type: object - type: 'null' description: A default role to provision upon new entity creation. mail: anyOf: - $ref: '#/components/schemas/MailSettings' - type: 'null' description: Settings for email and mailboxes. payable: anyOf: - $ref: '#/components/schemas/PayableSettings_3' - type: 'null' description: Settings for the payables module. payments: anyOf: - $ref: '#/components/schemas/PaymentsSettings-Input_3' - type: 'null' description: Settings for the payments module. receivable: anyOf: - $ref: '#/components/schemas/ReceivableSettings' - type: 'null' description: Settings for the receivables module. units: anyOf: - items: $ref: '#/components/schemas/Unit' type: array - type: 'null' description: Measurement units. website: anyOf: - type: string - type: 'null' type: object PartnerProjectSettingsPayload-Output_3: properties: api_version: anyOf: - $ref: '#/components/schemas/APIVersion' - type: 'null' description: Default API version for partner. commercial_conditions: anyOf: - items: type: string type: array - type: 'null' description: Commercial conditions for receivables. currency: anyOf: - $ref: '#/components/schemas/CurrencySettings-Output' - type: 'null' description: Custom currency exchange rates. default_role: anyOf: - additionalProperties: true type: object - type: 'null' description: A default role to provision upon new entity creation. mail: anyOf: - $ref: '#/components/schemas/MailSettings' - type: 'null' description: Settings for email and mailboxes. payable: anyOf: - $ref: '#/components/schemas/PayableSettings_3' - type: 'null' description: Settings for the payables module. payments: anyOf: - $ref: '#/components/schemas/PaymentsSettings-Output_3' - type: 'null' description: Settings for the payments module. receivable: anyOf: - $ref: '#/components/schemas/ReceivableSettings' - type: 'null' description: Settings for the receivables module. units: anyOf: - items: $ref: '#/components/schemas/Unit' type: array - type: 'null' description: Measurement units. website: anyOf: - type: string - type: 'null' type: object securitySchemes: HTTPBearer: type: http scheme: bearer x-refined-from: - monite-openapi-2023-09-01.json - monite-openapi-2024-05-25.json - monite-openapi.yml