Walletguide API (1.0.0)

Download OpenAPI specification:

Walletguide: support@walletguide.com URL: https://walletguide.com

API for the Walletguide app

Assets

Asset related endpoints

Get assets

Get all assets

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"access": "fixed",
"assetGroupId": "string",
"archived": true,
"expectedAnnualReturn": 0,
"order": 0,
"createdTime": "2019-08-24T14:15:22Z",
"createdUserId": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"lastUpdatedUserId": "string",
"defaultCurrency": "EUR",
"defaultCategoryId": "string",
"type": "manualBank",
"accountNumber": "string",
"importSettings": {"csv": null
},
"id": "string"
}
]

Get asset

Get an asset by id

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

null

Asset groups

Asset group related endpoints

Get asset groups

Get all asset groups

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"archived": true,
"order": 0,
"createdTime": "2019-08-24T14:15:22Z",
"createdUserId": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"lastUpdatedUserId": "string",
"id": "string"
}
]

Get asset group

Get an asset group by id

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

null

Transactions

Transaction related endpoints

Get transactions

Get all transactions

Authorizations:

bearerAuthbasicAuth

query Parameters

startDate	string <date> ^((\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|...
endDate	string <date> ^((\d\d[2468][048]\|\d\d[13579][26]\|\d\d0[48]\|...
assetId	string

Responses

Response samples

200

Content type

application/json

[{"assetId": "string",
"date": "2019-08-24",
"fromTo": "string",
"description": "string",
"amount": {"value": 0,
"currency": "EUR"
},
"categoryId": "string",
"merchantId": "string",
"merchantAutoAssigned": true,
"merchantCheckedGoogleMaps": true,
"merchantCheckedBingWebSearch": true,
"excludeFromMerchantAutoAssignment": true,
"usingDateRule": "transactionDate",
"usingStartDate": "2019-08-24",
"usingEndDate": "2019-08-24",
"notes": "string",
"parentTransactionId": "string",
"parent": true,
"source": "string",
"assignedUserId": "string",
"counterTransactionId": "string",
"counterAssetId": "string",
"gocardlessTransactionId": "string",
"gocardlessInternalTransactionId": "string",
"finApiTransactionId": 0,
"tagIds": ["string"
],
"pending": true,
"reviewed": true,
"createdTime": "2019-08-24T14:15:22Z",
"createdUserId": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"lastUpdatedUserId": "string",
"id": "string"
}
]

Get transaction

Get a transaction by id

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

null

Crypto transactions

Crypto transaction related endpoints

Get crypto transactions

Get all crypto transactions

Authorizations:

bearerAuthbasicAuth

query Parameters

assetId

string

Responses

Response samples

200

Content type

application/json

[{"date": "2019-08-24",
"assetId": "string",
"type": "initialBalance",
"cryptoCurrency": "BTC",
"quantity": 0,
"categoryId": "string",
"price": {"value": 0,
"currency": "EUR"
},
"fees": {"value": 0,
"currency": "EUR"
},
"tax": {"value": 0,
"currency": "EUR"
},
"notes": "string",
"createdTime": "2019-08-24T14:15:22Z",
"createdUserId": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"lastUpdatedUserId": "string",
"id": "string"
}
]

Get crypto transaction

Get a crypto transaction by id

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

null

Security transactions

Security transaction related endpoints

Get security transactions

Get all security transactions

Authorizations:

bearerAuthbasicAuth

query Parameters

assetId

string

Responses

Response samples

200

Content type

application/json

[{"date": "string",
"isin": "string",
"quantity": 0,
"price": {"value": 0,
"currency": "EUR"
},
"fees": {"value": 0,
"currency": "EUR"
},
"tax": {"value": 0,
"currency": "EUR"
},
"assetId": "string",
"type": "initialBalance",
"categoryId": "string",
"notes": "string",
"createdTime": "2019-08-24T14:15:22Z",
"createdUserId": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"lastUpdatedUserId": "string",
"id": "string"
}
]

Get security transaction

Get a security transaction by id

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

null

Total value updates

Total value update related endpoints

Get total value updates

Get all total value updates

Authorizations:

bearerAuthbasicAuth

query Parameters

assetId

string

Responses

Response samples

200

Content type

application/json

[{"date": "2019-08-24",
"assetId": "string",
"amount": {"value": 0,
"currency": "EUR"
},
"notes": "string",
"initialBalance": true,
"source": "finapi",
"createdTime": "2019-08-24T14:15:22Z",
"createdUserId": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"lastUpdatedUserId": "string",
"id": "string"
}
]

Get total value update

Get a total value update by id

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

null

Files

File related endpoints

Get files

Get all files

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

[{"transactionIds": ["string"
],
"cryptoTransactionIds": ["string"
],
"securityTransactionIds": ["string"
],
"filename": "string",
"fileExtension": "string",
"size": 0,
"storagePath": "string",
"parseStatus": "open",
"parseData": {"amount": {"value": 0,
"currency": "EUR"
},
"date": "2019-08-24",
"type": "invoice",
"potentialSecurityTransaction": {"date": "string",
"type": "buy",
"isin": "string",
"quantity": 0,
"price": {"value": 0,
"currency": "EUR"
},
"fees": {"value": 0,
"currency": "EUR"
},
"tax": {"value": 0,
"currency": "EUR"
}
}
},
"createdTime": "string",
"createdUserId": "string",
"lastUpdatedTime": "string",
"lastUpdatedUserId": "string",
"id": "string"
}
]

Get file

Get a file by id

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

null

Get categories

Get all categories

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"type": "activeIncome",
"emoji": "string",
"system": true,
"order": 0,
"categoryGroupId": "string",
"createdTime": "2019-08-24T14:15:22Z",
"createdUserId": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"lastUpdatedUserId": "string",
"id": "string"
}
]

Get category

Get a category by id

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

null

Category groups

Category group related endpoints

Get category groups

Get all category groups. Category groups are used to organize categories into a hierarchy.

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"emoji": "string",
"parentCategoryGroupId": "string",
"order": 0,
"createdTime": "2019-08-24T14:15:22Z",
"createdUserId": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"lastUpdatedUserId": "string",
"id": "string"
}
]

Get category group

Get a category group by id. Category groups are used to organize categories into a hierarchy.

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

null

Get tags

Get all tags

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"createdTime": "2019-08-24T14:15:22Z",
"createdUserId": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"lastUpdatedUserId": "string",
"id": "string"
}
]

Get tag

Get a tag by id

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

null

Scenarios

Scenario related endpoints

Get scenarios

Get all scenarios

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"startDate": "2019-08-24",
"endMonth": "string",
"startingBasePerCategory": {"property1": {"value": 0,
"currency": "EUR"
},
"property2": {"value": 0,
"currency": "EUR"
}
},
"expectedAnnualReturn": 0,
"changeEvents": {"property1": {"name": "string",
"categoryId": "string",
"startMonth": "string",
"ongoingBase": {"value": 0,
"currency": "EUR"
},
"ongoingPercentageChangePerYear": 0,
"oneTime": {"value": 0,
"currency": "EUR"
},
"active": true
},
"property2": {"name": "string",
"categoryId": "string",
"startMonth": "string",
"ongoingBase": {"value": 0,
"currency": "EUR"
},
"ongoingPercentageChangePerYear": 0,
"oneTime": {"value": 0,
"currency": "EUR"
},
"active": true
}
},
"assetIds": ["string"
],
"createdTime": "2019-08-24T14:15:22Z",
"createdUserId": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"lastUpdatedUserId": "string",
"id": "string"
}
]

Get scenario

Get a scenario by id

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

null

Merchants

Merchant related endpoints

Get merchants

Get all merchants

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

[{"name": "string",
"defaultCategoryId": "string",
"defaultUsingDateRule": "transactionDate",
"domains": ["string"
],
"logo": true,
"autoCreatedSource": "googleMaps",
"autoReviewTransactions": true,
"createdTime": "2019-08-24T14:15:22Z",
"createdUserId": "string",
"lastUpdatedTime": "2019-08-24T14:15:22Z",
"lastUpdatedUserId": "string",
"id": "string"
}
]

Get merchant

Get a merchant by id

Authorizations:

bearerAuthbasicAuth

Responses

Response samples

200

Content type

application/json

null

Other

Other endpoints

Show API docs

Show the API docs

Authorizations:

NonebasicAuthbearerAuth

Responses

Get OpenAPI spec

Get the OpenAPI spec

Authorizations:

NonebasicAuthbearerAuth

query Parameters

format

string

Walletguide API (1.0.0)

Assets

Get assets

Authorizations:

Responses

Response samples

Get asset

Authorizations:

Responses

Response samples

Asset groups

Get asset groups

Authorizations:

Responses

Response samples

Get asset group

Authorizations:

Responses

Response samples

Transactions

Get transactions

Authorizations:

query Parameters

Responses

Response samples

Get transaction

Authorizations:

Responses

Response samples

Crypto transactions

Get crypto transactions

Authorizations:

query Parameters

Responses

Response samples

Get crypto transaction

Authorizations:

Responses

Response samples

Security transactions

Get security transactions

Authorizations:

query Parameters

Responses

Response samples

Get security transaction

Authorizations:

Responses

Response samples

Total value updates

Get total value updates

Authorizations:

query Parameters

Responses

Response samples

Get total value update

Authorizations:

Responses

Response samples

Files

Get files

Authorizations:

Responses

Response samples

Get file

Authorizations:

Responses

Response samples

Categories

Get categories

Authorizations:

Responses

Response samples

Get category

Authorizations:

Responses

Response samples

Category groups

Get category groups

Authorizations: