> 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/get-a-printable-service-paper.md).

# Get a printable service paper

The printable service papers for a service order. Flow renders one from the service order on request; nothing is stored and nothing has to be prepared first, so a paper says what the case says at the moment it is asked for. There are three, and type names the one to render. INTAKE\_CONFIRMATION is 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 is the service summary, for the customer, handed back with the unit when the work is done — the record of what was done. DAMAGE\_REPORT is the damage report, for a third party — an insurer, a manufacturer, or a seller in a complaint. The parameter is optional and defaults to SERVICE\_SUMMARY, so a caller that names no paper gets the summary. The caller chooses the paper and the server never derives it from the state of the case: the summary is handed over with the unit while the case still stands on READY\_FOR\_PICKUP, so a rule that read the state would print the wrong sheet exactly then. Any of the three can be asked for at any time and under any coverage — a case registered as a payable repair yields the same damage report three weeks later, when the customer claims from an insurer. Every paper opens with the same header: the store that owns the service order, whichever store asks for the paper — its name, address, phone, organization number and logo — the service number with its barcode, with externalSalesOrderNumber, the external sales order number, beside it where the case carries one, the date the case was registered and the date the paper was printed. Each is rendered in the customer's preferred language, and in the tenant's where the customer has none. Written entries only. The service summary and the damage report carry the timeline entries a person wrote — NOTE, DIAGNOSIS and RESOLUTION, as each names below — and only those whose visibility is PUBLIC or REPORT, in time order. The service confirmation carries none: it is the record of what was handed in and of the terms the customer accepted, and a note, a diagnosis or a resolution written on the case is nothing the customer confirmed. An entry marked INTERNAL is never on a paper. Status changes, the messages that went out, the store's messages to the customer and the customer's portal messages, the quote events, and the assignment and shipment history are never printed either, whatever visibility they carry: that history stays in Flow and that dialogue stays in the service portal. REPORT is the visibility that exists for paper alone — printed, and never shown on the portal page. Nor does a paper carry the status the case currently stands on: each of the three is the record of a moment — what was handed in, what was done, what was found — and never a report on where the case sits, which is what the service portal is for. Money on a paper is structured: it is taken from the prices on the service order's own items, or from the quote on the case and the state the quote stands at, and never from a figure written into a diagnosis or a note. A figure typed into a text goes stale when the quote changes and then contradicts the receipt. The sales receipt or invoice remains the settlement document, and no service paper replaces it. Never on any paper: the values of sensitive fields, the secrets on the service order and their labels, INTERNAL entries, the store's own cost — the costPrice and totalCostPrice an item carries — and the margin that follows from it, workshop and supplier arrangements, the name, initials or employee number of any person who worked on the case — the store is the only identity a paper carries — and the customer's service portal link, so that a dropped paper cannot open the case. The service number as a Code128 barcode is not a credential and prints on all three. INTAKE\_CONFIRMATION carries the customer's name and contact details; the unit — its product, with the serial number and the IMEI where they were captured; the answers captured on the intake form, which never include the values of sensitive fields nor the passcode, nor, sensitive or not, the internal note and the location label, and which leave out the product, the serial number and the IMEI, each of those printing in its own line where the paper prints it at all; the issue as it was registered, its title and its description; the coverage, and for an insurance case the insurer, the claim number and the deductible, the claim number printed only where it is not empty and the deductible only where it is not 0; the estimated price and the max price, each printed only where it is not 0, since 0 is how a service order records that none was captured — together they are the arrangement made between the customer and the store; and when the work is expected to be ready, as the day and the time, or as the day and "end of day" where readyAtEstimate reads as the end of the day. It carries no written entries. It prints the resolved terms in full, rendered in the terms format that termsText in the service settings describes: where a standing acceptance exists, the terms printed are that acceptance's own snapshot, the termsText and termsUrl recorded on it, which is the wording the customer answered; where none does, they are the service order's own termsText and termsUrl. Where the standing acceptance was given on a counter device and carries a drawn signature, that signature prints with the terms, together with the customer who accepted, when and how; where the acceptance was given in the service portal or in the store, the fact of it prints with when and how; and where the service order has terms and no acceptance stands, the printed paper carries a blank signature line, for signing at the counter. An e-mailed confirmation never carries that line: where no acceptance stands, it prints the terms and nothing under them, while a standing acceptance prints on it exactly as on the printed paper. A service order without terms prints no terms block. SERVICE\_SUMMARY carries the customer, the unit, the issue as it was registered and the coverage; the written entries — the diagnosis, the resolution and the notes — in time order; the service order's own items, the parts fitted and the work charged, by name and quantity, without prices and without the staff attribution the items carry, while the worked-hours registrations are not printed at all, because each carries the name of the person who registered it; the dates the case was registered and finished, and when the work is expected to be ready, as the day and the time or as the day and "end of day"; and the quoted price with where it stands, sent, approved or declined, printing nothing at all when no quote was made, since payment is on the sales receipt. Its terms line prints one thing and only one: where a standing acceptance exists, the fact of it with when and how. Where none stands, whether because the service order has no terms or because nobody was asked to accept them, no terms block prints at all — this paper is the record of the work, not a report on where the terms stand, and a customer collecting a repaired unit is not told that terms they were never asked for went unaccepted. termsAccepted is not the test for any of it: it reads true on a service order that has no terms at all, so a paper driven by it would announce an acceptance nobody ever gave. No signature and no signature line print on this paper. DAMAGE\_REPORT is the narrowest of the three and carries nothing of the dialogue between the customer and the store: the customer's name; the unit, its product, serial number and IMEI; the coverage, with the insurer, the claim number and the deductible where they exist, that insurer block appearing only when the data is there, the claim number only where it is not empty and the deductible only where it is not 0; the issue as it was registered; the DIAGNOSIS entries in time order and then the RESOLUTION entries, taken under the written-entries rule above; the photos the caller names in assetUids, after the RESOLUTION entries and before the price block; the registration date, and the completion date once it is reached; and a price block. The photos are the customer-visible images on the service order that the caller chooses, in the order given and at most 12: nothing is chosen for the caller, so a damage report asked for without assetUids carries no photos, and whether a file is customer-visible never by itself puts it on a paper. Each photo is scaled down and embedded in the file itself, never linked, so the paper reads the same wherever it is sent. The two other papers carry no photos, and a non-empty assetUids named with either of them is refused with a 400, an empty one being the same as leaving it out. The price block lists the service order's own items — each part and each piece of work by name, quantity and price, with the total below, without the staff attribution the items carry and never the worked-hours registrations. A price of 0 is a price and prints as one: a part fitted under warranty costs the customer nothing, and the third party reading this paper needs to see that it was fitted. Only where the service order carries no items at all do the quoted price and the state it stands at take the block's place, and where there is neither, the block says that no price has been set. The items are the service order's own and never the lines of a linked sales order: that sale is an aggregate which covers only what is billed on it and collapses the work onto the service sale products of each VAT code, while the paper shows every item on the case. It carries no terms, no signature, no estimated price, no max price and no notes. Which file comes back follows the Accept header, the same way every other generated document in the platform is fetched. Read at any store of the tenant: the store in the path is where the permission is judged, and nothing more; 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":{"FileResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Base64EncodedFileContentSchema"}},"application/pdf":{"schema":{"format":"binary","type":"string"}},"text/html":{"schema":{"type":"string"}},"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"description":"Based on the Accept header the response will be base64 json encoded or a raw file.\napplication/octet-stream will return a binary file\napplication/json will return a json with the file content base64 encoded."}},"schemas":{"Base64EncodedFileContentSchema":{"title":"Base64EncodedFileContentSchema","type":"object","properties":{"content":{"type":"string","description":" base64 encoded"},"contentType":{"description":"mime type","type":"string"},"filename":{"type":"string"}},"required":["content","contentType","filename"]},"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"]},"UID":{"title":"UID","type":"string","pattern":"^[A-Za-z0-9-_]+"}},"parameters":{"serviceOrderDocumentTypeQuery":{"name":"type","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ServiceOrderDocumentTypeENUM"},"description":"Which of the three service papers to render. Defaults to SERVICE_SUMMARY: a caller that names no paper gets the summary. A value that is not one of the three is refused with a 400."},"serviceOrderDocumentAssetUidsQuery":{"description":"The photos to print on the damage report, as a comma-separated list of asset uids — assetUids=a,b — at most 12. They print in the order given. Nothing is chosen for the caller: without assetUids the damage report prints no photos, whatever the service order carries.\nAllowed with type DAMAGE_REPORT only: a non-empty list named with any other paper is refused with a 400, and an empty one is the same as leaving it out.\nEach uid must name an image — not a video, not an audio file — that the customer's portal page would list as a document: attached to this service order and to no other, marked customer-visible, in the SERVICE category, and stored privately in Flow Retail. An unknown uid, a file that is not an image (its mimeType is not image/*), a file that is not customer-visible, a file fetched from the CDN without a signature (isPublic) or kept at an address of its own, a file outside the SERVICE category, a file on another service order and not this one, a file attached to more than one service order, and a uid named twice are all refused with a 400, and nothing is rendered. Each request is judged afresh, so a photo unflagged or removed after the preview is refused on the next request.","explode":false,"in":"query","name":"assetUids","schema":{"items":{"$ref":"#/components/schemas/UID"},"type":"array","maxItems":12},"style":"form"}}},"paths":{"/tenants/{tenantUid}/stores/{storeUid}/serviceorders/{serviceOrderUid}/reports":{"get":{"summary":"Get a printable service paper","tags":["Service"],"responses":{"200":{"$ref":"#/components/responses/FileResponse"}},"operationId":"get-serviceorders-reports","description":"The printable service papers for a service order. Flow renders one from the service order on request; nothing is stored and nothing has to be prepared first, so a paper says what the case says at the moment it is asked for.\nThere are three, and type names the one to render. INTAKE_CONFIRMATION is 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 is the service summary, for the customer, handed back with the unit when the work is done — the record of what was done. DAMAGE_REPORT is the damage report, for a third party — an insurer, a manufacturer, or a seller in a complaint. The parameter is optional and defaults to SERVICE_SUMMARY, so a caller that names no paper gets the summary.\nThe caller chooses the paper and the server never derives it from the state of the case: the summary is handed over with the unit while the case still stands on READY_FOR_PICKUP, so a rule that read the state would print the wrong sheet exactly then. Any of the three can be asked for at any time and under any coverage — a case registered as a payable repair yields the same damage report three weeks later, when the customer claims from an insurer.\nEvery paper opens with the same header: the store that owns the service order, whichever store asks for the paper — its name, address, phone, organization number and logo — the service number with its barcode, with externalSalesOrderNumber, the external sales order number, beside it where the case carries one, the date the case was registered and the date the paper was printed. Each is rendered in the customer's preferred language, and in the tenant's where the customer has none.\nWritten entries only. The service summary and the damage report carry the timeline entries a person wrote — NOTE, DIAGNOSIS and RESOLUTION, as each names below — and only those whose visibility is PUBLIC or REPORT, in time order. The service confirmation carries none: it is the record of what was handed in and of the terms the customer accepted, and a note, a diagnosis or a resolution written on the case is nothing the customer confirmed. An entry marked INTERNAL is never on a paper. Status changes, the messages that went out, the store's messages to the customer and the customer's portal messages, the quote events, and the assignment and shipment history are never printed either, whatever visibility they carry: that history stays in Flow and that dialogue stays in the service portal. REPORT is the visibility that exists for paper alone — printed, and never shown on the portal page. Nor does a paper carry the status the case currently stands on: each of the three is the record of a moment — what was handed in, what was done, what was found — and never a report on where the case sits, which is what the service portal is for.\nMoney on a paper is structured: it is taken from the prices on the service order's own items, or from the quote on the case and the state the quote stands at, and never from a figure written into a diagnosis or a note. A figure typed into a text goes stale when the quote changes and then contradicts the receipt. The sales receipt or invoice remains the settlement document, and no service paper replaces it.\nNever on any paper: the values of sensitive fields, the secrets on the service order and their labels, INTERNAL entries, the store's own cost — the costPrice and totalCostPrice an item carries — and the margin that follows from it, workshop and supplier arrangements, the name, initials or employee number of any person who worked on the case — the store is the only identity a paper carries — and the customer's service portal link, so that a dropped paper cannot open the case. The service number as a Code128 barcode is not a credential and prints on all three.\nINTAKE_CONFIRMATION carries the customer's name and contact details; the unit — its product, with the serial number and the IMEI where they were captured; the answers captured on the intake form, which never include the values of sensitive fields nor the passcode, nor, sensitive or not, the internal note and the location label, and which leave out the product, the serial number and the IMEI, each of those printing in its own line where the paper prints it at all; the issue as it was registered, its title and its description; the coverage, and for an insurance case the insurer, the claim number and the deductible, the claim number printed only where it is not empty and the deductible only where it is not 0; the estimated price and the max price, each printed only where it is not 0, since 0 is how a service order records that none was captured — together they are the arrangement made between the customer and the store; and when the work is expected to be ready, as the day and the time, or as the day and \"end of day\" where readyAtEstimate reads as the end of the day. It carries no written entries. It prints the resolved terms in full, rendered in the terms format that termsText in the service settings describes: where a standing acceptance exists, the terms printed are that acceptance's own snapshot, the termsText and termsUrl recorded on it, which is the wording the customer answered; where none does, they are the service order's own termsText and termsUrl. Where the standing acceptance was given on a counter device and carries a drawn signature, that signature prints with the terms, together with the customer who accepted, when and how; where the acceptance was given in the service portal or in the store, the fact of it prints with when and how; and where the service order has terms and no acceptance stands, the printed paper carries a blank signature line, for signing at the counter. An e-mailed confirmation never carries that line: where no acceptance stands, it prints the terms and nothing under them, while a standing acceptance prints on it exactly as on the printed paper. A service order without terms prints no terms block.\nSERVICE_SUMMARY carries the customer, the unit, the issue as it was registered and the coverage; the written entries — the diagnosis, the resolution and the notes — in time order; the service order's own items, the parts fitted and the work charged, by name and quantity, without prices and without the staff attribution the items carry, while the worked-hours registrations are not printed at all, because each carries the name of the person who registered it; the dates the case was registered and finished, and when the work is expected to be ready, as the day and the time or as the day and \"end of day\"; and the quoted price with where it stands, sent, approved or declined, printing nothing at all when no quote was made, since payment is on the sales receipt. Its terms line prints one thing and only one: where a standing acceptance exists, the fact of it with when and how. Where none stands, whether because the service order has no terms or because nobody was asked to accept them, no terms block prints at all — this paper is the record of the work, not a report on where the terms stand, and a customer collecting a repaired unit is not told that terms they were never asked for went unaccepted. termsAccepted is not the test for any of it: it reads true on a service order that has no terms at all, so a paper driven by it would announce an acceptance nobody ever gave. No signature and no signature line print on this paper.\nDAMAGE_REPORT is the narrowest of the three and carries nothing of the dialogue between the customer and the store: the customer's name; the unit, its product, serial number and IMEI; the coverage, with the insurer, the claim number and the deductible where they exist, that insurer block appearing only when the data is there, the claim number only where it is not empty and the deductible only where it is not 0; the issue as it was registered; the DIAGNOSIS entries in time order and then the RESOLUTION entries, taken under the written-entries rule above; the photos the caller names in assetUids, after the RESOLUTION entries and before the price block; the registration date, and the completion date once it is reached; and a price block. The photos are the customer-visible images on the service order that the caller chooses, in the order given and at most 12: nothing is chosen for the caller, so a damage report asked for without assetUids carries no photos, and whether a file is customer-visible never by itself puts it on a paper. Each photo is scaled down and embedded in the file itself, never linked, so the paper reads the same wherever it is sent. The two other papers carry no photos, and a non-empty assetUids named with either of them is refused with a 400, an empty one being the same as leaving it out. The price block lists the service order's own items — each part and each piece of work by name, quantity and price, with the total below, without the staff attribution the items carry and never the worked-hours registrations. A price of 0 is a price and prints as one: a part fitted under warranty costs the customer nothing, and the third party reading this paper needs to see that it was fitted. Only where the service order carries no items at all do the quoted price and the state it stands at take the block's place, and where there is neither, the block says that no price has been set. The items are the service order's own and never the lines of a linked sales order: that sale is an aggregate which covers only what is billed on it and collapses the work onto the service sale products of each VAT code, while the paper shows every item on the case. It carries no terms, no signature, no estimated price, no max price and no notes.\nWhich file comes back follows the Accept header, the same way every other generated document in the platform is fetched.\nRead at any store of the tenant: the store in the path is where the permission is judged, and nothing more; the service order record carries the whole reach rule.\n\nRequired permissions: SERVICE_ORDER","parameters":[{"$ref":"#/components/parameters/serviceOrderDocumentTypeQuery"},{"$ref":"#/components/parameters/serviceOrderDocumentAssetUidsQuery"}]}}}}
```


---

# 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/get-a-printable-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.
