Deliver a PDF, such as the invoice, when you create a collection order, or separately with POST /v3/documents. Your customer sees the document in MyCase. Afterwards you can change its name or visibility, or hide it. Belgian hospitals also send a D-form.
Which option do you choose?
| Situation | Use |
|---|---|
| You create the collection order and already have the document | Send the document with POST /v3/collection_orders (field document). It is linked to the collection order straight away. |
| The collection order already exists | POST /v3/documents with the collection order number in cid. |
| The document arrives before the collection order | POST /v3/documents without cid. A flow step links the document to the collection order later, based on the file name, for example the invoice number. Ask POM to set up that step. |
A document is always a PDF, sent as base64. Each document costs 40 points. See Getting started with the API.
Changing or hiding a document
- With
PATCH /v3/documents/{id}you change the file name, the description or the visibility in MyCase. The description is the name your customer sees; make it unique, for example "Invoice 12345". - With
DELETE /v3/documents/{id}you hide the document in MyCase and on the self-service page. A document already sent by post naturally stays with the customer. - If you want to include a document in an email, it must be visible in MyCase.
Sending a D-form (Belgium)
For Belgian hospital invoices you can link the D-form data to a collection order with POST /v3/collection_orders/{id}/d_form. The D-form is sent with the letter, so the patient can claim the costs from their health insurer.
- You send the type (
griortxt) and the content, up to 1 MB. - Each collection order has one D-form. If you send it again, the previous one is overwritten.
- The data is stored encrypted.