> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update a tax exemption certificate > Corrects the details recorded for a certificate, such as its issuing authority or expiry date. **Required scope:** `write_customers` (for API-key authentication). ## OpenAPI ````yaml /api-reference/admin.yaml patch /api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id} openapi: 3.0.3 info: title: Admin API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: > Spree Admin API v3 - Administrative API for managing products, orders, and store settings. ## Authentication The Admin API requires a secret API key passed in the `x-spree-api-key` header. Secret API keys can be generated in the Spree admin dashboard. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. Single resource endpoints return a flat JSON object. ## Resource IDs Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`, `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths, request bodies, and Ransack filters all accept them directly. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "validation_error", "message": "Validation failed", "details": { "name": ["can't be blank"] } } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Admin user login, logout, token refresh, and current user profile - name: Allowed Origins description: CORS allowlist for storefront and admin client origins - name: API Keys description: Secret and publishable API keys - name: Categories description: >- Hierarchical product categories — tree management, repositioning, and product assignments - name: Channels description: >- Sales channels, product publication across channels, and per-channel order routing rules - name: Custom Fields description: >- Custom field definitions for products, variants, customers, and other resources - name: Customer Groups description: >- Customer groups for segmenting customers (e.g. wholesale, VIP) used by pricing and promotions - name: Customers description: Customer profiles, addresses, credit cards, and store credits - name: Email Templates description: >- Customer email templates, the email layout and shared partials: drafts, previews, publishing and history - name: Exports description: Async CSV exports of admin resources - name: Files description: Uploading the files that product media, imports, logos and documents use - name: Fulfillments description: Order fulfillments — shipments, fulfill, cancel, resume, split - name: Gift Cards description: Gift cards and gift card batches - name: Imports description: >- Async CSV imports of admin resources, with per-row status and failed-row retry - name: Markets description: >- Markets — geographic groupings of countries used for pricing, tax, and fulfillment rules - name: Option Types description: >- Option types and option values used to build product variants (e.g. Size, Color) - name: Orders description: Orders, order items, applied gift cards, and applied store credits - name: Payment Methods description: Configured payment providers and their available types - name: Payments description: Order payments — list, capture, void - name: Pricing description: >- Prices and price lists for currency-, market-, and customer-group-specific pricing - name: Products description: >- Products, taxons/categories, product custom field values, and bulk product operations - name: Policies description: The store's legal documents — terms of service, privacy, returns, shipping - name: Reasons description: >- Merchant-owned vocabularies for why a return, claim, refund, cancellation or tax exemption happened - name: Promotions description: Promotions, promotion rules, promotion actions, and coupon codes - name: Refunds description: Order refunds - name: Settings description: Store-level settings — store profile, tags, and configuration - name: Staff description: Admin users, roles, and invitations to the store - name: Stock Locations description: Warehouses and physical fulfillment locations - name: Store Credits description: Prepaid customer balances across all customers, and each balance's ledger - name: Variants description: >- Product variants — the individual SKUs (size/color combinations) sold under a product - name: Webhooks description: Webhook endpoints and webhook delivery history paths: /api/v3/admin/companies/{company_id}/tax_exemption_certificates/{id}: parameters: - name: x-spree-api-key in: header required: true schema: type: string - name: Authorization in: header required: true schema: type: string - name: company_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string patch: tags: - Companies summary: Update a tax exemption certificate description: >- Corrects the details recorded for a certificate, such as its issuing authority or expiry date. **Required scope:** `write_customers` (for API-key authentication). parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/TaxExemptionCertificateUpdateParams' required: true responses: '200': description: certificate updated content: application/json: example: id: cert_UkLWZg9DAJ certificate_number: DE-RESALE-1 status: pending issuing_authority: Finanzamt Berlin metadata: {} issued_at: null expires_at: '2027-12-31T23:59:59.000Z' verified_at: null created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' company_id: comp_UkLWZg9DAJ tax_exemption_reason_id: txr_UkLWZg9DAJ country_code: null state_code: null active: false lapsed: false can_be_deleted: true document_filename: null document_byte_size: null document_url: null schema: $ref: '#/components/schemas/TaxExemptionCertificate' security: - api_key: [] bearer_auth: [] x-codeSamples: - lang: javascript label: Spree Admin SDK source: >- import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) const certificate = await client.companies.taxExemptionCertificates.update( 'comp_UkLWZg9DAJ', 'cert_k5nR8xLqPz', { issuing_authority: 'Finanzamt Berlin', expires_at: '2027-12-31T23:59:59Z' }, ) - lang: bash label: Spree CLI source: >- spree api patch /companies/{company_id}/tax_exemption_certificates/{id} -d '{"issuing_authority":"Finanzamt Berlin","expires_at":"2027-12-31T23:59:59Z"}' components: schemas: TaxExemptionCertificateUpdateParams: type: object properties: certificate_number: type: string example: DE-RESALE-7 tax_exemption_reason_id: type: string description: >- One of the store's active tax exemption reasons. The tax provider receives its `code`. issuing_authority: type: string example: Finanzamt Berlin nullable: true issued_at: type: string format: date-time nullable: true expires_at: type: string format: date-time nullable: true country_code: allOf: - $ref: '#/components/schemas/CountryCode' description: >- Where the certificate holds. Omit it and `state_code` for one valid everywhere. nullable: true state_code: type: string nullable: true document_signed_id: type: string description: 'A `signed_id` from `files.upload()` with `visibility: ''private''`.' metadata: type: object additionalProperties: true TaxExemptionCertificate: type: object properties: id: type: string certificate_number: type: string status: anyOf: - type: string enum: - pending - verified - expired - revoked - type: string description: The values listed are the built-in ones; extensions may add more. issuing_authority: type: string nullable: true metadata: type: object nullable: true issued_at: type: string nullable: true expires_at: type: string nullable: true verified_at: type: string nullable: true created_at: type: string updated_at: type: string company_id: type: string tax_exemption_reason_id: type: string tax_exemption_reason: $ref: '#/components/schemas/TaxExemptionReason' country_code: type: string nullable: true enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW state_code: type: string nullable: true active: type: boolean lapsed: type: boolean can_be_deleted: type: boolean document_filename: type: string nullable: true document_byte_size: type: number nullable: true document_url: type: string nullable: true required: - id - certificate_number - status - issuing_authority - metadata - issued_at - expires_at - verified_at - created_at - updated_at - company_id - tax_exemption_reason_id - country_code - state_code - active - lapsed - can_be_deleted - document_filename - document_byte_size - document_url x-typelizer: true CountryCode: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW TaxExemptionReason: type: object properties: id: type: string name: type: string code: type: string active: type: boolean metadata: type: object nullable: true created_at: type: string updated_at: type: string can_be_deleted: type: boolean required: - id - name - code - active - metadata - created_at - updated_at - can_be_deleted x-typelizer: true securitySchemes: api_key: type: apiKey name: x-spree-api-key in: header description: Secret API key for admin access bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for admin user authentication ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.