Difference between revisions of "NATS5 REST API Biller GET taxes"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''GET /biller/taxes''' == '''Description''' * Get taxes '''Resource URL''' *<nowiki>http://domain/api/biller/taxes</now...") |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_biller_section = true |
}} | }} | ||
== '''GET /biller/taxes''' == | == '''GET /biller/taxes''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get taxes | * Get taxes | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 20: | Line 21: | ||
None | None | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/biller/taxes</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "taxes": [ | ||
| + | { | ||
| + | "taxid": "1", | ||
| + | "networkid": "0", | ||
| + | "countries": "US", | ||
| + | "tax_amount": "65535", | ||
| + | "tax_perc": "500", | ||
| + | "tax_deduct": "1", | ||
| + | "tax_amount_dec": "655.35", | ||
| + | "tax_amount_currency": "$655.35", | ||
| + | "tax_perc_dec": "5.00", | ||
| + | "countries_list": [ | ||
| + | "US" | ||
| + | ], | ||
| + | "countries_list_nice": [ | ||
| + | "United States" | ||
| + | ], | ||
| + | "tax_deduct_nice": "After Affiliate Payout" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 74: | Line 108: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_biller_Collection]] |
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
| − | [[Category: | + | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> |
Latest revision as of 15:58, 9 August 2019
GET /biller/taxes
Description
- Get taxes
Resource URL
- http://domain/api/biller/taxes
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
None
Example Request
Method: GET
URL: http://domain/api/biller/taxes
Response:
{
"success": true,
"taxes": [
{
"taxid": "1",
"networkid": "0",
"countries": "US",
"tax_amount": "65535",
"tax_perc": "500",
"tax_deduct": "1",
"tax_amount_dec": "655.35",
"tax_amount_currency": "$655.35",
"tax_perc_dec": "5.00",
"countries_list": [
"US"
],
"countries_list_nice": [
"United States"
],
"tax_deduct_nice": "After Affiliate Payout"
}
]
}
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = array();
$request = Array(
'method' => 'GET',
'path' => 'v1/biller/taxes',
'data' => $data
);
/*code below is the same for (almost) every API call */
$curl = curl_init();
$url = $url.'/api/'.$request['path'];
$query = http_build_query($request['data']);
if($request['method'] == 'GET'){
//add query string parameters to the end of the url
$url = $url.'?'.$query;
}else{
//send parameters as POST fields
curl_setopt($curl, CURLOPT_POST, 1);
curl_setopt($curl, CURLOPT_POSTFIELDS, $query);
if($request['method'] != 'POST'){
$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
