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.

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": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'

PowerShell

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

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

$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": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
});

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": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }),
});

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": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """);

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": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
    """, 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": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    })
    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": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

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.

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.
`billerType` required	all of InvoicePartyType	The biller's party type. Anything other than `Merchant` is refused.
`recipientType` required	all of InvoicePartyType	The recipient's party type. Only a `Customer` recipient has an address on file to fall back to.
`recipientId` required	string (uuid)	The recipient, when one has been chosen. Optional: a supplied `recipientSnapshot` stands in for it. nullable
`recipientSnapshot` required	all of 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.
`billerSnapshot` required	all of InvoicePartySnapshotDto	Optional origin address. Used only when the merchant has no default shipping origin. Conditional: When BillerSnapshot is not null.

This request body has no documented fields.