Skip to content

FormsW9Api.md

Latest commit

 

History

History
815 lines (631 loc) · 35.1 KB

FormsW9Api.md

File metadata and controls

815 lines (631 loc) · 35.1 KB

Avalara.SDK.FormsW9Api

All URIs are relative to https://api.sbx.avalara.com/avalara1099

Method HTTP request Description
create_and_send_w9_form_email POST /w9/forms/$create-and-send-email Create a minimal W9/W4/W8 form and sends the e-mail request
create_w9_form POST /w9/forms Create a W9/W4/W8 form
delete_w9_form DELETE /w9/forms/{id} Delete a W9/W4/W8 form
get_w9_form GET /w9/forms/{id} Retrieve a W9/W4/W8 form
get_w9_form_pdf GET /w9/forms/{id}/pdf Download the PDF for a W9/W4/W8 form.
list_w9_forms GET /w9/forms List W9/W4/W8 forms
send_w9_form_email POST /w9/forms/{id}/$send-email Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form
update_w9_form PUT /w9/forms/{id} Update a W9/W4/W8 form
upload_w9_files POST /w9/forms/{id}/attachment Replace the PDF file for a W9/W4/W8 form

create_and_send_w9_form_email

CreateW9Form201Response create_and_send_w9_form_email(avalara_version)

Create a minimal W9/W4/W8 form and sends the e-mail request

Create a minimal W9/W4/W8 form and sends the e-mail request.

Example

  • Bearer Authentication (bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.A1099.V2 import forms_w9_api
CreateW9Form201Response
CreateAndSendW9FormEmailRequest
ErrorResponse
from pprint import pprint
    
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
    app_name='test app'
    app_version='1.0'
    machine_name='some machine'
    client_id='<Your Avalara Identity Client Id>'
    client_secret='<Your Avalara Identity Client Secret>'
    environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = forms_w9_api.FormsW9Api(api_client)
    avalara_version = '2.0.0' # str | API version
    x_correlation_id = 'f288b7a0-8ae8-4fa4-a0e1-b294d597b7a3' # str | Unique correlation Id in a GUID format (optional)
    x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional)
    create_and_send_w9_form_email_request = {"type":"W9","email":"john.doe@example.com","name":"John Doe","accountNumber":"ACC01","companyId":"12345","referenceId":"REF-12345"} # CreateAndSendW9FormEmailRequest | Form to be created (optional)
    # example passing only required values which don't have defaults set
    try:
        # Create a minimal W9/W4/W8 form and sends the e-mail request
        api_response = api_instance.create_and_send_w9_form_email(avalara_version)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->create_and_send_w9_form_email: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create a minimal W9/W4/W8 form and sends the e-mail request
        api_response = api_instance.create_and_send_w9_form_email(avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, create_and_send_w9_form_email_request=create_and_send_w9_form_email_request)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->create_and_send_w9_form_email: %s\n" % e)

Parameters

Name Type Description Notes
avalara_version str API version
x_correlation_id str Unique correlation Id in a GUID format [optional]
x_avalara_client str Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]
create_and_send_w9_form_email_request CreateAndSendW9FormEmailRequest Form to be created [optional]

Return type

CreateW9Form201Response

Authorization

bearer

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 The created W9/W4/W8 form -
400 Bad request (e.g. Unknown form type: W10&quot;) -
401 Authentication failed -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_w9_form

CreateW9Form201Response create_w9_form(avalara_version)

Create a W9/W4/W8 form

Create a W9/W4/W8 form.

Example

  • Bearer Authentication (bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.A1099.V2 import forms_w9_api
CreateW9FormRequest
CreateW9Form201Response
ErrorResponse
from pprint import pprint
    
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
    app_name='test app'
    app_version='1.0'
    machine_name='some machine'
    client_id='<Your Avalara Identity Client Id>'
    client_secret='<Your Avalara Identity Client Secret>'
    environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = forms_w9_api.FormsW9Api(api_client)
    avalara_version = '2.0.0' # str | API version
    x_correlation_id = '0508a682-ec3b-4686-9f1c-800b1c16cb02' # str | Unique correlation Id in a GUID format (optional)
    x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional)
    create_w9_form_request = {"type":"W9","name":"John Doe","businessName":"Acme Inc.","businessClassification":"Individual","businessOther":null,"foreignPartnerOwnerOrBeneficiary":false,"exemptPayeeCode":"5","exemptFatcaCode":"A","foreignCountryIndicator":false,"address":"123 Main St.","foreignAddress":null,"city":"Anytown","state":"CA","zip":"12345","accountNumber":"ACC123456","tinType":"SSN","tin":"543456789","backupWithholding":false,"is1099able":true,"eDeliveryConsentedAt":"2024-05-01T10:30:10.000000","signature":null,"companyId":"32553266","referenceId":"REF12345","email":"johndoe@example.com"} # CreateW9FormRequest | Form to be created (optional)
    # example passing only required values which don't have defaults set
    try:
        # Create a W9/W4/W8 form
        api_response = api_instance.create_w9_form(avalara_version)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->create_w9_form: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Create a W9/W4/W8 form
        api_response = api_instance.create_w9_form(avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, create_w9_form_request=create_w9_form_request)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->create_w9_form: %s\n" % e)

Parameters

Name Type Description Notes
avalara_version str API version
x_correlation_id str Unique correlation Id in a GUID format [optional]
x_avalara_client str Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]
create_w9_form_request CreateW9FormRequest Form to be created [optional]

Return type

CreateW9Form201Response

Authorization

bearer

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 The created W9/W4/W8 form -
400 Bad request (e.g., missing required field) -
401 Authentication failed -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_w9_form

delete_w9_form(id, avalara_version)

Delete a W9/W4/W8 form

Delete a W9/W4/W8 form.

Example

  • Bearer Authentication (bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.A1099.V2 import forms_w9_api
ErrorResponse
from pprint import pprint
    
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
    app_name='test app'
    app_version='1.0'
    machine_name='some machine'
    client_id='<Your Avalara Identity Client Id>'
    client_secret='<Your Avalara Identity Client Secret>'
    environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = forms_w9_api.FormsW9Api(api_client)
    id = 'id_example' # str | ID of the form to delete
    avalara_version = '2.0.0' # str | API version
    x_correlation_id = 'b6cde878-ee95-404d-864e-46cd2d3e3e85' # str | Unique correlation Id in a GUID format (optional)
    x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional)
    # example passing only required values which don't have defaults set
    try:
        # Delete a W9/W4/W8 form
        api_instance.delete_w9_form(id, avalara_version)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->delete_w9_form: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Delete a W9/W4/W8 form
        api_instance.delete_w9_form(id, avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->delete_w9_form: %s\n" % e)

Parameters

Name Type Description Notes
id str ID of the form to delete
avalara_version str API version
x_correlation_id str Unique correlation Id in a GUID format [optional]
x_avalara_client str Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Empty response -
401 Authentication failed -
404 W9/W4/W8 form not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_w9_form

CreateW9Form201Response get_w9_form(id, avalara_version)

Retrieve a W9/W4/W8 form

Retrieve a W9/W4/W8 form.

Example

  • Bearer Authentication (bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.A1099.V2 import forms_w9_api
CreateW9Form201Response
ErrorResponse
from pprint import pprint
    
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
    app_name='test app'
    app_version='1.0'
    machine_name='some machine'
    client_id='<Your Avalara Identity Client Id>'
    client_secret='<Your Avalara Identity Client Secret>'
    environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = forms_w9_api.FormsW9Api(api_client)
    id = 'id_example' # str | ID of the form
    avalara_version = '2.0.0' # str | API version
    x_correlation_id = '6923a86c-3ac5-4826-8b32-b6f5c04bd49b' # str | Unique correlation Id in a GUID format (optional)
    x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional)
    # example passing only required values which don't have defaults set
    try:
        # Retrieve a W9/W4/W8 form
        api_response = api_instance.get_w9_form(id, avalara_version)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->get_w9_form: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Retrieve a W9/W4/W8 form
        api_response = api_instance.get_w9_form(id, avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->get_w9_form: %s\n" % e)

Parameters

Name Type Description Notes
id str ID of the form
avalara_version str API version
x_correlation_id str Unique correlation Id in a GUID format [optional]
x_avalara_client str Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]

Return type

CreateW9Form201Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 W9/W4/W8 form with id -
401 Authentication failed -
404 W9/W4/W8 form not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_w9_form_pdf

bytearray get_w9_form_pdf(id, avalara_version)

Download the PDF for a W9/W4/W8 form.

Returns the PDF file for a W9/W4/W8 form.

Example

  • Bearer Authentication (bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.A1099.V2 import forms_w9_api
ErrorResponse
from pprint import pprint
    
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
    app_name='test app'
    app_version='1.0'
    machine_name='some machine'
    client_id='<Your Avalara Identity Client Id>'
    client_secret='<Your Avalara Identity Client Secret>'
    environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = forms_w9_api.FormsW9Api(api_client)
    id = 'id_example' # str | Id of the form
    avalara_version = '2.0.0' # str | API version
    x_correlation_id = 'f14992b5-c401-4059-a78e-5e4f4f389334' # str | Unique correlation Id in a GUID format (optional)
    x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional)
    # example passing only required values which don't have defaults set
    try:
        # Download the PDF for a W9/W4/W8 form.
        api_response = api_instance.get_w9_form_pdf(id, avalara_version)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->get_w9_form_pdf: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Download the PDF for a W9/W4/W8 form.
        api_response = api_instance.get_w9_form_pdf(id, avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->get_w9_form_pdf: %s\n" % e)

Parameters

Name Type Description Notes
id str Id of the form
avalara_version str API version
x_correlation_id str Unique correlation Id in a GUID format [optional]
x_avalara_client str Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]

Return type

bytearray

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/pdf, application/json

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
401 Unauthorized -
404 Not Found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_w9_forms

PaginatedQueryResultModelW9FormBaseResponse list_w9_forms(avalara_version)

List W9/W4/W8 forms

List W9/W4/W8 forms. Filterable/Sortable fields are: "companyId", "type", "displayName", "entryStatus", "email", "archived" and "referenceId".

Example

  • Bearer Authentication (bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.A1099.V2 import forms_w9_api
PaginatedQueryResultModelW9FormBaseResponse
ErrorResponse
from pprint import pprint
    
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
    app_name='test app'
    app_version='1.0'
    machine_name='some machine'
    client_id='<Your Avalara Identity Client Id>'
    client_secret='<Your Avalara Identity Client Secret>'
    environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = forms_w9_api.FormsW9Api(api_client)
    avalara_version = '2.0.0' # str | API version
    filter = 'filter_example' # str | A filter statement to identify specific records to retrieve.  For more information on filtering, see <a href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</a>. (optional)
    top = 56 # int | If zero or greater than 1000, return at most 1000 results.  Otherwise, return this number of results.  Used with skip to provide pagination for large datasets. (optional)
    skip = 56 # int | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets. (optional)
    order_by = 'order_by_example' # str | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. (optional)
    count = True # bool | If true, return the global count of elements in the collection. (optional)
    count_only = True # bool | If true, return ONLY the global count of elements in the collection.  It only applies when count=true. (optional)
    x_correlation_id = '99af27b9-a391-417e-a443-69f93286eb92' # str | Unique correlation Id in a GUID format (optional)
    x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional)
    # example passing only required values which don't have defaults set
    try:
        # List W9/W4/W8 forms
        api_response = api_instance.list_w9_forms(avalara_version)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->list_w9_forms: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List W9/W4/W8 forms
        api_response = api_instance.list_w9_forms(avalara_version, filter=filter, top=top, skip=skip, order_by=order_by, count=count, count_only=count_only, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->list_w9_forms: %s\n" % e)

Parameters

Name Type Description Notes
avalara_version str API version
filter str A filter statement to identify specific records to retrieve. For more information on filtering, see <a href=&quot;https://developer.avalara.com/avatax/filtering-in-rest/\&quot;&gt;Filtering in REST</a>. [optional]
top int If zero or greater than 1000, return at most 1000 results. Otherwise, return this number of results. Used with skip to provide pagination for large datasets. [optional]
skip int If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets. [optional]
order_by str A comma separated list of sort statements in the format (fieldname) [ASC DESC], for example id ASC.
count bool If true, return the global count of elements in the collection. [optional]
count_only bool If true, return ONLY the global count of elements in the collection. It only applies when count=true. [optional]
x_correlation_id str Unique correlation Id in a GUID format [optional]
x_avalara_client str Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]

Return type

PaginatedQueryResultModelW9FormBaseResponse

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 list -
400 Bad request (e.g., invalid sort key) -
401 Authentication failed -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

send_w9_form_email

CreateW9Form201Response send_w9_form_email(id, avalara_version)

Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form

Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form. If the form is not in 'Requested' status, it will either use an existing descendant form in 'Requested' status or create a new minimal form and send the email request.

Example

  • Bearer Authentication (bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.A1099.V2 import forms_w9_api
CreateW9Form201Response
ErrorResponse
from pprint import pprint
    
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
    app_name='test app'
    app_version='1.0'
    machine_name='some machine'
    client_id='<Your Avalara Identity Client Id>'
    client_secret='<Your Avalara Identity Client Secret>'
    environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = forms_w9_api.FormsW9Api(api_client)
    id = 'id_example' # str | The ID of the W9/W4/W8 form.
    avalara_version = '2.0.0' # str | API version
    x_correlation_id = 'af3f06c2-8e69-4ce1-b283-a387ea3e7763' # str | Unique correlation Id in a GUID format (optional)
    x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional)
    # example passing only required values which don't have defaults set
    try:
        # Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form
        api_response = api_instance.send_w9_form_email(id, avalara_version)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->send_w9_form_email: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form
        api_response = api_instance.send_w9_form_email(id, avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->send_w9_form_email: %s\n" % e)

Parameters

Name Type Description Notes
id str The ID of the W9/W4/W8 form.
avalara_version str API version
x_correlation_id str Unique correlation Id in a GUID format [optional]
x_avalara_client str Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]

Return type

CreateW9Form201Response

Authorization

bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Email sent using existing form (form was already in 'Requested' status or descendant found) -
201 Email sent using newly created minimal form -
400 Bad request (e.g., missing vendor e-mail) -
401 Authentication failed -
404 W9/W4/W8 form not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_w9_form

CreateW9Form201Response update_w9_form(id, avalara_version)

Update a W9/W4/W8 form

Update a W9/W4/W8 form.

Example

  • Bearer Authentication (bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.A1099.V2 import forms_w9_api
CreateW9FormRequest
CreateW9Form201Response
ErrorResponse
from pprint import pprint
    
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
    app_name='test app'
    app_version='1.0'
    machine_name='some machine'
    client_id='<Your Avalara Identity Client Id>'
    client_secret='<Your Avalara Identity Client Secret>'
    environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = forms_w9_api.FormsW9Api(api_client)
    id = 'id_example' # str | ID of the form to update
    avalara_version = '2.0.0' # str | API version
    x_correlation_id = '605a2261-2ae9-46f7-b597-d2e88867e827' # str | Unique correlation Id in a GUID format (optional)
    x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional)
    create_w9_form_request = {"type":"W9","name":"John Doe","businessName":"Acme Inc.","businessClassification":"Individual","businessOther":null,"foreignPartnerOwnerOrBeneficiary":false,"exemptPayeeCode":"5","exemptFatcaCode":"A","foreignCountryIndicator":false,"address":"123 Main St.","foreignAddress":null,"city":"Anytown","state":"CA","zip":"12345","accountNumber":"ACC123456","tinType":"SSN","tin":"543456789","backupWithholding":false,"is1099able":true,"eDeliveryConsentedAt":"2024-05-01T10:30:10.000000","signature":null,"referenceId":"REF12345","email":"johndoe@example.com"} # CreateW9FormRequest | Form to be updated (optional)
    # example passing only required values which don't have defaults set
    try:
        # Update a W9/W4/W8 form
        api_response = api_instance.update_w9_form(id, avalara_version)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->update_w9_form: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update a W9/W4/W8 form
        api_response = api_instance.update_w9_form(id, avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, create_w9_form_request=create_w9_form_request)
        pprint(api_response)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->update_w9_form: %s\n" % e)

Parameters

Name Type Description Notes
id str ID of the form to update
avalara_version str API version
x_correlation_id str Unique correlation Id in a GUID format [optional]
x_avalara_client str Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]
create_w9_form_request CreateW9FormRequest Form to be updated [optional]

Return type

CreateW9Form201Response

Authorization

bearer

HTTP request headers

  • Content-Type: application/json, text/json, application/*+json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 The updated W9/W4/W8 form -
400 Bad request (e.g., missing required field) -
401 Authentication failed -
404 W9/W4/W8 form not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

upload_w9_files

upload_w9_files(id, avalara_version)

Replace the PDF file for a W9/W4/W8 form

Replaces the PDF file for a W9/W4/W8 form.

Example

  • Bearer Authentication (bearer):
import time
import Avalara.SDK
from Avalara.SDK.api.A1099.V2 import forms_w9_api
ErrorResponse
from pprint import pprint
    
# Define configuration object with parameters specified to your application.
configuration = Avalara.SDK.Configuration(
    app_name='test app'
    app_version='1.0'
    machine_name='some machine'
    client_id='<Your Avalara Identity Client Id>'
    client_secret='<Your Avalara Identity Client Secret>'
    environment='sandbox'
)
# Enter a context with an instance of the API client
with Avalara.SDK.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = forms_w9_api.FormsW9Api(api_client)
    id = 'id_example' # str | Id of the form
    avalara_version = '2.0.0' # str | API version
    x_correlation_id = '57662456-54a0-47c9-a5c5-4fe315a77ae7' # str | Unique correlation Id in a GUID format (optional)
    x_avalara_client = 'Swagger UI; 22.1.0' # str | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . (optional)
    file = None # bytearray |  (optional)
    # example passing only required values which don't have defaults set
    try:
        # Replace the PDF file for a W9/W4/W8 form
        api_instance.upload_w9_files(id, avalara_version)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->upload_w9_files: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Replace the PDF file for a W9/W4/W8 form
        api_instance.upload_w9_files(id, avalara_version, x_correlation_id=x_correlation_id, x_avalara_client=x_avalara_client, file=file)
    except Avalara.SDK.ApiException as e:
        print("Exception when calling FormsW9Api->upload_w9_files: %s\n" % e)

Parameters

Name Type Description Notes
id str Id of the form
avalara_version str API version
x_correlation_id str Unique correlation Id in a GUID format [optional]
x_avalara_client str Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]
file bytearray [optional]

Return type

void (empty response body)

Authorization

bearer

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -
400 Bad request (e.g., only .pdf files are allowed.) -
401 Authentication failed -
404 W9/W4/W8 form not found -

[Back to top] [Back to API list] [Back to Model list] [Back to README]