Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# API Key for authentication
API_KEY=
1,665 changes: 843 additions & 822 deletions .manifest.json

Large diffs are not rendered by default.

904 changes: 457 additions & 447 deletions README.md

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions documentation/models/AccountDocumentDeleteResponseDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# AccountDocumentDeleteResponseDto

**Properties**

| Name | Type | Required | Description |
| :------ | :------ | :------- | :----------------------------------------- |
| deleted | Boolean | ❌ | Indicates whether the document was removed |
| id | String | ❌ | Unique document identifier in Asaas |

<!-- This file was generated by liblab | https://liblab.com/ -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# AccountDocumentGetResponseAccountDocumentStatus

Document approval status

**Properties**

| Name | Type | Required | Description |
| :------- | :----- | :------- | :---------- |
| NOT_SENT | String | ✅ | "NOT_SENT" |
| PENDING | String | ✅ | "PENDING" |
| APPROVED | String | ✅ | "APPROVED" |
| REJECTED | String | ✅ | "REJECTED" |

<!-- This file was generated by liblab | https://liblab.com/ -->
10 changes: 10 additions & 0 deletions documentation/models/AccountDocumentGetResponseDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# AccountDocumentGetResponseDto

**Properties**

| Name | Type | Required | Description |
| :----- | :---------------------------------------------- | :------- | :---------------------------------- |
| id | String | ❌ | Unique document identifier in Asaas |
| status | AccountDocumentGetResponseAccountDocumentStatus | ❌ | Document approval status |

<!-- This file was generated by liblab | https://liblab.com/ -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# AccountDocumentGroupResponseAccountDocumentStatus

Document group status

**Properties**

| Name | Type | Required | Description |
| :------- | :----- | :------- | :---------- |
| NOT_SENT | String | ✅ | "NOT_SENT" |
| PENDING | String | ✅ | "PENDING" |
| APPROVED | String | ✅ | "APPROVED" |
| REJECTED | String | ✅ | "REJECTED" |
| IGNORED | String | ✅ | "IGNORED" |

<!-- This file was generated by liblab | https://liblab.com/ -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# AccountDocumentGroupResponseAccountDocumentType

Type of documents

**Properties**

| Name | Type | Required | Description |
| :----------------------- | :----- | :------- | :------------------------- |
| IDENTIFICATION | String | ✅ | "IDENTIFICATION" |
| SOCIAL_CONTRACT | String | ✅ | "SOCIAL_CONTRACT" |
| ENTREPRENEUR_REQUIREMENT | String | ✅ | "ENTREPRENEUR_REQUIREMENT" |
| MINUTES_OF_ELECTION | String | ✅ | "MINUTES_OF_ELECTION" |
| CUSTOM | String | ✅ | "CUSTOM" |

<!-- This file was generated by liblab | https://liblab.com/ -->
19 changes: 19 additions & 0 deletions documentation/models/AccountDocumentGroupResponseDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# AccountDocumentGroupResponseDto

List of objects

**Properties**

| Name | Type | Required | Description |
| :-------------------------- | :------------------------------------------------ | :------- | :---------------------------------------------------------------------- |
| id | String | ❌ | Unique document group identifier in Asaas |
| status | AccountDocumentGroupResponseAccountDocumentStatus | ❌ | Document group status |
| type | AccountDocumentGroupResponseAccountDocumentType | ❌ | Type of documents |
| title | String | ❌ | Document group title |
| description | String | ❌ | Description |
| responsible | AccountDocumentResponsibleResponseDto | ❌ | Who is responsible for sending these documents |
| onboardingUrl | String | ❌ | URL for sending documents |
| onboardingUrlExpirationDate | String | ❌ | Expiration date of the URL for sending documents |
| documents | List\<AccountDocumentGetResponseDto\> | ❌ | Documents that have already been sent with their respective identifiers |

<!-- This file was generated by liblab | https://liblab.com/ -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# AccountDocumentResponsibleResponseAccountDocumentResponsibleType

Responsible type

**Properties**

| Name | Type | Required | Description |
| :----------------------------------- | :----- | :------- | :------------------------------------- |
| ALLOW_BANK_ACCOUNT_DEPOSIT_STATEMENT | String | ✅ | "ALLOW_BANK_ACCOUNT_DEPOSIT_STATEMENT" |
| ASAAS_ACCOUNT_OWNER_EMANCIPATION_AGE | String | ✅ | "ASAAS_ACCOUNT_OWNER_EMANCIPATION_AGE" |
| ASAAS_ACCOUNT_OWNER | String | ✅ | "ASAAS_ACCOUNT_OWNER" |
| ASSOCIATION | String | ✅ | "ASSOCIATION" |
| BANK_ACCOUNT_OWNER_EMANCIPATION_AGE | String | ✅ | "BANK_ACCOUNT_OWNER_EMANCIPATION_AGE" |
| BANK_ACCOUNT_OWNER | String | ✅ | "BANK_ACCOUNT_OWNER" |
| CUSTOM | String | ✅ | "CUSTOM" |
| DIRECTOR | String | ✅ | "DIRECTOR" |
| INDIVIDUAL_COMPANY | String | ✅ | "INDIVIDUAL_COMPANY" |
| LIMITED_COMPANY | String | ✅ | "LIMITED_COMPANY" |
| MEI | String | ✅ | "MEI" |
| PARTNER | String | ✅ | "PARTNER" |

<!-- This file was generated by liblab | https://liblab.com/ -->
12 changes: 12 additions & 0 deletions documentation/models/AccountDocumentResponsibleResponseDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AccountDocumentResponsibleResponseDto

Who is responsible for sending these documents

**Properties**

| Name | Type | Required | Description |
| :--- | :----------------------------------------------------------------------- | :------- | :--------------- |
| name | String | ❌ | Responsible name |
| type | List\<AccountDocumentResponsibleResponseAccountDocumentResponsibleType\> | ❌ | Responsible type |

<!-- This file was generated by liblab | https://liblab.com/ -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# AccountDocumentSaveRequestAccountDocumentType

Document Type

**Properties**

| Name | Type | Required | Description |
| :----------------------- | :----- | :------- | :------------------------- |
| IDENTIFICATION | String | ✅ | "IDENTIFICATION" |
| SOCIAL_CONTRACT | String | ✅ | "SOCIAL_CONTRACT" |
| ENTREPRENEUR_REQUIREMENT | String | ✅ | "ENTREPRENEUR_REQUIREMENT" |
| MINUTES_OF_ELECTION | String | ✅ | "MINUTES_OF_ELECTION" |
| CUSTOM | String | ✅ | "CUSTOM" |

<!-- This file was generated by liblab | https://liblab.com/ -->
10 changes: 10 additions & 0 deletions documentation/models/AccountDocumentSaveRequestDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# AccountDocumentSaveRequestDto

**Properties**

| Name | Type | Required | Description |
| :----------- | :-------------------------------------------- | :------- | :------------ |
| documentFile | byte[] | ❌ | File |
| type | AccountDocumentSaveRequestAccountDocumentType | ❌ | Document Type |

<!-- This file was generated by liblab | https://liblab.com/ -->
10 changes: 10 additions & 0 deletions documentation/models/AccountDocumentShowResponseDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# AccountDocumentShowResponseDto

**Properties**

| Name | Type | Required | Description |
| :------------ | :-------------------------------------- | :------- | :--------------------------------------- |
| rejectReasons | String | ❌ | Reason why account approval was rejected |
| data | List\<AccountDocumentGroupResponseDto\> | ❌ | List of objects |

<!-- This file was generated by liblab | https://liblab.com/ -->
9 changes: 9 additions & 0 deletions documentation/models/AccountDocumentUpdateRequestDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# AccountDocumentUpdateRequestDto

**Properties**

| Name | Type | Required | Description |
| :----------- | :----- | :------- | :---------- |
| documentFile | byte[] | ✅ | File |

<!-- This file was generated by liblab | https://liblab.com/ -->
14 changes: 14 additions & 0 deletions documentation/models/AccountGetResponseCompanyType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# AccountGetResponseCompanyType

Type of company (only when Legal Entity)

**Properties**

| Name | Type | Required | Description |
| :---------- | :----- | :------- | :------------ |
| MEI | String | ✅ | "MEI" |
| LIMITED | String | ✅ | "LIMITED" |
| INDIVIDUAL | String | ✅ | "INDIVIDUAL" |
| ASSOCIATION | String | ✅ | "ASSOCIATION" |

<!-- This file was generated by liblab | https://liblab.com/ -->
32 changes: 32 additions & 0 deletions documentation/models/AccountGetResponseDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# AccountGetResponseDto

**Properties**

| Name | Type | Required | Description |
| :----------------------- | :--------------------------------------------- | :------- | :----------------------------------------------------------------------------- |
| object | String | ❌ | Object type |
| id | String | ❌ | Unique subaccount identifier in Asaas |
| name | String | ❌ | Subaccount name |
| email | String | ❌ | Subaccount email |
| loginEmail | String | ❌ | Email for subaccount login, if not provided, the subaccount email will be used |
| phone | String | ❌ | Telephone |
| mobilePhone | String | ❌ | Cellphone |
| address | String | ❌ | Public place |
| addressNumber | String | ❌ | Address number |
| complement | String | ❌ | Address complement |
| province | String | ❌ | Neighborhood |
| postalCode | String | ❌ | Address zip code |
| cpfCnpj | String | ❌ | CPF or CNPJ of the subaccount owner |
| birthDate | String | ❌ | Date of birth (only for Individuals) |
| personType | AccountGetResponsePersonType | ❌ | Kind of person |
| companyType | AccountGetResponseCompanyType | ❌ | Type of company (only when Legal Entity) |
| city | Long | ❌ | Unique city identifier in Asaas |
| state | String | ❌ | State abbreviation (SP, RJ, SC, ...) |
| country | String | ❌ | Country (Fixed Brazil) |
| tradingName | String | ❌ | Display name (auto-populated) |
| site | String | ❌ | Url reffered to the subaccount |
| walletId | String | ❌ | Unique wallet identifier to split charges or transfer between Asaas accounts |
| accountNumber | AccountNumberDto | ❌ | Subaccount number in Asaas |
| commercialInfoExpiration | AccountInfoCommercialInfoExpirationResponseDto | ❌ | Information about the expiration of commercial data |

<!-- This file was generated by liblab | https://liblab.com/ -->
12 changes: 12 additions & 0 deletions documentation/models/AccountGetResponsePersonType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AccountGetResponsePersonType

Kind of person

**Properties**

| Name | Type | Required | Description |
| :------- | :----- | :------- | :---------- |
| JURIDICA | String | ✅ | "JURIDICA" |
| FISICA | String | ✅ | "FISICA" |

<!-- This file was generated by liblab | https://liblab.com/ -->
17 changes: 17 additions & 0 deletions documentation/models/AccountInfoCityDto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# AccountInfoCityDto

City information registered in your account

**Properties**

| Name | Type | Required | Description |
| :----------- | :------------------- | :------- | :----------------------------------- |
| object | String | ❌ | Object type |
| id | Long | ❌ | Unique city identifier in Asaas |
| ibgeCode | String | ❌ | IBGE Code |
| name | String | ❌ | City's name |
| districtCode | String | ❌ | District code |
| district | String | ❌ | District name |
| state | AccountInfoCityState | ❌ | State abbreviation (SP, RJ, SC, ...) |

<!-- This file was generated by liblab | https://liblab.com/ -->
37 changes: 37 additions & 0 deletions documentation/models/AccountInfoCityState.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# AccountInfoCityState

State abbreviation (SP, RJ, SC, ...)

**Properties**

| Name | Type | Required | Description |
| :--- | :----- | :------- | :---------- |
| AC | String | ✅ | "AC" |
| AL | String | ✅ | "AL" |
| AP | String | ✅ | "AP" |
| AM | String | ✅ | "AM" |
| BA | String | ✅ | "BA" |
| CE | String | ✅ | "CE" |
| DF | String | ✅ | "DF" |
| ES | String | ✅ | "ES" |
| GO | String | ✅ | "GO" |
| MA | String | ✅ | "MA" |
| MT | String | ✅ | "MT" |
| MS | String | ✅ | "MS" |
| MG | String | ✅ | "MG" |
| PA | String | ✅ | "PA" |
| PB | String | ✅ | "PB" |
| PR | String | ✅ | "PR" |
| PE | String | ✅ | "PE" |
| PI | String | ✅ | "PI" |
| RR | String | ✅ | "RR" |
| RO | String | ✅ | "RO" |
| RJ | String | ✅ | "RJ" |
| RN | String | ✅ | "RN" |
| RS | String | ✅ | "RS" |
| SC | String | ✅ | "SC" |
| SP | String | ✅ | "SP" |
| SE | String | ✅ | "SE" |
| TO | String | ✅ | "TO" |

<!-- This file was generated by liblab | https://liblab.com/ -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# AccountInfoCommercialInfoExpirationResponseDto

Information about the expiration of commercial data

**Properties**

| Name | Type | Required | Description |
| :------------ | :------ | :------- | :--------------------------------------------- |
| isExpired | Boolean | ❌ | Informs if commercial data is expired |
| scheduledDate | String | ❌ | Informs the expiration date of commercial data |

<!-- This file was generated by liblab | https://liblab.com/ -->
14 changes: 14 additions & 0 deletions documentation/models/AccountInfoGetResponseCompanyType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# AccountInfoGetResponseCompanyType

Type of company (only when Legal Entity)

**Properties**

| Name | Type | Required | Description |
| :---------- | :----- | :------- | :------------ |
| MEI | String | ✅ | "MEI" |
| LIMITED | String | ✅ | "LIMITED" |
| INDIVIDUAL | String | ✅ | "INDIVIDUAL" |
| ASSOCIATION | String | ✅ | "ASSOCIATION" |

<!-- This file was generated by liblab | https://liblab.com/ -->
Loading