> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Create a fee schedule > Use this endpoint to create a new fee schedule. Fee schedules define the fee structure applied to transactions during reconciliation. ## OpenAPI ````yaml /pt/openapi/v3-current/matcher.yaml post /v1/fee-schedules openapi: 3.1.0 info: title: Matcher APIs description: >- Complete API reference for the Matcher reconciliation engine, providing automated transaction matching between Midaz Ledger and external systems. version: 6.1.0 license: name: Lerian Studio General License servers: - url: https://matcher.sandbox.lerian.net security: [] paths: /v1/fee-schedules: post: tags: - Configuration Fee Schedules summary: Create a fee schedule description: >- Use this endpoint to create a new fee schedule. Fee schedules define the fee structure applied to transactions during reconciliation. operationId: createFeeSchedule parameters: - description: A unique identifier for tracing the request across services. in: header name: X-Request-Id schema: type: string - $ref: '#/components/parameters/XIdempotency' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateFeeScheduleRequest' description: Fee schedule creation payload required: true responses: '201': description: Successfully created fee schedule. content: application/json: schema: $ref: '#/components/schemas/FeeScheduleResponse' headers: X-Idempotency-Replayed: $ref: '#/components/headers/XIdempotencyReplayed' '400': description: Invalid request payload content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: 400-invalid-fee-schedule-items: $ref: '#/components/examples/400-invalid-fee-schedule-items' mtch-0001-create-fee-schedule-fee-schedule-name-fee-schedule-name-is-r: $ref: >- #/components/examples/mtch-0001-create-fee-schedule-fee-schedule-name-fee-schedule-name-is-r '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/ValidationFailed' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' security: - BearerAuth: [] components: parameters: XIdempotency: name: X-Idempotency in: header required: false description: >- Optional idempotency key for safe retries. Matcher reads the key only from this header, and only when you send one. A request that carries a key only in `X-Idempotency-Key` or `Idempotency-Key` is refused with `400` (`MTCH-0015`), and nothing is processed. If the same key is sent again and the original request was already processed, the stored response is returned with `X-Idempotency-Replayed: true`. A malformed key returns `400`, a key whose first request is still in progress returns `409` (`MTCH-0018`), a key whose earlier attempt already ran but whose answer cannot be replayed returns `409` (`MTCH-0022`), and an idempotency storage failure returns `500`. POST, PUT, PATCH and DELETE requests accept the header. These refusals are problem documents. schema: type: string schemas: CreateFeeScheduleRequest: additionalProperties: false properties: applicationOrder: description: >- How items combine. PARALLEL applies every item to the same gross base; CASCADING applies each item to the net remaining after prior items. enum: - PARALLEL - CASCADING examples: - PARALLEL type: string currency: description: ISO 4217 currency code the schedule's amounts are denominated in. examples: - USD type: string items: description: Fee items that make up the schedule; at least one is required. items: $ref: '#/components/schemas/CreateFeeScheduleItemRequest' maxItems: 100 minItems: 1 type: - array - 'null' name: description: Human-readable name of the fee schedule. examples: - Card Processing - Visa maxLength: 100 minLength: 1 type: string roundingMode: description: >- Rounding strategy. HALF_UP rounds halves away from zero; BANKERS rounds halves to the nearest even digit; FLOOR rounds down; CEIL rounds up; TRUNCATE drops extra digits. enum: - HALF_UP - BANKERS - FLOOR - CEIL - TRUNCATE examples: - HALF_UP type: string roundingScale: description: Number of decimal places fee amounts are rounded to. examples: - 2 format: int64 type: integer required: - name - currency - applicationOrder - roundingScale - roundingMode - items type: object FeeScheduleResponse: additionalProperties: false properties: applicationOrder: description: >- How items combine. PARALLEL applies every item to the same gross base; CASCADING applies each item to the net remaining after prior items. enum: - PARALLEL - CASCADING examples: - PARALLEL type: string createdAt: description: Creation timestamp in RFC 3339 format. examples: - '2025-01-15T10:30:00Z' type: string currency: description: ISO 4217 currency code the schedule's amounts are denominated in. examples: - USD type: string id: description: Unique identifier of the fee schedule. examples: - 550e8400-e29b-41d4-a716-446655440000 type: string items: description: Fee items that make up the schedule. items: $ref: '#/components/schemas/FeeScheduleItemResponse' maxItems: 100 type: - array - 'null' name: description: Human-readable name of the fee schedule. examples: - Card Processing - Visa type: string roundingMode: description: >- Rounding strategy. HALF_UP rounds halves away from zero; BANKERS rounds halves to the nearest even digit; FLOOR rounds down; CEIL rounds up; TRUNCATE drops extra digits. enum: - HALF_UP - BANKERS - FLOOR - CEIL - TRUNCATE examples: - HALF_UP type: string roundingScale: description: Number of decimal places fee amounts are rounded to. examples: - 2 format: int64 type: integer tenantId: description: Identifier of the tenant that owns the schedule. examples: - 550e8400-e29b-41d4-a716-446655440000 type: string updatedAt: description: Last update timestamp in RFC 3339 format. examples: - '2025-01-15T10:30:00Z' type: string usedByContexts: description: >- Number of distinct contexts whose fee rules reference this schedule. Computed at read time from the fee rules that reference this schedule (never persisted). examples: - 2 format: int64 type: integer required: - id - tenantId - name - currency - applicationOrder - roundingScale - roundingMode - items - usedByContexts - createdAt - updatedAt type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object CreateFeeScheduleItemRequest: additionalProperties: false properties: name: description: Human-readable name of the fee item. examples: - interchange type: string priority: description: >- Application order within the schedule; relevant for CASCADING application. examples: - 1 format: int64 type: integer structure: additionalProperties: {} description: >- Type-specific structure. FLAT: {"amount":"1.50"}. PERCENTAGE: {"rate":"0.029"} where rate is a 0..1 fraction of the base amount (0.029 means 2.9%), not a percent value. TIERED: {"tiers":[{"rate":"0.01","upTo":"1000"},...]} with the same 0..1 fraction semantics per tier rate. EXPRESSION: {"expression":"gross - desconto + multa + juros_dia * days_late(due_date, pay_date)"} a formula over metadata fields (+ - * /, parentheses, and the functions days_late, days_between, max, min, abs, clamp). A formula that is only the base amount times numeric literals is a percentage rate and is bounded 0..1: gross * 0.029 is 2.9%, gross * 2.9 is refused; any other formula is unbounded. type: object structureType: description: >- Shape of the fee structure; the structure field documents the object each one takes. enum: - FLAT - PERCENTAGE - TIERED - EXPRESSION examples: - PERCENTAGE type: string required: - name - priority - structureType - structure type: object FeeScheduleItemResponse: additionalProperties: false properties: createdAt: description: Creation timestamp in RFC 3339 format. examples: - '2025-01-15T10:30:00Z' type: string id: description: Unique identifier of the fee item. examples: - 550e8400-e29b-41d4-a716-446655440000 type: string name: description: Human-readable name of the fee item. examples: - interchange type: string priority: description: >- Application order within the schedule; relevant for CASCADING application. examples: - 1 format: int64 type: integer structure: additionalProperties: {} description: >- Type-specific structure. FLAT: {"amount":"1.50"}. PERCENTAGE: {"rate":"0.029"} where rate is a 0..1 fraction of the base amount (0.029 means 2.9%), not a percent value. TIERED: {"tiers":[{"rate":"0.01","upTo":"1000"},...]} with the same 0..1 fraction semantics per tier rate. EXPRESSION: {"expression":"gross - desconto + multa + juros_dia * days_late(due_date, pay_date)"} a formula over metadata fields (+ - * /, parentheses, and the functions days_late, days_between, max, min, abs, clamp). A formula that is only the base amount times numeric literals is a percentage rate and is bounded 0..1: gross * 0.029 is 2.9%, gross * 2.9 is refused; any other formula is unbounded. type: object structureType: description: >- Shape of the fee structure. FLAT is a fixed amount; PERCENTAGE is a rate of the base; TIERED applies different rates per amount tier; EXPRESSION computes the fee from a bounded arithmetic formula over transaction metadata. enum: - FLAT - PERCENTAGE - TIERED - EXPRESSION examples: - PERCENTAGE type: string updatedAt: description: Last update timestamp in RFC 3339 format. examples: - '2025-01-15T10:30:00Z' type: string required: - id - name - priority - structureType - structure - createdAt - updatedAt type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object RateLimitErrorResponse: description: >- Flat body that the rate limiter returns. `code` is the HTTP status as a number. type: object required: - code - title - message properties: code: type: integer description: HTTP status code. example: 429 title: type: string description: Error type. example: rate_limit_exceeded message: type: string description: Human-readable error message. example: rate limit exceeded headers: XIdempotencyReplayed: description: >- Indicates whether this response was served from the idempotency cache. When `true`, the response is a replay of the original request with the same idempotency key. schema: type: boolean RetryAfter: description: Seconds to wait before you retry. schema: type: integer example: 30 XRateLimitLimit: description: Requests allowed in the current window. schema: type: integer example: 100 XRateLimitRemaining: description: Requests left in the current window. Always `0` on a `429`. schema: type: integer example: 0 XRateLimitReset: description: Unix time, in seconds, when the current window resets. schema: type: integer example: 1767225600 examples: 400-invalid-fee-schedule-items: summary: Invalid fee schedule items value: type: https://errors.lerian.studio/v1/MTCH-0001 title: Bad Request status: 400 detail: >- One or more fee schedule items are invalid. The structure type must be flat, percentage, tiered, or expression; flat needs a string amount, percentage needs a string rate (0 to 1), tiered needs a tiers array, and expression needs a parseable formula; fix the item and try again. code: MTCH-0001 mtch-0001-create-fee-schedule-fee-schedule-name-fee-schedule-name-is-r: summary: 'Create fee schedule: fee schedule name: fee schedule name is required' value: type: https://errors.lerian.studio/v1/MTCH-0001 title: Bad Request status: 400 detail: >- The fee schedule request is invalid; check the schedule's name, items, and rounding/application-order settings and try again code: MTCH-0001 responses: Unauthorized: description: The request lacks valid authentication credentials. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: MissingToken: summary: Missing token value: type: https://errors.lerian.studio/v1/AUT-0006 title: Token Missing status: 401 detail: >- A valid token must be provided in the request header. Please include a token and try again. code: AUT-0006 InvalidToken: summary: Invalid token value: type: https://errors.lerian.studio/v1/AUT-0007 title: Invalid Token status: 401 detail: >- The provided token is expired, invalid or malformed. Please provide a valid token and try again. code: AUT-0007 Forbidden: description: You do not have permission to access this resource. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: TenantClaimRequired: summary: Tenant claim missing value: type: https://errors.lerian.studio/v1/MTCH-0004 title: Forbidden status: 403 detail: tenant claim required code: MTCH-0004 PermissionDenied: summary: Permission denied value: type: https://errors.lerian.studio/v1/AUT-1020 title: Permission Denied status: 403 detail: >- the credential is not allowed to perform contexts:read on this request code: AUT-1020 ValidationFailed: description: >- The request failed validation. The `errors` list names each value that failed. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' example: title: Unprocessable Entity status: 422 detail: validation failed errors: - message: expected required property name to be present location: body TooManyRequests: description: >- The request exceeded the rate limit. Wait the number of seconds in `Retry-After`, then retry. headers: Retry-After: $ref: '#/components/headers/RetryAfter' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' content: application/json: schema: $ref: '#/components/schemas/RateLimitErrorResponse' example: code: 429 title: rate_limit_exceeded message: rate limit exceeded InternalServerError: description: An unexpected error occurred on the server. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' example: type: https://errors.lerian.studio/v1/MTCH-0002 title: Internal Server Error status: 500 detail: internal error code: MTCH-0002 text/plain: schema: type: string example: Internal Server Error securitySchemes: BearerAuth: bearerFormat: JWT description: 'Bearer token authentication (format: "Bearer {token}")' scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.