name: Monite API Conventions
generated: '2026-10-09'
method: searched
source: https://docs.monite.com/api/concepts/overview
description: Cross-cutting semantics of the Monite Partner API (v2024-05-25), from the API Concepts docs and the OpenAPI contract.
base_url: https://api.monite.com/v1
regional_base_urls:
  europe: https://api.monite.com
  north_america: https://us.api.monite.com
  sandbox: https://api.sandbox.monite.com
api_style: REST/JSON
authentication:
  scheme: Bearer token from POST /auth/token (client_credentials or entity_user grant)
  docs: https://docs.monite.com/api/concepts/authentication
  detail: See authentication/monite-authentication.yml and scopes/monite-scopes.yml.
idempotency:
  supported: false
  coverage: none
  detail: No idempotency key header or parameter is documented in the API Concepts docs or declared on any of the 248 write operations in the OpenAPI contract (docs.monite.com/api/concepts/idempotency returns a not-found page).
pagination:
  style: cursor (opaque pagination tokens)
  request_params: [limit, pagination_token, sort, order]
  response_fields: [data, prev_pagination_token, next_pagination_token]
  limit_range: 1 to 100; values outside the range return HTTP 416
  filtering: 'Exact match FIELD=VALUE and comparison FIELD__OPERATOR=VALUE with operators iexact, contains, icontains, in, gte, gt, lte, lt, isnull'
  errors: [406 Not Acceptable, 416 Range Not Satisfiable]
  docs: https://docs.monite.com/api/concepts/pagination-sorting-filtering
metadata:
  supported: true
  docs: https://docs.monite.com/common/metadata
request_tracing:
  request_id_header: x-request-id
  other_headers: [x-process-time, x-monite-version, x-monite-entity-id]
  description: x-request-id is a random ID generated by Monite for each response; provide it when reporting issues to support.
  docs: https://docs.monite.com/api/concepts/http-headers
tenancy:
  header: x-monite-entity-id
  description: Resources are owned by entities; calls on entity-owned resources must include the entity ID header.
versioning:
  scheme: date-based YYYY-MM-DD
  mechanism: X-Monite-Version request header (required; missing returns 400 missing_api_version)
  current: '2024-05-25'
  changelog: https://docs.monite.com/intro/release-notes/changelog
  docs: https://docs.monite.com/api/concepts/versioning
  detail: See lifecycle/monite-lifecycle.yml.
error_envelope:
  media_type: application/json
  rfc9457: false
  shape: '{"error": {"type": ..., "message": ...}} (ErrorSchemaResponse); validation errors use {"detail": [{"loc", "msg", "type"}]} (HTTPValidationError); rate limit responses use {"message": ...}'
  sources: [openapi/monite-openapi.yml, https://docs.monite.com/api/concepts/versioning, https://docs.monite.com/api/concepts/rate-limiting]
rate_limits:
  signal_status: 429
  headers: [RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, X-RateLimit-Limit-Second, X-RateLimit-Remaining-Second, Retry-After]
  docs: https://docs.monite.com/api/concepts/rate-limiting
  detail: See rate-limits/monite-rate-limits.yml.
webhooks:
  signing_header: Monite-Signature
  verification: HMAC SHA-256 over the payload with a shared secret; header carries t=<unix timestamp>,v1=<signature>
  docs: https://docs.monite.com/references/webhooks/signatures
reversibility:
  read_only: false
  summary: Several document workflows expose explicit reversal operations; the docs state status conditions under which they work but no time windows.
  surfaces:
  - surface: Receivable invoices
    operation: post_receivables_id_cancel
    window: null
    condition: Invoices in the issued and overdue statuses can be canceled if they have not been paid in full yet; canceled invoices cannot be reissued.
    docs: https://docs.monite.com/accounts-receivable/invoices/manage
    grade: documented
  - surface: Payment records
    operation: post_payment_records_id_cancel
    window: null
    condition: Payment records in the created and processing statuses can be canceled; once canceled they cannot be modified further.
    docs: https://docs.monite.com/common/payment-records
    grade: documented
  - surface: Payables
    operation: post_payables_id_cancel
    related: [post_payables_id_reopen, post_payables_id_cancel_ocr]
    window: null
    docs: openapi/monite-openapi.yml
    grade: documented
  - surface: Other cancellable objects (from the contract)
    operations: [post_payable_credit_notes_id_cancel, post_delivery_notes_id_cancel, post_recurrences_id_cancel, post_approval_requests_id_cancel, post_approval_policies_id_processes_id_cancel]
    window: null
    docs: openapi/monite-openapi.yml
    grade: documented
  - surface: Entities
    operation: post_entities_id_deactivate
    reversal: post_entities_id_activate
    window: null
    docs: openapi/monite-openapi.yml
    grade: documented
  - surface: Access tokens
    operation: post_auth_revoke
    window: null
    docs: https://docs.monite.com/api/concepts/authentication
    grade: documented