> ## Documentation Index > Fetch the complete documentation index at: https://docs.rinne.com.br/llms.txt > Use this file to discover all available pages before exploring further. # List contract effects on your receivables > Requires the receivable.list permission. Lists the contract effects registered at the receivables registrars on the authenticated company's own document, under its organization (the parent organization for a merchant, the organization itself for an organization). Effects are keyed by document, so they cover every store with that document; they are not linked to a receivable unit or a transaction; they are informational copies, never applied to balances; and they are only as fresh as the latest snapshot (`latest_snapshot_date`). Returns `ACTIVE` effects unless `status` asks for others, ordered by `expected_settlement_date` ascending unless `sort` says otherwise. ## OpenAPI ````yaml /api-spec.yaml get /v1/receivables/contract-effects openapi: 3.1.0 info: title: Rinne API version: 1.0.0 description: > **Rinne API** is a robust payment platform that offers integration with multiple payment providers. ## Authentication The API uses API Key authentication via the `x-api-key` header. Each company has a unique key to access resources. ## Response Format All responses follow a consistent format: - **Success**: Returns the requested data directly - **Error**: Returns an `error` object with detailed information ## Pagination Endpoints that return lists support pagination through parameters: - `page`: Page number (default: 1) - `limit`: Items per page (default: 20, maximum: 100) ## Supported Providers The API supports multiple payment providers: - **Rinne**: Internal provider - **Celcoin**: PIX integration and other financial services ## Raw Card Data (PCI Endpoints) Card credential fields (`card_data.number`, `card_data.cvv`, `card_data.network_token`, `card_data.cryptogram`, and the 3DS `card.number`) must always be sent encrypted — values start with the `ev:` prefix. Plaintext values are rejected with `400 VALIDATION_ERROR` on every host. There are two ways to send encrypted values: - **rinne-js**: card forms and wallet buttons (Apple Pay / Google Pay) encrypt credentials client-side before they leave the browser. - **PCI API host**: server-to-server integrations that handle raw card data must call `https://pci.api.rinne.com.br/core` (sandbox: `https://pci.api-sandbox.rinne.com.br/core`) instead of the regular host. This endpoint encrypts `number` and `cvv` in transit before the request reaches the API; all other fields pass through unchanged. The PCI host serves only transaction creation and 3DS session creation (both the self and merchant variants); use the regular host for everything else. contact: name: Rinne API Support email: suporte@rinne.com.br servers: - url: https://api-sandbox.rinne.com.br/core description: Sandbox - url: https://api.rinne.com.br/core description: Production security: [] tags: - name: System description: System and API health endpoints - name: Tap-on-Phone description: Access-token minting for the Tap-on-Phone SDK (called from your backend) - name: Authentication description: User authentication and authorization endpoints - name: Management description: >- Merchant management endpoints - create, list, get specific, overview, update - name: Transactions description: Transaction operations for merchants - create, list, overview, refunds - name: Affiliations description: Affiliation management for merchants - name: Biometric Verifications description: Biometric verifications of your merchants' contacts - name: Onboarding Requirements description: What your merchants must prove to a provider, and how far along they are - name: Onboarding Documents description: Documents uploaded for your merchants - name: KYC description: KYC check history of your merchants - name: Banking description: Banking operations for merchants - balance, cashout, statements - name: Bank Accounts description: Bank account management for merchants - name: Pix Keys description: PIX key management for merchants - name: Company Transactions description: Direct transaction management and query endpoints for companies - name: Companies description: Company management - name: Company Affiliations description: Payment provider affiliation management - name: Company Biometric Verifications description: Biometric verifications of the company contact - name: Company Onboarding Requirements description: What the company must prove to a provider, and how far along it is - name: Company Onboarding Documents description: Documents the company uploads for its onboarding - name: Company Banking description: Company banking endpoints (balance, etc.) - name: Company Pix description: Company PIX key management - name: Company Ledger description: Company ledger entry query endpoints - name: Company Disputes description: Company dispute query endpoints - name: Company Receivables description: Contract effects on the company's own receivables - name: Ledger description: Ledger entry query endpoints (company and merchants) - name: Disputes description: Dispute query endpoints for an organization's merchants - name: Receivables description: Contract effects on an organization's merchants' receivables - name: Cards description: Stored card management (self and merchant) - name: API Keys description: API key management - create, list, revoke (hashed, show-once) - name: Webhooks description: Endpoints for receiving webhooks from external providers - name: Pricing description: Fee and cost policy management for transaction pricing - name: Users description: User management endpoints - name: Roles description: Role management endpoints - name: Permissions description: Permission management endpoints paths: /v1/receivables/contract-effects: get: tags: - Company Receivables summary: List contract effects on your receivables description: > Requires the receivable.list permission. Lists the contract effects registered at the receivables registrars on the authenticated company's own document, under its organization (the parent organization for a merchant, the organization itself for an organization). Effects are keyed by document, so they cover every store with that document; they are not linked to a receivable unit or a transaction; they are informational copies, never applied to balances; and they are only as fresh as the latest snapshot (`latest_snapshot_date`). Returns `ACTIVE` effects unless `status` asks for others, ordered by `expected_settlement_date` ascending unless `sort` says otherwise. parameters: - name: external_contract_id in: query description: Filter by the contract's key schema: type: string example: CTR-2026-000481 - name: status in: query description: Comma-separated statuses. Defaults to `ACTIVE`. style: form explode: false schema: type: array items: type: string enum: - ACTIVE - CANCELLED default: - ACTIVE example: - ACTIVE - CANCELLED - name: effect_type in: query description: Comma-separated effect types style: form explode: false schema: type: array items: type: string enum: - OWNERSHIP_TRANSFER - GUARANTEE - GUARANTEE_PLEDGE - GUARANTEE_FIDUCIARY_ASSIGNMENT - JUDICIAL_SEIZURE - FINANCIAL_RESERVE - CESSION_PROMISE example: - GUARANTEE_FIDUCIARY_ASSIGNMENT - OWNERSHIP_TRANSFER - name: expected_settlement_date_from in: query description: Settlement date from (inclusive), `YYYY-MM-DD` schema: type: string format: date - name: expected_settlement_date_to in: query description: Settlement date until (inclusive), `YYYY-MM-DD` schema: type: string format: date - name: sort in: query description: >- `expected_settlement_date` or `created_at`, `-` prefix for descending schema: type: string example: '-expected_settlement_date' - name: page in: query description: Page number schema: type: integer minimum: 1 default: 1 example: 1 - name: limit in: query description: Number of items per page schema: type: integer minimum: 1 maximum: 100 default: 20 example: 20 responses: '200': description: Contract effects content: application/json: schema: type: object required: - data - pagination - latest_snapshot_date properties: data: type: array items: $ref: '#/components/schemas/ContractEffect' pagination: $ref: '#/components/schemas/PaginationResponse' latest_snapshot_date: type: - string - 'null' format: date description: >- The date of the latest snapshot Rinne received; null before the first one. When it is older than you expect, the effects are older too. example: '2026-10-14' '400': description: >- Validation error (an empty or unknown status, an unknown effect type or sort field, a date not in `YYYY-MM-DD`, or a `limit` above 100) content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '401': description: Unauthorized - Invalid or missing API key content: application/json: schema: $ref: '#/components/schemas/AuthenticationErrorResponse' '403': description: Insufficient permissions to access this resource content: application/json: schema: $ref: '#/components/schemas/AuthorizationErrorResponse' '404': description: The authenticated company is a merchant without an organization content: application/json: schema: $ref: '#/components/schemas/NotFoundErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorResponse' security: - ApiKeyAuth: [] components: schemas: ContractEffect: type: object description: > A contract a creditor registered at the receivables registrars against a merchant document's card receivables, for one settlement date, as the card partner reports it. Informational: it is never applied to balances. required: - external_contract_id - merchant_document - effect_type - effect_priority - division_method - effect_amount - effect_percentage - committed_effect_amount - expected_settlement_date - status - beneficiary_document - beneficiary_document_type - beneficiary_account - registrar_document - last_snapshot_date - cancelled_at - created_at - updated_at properties: external_contract_id: type: string description: >- The contract's key, as reported. Repeats across the dates one contract covers. example: CTR-2026-000481 merchant_document: type: string description: >- The CNPJ or CPF the contract is registered on, without formatting. It covers every store with this document. example: '11444777000161' effect_type: type: string enum: - OWNERSHIP_TRANSFER - GUARANTEE - GUARANTEE_PLEDGE - GUARANTEE_FIDUCIARY_ASSIGNMENT - JUDICIAL_SEIZURE - FINANCIAL_RESERVE - CESSION_PROMISE example: GUARANTEE_FIDUCIARY_ASSIGNMENT effect_priority: type: integer description: >- The effect's place in the settlement order among the effects on the same date, as reported (sequential from 0) example: 0 division_method: type: string enum: - FIXED_AMOUNT - PERCENTAGE description: >- Which field carries the value — `effect_amount` for `FIXED_AMOUNT`, `effect_percentage` for `PERCENTAGE` example: PERCENTAGE effect_amount: type: - integer - 'null' description: >- The effect's amount in cents for `FIXED_AMOUNT`; null for `PERCENTAGE` example: null effect_percentage: type: - number - 'null' minimum: 0 maximum: 100 description: >- The effect's share of the settlement for `PERCENTAGE`, from 0 to 100 with two decimals; null for `FIXED_AMOUNT` example: 100 committed_effect_amount: type: integer description: >- The part of the effect already committed against the settlement, in cents example: 82350 expected_settlement_date: type: string format: date description: The settlement date the effect applies to example: '2026-07-14' status: type: string enum: - ACTIVE - CANCELLED description: >- `CANCELLED` once a later snapshot no longer reports the effect: the contract was cancelled, settled or ended at the registrar example: ACTIVE beneficiary_document: type: string description: The creditor's CNPJ or CPF, as reported example: '60701190000104' beneficiary_document_type: type: string enum: - CPF - CNPJ example: CNPJ beneficiary_account: type: object description: The account the settlement is diverted to, as reported required: - holder_document - ispb - branch_code - account_number - check_digit - account_type properties: holder_document: type: string example: '60701190000104' ispb: type: string example: '60701190' branch_code: type: - string - 'null' description: Null when not reported example: '0001' account_number: type: string example: '123456' check_digit: type: - string - 'null' description: Null when not reported example: '7' account_type: type: string enum: - CHECKING - DEPOSIT - GUARANTEED - INVESTMENT - PAYMENT - SAVINGS example: CHECKING registrar_document: type: - string - 'null' description: >- The CNPJ of the registrar the contract is registered at; null when not reported example: '11222333000181' last_snapshot_date: type: string format: date description: The latest snapshot that reported this effect example: '2026-10-14' cancelled_at: type: - string - 'null' format: date-time description: When Rinne recorded the cancellation; null while `ACTIVE` example: null created_at: type: string format: date-time description: When Rinne first stored the effect example: '2026-07-02T09:12:44.000Z' updated_at: type: string format: date-time description: When the effect last changed example: '2026-10-14T09:05:10.000Z' PaginationResponse: type: object required: - page - limit - total - totalPages - hasNext - hasPrev properties: page: type: integer example: 1 limit: type: integer example: 20 total: type: integer example: 50 totalPages: type: integer example: 3 hasNext: type: boolean example: true hasPrev: type: boolean example: false ValidationErrorResponse: type: object properties: error: type: object properties: code: type: string example: VALIDATION_ERROR message: type: string example: Validation error status: type: integer example: 400 details: type: object properties: issues: type: array items: type: object properties: field: type: string example: email type: type: string example: REQUIRED message: type: string example: Field 'email' is required value: anyOf: - type: string - type: number - type: boolean example: invalid_value constraints: type: object example: min: 18 max: 120 path: type: string example: /companies timestamp: type: string format: date-time example: '2023-12-01T10:00:00.000Z' requestId: type: string example: req_123456789 AuthenticationErrorResponse: type: object properties: error: type: object properties: code: type: string example: AUTHENTICATION_ERROR message: type: string example: Authentication required to access this resource status: type: integer example: 401 details: type: object properties: reason: type: string example: Invalid API key path: type: string example: /companies/me timestamp: type: string format: date-time example: '2023-12-01T10:00:00.000Z' requestId: type: string example: req_123456789 AuthorizationErrorResponse: type: object properties: error: type: object properties: code: type: string example: AUTHORIZATION_ERROR message: type: string example: You need 'admin' permissions to access this resource status: type: integer example: 403 path: type: string example: /companies timestamp: type: string format: date-time example: '2023-12-01T10:00:00.000Z' requestId: type: string example: req_123456789 NotFoundErrorResponse: type: object properties: error: type: object properties: code: type: string example: RESOURCE_NOT_FOUND message: type: string example: Company with ID '123' not found status: type: integer example: 404 path: type: string example: /companies/me timestamp: type: string format: date-time example: '2023-12-01T10:00:00.000Z' requestId: type: string example: req_123456789 InternalServerErrorResponse: type: object properties: error: type: object properties: code: type: string example: INTERNAL_SERVER_ERROR message: type: string example: An unexpected error occurred status: type: integer example: 500 path: type: string example: /companies timestamp: type: string format: date-time example: '2023-12-01T10:00:00.000Z' requestId: type: string example: req_123456789 securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: Company API key for authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.