# POST /api/invoicing/tax-rates

Tax Rates: Creates a new invoice tax rate.

**Required permissions**: `Invoicing.TaxRates`, `Invoicing.TaxRates.Create`  
**Scope**: merchant

**Operation ID:** `invoiceTaxRateCreate`

## Authorization

Requires: Invoicing.TaxRates, Invoicing.TaxRates.Create, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Invoicing.TaxRates`
- `Invoicing.TaxRates.Create`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

**Content type:** `application/json`

Schema: [`InvoiceTaxRateCreateDto`](https://devportal.demo.winkpg.io/docs/api/models/InvoiceTaxRateCreateDto.md)

Properties:
- `name` (string) required: (nullable, max length 100)
- `rate` (number(double)): (min 0)
- `isDefault` (boolean): (nullable)
- `isActive` (boolean): (nullable)
- `billerId` (string(uuid)) required
- `billerType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Identifies the type of entity acting as the biller or recipient on an invoice.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.

_Example: State sales tax rate_

Adds a named 6.25 percent rate to the merchant's catalog. rate is a percentage, so 6.25 means 6.25 percent. An invoice line taxed at the rate stores the percentage itself, so a later change to the rate never alters an existing invoice. Replace billerId with your merchant's id.

```json
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Texas state sales tax",
  "rate": 6.25,
  "isActive": true
}
```

_Example: Combined local rate as the default_

Adds an 8.25 percent rate and makes it the merchant's default. A merchant holds one default rate, so any rate that was the default before is no longer one after this request. Replace billerId with your merchant's id.

```json
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Austin combined sales tax",
  "rate": 8.25,
  "isDefault": true,
  "isActive": true
}
```

**Content type:** `text/json`

Schema: [`InvoiceTaxRateCreateDto`](https://devportal.demo.winkpg.io/docs/api/models/InvoiceTaxRateCreateDto.md)

Properties:
- `name` (string) required: (nullable, max length 100)
- `rate` (number(double)): (min 0)
- `isDefault` (boolean): (nullable)
- `isActive` (boolean): (nullable)
- `billerId` (string(uuid)) required
- `billerType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Identifies the type of entity acting as the biller or recipient on an invoice.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.

_Example: State sales tax rate_

Adds a named 6.25 percent rate to the merchant's catalog. rate is a percentage, so 6.25 means 6.25 percent. An invoice line taxed at the rate stores the percentage itself, so a later change to the rate never alters an existing invoice. Replace billerId with your merchant's id.

```json
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Texas state sales tax",
  "rate": 6.25,
  "isActive": true
}
```

_Example: Combined local rate as the default_

Adds an 8.25 percent rate and makes it the merchant's default. A merchant holds one default rate, so any rate that was the default before is no longer one after this request. Replace billerId with your merchant's id.

```json
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Austin combined sales tax",
  "rate": 8.25,
  "isDefault": true,
  "isActive": true
}
```

**Content type:** `application/*+json`

Schema: [`InvoiceTaxRateCreateDto`](https://devportal.demo.winkpg.io/docs/api/models/InvoiceTaxRateCreateDto.md)

Properties:
- `name` (string) required: (nullable, max length 100)
- `rate` (number(double)): (min 0)
- `isDefault` (boolean): (nullable)
- `isActive` (boolean): (nullable)
- `billerId` (string(uuid)) required
- `billerType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Identifies the type of entity acting as the biller or recipient on an invoice.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.

_Example: State sales tax rate_

Adds a named 6.25 percent rate to the merchant's catalog. rate is a percentage, so 6.25 means 6.25 percent. An invoice line taxed at the rate stores the percentage itself, so a later change to the rate never alters an existing invoice. Replace billerId with your merchant's id.

```json
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Texas state sales tax",
  "rate": 6.25,
  "isActive": true
}
```

_Example: Combined local rate as the default_

Adds an 8.25 percent rate and makes it the merchant's default. A merchant holds one default rate, so any rate that was the default before is no longer one after this request. Replace billerId with your merchant's id.

```json
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Austin combined sales tax",
  "rate": 8.25,
  "isDefault": true,
  "isActive": true
}
```

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`InvoiceTaxRateDto`](https://devportal.demo.winkpg.io/docs/api/models/InvoiceTaxRateDto.md)

Properties:
- `id` (string(uuid))
- `creationTime` (string(date-time)): The date and time when this entity was created.
- `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
- `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
- `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
- `billerId` (string(uuid))
- `billerType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Identifies the type of entity acting as the biller or recipient on an invoice.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.
- `name` (string): (nullable)
- `rate` (number(double))
- `isDefault` (boolean): (nullable)
- `isActive` (boolean): (nullable)
- `concurrencyStamp` (string): (nullable)

### 403

Forbidden

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 401

Unauthorized

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad Request

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": "null",
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 404

Not Found

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": "null",
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 501

Not Implemented

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 500

Internal Server Error

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on. (nullable)
- `title` (string) required: A short, human-readable summary of the problem type. (nullable)
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable)
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

## Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a InvoiceTaxRateCreateDto. See the Request body section below for its fields.

These blocks send the State sales tax rate example. The other examples follow under Other request examples.

Adds a named 6.25 percent rate to the merchant's catalog. rate is a percentage, so 6.25 means 6.25 percent. An invoice line taxed at the rate stores the percentage itself, so a later change to the rate never alters an existing invoice. Replace billerId with your merchant's id.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/invoicing/tax-rates" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Texas state sales tax",
  "rate": 6.25,
  "isActive": true
}'
```

### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Texas state sales tax",
  "rate": 6.25,
  "isActive": true
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/invoicing/tax-rates' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, InvoicingApi } from '@winkpg/winkpg-api';

const api = new InvoicingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.invoiceTaxRateCreate({
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Texas state sales tax",
  "rate": 6.25,
  "isActive": true
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/invoicing/tax-rates', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "billerId": "00000000-0000-0000-0000-000000000001",
    "billerType": "Merchant",
    "name": "Texas state sales tax",
    "rate": 6.25,
    "isActive": true
  }),
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new InvoicingApi(config);
var body = JsonSerializer.Deserialize<InvoiceTaxRateCreateDto>("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Texas state sales tax",
      "rate": 6.25,
      "isActive": true
    }
    """);

var result = await api.InvoiceTaxRateCreateAsync(body);
```

### C# (raw HTTP)

```csharp
using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/invoicing/tax-rates");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Texas state sales tax",
      "rate": 6.25,
      "isActive": true
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.InvoicingApi(client)
    body = winkpg_api.InvoiceTaxRateCreateDto.from_dict({
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Texas state sales tax",
      "rate": 6.25,
      "isActive": True
    })
    result = api.invoice_tax_rate_create(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Texas state sales tax",
  "rate": 6.25,
  "isActive": True
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/invoicing/tax-rates",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## Other request examples

Each example below is one request, shown in every language with the same placeholders.

### Combined local rate as the default

Adds an 8.25 percent rate and makes it the merchant's default. A merchant holds one default rate, so any rate that was the default before is no longer one after this request. Replace billerId with your merchant's id.

#### cURL

```bash
curl -X POST "{{BASE_URL}}/api/invoicing/tax-rates" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Austin combined sales tax",
  "rate": 8.25,
  "isDefault": true,
  "isActive": true
}'
```

#### PowerShell

```powershell
$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Austin combined sales tax",
  "rate": 8.25,
  "isDefault": true,
  "isActive": true
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/invoicing/tax-rates' `
    -Headers $headers -ContentType 'application/json' -Body $body
```

#### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, InvoicingApi } from '@winkpg/winkpg-api';

const api = new InvoicingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.invoiceTaxRateCreate({
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Austin combined sales tax",
  "rate": 8.25,
  "isDefault": true,
  "isActive": true
});
```

#### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/invoicing/tax-rates', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "billerId": "00000000-0000-0000-0000-000000000001",
    "billerType": "Merchant",
    "name": "Austin combined sales tax",
    "rate": 8.25,
    "isDefault": true,
    "isActive": true
  }),
});

const data = await response.json();
```

#### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new InvoicingApi(config);
var body = JsonSerializer.Deserialize<InvoiceTaxRateCreateDto>("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Austin combined sales tax",
      "rate": 8.25,
      "isDefault": true,
      "isActive": true
    }
    """);

var result = await api.InvoiceTaxRateCreateAsync(body);
```

#### C# (raw HTTP)

```csharp
using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/invoicing/tax-rates");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Austin combined sales tax",
      "rate": 8.25,
      "isDefault": true,
      "isActive": true
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

#### Python (SDK)

```bash
pip install winkpg-api
```

```python
import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.InvoicingApi(client)
    body = winkpg_api.InvoiceTaxRateCreateDto.from_dict({
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Austin combined sales tax",
      "rate": 8.25,
      "isDefault": True,
      "isActive": True
    })
    result = api.invoice_tax_rate_create(body)
```

#### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Austin combined sales tax",
  "rate": 8.25,
  "isDefault": True,
  "isActive": True
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/invoicing/tax-rates",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()
```

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.