# PUT /api/invoicing/custom-field-definitions/{id}

Custom Field Definitions: Updates an existing invoice custom field definition by id.

**Required permissions**: `Invoicing.CustomFieldDefinitions`, `Invoicing.CustomFieldDefinitions.Update`  
**Scope**: merchant

**Operation ID:** `invoiceCustomFieldDefinitionUpdate`

## Authorization

Requires: Invoicing.CustomFieldDefinitions, Invoicing.CustomFieldDefinitions.Update, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Invoicing.CustomFieldDefinitions`
- `Invoicing.CustomFieldDefinitions.Update`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) |  |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

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

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

Properties:
- `label` (string) required: (nullable, max length 200)
- `description` (string): Conditional: When Description is not null. Max length: 2000. (nullable)
- `isRequired` (boolean): (nullable)
- `isActive` (boolean): (nullable)
- `sortOrder` (integer(int32)): Conditional: When SortOrder is not null. Must be >= 0. (nullable)
- `options` (array<string>): For `Dropdown` fields, the list of selectable options. (nullable)
- `maxLength` (integer(int32)): Maximum length for `Text` fields. Conditional: When MaxLength is not null. Must be > 0. (nullable)
- `regexPattern` (string): Regex validation pattern for `Text` fields. Conditional: When RegexPattern is not null. Max length: 2000. (nullable)
- `regexErrorMessage` (string): Error message when regex validation fails. Conditional: When RegexErrorMessage is not null. Max length: 2000. (nullable)
- `concurrencyStamp` (string): (nullable)

_Example: Retire a field and keep its values_

Deactivates the field and stops requiring it. The definition keeps its key and still counts toward the merchant's limit; values already on invoices stay, and an invoice that sends a value for it is accepted without checks. Every member is replaced by what is sent, so restate the label, limits and pattern to keep; the key and field type are fixed at create and are not on this payload. Delete the definition to free its key and its slot. Send the concurrencyStamp from your latest read of the definition.

```json
{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "label": "PO number",
  "description": "The customer's purchase order number",
  "isRequired": false,
  "isActive": false,
  "maxLength": 20,
  "regexPattern": "^PO-[0-9]{5}$",
  "regexErrorMessage": "Enter a PO number such as PO-48213."
}
```

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

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

Properties:
- `label` (string) required: (nullable, max length 200)
- `description` (string): Conditional: When Description is not null. Max length: 2000. (nullable)
- `isRequired` (boolean): (nullable)
- `isActive` (boolean): (nullable)
- `sortOrder` (integer(int32)): Conditional: When SortOrder is not null. Must be >= 0. (nullable)
- `options` (array<string>): For `Dropdown` fields, the list of selectable options. (nullable)
- `maxLength` (integer(int32)): Maximum length for `Text` fields. Conditional: When MaxLength is not null. Must be > 0. (nullable)
- `regexPattern` (string): Regex validation pattern for `Text` fields. Conditional: When RegexPattern is not null. Max length: 2000. (nullable)
- `regexErrorMessage` (string): Error message when regex validation fails. Conditional: When RegexErrorMessage is not null. Max length: 2000. (nullable)
- `concurrencyStamp` (string): (nullable)

_Example: Retire a field and keep its values_

Deactivates the field and stops requiring it. The definition keeps its key and still counts toward the merchant's limit; values already on invoices stay, and an invoice that sends a value for it is accepted without checks. Every member is replaced by what is sent, so restate the label, limits and pattern to keep; the key and field type are fixed at create and are not on this payload. Delete the definition to free its key and its slot. Send the concurrencyStamp from your latest read of the definition.

```json
{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "label": "PO number",
  "description": "The customer's purchase order number",
  "isRequired": false,
  "isActive": false,
  "maxLength": 20,
  "regexPattern": "^PO-[0-9]{5}$",
  "regexErrorMessage": "Enter a PO number such as PO-48213."
}
```

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

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

Properties:
- `label` (string) required: (nullable, max length 200)
- `description` (string): Conditional: When Description is not null. Max length: 2000. (nullable)
- `isRequired` (boolean): (nullable)
- `isActive` (boolean): (nullable)
- `sortOrder` (integer(int32)): Conditional: When SortOrder is not null. Must be >= 0. (nullable)
- `options` (array<string>): For `Dropdown` fields, the list of selectable options. (nullable)
- `maxLength` (integer(int32)): Maximum length for `Text` fields. Conditional: When MaxLength is not null. Must be > 0. (nullable)
- `regexPattern` (string): Regex validation pattern for `Text` fields. Conditional: When RegexPattern is not null. Max length: 2000. (nullable)
- `regexErrorMessage` (string): Error message when regex validation fails. Conditional: When RegexErrorMessage is not null. Max length: 2000. (nullable)
- `concurrencyStamp` (string): (nullable)

_Example: Retire a field and keep its values_

Deactivates the field and stops requiring it. The definition keeps its key and still counts toward the merchant's limit; values already on invoices stay, and an invoice that sends a value for it is accepted without checks. Every member is replaced by what is sent, so restate the label, limits and pattern to keep; the key and field type are fixed at create and are not on this payload. Delete the definition to free its key and its slot. Send the concurrencyStamp from your latest read of the definition.

```json
{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "label": "PO number",
  "description": "The customer's purchase order number",
  "isRequired": false,
  "isActive": false,
  "maxLength": 20,
  "regexPattern": "^PO-[0-9]{5}$",
  "regexErrorMessage": "Enter a PO number such as PO-48213."
}
```

## Responses

### 200

OK

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

Schema: [`InvoiceCustomFieldDefinitionDto`](https://devportal.demo.winkpg.io/docs/api/models/InvoiceCustomFieldDefinitionDto.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.
- `key` (string): (nullable)
- `label` (string): (nullable)
- `description` (string): (nullable)
- `fieldType` ([CustomFieldType](https://devportal.demo.winkpg.io/docs/api/models/CustomFieldType.md)): The data type of a custom field definition.
  Values:
  - `Text`
  - `Dropdown`
  - `Checkbox`
  - `Date`
  - `Numeric`
- `isRequired` (boolean): (nullable)
- `isActive` (boolean): (nullable)
- `sortOrder` (integer(int32)): (nullable)
- `options` (array<string>): (nullable)
- `maxLength` (integer(int32)): (nullable)
- `regexPattern` (string): (nullable)
- `regexErrorMessage` (string): (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"
  }
}
```

### 409

Conflict. The `concurrencyStamp` sent is not the resource's current one: the resource changed after it was read. Read the resource again and retry with the `concurrencyStamp` it returns. The body carries the standard error envelope.

**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))

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

### cURL

```bash
curl -X PUT "{{BASE_URL}}/api/invoicing/custom-field-definitions/{id}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "label": "PO number",
  "description": "The customer\u0027s purchase order number",
  "isRequired": false,
  "isActive": false,
  "maxLength": 20,
  "regexPattern": "^PO-[0-9]{5}$",
  "regexErrorMessage": "Enter a PO number such as PO-48213."
}'
```

### PowerShell

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

$body = @'
{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "label": "PO number",
  "description": "The customer\u0027s purchase order number",
  "isRequired": false,
  "isActive": false,
  "maxLength": 20,
  "regexPattern": "^PO-[0-9]{5}$",
  "regexErrorMessage": "Enter a PO number such as PO-48213."
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/invoicing/custom-field-definitions/{id}' `
    -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.invoiceCustomFieldDefinitionUpdate("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "label": "PO number",
  "description": "The customer\u0027s purchase order number",
  "isRequired": false,
  "isActive": false,
  "maxLength": 20,
  "regexPattern": "^PO-[0-9]{5}$",
  "regexErrorMessage": "Enter a PO number such as PO-48213."
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/invoicing/custom-field-definitions/{id}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
    "label": "PO number",
    "description": "The customer\u0027s purchase order number",
    "isRequired": false,
    "isActive": false,
    "maxLength": 20,
    "regexPattern": "^PO-[0-9]{5}$",
    "regexErrorMessage": "Enter a PO number such as PO-48213."
  }),
});

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<InvoiceCustomFieldDefinitionUpdateDto>("""
    {
      "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
      "label": "PO number",
      "description": "The customer\u0027s purchase order number",
      "isRequired": false,
      "isActive": false,
      "maxLength": 20,
      "regexPattern": "^PO-[0-9]{5}$",
      "regexErrorMessage": "Enter a PO number such as PO-48213."
    }
    """);

var result = await api.InvoiceCustomFieldDefinitionUpdateAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), body);
```

### C# (raw HTTP)

```csharp
using System.Text;

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

var request = new HttpRequestMessage(new HttpMethod("PUT"), "/api/invoicing/custom-field-definitions/{id}");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
      "label": "PO number",
      "description": "The customer\u0027s purchase order number",
      "isRequired": false,
      "isActive": false,
      "maxLength": 20,
      "regexPattern": "^PO-[0-9]{5}$",
      "regexErrorMessage": "Enter a PO number such as PO-48213."
    }
    """, 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.InvoiceCustomFieldDefinitionUpdateDto.from_dict({
      "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
      "label": "PO number",
      "description": "The customer\u0027s purchase order number",
      "isRequired": False,
      "isActive": False,
      "maxLength": 20,
      "regexPattern": "^PO-[0-9]{5}$",
      "regexErrorMessage": "Enter a PO number such as PO-48213."
    })
    result = api.invoice_custom_field_definition_update("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "label": "PO number",
  "description": "The customer\u0027s purchase order number",
  "isRequired": False,
  "isActive": False,
  "maxLength": 20,
  "regexPattern": "^PO-[0-9]{5}$",
  "regexErrorMessage": "Enter a PO number such as PO-48213."
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/invoicing/custom-field-definitions/{id}",
    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.