> For the complete documentation index, see [llms.txt](https://docs.flowretail.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flowretail.com/docs/developers/api-documentation/service/e-mail-a-service-paper.md).

# E-mail a service paper

E-mail one of the service papers as a PDF attachment — the damage report to the customer's insurer, the service confirmation or the service summary to the customer. The paper is rendered at the moment of the request exactly as the printable paper renders, apart from the signature line set out below: the same content, the same photos where a damage report names them in assetUids, and the same rules on what never appears on a paper, the customer's service portal link among them. It is rendered in the customer's preferred language, and in the tenant's where the customer has none, and the file is named with the paper's localized name and the service number. The e-mail goes to the address given in email, and to the customer's own address when none is given; any address may be given. Its text is the tenant's own text for EMAIL\_SERVICE\_DOCUMENT\_SENT, a service template type like any other: the tenant writes the text under that exact name, the platform catalog does not list it, and nothing stands behind it until the tenant writes it. It is composed exactly as every other service message is, with the service order's values filled in and the paper's localized name available as a variable, in the language the paper is rendered in. The service portal link variable is filled only when the paper goes to the customer's own address — email left out, or equal to the customer's address; sent anywhere else it is empty, so a paper e-mailed to a third party never carries a way into the customer's case. It is sent from the e-mail address of the store that owns the service order, under that store's name, whichever store it is asked for at: a reply reaches the store the work sits with. An e-mailed paper never prints the blank signature line the printed confirmation carries: where no acceptance stands, the confirmation prints the terms and nothing under them. A standing acceptance prints as it does on the printed paper — the drawn signature with the customer who accepted, when and how, or the fact of the acceptance with when and how. The request is refused with a 400 when no address is given and the customer has none, when the tenant has no text for EMAIL\_SERVICE\_DOCUMENT\_SENT, when the store that owns the service order has no e-mail address of its own, and while the tenant setting serviceMessagesPaused is on — a message asked for by hand is refused outright rather than queued for a moment that has passed. assetUids is judged as on the printable paper, and a refused photo sends nothing. A paper that cannot be rendered sends nothing either: the request fails and nothing is sent. Any of the three papers may be sent at any time, a finished case included. The notification that was created is returned and recorded in the notification log alongside every other message about the case; it records the address the paper went to, which is not the customer's when another was given. The attachment is handed to the e-mail provider and never stored by the platform, as every e-mailed sales receipt's is: the notification log keeps the subject, the text and the address, never the file. A customer link in a notification is served masked (see NotificationResponseSchema). Sending a paper changes nothing on the service order. This is read reach rather than a write on the case: it is served at any store of the tenant, whichever store owns the service order and whichever store took it in; the service order record carries the whole reach rule.

Required permissions: SERVICE\_ORDER

```json
{"openapi":"3.0.2","info":{"title":"Flow Retail API version 2","version":"2.0.0"},"tags":[{"name":"Service","description":"Service"}],"servers":[{"description":"Flow Retail Production","url":"https://api.flowretail.com/v2"},{"description":"Flow Retail Stage","url":"https://api.stage.flowretail.com/v2"}],"security":[{"accessToken":[]},{"authToken":[]},{"integrationToken":[]}],"components":{"securitySchemes":{"accessToken":{"description":"Access token recevied after user login with a deviceToken","scheme":"bearer","type":"http"},"authToken":{"description":"Token received from the auth service","scheme":"bearer","type":"http"},"integrationToken":{"scheme":"bearer","type":"http"}},"responses":{"NotificationResponse":{"description":"Example response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationResponseSchema"}}}}},"schemas":{"NotificationResponseSchema":{"title":"NotificationResponseSchema","type":"object","required":["messageType","recipient","message","subject","state","errorText","notificationUid","customerUid","orderUid","serviceOrderUid","serviceEventUid","tenantUserUid","supplierUid","receivementUid","purchaseOrderUid","createdBy","createdAt","lastModifiedBy","lastModifiedAt","source"],"properties":{"messageType":{"$ref":"#/components/schemas/MessageTypeENUM"},"recipient":{"type":"string"},"message":{"type":"string","description":"A customer link in it is served with its token replaced by …, the address kept: the service portal link, a portal document link and a counter signing link keep the scheme, the host and the path up to the token, and any other whole run of letters, digits, hyphens and underscores, bounded by other characters or the text's edge, exactly as long as one of those tokens is replaced by … wherever it stands. The stored message is what was sent, and the response never carries the credential."},"subject":{"type":"string","description":"A customer link in it is served with its token replaced by …, the address kept: the service portal link, a portal document link and a counter signing link keep the scheme, the host and the path up to the token, and any other whole run of letters, digits, hyphens and underscores, bounded by other characters or the text's edge, exactly as long as one of those tokens is replaced by … wherever it stands. The stored message is what was sent, and the response never carries the credential."},"state":{"$ref":"#/components/schemas/NotificationStateENUM"},"errorText":{"type":"string"},"notificationUid":{"$ref":"#/components/schemas/UID"},"customerUid":{"description":"The customer the message is recorded against. A value here marks the row as part of the message log for that customer; an empty value says only that no customer was named on the write, and not that the message went to staff — a receipt or a payment link is addressed to whatever number or address the caller gave, which need not come from a customer record, and the notes the order- and customer-scoped searches merge in from Omnium name no customer either. Where the message was actually delivered is recipient.","type":"string","pattern":"^[A-Za-z0-9_-]*$"},"orderUid":{"$ref":"#/components/schemas/OptionalUID"},"serviceOrderUid":{"$ref":"#/components/schemas/OptionalUID"},"serviceEventUid":{"$ref":"#/components/schemas/OptionalUID"},"tenantUserUid":{"description":"The tenant user the message is recorded against. It is never who the message was delivered to — that is recipient, which carries the address or number it was sent to, or several of them separated by commas — so a message to a colleague names its sender here rather than its reader. Who it credits is the person on our side behind the send: in the service module the caller who made the write, which on a shared screen is the person whose PIN unlocked it; elsewhere the user the record behind the message belongs to, such as the salesperson a receipt is registered to. It is empty only on the notes the order- and customer-scoped searches merge in from Omnium, which name nobody on our side.","type":"string","pattern":"^[A-Za-z0-9_-]*$"},"supplierUid":{"$ref":"#/components/schemas/OptionalUID"},"receivementUid":{"$ref":"#/components/schemas/OptionalUID"},"purchaseOrderUid":{"$ref":"#/components/schemas/OptionalUID"},"createdBy":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"lastModifiedBy":{"type":"string"},"lastModifiedAt":{"type":"string","format":"date-time"},"source":{"type":"string","description":"Source of the notification"}}},"MessageTypeENUM":{"title":"MessageTypeENUM","type":"string","enum":["EMAIL","SMS"]},"NotificationStateENUM":{"title":"NotificationStateENUM","type":"string","enum":["NOT_STARTED","IN_PROGRESS","COMPLETE","FAILED"]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"},"OptionalUID":{"title":"OptionalUID","type":"string","pattern":"^[A-Za-z0-9-_]*"},"ServiceOrderDocumentEmailSchema":{"title":"ServiceOrderDocumentEmailSchema","description":"A service paper to e-mail now, as a PDF attachment — the damage report to the customer's insurer, the service summary to a customer who left without it.\nThe paper is rendered at the moment of the request exactly as the printable paper renders, apart from the blank signature line an e-mailed paper never prints, and the e-mail text is the tenant's own text for EMAIL_SERVICE_DOCUMENT_SENT. The send is recorded in the notification log alongside every other message about the case, with the address the paper went to.","type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/ServiceOrderDocumentTypeENUM"},"email":{"description":"The address to send the paper to. Left out, it goes to the customer's e-mail address, and the request is refused with a 400 when the customer has none. Any address may be given — the insurer's, the manufacturer's — and the paper goes there instead of to the customer; sent anywhere but the customer's own address, the message carries no service portal link. A value that is not an e-mail address is refused with a 400.","allOf":[{"$ref":"#/components/schemas/EmailTYPE"}]},"assetUids":{"type":"array","maxItems":12,"description":"The photos to print on the damage report, in the order given, at most 12 — the same photos, under the same rules and refusals, as the assetUids of the printable paper. Allowed with type DAMAGE_REPORT only: a non-empty list sent with any other paper is refused with a 400, and an empty one is the same as leaving it out. Left out, the paper carries no photos.","items":{"$ref":"#/components/schemas/UID"}}}},"ServiceOrderDocumentTypeENUM":{"title":"ServiceOrderDocumentTypeENUM","description":"Which of the three printable service papers is meant. It is never derived from the state of the case — the caller names it, or the tenant names it on a status rule.\nINTAKE_CONFIRMATION: the service confirmation, for the customer, handed across the counter at intake — the record of what was handed in, and the sheet the customer can sign where the terms are accepted in the store. SERVICE_SUMMARY: the service summary, for the customer, handed back with the unit when the work is done — the record of what was done. DAMAGE_REPORT: the damage report, written for a third party — an insurer, a manufacturer, or a seller in a complaint — carrying the unit, the coverage, the findings, the customer-visible photos the caller names and the price of the work, and nothing of the dialogue between the customer and the store.\nAny of the three can be asked for at any time and under any coverage.","type":"string","enum":["INTAKE_CONFIRMATION","SERVICE_SUMMARY","DAMAGE_REPORT"]},"EmailTYPE":{"title":"Email","type":"string"}},"requestBodies":{"ServiceOrderDocumentEmailRequest":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceOrderDocumentEmailSchema"}}}}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/reports/email":{"post":{"summary":"E-mail a service paper","operationId":"post-serviceorders-reports-email","description":"E-mail one of the service papers as a PDF attachment — the damage report to the customer's insurer, the service confirmation or the service summary to the customer.\nThe paper is rendered at the moment of the request exactly as the printable paper renders, apart from the signature line set out below: the same content, the same photos where a damage report names them in assetUids, and the same rules on what never appears on a paper, the customer's service portal link among them. It is rendered in the customer's preferred language, and in the tenant's where the customer has none, and the file is named with the paper's localized name and the service number.\nThe e-mail goes to the address given in email, and to the customer's own address when none is given; any address may be given. Its text is the tenant's own text for EMAIL_SERVICE_DOCUMENT_SENT, a service template type like any other: the tenant writes the text under that exact name, the platform catalog does not list it, and nothing stands behind it until the tenant writes it. It is composed exactly as every other service message is, with the service order's values filled in and the paper's localized name available as a variable, in the language the paper is rendered in. The service portal link variable is filled only when the paper goes to the customer's own address — email left out, or equal to the customer's address; sent anywhere else it is empty, so a paper e-mailed to a third party never carries a way into the customer's case. It is sent from the e-mail address of the store that owns the service order, under that store's name, whichever store it is asked for at: a reply reaches the store the work sits with.\nAn e-mailed paper never prints the blank signature line the printed confirmation carries: where no acceptance stands, the confirmation prints the terms and nothing under them. A standing acceptance prints as it does on the printed paper — the drawn signature with the customer who accepted, when and how, or the fact of the acceptance with when and how.\nThe request is refused with a 400 when no address is given and the customer has none, when the tenant has no text for EMAIL_SERVICE_DOCUMENT_SENT, when the store that owns the service order has no e-mail address of its own, and while the tenant setting serviceMessagesPaused is on — a message asked for by hand is refused outright rather than queued for a moment that has passed. assetUids is judged as on the printable paper, and a refused photo sends nothing. A paper that cannot be rendered sends nothing either: the request fails and nothing is sent. Any of the three papers may be sent at any time, a finished case included.\nThe notification that was created is returned and recorded in the notification log alongside every other message about the case; it records the address the paper went to, which is not the customer's when another was given. The attachment is handed to the e-mail provider and never stored by the platform, as every e-mailed sales receipt's is: the notification log keeps the subject, the text and the address, never the file. A customer link in a notification is served masked (see NotificationResponseSchema). Sending a paper changes nothing on the service order.\nThis is read reach rather than a write on the case: it is served at any store of the tenant, whichever store owns the service order and whichever store took it in; the service order record carries the whole reach rule.\n\nRequired permissions: SERVICE_ORDER","responses":{"200":{"$ref":"#/components/responses/NotificationResponse"}},"requestBody":{"$ref":"#/components/requestBodies/ServiceOrderDocumentEmailRequest"},"tags":["Service"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flowretail.com/docs/developers/api-documentation/service/e-mail-a-service-paper.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
