# POST /api/invoicing/products

Products: Creates a new invoice product.

A `productCode` another of the biller's products already holds (compared
case-insensitively) is refused as a validation error on that field, so no two products of one
biller share a SKU.

**Operation ID:** `invoiceProductCreate`

## Authorization

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

Required permissions:
- `Invoicing.Products`
- `Invoicing.Products.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: `InvoiceProductCreateDto`

Properties:
- `name` (string) required
- `description` (string): Conditional: When Description is not empty. Max length: 1000.
- `productCode` (string): Optional SKU or product code. Stored trimmed, with its letter case kept. Unique within the  biller, compared case-insensitively: a code another of the biller's products already holds is  rejected with a validation error naming this field. Leave it empty (or send whitespace, which  is stored as no code) for a product without a code; any number of those may exist. Conditional: When ProductCode is not empty. Max length: 50.
- `imageBlobName` (string): Bare blob filename of the product image, as returned by the hosted-page image upload endpoint  (`POST /api/hostedpaymentpages/images/upload`). Omit or send null to leave the product  without an image; an empty string also clears it. Never a URL, a path, or inline image data.
- `defaultPrice` (number(double))
- `taxCategoryId` (string(uuid)): Superseded by `defaultTaxRateId`; retained for compatibility, not read. Accepted  and stored as sent, and never applied to a line item.
- `defaultTaxRateId` (string(uuid)): Optional. The id of one of the biller's active tax rates, applied to an invoice line when this  product is picked. Must belong to the same biller as the product; a rate that does not exist,  belongs to another biller, or has been deactivated is rejected with a validation error naming  this field. Omit or send null for no default.
- `isActive` (boolean)
- `sortOrder` (integer(int32))
- `currency` (string): Conditional: When Currency is not empty. Max length: 3.
- `pricingModel` (object)
- `allowCustomPrice` (boolean)
- `productType` (object)
- `isTaxable` (boolean)
- `taxCode` (string): Conditional: When TaxCode is not empty. Max length: 50.
- `unitOfMeasure` (string): Conditional: When UnitOfMeasure is not empty. Max length: 50.
- `allowFractionalQuantity` (boolean)
- `minimumQuantity` (number(double)): Conditional: When MinimumQuantity is not null. Must be >= 0.
- `maximumQuantity` (number(double)): Conditional: When MaximumQuantity is not null. Must be >= 0.
- `requiresShipping` (boolean)
- `weight` (number(double))
- `weightUnit` (object): Required: When Weight is not null.
- `length` (number(double))
- `width` (number(double))
- `height` (number(double))
- `dimensionUnit` (object): Required: When Length is not null or Width is not null or Height is not null.
- `revenueAccount` (string): Conditional: When RevenueAccount is not empty. Max length: 100.
- `deferredRevenue` (boolean)
- `recognitionRuleId` (string(uuid))
- `tags` (array<EntityTag>)
- `billerId` (string(uuid)) required
- `billerType` (InvoicePartyType): Identifies the type of entity acting as the biller or recipient on an invoice.

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

Schema: `InvoiceProductCreateDto`

Properties:
- `name` (string) required
- `description` (string): Conditional: When Description is not empty. Max length: 1000.
- `productCode` (string): Optional SKU or product code. Stored trimmed, with its letter case kept. Unique within the  biller, compared case-insensitively: a code another of the biller's products already holds is  rejected with a validation error naming this field. Leave it empty (or send whitespace, which  is stored as no code) for a product without a code; any number of those may exist. Conditional: When ProductCode is not empty. Max length: 50.
- `imageBlobName` (string): Bare blob filename of the product image, as returned by the hosted-page image upload endpoint  (`POST /api/hostedpaymentpages/images/upload`). Omit or send null to leave the product  without an image; an empty string also clears it. Never a URL, a path, or inline image data.
- `defaultPrice` (number(double))
- `taxCategoryId` (string(uuid)): Superseded by `defaultTaxRateId`; retained for compatibility, not read. Accepted  and stored as sent, and never applied to a line item.
- `defaultTaxRateId` (string(uuid)): Optional. The id of one of the biller's active tax rates, applied to an invoice line when this  product is picked. Must belong to the same biller as the product; a rate that does not exist,  belongs to another biller, or has been deactivated is rejected with a validation error naming  this field. Omit or send null for no default.
- `isActive` (boolean)
- `sortOrder` (integer(int32))
- `currency` (string): Conditional: When Currency is not empty. Max length: 3.
- `pricingModel` (object)
- `allowCustomPrice` (boolean)
- `productType` (object)
- `isTaxable` (boolean)
- `taxCode` (string): Conditional: When TaxCode is not empty. Max length: 50.
- `unitOfMeasure` (string): Conditional: When UnitOfMeasure is not empty. Max length: 50.
- `allowFractionalQuantity` (boolean)
- `minimumQuantity` (number(double)): Conditional: When MinimumQuantity is not null. Must be >= 0.
- `maximumQuantity` (number(double)): Conditional: When MaximumQuantity is not null. Must be >= 0.
- `requiresShipping` (boolean)
- `weight` (number(double))
- `weightUnit` (object): Required: When Weight is not null.
- `length` (number(double))
- `width` (number(double))
- `height` (number(double))
- `dimensionUnit` (object): Required: When Length is not null or Width is not null or Height is not null.
- `revenueAccount` (string): Conditional: When RevenueAccount is not empty. Max length: 100.
- `deferredRevenue` (boolean)
- `recognitionRuleId` (string(uuid))
- `tags` (array<EntityTag>)
- `billerId` (string(uuid)) required
- `billerType` (InvoicePartyType): Identifies the type of entity acting as the biller or recipient on an invoice.

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

Schema: `InvoiceProductCreateDto`

Properties:
- `name` (string) required
- `description` (string): Conditional: When Description is not empty. Max length: 1000.
- `productCode` (string): Optional SKU or product code. Stored trimmed, with its letter case kept. Unique within the  biller, compared case-insensitively: a code another of the biller's products already holds is  rejected with a validation error naming this field. Leave it empty (or send whitespace, which  is stored as no code) for a product without a code; any number of those may exist. Conditional: When ProductCode is not empty. Max length: 50.
- `imageBlobName` (string): Bare blob filename of the product image, as returned by the hosted-page image upload endpoint  (`POST /api/hostedpaymentpages/images/upload`). Omit or send null to leave the product  without an image; an empty string also clears it. Never a URL, a path, or inline image data.
- `defaultPrice` (number(double))
- `taxCategoryId` (string(uuid)): Superseded by `defaultTaxRateId`; retained for compatibility, not read. Accepted  and stored as sent, and never applied to a line item.
- `defaultTaxRateId` (string(uuid)): Optional. The id of one of the biller's active tax rates, applied to an invoice line when this  product is picked. Must belong to the same biller as the product; a rate that does not exist,  belongs to another biller, or has been deactivated is rejected with a validation error naming  this field. Omit or send null for no default.
- `isActive` (boolean)
- `sortOrder` (integer(int32))
- `currency` (string): Conditional: When Currency is not empty. Max length: 3.
- `pricingModel` (object)
- `allowCustomPrice` (boolean)
- `productType` (object)
- `isTaxable` (boolean)
- `taxCode` (string): Conditional: When TaxCode is not empty. Max length: 50.
- `unitOfMeasure` (string): Conditional: When UnitOfMeasure is not empty. Max length: 50.
- `allowFractionalQuantity` (boolean)
- `minimumQuantity` (number(double)): Conditional: When MinimumQuantity is not null. Must be >= 0.
- `maximumQuantity` (number(double)): Conditional: When MaximumQuantity is not null. Must be >= 0.
- `requiresShipping` (boolean)
- `weight` (number(double))
- `weightUnit` (object): Required: When Weight is not null.
- `length` (number(double))
- `width` (number(double))
- `height` (number(double))
- `dimensionUnit` (object): Required: When Length is not null or Width is not null or Height is not null.
- `revenueAccount` (string): Conditional: When RevenueAccount is not empty. Max length: 100.
- `deferredRevenue` (boolean)
- `recognitionRuleId` (string(uuid))
- `tags` (array<EntityTag>)
- `billerId` (string(uuid)) required
- `billerType` (InvoicePartyType): Identifies the type of entity acting as the biller or recipient on an invoice.

## Responses

### 200

OK

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

Schema: `InvoiceProductDto`

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.
- `lastModificationTime` (string(date-time)): The date and time when this entity was last modified.
- `lastModifierId` (string(uuid)): The ID of the user who last modified this entity.
- `billerId` (string(uuid))
- `billerType` (InvoicePartyType): Identifies the type of entity acting as the biller or recipient on an invoice.
- `name` (string)
- `description` (string)
- `productCode` (string)
- `imageBlobName` (string): Bare blob filename of the product image in the hosted-page image container, or null when the  product has no image. Rendered at `{cdn}/hosted-page-imgs/host/{name}`.
- `defaultPrice` (number(double))
- `taxCategoryId` (string(uuid)): Superseded by `defaultTaxRateId`; retained for compatibility, not read.
- `defaultTaxRateId` (string(uuid)): The biller's tax rate applied to an invoice line when this product is picked, or null when the  product carries no default.
- `isActive` (boolean)
- `sortOrder` (integer(int32))
- `currency` (string)
- `pricingModel` (object)
- `allowCustomPrice` (boolean)
- `productType` (object)
- `isTaxable` (boolean)
- `taxCode` (string)
- `unitOfMeasure` (string)
- `allowFractionalQuantity` (boolean)
- `minimumQuantity` (number(double))
- `maximumQuantity` (number(double))
- `requiresShipping` (boolean)
- `weight` (number(double))
- `weightUnit` (object)
- `length` (number(double))
- `width` (number(double))
- `height` (number(double))
- `dimensionUnit` (object)
- `revenueAccount` (string)
- `deferredRevenue` (boolean)
- `recognitionRuleId` (string(uuid))
- `tags` (array<EntityTag>)
- `archivedAt` (string(date-time))
- `concurrencyStamp` (string)

### 403

Forbidden

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

The request is invalid, including a `productCode` already held by another product of the
same biller.

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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. See the error-code reference in this document's description for the values `error.code` can take.

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

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 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`

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.
- `title` (string) required: A short, human-readable summary of the problem type.
- `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.
- `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`

Properties:
- `error` (RemoteServiceErrorInfo)

## 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 InvoiceProductCreateDto. See the Request body section below for its fields.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/invoicing/products" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "",
  "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
```

### PowerShell

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

$body = @'
{
  "name": "",
  "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/invoicing/products' `
    -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.invoiceProductCreate({
  "name": "",
  "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/invoicing/products', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "",
    "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }),
});

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<InvoiceProductCreateDto>("""
    {
      "name": "",
      "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """);

var result = await api.InvoiceProductCreateAsync(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/products");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "name": "",
      "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """, 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.InvoiceProductCreateDto.from_dict({
      "name": "",
      "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    })
    result = api.invoice_product_create(body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "name": "",
  "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

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

## See also

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