---
title: "Refresh tax-agency status"
method: GET
path: "/retentions/{id}/tax_agency_status/"
tags: ["Procurement"]
---

# Refresh tax-agency status

`GET /retentions/{id}/tax_agency_status/`

## Request

- Base URL: `https://api.piriod.com`
- URL: `https://api.piriod.com/retentions/{id}/tax_agency_status/`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/piriod/apis/piriod-api/docs/retentions/:id/tax_agency_status/get.ts> (a function with typed inputs; its response is checked against the schema)

## Response `200`

Refreshed retention.

- Retention: Withholding-tax document issued against a supplier.
  - `id` integer
  - `supplier` string, required: Supplier ID.
  - `document` integer, required: Retention document type.
  - `number` integer, required
  - `date` string, date, required
  - `amount` number, nullable
  - `exempt` number, nullable
  - `tax` number, nullable
  - `tax_percent` number, nullable
  - `subtotal` number, nullable
  - `total` number, nullable
  - `discount` number, nullable
  - `discount_scheme` '%' | '$', nullable
  - `status` 'draft' | 'finalized' | 'cancelled'
  - `biller_status` string
  - `tax_agency` object
  - `local_file` string, uri, nullable
  - `imported` boolean
  - `test_mode` boolean
  - `lines` RetentionLine[], required
    - `id` integer
    - `name` string, required
    - `description` string, nullable
    - `amount` number, required
    - `quantity` number, required
    - `exempt` boolean
    - `tax` number, nullable
    - `tax_percent` number, nullable
    - `total` number
    - `discount` number, nullable
    - `discount_scheme` '%' | '$', nullable
  - `created` string, date-time
  - `updated` string, date-time

---

[API](https://skmtc.dev/piriod/apis/piriod-api.md) - [All operations](https://skmtc.dev/piriod/apis/piriod-api/llms.txt) - [OpenAPI document](https://skmtc.dev/piriod/apis/piriod-api/revisions/70cbc827dc7b?raw)