Attach proof of payment

post

https://sandbox.uk.rootplatform.com/v1/insurance/invoices/{invoice_id}/proof-of-payment

Attach a proof of payment document to an invoice: a remittance advice or bank confirmation supporting a payment collected outside Root. Attaching a file does not change the invoice's status; settle it with mark as paid.

Attaching replaces any file already attached. Download the current one with retrieve proof of payment.

Invoicing is opt-in per organization: unless the invoicing feature flag is enabled for your organization this endpoint returns 403.

Path Params

invoice_id

string

required

Must be a UUID. The unique identifier of the invoice.

Body Params

file_name

string

required

length between 1 and 255

The file name to store the document under.

file_base64

string

required

length ≤ 10485760

The file's contents, base64-encoded. Capped at 10MB of encoded payload, because these routes sit behind the standard JSON body limit, not the larger one the dedicated attachment routes get.

file_type

string

enum

required

The document's MIME type. Must be one of Root's allowed attachment types, and must match the file's actual contents.

Responses

400

Validation error. Examples: file_type is not an allowed MIME type, or the file's contents do not match the declared type.

403

Invoicing is not enabled for the organization, or the caller is missing the invoices:mark_paid permission.

404

No such invoice, or the caller's user group does not grant access to its policy.

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success. The invoice is returned with proof_of_payment_file_id set.