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

# Update Invoice PDF

## Endpoint Overview

**POST** `https://api.unibee.dev/merchant/invoice/pdf_update`

Update Invoice PDF

***

## Authorization

All UniBee Merchant API requests require authentication via API key.

| Header | Required | Description |
| - | - | - |
| `Authorization` | Yes | Bearer `<your_api_key>` |
| `Content-Type` | Yes | `application/json` (for request body) |

***

## Parameters

Parameters for this endpoint are listed below. The schema is also shown in the Try it panel.

### Request body

| Name | Type | Required | Description |
| - | - | - | - |
| `invoiceId` | string | Yes | The unique id of invoice |
| `issueAddress` | string | No | IssueAddress |
| `issueCompanyName` | string | No | IssueCompanyName |
| `issueRegNumber` | string | No | IssueRegNumber |
| `issueVatNumber` | string | No | IssueVatNumber |
| `localizedCurrency` | string | No | LocalizedCurrency, To display localized currency amount |
| `localizedExchangeRate` | number | No | LocalizedExchangeRate, exchange rate must set while LocalizedCurrency enabled |
| `localizedExchangeRateDescription` | number | No | LocalizedExchangeRateDescription |
| `metadata` | object | No | Metadata，Map |
| `sendUserEmail` | boolean | No | Whether sen invoice email to user or not，default false |
| `showDetailItem` | boolean | No | ShowDetailItem, whether to display detail item information in pdf generate, unitAmount, quantity, etc. |
| `template` | string | No | Template |

***

## Request examples

### cURL

```bash theme={null}
curl -X POST "https://api.unibee.dev/merchant/invoice/pdf_update" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "invoiceId": "id_example",
  "issueAddress": "",
  "issueCompanyName": "",
  "issueRegNumber": "",
  "issueVatNumber": "",
  "localizedCurrency": "",
  "localizedExchangeRate": "",
  "localizedExchangeRateDescription": "",
  "metadata": {},
  "sendUserEmail": "user@example.com",
  "showDetailItem": false,
  "template": ""
}'
```

### Sandbox

```bash theme={null}
curl -X POST "https://api-sandbox.unibee.top/merchant/invoice/pdf_update" \
  -H "Authorization: Bearer YOUR_SANDBOX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "invoiceId": "id_example",
  "issueAddress": "",
  "issueCompanyName": "",
  "issueRegNumber": "",
  "issueVatNumber": "",
  "localizedCurrency": "",
  "localizedExchangeRate": "",
  "localizedExchangeRateDescription": "",
  "metadata": {},
  "sendUserEmail": "user@example.com",
  "showDetailItem": false,
  "template": ""
}'
```

***

## Response

Success responses return a JSON envelope with `code`, `data`, `message`, `redirect`, and `requestId`. `code` `0` indicates success. The response schema for this endpoint is shown below.

***

## Error handling

| HTTP status | Meaning |
| - | - |
| 400 | Bad request — invalid or missing parameters. Check `message` in the body. |
| 401 | Unauthorized — missing or invalid API key. |
| 404 | Not found — invalid path or resource. |
| 500 | Server error — retry with backoff. |

When `code` in the response body is non-zero, check `message` for details. Use `requestId` when contacting support.


## OpenAPI

````yaml post /merchant/invoice/pdf_update
openapi: 3.0.0
info:
  description: UniBee Api Server
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  title: OpenAPI UniBee
  version: daily,buildtime:202607240926
servers:
  - url: https://api.unibee.dev
  - url: https://api-sandbox.unibee.top
security:
  - Authorization: []
paths:
  /merchant/invoice/pdf_update:
    post:
      tags:
        - Invoice
      summary: Update Invoice PDF
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/unibee.api.merchant.invoice.PdfUpdateReq'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  code:
                    format: int
                    properties: {}
                    type: integer
                  data:
                    properties: {}
                    type: object
                  merchantId:
                    format: int64
                    properties: {}
                    type: integer
                  message:
                    format: string
                    properties: {}
                    type: string
                  redirect:
                    format: string
                    properties: {}
                    type: string
                  requestId:
                    format: string
                    properties: {}
                    type: string
                type: object
          description: ''
components:
  schemas:
    unibee.api.merchant.invoice.PdfUpdateReq:
      properties:
        invoiceId:
          description: The unique id of invoice
          format: string
          properties: {}
          type: string
        issueAddress:
          description: IssueAddress
          format: '*string'
          properties: {}
          type: string
        issueCompanyName:
          description: IssueCompanyName
          format: '*string'
          properties: {}
          type: string
        issueRegNumber:
          description: IssueRegNumber
          format: '*string'
          properties: {}
          type: string
        issueVatNumber:
          description: IssueVatNumber
          format: '*string'
          properties: {}
          type: string
        localizedCurrency:
          description: LocalizedCurrency, To display localized currency amount
          format: '*string'
          properties: {}
          type: string
        localizedExchangeRate:
          description: >-
            LocalizedExchangeRate, exchange rate must set while
            LocalizedCurrency enabled
          format: '*float64'
          properties: {}
          type: number
        localizedExchangeRateDescription:
          description: LocalizedExchangeRateDescription
          format: '*float64'
          properties: {}
          type: number
        metadata:
          additionalProperties:
            $ref: '#/components/schemas/interface'
          description: Metadata，Map
          format: map[string]interface {}
          properties: {}
          type: object
        sendUserEmail:
          default: false
          description: Whether sen invoice email to user or not，default false
          format: bool
          properties: {}
          type: boolean
        showDetailItem:
          default: false
          description: >-
            ShowDetailItem, whether to display detail item information in pdf
            generate, unitAmount, quantity, etc.
          format: '*bool'
          properties: {}
          type: boolean
        template:
          description: Template
          format: string
          properties: {}
          type: string
      required:
        - invoiceId
      type: object
    interface:
      properties: {}
      type: object
  securitySchemes:
    Authorization:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

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