> ## Documentation Index > Fetch the complete documentation index at: https://docs.clinikehr.com/llms.txt > Use this file to discover all available pages before exploring further. # Send a payment advice > **Permission:** `insurance.remittances:write` Tell the clinic what your insurer paid. Records an ADVICE for clinic staff to reconcile. It never changes a claim, a payment or the clinic's books - the clinic records the money itself. Answers 201 with the advice. Only for the insurer the clinic linked to your organization. The `Idempotency-Key` header is REQUIRED. ## OpenAPI ````yaml /openapi/ehr-api.v1.yaml post /v1/clinics/{clinic_id}/insurance/payment-advices openapi: 3.1.0 info: title: ClinikEHR API version: 1.0.0 description: >- Server-to-server REST API for a clinic's own data, reached with a key the clinic (or a developer workspace) creates in the developer portal. Authenticate every request with `Authorization: Bearer `. Test keys reach only your workspace's own synthetic sandbox; live keys reach the clinic that created them. Lists wrap their rows as `{ data, has_more, next_cursor }`; single resources are returned directly. Errors are `application/problem+json` (RFC 9457) with a stable `code`. Write requests accept an `Idempotency-Key` header so a retry never repeats a change. See the guides for authentication, permissions, pagination, rate limits and retries. servers: - url: https://api.clinikehr.com security: - ApiKey: [] paths: /v1/clinics/{clinic_id}/insurance/payment-advices: post: tags: - HMO insurance summary: Send a payment advice description: >- **Permission:** `insurance.remittances:write` Tell the clinic what your insurer paid. Records an ADVICE for clinic staff to reconcile. It never changes a claim, a payment or the clinic's books - the clinic records the money itself. Answers 201 with the advice. Only for the insurer the clinic linked to your organization. The `Idempotency-Key` header is REQUIRED. operationId: createInsurancePaymentAdvice parameters: - $ref: '#/components/parameters/IdempotencyKeyRequired' - name: clinic_id in: path required: true schema: type: string format: uuid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InsurancePaymentAdviceCreate' responses: '201': description: Created - an advice, status `advised`. content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/InsurancePaymentAdvice' idempotent_replay: type: boolean description: >- Present and true when this Idempotency-Key was already used and the original answer is returned. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/TooManyRequests' security: - ApiKey: [] components: parameters: IdempotencyKeyRequired: name: Idempotency-Key in: header required: true description: >- A unique value you choose for this request, such as a UUID. Sending the same key again returns the first answer instead of doing the work twice, so a timed-out request is safe to retry. Reusing a key for a different request is refused with `409 idempotency_key_conflict`, and retrying while the first request is still running with `409 idempotency_key_reused`. See Retries and idempotency. schema: type: string minLength: 1 schemas: InsurancePaymentAdviceCreate: type: object additionalProperties: false description: >- A payment advice. Each allocation names a claim of that insurer that is awaiting payment and an amount no larger than what the claim still owes; the allocations may not add up to more than `amount`. `currency`, if sent, must be the clinic's currency. required: - insurance_company_id - paid_on - amount - method properties: insurance_company_id: type: string format: uuid paid_on: type: string format: date amount: type: number exclusiveMinimum: 0 currency: type: string maxLength: 10 method: type: string enum: - bank_transfer - eft - cheque - other reference: type: string maxLength: 200 allocations: type: array maxItems: 500 items: $ref: '#/components/schemas/InsurancePaymentAdviceAllocation' InsurancePaymentAdvice: type: object description: >- What an insurer says it paid the clinic. It is an ADVICE for clinic staff to reconcile: it never changes a claim, the clinic's payments or its books. `status` is `advised` until staff act on it. required: - id - insurance_company_id - amount - status properties: id: type: string format: uuid insurance_company_id: type: string format: uuid paid_on: type: string format: date amount: type: number currency: type: string method: type: string enum: - bank_transfer - eft - cheque - other reference: type: - string - 'null' status: type: string enum: - advised - recorded - declined created_at: type: string format: date-time allocations: type: array items: type: object properties: claim_id: type: string format: uuid amount: type: number InsurancePaymentAdviceAllocation: type: object additionalProperties: false required: - claim_id - amount properties: claim_id: type: string format: uuid amount: type: number exclusiveMinimum: 0 Problem: type: object description: RFC 9457 application/problem+json. required: - type - title - status - code - request_id properties: type: type: string format: uri title: type: string status: type: integer detail: type: string code: type: string request_id: type: string errors: type: array items: type: object required: - pointer - message properties: pointer: type: string message: type: string responses: BadRequest: description: >- The request failed validation (unknown query parameter, limit out of range, malformed body, or a write-off sent without its reason — `reason_required`). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' Unauthorized: description: >- Missing, malformed, unknown, revoked or expired key, or the wrong secret. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' Forbidden: description: >- The key or connection lacks the required scope, the plan does not include this resource, the request came from an address this key's IP allow-list does not permit, a TEST-environment workspace key asked for a clinic_id other than its own workspace's sandbox (`sandbox_only`), or a LIVE workspace key asked for a real clinic while its workspace's verification has lapsed (`not_verified`) — the response never names which addresses ARE allowed, nor which clinic actually is the sandbox. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' NotFound: description: The record is absent, or out of the key's scope — one message for both. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' Conflict: description: >- The request is well-formed but conflicts with the CURRENT STATE of the record — a double-booked slot (`slot_taken`), a clinician's calendar blocked at that time (`out_of_office`), nobody eligible free (`no_provider_available`), an item that still has stock (`item_has_stock`), an item that has been used and so cannot be deleted (`item_has_history`), a ledger movement that cannot be covered (`insufficient_stock`, `expired_stock_not_transferable`), a note already signed or clinician-touched (`note_not_editable`), an Idempotency-Key already used for a different request or still in flight (`idempotency_key_conflict`, `idempotency_key_reused`), or an external-stock batch rejected as structurally invalid or a suspicious shrink versus the clinic's last accepted batch (`batch_rejected`), or an outside record that conflicts with what was already submitted or decided: the same `client_reference` sent again with different content (`client_reference_conflict`), or a submission a clinician has already decided (`submission_not_pending`), or an insurance write that conflicts with the clinic's setup or the coverage's state: the patient already has a coverage for that payer (`coverage_exists`, the existing coverage's id is in `detail` when the caller can see that patient), a payer the clinic has not enabled in Settings → Insurance (`payer_not_enabled`), or `coverage_active: true` sent through the API (`activation_requires_staff` — only clinic staff activate a coverage), or a change to an outside care provider the clinic added rather than an app (`care_provider_clinic_managed` — only the clinic can change or remove it). content: application/problem+json: schema: $ref: '#/components/schemas/Problem' TooManyRequests: description: Rate limited. See the Retry-After header. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: ehr_live__ or ehr_test__ ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.