> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anivahealth.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Orçamentar carrinho

> Calcular o preço de painéis e biomarcadores sem marcação

Devolve a conta dos painéis e biomarcadores segundo o teu preçário. Não precisas de marcação. Nada fica
marcado.

A conta é igual a `pricing` em [Pré-visualizar marcação](https://docs.anivahealth.com/pt/api/appointments/preview-containers.md),
mais o que o modo de colheita da amostra acrescenta. Por predefinição, trata-se de uma colheita de sangue num local, com
as taxas da marcação. Envia `fulfilment: "home_kit"` e um `country_code` para calcular antes o preço de um kit enviado por correio
para esse país: a taxa do kit, os dispositivos de colheita, os portes de envio e de devolução, a bolsa
e um saco extra de lancetas, tal como são cobrados na tua fatura mensal.
[Preços](https://docs.anivahealth.com/pt/concepts/pricing.md) explica como a Aniva define os preços dos testes.

Requer o scope `prices_view`.

## Pedido

### Parâmetros do corpo

Envia pelo menos um id em `panel_ids` ou `biomarker_ids`.

**panel\_ids** `string[]`

Painéis a cotar, no máximo 50. Cada um tem de constar em [Listar painéis](https://docs.anivahealth.com/pt/api/panels/list-panels.md) para a tua chave.

**biomarker\_ids** `number[]`

Biomarcadores a cotar, no máximo 500.

**sex** `integer`

Sexo biológico segundo a norma ISO/IEC 5218: `1` = masculino, `2` = feminino. Alguns painéis adicionam biomarcadores apenas para um
sexo ou idade. Envia `sex` e `date_of_birth` em conjunto para aplicar estas regras. Sem eles, as regras
não se aplicam.

**date\_of\_birth** `string`

Data de nascimento, `YYYY-MM-DD`. Envia-a com `sex`.

**rate\_card** `string`

O preçário a usar no cálculo: `retail`, ou o `id` de [Obter preçário](https://docs.anivahealth.com/pt/api/pricing/get-rate-card.md).
Predefinição: o preçário da tua chave de API; caso contrário, retalho.

**fulfilment** `string`

Como a amostra é colhida. `draw` (predefinição): uma colheita de sangue num local, que acrescenta as taxas da
marcação. `home_kit`: um kit enviado por correio para `country_code`, que acrescenta antes as linhas do kit. Um kit de teste em casa
inclui exatamente um painel, e o painel tem de ser vendido como kit de teste em casa.

**country\_code** `string`

O país de entrega do kit, ISO 3166-1 alfa-2 (`DE`, `SE`). Obrigatório com
`fulfilment: "home_kit"`, e apenas nesse caso. Define as linhas de portes.

## Resposta

**total\_cents** `integer`

O preço dos testes segundo o teu preçário: cada posição, painel e linha de biomarcador com preço. Uma linha
com `price_cents: null` não acrescenta nada.

**retail\_total\_cents** `integer`

O mesmo preço segundo o preçário de retalho recomendado.

**fees** `object`

As taxas de uma marcação, em cêntimos. A Aniva cobra-as na tua fatura mensal. Aplicam-se a um
`draw`; um `home_kit` cobra antes as linhas em `fulfilment`.

**taxas**

**phlebotomy\_fee\_cents** `integer`

Por marcação concluída.

**snack\_fee\_cents** `integer`

Por marcação em que o paciente recebe um snack. Omitido quando os teus pacientes não recebem snack. Para
oferecer snacks, contacta a Aniva.

**logistics\_fee\_cents** `integer`

Por recolha por estafeta. As tuas marcações no mesmo local e no mesmo dia partilham uma recolha.

**material\_fee\_cents** `integer`

Por marcação concluída. Cobre tubos, etiquetas e o saco.

**total\_with\_fees\_cents** `integer`

`total_cents` mais o que o modo de colheita acrescenta. Para um `draw`: todas as taxas em `fees`. Conta a taxa
de logística completa, e uma recolha partilhada torna o montante real mais baixo. Para um `home_kit`:
`fulfilment.total_cents`.

**fulfilment** `object`

Como a amostra é colhida e o que isso acrescenta. `kind` é `draw` ou `home_kit`. Um `draw` não tem nenhum outro
campo.

**home\_kit**

**country\_code** `string`

O país de entrega para o qual os portes foram calculados.

**kit\_ref** `string | null`

O kit em que o painel é enviado. `null` quando a Aniva ainda não definiu um; nesse caso, a cotação não conta
nenhum dispositivo.

**devices** `integer`

Dispositivos de colheita na caixa, cada um cobrado à taxa de dispositivo.

**lines** `object[]`

As linhas de kit que uma encomenda acrescenta à tua fatura mensal, cada uma com `description`, `quantity`,
`unit`, `unit_cents` e `amount_cents`. Os portes são calculados com base nos serviços que o passo de envio reserva
para este país. Uma taxa de 0 no teu preçário não gera nenhuma linha. Um crédito de material pré-pago não é
deduzido aqui.

**total\_cents** `integer`

A soma de `lines`, líquida.

**activation\_fee\_cents** `integer`

Cobrada à parte, líquida, quando não ativas o kit antes de chegar ao laboratório e é o laboratório que o
ativa. Não entra em `lines` nem em `total_cents`. 0 significa que o teu preçário não tem esta taxa.

**unpriced\_postage\_legs** `string[]`

Trajetos (`out`, `back`) que o teu preçário define por país, mas para os quais não tem preço neste país. Recorreram
à taxa fixa de portes, ou a 0 quando o preçário não tem nenhuma. Vazio quando todos os trajetos têm
preço.

**positions** `object[]`

As posições na conta. Uma posição é um conjunto de biomarcadores com um único preço. Tem `id`, `name`,
`price_cents`, `retail_cents` e `tier`. `id` e `name` são `null` numa posição que a Aniva ainda não
publicou.

**panels** `object[]`

Os painéis na conta, com `id`, `name`, `price_cents` e `retail_cents`.

**biomarkers** `object[]`

Uma linha por cada biomarcador que recebes. Inclui os componentes de um rácio e todos os membros de uma
posição.

**linha de biomarcador**

**id** `number`

Id do biomarcador.

**name** `string`

Nome do biomarcador.

**price\_cents** `integer | null`

O preço desta linha, com `retail_cents` ao lado. `0` quando uma posição ou um painel o
cobre.

**required\_by** `number[]`

Os rácios que precisam deste biomarcador. Pagas por ele uma vez.

**requires** `number[]`

Apenas num rácio: os biomarcadores a partir dos quais é calculado.

**via\_position** `string | null`

A posição que cobre esta linha. `null` quando a posição ainda não está publicada.

## Respostas de erro

| Estado | Descrição |
| - | - |
| `400` | O corpo é inválido ou a tua chave não pode usar o `rate_card`. |
| `400` | Uma cotação de `home_kit` precisa de exatamente um painel, de um painel vendido como kit de teste em casa e de um código de país. |
| `400` | `biomarker_not_available`: nenhum laboratório que a tua chave possa usar analisa o biomarcador. |
| `400` | `biomarker_not_priced`: o biomarcador não tem preço. |
| `400` | `biomarker_requires_position`: o biomarcador é vendido apenas numa posição. O corpo lista as posições. |
| `403` | A tua chave de API não tem o scope `prices_view`. |
| `404` | `Panels not found`: o painel não existe ou a tua chave não o pode listar. |
| `404` | `Biomarkers not found`: o biomarcador não existe. |
| `500` | Erro interno do servidor. |

```bash cURL theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/pricing/quote \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "biomarker_ids": [63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 204, 206, 207, 209, 249]
  }'
```

```bash cURL (home kit) theme={null}
curl --request POST \
  --url https://anivahealth.com/api/v1/pricing/quote \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "panel_ids": ["4d0423c5-6538-48f6-ac93-435f61e456e9"],
    "fulfilment": "home_kit",
    "country_code": "DE"
  }'
```

```json 200 theme={null}
{
  "total_cents": 210,
  "retail_total_cents": 451,
  "fees": {
    "phlebotomy_fee_cents": 2500,
    "logistics_fee_cents": 2000,
    "material_fee_cents": 250
  },
  "total_with_fees_cents": 4960,
  "fulfilment": { "kind": "draw" },
  "positions": [
    { "id": null, "name": null, "price_cents": 210, "retail_cents": 451, "tier": "routine" }
  ],
  "panels": [],
  "biomarkers": [
    { "id": 63, "name": "Eosinophils", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 64, "name": "Lymphocytes", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 65, "name": "Neutrophils", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 66, "name": "Monocytes", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 67, "name": "White Blood Cells (WBC)", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 68, "name": "Basophils", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 69, "name": "Hematocrit", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 70, "name": "Red Blood Cells (RBC)", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 71, "name": "Hemoglobin", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 72, "name": "Platelets", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 73, "name": "Mean Corpuscular Hemoglobin Concentration (MCHC)", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 74, "name": "Mean Corpuscular Volume (MCV)", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 75, "name": "Red Cell Distribution Width (RDW)", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 76, "name": "Mean Corpuscular Hemoglobin (MCH)", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 204, "name": "Lymphocytes (%)", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 206, "name": "Eosinophils (%)", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 207, "name": "Basophils (%)", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 209, "name": "Monocytes (%)", "price_cents": 0, "retail_cents": 0, "via_position": null },
    { "id": 249, "name": "Neutrophils (%)", "price_cents": 0, "retail_cents": 0, "via_position": null }
  ]
}
```

```json 200 (home kit) theme={null}
{
  "total_cents": 2081,
  "retail_total_cents": 6702,
  "fees": {
    "phlebotomy_fee_cents": 2000,
    "logistics_fee_cents": 2000,
    "material_fee_cents": 0
  },
  "total_with_fees_cents": 4971,
  "fulfilment": {
    "kind": "home_kit",
    "country_code": "DE",
    "kit_ref": "TAS-1-1S1E",
    "devices": 1,
    "lines": [
      { "description": "Home kit (per order)", "quantity": 1, "unit": "kits", "unit_cents": 720, "amount_cents": 720 },
      { "description": "Collection device (per device)", "quantity": 1, "unit": "devices", "unit_cents": 1250, "amount_cents": 1250 },
      { "description": "Postage to the customer (per kit sent)", "quantity": 1, "unit": "kits sent", "unit_cents": 370, "amount_cents": 370 },
      { "description": "Return postage (per kit sent)", "quantity": 1, "unit": "kits sent", "unit_cents": 400, "amount_cents": 400 },
      { "description": "Spare lancet bag (per kit sent with one)", "quantity": 1, "unit": "bags", "unit_cents": 150, "amount_cents": 150 }
    ],
    "total_cents": 2890,
    "activation_fee_cents": 100,
    "unpriced_postage_legs": []
  },
  "positions": [],
  "panels": [
    { "id": "4d0423c5-6538-48f6-ac93-435f61e456e9", "name": "Doctrinus - Gesundheitsprofil 6 (Männer)", "price_cents": 2081, "retail_cents": 6702 }
  ],
  "biomarkers": []
}
```

```json 404 theme={null}
{
  "error": "Panels not found: f1c2d4a3-7b8e-4f2a-9c1d-2e3f4a5b6c7d"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.