Skip to content

AccountDocumentService.md

Latest commit

 

History

History
240 lines (169 loc) · 8 KB

AccountDocumentService.md

File metadata and controls

240 lines (169 loc) · 8 KB

AccountDocumentService

A list of all methods in the AccountDocumentService service. Click on the method name to view detailed information about that method.

Methods Description
checkPendingDocuments
sendDocumentsViaApi
viewDocumentSent
updateSentDocument
removeSentDocument

checkPendingDocuments

  • HTTP Method: GET
  • Endpoint: /v3/myAccount/documents

Return Type

ApiAccountDocumentShowResponseDto

Example Usage Code Snippet

import com.asaas.apisdk.AsaasSdk;
import com.asaas.apisdk.config.ApiKeyAuthConfig;
import com.asaas.apisdk.config.AsaasSdkConfig;
import com.asaas.apisdk.models.ApiAccountDocumentShowResponseDto;

public class Main {

  public static void main(String[] args) {
    AsaasSdkConfig config = AsaasSdkConfig.builder()
      .apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
      .build();

    AsaasSdk asaasSdk = new AsaasSdk(config);

    ApiAccountDocumentShowResponseDto response = asaasSdk.accountDocument.checkPendingDocuments();

    System.out.println(response);
  }
}

sendDocumentsViaApi

  • HTTP Method: POST
  • Endpoint: /v3/myAccount/documents/{id}

Parameters

Name Type Required Description
id String ✅ Unique document identifier in Asaas
apiAccountDocumentSaveRequestDto ApiAccountDocumentSaveRequestDto ❌ Request Body
_filename String ✅ Filename for the uploaded file

Return Type

ApiAccountDocumentGetResponseDto

Example Usage Code Snippet

import com.asaas.apisdk.AsaasSdk;
import com.asaas.apisdk.config.ApiKeyAuthConfig;
import com.asaas.apisdk.config.AsaasSdkConfig;
import com.asaas.apisdk.models.ApiAccountDocumentGetResponseDto;
import com.asaas.apisdk.models.ApiAccountDocumentSaveRequestCustomerDocumentType;
import com.asaas.apisdk.models.ApiAccountDocumentSaveRequestDto;

public class Main {
    public static void main(String[] args) {
		AsaasSdkConfig config = AsaasSdkConfig.builder()
			.apiKeyAuthConfig(
				ApiKeyAuthConfig.builder()
					.apiKey("YOUR_API_KEY")
					.build()
			)
			.build();

		AsaasSdk asaasSdk = new AsaasSdk(config);

		ApiAccountDocumentSaveRequestDto apiAccountDocumentSaveRequestDto = ApiAccountDocumentSaveRequestDto.builder()
			.documentFile(ut Ut )
			.type(ApiAccountDocumentSaveRequestCustomerDocumentType.IDENTIFICATION)
			.build();
		ApiAccountDocumentSaveRequestDto apiAccountDocumentSaveRequestDto = ApiAccountDocumentSaveRequestDto.builder()
			.documentFile(ut Ut )
			.type(ApiAccountDocumentSaveRequestCustomerDocumentType.IDENTIFICATION)
			.build();

		ApiAccountDocumentGetResponseDto response = asaasSdk.accountDocument.sendDocumentsViaApi("8d257732-2220-11ec-b695-b6af4a64184d", apiAccountDocumentSaveRequestDto, apiAccountDocumentSaveRequestDto);

		System.out.println(response);
    }
}

viewDocumentSent

  • HTTP Method: GET
  • Endpoint: /v3/myAccount/documents/files/{id}

Parameters

Name Type Required Description
id String ✅ Unique document identifier in Asaas

Return Type

ApiAccountDocumentGetResponseDto

Example Usage Code Snippet

import com.asaas.apisdk.AsaasSdk;
import com.asaas.apisdk.config.ApiKeyAuthConfig;
import com.asaas.apisdk.config.AsaasSdkConfig;
import com.asaas.apisdk.models.ApiAccountDocumentGetResponseDto;

public class Main {

  public static void main(String[] args) {
    AsaasSdkConfig config = AsaasSdkConfig.builder()
      .apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
      .build();

    AsaasSdk asaasSdk = new AsaasSdk(config);

    ApiAccountDocumentGetResponseDto response = asaasSdk.accountDocument.viewDocumentSent(
      "8d257732-2220-11ec-b695-b6af4a64184d"
    );

    System.out.println(response);
  }
}

updateSentDocument

  • HTTP Method: POST
  • Endpoint: /v3/myAccount/documents/files/{id}

Parameters

Name Type Required Description
id String ✅ Unique document identifier in Asaas
apiAccountDocumentUpdateRequestDto ApiAccountDocumentUpdateRequestDto ❌ Request Body
_filename String ✅ Filename for the uploaded file

Return Type

ApiAccountDocumentGetResponseDto

Example Usage Code Snippet

import com.asaas.apisdk.AsaasSdk;
import com.asaas.apisdk.config.ApiKeyAuthConfig;
import com.asaas.apisdk.config.AsaasSdkConfig;
import com.asaas.apisdk.models.ApiAccountDocumentGetResponseDto;
import com.asaas.apisdk.models.ApiAccountDocumentUpdateRequestDto;

public class Main {

  public static void main(String[] args) {
    AsaasSdkConfig config = AsaasSdkConfig.builder()
      .apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
      .build();

    AsaasSdk asaasSdk = new AsaasSdk(config);

    ApiAccountDocumentUpdateRequestDto apiAccountDocumentUpdateRequestDto = ApiAccountDocumentUpdateRequestDto.builder()
      .documentFile(sintl)
      .build();
    ApiAccountDocumentUpdateRequestDto apiAccountDocumentUpdateRequestDto = ApiAccountDocumentUpdateRequestDto.builder()
      .documentFile(sintl)
      .build();

    ApiAccountDocumentGetResponseDto response = asaasSdk.accountDocument.updateSentDocument(
      "8d257732-2220-11ec-b695-b6af4a64184d",
      apiAccountDocumentUpdateRequestDto,
      apiAccountDocumentUpdateRequestDto
    );

    System.out.println(response);
  }
}

removeSentDocument

  • HTTP Method: DELETE
  • Endpoint: /v3/myAccount/documents/files/{id}

Parameters

Name Type Required Description
id String ✅ Unique document identifier in Asaas

Return Type

ApiAccountDocumentDeleteResponseDto

Example Usage Code Snippet

import com.asaas.apisdk.AsaasSdk;
import com.asaas.apisdk.config.ApiKeyAuthConfig;
import com.asaas.apisdk.config.AsaasSdkConfig;
import com.asaas.apisdk.models.ApiAccountDocumentDeleteResponseDto;

public class Main {

  public static void main(String[] args) {
    AsaasSdkConfig config = AsaasSdkConfig.builder()
      .apiKeyAuthConfig(ApiKeyAuthConfig.builder().apiKey("YOUR_API_KEY").build())
      .build();

    AsaasSdk asaasSdk = new AsaasSdk(config);

    ApiAccountDocumentDeleteResponseDto response = asaasSdk.accountDocument.removeSentDocument(
      "8d257732-2220-11ec-b695-b6af4a64184d"
    );

    System.out.println(response);
  }
}