Requests and Responses
Here we have the descriptions and details of the fields used in our API requests and responses.
Organizations API
The following fields can be used to manage the Organizations API.
Field | Type | Description |
---|---|---|
| String (UUID) | The unique identifier of the Organization. |
| String (UUID) | The unique identifier of the parent Organization.
Note: The
|
| String | The legal name of the Organization. Maxlength: 256 |
| String | The trade name of the Organization. Maxlength: 256 |
| String | The document of the Organization. (CNPJ in Brazil, EIN in the US, and so on.) Maxlength: 256 |
| An object containing information about the address. | |
| An object containing metadata information. | |
| An object containing information about the status. | |
| DateTime | The time when the Organization was created. |
| DateTime | The last time that the Organization was updated. |
| DateTime | The time when the Organization was deleted. |
Ledgers API
The following fields can be used to manage the Ledgers API.
Field | Type | Description |
---|---|---|
| String (UUID) | The unique identifier of the Ledger. |
| String | The name of the Ledger. Maxlength: 256 |
| String (UUID) | The unique identifier of the associated Organization. |
| An object containing information about the status. | |
| DateTime | The time when the Ledger was created. |
| DateTime | The last time that the Ledger was updated. |
| DateTime | The time when the Ledger was deleted. |
| An object containing metadata information. |
Assets API
The following fields can be used to manage the Assets API.
| String (UUID) | The unique identifier of the Asset. |
| String | Name of the Asset. |
| String (UUID) | Ledger's identification code. |
| String | The type of Asset. |
| String | The code that identifies the Asset. |
| An object containing information about the Asset status. | |
| DateTime | The time when the Asset was created. |
| DateTime | The time when the Asset was created. |
| DateTime | The time when the Asset was deleted. |
| An object containing metadata information. |
Products API
The following fields can be used to manage the Products API.
Field | Type | Description |
---|---|---|
| String (UUID) | The unique identifier of the Product. |
| String | Name of the Product. Maxlenght: 256 |
| String (UUID) | The unique identifier of the Ledger. |
| String (UUID) | The unique identifier of the Organization. |
| An object containing information about the product status. | |
| String (UUID) | The unique identifier of the Ledger. |
| DateTime | The time that the Product was created. |
| DateTime | The last time that the Product was updated. |
| DateTime | The time when the Product was deleted. |
Portfolios API
The following fields can be used to manage the Portfolio API.
Field | Type | Description |
---|---|---|
| String (UUID) | The unique identifier of the Portfolio. |
| String | Name of the Portfolio. Maxlength: 256 |
| String | The identifier of the Entity. Maxlength: 256 |
| String (UUID) | The unique identifier of the Ledger. |
| String (UUID) | The unique identifier of the Organization. |
| An object containing information about the portfolio status. | |
| DateTime | The time when the Portfolio was created. |
| DateTime | The last time that the Portfolio was updated. |
| DateTime | The time when the Portfolio was deleted. |
Accounts API
The following fields can be used to manage the Accounts API.
Field | Type | Description |
---|---|---|
| String (UUID) | The unique identifier of the Account. |
| String | Name of the Account. Maxlength: 256 |
| String (UUID) | The unique identifier of the parent account. This field will be null if the account does not have a parent account. |
| String | The identifier of the Entity. Maxlength: 256 |
| String | The code of the Asset. Maxlength: 100 |
| String (UUID) | The unique identifier of the Organization. |
| String (UUID) | Ledger's identification code. |
| String (UUID) | The unique identifier of the Portfolio. |
| String (UUID) | The unique identifier of the product. |
| An object containing information about the balance. | |
| An object containing information about the account status. | |
| String | An alias used to identify the person responsible for the account. Maxlength: 100 |
| String | The type of account.
Possible values: |
| DateTime | The time when the Account was created. |
| DateTime | The last time that the Account was updated. |
| DateTime | The time when the Account was deleted. |
Assets rates API
Field | Type | Description |
---|---|---|
| String (UUID) | The unique identifier of the Asset Rate. |
| String | The asset code of the asset the first asset that is part of the Asset Rate pair. |
| String | The asset code of the asset the second asset that is part of the Asset Rate pair. |
| Integer | The amount that will be used as the rate. |
| Integer | The number of decimal points that will be used to display the amount. |
| String | The source of the assets that will be in the asset rate. Maxlength: 100 |
| An object containing information about the account status. | |
| An object containing metadata information. | |
| String (UUID) | Ledger's identification code. |
| String (UUID) | The unique identifier of the Organization. |
| DateTime | The time when the Asset rate was created. |
| DateTime | The last time that the Asset rate was updated. |
| DateTime | The time when the Asset rate was deleted. |
Transactions API
Field | Type | Description |
---|---|---|
| String (UUID) | The unique identifier of the transaction. |
| String (UUID) | The unique identifier of the parent transaction. NOTE: This field will be null if it does not have a parent transaction. |
| String (UUID) | The unique identifier of the associated Ledger. |
| String (UUID) | The unique identifier of the associated Organization. |
| String | A brief description of the transaction. Maxlength: 256 |
| String | The type of transaction. Maxlength: 100 |
| String | The status of the transaction. Maxlength: 100 |
| An object contaning information about the amount. | |
| String | The code of the asset used in the transaction. Maxlength: 100 |
| String | The name of the group to which the Chart Of Accounts belongs. Maxlength: 256 |
| Array | A list containing the names of the source accounts. |
| Array | A list containing the names of the destination accounts. |
| Boolean | If true, it indicates that the transaction operations will inherit the metadata of the transaction. |
| Boolean | If true, it indicates that the transaction operations will inherit the description of the transaction. |
| A list containing the details of the operations involved in the transaction. | |
| DateTime | The date when the transaction was created. |
| DateTime | The date when the transaction was last updated. |
Operations API
Field | Type | Description |
---|---|---|
| String (UUID) | The unique identifier of the operation. |
t | String (UUID) | The unique identifier of the transaction associated with the operation. |
| String (UUID) | The unique identifier of the associated Ledger. |
| String (UUID) | The unique identifier of the associated Organization. |
| String | A brief description of the operation. Maxlength: 256 |
| String | The type of operation. Maxlength: 100 |
| String | The code of the asset used in the transaction. Maxlength: 100 |
| String | The name of the associated Chart Of Accounts. Maxlength: 100 |
| An object contaning information about the amount. | |
| An object containing information about the balance before the operation. | |
| An object containing information about the balance after the operation. | |
| String (UUID) | The unique identifier of the Account used in the transaction. |
| String | The alias of the Account used in the transaction. Maxlength: 100 |
| String (UUID) | The unique identifier of the associated Portfolio. |
| DateTime | The date when the operation was created. |
| DateTime | The date when the operation was last updated. |
Charts API
Field | Type | Description |
---|---|---|
Objects
address object
Name | Type | Description |
---|---|---|
| String | The first line of the address. |
| String | The second line of the address with any complement. |
| String | The area located within a city. |
| String | The postal code using only numbers. |
| String | The name of the city. |
| String | Two letters that represent the State. |
| String | Two letters code of the country in ISO 3166-1 alpha2 format. |
status object
Field | Type | Description |
---|---|---|
| String | The status. Maxlength: 100 |
| String | The description of the status. Maxlength: 256 |
| Boolean | If true, it indicates that the account can send transactions. NOTE: Used only for accounts. |
| Boolean | If true, it indicates that the account can receive transactions. NOTE: Used only for accounts. |
metadata object
Field | Type | Description |
---|---|---|
| String | |
| String | |
| String | |
| String | |
| String |
balance object
Field | Type | Description |
---|---|---|
| Integer | The amount available in the balance. |
| Integer | The amount that is on hold. |
| Integer | The number of decimal points that will be used to display the balance. |
balanceAfter object
Field | Type | Description |
---|---|---|
| Integer | The amount available in the balance after the operation is performed. |
| Integer | The amount that is on hold after the operation is performed. |
| Integer | The number of decimal points that will be used to display the balance after the operation is performed. |
amount object
Field | Type | Description |
---|---|---|
| Integer | The amount of the transaction. |
| Integer | The number of decimal points that will be used to display the amount. |
Last updated