Transactions

$model.description$.

Defined (1)

The class is defined in the following location(s).

/lib/taxamo/Taxamo/models/transactions.php  
  1. class Transactions { 
  2.  
  3. static $swaggerTypes = array( 
  4. 'invoice_date' => 'string',  
  5. 'invoice_address' => 'invoice_address',  
  6. 'manual' => 'bool',  
  7. 'buyer_credit_card_prefix' => 'string',  
  8. 'custom_fields' => 'array[custom_fields]',  
  9. 'additional_currencies' => 'additional_currencies',  
  10. 'buyer_tax_number' => 'string',  
  11. 'custom_id' => 'string',  
  12. 'deducted_tax_amount' => 'number',  
  13. 'tax_country_code' => 'string',  
  14. 'force_country_code' => 'string',  
  15. 'tax_amount' => 'number',  
  16. 'tax_timezone' => 'string',  
  17. 'buyer_email' => 'string',  
  18. 'original_transaction_key' => 'string',  
  19. 'test' => 'bool',  
  20. 'status' => 'string',  
  21. 'create_timestamp' => 'string',  
  22. 'total_amount' => 'number',  
  23. 'tax_entity_name' => 'string',  
  24. 'buyer_ip' => 'string',  
  25. 'refunded_tax_amount' => 'number',  
  26. 'countries' => 'countries',  
  27. 'invoice_place' => 'string',  
  28. 'verification_token' => 'string',  
  29. 'tax_deducted' => 'bool',  
  30. 'buyer_name' => 'string',  
  31. 'confirm_timestamp' => 'string',  
  32. 'evidence' => 'evidence',  
  33. 'amount' => 'number',  
  34. 'custom_data' => 'string',  
  35. 'billing_country_code' => 'string',  
  36. 'tax_supported' => 'bool',  
  37. 'invoice_number' => 'string',  
  38. 'currency_code' => 'string',  
  39. 'refunded_total_amount' => 'number',  
  40. 'description' => 'string',  
  41. 'supply_date' => 'string',  
  42. 'transaction_lines' => 'array[transaction_lines]',  
  43. 'order_date' => 'string',  
  44. 'key' => 'string' 
  45.  
  46. ); 
  47.  
  48. /** 
  49. * Invoice date of issue. 
  50. */ 
  51. public $invoice_date; // string 
  52. /** 
  53. * Invoice address. 
  54. */ 
  55. public $invoice_address; // invoice_address 
  56. /** 
  57. * Is the transaction created manually - using private token. In manual mode, it is the merchant who calculates tax country and validates evidence. If you need API to do that when accessing the API with private token, just skip the 'manual' flag or use false value there and provide customer's ip address through buyer_ip field. 
  58. */ 
  59. public $manual; // bool 
  60. /** 
  61. * Buyer's credit card prefix. 
  62. */ 
  63. public $buyer_credit_card_prefix; // string 
  64. /** 
  65. * Custom fields, stored as key-value pairs. This property is not processed and used mostly with Taxamo-built helpers. 
  66. */ 
  67. public $custom_fields; // array[custom_fields] 
  68. /** 
  69. * Additional currency information - can be used to receive additional information about invoice in another currency. 
  70. */ 
  71. public $additional_currencies; // additional_currencies 
  72. /** 
  73. * Buyer's tax number - EU VAT number for example. If using EU VAT number, it is possible to provide country code in it (e.g. IE1234567X) or simply use billing_country_code field for that. In the first case, if billing_country_code value was provided, it will be overwritten with country code value extracted from VAT number - but only if the VAT has been verified properly. 
  74. */ 
  75. public $buyer_tax_number; // string 
  76. /** 
  77. * Custom identifier provided upon transaction creation. 
  78. */ 
  79. public $custom_id; // string 
  80. /** 
  81. * How much tax has been deducted. 
  82. */ 
  83. public $deducted_tax_amount; // number 
  84. /** 
  85. * Two-letter ISO country code, e.g. FR. This code applies to detected/set country for transaction, but can be set using manual mode. 
  86. */ 
  87. public $tax_country_code; // string 
  88. /** 
  89. * Two-letter ISO country code, e.g. FR. Use it to force country code for tax calculation. 
  90. */ 
  91. public $force_country_code; // string 
  92. /** 
  93. * Tax amount of transaction. 
  94. */ 
  95. public $tax_amount; // number 
  96. /** 
  97. * Timezone name for tax transaction. 
  98. */ 
  99. public $tax_timezone; // string 
  100. /** 
  101. * Buyer's declared email address. 
  102. */ 
  103. public $buyer_email; // string 
  104. /** 
  105. * Use data and evidence from original transaction. Tax will be re-calculated, but evidence won't be re-checked. 
  106. */ 
  107. public $original_transaction_key; // string 
  108. /** 
  109. * Was this transaction created in test mode? 
  110. */ 
  111. public $test; // bool 
  112. /** 
  113. * Transaction status. 
  114. */ 
  115. public $status; // string 
  116. /** 
  117. * Date and time of transaction creation. 
  118. */ 
  119. public $create_timestamp; // string 
  120. /** 
  121. * Total amount of transaction. 
  122. */ 
  123. public $total_amount; // number 
  124. /** 
  125. * To which entity is the tax due. 
  126. */ 
  127. public $tax_entity_name; // string 
  128. /** 
  129. * IP address of the buyer in dotted decimal (IPv4) or text format (IPv6). 
  130. */ 
  131. public $buyer_ip; // string 
  132. /** 
  133. * Refunded tax amount. 
  134. */ 
  135. public $refunded_tax_amount; // number 
  136. /** 
  137. * Map of countries calculated from evidence provided. This value is not stored and is available only upon tax calculation. 
  138. */ 
  139. public $countries; // countries 
  140. /** 
  141. * Invoice place of issue. 
  142. */ 
  143. public $invoice_place; // string 
  144. /** 
  145. * Verification token 
  146. */ 
  147. public $verification_token; // string 
  148. /** 
  149. * True if the transaction deducted from tax and no tax is applied. Either set automatically when VAT number validates with VIES correctly, but can also be provided in manual mode. 
  150. */ 
  151. public $tax_deducted; // bool 
  152. /** 
  153. * Buyer's name - first name and last name or company name. 
  154. */ 
  155. public $buyer_name; // string 
  156. /** 
  157. * Date and time of transaction confirmation. 
  158. */ 
  159. public $confirm_timestamp; // string 
  160. /** 
  161. * Tax country of residence evidence. 
  162. */ 
  163. public $evidence; // evidence 
  164. /** 
  165. * Amount of transaction without tax. 
  166. */ 
  167. public $amount; // number 
  168. /** 
  169. * Custom data related to transaction. 
  170. */ 
  171. public $custom_data; // string 
  172. /** 
  173. * Billing two letter ISO country code. 
  174. */ 
  175. public $billing_country_code; // string 
  176. /** 
  177. * Is tax calculation supported for a detected tax location? 
  178. */ 
  179. public $tax_supported; // bool 
  180. /** 
  181. * Invoice number. 
  182. */ 
  183. public $invoice_number; // string 
  184. /** 
  185. * Currency code for transaction - e.g. EUR. 
  186. */ 
  187. public $currency_code; // string 
  188. /** 
  189. * Total amount refunde (including tax). 
  190. */ 
  191. public $refunded_total_amount; // number 
  192. /** 
  193. * Transaction description. 
  194. */ 
  195. public $description; // string 
  196. /** 
  197. * Supply date in yyyy-MM-dd format. 
  198. */ 
  199. public $supply_date; // string 
  200. /** 
  201. * Transaction lines. 
  202. */ 
  203. public $transaction_lines; // array[transaction_lines] 
  204. /** 
  205. * Order date in yyyy-MM-dd format, in merchant's timezone. If provided by the API caller, no timezone conversion is performed. Default value is current date and time. When using public token, the default value is used. 
  206. */ 
  207. public $order_date; // string 
  208. /** 
  209. * Id generated by taxamo. 
  210. */ 
  211. public $key; // string