Skip to content

Commit

Permalink
test build
Browse files Browse the repository at this point in the history
  • Loading branch information
nht007 committed Aug 12, 2024
1 parent e71ce1c commit bc49a87
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
test build

# VertexClient

[![CircleCI](https://circleci.com/gh/customink/vertex_client.svg?style=svg&circle-token=ccfd7815662866d32b9173a55820d897b162220f)](https://circleci.com/gh/customink/vertex_client)
Expand Down Expand Up @@ -94,12 +96,14 @@ response.total #=> Total price plus total tax
response.subtotal #=> Total price before tax
```

#### Location specific data (required for `:customer` and specified `:physical_origin` of `:seller` in `:line_items`)
You are required to specify a `state` or a `country`. The client will raise an error if none is specified.
#### Location specific data (required for `:customer` and specified `:physical_origin` of `:seller` in `:line_items`)

You are required to specify a `state` or a `country`. The client will raise an error if none is specified.

At the moment specifying state automatically implies `country` is `US`. For `US` locations `postal_code` is also required.

##### US address example

```ruby
customer: {
...
Expand All @@ -109,12 +113,15 @@ At the moment specifying state automatically implies `country` is `US`. For `US`
...
}
```

##### Non-US address example

`state` and `postal_code` are optional attributes for non-US countries

```ruby
customer: {
...
country: "CZ",
country: "CZ",
...
}
```
Expand Down Expand Up @@ -153,7 +160,8 @@ VertexClient.distribute_tax(
```

### Tax Area
Look up the internal Vertex location identifier for a given address. Including `tax_area_id` as part of the customer information in calls to `invoice` and `quotation` should improve performance, especially in situations where there are many destination addresses.

Look up the internal Vertex location identifier for a given address. Including `tax_area_id` as part of the customer information in calls to `invoice` and `quotation` should improve performance, especially in situations where there are many destination addresses.

```ruby
response = VertexClient.tax_area(
Expand Down Expand Up @@ -199,12 +207,14 @@ Or install it yourself as:
Configure the client's connection to Vertex using environment variables or an initializer.

### Environment Variables

The following environment variables are used to configure the client.

```
VERTEX_TRUSTED_ID=your-trusted-id
VERTEX_SOAP_API=https://connect.vertexsmb.com/vertex-ws/services/
```

### Initializer

If you are using Rails, take advantage of the included generator:
Expand All @@ -213,7 +223,6 @@ If you are using Rails, take advantage of the included generator:

Otherwise reference our [initializer template](https://github.com/customink/vertex_client/blob/master/lib/generators/install/templates/initializer.rb.erb)


## Development

This project follows Github's [Scripts to rule them all conventions][scripts-to-rule-them-all]. After cloning the app,
Expand Down

0 comments on commit bc49a87

Please sign in to comment.