Skip to main content
POST
Create a Medicare claim

Body

application/json
locationId
string
required

Location ID

Example:

"prlo_39SaCy77MShwXBMzwFVSMHOtXdq"

type
enum<string>
required

Type of claim

Available options:
patient,
bulk_bill
Example:

"patient"

paymentStatus
enum<string>
required

Payment status

Available options:
full_paid,
part_paid,
not_paid
Example:

"full_paid"

submit
boolean
required

Whether to submit the claim to Medicare Online immediately or store for later submission

Example:

true

serviceProvider
object
required
patient
object
required
items
object[]
required
Required array length: 1 - 16 elements
claimant
object

Optional override for the claimant if different from the patient.

reference
string

Reference number to identify the claim in the system

Required string length: 1 - 9
Example:

"INV000001"

paymentAmount
number

Total amount that has already been paid

Required range: 50 <= x <= 9999999
Example:

25000

transactionId
string

Transaction ID

Maximum string length: 255
Example:

"btrn_39Q57MwxjLyx7PBXZObTpY4JQr6"

payeeProvider
object
referral
object
overrides
object
metadata
object

Response

items
object[]
page
number
Example:

1

limit
number
Example:

10

totalItems
number
Example:

100

totalPages
number
Example:

10