Get Payer Import¶

Returns a single payer import job.

Endpoint¶

GET /v2/billing-profiles/{billing_profile_id}/payers/imports/{import_id}

Path Parameters¶

Parameter	Type	Required	Description
`billing_profile_id`	string	Yes	The billing profile this record belongs to.
`import_id`	string	Yes	The import job's id.

Request¶

curl --location '{base_url}/v2/billing-profiles/b7e4c1a2-6f3d-4e9b-9a51-2c8d0f7e3a14/payers/imports/1e7b9c3d-5a2f-4d8e-b6c1-0f4a7d2e9b35' \
  --header 'Authorization: Bearer JWT_TOKEN'

Response¶

Success Response¶

Code: 200 OK

{
  "import_id": "1e7b9c3d-5a2f-4d8e-b6c1-0f4a7d2e9b35",
  "billing_profile_id": "b7e4c1a2-6f3d-4e9b-9a51-2c8d0f7e3a14",
  "file_name": "payers.csv",
  "status": "READY",
  "counts": {
    "total": 42,
    "verified": 38,
    "unverified": 3,
    "skipped": 1
  },
  "error": null,
  "uploaded_at": "2026-08-27T14:30:00Z"
}

Response Fields¶

Field	Type	Description
`import_id`	string	The import job's id.
`billing_profile_id`	string or null	The billing profile this record belongs to.
`file_name`	string or null	The uploaded file's name.
`status`	string	Lifecycle state of the record. One of `QUEUED`, `PARSING`, `MATCHING`, `READY`, `FAILED`.
`counts`	object or null	Row counts: `total` parsed, `verified` matched to the master, `unverified` created for review, `skipped` blank/duplicate. See Counts.
`error`	string or null	Failure reason when `status` is `FAILED`. `null` otherwise.
`uploaded_at`	string	When the file was uploaded.

Counts¶

Field	Type	Description
`total`	integer	Rows parsed from the sheet.
`verified`	integer	Rows matched to the clearing-house master.
`unverified`	integer	Rows created for review — no match in the master.
`skipped`	integer	Rows skipped — blank or duplicate.

Error Response¶

Code: 400 Bad Request

{
  "code": "bad_request",
  "message": "Validation failed",
  "errors": [
    {
      "field": "patient_id",
      "message": "must be a string"
    }
  ]
}

Every error has the same shape — a machine-readable code, a message, and an errors[] array that's empty when there's nothing field-specific to report. The HTTP status is authoritative.

Status	`code`	Meaning
`400 Bad Request`	`bad_request`	The request body or parameters failed validation. `errors[]` names the offending fields.
`401 Unauthorized`	`unauthorized`	The access token is missing, malformed or expired.
`403 Forbidden`	`forbidden`	The request references a resource outside the token's organisation or clinic scope.
`404 Not Found`	`not_found`	No such resource, or it's outside your scope.
`429 Too Many Requests`	`rate_limited`	Rate limit exceeded. Back off and retry.
`500 Internal Server Error`	`internal_error`	Unexpected server error.
`502 Bad Gateway`	`upstream_error`	Upstream service failed or timed out.

Notes¶

status moves QUEUED → PARSING → MATCHING → READY (or FAILED).