Invoices: Looks up a line's sales-tax rate from the merchant biller's tax provider.

POST /api/invoicing/invoices/tax-rate-lookup deprecated

Requires: Invoicing.Invoices, merchant scope.

Requires API key scope: admin (Administration)

Resolves the origin from the merchant's default shipping origin (falling back to `billerSnapshot`) and the destination from `recipientSnapshot` (falling back to a customer recipient's address on file), then asks the merchant's bound provider for the combined rate. The answer is in percent units (a provider rate of 0.0975 is returned as 9.75), ready to store as the line's `taxRatePercent` alongside `taxRateSource` = Provider and the returned `providerName`. The line's `taxCode` is never sent to the provider.

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/invoicing/invoices/tax-rate-lookup" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "recipientType": "Customer",
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientSnapshot": {
    "addressLine1": "2100 Ross Ave",
    "city": "Dallas",
    "state": "TX",
    "postalCode": "75201",
    "country": "US"
  }
}'

PowerShell

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

$body = @'
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "recipientType": "Customer",
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientSnapshot": {
    "addressLine1": "2100 Ross Ave",
    "city": "Dallas",
    "state": "TX",
    "postalCode": "75201",
    "country": "US"
  }
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/invoicing/invoices/tax-rate-lookup' `
    -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.invoiceTaxRateLookupLookup({
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "recipientType": "Customer",
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientSnapshot": {
    "addressLine1": "2100 Ross Ave",
    "city": "Dallas",
    "state": "TX",
    "postalCode": "75201",
    "country": "US"
  }
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/invoicing/invoices/tax-rate-lookup', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "billerId": "00000000-0000-0000-0000-000000000001",
    "billerType": "Merchant",
    "recipientType": "Customer",
    "recipientId": "00000000-0000-0000-0000-000000000201",
    "recipientSnapshot": {
      "addressLine1": "2100 Ross Ave",
      "city": "Dallas",
      "state": "TX",
      "postalCode": "75201",
      "country": "US"
    }
  }),
});

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<InvoiceTaxRateLookupInput>("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "recipientType": "Customer",
      "recipientId": "00000000-0000-0000-0000-000000000201",
      "recipientSnapshot": {
        "addressLine1": "2100 Ross Ave",
        "city": "Dallas",
        "state": "TX",
        "postalCode": "75201",
        "country": "US"
      }
    }
    """);

var result = await api.InvoiceTaxRateLookupLookupAsync(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/invoices/tax-rate-lookup");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "recipientType": "Customer",
      "recipientId": "00000000-0000-0000-0000-000000000201",
      "recipientSnapshot": {
        "addressLine1": "2100 Ross Ave",
        "city": "Dallas",
        "state": "TX",
        "postalCode": "75201",
        "country": "US"
      }
    }
    """, 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.InvoiceTaxRateLookupInput.from_dict({
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "recipientType": "Customer",
      "recipientId": "00000000-0000-0000-0000-000000000201",
      "recipientSnapshot": {
        "addressLine1": "2100 Ross Ave",
        "city": "Dallas",
        "state": "TX",
        "postalCode": "75201",
        "country": "US"
      }
    })
    result = api.invoice_tax_rate_lookup_lookup(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",
  "recipientType": "Customer",
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientSnapshot": {
    "addressLine1": "2100 Ross Ave",
    "city": "Dallas",
    "state": "TX",
    "postalCode": "75201",
    "country": "US"
  }
}

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

billerId required

string (uuid)

The biller whose tax provider binding performs the lookup. Must be a merchant.

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

The biller's party type. Anything other than `Merchant` is refused.

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.

recipientType required

InvoicePartyType InvoicePartyType

The recipient's party type. Only a `Customer` recipient has an address on file to fall back to.

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.

recipientId required

string (uuid)

The recipient, when one has been chosen. Optional: a supplied `recipientSnapshot` stands in for it. 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.

recipientSnapshot required

InvoicePartySnapshotDto InvoicePartySnapshotDto

Optional destination address. When supplied with a street and a state it is used as the destination instead of the recipient's address on file. Conditional: When RecipientSnapshot is not null.

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 InvoicePartySnapshotDto:

Field Type Description

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

email required

string

nullablemax length 256

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.

phone required

string

nullablemax length 30

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.

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

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

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

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

postalCode required

string

nullablemax length 20

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.

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

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

taxId required

string

nullablemax length 50

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.

logoUrl required

string

nullablemax length 2048

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.

billerSnapshot required

InvoicePartySnapshotDto InvoicePartySnapshotDto

Optional origin address. Used only when the merchant has no default shipping origin. Conditional: When BillerSnapshot is not null.

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 InvoicePartySnapshotDto:

Field Type Description

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

email required

string

nullablemax length 256

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.

phone required

string

nullablemax length 30

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.

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

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

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

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

postalCode required

string

nullablemax length 20

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.

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

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

taxId required

string

nullablemax length 50

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.

logoUrl required

string

nullablemax length 2048

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 request body has no documented fields.

Responses

200 The provider's rate in percent units.

Body: InvoiceTaxRateLookupResultDto InvoiceTaxRateLookupResultDto Each item has these fields.

Field Type Description

ratePercent required

number (double)

The combined sales-tax rate in percent units, rounded to four decimals.

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.

jurisdiction required

string

One display string naming the jurisdictions the rate is built from, bounded to `MaxTaxJurisdictionLength` so it fits the line's jurisdiction field. 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.

providerName required

string

The provider that answered, as the line records it in `TaxRateProviderName`. 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.

normalizedAddress required

string

The provider's normalised form of the address it rated, when it reported one. 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.

isFreightTaxable required

boolean

Whether the provider reports shipping as taxable at the rated location.

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.

400 The biller is not a merchant (`Invoicing:TaxRateLookup:BillerNotMerchant`). Only a merchant holds a tax provider binding; a reseller or gateway-owner biller uses its own tax rate catalog instead.

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.

404 The caller's biller scope does not cover the requested biller (`Invoicing:Biller:ForeignBillerNotAllowed`). Reported as not-found rather than forbidden so the response cannot be used to probe which billers exist.

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.

409 The lookup cannot run as things stand: the merchant has no enabled, deployed provider (`Invoicing:TaxRateLookup:ProviderUnavailable`); no origin address could be resolved (`Invoicing:TaxRateLookup:NoOriginAddress`); no destination address could be resolved (`Invoicing:TaxRateLookup:NoDestinationAddress`); or the provider answered with a failure (`Invoicing:TaxRateLookup:ProviderFailed`), whose normalised error codes travel in the error's `data.errorCodes`.

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.

403 Forbidden

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.

401 Unauthorized

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.

501 Not Implemented

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.

500 Internal Server Error

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.

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.

This response has no documented body fields.

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.

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

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

The API reference isn't available right now

No such operation

This reference may be out of date

Invoices: Looks up a line's sales-tax rate from the merchant biller's tax provider.

Example request

Parameters

Request body

Responses

200 The provider's rate in percent units.

400 The biller is not a merchant (`Invoicing:TaxRateLookup:BillerNotMerchant`). Only a merchant holds a tax provider binding; a reseller or gateway-owner biller uses its own tax rate catalog instead.

404 The caller's biller scope does not cover the requested biller (`Invoicing:Biller:ForeignBillerNotAllowed`). Reported as not-found rather than forbidden so the response cannot be used to probe which billers exist.

403 Forbidden

401 Unauthorized

501 Not Implemented

500 Internal Server Error

Errors

Authentication