Custom Field Definitions: Creates a new invoice custom field definition.

POST /api/invoicing/custom-field-definitions deprecated

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

A biller holds at most 20 definitions, active and inactive alike. Deactivating a definition does not free a slot; deleting one does. The key is unique per biller, compared case-insensitively: `po_number` and `PO_Number` are the same key. Inactive definitions hold their key; a deleted definition's key can be reused. The key cannot be changed after creation.

Try this in the console

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/invoicing/custom-field-definitions" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "",
  "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "key": ""
}'

PowerShell

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

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

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

npm install @winkpg/winkpg-api

TypeScript (SDK)

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

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

const { data } = await api.invoiceCustomFieldDefinitionCreate({
  "label": "",
  "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "key": ""
});

TypeScript (raw HTTP)

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

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

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

var result = await api.InvoiceCustomFieldDefinitionCreateAsync(body);

C# (raw HTTP)

using System.Text;

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

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

request.Content = new StringContent("""
    {
      "label": "",
      "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "key": ""
    }
    """, Encoding.UTF8, "application/json");

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

pip install winkpg-api

Python (SDK)

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.InvoiceCustomFieldDefinitionCreateDto.from_dict({
      "label": "",
      "billerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "key": ""
    })
    result = api.invoice_custom_field_definition_create(body)

pip install requests

Python (raw HTTP)

import requests

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

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

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/invoicing/custom-field-definitions",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`label` required	string	nullablemax length 200
`description` required	string	Conditional: When Description is not null. Max length: 2000. nullable
`isRequired` required	boolean	nullable
`isActive` required	boolean	nullable
`sortOrder` required	integer (int32)	Conditional: When SortOrder is not null. Must be >= 0. nullable
`options` required	array of string	For `Dropdown` fields, the list of selectable options. nullable
`maxLength` required	integer (int32)	Maximum length for `Text` fields. Conditional: When MaxLength is not null. Must be > 0. nullable
`regexPattern` required	string	Regex validation pattern for `Text` fields. Conditional: When RegexPattern is not null. Max length: 2000. nullable
`regexErrorMessage` required	string	Error message when regex validation fails. Conditional: When RegexErrorMessage is not null. Max length: 2000. nullable
`billerId` required	string (uuid)
`billerType` required	InvoicePartyType	Identifies the type of entity acting as the biller or recipient on an invoice. one of: GatewayOwner, Reseller, Merchant, Customer
`key` required	string	nullablemax length 100
`fieldType` required	CustomFieldType	The data type of a custom field definition. one of: Text, Dropdown, Checkbox, Date, Numeric

This request body has no documented fields.