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

Requires API key scope: `admin`

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`](https://devportal.demo.winkpg.io/docs/api/models/InvoiceProductCreateDto.md)

Properties:
- `name` (string) required: (nullable, max length 200)
- `description` (string): Conditional: When Description is not empty. Max length: 1000. (nullable)
- `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. (nullable)
- `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. (nullable)
- `defaultPrice` (number(double)): (min 0)
- `taxCategoryId` (string(uuid)): Superseded by `defaultTaxRateId`; retained for compatibility, not read. Accepted  and stored as sent, and never applied to a line item. (nullable)
- `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. (nullable)
- `isActive` (boolean): (nullable)
- `sortOrder` (integer(int32)): (nullable)
- `currency` (string): Conditional: When Currency is not empty. Max length: 3. (nullable)
- `pricingModel` ([PricingModel](https://devportal.demo.winkpg.io/docs/api/models/PricingModel.md)): (nullable)
  Values:
  - `Fixed`: A single fixed price per unit.
  - `Tiered`: Price varies by quantity tier (e.g., 1-10 = $5, 11-50 = $4).
  - `UsageBased`: Price determined by metered usage (e.g., per GB, per API call).
  - `Custom`: Custom pricing negotiated per deal or contract.
- `allowCustomPrice` (boolean): (nullable)
- `productType` ([ProductType](https://devportal.demo.winkpg.io/docs/api/models/ProductType.md)): (nullable)
  Values:
  - `Physical`: Physical goods that are shipped or delivered.
  - `Service`: Professional or managed services billed by time or engagement.
  - `Digital`: Digital goods such as software licenses, downloads, or subscriptions.
  - `Fee`: Flat fees such as setup charges, late fees, or surcharges.
  - `Discount`: Discount line items that reduce the invoice total.
- `isTaxable` (boolean): (nullable)
- `taxCode` (string): Conditional: When TaxCode is not empty. Max length: 50. (nullable)
- `unitOfMeasure` (string): Conditional: When UnitOfMeasure is not empty. Max length: 50. (nullable)
- `commodityCode` (string): Commodity code snapshotted onto an invoice line when this product is applied, and sent as enhanced  (Level 3) card data. At most 25 characters. (nullable, max length 25)
- `allowFractionalQuantity` (boolean): (nullable)
- `minimumQuantity` (number(double)): Conditional: When MinimumQuantity is not null. Must be >= 0. (nullable)
- `maximumQuantity` (number(double)): Conditional: When MaximumQuantity is not null. Must be >= 0. (nullable)
- `requiresShipping` (boolean): (nullable)
- `weight` (number(double)): (nullable, greater than 0, max 999999.9999)
- `weightUnit` ([ShippingWeightUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingWeightUnit.md)): Required: When Weight is not null. (nullable)
  Values:
  - `Gram`: Grams.
  - `Kilogram`: Kilograms.
  - `Ounce`: Ounces (avoirdupois).
  - `Pound`: Pounds (avoirdupois).
- `length` (number(double)): (nullable, greater than 0, max 99999.9999)
- `width` (number(double)): (nullable, greater than 0, max 99999.9999)
- `height` (number(double)): (nullable, greater than 0, max 99999.9999)
- `dimensionUnit` ([ShippingDimensionUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingDimensionUnit.md)): Required: When Length is not null or Width is not null or Height is not null. (nullable)
  Values:
  - `Centimeter`: Centimetres.
  - `Inch`: Inches.
- `revenueAccount` (string): Conditional: When RevenueAccount is not empty. Max length: 100. (nullable)
- `deferredRevenue` (boolean): (nullable)
- `recognitionRuleId` (string(uuid)): (nullable)
- `tags` (array<[EntityTag](https://devportal.demo.winkpg.io/docs/api/models/EntityTag.md)>): (nullable)
  Fields of each item:
  - `name` (string): (nullable, min length 0, max length 50)
  - `value` (string): (nullable, min length 0, max length 150)
- `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: Service billed by the month_

Adds a service to the merchant's catalog at 450.00 a month, marked not taxable. An invoice line built from a product stores its own description and price, so a later change to the product never alters an existing invoice. The product code is optional; when sent it must be unique within the merchant, compared without regard to case. Replace billerId with your merchant's id.

```json
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Website maintenance",
  "description": "Monthly updates, backups and uptime monitoring",
  "productCode": "SVC-MAINT",
  "defaultPrice": 450,
  "isActive": true,
  "currency": "USD",
  "productType": "Service",
  "isTaxable": false,
  "unitOfMeasure": "month"
}
```

_Example: Shipped product with a default tax rate_

Adds a physical product at 24.00 each that ships in a 5 by 4 by 4 inch parcel weighing 0.75 pounds. defaultTaxRateId must name one of the merchant's own active tax rates (a synthetic id here); it is the rate the invoice editor applies when the product is picked. A weight needs its unit, and length, width and height are sent together with their unit or not at all. Replace billerId with your merchant's id.

```json
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Ceramic travel mug",
  "description": "12 oz insulated mug with a sliding lid",
  "productCode": "MUG-12OZ",
  "defaultPrice": 24,
  "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
  "isActive": true,
  "currency": "USD",
  "productType": "Physical",
  "isTaxable": true,
  "unitOfMeasure": "each",
  "requiresShipping": true,
  "weight": 0.75,
  "weightUnit": "Pound",
  "length": 5,
  "width": 4,
  "height": 4,
  "dimensionUnit": "Inch"
}
```

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

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

Properties:
- `name` (string) required: (nullable, max length 200)
- `description` (string): Conditional: When Description is not empty. Max length: 1000. (nullable)
- `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. (nullable)
- `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. (nullable)
- `defaultPrice` (number(double)): (min 0)
- `taxCategoryId` (string(uuid)): Superseded by `defaultTaxRateId`; retained for compatibility, not read. Accepted  and stored as sent, and never applied to a line item. (nullable)
- `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. (nullable)
- `isActive` (boolean): (nullable)
- `sortOrder` (integer(int32)): (nullable)
- `currency` (string): Conditional: When Currency is not empty. Max length: 3. (nullable)
- `pricingModel` ([PricingModel](https://devportal.demo.winkpg.io/docs/api/models/PricingModel.md)): (nullable)
  Values:
  - `Fixed`: A single fixed price per unit.
  - `Tiered`: Price varies by quantity tier (e.g., 1-10 = $5, 11-50 = $4).
  - `UsageBased`: Price determined by metered usage (e.g., per GB, per API call).
  - `Custom`: Custom pricing negotiated per deal or contract.
- `allowCustomPrice` (boolean): (nullable)
- `productType` ([ProductType](https://devportal.demo.winkpg.io/docs/api/models/ProductType.md)): (nullable)
  Values:
  - `Physical`: Physical goods that are shipped or delivered.
  - `Service`: Professional or managed services billed by time or engagement.
  - `Digital`: Digital goods such as software licenses, downloads, or subscriptions.
  - `Fee`: Flat fees such as setup charges, late fees, or surcharges.
  - `Discount`: Discount line items that reduce the invoice total.
- `isTaxable` (boolean): (nullable)
- `taxCode` (string): Conditional: When TaxCode is not empty. Max length: 50. (nullable)
- `unitOfMeasure` (string): Conditional: When UnitOfMeasure is not empty. Max length: 50. (nullable)
- `commodityCode` (string): Commodity code snapshotted onto an invoice line when this product is applied, and sent as enhanced  (Level 3) card data. At most 25 characters. (nullable, max length 25)
- `allowFractionalQuantity` (boolean): (nullable)
- `minimumQuantity` (number(double)): Conditional: When MinimumQuantity is not null. Must be >= 0. (nullable)
- `maximumQuantity` (number(double)): Conditional: When MaximumQuantity is not null. Must be >= 0. (nullable)
- `requiresShipping` (boolean): (nullable)
- `weight` (number(double)): (nullable, greater than 0, max 999999.9999)
- `weightUnit` ([ShippingWeightUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingWeightUnit.md)): Required: When Weight is not null. (nullable)
  Values:
  - `Gram`: Grams.
  - `Kilogram`: Kilograms.
  - `Ounce`: Ounces (avoirdupois).
  - `Pound`: Pounds (avoirdupois).
- `length` (number(double)): (nullable, greater than 0, max 99999.9999)
- `width` (number(double)): (nullable, greater than 0, max 99999.9999)
- `height` (number(double)): (nullable, greater than 0, max 99999.9999)
- `dimensionUnit` ([ShippingDimensionUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingDimensionUnit.md)): Required: When Length is not null or Width is not null or Height is not null. (nullable)
  Values:
  - `Centimeter`: Centimetres.
  - `Inch`: Inches.
- `revenueAccount` (string): Conditional: When RevenueAccount is not empty. Max length: 100. (nullable)
- `deferredRevenue` (boolean): (nullable)
- `recognitionRuleId` (string(uuid)): (nullable)
- `tags` (array<[EntityTag](https://devportal.demo.winkpg.io/docs/api/models/EntityTag.md)>): (nullable)
  Fields of each item:
  - `name` (string): (nullable, min length 0, max length 50)
  - `value` (string): (nullable, min length 0, max length 150)
- `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: Service billed by the month_

Adds a service to the merchant's catalog at 450.00 a month, marked not taxable. An invoice line built from a product stores its own description and price, so a later change to the product never alters an existing invoice. The product code is optional; when sent it must be unique within the merchant, compared without regard to case. Replace billerId with your merchant's id.

```json
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Website maintenance",
  "description": "Monthly updates, backups and uptime monitoring",
  "productCode": "SVC-MAINT",
  "defaultPrice": 450,
  "isActive": true,
  "currency": "USD",
  "productType": "Service",
  "isTaxable": false,
  "unitOfMeasure": "month"
}
```

_Example: Shipped product with a default tax rate_

Adds a physical product at 24.00 each that ships in a 5 by 4 by 4 inch parcel weighing 0.75 pounds. defaultTaxRateId must name one of the merchant's own active tax rates (a synthetic id here); it is the rate the invoice editor applies when the product is picked. A weight needs its unit, and length, width and height are sent together with their unit or not at all. Replace billerId with your merchant's id.

```json
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Ceramic travel mug",
  "description": "12 oz insulated mug with a sliding lid",
  "productCode": "MUG-12OZ",
  "defaultPrice": 24,
  "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
  "isActive": true,
  "currency": "USD",
  "productType": "Physical",
  "isTaxable": true,
  "unitOfMeasure": "each",
  "requiresShipping": true,
  "weight": 0.75,
  "weightUnit": "Pound",
  "length": 5,
  "width": 4,
  "height": 4,
  "dimensionUnit": "Inch"
}
```

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

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

Properties:
- `name` (string) required: (nullable, max length 200)
- `description` (string): Conditional: When Description is not empty. Max length: 1000. (nullable)
- `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. (nullable)
- `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. (nullable)
- `defaultPrice` (number(double)): (min 0)
- `taxCategoryId` (string(uuid)): Superseded by `defaultTaxRateId`; retained for compatibility, not read. Accepted  and stored as sent, and never applied to a line item. (nullable)
- `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. (nullable)
- `isActive` (boolean): (nullable)
- `sortOrder` (integer(int32)): (nullable)
- `currency` (string): Conditional: When Currency is not empty. Max length: 3. (nullable)
- `pricingModel` ([PricingModel](https://devportal.demo.winkpg.io/docs/api/models/PricingModel.md)): (nullable)
  Values:
  - `Fixed`: A single fixed price per unit.
  - `Tiered`: Price varies by quantity tier (e.g., 1-10 = $5, 11-50 = $4).
  - `UsageBased`: Price determined by metered usage (e.g., per GB, per API call).
  - `Custom`: Custom pricing negotiated per deal or contract.
- `allowCustomPrice` (boolean): (nullable)
- `productType` ([ProductType](https://devportal.demo.winkpg.io/docs/api/models/ProductType.md)): (nullable)
  Values:
  - `Physical`: Physical goods that are shipped or delivered.
  - `Service`: Professional or managed services billed by time or engagement.
  - `Digital`: Digital goods such as software licenses, downloads, or subscriptions.
  - `Fee`: Flat fees such as setup charges, late fees, or surcharges.
  - `Discount`: Discount line items that reduce the invoice total.
- `isTaxable` (boolean): (nullable)
- `taxCode` (string): Conditional: When TaxCode is not empty. Max length: 50. (nullable)
- `unitOfMeasure` (string): Conditional: When UnitOfMeasure is not empty. Max length: 50. (nullable)
- `commodityCode` (string): Commodity code snapshotted onto an invoice line when this product is applied, and sent as enhanced  (Level 3) card data. At most 25 characters. (nullable, max length 25)
- `allowFractionalQuantity` (boolean): (nullable)
- `minimumQuantity` (number(double)): Conditional: When MinimumQuantity is not null. Must be >= 0. (nullable)
- `maximumQuantity` (number(double)): Conditional: When MaximumQuantity is not null. Must be >= 0. (nullable)
- `requiresShipping` (boolean): (nullable)
- `weight` (number(double)): (nullable, greater than 0, max 999999.9999)
- `weightUnit` ([ShippingWeightUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingWeightUnit.md)): Required: When Weight is not null. (nullable)
  Values:
  - `Gram`: Grams.
  - `Kilogram`: Kilograms.
  - `Ounce`: Ounces (avoirdupois).
  - `Pound`: Pounds (avoirdupois).
- `length` (number(double)): (nullable, greater than 0, max 99999.9999)
- `width` (number(double)): (nullable, greater than 0, max 99999.9999)
- `height` (number(double)): (nullable, greater than 0, max 99999.9999)
- `dimensionUnit` ([ShippingDimensionUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingDimensionUnit.md)): Required: When Length is not null or Width is not null or Height is not null. (nullable)
  Values:
  - `Centimeter`: Centimetres.
  - `Inch`: Inches.
- `revenueAccount` (string): Conditional: When RevenueAccount is not empty. Max length: 100. (nullable)
- `deferredRevenue` (boolean): (nullable)
- `recognitionRuleId` (string(uuid)): (nullable)
- `tags` (array<[EntityTag](https://devportal.demo.winkpg.io/docs/api/models/EntityTag.md)>): (nullable)
  Fields of each item:
  - `name` (string): (nullable, min length 0, max length 50)
  - `value` (string): (nullable, min length 0, max length 150)
- `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: Service billed by the month_

Adds a service to the merchant's catalog at 450.00 a month, marked not taxable. An invoice line built from a product stores its own description and price, so a later change to the product never alters an existing invoice. The product code is optional; when sent it must be unique within the merchant, compared without regard to case. Replace billerId with your merchant's id.

```json
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Website maintenance",
  "description": "Monthly updates, backups and uptime monitoring",
  "productCode": "SVC-MAINT",
  "defaultPrice": 450,
  "isActive": true,
  "currency": "USD",
  "productType": "Service",
  "isTaxable": false,
  "unitOfMeasure": "month"
}
```

_Example: Shipped product with a default tax rate_

Adds a physical product at 24.00 each that ships in a 5 by 4 by 4 inch parcel weighing 0.75 pounds. defaultTaxRateId must name one of the merchant's own active tax rates (a synthetic id here); it is the rate the invoice editor applies when the product is picked. A weight needs its unit, and length, width and height are sent together with their unit or not at all. Replace billerId with your merchant's id.

```json
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Ceramic travel mug",
  "description": "12 oz insulated mug with a sliding lid",
  "productCode": "MUG-12OZ",
  "defaultPrice": 24,
  "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
  "isActive": true,
  "currency": "USD",
  "productType": "Physical",
  "isTaxable": true,
  "unitOfMeasure": "each",
  "requiresShipping": true,
  "weight": 0.75,
  "weightUnit": "Pound",
  "length": 5,
  "width": 4,
  "height": 4,
  "dimensionUnit": "Inch"
}
```

## Responses

### 200

OK

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

Schema: [`InvoiceProductDto`](https://devportal.demo.winkpg.io/docs/api/models/InvoiceProductDto.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)
- `description` (string): (nullable)
- `productCode` (string): (nullable)
- `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}`. (nullable)
- `defaultPrice` (number(double))
- `taxCategoryId` (string(uuid)): Superseded by `defaultTaxRateId`; retained for compatibility, not read. (nullable)
- `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. (nullable)
- `isActive` (boolean): (nullable)
- `sortOrder` (integer(int32)): (nullable)
- `currency` (string): (nullable)
- `pricingModel` ([PricingModel](https://devportal.demo.winkpg.io/docs/api/models/PricingModel.md)): (nullable)
  Values:
  - `Fixed`: A single fixed price per unit.
  - `Tiered`: Price varies by quantity tier (e.g., 1-10 = $5, 11-50 = $4).
  - `UsageBased`: Price determined by metered usage (e.g., per GB, per API call).
  - `Custom`: Custom pricing negotiated per deal or contract.
- `allowCustomPrice` (boolean): (nullable)
- `productType` ([ProductType](https://devportal.demo.winkpg.io/docs/api/models/ProductType.md)): (nullable)
  Values:
  - `Physical`: Physical goods that are shipped or delivered.
  - `Service`: Professional or managed services billed by time or engagement.
  - `Digital`: Digital goods such as software licenses, downloads, or subscriptions.
  - `Fee`: Flat fees such as setup charges, late fees, or surcharges.
  - `Discount`: Discount line items that reduce the invoice total.
- `isTaxable` (boolean): (nullable)
- `taxCode` (string): (nullable)
- `unitOfMeasure` (string): (nullable)
- `commodityCode` (string): Default commodity code for enhanced (Level 3) card data. (nullable)
- `allowFractionalQuantity` (boolean): (nullable)
- `minimumQuantity` (number(double)): (nullable)
- `maximumQuantity` (number(double)): (nullable)
- `requiresShipping` (boolean): (nullable)
- `weight` (number(double)): (nullable)
- `weightUnit` ([ShippingWeightUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingWeightUnit.md)): (nullable)
  Values:
  - `Gram`: Grams.
  - `Kilogram`: Kilograms.
  - `Ounce`: Ounces (avoirdupois).
  - `Pound`: Pounds (avoirdupois).
- `length` (number(double)): (nullable)
- `width` (number(double)): (nullable)
- `height` (number(double)): (nullable)
- `dimensionUnit` ([ShippingDimensionUnit](https://devportal.demo.winkpg.io/docs/api/models/ShippingDimensionUnit.md)): (nullable)
  Values:
  - `Centimeter`: Centimetres.
  - `Inch`: Inches.
- `revenueAccount` (string): (nullable)
- `deferredRevenue` (boolean): (nullable)
- `recognitionRuleId` (string(uuid)): (nullable)
- `tags` (array<[EntityTag](https://devportal.demo.winkpg.io/docs/api/models/EntityTag.md)>): (nullable)
  Fields of each item:
  - `name` (string): (nullable, min length 0, max length 50)
  - `value` (string): (nullable, min length 0, max length 150)
- `archivedAt` (string(date-time)): (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

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

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

These blocks send the Service billed by the month example. The other examples follow under Other request examples.

Adds a service to the merchant's catalog at 450.00 a month, marked not taxable. An invoice line built from a product stores its own description and price, so a later change to the product never alters an existing invoice. The product code is optional; when sent it must be unique within the merchant, compared without regard to case. Replace billerId with your merchant's id.

### cURL

```bash
curl -X POST "{{BASE_URL}}/api/invoicing/products" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Website maintenance",
  "description": "Monthly updates, backups and uptime monitoring",
  "productCode": "SVC-MAINT",
  "defaultPrice": 450,
  "isActive": true,
  "currency": "USD",
  "productType": "Service",
  "isTaxable": false,
  "unitOfMeasure": "month"
}'
```

### PowerShell

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

$body = @'
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Website maintenance",
  "description": "Monthly updates, backups and uptime monitoring",
  "productCode": "SVC-MAINT",
  "defaultPrice": 450,
  "isActive": true,
  "currency": "USD",
  "productType": "Service",
  "isTaxable": false,
  "unitOfMeasure": "month"
}
'@

$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({
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Website maintenance",
  "description": "Monthly updates, backups and uptime monitoring",
  "productCode": "SVC-MAINT",
  "defaultPrice": 450,
  "isActive": true,
  "currency": "USD",
  "productType": "Service",
  "isTaxable": false,
  "unitOfMeasure": "month"
});
```

### 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({
    "billerId": "00000000-0000-0000-0000-000000000001",
    "billerType": "Merchant",
    "name": "Website maintenance",
    "description": "Monthly updates, backups and uptime monitoring",
    "productCode": "SVC-MAINT",
    "defaultPrice": 450,
    "isActive": true,
    "currency": "USD",
    "productType": "Service",
    "isTaxable": false,
    "unitOfMeasure": "month"
  }),
});

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>("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Website maintenance",
      "description": "Monthly updates, backups and uptime monitoring",
      "productCode": "SVC-MAINT",
      "defaultPrice": 450,
      "isActive": true,
      "currency": "USD",
      "productType": "Service",
      "isTaxable": false,
      "unitOfMeasure": "month"
    }
    """);

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("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Website maintenance",
      "description": "Monthly updates, backups and uptime monitoring",
      "productCode": "SVC-MAINT",
      "defaultPrice": 450,
      "isActive": true,
      "currency": "USD",
      "productType": "Service",
      "isTaxable": false,
      "unitOfMeasure": "month"
    }
    """, 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({
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Website maintenance",
      "description": "Monthly updates, backups and uptime monitoring",
      "productCode": "SVC-MAINT",
      "defaultPrice": 450,
      "isActive": True,
      "currency": "USD",
      "productType": "Service",
      "isTaxable": False,
      "unitOfMeasure": "month"
    })
    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 = {
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Website maintenance",
  "description": "Monthly updates, backups and uptime monitoring",
  "productCode": "SVC-MAINT",
  "defaultPrice": 450,
  "isActive": True,
  "currency": "USD",
  "productType": "Service",
  "isTaxable": False,
  "unitOfMeasure": "month"
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/invoicing/products",
    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.

### Shipped product with a default tax rate

Adds a physical product at 24.00 each that ships in a 5 by 4 by 4 inch parcel weighing 0.75 pounds. defaultTaxRateId must name one of the merchant's own active tax rates (a synthetic id here); it is the rate the invoice editor applies when the product is picked. A weight needs its unit, and length, width and height are sent together with their unit or not at all. Replace billerId with your merchant's id.

#### cURL

```bash
curl -X POST "{{BASE_URL}}/api/invoicing/products" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Ceramic travel mug",
  "description": "12 oz insulated mug with a sliding lid",
  "productCode": "MUG-12OZ",
  "defaultPrice": 24,
  "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
  "isActive": true,
  "currency": "USD",
  "productType": "Physical",
  "isTaxable": true,
  "unitOfMeasure": "each",
  "requiresShipping": true,
  "weight": 0.75,
  "weightUnit": "Pound",
  "length": 5,
  "width": 4,
  "height": 4,
  "dimensionUnit": "Inch"
}'
```

#### PowerShell

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

$body = @'
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Ceramic travel mug",
  "description": "12 oz insulated mug with a sliding lid",
  "productCode": "MUG-12OZ",
  "defaultPrice": 24,
  "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
  "isActive": true,
  "currency": "USD",
  "productType": "Physical",
  "isTaxable": true,
  "unitOfMeasure": "each",
  "requiresShipping": true,
  "weight": 0.75,
  "weightUnit": "Pound",
  "length": 5,
  "width": 4,
  "height": 4,
  "dimensionUnit": "Inch"
}
'@

$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({
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Ceramic travel mug",
  "description": "12 oz insulated mug with a sliding lid",
  "productCode": "MUG-12OZ",
  "defaultPrice": 24,
  "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
  "isActive": true,
  "currency": "USD",
  "productType": "Physical",
  "isTaxable": true,
  "unitOfMeasure": "each",
  "requiresShipping": true,
  "weight": 0.75,
  "weightUnit": "Pound",
  "length": 5,
  "width": 4,
  "height": 4,
  "dimensionUnit": "Inch"
});
```

#### 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({
    "billerId": "00000000-0000-0000-0000-000000000001",
    "billerType": "Merchant",
    "name": "Ceramic travel mug",
    "description": "12 oz insulated mug with a sliding lid",
    "productCode": "MUG-12OZ",
    "defaultPrice": 24,
    "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
    "isActive": true,
    "currency": "USD",
    "productType": "Physical",
    "isTaxable": true,
    "unitOfMeasure": "each",
    "requiresShipping": true,
    "weight": 0.75,
    "weightUnit": "Pound",
    "length": 5,
    "width": 4,
    "height": 4,
    "dimensionUnit": "Inch"
  }),
});

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>("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Ceramic travel mug",
      "description": "12 oz insulated mug with a sliding lid",
      "productCode": "MUG-12OZ",
      "defaultPrice": 24,
      "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
      "isActive": true,
      "currency": "USD",
      "productType": "Physical",
      "isTaxable": true,
      "unitOfMeasure": "each",
      "requiresShipping": true,
      "weight": 0.75,
      "weightUnit": "Pound",
      "length": 5,
      "width": 4,
      "height": 4,
      "dimensionUnit": "Inch"
    }
    """);

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("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Ceramic travel mug",
      "description": "12 oz insulated mug with a sliding lid",
      "productCode": "MUG-12OZ",
      "defaultPrice": 24,
      "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
      "isActive": true,
      "currency": "USD",
      "productType": "Physical",
      "isTaxable": true,
      "unitOfMeasure": "each",
      "requiresShipping": true,
      "weight": 0.75,
      "weightUnit": "Pound",
      "length": 5,
      "width": 4,
      "height": 4,
      "dimensionUnit": "Inch"
    }
    """, 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({
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Ceramic travel mug",
      "description": "12 oz insulated mug with a sliding lid",
      "productCode": "MUG-12OZ",
      "defaultPrice": 24,
      "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
      "isActive": True,
      "currency": "USD",
      "productType": "Physical",
      "isTaxable": True,
      "unitOfMeasure": "each",
      "requiresShipping": True,
      "weight": 0.75,
      "weightUnit": "Pound",
      "length": 5,
      "width": 4,
      "height": 4,
      "dimensionUnit": "Inch"
    })
    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 = {
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Ceramic travel mug",
  "description": "12 oz insulated mug with a sliding lid",
  "productCode": "MUG-12OZ",
  "defaultPrice": 24,
  "defaultTaxRateId": "00000000-0000-0000-0000-000000000401",
  "isActive": True,
  "currency": "USD",
  "productType": "Physical",
  "isTaxable": True,
  "unitOfMeasure": "each",
  "requiresShipping": True,
  "weight": 0.75,
  "weightUnit": "Pound",
  "length": 5,
  "width": 4,
  "height": 4,
  "dimensionUnit": "Inch"
}

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.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.