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

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

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.

**Operation ID:** `invoiceTaxRateLookupLookup`

## Authorization

Requires: Invoicing.Invoices, merchant scope.

Requires API key scope: `admin`

Required permissions:
- `Invoicing.Invoices`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

The biller, the recipient, and the optional address overrides.

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

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

Properties:
- `billerId` (string(uuid)) required: The biller whose tax provider binding performs the lookup. Must be a merchant.
- `billerType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): The biller's party type. Anything other than `Merchant` is refused.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.
- `recipientType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): The recipient's party type. Only a `Customer` recipient has an address on file to fall back to.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.
- `recipientId` (string(uuid)): The recipient, when one has been chosen. Optional: a supplied `recipientSnapshot` stands in for it. (nullable)
- `recipientSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): 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.
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)
- `billerSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Optional origin address. Used only when the merchant has no default shipping origin. Conditional: When BillerSnapshot is not null.
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)

_Example: Look up the rate for a shipping address_

Asks the merchant's tax provider for the sales tax rate from the merchant's default shipping origin to the address given. A recipient address with a street and a state is used in place of the customer's address on file; leave recipientSnapshot out to use the address on file. Only a merchant biller can look up a rate, and only where a tax provider is enabled for the merchant. Nothing is written: the rate returned is applied to a line only when it is sent on an invoice create or update, as the line's taxRatePercent with Provider as its taxRateSource and the returned providerName as its taxRateProviderName. Replace billerId with your merchant's id and recipientId with the customer's id.

```json
{
  "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"
  }
}
```

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

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

Properties:
- `billerId` (string(uuid)) required: The biller whose tax provider binding performs the lookup. Must be a merchant.
- `billerType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): The biller's party type. Anything other than `Merchant` is refused.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.
- `recipientType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): The recipient's party type. Only a `Customer` recipient has an address on file to fall back to.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.
- `recipientId` (string(uuid)): The recipient, when one has been chosen. Optional: a supplied `recipientSnapshot` stands in for it. (nullable)
- `recipientSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): 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.
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)
- `billerSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Optional origin address. Used only when the merchant has no default shipping origin. Conditional: When BillerSnapshot is not null.
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)

_Example: Look up the rate for a shipping address_

Asks the merchant's tax provider for the sales tax rate from the merchant's default shipping origin to the address given. A recipient address with a street and a state is used in place of the customer's address on file; leave recipientSnapshot out to use the address on file. Only a merchant biller can look up a rate, and only where a tax provider is enabled for the merchant. Nothing is written: the rate returned is applied to a line only when it is sent on an invoice create or update, as the line's taxRatePercent with Provider as its taxRateSource and the returned providerName as its taxRateProviderName. Replace billerId with your merchant's id and recipientId with the customer's id.

```json
{
  "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"
  }
}
```

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

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

Properties:
- `billerId` (string(uuid)) required: The biller whose tax provider binding performs the lookup. Must be a merchant.
- `billerType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): The biller's party type. Anything other than `Merchant` is refused.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.
- `recipientType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): The recipient's party type. Only a `Customer` recipient has an address on file to fall back to.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.
- `recipientId` (string(uuid)): The recipient, when one has been chosen. Optional: a supplied `recipientSnapshot` stands in for it. (nullable)
- `recipientSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): 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.
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)
- `billerSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Optional origin address. Used only when the merchant has no default shipping origin. Conditional: When BillerSnapshot is not null.
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)

_Example: Look up the rate for a shipping address_

Asks the merchant's tax provider for the sales tax rate from the merchant's default shipping origin to the address given. A recipient address with a street and a state is used in place of the customer's address on file; leave recipientSnapshot out to use the address on file. Only a merchant biller can look up a rate, and only where a tax provider is enabled for the merchant. Nothing is written: the rate returned is applied to a line only when it is sent on an invoice create or update, as the line's taxRatePercent with Provider as its taxRateSource and the returned providerName as its taxRateProviderName. Replace billerId with your merchant's id and recipientId with the customer's id.

```json
{
  "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"
  }
}
```

## Responses

### 200

The provider's rate in percent units.

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

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

Properties:
- `ratePercent` (number(double)): The combined sales-tax rate in percent units, rounded to four decimals.
- `jurisdiction` (string): One display string naming the jurisdictions the rate is built from, bounded to  `MaxTaxJurisdictionLength` so it fits the line's jurisdiction field. (nullable)
- `providerName` (string): The provider that answered, as the line records it in `TaxRateProviderName`. (nullable)
- `normalizedAddress` (string): The provider's normalised form of the address it rated, when it reported one. (nullable)
- `isFreightTaxable` (boolean): Whether the provider reports shipping as taxable at the rated location.

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

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

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.

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

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

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

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

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

### cURL

```bash
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

```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
```

### 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.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)

```typescript
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();
```

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

```csharp
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();
```

### 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.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)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
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()
```

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.