Skip to content

Issuers1099Api.md

Latest commit

 

History

History
458 lines (349 loc) · 19.3 KB

Issuers1099Api.md

File metadata and controls

458 lines (349 loc) · 19.3 KB
Raw

Issuers1099Api

All URIs are relative to https://api-ava1099.edge.qa.us-east-1.aws.avalara.io/avalara1099

Method HTTP request Description
createIssuer POST /1099/issuers Create an issuer
deleteIssuer DELETE /1099/issuers/{id} Delete an issuer
getIssuer GET /1099/issuers/{id} Retrieve an issuer
getIssuers GET /1099/issuers List issuers
updateIssuer PUT /1099/issuers/{id} Update an issuer

createIssuer

IssuerWriteResponse createIssuer(avalaraVersion, xCorrelationId, xAvalaraClient, issuerRequest)

Create an issuer

Create an issuer (also known as a Payer).

Example

// Import classes:
import Avalara.SDK.ApiClient;
import Avalara.SDK.ApiException;
import Avalara.SDK.Configuration;
import Avalara.SDK.auth.*;
import Avalara.SDK.models.*;
import Avalara.SDK.api.A1099.V2.Issuers1099Api;

public class Example {
    public static void main(String[] args) {
        Configuration configuration = new Configuration();
        configuration.setAppName("Test");
        configuration.setAppVersion("1.0");
        configuration.setMachineName("LocalBox");
        configuration.setTimeout(5000);
        configuration.setEnvironment(AvaTaxEnvironment.Sandbox);
        // Configure HTTP basic authorization
        configuration.setUsername("YOUR USERNAME");
        configuration.setPassword("YOUR PASSWORD");
        // Configure OAuth2 access token for authorization
        configuration.setBearerToken("YOUR ACCESS TOKEN");
        
        ApiClient apiClient = new ApiClient(configuration);

        Issuers1099Api apiInstance = new Issuers1099Api(apiClient);
        String avalaraVersion = "2.0.0"; // String | API version
        String xCorrelationId = "14e92c5a-0e21-4dcd-8e3f-59111c335ba3"; // String | Unique correlation Id in a GUID format
        String xAvalaraClient = "Swagger UI; 22.1.0"; // String | 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/) .
        IssuerRequest issuerRequest = new IssuerRequest(); // IssuerRequest | The issuer to create
        try {
            IssuerWriteResponse result = apiInstance.createIssuer(avalaraVersion, xCorrelationId, xAvalaraClient, issuerRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Issuers1099Api#createIssuer");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
avalaraVersion String API version
xCorrelationId String Unique correlation Id in a GUID format [optional]
xAvalaraClient String Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]
issuerRequest IssuerRequest The issuer to create [optional]

Return type

IssuerWriteResponse

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 Created issuer -
400 Bad request (e.g., invalid sort key) -
401 Authentication failed -

deleteIssuer

deleteIssuer(id, avalaraVersion, xCorrelationId, xAvalaraClient)

Delete an issuer

Delete an issuer (also known as a Payer).

Example

// Import classes:
import Avalara.SDK.ApiClient;
import Avalara.SDK.ApiException;
import Avalara.SDK.Configuration;
import Avalara.SDK.auth.*;
import Avalara.SDK.models.*;
import Avalara.SDK.api.A1099.V2.Issuers1099Api;

public class Example {
    public static void main(String[] args) {
        Configuration configuration = new Configuration();
        configuration.setAppName("Test");
        configuration.setAppVersion("1.0");
        configuration.setMachineName("LocalBox");
        configuration.setTimeout(5000);
        configuration.setEnvironment(AvaTaxEnvironment.Sandbox);
        // Configure HTTP basic authorization
        configuration.setUsername("YOUR USERNAME");
        configuration.setPassword("YOUR PASSWORD");
        // Configure OAuth2 access token for authorization
        configuration.setBearerToken("YOUR ACCESS TOKEN");
        
        ApiClient apiClient = new ApiClient(configuration);

        Issuers1099Api apiInstance = new Issuers1099Api(apiClient);
        String id = "id_example"; // String | Id of the issuer to delete
        String avalaraVersion = "2.0.0"; // String | API version
        String xCorrelationId = "cc721fe4-7f1e-4228-87d2-9351c780d9e9"; // String | Unique correlation Id in a GUID format
        String xAvalaraClient = "Swagger UI; 22.1.0"; // String | 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/) .
        try {
            apiInstance.deleteIssuer(id, avalaraVersion, xCorrelationId, xAvalaraClient);
        } catch (ApiException e) {
            System.err.println("Exception when calling Issuers1099Api#deleteIssuer");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id String Id of the issuer to delete
avalaraVersion String API version
xCorrelationId String Unique correlation Id in a GUID format [optional]
xAvalaraClient String Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]

Return type

null (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 -
400 Bad request (e.g., invalid sort key) -
401 Authentication failed -

getIssuer

IssuerResponse getIssuer(id, avalaraVersion, xCorrelationId, xAvalaraClient)

Retrieve an issuer

Retrieve an issuer (also known as a Payer).

Example

// Import classes:
import Avalara.SDK.ApiClient;
import Avalara.SDK.ApiException;
import Avalara.SDK.Configuration;
import Avalara.SDK.auth.*;
import Avalara.SDK.models.*;
import Avalara.SDK.api.A1099.V2.Issuers1099Api;

public class Example {
    public static void main(String[] args) {
        Configuration configuration = new Configuration();
        configuration.setAppName("Test");
        configuration.setAppVersion("1.0");
        configuration.setMachineName("LocalBox");
        configuration.setTimeout(5000);
        configuration.setEnvironment(AvaTaxEnvironment.Sandbox);
        // Configure HTTP basic authorization
        configuration.setUsername("YOUR USERNAME");
        configuration.setPassword("YOUR PASSWORD");
        // Configure OAuth2 access token for authorization
        configuration.setBearerToken("YOUR ACCESS TOKEN");
        
        ApiClient apiClient = new ApiClient(configuration);

        Issuers1099Api apiInstance = new Issuers1099Api(apiClient);
        String id = "id_example"; // String | Id of the issuer to retrieve
        String avalaraVersion = "2.0.0"; // String | API version
        String xCorrelationId = "1c49f829-d029-4e67-8d87-c87a83033413"; // String | Unique correlation Id in a GUID format
        String xAvalaraClient = "Swagger UI; 22.1.0"; // String | 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/) .
        try {
            IssuerResponse result = apiInstance.getIssuer(id, avalaraVersion, xCorrelationId, xAvalaraClient);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Issuers1099Api#getIssuer");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id String Id of the issuer to retrieve
avalaraVersion String API version
xCorrelationId String Unique correlation Id in a GUID format [optional]
xAvalaraClient String Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]

Return type

IssuerResponse

Authorization

bearer

HTTP request headers

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

HTTP response details

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

getIssuers

PaginatedQueryResultModelIssuerResponse getIssuers(avalaraVersion, $filter, $top, $skip, $orderBy, count, countOnly, xCorrelationId, xAvalaraClient)

List issuers

List issuers (also known as Payers). Filterable fields are businessName, businessName2, referenceId, taxYear, firstName, and lastName.

Example

// Import classes:
import Avalara.SDK.ApiClient;
import Avalara.SDK.ApiException;
import Avalara.SDK.Configuration;
import Avalara.SDK.auth.*;
import Avalara.SDK.models.*;
import Avalara.SDK.api.A1099.V2.Issuers1099Api;

public class Example {
    public static void main(String[] args) {
        Configuration configuration = new Configuration();
        configuration.setAppName("Test");
        configuration.setAppVersion("1.0");
        configuration.setMachineName("LocalBox");
        configuration.setTimeout(5000);
        configuration.setEnvironment(AvaTaxEnvironment.Sandbox);
        // Configure HTTP basic authorization
        configuration.setUsername("YOUR USERNAME");
        configuration.setPassword("YOUR PASSWORD");
        // Configure OAuth2 access token for authorization
        configuration.setBearerToken("YOUR ACCESS TOKEN");
        
        ApiClient apiClient = new ApiClient(configuration);

        Issuers1099Api apiInstance = new Issuers1099Api(apiClient);
        String avalaraVersion = "2.0.0"; // String | API version
        String $filter = "taxYear eq 2025"; // String | 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>.
        Integer $top = 56; // Integer | 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.
        Integer $skip = 56; // Integer | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets.
        String $orderBy = "$orderBy_example"; // String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
        Boolean count = true; // Boolean | If true, return the global count of elements in the collection.
        Boolean countOnly = true; // Boolean | If true, return ONLY the global count of elements in the collection.  It only applies when count=true.
        String xCorrelationId = "7845d8ad-09ab-4ba4-a644-bc06bcb806b0"; // String | Unique correlation Id in a GUID format
        String xAvalaraClient = "Swagger UI; 22.1.0"; // String | 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/) .
        try {
            PaginatedQueryResultModelIssuerResponse result = apiInstance.getIssuers(avalaraVersion, $filter, $top, $skip, $orderBy, count, countOnly, xCorrelationId, xAvalaraClient);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Issuers1099Api#getIssuers");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
avalaraVersion String API version
$filter String 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 Integer 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 Integer If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets. [optional]
$orderBy String A comma separated list of sort statements in the format (fieldname) [ASC DESC], for example id ASC.
count Boolean If true, return the global count of elements in the collection. [optional]
countOnly Boolean If true, return ONLY the global count of elements in the collection. It only applies when count=true. [optional]
xCorrelationId String Unique correlation Id in a GUID format [optional]
xAvalaraClient String Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]

Return type

PaginatedQueryResultModelIssuerResponse

Authorization

bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 List of issuers -
400 Bad request (e.g., invalid sort key) -
404 Not Found -
500 Server Error -
401 Authentication failed -

updateIssuer

IssuerWriteResponse updateIssuer(id, avalaraVersion, xCorrelationId, xAvalaraClient, issuerRequest)

Update an issuer

Update an issuer (also known as a Payer). When the payload violates field-level business rules, the issuer is still persisted and the response body includes a `validationErrors[]` array describing each violation.

Example

// Import classes:
import Avalara.SDK.ApiClient;
import Avalara.SDK.ApiException;
import Avalara.SDK.Configuration;
import Avalara.SDK.auth.*;
import Avalara.SDK.models.*;
import Avalara.SDK.api.A1099.V2.Issuers1099Api;

public class Example {
    public static void main(String[] args) {
        Configuration configuration = new Configuration();
        configuration.setAppName("Test");
        configuration.setAppVersion("1.0");
        configuration.setMachineName("LocalBox");
        configuration.setTimeout(5000);
        configuration.setEnvironment(AvaTaxEnvironment.Sandbox);
        // Configure HTTP basic authorization
        configuration.setUsername("YOUR USERNAME");
        configuration.setPassword("YOUR PASSWORD");
        // Configure OAuth2 access token for authorization
        configuration.setBearerToken("YOUR ACCESS TOKEN");
        
        ApiClient apiClient = new ApiClient(configuration);

        Issuers1099Api apiInstance = new Issuers1099Api(apiClient);
        String id = "id_example"; // String | Id of the issuer to update
        String avalaraVersion = "2.0.0"; // String | API version
        String xCorrelationId = "484d0024-b885-4e06-aac7-bf3ab4daba3b"; // String | Unique correlation Id in a GUID format
        String xAvalaraClient = "Swagger UI; 22.1.0"; // String | 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/) .
        IssuerRequest issuerRequest = new IssuerRequest(); // IssuerRequest | The issuer to update
        try {
            IssuerWriteResponse result = apiInstance.updateIssuer(id, avalaraVersion, xCorrelationId, xAvalaraClient, issuerRequest);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Issuers1099Api#updateIssuer");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id String Id of the issuer to update
avalaraVersion String API version
xCorrelationId String Unique correlation Id in a GUID format [optional]
xAvalaraClient String Identifies the software you are using to call this API. For more information on the client header, see Client Headers . [optional]
issuerRequest IssuerRequest The issuer to update [optional]

Return type

IssuerWriteResponse

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 Issuer updated. Body may contain `validationErrors[]` when business rules failed. -
400 Invalid id format, malformed JSON, or identity change rejected for an issuer with scheduled Forms 1099 (TIN, TIN type, or name are immutable in that case). -
401 Unauthorized -
403 Caller does not have access to this issuer. -
404 Issuer not found. -