You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/MxPlatformApi.md
+302Lines changed: 302 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,9 +26,11 @@ All URIs are relative to *https://api.mx.com*
26
26
|[**delete_user**](MxPlatformApi.md#delete_user)|**DELETE** /users/{user_guid} | Delete user |
27
27
|[**deprecated_request_payment_processor_authorization_code**](MxPlatformApi.md#deprecated_request_payment_processor_authorization_code)|**POST** /payment_processor_authorization_code | (Deprecated) Request an authorization code. |
28
28
|[**download_statement_pdf**](MxPlatformApi.md#download_statement_pdf)|**GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf | Download statement pdf |
29
+
|[**download_tax_document**](MxPlatformApi.md#download_tax_document)|**GET** /users/{user_guid}/members/{member_guid}/tax_documents/{tax_document_guid}.pdf | Download a Tax Document PDF |
|[**identify_member**](MxPlatformApi.md#identify_member)|**POST** /users/{user_guid}/members/{member_guid}/identify | Identify member |
33
35
|[**list_account_numbers_by_account**](MxPlatformApi.md#list_account_numbers_by_account)|**GET** /users/{user_guid}/accounts/{account_guid}/account_numbers | List account numbers by account |
34
36
|[**list_account_numbers_by_member**](MxPlatformApi.md#list_account_numbers_by_member)|**GET** /users/{user_guid}/members/{member_guid}/account_numbers | List account numbers by member |
@@ -54,6 +56,7 @@ All URIs are relative to *https://api.mx.com*
54
56
|[**list_statements_by_member**](MxPlatformApi.md#list_statements_by_member)|**GET** /users/{user_guid}/members/{member_guid}/statements | List statements by member |
55
57
|[**list_taggings**](MxPlatformApi.md#list_taggings)|**GET** /users/{user_guid}/taggings | List taggings |
56
58
|[**list_tags**](MxPlatformApi.md#list_tags)|**GET** /users/{user_guid}/tags | List tags |
59
+
|[**list_tax_documents**](MxPlatformApi.md#list_tax_documents)|**GET** /users/{user_guid}/members/{member_guid}/tax_documents | List Tax Documents |
57
60
|[**list_transaction_rules**](MxPlatformApi.md#list_transaction_rules)|**GET** /users/{user_guid}/transaction_rules | List transaction rules |
58
61
|[**list_transactions**](MxPlatformApi.md#list_transactions)|**GET** /users/{user_guid}/transactions | List transactions |
59
62
|[**list_transactions_by_account**](MxPlatformApi.md#list_transactions_by_account)|**GET** /users/{user_guid}/accounts/{account_guid}/transactions | List transactions by account |
@@ -77,6 +80,7 @@ All URIs are relative to *https://api.mx.com*
77
80
|[**read_statement_by_member**](MxPlatformApi.md#read_statement_by_member)|**GET** /users/{user_guid}/members/{member_guid}/statements/{statement_guid} | Read statement by member |
78
81
|[**read_tag**](MxPlatformApi.md#read_tag)|**GET** /users/{user_guid}/tags/{tag_guid} | Read tag |
Use this endpoint to fetch (aggregate) the tax documents associated with the specified member. This request **does not** return the latest tax documents. It just starts the document aggregation process and returns the initial state of the process. You must interact with the newly aggregated data using the other document endpoints in this reference. This request may also trigger multi-factor authentication which requires end-user input and a specific process for answering authentication challenges.
1984
+
1985
+
### Examples
1986
+
1987
+
```ruby
1988
+
require'time'
1989
+
require'mx-platform-ruby'
1990
+
# setup authorization
1991
+
MxPlatformRuby.configure do |config|
1992
+
# Configure HTTP basic authorization: basicAuth
1993
+
config.username ='YOUR USERNAME'
1994
+
config.password ='YOUR PASSWORD'
1995
+
end
1996
+
1997
+
api_instance =MxPlatformRuby::MxPlatformApi.new
1998
+
member_guid ='MBR-7c6f361b-e582-15b6-60c0-358f12466b4b'# String | The unique id for a `member`.
1999
+
user_guid ='USR-fa7537f3-48aa-a683-a02a-b18940482f54'# String | The unique id for a `user`.
2000
+
2001
+
begin
2002
+
# Fetch Tax Documents
2003
+
result = api_instance.fetch_tax_documents(member_guid, user_guid)
2004
+
p result
2005
+
rescueMxPlatformRuby::ApiError => e
2006
+
puts"Error when calling MxPlatformApi->fetch_tax_documents: #{e}"
2007
+
end
2008
+
```
2009
+
2010
+
#### Using the fetch_tax_documents_with_http_info variant
2011
+
2012
+
This returns an Array which contains the response data, status code and headers.
0 commit comments