Get invoice by ID

{
  "id": "string",
  "invoice_number": "string",
  "invoice_date": "2023-01-15",
  "total": 1.1,
  "tax": 1.1,
  "subtotal": 1.1,
  "plan_manager": "string",
  "participant_id": "string",
  "claim_status": "string",
  "approval_status": "string",
  "created_at": "2024-01-15T09:30:00Z",
  "pm_provider_id": "string",
  "s3_key": "string",
  "email_message_id": "string",
  "errors": true,
  "state_management": {},
  "is_deleted": true,
  "wont_claim": true,
  "is_reimbursement": true,
  "is_duplicate": true,
  "line_items": [
    {
      "id": "string",
      "invoice": "string",
      "description": "string",
      "quantity": 1.1,
      "unit_price": 1.1,
      "total_price": 1.1,
      "service_item_number": "string",
      "claim_status": "string",
      "claim_batch_ref": "string",
      "claim_number": "string",
      "payment_ref": "string",
      "is_deleted": true,
      "created_at": "2024-01-15T09:30:00Z"
    }
  ]
}

Returns a single invoice including line items. Requires X-Plan-Manager-Id header.

Authentication

AuthorizationBearer

API key issued for your account. Send as Bearer token in the Authorization header.

X-Plan-Manager-Idstring

Plan manager UUID. Required on all public API requests to scope data access.

Path parameters

invoice_idstringRequired

Invoice ID (numeric or UUID)

Response

Invoice with line items

idstringOptional

invoice_numberstringOptional

invoice_datedateOptional

totaldoubleOptional

taxdoubleOptional

subtotaldoubleOptional

plan_managerstringOptional

participant_idstringOptional

claim_statusstringOptional

approval_statusstringOptional

created_atdatetimeOptional

pm_provider_idstringOptional

s3_keystringOptional

email_message_idstringOptional

Email message ID associated with the invoice

errorsbooleanOptional

state_managementobjectOptional

State management (object with errors/ignored_errors or string)

is_deletedbooleanOptional

wont_claimbooleanOptional

is_reimbursementbooleanOptional

is_duplicatebooleanOptional

line_itemslist of objectsOptional

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error