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

Example request

Each example below is one request, shown in every language. Choose an example and a language, then 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

Required purchase order number

Defines a text field every new invoice from the merchant must carry: an invoice create with no value for it, or an update whose customFields leave it out, answers 400 Invoicing:CustomField:Required, and a value that is longer than 20 characters or does not match the pattern answers 400 Invoicing:CustomField:InvalidValue with the error message given here. The key is fixed once created and unique per merchant, compared without regard to case: a duplicate answers 409 Invoicing:CustomFieldDefinition:KeyAlreadyExists. A merchant holds at most 20 definitions, active or inactive. Replace billerId with your merchant's id.

cURL

curl -X POST "{{BASE_URL}}/api/invoicing/custom-field-definitions" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "key": "po_number",
  "fieldType": "Text",
  "label": "PO number",
  "description": "The customer\u0027s purchase order number",
  "isRequired": true,
  "isActive": true,
  "maxLength": 20,
  "regexPattern": "^PO-[0-9]{5}$",
  "regexErrorMessage": "Enter a PO number such as PO-48213."
}'

PowerShell

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

$body = @'
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "key": "po_number",
  "fieldType": "Text",
  "label": "PO number",
  "description": "The customer\u0027s purchase order number",
  "isRequired": true,
  "isActive": true,
  "maxLength": 20,
  "regexPattern": "^PO-[0-9]{5}$",
  "regexErrorMessage": "Enter a PO number such as PO-48213."
}
'@

$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({
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "key": "po_number",
  "fieldType": "Text",
  "label": "PO number",
  "description": "The customer\u0027s purchase order number",
  "isRequired": true,
  "isActive": true,
  "maxLength": 20,
  "regexPattern": "^PO-[0-9]{5}$",
  "regexErrorMessage": "Enter a PO number such as PO-48213."
});

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({
    "billerId": "00000000-0000-0000-0000-000000000001",
    "billerType": "Merchant",
    "key": "po_number",
    "fieldType": "Text",
    "label": "PO number",
    "description": "The customer\u0027s purchase order number",
    "isRequired": true,
    "isActive": true,
    "maxLength": 20,
    "regexPattern": "^PO-[0-9]{5}$",
    "regexErrorMessage": "Enter a PO number such as PO-48213."
  }),
});

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>("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "key": "po_number",
      "fieldType": "Text",
      "label": "PO number",
      "description": "The customer\u0027s purchase order number",
      "isRequired": true,
      "isActive": true,
      "maxLength": 20,
      "regexPattern": "^PO-[0-9]{5}$",
      "regexErrorMessage": "Enter a PO number such as PO-48213."
    }
    """);

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("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "key": "po_number",
      "fieldType": "Text",
      "label": "PO number",
      "description": "The customer\u0027s purchase order number",
      "isRequired": true,
      "isActive": true,
      "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();

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({
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "key": "po_number",
      "fieldType": "Text",
      "label": "PO number",
      "description": "The customer\u0027s purchase order number",
      "isRequired": True,
      "isActive": True,
      "maxLength": 20,
      "regexPattern": "^PO-[0-9]{5}$",
      "regexErrorMessage": "Enter a PO number such as PO-48213."
    })
    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 = {
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "key": "po_number",
  "fieldType": "Text",
  "label": "PO number",
  "description": "The customer\u0027s purchase order number",
  "isRequired": True,
  "isActive": True,
  "maxLength": 20,
  "regexPattern": "^PO-[0-9]{5}$",
  "regexErrorMessage": "Enter a PO number such as PO-48213."
}

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

Optional department dropdown

Defines an optional dropdown. A value sent on an invoice must match one of the options exactly, or the request answers 400 Invoicing:CustomField:InvalidValue. Replace billerId with your merchant's id.

cURL

curl -X POST "{{BASE_URL}}/api/invoicing/custom-field-definitions" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "key": "department",
  "fieldType": "Dropdown",
  "label": "Department",
  "isActive": true,
  "sortOrder": 1,
  "options": [
    "Facilities",
    "Marketing",
    "Operations"
  ]
}'

PowerShell

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

$body = @'
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "key": "department",
  "fieldType": "Dropdown",
  "label": "Department",
  "isActive": true,
  "sortOrder": 1,
  "options": [
    "Facilities",
    "Marketing",
    "Operations"
  ]
}
'@

$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({
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "key": "department",
  "fieldType": "Dropdown",
  "label": "Department",
  "isActive": true,
  "sortOrder": 1,
  "options": [
    "Facilities",
    "Marketing",
    "Operations"
  ]
});

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({
    "billerId": "00000000-0000-0000-0000-000000000001",
    "billerType": "Merchant",
    "key": "department",
    "fieldType": "Dropdown",
    "label": "Department",
    "isActive": true,
    "sortOrder": 1,
    "options": [
      "Facilities",
      "Marketing",
      "Operations"
    ]
  }),
});

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>("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "key": "department",
      "fieldType": "Dropdown",
      "label": "Department",
      "isActive": true,
      "sortOrder": 1,
      "options": [
        "Facilities",
        "Marketing",
        "Operations"
      ]
    }
    """);

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("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "key": "department",
      "fieldType": "Dropdown",
      "label": "Department",
      "isActive": true,
      "sortOrder": 1,
      "options": [
        "Facilities",
        "Marketing",
        "Operations"
      ]
    }
    """, 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({
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "key": "department",
      "fieldType": "Dropdown",
      "label": "Department",
      "isActive": True,
      "sortOrder": 1,
      "options": [
        "Facilities",
        "Marketing",
        "Operations"
      ]
    })
    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 = {
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "key": "department",
  "fieldType": "Dropdown",
  "label": "Department",
  "isActive": True,
  "sortOrder": 1,
  "options": [
    "Facilities",
    "Marketing",
    "Operations"
  ]
}

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.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field Type Description

label required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

Conditional: When Description is not null. Max length: 2000. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isRequired required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isActive required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

sortOrder required

integer (int32)

Conditional: When SortOrder is not null. Must be >= 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

options required

array of string array of

For `Dropdown` fields, the list of selectable options. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

maxLength required

integer (int32)

Maximum length for `Text` fields. Conditional: When MaxLength is not null. Must be > 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

regexPattern required

string

Regex validation pattern for `Text` fields. Conditional: When RegexPattern is not null. Max length: 2000. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

regexErrorMessage required

string

Error message when regex validation fails. Conditional: When RegexErrorMessage is not null. Max length: 2000. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

billerId required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

billerType required

InvoicePartyType InvoicePartyType

Identifies the type of entity acting as the biller or recipient on an invoice.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`GatewayOwner`	Platform-level gateway owner.
`Reseller`	Reseller entity.
`Merchant`	Merchant entity.
`Customer`	End customer.

key required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

fieldType required

CustomFieldType CustomFieldType

The data type of a custom field definition.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Text`
`Dropdown`
`Checkbox`
`Date`
`Numeric`

This request body has no documented fields.

Responses

200 OK

The definition was created and is returned.

Body: InvoiceCustomFieldDefinitionDto InvoiceCustomFieldDefinitionDto Each item has these fields.

Field Type Description

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creationTime required

string (date-time)

The date and time when this entity was created.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creatorId required

string (uuid)

The ID of the user who created this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModificationTime required

string (date-time)

The date and time when this entity was last modified. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModifierId required

string (uuid)

The ID of the user who last modified this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

billerId required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

billerType required

InvoicePartyType InvoicePartyType

Identifies the type of entity acting as the biller or recipient on an invoice.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`GatewayOwner`	Platform-level gateway owner.
`Reseller`	Reseller entity.
`Merchant`	Merchant entity.
`Customer`	End customer.

key required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

label required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

fieldType required

CustomFieldType CustomFieldType

The data type of a custom field definition.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Text`
`Dropdown`
`Checkbox`
`Date`
`Numeric`

isRequired required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isActive required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDemoData required

boolean

True when this custom field definition belongs to the biller's removable demo data set. Null for every other custom field definition. Read-only: no request sets it. Filter on it to leave demo rows out of a list. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

sortOrder required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

options required

array of string array of

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

maxLength required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

regexPattern required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

regexErrorMessage required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

concurrencyStamp required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

429 Too Many Requests

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.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors 400 401 403 404 409 500 501 default

400 Bad Request The request is not valid: the key is missing or too long, the biller is empty, or a field rule is malformed.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
409 Conflict The biller already holds the maximum number of custom field definitions (`Invoicing:CustomFieldDefinition:LimitReached`), or a definition with this key, compared case-insensitively, already exists for the biller (`Invoicing:CustomFieldDefinition:KeyAlreadyExists`); for the latter the error's `data.key` holds the stored spelling of the key it collided with.
500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
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 lists the values `error.code` can take.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 lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of RemoteServiceErrorInfo:

Field Type Description

code required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

message required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

details required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

data required

object

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Invoicing

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

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

Example request

Parameters

Request body

Responses

Errors

Authentication