curl --request DELETE \
--url https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'If-Match: <if-match>' \
--data '
{
"actionId": "7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d",
"reason": "Recorded against the wrong invoice"
}
'import requests
url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId}"
payload = {
"actionId": "7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d",
"reason": "Recorded against the wrong invoice"
}
headers = {
"If-Match": "<if-match>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {
'If-Match': '<if-match>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
actionId: '7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d',
reason: 'Recorded against the wrong invoice'
})
};
fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'actionId' => '7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d',
'reason' => 'Recorded against the wrong invoice'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"If-Match: <if-match>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId}"
payload := strings.NewReader("{\n \"actionId\": \"7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d\",\n \"reason\": \"Recorded against the wrong invoice\"\n}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("If-Match", "<if-match>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId}")
.header("If-Match", "<if-match>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"actionId\": \"7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d\",\n \"reason\": \"Recorded against the wrong invoice\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["If-Match"] = '<if-match>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"actionId\": \"7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d\",\n \"reason\": \"Recorded against the wrong invoice\"\n}"
response = http.request(request)
puts response.read_body{
"journalIds": [
"7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d",
"8b0c2d4e-6f7a-4b9c-1d3e-2f4a5b6c7d8e"
],
"invoice": {
"id": "550e8400-e29b-41d4-a716-446655440700",
"invoiceNumber": "INV-389538-455",
"categoryId": "550e8400-e29b-41d4-a716-446655440100",
"status": "owed",
"linkedEvent": {
"id": "550e8400-e29b-41d4-a716-446655440200",
"displayName": "Claim #1042"
},
"linkedPolicy": null,
"linkedPayee": null,
"incurredDate": "2026-06-01",
"dueDate": null,
"memo": "Legal defense",
"fieldData": null,
"lineItems": [
{
"lineItemId": "550e8400-e29b-41d4-a716-446655440300",
"lineItemTypeId": "550e8400-e29b-41d4-a716-446655440110",
"memo": null,
"amountCents": 10000
}
],
"totalAmountCents": 10000,
"amountPaidCents": 0,
"balanceDueCents": 10000,
"draftAmountPaidCents": null,
"paidDate": null,
"lastPaymentDate": null,
"approved": true,
"approvedAt": "2026-06-10T09:00:00.000Z",
"voidedAt": null,
"deletedAt": null,
"createdAt": "2026-06-01T10:30:00.000Z",
"updatedAt": "2026-06-16T09:00:00.000Z",
"headJournalId": "7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d"
},
"payments": []
}Remove Payment
Removes a recorded payment — the invoice.payment_removed action, the
exact negation of what the payment posted (an optional reason rides the
body). An unknown paymentId on a live invoice is 422 PAYMENT_NOT_FOUND.
The horizon rule is automatic. Removing a reserve-eroding payment
recorded BEFORE the scope’s reserve-history reset would resurrect eroded
reserves the reset already absorbed — so the server composes a companion
reserve unwind in the same transaction, and journalIds carries BOTH
ids. Callers never handle the horizon themselves.
Concurrency + idempotency. Requires If-Match (the invoice’s current
headJournalId); the body carries the client-minted actionId — an
identical retry replays the original outcome, companion ids included.
Required permission: payment.delete
curl --request DELETE \
--url https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'If-Match: <if-match>' \
--data '
{
"actionId": "7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d",
"reason": "Recorded against the wrong invoice"
}
'import requests
url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId}"
payload = {
"actionId": "7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d",
"reason": "Recorded against the wrong invoice"
}
headers = {
"If-Match": "<if-match>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.delete(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {
'If-Match': '<if-match>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
actionId: '7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d',
reason: 'Recorded against the wrong invoice'
})
};
fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_POSTFIELDS => json_encode([
'actionId' => '7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d',
'reason' => 'Recorded against the wrong invoice'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"If-Match: <if-match>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId}"
payload := strings.NewReader("{\n \"actionId\": \"7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d\",\n \"reason\": \"Recorded against the wrong invoice\"\n}")
req, _ := http.NewRequest("DELETE", url, payload)
req.Header.Add("If-Match", "<if-match>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId}")
.header("If-Match", "<if-match>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"actionId\": \"7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d\",\n \"reason\": \"Recorded against the wrong invoice\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/financials/invoices/{invoiceId}/payments/{paymentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["If-Match"] = '<if-match>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"actionId\": \"7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d\",\n \"reason\": \"Recorded against the wrong invoice\"\n}"
response = http.request(request)
puts response.read_body{
"journalIds": [
"7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d",
"8b0c2d4e-6f7a-4b9c-1d3e-2f4a5b6c7d8e"
],
"invoice": {
"id": "550e8400-e29b-41d4-a716-446655440700",
"invoiceNumber": "INV-389538-455",
"categoryId": "550e8400-e29b-41d4-a716-446655440100",
"status": "owed",
"linkedEvent": {
"id": "550e8400-e29b-41d4-a716-446655440200",
"displayName": "Claim #1042"
},
"linkedPolicy": null,
"linkedPayee": null,
"incurredDate": "2026-06-01",
"dueDate": null,
"memo": "Legal defense",
"fieldData": null,
"lineItems": [
{
"lineItemId": "550e8400-e29b-41d4-a716-446655440300",
"lineItemTypeId": "550e8400-e29b-41d4-a716-446655440110",
"memo": null,
"amountCents": 10000
}
],
"totalAmountCents": 10000,
"amountPaidCents": 0,
"balanceDueCents": 10000,
"draftAmountPaidCents": null,
"paidDate": null,
"lastPaymentDate": null,
"approved": true,
"approvedAt": "2026-06-10T09:00:00.000Z",
"voidedAt": null,
"deletedAt": null,
"createdAt": "2026-06-01T10:30:00.000Z",
"updatedAt": "2026-06-16T09:00:00.000Z",
"headJournalId": "7a9b1c3d-5e6f-4a8b-0c2d-1e3f4a5b6c7d"
},
"payments": []
}Authorizations
API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.
Headers
The invoice's current headJournalId — the optimistic-concurrency watermark every single-invoice write after creation must send. Read it off any invoice read or write response and echo it verbatim (a bare uuid; an entity-tag dressing of it — "uuid" or W/"uuid" — is also accepted). Missing or malformed is a 400 (IF_MATCH_REQUIRED / IF_MATCH_INVALID); a stale value is a 409 IF_MATCH_CONFLICT whose body carries the current invoice. An idempotent actionId replay short-circuits BEFORE the watermark is evaluated.
Path Parameters
Company identifier
Invoice identifier
The payment's id — from the record-payment response or the invoice's payments
Body
Client-minted idempotency key — becomes the action's journal id. An identical retry replays the original outcome; reuse with a different payload is 409 ACTION_ID_REUSED
Optional display label for the source system's author (e.g. the integrator-side user). Stamped as the journal record's display attribution; the acting principal stays the External API service user, so a label can never impersonate an in-app user. Ignored on idempotent replays
1 - 255Optional free-text reason, recorded on the action
Response
The refreshed invoice state; journalIds carries the removal plus the companion reserve unwind when the horizon rule composed one
The response of every single-invoice write — refreshed read state, not an ack: the emitted journal id(s), THE invoice row (identical shape to the reads — one invoice representation everywhere; its headJournalId is the next If-Match), and the invoice's live payments. An idempotent actionId replay returns this same shape rebuilt from the original outcome, server-minted values included.
Every journal id the write emitted — the anchor action's id (the actionId you supplied) first, then any engine-minted siblings (a multi-mark payment's additional marks) and any companion the horizon rule composed (e.g. the reserve unwind of a pre-horizon eroding payment's removal, or a delete's payment sweep)
1THE invoice representation — the same shape everywhere an endpoint returns an invoice (listing rows, the detail read, and every write's refreshed-row response). headJournalId is the invoice's current journal head — the optimistic-concurrency token subsequent writes echo back as If-Match.
Show child attributes
Show child attributes
The invoice's live payment marks after the write, newest first
Show child attributes
Show child attributes
