Skip to content

Commit 2f017cd

Browse files
MC-16072 Add tax code docs
1 parent 44ef9f7 commit 2f017cd

File tree

3 files changed

+53
-8
lines changed

3 files changed

+53
-8
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Option 1: use docker
2222

2323
```shell
2424
cd /path/to/repo/cloudmc-api-docs/
25-
docker-compose up -d
25+
docker compose up -d
2626
```
2727

2828
Option 2: local or vagrant

docker-compose.yml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
app:
2-
build: .
3-
ports:
4-
- 4567:4567
5-
volumes:
6-
- .:/usr/src/app
1+
version: "3.9"
2+
3+
services:
4+
api-docs:
5+
build: .
6+
ports:
7+
- 4567:4567
8+
volumes:
9+
- .:/usr/src/app

source/includes/administration/_tax_providers.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,4 +94,46 @@ Attributes |  
9494
`state`<br/>*enum" | The state of the tax provider. Possible values are: `CONFIGURED`, `CONFIGURING`, `ERROR`.
9595
`createdDate`<br/>*string* | The date the tax provider was created.
9696
`updatedDate`<br/>*string* | The last date the tax provider was updated.
97-
`configurationAttributes`<br/>*Object* | The configuration attributes associated to the provider type. This depends on the provider type.
97+
`configurationAttributes`<br/>*Object* | The configuration attributes associated to the provider type. This depends on the provider type.
98+
99+
100+
<!-------------------- GET TAX CODES FROM PROVIDER -------------------->
101+
102+
#### Get a tax codes
103+
104+
`GET /tax_providers/:id/tax-codes`
105+
106+
Retrieves a list of tax codes from the configured tax provider for a reseller organization.
107+
108+
> Note: You must have the Reseller billing permission on the owner of the tax provider requested. If the caller does not have the correct permissions or the tax provider is not configured for the given organization ID or the organization does not exist, then a `404 Not Found` response will be returned. The required ID in the URL is the ID of the reseller organization for which the tax codes are being fetched.
109+
110+
```shell
111+
# Retrieve tax codes for a given organization
112+
curl "https://cloudmc_endpoint/rest/tax_providers/f26e66a4-755c-4867-b565-ad68aa515237/tax-codes" \
113+
-H "MC-Api-Key: your_api_key"
114+
```
115+
> The above command returns a JSON structured like this:
116+
117+
```json
118+
{
119+
"data": [
120+
{
121+
"code": "SW054101",
122+
"description": "Cloud Services - SaaS - Service Agreement - Database Products"
123+
},
124+
{
125+
"code": "SW053004",
126+
"description": "Cloud Services - SaaS - License Agreement - for business use only"
127+
},
128+
{
129+
"code": "SW056003",
130+
"description": "Cloud Services / Platform as a Service (PaaS)"
131+
}
132+
]
133+
}
134+
```
135+
136+
Attributes | &nbsp;
137+
---- | -----------
138+
`code`<br/>*string* | The code of the tax.
139+
`description`<br/>*string* | The description of the tax code.

0 commit comments

Comments
 (0)