Skip to content
Purser

Manual Match

POST
/matching/match
curl --request POST \
  --url https://example.com/matching/match \
  --header 'Content-Type: application/json' \
  --data '{ "expected_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "posted_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Mark an expected row paid by a bank row (write scope). When the matcher already proposed exactly this pair (the unmatched report’s proposed_posted_id), the proposal is confirmed in place; a bank row proposed for a different expected is refused, naming it (decision 76).

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ManualMatchRequest
object
expected_id
required
Expected Id
string format: uuid
posted_id
required
Posted Id
string format: uuid

Example generated

{
  "expected_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "posted_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
MatchOut
object
expected_amount
Any of:
string
expected_date
Any of:
string format: date
expected_description
Any of:
string
expected_id
required
Expected Id
string format: uuid
expected_payee
Any of:
string
id
required
Id
string format: uuid
posted_id
required
Posted Id
string format: uuid
score
required
Score
number
state
required
State
string
variance
required
Any of:
string
variance_ratio
required
Any of:
string

Example generated

{
  "expected_amount": "example",
  "expected_date": "2026-04-15",
  "expected_description": "example",
  "expected_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "expected_payee": "example",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "posted_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "score": 1,
  "state": "example",
  "variance": "example",
  "variance_ratio": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}