id
stringlengths 53
86
| api_name
stringlengths 2
76
| api_description
stringlengths 1
500
⌀ | api_score
float64 0
10
⌀ | endpoint_name
stringlengths 1
190
| endpoint_description
stringlengths 0
500
| response_status_code
int64 100
505
| response_summary
stringlengths 1
68
⌀ | response_json
stringlengths 6
50k
| response_json_schema
stringlengths 14
150k
|
|---|---|---|---|---|---|---|---|---|---|
3c30559e-c984-41f2-8ed2-338178c80c4e/6d774d26-a8e9-483d-bbf8-806691b8525e/1/0 | Dots | Dots Payouts API | null | /api/transactions/add_credit | 403 | null | {"success": true} | {"type": "object", "properties": {"success": {"type": "boolean"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/6d774d26-a8e9-483d-bbf8-806691b8525e/2/0 | Dots | Dots Payouts API | null | /api/transactions/add_credit | 400 | null | {"success": true, "message": "Destination user cannot be the same as the user of the api app"} | {"type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/6d774d26-a8e9-483d-bbf8-806691b8525e/3/0 | Dots | Dots Payouts API | null | /api/transactions/add_credit | 404 | null | {"success": true} | {"type": "object", "properties": {"success": {"type": "boolean"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/a9202499-f1bd-421e-8c4d-08a17782dc4f/0/0 | Dots | Dots Payouts API | null | /api/payouts/create_direct_payout | 400 | null | {"success": true, "message": "Please set user venmo using api/users/wallet/add_payout_method"} | {"type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/a9202499-f1bd-421e-8c4d-08a17782dc4f/1/0 | Dots | Dots Payouts API | null | /api/payouts/create_direct_payout | 403 | null | {"success": true} | {"type": "object", "properties": {"success": {"type": "boolean"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/a9202499-f1bd-421e-8c4d-08a17782dc4f/2/0 | Dots | Dots Payouts API | null | /api/payouts/create_direct_payout | 404 | null | {"success": true} | {"type": "object", "properties": {"success": {"type": "boolean"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/a9202499-f1bd-421e-8c4d-08a17782dc4f/3/0 | Dots | Dots Payouts API | null | /api/payouts/create_direct_payout | 200 | null | {"success": true, "message": "Invalid Venmo phone number"} | {"type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string", "description": "Error message if success is false"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/39c70617-f2c9-4fb4-b248-3120b1b30be1/0/0 | Dots | Dots Payouts API | null | /api/app/metrics/transaction/volume | 200 | null | {"success": true, "volume": 100000} | {"type": "object", "properties": {"success": {"type": "boolean"}, "volume": {"type": "number", "description": "Volume in cents"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/80afdca6-66e6-4f56-adec-537598308258/0/0 | Dots | Dots Payouts API | null | /api/payouts/create | 403 | null | {"success": true} | {"type": "object", "properties": {"success": {"type": "boolean"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/80afdca6-66e6-4f56-adec-537598308258/1/0 | Dots | Dots Payouts API | null | /api/payouts/create | 404 | null | {"success": true} | {"type": "object", "properties": {"success": {"type": "boolean"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/80afdca6-66e6-4f56-adec-537598308258/2/0 | Dots | Dots Payouts API | null | /api/payouts/create | 200 | null | {"success": true, "error_code": 0} | {"type": "object", "properties": {"success": {"type": "boolean"}, "error_code": {"type": "integer", "description": "Error code if success is false"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/80afdca6-66e6-4f56-adec-537598308258/3/0 | Dots | Dots Payouts API | null | /api/payouts/create | 400 | null | {"success": true, "message": "Please set user venmo using api/users/wallet/add_payout_method"} | {"type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/1ff89f38-c74d-4855-8bd0-98a27ddd1b96/0/0 | Dots | Dots Payouts API | null | /api/payouts/create_payout_link | 200 | null | {"success": true, "payout_link": {"id": "", "link": "", "original_amount": 0, "amount": 0, "status": "created", "api_app_name": "", "payee": {"first_name": "", "last_name": "", "email": "", "country_code": "", "phone_number": ""}}} | {"type": "object", "properties": {"success": {"type": "boolean"}, "payout_link": {"type": "object", "description": "The payout link if success is true", "properties": {"id": {"type": "string", "description": "The id of the payout link", "format": "uuid"}, "link": {"type": "string", "description": "The link to the payout", "format": "url"}, "original_amount": {"type": "number", "description": "The original amount of the payout", "minimum": 0, "exclusiveMinimum": true}, "amount": {"type": "number", "description": "The amount left in the payout link/the amount in the user's wallet", "minimum": 0, "exclusiveMinimum": true}, "status": {"type": "string", "enum": ["created", "claimed", "delivered", "delivery_failed"]}, "api_app_name": {"type": "string", "description": "The name of the app that created the payout link"}, "payee": {"type": "object", "description": "The payee of the payout link", "properties": {"first_name": {"type": "string"}, "last_name": {"type": "string"}, "email": {"type": "string"}, "country_code": {"type": "string"}, "phone_number": {"type": "string"}}}}}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/1ff89f38-c74d-4855-8bd0-98a27ddd1b96/1/0 | Dots | Dots Payouts API | null | /api/payouts/create_payout_link | 404 | null | {"success": true} | {"type": "object", "properties": {"success": {"type": "boolean"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/1ff89f38-c74d-4855-8bd0-98a27ddd1b96/2/0 | Dots | Dots Payouts API | null | /api/payouts/create_payout_link | 500 | null | {"success": true, "message": "Server could not process this request"} | {"type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/1ff89f38-c74d-4855-8bd0-98a27ddd1b96/3/0 | Dots | Dots Payouts API | null | /api/payouts/create_payout_link | 400 | null | {"success": true, "message": "Cannot parse or bad format"} | {"type": "object", "properties": {"success": {"type": "boolean"}, "message": {"type": "string"}}} |
|
3c30559e-c984-41f2-8ed2-338178c80c4e/1ff89f38-c74d-4855-8bd0-98a27ddd1b96/4/0 | Dots | Dots Payouts API | null | /api/payouts/create_payout_link | 403 | null | {"success": true} | {"type": "object", "properties": {"success": {"type": "boolean"}}} |
|
5485c52e-7e9c-4322-8210-0236ea23e936/0b21ab37-8f83-46e5-8c0d-05ba64516fef/0/0 | YNAB | YNAB | 0 | getTransactionsByCategory | Returns all transactions for a specified category | 200 | null | {"data": {"transactions": [{"id": "", "date": "", "amount": 0, "memo": "", "cleared": "cleared", "approved": true, "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "transfer_transaction_id": "", "matched_transaction_id": "", "import_id": "", "deleted": true, "type": "transaction", "parent_transaction_id": "", "account_name": "", "payee_name": "", "category_name": ""}]}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["transactions"], "properties": {"transactions": {"type": "array", "items": {"allOf": [{"type": "object", "required": ["account_id", "amount", "approved", "cleared", "date", "deleted", "id"], "properties": {"id": {"type": "string"}, "date": {"type": "string", "format": "date", "description": "The transaction date in ISO format (e.g. 2016-12-01)"}, "amount": {"type": "integer", "format": "int64", "description": "The transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "cleared": {"type": "string", "description": "The cleared status of the transaction", "enum": ["cleared", "uncleared", "reconciled"]}, "approved": {"type": "boolean", "description": "Whether or not the transaction is approved"}, "flag_color": {"type": "string", "description": "The transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer transaction, the account to which it transfers"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer transaction, the id of transaction on the other side of the transfer"}, "matched_transaction_id": {"type": "string", "description": "If transaction is matched, the id of the matched transaction"}, "import_id": {"type": "string", "description": "If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'."}, "deleted": {"type": "boolean", "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests."}}}, {"type": "object", "required": ["account_name", "type"], "properties": {"type": {"type": "string", "description": "Whether the hybrid transaction represents a regular transaction or a subtransaction", "enum": ["transaction", "subtransaction"]}, "parent_transaction_id": {"type": "string", "description": "For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null."}, "account_name": {"type": "string"}, "payee_name": {"type": "string"}, "category_name": {"type": "string"}}}]}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/0b21ab37-8f83-46e5-8c0d-05ba64516fef/1/0 | YNAB | YNAB | 0 | getTransactionsByCategory | Returns all transactions for a specified category | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/d363c8f9-42f1-410b-aca1-a6eff347df54/0/0 | YNAB | YNAB | 0 | getTransactionsByPayee | Returns all transactions for a specified payee | 200 | null | {"data": {"transactions": [{"id": "", "date": "", "amount": 0, "memo": "", "cleared": "cleared", "approved": true, "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "transfer_transaction_id": "", "matched_transaction_id": "", "import_id": "", "deleted": true, "type": "transaction", "parent_transaction_id": "", "account_name": "", "payee_name": "", "category_name": ""}]}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["transactions"], "properties": {"transactions": {"type": "array", "items": {"allOf": [{"type": "object", "required": ["account_id", "amount", "approved", "cleared", "date", "deleted", "id"], "properties": {"id": {"type": "string"}, "date": {"type": "string", "format": "date", "description": "The transaction date in ISO format (e.g. 2016-12-01)"}, "amount": {"type": "integer", "format": "int64", "description": "The transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "cleared": {"type": "string", "description": "The cleared status of the transaction", "enum": ["cleared", "uncleared", "reconciled"]}, "approved": {"type": "boolean", "description": "Whether or not the transaction is approved"}, "flag_color": {"type": "string", "description": "The transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer transaction, the account to which it transfers"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer transaction, the id of transaction on the other side of the transfer"}, "matched_transaction_id": {"type": "string", "description": "If transaction is matched, the id of the matched transaction"}, "import_id": {"type": "string", "description": "If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'."}, "deleted": {"type": "boolean", "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests."}}}, {"type": "object", "required": ["account_name", "type"], "properties": {"type": {"type": "string", "description": "Whether the hybrid transaction represents a regular transaction or a subtransaction", "enum": ["transaction", "subtransaction"]}, "parent_transaction_id": {"type": "string", "description": "For subtransaction types, this is the id of the parent transaction. For transaction types, this id will be always be null."}, "account_name": {"type": "string"}, "payee_name": {"type": "string"}, "category_name": {"type": "string"}}}]}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/d363c8f9-42f1-410b-aca1-a6eff347df54/1/0 | YNAB | YNAB | 0 | getTransactionsByPayee | Returns all transactions for a specified payee | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/30df9fc7-38db-4bea-ac7c-5403b7155d8e/0/0 | YNAB | YNAB | 0 | updateTransactions | Updates multiple transactions, by id or import_id. | 209 | null | {"data": {"transaction_ids": [], "transaction": {"id": "", "date": "", "amount": 0, "memo": "", "cleared": "cleared", "approved": true, "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "transfer_transaction_id": "", "matched_transaction_id": "", "import_id": "", "deleted": true, "account_name": "", "payee_name": "", "category_name": "", "subtransactions": [{"id": "", "transaction_id": "", "amount": 0, "memo": "", "payee_id": "", "payee_name": "", "category_id": "", "category_name": "", "transfer_account_id": "", "transfer_transaction_id": "", "deleted": true}]}, "transactions": [{"id": "", "date": "", "amount": 0, "memo": "", "cleared": "cleared", "approved": true, "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "transfer_transaction_id": "", "matched_transaction_id": "", "import_id": "", "deleted": true, "account_name": "", "payee_name": "", "category_name": "", "subtransactions": [{"id": "", "transaction_id": "", "amount": 0, "memo": "", "payee_id": "", "payee_name": "", "category_id": "", "category_name": "", "transfer_account_id": "", "transfer_transaction_id": "", "deleted": true}]}], "duplicate_import_ids": [], "server_knowledge": 0}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["server_knowledge", "transaction_ids"], "properties": {"transaction_ids": {"type": "array", "description": "The transaction ids that were saved", "items": {"type": "string"}}, "transaction": {"allOf": [{"type": "object", "required": ["account_id", "amount", "approved", "cleared", "date", "deleted", "id"], "properties": {"id": {"type": "string"}, "date": {"type": "string", "format": "date", "description": "The transaction date in ISO format (e.g. 2016-12-01)"}, "amount": {"type": "integer", "format": "int64", "description": "The transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "cleared": {"type": "string", "description": "The cleared status of the transaction", "enum": ["cleared", "uncleared", "reconciled"]}, "approved": {"type": "boolean", "description": "Whether or not the transaction is approved"}, "flag_color": {"type": "string", "description": "The transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer transaction, the account to which it transfers"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer transaction, the id of transaction on the other side of the transfer"}, "matched_transaction_id": {"type": "string", "description": "If transaction is matched, the id of the matched transaction"}, "import_id": {"type": "string", "description": "If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'."}, "deleted": {"type": "boolean", "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests."}}}, {"type": "object", "required": ["account_name", "subtransactions"], "properties": {"account_name": {"type": "string"}, "payee_name": {"type": "string"}, "category_name": {"type": "string"}, "subtransactions": {"type": "array", "description": "If a split transaction, the subtransactions.", "items": {"type": "object", "required": ["amount", "deleted", "id", "transaction_id"], "properties": {"id": {"type": "string"}, "transaction_id": {"type": "string"}, "amount": {"type": "integer", "format": "int64", "description": "The subtransaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "payee_id": {"type": "string", "format": "uuid"}, "payee_name": {"type": "string"}, "category_id": {"type": "string", "format": "uuid"}, "category_name": {"type": "string"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the subtransaction transfers to"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer, the id of transaction on the other side of the transfer"}, "deleted": {"type": "boolean", "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests."}}}}}}]}, "transactions": {"type": "array", "description": "If multiple transactions were specified, the transactions that were saved", "items": {"allOf": [{"type": "object", "required": ["account_id", "amount", "approved", "cleared", "date", "deleted", "id"], "properties": {"id": {"type": "string"}, "date": {"type": "string", "format": "date", "description": "The transaction date in ISO format (e.g. 2016-12-01)"}, "amount": {"type": "integer", "format": "int64", "description": "The transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "cleared": {"type": "string", "description": "The cleared status of the transaction", "enum": ["cleared", "uncleared", "reconciled"]}, "approved": {"type": "boolean", "description": "Whether or not the transaction is approved"}, "flag_color": {"type": "string", "description": "The transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer transaction, the account to which it transfers"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer transaction, the id of transaction on the other side of the transfer"}, "matched_transaction_id": {"type": "string", "description": "If transaction is matched, the id of the matched transaction"}, "import_id": {"type": "string", "description": "If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'."}, "deleted": {"type": "boolean", "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests."}}}, {"type": "object", "required": ["account_name", "subtransactions"], "properties": {"account_name": {"type": "string"}, "payee_name": {"type": "string"}, "category_name": {"type": "string"}, "subtransactions": {"type": "array", "description": "If a split transaction, the subtransactions.", "items": {"type": "object", "required": ["amount", "deleted", "id", "transaction_id"], "properties": {"id": {"type": "string"}, "transaction_id": {"type": "string"}, "amount": {"type": "integer", "format": "int64", "description": "The subtransaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "payee_id": {"type": "string", "format": "uuid"}, "payee_name": {"type": "string"}, "category_id": {"type": "string", "format": "uuid"}, "category_name": {"type": "string"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the subtransaction transfers to"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer, the id of transaction on the other side of the transfer"}, "deleted": {"type": "boolean", "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests."}}}}}}]}}, "duplicate_import_ids": {"type": "array", "description": "If multiple transactions were specified, a list of import_ids that were not created because of an existing `import_id` found on the same account", "items": {"type": "string"}}, "server_knowledge": {"type": "integer", "format": "int64", "description": "The knowledge of the server", "minimum": -9223372036854776000, "maximum": 9223372036854776000}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/30df9fc7-38db-4bea-ac7c-5403b7155d8e/1/0 | YNAB | YNAB | 0 | updateTransactions | Updates multiple transactions, by id or import_id. | 400 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/ae3b864b-879f-4532-9654-6fcb3749de39/0/0 | YNAB | YNAB | 0 | getTransactionsByAccount | Returns all transactions for a specified account | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/ae3b864b-879f-4532-9654-6fcb3749de39/1/0 | YNAB | YNAB | 0 | getTransactionsByAccount | Returns all transactions for a specified account | 200 | null | {"data": {"transactions": [{"id": "", "date": "", "amount": 0, "memo": "", "cleared": "cleared", "approved": true, "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "transfer_transaction_id": "", "matched_transaction_id": "", "import_id": "", "deleted": true, "account_name": "", "payee_name": "", "category_name": "", "subtransactions": [{"id": "", "transaction_id": "", "amount": 0, "memo": "", "payee_id": "", "payee_name": "", "category_id": "", "category_name": "", "transfer_account_id": "", "transfer_transaction_id": "", "deleted": true}]}], "server_knowledge": 0}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["server_knowledge", "transactions"], "properties": {"transactions": {"type": "array", "items": {"allOf": [{"type": "object", "required": ["account_id", "amount", "approved", "cleared", "date", "deleted", "id"], "properties": {"id": {"type": "string"}, "date": {"type": "string", "format": "date", "description": "The transaction date in ISO format (e.g. 2016-12-01)"}, "amount": {"type": "integer", "format": "int64", "description": "The transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "cleared": {"type": "string", "description": "The cleared status of the transaction", "enum": ["cleared", "uncleared", "reconciled"]}, "approved": {"type": "boolean", "description": "Whether or not the transaction is approved"}, "flag_color": {"type": "string", "description": "The transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer transaction, the account to which it transfers"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer transaction, the id of transaction on the other side of the transfer"}, "matched_transaction_id": {"type": "string", "description": "If transaction is matched, the id of the matched transaction"}, "import_id": {"type": "string", "description": "If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'."}, "deleted": {"type": "boolean", "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests."}}}, {"type": "object", "required": ["account_name", "subtransactions"], "properties": {"account_name": {"type": "string"}, "payee_name": {"type": "string"}, "category_name": {"type": "string"}, "subtransactions": {"type": "array", "description": "If a split transaction, the subtransactions.", "items": {"type": "object", "required": ["amount", "deleted", "id", "transaction_id"], "properties": {"id": {"type": "string"}, "transaction_id": {"type": "string"}, "amount": {"type": "integer", "format": "int64", "description": "The subtransaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "payee_id": {"type": "string", "format": "uuid"}, "payee_name": {"type": "string"}, "category_id": {"type": "string", "format": "uuid"}, "category_name": {"type": "string"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the subtransaction transfers to"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer, the id of transaction on the other side of the transfer"}, "deleted": {"type": "boolean", "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests."}}}}}}]}}, "server_knowledge": {"type": "integer", "format": "int64", "description": "The knowledge of the server", "minimum": -9223372036854776000, "maximum": 9223372036854776000}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/af7720a8-a2f7-490e-b2b7-c0303775f9d3/0/0 | YNAB | YNAB | 0 | updateTransaction | Updates a single transaction | 200 | null | {"data": {"transaction": {"id": "", "date": "", "amount": 0, "memo": "", "cleared": "cleared", "approved": true, "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "transfer_transaction_id": "", "matched_transaction_id": "", "import_id": "", "deleted": true, "account_name": "", "payee_name": "", "category_name": "", "subtransactions": [{"id": "", "transaction_id": "", "amount": 0, "memo": "", "payee_id": "", "payee_name": "", "category_id": "", "category_name": "", "transfer_account_id": "", "transfer_transaction_id": "", "deleted": true}]}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["transaction"], "properties": {"transaction": {"allOf": [{"type": "object", "required": ["account_id", "amount", "approved", "cleared", "date", "deleted", "id"], "properties": {"id": {"type": "string"}, "date": {"type": "string", "format": "date", "description": "The transaction date in ISO format (e.g. 2016-12-01)"}, "amount": {"type": "integer", "format": "int64", "description": "The transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "cleared": {"type": "string", "description": "The cleared status of the transaction", "enum": ["cleared", "uncleared", "reconciled"]}, "approved": {"type": "boolean", "description": "Whether or not the transaction is approved"}, "flag_color": {"type": "string", "description": "The transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer transaction, the account to which it transfers"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer transaction, the id of transaction on the other side of the transfer"}, "matched_transaction_id": {"type": "string", "description": "If transaction is matched, the id of the matched transaction"}, "import_id": {"type": "string", "description": "If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'."}, "deleted": {"type": "boolean", "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests."}}}, {"type": "object", "required": ["account_name", "subtransactions"], "properties": {"account_name": {"type": "string"}, "payee_name": {"type": "string"}, "category_name": {"type": "string"}, "subtransactions": {"type": "array", "description": "If a split transaction, the subtransactions.", "items": {"type": "object", "required": ["amount", "deleted", "id", "transaction_id"], "properties": {"id": {"type": "string"}, "transaction_id": {"type": "string"}, "amount": {"type": "integer", "format": "int64", "description": "The subtransaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "payee_id": {"type": "string", "format": "uuid"}, "payee_name": {"type": "string"}, "category_id": {"type": "string", "format": "uuid"}, "category_name": {"type": "string"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the subtransaction transfers to"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer, the id of transaction on the other side of the transfer"}, "deleted": {"type": "boolean", "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests."}}}}}}]}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/af7720a8-a2f7-490e-b2b7-c0303775f9d3/1/0 | YNAB | YNAB | 0 | updateTransaction | Updates a single transaction | 400 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/a604a41c-d1fe-423f-a3a1-2a3faf7621d4/0/0 | YNAB | YNAB | 0 | createTransaction | Creates a single transaction or multiple transactions. If you provide a body containing a transaction object, a single transaction will be created and if you provide a body containing a transactions array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint. | 409 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/a604a41c-d1fe-423f-a3a1-2a3faf7621d4/1/0 | YNAB | YNAB | 0 | createTransaction | Creates a single transaction or multiple transactions. If you provide a body containing a transaction object, a single transaction will be created and if you provide a body containing a transactions array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint. | 400 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/a604a41c-d1fe-423f-a3a1-2a3faf7621d4/2/0 | YNAB | YNAB | 0 | createTransaction | Creates a single transaction or multiple transactions. If you provide a body containing a transaction object, a single transaction will be created and if you provide a body containing a transactions array, multiple transactions will be created. Scheduled transactions cannot be created on this endpoint. | 201 | null | {"data": {"transaction_ids": [], "transaction": {"id": "", "date": "", "amount": 0, "memo": "", "cleared": "cleared", "approved": true, "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "transfer_transaction_id": "", "matched_transaction_id": "", "import_id": "", "deleted": true, "account_name": "", "payee_name": "", "category_name": "", "subtransactions": [{"id": "", "transaction_id": "", "amount": 0, "memo": "", "payee_id": "", "payee_name": "", "category_id": "", "category_name": "", "transfer_account_id": "", "transfer_transaction_id": "", "deleted": true}]}, "transactions": [{"id": "", "date": "", "amount": 0, "memo": "", "cleared": "cleared", "approved": true, "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "transfer_transaction_id": "", "matched_transaction_id": "", "import_id": "", "deleted": true, "account_name": "", "payee_name": "", "category_name": "", "subtransactions": [{"id": "", "transaction_id": "", "amount": 0, "memo": "", "payee_id": "", "payee_name": "", "category_id": "", "category_name": "", "transfer_account_id": "", "transfer_transaction_id": "", "deleted": true}]}], "duplicate_import_ids": [], "server_knowledge": 0}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["server_knowledge", "transaction_ids"], "properties": {"transaction_ids": {"type": "array", "description": "The transaction ids that were saved", "items": {"type": "string"}}, "transaction": {"allOf": [{"type": "object", "required": ["account_id", "amount", "approved", "cleared", "date", "deleted", "id"], "properties": {"id": {"type": "string"}, "date": {"type": "string", "format": "date", "description": "The transaction date in ISO format (e.g. 2016-12-01)"}, "amount": {"type": "integer", "format": "int64", "description": "The transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "cleared": {"type": "string", "description": "The cleared status of the transaction", "enum": ["cleared", "uncleared", "reconciled"]}, "approved": {"type": "boolean", "description": "Whether or not the transaction is approved"}, "flag_color": {"type": "string", "description": "The transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer transaction, the account to which it transfers"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer transaction, the id of transaction on the other side of the transfer"}, "matched_transaction_id": {"type": "string", "description": "If transaction is matched, the id of the matched transaction"}, "import_id": {"type": "string", "description": "If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'."}, "deleted": {"type": "boolean", "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests."}}}, {"type": "object", "required": ["account_name", "subtransactions"], "properties": {"account_name": {"type": "string"}, "payee_name": {"type": "string"}, "category_name": {"type": "string"}, "subtransactions": {"type": "array", "description": "If a split transaction, the subtransactions.", "items": {"type": "object", "required": ["amount", "deleted", "id", "transaction_id"], "properties": {"id": {"type": "string"}, "transaction_id": {"type": "string"}, "amount": {"type": "integer", "format": "int64", "description": "The subtransaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "payee_id": {"type": "string", "format": "uuid"}, "payee_name": {"type": "string"}, "category_id": {"type": "string", "format": "uuid"}, "category_name": {"type": "string"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the subtransaction transfers to"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer, the id of transaction on the other side of the transfer"}, "deleted": {"type": "boolean", "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests."}}}}}}]}, "transactions": {"type": "array", "description": "If multiple transactions were specified, the transactions that were saved", "items": {"allOf": [{"type": "object", "required": ["account_id", "amount", "approved", "cleared", "date", "deleted", "id"], "properties": {"id": {"type": "string"}, "date": {"type": "string", "format": "date", "description": "The transaction date in ISO format (e.g. 2016-12-01)"}, "amount": {"type": "integer", "format": "int64", "description": "The transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "cleared": {"type": "string", "description": "The cleared status of the transaction", "enum": ["cleared", "uncleared", "reconciled"]}, "approved": {"type": "boolean", "description": "Whether or not the transaction is approved"}, "flag_color": {"type": "string", "description": "The transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer transaction, the account to which it transfers"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer transaction, the id of transaction on the other side of the transfer"}, "matched_transaction_id": {"type": "string", "description": "If transaction is matched, the id of the matched transaction"}, "import_id": {"type": "string", "description": "If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'."}, "deleted": {"type": "boolean", "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests."}}}, {"type": "object", "required": ["account_name", "subtransactions"], "properties": {"account_name": {"type": "string"}, "payee_name": {"type": "string"}, "category_name": {"type": "string"}, "subtransactions": {"type": "array", "description": "If a split transaction, the subtransactions.", "items": {"type": "object", "required": ["amount", "deleted", "id", "transaction_id"], "properties": {"id": {"type": "string"}, "transaction_id": {"type": "string"}, "amount": {"type": "integer", "format": "int64", "description": "The subtransaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "payee_id": {"type": "string", "format": "uuid"}, "payee_name": {"type": "string"}, "category_id": {"type": "string", "format": "uuid"}, "category_name": {"type": "string"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the subtransaction transfers to"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer, the id of transaction on the other side of the transfer"}, "deleted": {"type": "boolean", "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests."}}}}}}]}}, "duplicate_import_ids": {"type": "array", "description": "If multiple transactions were specified, a list of import_ids that were not created because of an existing `import_id` found on the same account", "items": {"type": "string"}}, "server_knowledge": {"type": "integer", "format": "int64", "description": "The knowledge of the server", "minimum": -9223372036854776000, "maximum": 9223372036854776000}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/b2a8d781-f4e4-4786-a70a-3c964a2cad62/0/0 | YNAB | YNAB | 0 | getTransactions | Returns budget transactions | 200 | null | {"data": {"transactions": [{"id": "", "date": "", "amount": 0, "memo": "", "cleared": "cleared", "approved": true, "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "transfer_transaction_id": "", "matched_transaction_id": "", "import_id": "", "deleted": true, "account_name": "", "payee_name": "", "category_name": "", "subtransactions": [{"id": "", "transaction_id": "", "amount": 0, "memo": "", "payee_id": "", "payee_name": "", "category_id": "", "category_name": "", "transfer_account_id": "", "transfer_transaction_id": "", "deleted": true}]}], "server_knowledge": 0}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["server_knowledge", "transactions"], "properties": {"transactions": {"type": "array", "items": {"allOf": [{"type": "object", "required": ["account_id", "amount", "approved", "cleared", "date", "deleted", "id"], "properties": {"id": {"type": "string"}, "date": {"type": "string", "format": "date", "description": "The transaction date in ISO format (e.g. 2016-12-01)"}, "amount": {"type": "integer", "format": "int64", "description": "The transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "cleared": {"type": "string", "description": "The cleared status of the transaction", "enum": ["cleared", "uncleared", "reconciled"]}, "approved": {"type": "boolean", "description": "Whether or not the transaction is approved"}, "flag_color": {"type": "string", "description": "The transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer transaction, the account to which it transfers"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer transaction, the id of transaction on the other side of the transfer"}, "matched_transaction_id": {"type": "string", "description": "If transaction is matched, the id of the matched transaction"}, "import_id": {"type": "string", "description": "If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'."}, "deleted": {"type": "boolean", "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests."}}}, {"type": "object", "required": ["account_name", "subtransactions"], "properties": {"account_name": {"type": "string"}, "payee_name": {"type": "string"}, "category_name": {"type": "string"}, "subtransactions": {"type": "array", "description": "If a split transaction, the subtransactions.", "items": {"type": "object", "required": ["amount", "deleted", "id", "transaction_id"], "properties": {"id": {"type": "string"}, "transaction_id": {"type": "string"}, "amount": {"type": "integer", "format": "int64", "description": "The subtransaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "payee_id": {"type": "string", "format": "uuid"}, "payee_name": {"type": "string"}, "category_id": {"type": "string", "format": "uuid"}, "category_name": {"type": "string"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the subtransaction transfers to"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer, the id of transaction on the other side of the transfer"}, "deleted": {"type": "boolean", "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests."}}}}}}]}}, "server_knowledge": {"type": "integer", "format": "int64", "description": "The knowledge of the server", "minimum": -9223372036854776000, "maximum": 9223372036854776000}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/b2a8d781-f4e4-4786-a70a-3c964a2cad62/1/0 | YNAB | YNAB | 0 | getTransactions | Returns budget transactions | 400 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/b2a8d781-f4e4-4786-a70a-3c964a2cad62/2/0 | YNAB | YNAB | 0 | getTransactions | Returns budget transactions | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/f651dd0f-bfc1-4bb7-8ffb-b57d99ffd903/0/0 | YNAB | YNAB | 0 | importTransactions | Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking "Import" on each account in the web application or tapping the "New Transactions" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported. | 200 | null | {"data": {"transaction_ids": []}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["transaction_ids"], "properties": {"transaction_ids": {"type": "array", "description": "The list of transaction ids that were imported.", "items": {"type": "string"}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/f651dd0f-bfc1-4bb7-8ffb-b57d99ffd903/1/0 | YNAB | YNAB | 0 | importTransactions | Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking "Import" on each account in the web application or tapping the "New Transactions" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported. | 201 | null | {"data": {"transaction_ids": []}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["transaction_ids"], "properties": {"transaction_ids": {"type": "array", "description": "The list of transaction ids that were imported.", "items": {"type": "string"}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/f651dd0f-bfc1-4bb7-8ffb-b57d99ffd903/2/0 | YNAB | YNAB | 0 | importTransactions | Imports available transactions on all linked accounts for the given budget. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking "Import" on each account in the web application or tapping the "New Transactions" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported. | 400 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/c1692cce-24ff-482c-b0d7-bf19c9861589/0/0 | YNAB | YNAB | 0 | getTransactionById | Returns a single transaction | 200 | null | {"data": {"transaction": {"id": "", "date": "", "amount": 0, "memo": "", "cleared": "cleared", "approved": true, "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "transfer_transaction_id": "", "matched_transaction_id": "", "import_id": "", "deleted": true, "account_name": "", "payee_name": "", "category_name": "", "subtransactions": [{"id": "", "transaction_id": "", "amount": 0, "memo": "", "payee_id": "", "payee_name": "", "category_id": "", "category_name": "", "transfer_account_id": "", "transfer_transaction_id": "", "deleted": true}]}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["transaction"], "properties": {"transaction": {"allOf": [{"type": "object", "required": ["account_id", "amount", "approved", "cleared", "date", "deleted", "id"], "properties": {"id": {"type": "string"}, "date": {"type": "string", "format": "date", "description": "The transaction date in ISO format (e.g. 2016-12-01)"}, "amount": {"type": "integer", "format": "int64", "description": "The transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "cleared": {"type": "string", "description": "The cleared status of the transaction", "enum": ["cleared", "uncleared", "reconciled"]}, "approved": {"type": "boolean", "description": "Whether or not the transaction is approved"}, "flag_color": {"type": "string", "description": "The transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer transaction, the account to which it transfers"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer transaction, the id of transaction on the other side of the transfer"}, "matched_transaction_id": {"type": "string", "description": "If transaction is matched, the id of the matched transaction"}, "import_id": {"type": "string", "description": "If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'."}, "deleted": {"type": "boolean", "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests."}}}, {"type": "object", "required": ["account_name", "subtransactions"], "properties": {"account_name": {"type": "string"}, "payee_name": {"type": "string"}, "category_name": {"type": "string"}, "subtransactions": {"type": "array", "description": "If a split transaction, the subtransactions.", "items": {"type": "object", "required": ["amount", "deleted", "id", "transaction_id"], "properties": {"id": {"type": "string"}, "transaction_id": {"type": "string"}, "amount": {"type": "integer", "format": "int64", "description": "The subtransaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "payee_id": {"type": "string", "format": "uuid"}, "payee_name": {"type": "string"}, "category_id": {"type": "string", "format": "uuid"}, "category_name": {"type": "string"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the subtransaction transfers to"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer, the id of transaction on the other side of the transfer"}, "deleted": {"type": "boolean", "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests."}}}}}}]}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/c1692cce-24ff-482c-b0d7-bf19c9861589/1/0 | YNAB | YNAB | 0 | getTransactionById | Returns a single transaction | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/d8ca1842-2842-43be-9578-2cf76e5bf757/0/0 | YNAB | YNAB | 0 | getCategoryById | Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). | 200 | null | {"data": {"category": {"id": "", "category_group_id": "", "name": "", "hidden": true, "original_category_group_id": "", "note": "", "budgeted": 0, "activity": 0, "balance": 0, "goal_type": "TB", "goal_creation_month": "", "goal_target": 0, "goal_target_month": "", "goal_percentage_complete": 0, "goal_months_to_budget": 0, "goal_under_funded": 0, "goal_overall_funded": 0, "goal_overall_left": 0, "deleted": true}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["category"], "properties": {"category": {"type": "object", "required": ["activity", "balance", "budgeted", "category_group_id", "deleted", "hidden", "id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "category_group_id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "hidden": {"type": "boolean", "description": "Whether or not the category is hidden"}, "original_category_group_id": {"type": "string", "format": "uuid", "description": "If category is hidden this is the id of the category group it originally belonged to before it was hidden."}, "note": {"type": "string"}, "budgeted": {"type": "integer", "format": "int64", "description": "Budgeted amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activity": {"type": "integer", "format": "int64", "description": "Activity amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "balance": {"type": "integer", "format": "int64", "description": "Balance in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_type": {"type": "string", "description": "The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')", "enum": ["TB", "TBD", "MF", "NEED"]}, "goal_creation_month": {"type": "string", "format": "date", "description": "The month a goal was created"}, "goal_target": {"type": "integer", "format": "int64", "description": "The goal target amount in milliunits", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_target_month": {"type": "string", "format": "date", "description": "The original target month for the goal to be completed. Only some goal types specify this date."}, "goal_percentage_complete": {"type": "integer", "format": "int32", "description": "The percentage completion of the goal", "minimum": -2147483648, "maximum": 2147483647}, "goal_months_to_budget": {"type": "integer", "format": "int32", "description": "The number of months, including the current month, left in the current goal period.", "minimum": -2147483648, "maximum": 2147483647}, "goal_under_funded": {"type": "integer", "format": "int64", "description": "The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_funded": {"type": "integer", "format": "int64", "description": "The total amount funded towards the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_left": {"type": "integer", "format": "int64", "description": "The amount of funding still needed to complete the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "deleted": {"type": "boolean", "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests."}}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/d8ca1842-2842-43be-9578-2cf76e5bf757/1/0 | YNAB | YNAB | 0 | getCategoryById | Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/9d6faf7c-303e-485a-9cef-fe7d0a832e54/0/0 | YNAB | YNAB | 0 | getPayeeLocationsByPayee | Returns all payee locations for a specified payee | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/9d6faf7c-303e-485a-9cef-fe7d0a832e54/1/0 | YNAB | YNAB | 0 | getPayeeLocationsByPayee | Returns all payee locations for a specified payee | 200 | null | {"data": {"payee_locations": [{"id": "", "payee_id": "", "latitude": "", "longitude": "", "deleted": true}]}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["payee_locations"], "properties": {"payee_locations": {"type": "array", "items": {"type": "object", "required": ["deleted", "id", "latitude", "longitude", "payee_id"], "properties": {"id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "latitude": {"type": "string"}, "longitude": {"type": "string"}, "deleted": {"type": "boolean", "description": "Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests."}}}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/39bf7091-d7e4-4df8-9f70-29e3ce23e734/0/0 | YNAB | YNAB | 0 | updateMonthCategory | Update a category for a specific month. Only budgeted amount can be updated. | 400 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/39bf7091-d7e4-4df8-9f70-29e3ce23e734/1/0 | YNAB | YNAB | 0 | updateMonthCategory | Update a category for a specific month. Only budgeted amount can be updated. | 200 | null | {"data": {"category": {"id": "", "category_group_id": "", "name": "", "hidden": true, "original_category_group_id": "", "note": "", "budgeted": 0, "activity": 0, "balance": 0, "goal_type": "TB", "goal_creation_month": "", "goal_target": 0, "goal_target_month": "", "goal_percentage_complete": 0, "goal_months_to_budget": 0, "goal_under_funded": 0, "goal_overall_funded": 0, "goal_overall_left": 0, "deleted": true}, "server_knowledge": 0}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["category", "server_knowledge"], "properties": {"category": {"type": "object", "required": ["activity", "balance", "budgeted", "category_group_id", "deleted", "hidden", "id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "category_group_id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "hidden": {"type": "boolean", "description": "Whether or not the category is hidden"}, "original_category_group_id": {"type": "string", "format": "uuid", "description": "If category is hidden this is the id of the category group it originally belonged to before it was hidden."}, "note": {"type": "string"}, "budgeted": {"type": "integer", "format": "int64", "description": "Budgeted amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activity": {"type": "integer", "format": "int64", "description": "Activity amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "balance": {"type": "integer", "format": "int64", "description": "Balance in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_type": {"type": "string", "description": "The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')", "enum": ["TB", "TBD", "MF", "NEED"]}, "goal_creation_month": {"type": "string", "format": "date", "description": "The month a goal was created"}, "goal_target": {"type": "integer", "format": "int64", "description": "The goal target amount in milliunits", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_target_month": {"type": "string", "format": "date", "description": "The original target month for the goal to be completed. Only some goal types specify this date."}, "goal_percentage_complete": {"type": "integer", "format": "int32", "description": "The percentage completion of the goal", "minimum": -2147483648, "maximum": 2147483647}, "goal_months_to_budget": {"type": "integer", "format": "int32", "description": "The number of months, including the current month, left in the current goal period.", "minimum": -2147483648, "maximum": 2147483647}, "goal_under_funded": {"type": "integer", "format": "int64", "description": "The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_funded": {"type": "integer", "format": "int64", "description": "The total amount funded towards the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_left": {"type": "integer", "format": "int64", "description": "The amount of funding still needed to complete the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "deleted": {"type": "boolean", "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests."}}}, "server_knowledge": {"type": "integer", "format": "int64", "description": "The knowledge of the server", "minimum": -9223372036854776000, "maximum": 9223372036854776000}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/65be55ab-88a6-4156-a905-8b7b7f26c5fe/0/0 | YNAB | YNAB | 0 | getBudgetById | Returns a single budget with all related entities. This resource is effectively a full budget export. | 200 | null | {"data": {"budget": {"id": "", "name": "", "last_modified_on": "", "first_month": "", "last_month": "", "date_format": {"format": ""}, "currency_format": {"iso_code": "", "example_format": "", "decimal_digits": 0, "decimal_separator": "", "symbol_first": true, "group_separator": "", "currency_symbol": "", "display_symbol": true}, "accounts": [{"id": "", "name": "", "type": "checking", "on_budget": true, "closed": true, "note": "", "balance": 0, "cleared_balance": 0, "uncleared_balance": 0, "transfer_payee_id": "", "deleted": true}], "payees": [{"id": "", "name": "", "transfer_account_id": "", "deleted": true}], "payee_locations": [{"id": "", "payee_id": "", "latitude": "", "longitude": "", "deleted": true}], "category_groups": [{"id": "", "name": "", "hidden": true, "deleted": true}], "categories": [{"id": "", "category_group_id": "", "name": "", "hidden": true, "original_category_group_id": "", "note": "", "budgeted": 0, "activity": 0, "balance": 0, "goal_type": "TB", "goal_creation_month": "", "goal_target": 0, "goal_target_month": "", "goal_percentage_complete": 0, "goal_months_to_budget": 0, "goal_under_funded": 0, "goal_overall_funded": 0, "goal_overall_left": 0, "deleted": true}], "months": [{"month": "", "note": "", "income": 0, "budgeted": 0, "activity": 0, "to_be_budgeted": 0, "age_of_money": 0, "deleted": true, "categories": [{"id": "", "category_group_id": "", "name": "", "hidden": true, "original_category_group_id": "", "note": "", "budgeted": 0, "activity": 0, "balance": 0, "goal_type": "TB", "goal_creation_month": "", "goal_target": 0, "goal_target_month": "", "goal_percentage_complete": 0, "goal_months_to_budget": 0, "goal_under_funded": 0, "goal_overall_funded": 0, "goal_overall_left": 0, "deleted": true}]}], "transactions": [{"id": "", "date": "", "amount": 0, "memo": "", "cleared": "cleared", "approved": true, "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "transfer_transaction_id": "", "matched_transaction_id": "", "import_id": "", "deleted": true}], "subtransactions": [{"id": "", "transaction_id": "", "amount": 0, "memo": "", "payee_id": "", "payee_name": "", "category_id": "", "category_name": "", "transfer_account_id": "", "transfer_transaction_id": "", "deleted": true}], "scheduled_transactions": [{"id": "", "date_first": "", "date_next": "", "frequency": "never", "amount": 0, "memo": "", "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "deleted": true}], "scheduled_subtransactions": [{"id": "", "scheduled_transaction_id": "", "amount": 0, "memo": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "deleted": true}]}, "server_knowledge": 0}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["budget", "server_knowledge"], "properties": {"budget": {"allOf": [{"type": "object", "required": ["id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "last_modified_on": {"type": "string", "format": "date-time", "description": "The last time any changes were made to the budget from either a web or mobile client"}, "first_month": {"type": "string", "format": "date", "description": "The earliest budget month"}, "last_month": {"type": "string", "format": "date", "description": "The latest budget month"}, "date_format": {"type": "object", "required": ["format"], "properties": {"format": {"type": "string"}}, "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null."}, "currency_format": {"type": "object", "required": ["currency_symbol", "decimal_digits", "decimal_separator", "display_symbol", "example_format", "group_separator", "iso_code", "symbol_first"], "properties": {"iso_code": {"type": "string"}, "example_format": {"type": "string"}, "decimal_digits": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "decimal_separator": {"type": "string"}, "symbol_first": {"type": "boolean"}, "group_separator": {"type": "string"}, "currency_symbol": {"type": "string"}, "display_symbol": {"type": "boolean"}}, "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null."}, "accounts": {"type": "array", "description": "The budget accounts (only included if `include_accounts=true` specified as query parameter)", "items": {"type": "object", "required": ["balance", "cleared_balance", "closed", "deleted", "id", "name", "on_budget", "transfer_payee_id", "type", "uncleared_balance"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "type": {"type": "string", "description": "The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future.", "enum": ["checking", "savings", "cash", "creditCard", "lineOfCredit", "otherAsset", "otherLiability", "payPal", "merchantAccount", "investmentAccount", "mortgage"]}, "on_budget": {"type": "boolean", "description": "Whether this account is on budget or not"}, "closed": {"type": "boolean", "description": "Whether this account is closed or not"}, "note": {"type": "string"}, "balance": {"type": "integer", "format": "int64", "description": "The current balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "cleared_balance": {"type": "integer", "format": "int64", "description": "The current cleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "uncleared_balance": {"type": "integer", "format": "int64", "description": "The current uncleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "transfer_payee_id": {"type": "string", "format": "uuid", "description": "The payee id which should be used when transferring to this account"}, "deleted": {"type": "boolean", "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests."}}}}}}, {"type": "object", "properties": {"accounts": {"type": "array", "items": {"type": "object", "required": ["balance", "cleared_balance", "closed", "deleted", "id", "name", "on_budget", "transfer_payee_id", "type", "uncleared_balance"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "type": {"type": "string", "description": "The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future.", "enum": ["checking", "savings", "cash", "creditCard", "lineOfCredit", "otherAsset", "otherLiability", "payPal", "merchantAccount", "investmentAccount", "mortgage"]}, "on_budget": {"type": "boolean", "description": "Whether this account is on budget or not"}, "closed": {"type": "boolean", "description": "Whether this account is closed or not"}, "note": {"type": "string"}, "balance": {"type": "integer", "format": "int64", "description": "The current balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "cleared_balance": {"type": "integer", "format": "int64", "description": "The current cleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "uncleared_balance": {"type": "integer", "format": "int64", "description": "The current uncleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "transfer_payee_id": {"type": "string", "format": "uuid", "description": "The payee id which should be used when transferring to this account"}, "deleted": {"type": "boolean", "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests."}}}}, "payees": {"type": "array", "items": {"type": "object", "required": ["deleted", "id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "transfer_account_id": {"type": "string", "description": "If a transfer payee, the `account_id` to which this payee transfers to"}, "deleted": {"type": "boolean", "description": "Whether or not the payee has been deleted. Deleted payees will only be included in delta requests."}}}}, "payee_locations": {"type": "array", "items": {"type": "object", "required": ["deleted", "id", "latitude", "longitude", "payee_id"], "properties": {"id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "latitude": {"type": "string"}, "longitude": {"type": "string"}, "deleted": {"type": "boolean", "description": "Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests."}}}}, "category_groups": {"type": "array", "items": {"type": "object", "required": ["deleted", "hidden", "id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "hidden": {"type": "boolean", "description": "Whether or not the category group is hidden"}, "deleted": {"type": "boolean", "description": "Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests."}}}}, "categories": {"type": "array", "items": {"type": "object", "required": ["activity", "balance", "budgeted", "category_group_id", "deleted", "hidden", "id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "category_group_id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "hidden": {"type": "boolean", "description": "Whether or not the category is hidden"}, "original_category_group_id": {"type": "string", "format": "uuid", "description": "If category is hidden this is the id of the category group it originally belonged to before it was hidden."}, "note": {"type": "string"}, "budgeted": {"type": "integer", "format": "int64", "description": "Budgeted amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activity": {"type": "integer", "format": "int64", "description": "Activity amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "balance": {"type": "integer", "format": "int64", "description": "Balance in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_type": {"type": "string", "description": "The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')", "enum": ["TB", "TBD", "MF", "NEED"]}, "goal_creation_month": {"type": "string", "format": "date", "description": "The month a goal was created"}, "goal_target": {"type": "integer", "format": "int64", "description": "The goal target amount in milliunits", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_target_month": {"type": "string", "format": "date", "description": "The original target month for the goal to be completed. Only some goal types specify this date."}, "goal_percentage_complete": {"type": "integer", "format": "int32", "description": "The percentage completion of the goal", "minimum": -2147483648, "maximum": 2147483647}, "goal_months_to_budget": {"type": "integer", "format": "int32", "description": "The number of months, including the current month, left in the current goal period.", "minimum": -2147483648, "maximum": 2147483647}, "goal_under_funded": {"type": "integer", "format": "int64", "description": "The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_funded": {"type": "integer", "format": "int64", "description": "The total amount funded towards the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_left": {"type": "integer", "format": "int64", "description": "The amount of funding still needed to complete the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "deleted": {"type": "boolean", "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests."}}}}, "months": {"type": "array", "items": {"allOf": [{"type": "object", "required": ["activity", "budgeted", "deleted", "income", "month", "to_be_budgeted"], "properties": {"month": {"type": "string", "format": "date"}, "note": {"type": "string"}, "income": {"type": "integer", "format": "int64", "description": "The total amount of transactions categorized to 'Inflow: To be Budgeted' in the month", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "budgeted": {"type": "integer", "format": "int64", "description": "The total amount budgeted in the month", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activity": {"type": "integer", "format": "int64", "description": "The total amount of transactions in the month, excluding those categorized to 'Inflow: To be Budgeted'", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "to_be_budgeted": {"type": "integer", "format": "int64", "description": "The available amount for 'To be Budgeted'", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "age_of_money": {"type": "integer", "format": "int32", "description": "The Age of Money as of the month", "minimum": -2147483648, "maximum": 2147483647}, "deleted": {"type": "boolean", "description": "Whether or not the month has been deleted. Deleted months will only be included in delta requests."}}}, {"type": "object", "required": ["categories"], "properties": {"categories": {"type": "array", "description": "The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified.", "items": {"type": "object", "required": ["activity", "balance", "budgeted", "category_group_id", "deleted", "hidden", "id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "category_group_id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "hidden": {"type": "boolean", "description": "Whether or not the category is hidden"}, "original_category_group_id": {"type": "string", "format": "uuid", "description": "If category is hidden this is the id of the category group it originally belonged to before it was hidden."}, "note": {"type": "string"}, "budgeted": {"type": "integer", "format": "int64", "description": "Budgeted amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activity": {"type": "integer", "format": "int64", "description": "Activity amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "balance": {"type": "integer", "format": "int64", "description": "Balance in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_type": {"type": "string", "description": "The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')", "enum": ["TB", "TBD", "MF", "NEED"]}, "goal_creation_month": {"type": "string", "format": "date", "description": "The month a goal was created"}, "goal_target": {"type": "integer", "format": "int64", "description": "The goal target amount in milliunits", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_target_month": {"type": "string", "format": "date", "description": "The original target month for the goal to be completed. Only some goal types specify this date."}, "goal_percentage_complete": {"type": "integer", "format": "int32", "description": "The percentage completion of the goal", "minimum": -2147483648, "maximum": 2147483647}, "goal_months_to_budget": {"type": "integer", "format": "int32", "description": "The number of months, including the current month, left in the current goal period.", "minimum": -2147483648, "maximum": 2147483647}, "goal_under_funded": {"type": "integer", "format": "int64", "description": "The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_funded": {"type": "integer", "format": "int64", "description": "The total amount funded towards the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_left": {"type": "integer", "format": "int64", "description": "The amount of funding still needed to complete the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "deleted": {"type": "boolean", "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests."}}}}}}]}}, "transactions": {"type": "array", "items": {"type": "object", "required": ["account_id", "amount", "approved", "cleared", "date", "deleted", "id"], "properties": {"id": {"type": "string"}, "date": {"type": "string", "format": "date", "description": "The transaction date in ISO format (e.g. 2016-12-01)"}, "amount": {"type": "integer", "format": "int64", "description": "The transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "cleared": {"type": "string", "description": "The cleared status of the transaction", "enum": ["cleared", "uncleared", "reconciled"]}, "approved": {"type": "boolean", "description": "Whether or not the transaction is approved"}, "flag_color": {"type": "string", "description": "The transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer transaction, the account to which it transfers"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer transaction, the id of transaction on the other side of the transfer"}, "matched_transaction_id": {"type": "string", "description": "If transaction is matched, the id of the matched transaction"}, "import_id": {"type": "string", "description": "If the Transaction was imported, this field is a unique (by account) import identifier. If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'. If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'."}, "deleted": {"type": "boolean", "description": "Whether or not the transaction has been deleted. Deleted transactions will only be included in delta requests."}}}}, "subtransactions": {"type": "array", "items": {"type": "object", "required": ["amount", "deleted", "id", "transaction_id"], "properties": {"id": {"type": "string"}, "transaction_id": {"type": "string"}, "amount": {"type": "integer", "format": "int64", "description": "The subtransaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "payee_id": {"type": "string", "format": "uuid"}, "payee_name": {"type": "string"}, "category_id": {"type": "string", "format": "uuid"}, "category_name": {"type": "string"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the subtransaction transfers to"}, "transfer_transaction_id": {"type": "string", "description": "If a transfer, the id of transaction on the other side of the transfer"}, "deleted": {"type": "boolean", "description": "Whether or not the subtransaction has been deleted. Deleted subtransactions will only be included in delta requests."}}}}, "scheduled_transactions": {"type": "array", "items": {"type": "object", "required": ["account_id", "amount", "date_first", "date_next", "deleted", "frequency", "id"], "properties": {"id": {"type": "string", "format": "uuid"}, "date_first": {"type": "string", "format": "date", "description": "The first date for which the Scheduled Transaction was scheduled."}, "date_next": {"type": "string", "format": "date", "description": "The next date for which the Scheduled Transaction is scheduled."}, "frequency": {"type": "string", "enum": ["never", "daily", "weekly", "everyOtherWeek", "twiceAMonth", "every4Weeks", "monthly", "everyOtherMonth", "every3Months", "every4Months", "twiceAYear", "yearly", "everyOtherYear"]}, "amount": {"type": "integer", "format": "int64", "description": "The scheduled transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "flag_color": {"type": "string", "description": "The scheduled transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the scheduled transaction transfers to"}, "deleted": {"type": "boolean", "description": "Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests."}}}}, "scheduled_subtransactions": {"type": "array", "items": {"type": "object", "required": ["amount", "deleted", "id", "scheduled_transaction_id"], "properties": {"id": {"type": "string", "format": "uuid"}, "scheduled_transaction_id": {"type": "string", "format": "uuid"}, "amount": {"type": "integer", "format": "int64", "description": "The scheduled subtransaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the scheduled subtransaction transfers to"}, "deleted": {"type": "boolean", "description": "Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests."}}}}}}]}, "server_knowledge": {"type": "integer", "format": "int64", "description": "The knowledge of the server", "minimum": -9223372036854776000, "maximum": 9223372036854776000}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/65be55ab-88a6-4156-a905-8b7b7f26c5fe/1/0 | YNAB | YNAB | 0 | getBudgetById | Returns a single budget with all related entities. This resource is effectively a full budget export. | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/208f555d-1aa5-412c-af9f-1a85345571a3/0/0 | YNAB | YNAB | 0 | getMonthCategoryById | Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). | 200 | null | {"data": {"category": {"id": "", "category_group_id": "", "name": "", "hidden": true, "original_category_group_id": "", "note": "", "budgeted": 0, "activity": 0, "balance": 0, "goal_type": "TB", "goal_creation_month": "", "goal_target": 0, "goal_target_month": "", "goal_percentage_complete": 0, "goal_months_to_budget": 0, "goal_under_funded": 0, "goal_overall_funded": 0, "goal_overall_left": 0, "deleted": true}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["category"], "properties": {"category": {"type": "object", "required": ["activity", "balance", "budgeted", "category_group_id", "deleted", "hidden", "id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "category_group_id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "hidden": {"type": "boolean", "description": "Whether or not the category is hidden"}, "original_category_group_id": {"type": "string", "format": "uuid", "description": "If category is hidden this is the id of the category group it originally belonged to before it was hidden."}, "note": {"type": "string"}, "budgeted": {"type": "integer", "format": "int64", "description": "Budgeted amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activity": {"type": "integer", "format": "int64", "description": "Activity amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "balance": {"type": "integer", "format": "int64", "description": "Balance in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_type": {"type": "string", "description": "The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')", "enum": ["TB", "TBD", "MF", "NEED"]}, "goal_creation_month": {"type": "string", "format": "date", "description": "The month a goal was created"}, "goal_target": {"type": "integer", "format": "int64", "description": "The goal target amount in milliunits", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_target_month": {"type": "string", "format": "date", "description": "The original target month for the goal to be completed. Only some goal types specify this date."}, "goal_percentage_complete": {"type": "integer", "format": "int32", "description": "The percentage completion of the goal", "minimum": -2147483648, "maximum": 2147483647}, "goal_months_to_budget": {"type": "integer", "format": "int32", "description": "The number of months, including the current month, left in the current goal period.", "minimum": -2147483648, "maximum": 2147483647}, "goal_under_funded": {"type": "integer", "format": "int64", "description": "The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_funded": {"type": "integer", "format": "int64", "description": "The total amount funded towards the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_left": {"type": "integer", "format": "int64", "description": "The amount of funding still needed to complete the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "deleted": {"type": "boolean", "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests."}}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/208f555d-1aa5-412c-af9f-1a85345571a3/1/0 | YNAB | YNAB | 0 | getMonthCategoryById | Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/6ca2cca7-a083-4fba-8c4d-779fe909c744/0/0 | YNAB | YNAB | 0 | getCategories | Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/6ca2cca7-a083-4fba-8c4d-779fe909c744/1/0 | YNAB | YNAB | 0 | getCategories | Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC). | 200 | null | {"data": {"category_groups": [{"id": "", "name": "", "hidden": true, "deleted": true, "categories": [{"id": "", "category_group_id": "", "name": "", "hidden": true, "original_category_group_id": "", "note": "", "budgeted": 0, "activity": 0, "balance": 0, "goal_type": "TB", "goal_creation_month": "", "goal_target": 0, "goal_target_month": "", "goal_percentage_complete": 0, "goal_months_to_budget": 0, "goal_under_funded": 0, "goal_overall_funded": 0, "goal_overall_left": 0, "deleted": true}]}], "server_knowledge": 0}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["category_groups", "server_knowledge"], "properties": {"category_groups": {"type": "array", "items": {"allOf": [{"type": "object", "required": ["deleted", "hidden", "id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "hidden": {"type": "boolean", "description": "Whether or not the category group is hidden"}, "deleted": {"type": "boolean", "description": "Whether or not the category group has been deleted. Deleted category groups will only be included in delta requests."}}}, {"type": "object", "required": ["categories"], "properties": {"categories": {"type": "array", "description": "Category group categories. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).", "items": {"type": "object", "required": ["activity", "balance", "budgeted", "category_group_id", "deleted", "hidden", "id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "category_group_id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "hidden": {"type": "boolean", "description": "Whether or not the category is hidden"}, "original_category_group_id": {"type": "string", "format": "uuid", "description": "If category is hidden this is the id of the category group it originally belonged to before it was hidden."}, "note": {"type": "string"}, "budgeted": {"type": "integer", "format": "int64", "description": "Budgeted amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activity": {"type": "integer", "format": "int64", "description": "Activity amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "balance": {"type": "integer", "format": "int64", "description": "Balance in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_type": {"type": "string", "description": "The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')", "enum": ["TB", "TBD", "MF", "NEED"]}, "goal_creation_month": {"type": "string", "format": "date", "description": "The month a goal was created"}, "goal_target": {"type": "integer", "format": "int64", "description": "The goal target amount in milliunits", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_target_month": {"type": "string", "format": "date", "description": "The original target month for the goal to be completed. Only some goal types specify this date."}, "goal_percentage_complete": {"type": "integer", "format": "int32", "description": "The percentage completion of the goal", "minimum": -2147483648, "maximum": 2147483647}, "goal_months_to_budget": {"type": "integer", "format": "int32", "description": "The number of months, including the current month, left in the current goal period.", "minimum": -2147483648, "maximum": 2147483647}, "goal_under_funded": {"type": "integer", "format": "int64", "description": "The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_funded": {"type": "integer", "format": "int64", "description": "The total amount funded towards the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_left": {"type": "integer", "format": "int64", "description": "The amount of funding still needed to complete the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "deleted": {"type": "boolean", "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests."}}}}}}]}}, "server_knowledge": {"type": "integer", "format": "int64", "description": "The knowledge of the server", "minimum": -9223372036854776000, "maximum": 9223372036854776000}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/e5307a56-89dd-4a21-bc2f-068ac56aea18/0/0 | YNAB | YNAB | 0 | getPayeeLocationById | Returns a single payee location | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/e5307a56-89dd-4a21-bc2f-068ac56aea18/1/0 | YNAB | YNAB | 0 | getPayeeLocationById | Returns a single payee location | 200 | null | {"data": {"payee_location": {"id": "", "payee_id": "", "latitude": "", "longitude": "", "deleted": true}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["payee_location"], "properties": {"payee_location": {"type": "object", "required": ["deleted", "id", "latitude", "longitude", "payee_id"], "properties": {"id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "latitude": {"type": "string"}, "longitude": {"type": "string"}, "deleted": {"type": "boolean", "description": "Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests."}}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/eb0ffd1e-ade3-4de9-bb13-f997a93a0c74/0/0 | YNAB | YNAB | 0 | getBudgetSettingsById | Returns settings for a budget | 200 | null | {"data": {"settings": {"date_format": {"format": ""}, "currency_format": {"iso_code": "", "example_format": "", "decimal_digits": 0, "decimal_separator": "", "symbol_first": true, "group_separator": "", "currency_symbol": "", "display_symbol": true}}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["settings"], "properties": {"settings": {"type": "object", "required": ["currency_format", "date_format"], "properties": {"date_format": {"type": "object", "required": ["format"], "properties": {"format": {"type": "string"}}, "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null."}, "currency_format": {"type": "object", "required": ["currency_symbol", "decimal_digits", "decimal_separator", "display_symbol", "example_format", "group_separator", "iso_code", "symbol_first"], "properties": {"iso_code": {"type": "string"}, "example_format": {"type": "string"}, "decimal_digits": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "decimal_separator": {"type": "string"}, "symbol_first": {"type": "boolean"}, "group_separator": {"type": "string"}, "currency_symbol": {"type": "string"}, "display_symbol": {"type": "boolean"}}, "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null."}}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/eb0ffd1e-ade3-4de9-bb13-f997a93a0c74/1/0 | YNAB | YNAB | 0 | getBudgetSettingsById | Returns settings for a budget | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/bb232499-631b-47e5-b586-6a6c364b490b/0/0 | YNAB | YNAB | 0 | getBudgets | Returns budgets list with summary information | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/bb232499-631b-47e5-b586-6a6c364b490b/1/0 | YNAB | YNAB | 0 | getBudgets | Returns budgets list with summary information | 200 | null | {"data": {"budgets": [{"id": "", "name": "", "last_modified_on": "", "first_month": "", "last_month": "", "date_format": {"format": ""}, "currency_format": {"iso_code": "", "example_format": "", "decimal_digits": 0, "decimal_separator": "", "symbol_first": true, "group_separator": "", "currency_symbol": "", "display_symbol": true}, "accounts": [{"id": "", "name": "", "type": "checking", "on_budget": true, "closed": true, "note": "", "balance": 0, "cleared_balance": 0, "uncleared_balance": 0, "transfer_payee_id": "", "deleted": true}]}], "default_budget": {"id": "", "name": "", "last_modified_on": "", "first_month": "", "last_month": "", "date_format": {"format": ""}, "currency_format": {"iso_code": "", "example_format": "", "decimal_digits": 0, "decimal_separator": "", "symbol_first": true, "group_separator": "", "currency_symbol": "", "display_symbol": true}, "accounts": [{"id": "", "name": "", "type": "checking", "on_budget": true, "closed": true, "note": "", "balance": 0, "cleared_balance": 0, "uncleared_balance": 0, "transfer_payee_id": "", "deleted": true}]}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["budgets"], "properties": {"budgets": {"type": "array", "items": {"type": "object", "required": ["id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "last_modified_on": {"type": "string", "format": "date-time", "description": "The last time any changes were made to the budget from either a web or mobile client"}, "first_month": {"type": "string", "format": "date", "description": "The earliest budget month"}, "last_month": {"type": "string", "format": "date", "description": "The latest budget month"}, "date_format": {"type": "object", "required": ["format"], "properties": {"format": {"type": "string"}}, "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null."}, "currency_format": {"type": "object", "required": ["currency_symbol", "decimal_digits", "decimal_separator", "display_symbol", "example_format", "group_separator", "iso_code", "symbol_first"], "properties": {"iso_code": {"type": "string"}, "example_format": {"type": "string"}, "decimal_digits": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "decimal_separator": {"type": "string"}, "symbol_first": {"type": "boolean"}, "group_separator": {"type": "string"}, "currency_symbol": {"type": "string"}, "display_symbol": {"type": "boolean"}}, "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null."}, "accounts": {"type": "array", "description": "The budget accounts (only included if `include_accounts=true` specified as query parameter)", "items": {"type": "object", "required": ["balance", "cleared_balance", "closed", "deleted", "id", "name", "on_budget", "transfer_payee_id", "type", "uncleared_balance"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "type": {"type": "string", "description": "The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future.", "enum": ["checking", "savings", "cash", "creditCard", "lineOfCredit", "otherAsset", "otherLiability", "payPal", "merchantAccount", "investmentAccount", "mortgage"]}, "on_budget": {"type": "boolean", "description": "Whether this account is on budget or not"}, "closed": {"type": "boolean", "description": "Whether this account is closed or not"}, "note": {"type": "string"}, "balance": {"type": "integer", "format": "int64", "description": "The current balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "cleared_balance": {"type": "integer", "format": "int64", "description": "The current cleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "uncleared_balance": {"type": "integer", "format": "int64", "description": "The current uncleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "transfer_payee_id": {"type": "string", "format": "uuid", "description": "The payee id which should be used when transferring to this account"}, "deleted": {"type": "boolean", "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests."}}}}}}}, "default_budget": {"type": "object", "required": ["id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "last_modified_on": {"type": "string", "format": "date-time", "description": "The last time any changes were made to the budget from either a web or mobile client"}, "first_month": {"type": "string", "format": "date", "description": "The earliest budget month"}, "last_month": {"type": "string", "format": "date", "description": "The latest budget month"}, "date_format": {"type": "object", "required": ["format"], "properties": {"format": {"type": "string"}}, "description": "The date format setting for the budget. In some cases the format will not be available and will be specified as null."}, "currency_format": {"type": "object", "required": ["currency_symbol", "decimal_digits", "decimal_separator", "display_symbol", "example_format", "group_separator", "iso_code", "symbol_first"], "properties": {"iso_code": {"type": "string"}, "example_format": {"type": "string"}, "decimal_digits": {"type": "integer", "format": "int32", "minimum": -2147483648, "maximum": 2147483647}, "decimal_separator": {"type": "string"}, "symbol_first": {"type": "boolean"}, "group_separator": {"type": "string"}, "currency_symbol": {"type": "string"}, "display_symbol": {"type": "boolean"}}, "description": "The currency format setting for the budget. In some cases the format will not be available and will be specified as null."}, "accounts": {"type": "array", "description": "The budget accounts (only included if `include_accounts=true` specified as query parameter)", "items": {"type": "object", "required": ["balance", "cleared_balance", "closed", "deleted", "id", "name", "on_budget", "transfer_payee_id", "type", "uncleared_balance"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "type": {"type": "string", "description": "The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future.", "enum": ["checking", "savings", "cash", "creditCard", "lineOfCredit", "otherAsset", "otherLiability", "payPal", "merchantAccount", "investmentAccount", "mortgage"]}, "on_budget": {"type": "boolean", "description": "Whether this account is on budget or not"}, "closed": {"type": "boolean", "description": "Whether this account is closed or not"}, "note": {"type": "string"}, "balance": {"type": "integer", "format": "int64", "description": "The current balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "cleared_balance": {"type": "integer", "format": "int64", "description": "The current cleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "uncleared_balance": {"type": "integer", "format": "int64", "description": "The current uncleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "transfer_payee_id": {"type": "string", "format": "uuid", "description": "The payee id which should be used when transferring to this account"}, "deleted": {"type": "boolean", "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests."}}}}}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/ab9f500c-585e-4af3-b2fa-12fbadf5ad4e/0/0 | YNAB | YNAB | 0 | getPayeeLocations | Returns all payee locations | 200 | null | {"data": {"payee_locations": [{"id": "", "payee_id": "", "latitude": "", "longitude": "", "deleted": true}]}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["payee_locations"], "properties": {"payee_locations": {"type": "array", "items": {"type": "object", "required": ["deleted", "id", "latitude", "longitude", "payee_id"], "properties": {"id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "latitude": {"type": "string"}, "longitude": {"type": "string"}, "deleted": {"type": "boolean", "description": "Whether or not the payee location has been deleted. Deleted payee locations will only be included in delta requests."}}}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/ab9f500c-585e-4af3-b2fa-12fbadf5ad4e/1/0 | YNAB | YNAB | 0 | getPayeeLocations | Returns all payee locations | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/e53d7337-1089-4a10-bcc0-d92742b87da7/0/0 | YNAB | YNAB | 0 | getBudgetMonths | Returns all budget months | 200 | null | {"data": {"months": [{"month": "", "note": "", "income": 0, "budgeted": 0, "activity": 0, "to_be_budgeted": 0, "age_of_money": 0, "deleted": true}], "server_knowledge": 0}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["months", "server_knowledge"], "properties": {"months": {"type": "array", "items": {"type": "object", "required": ["activity", "budgeted", "deleted", "income", "month", "to_be_budgeted"], "properties": {"month": {"type": "string", "format": "date"}, "note": {"type": "string"}, "income": {"type": "integer", "format": "int64", "description": "The total amount of transactions categorized to 'Inflow: To be Budgeted' in the month", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "budgeted": {"type": "integer", "format": "int64", "description": "The total amount budgeted in the month", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activity": {"type": "integer", "format": "int64", "description": "The total amount of transactions in the month, excluding those categorized to 'Inflow: To be Budgeted'", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "to_be_budgeted": {"type": "integer", "format": "int64", "description": "The available amount for 'To be Budgeted'", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "age_of_money": {"type": "integer", "format": "int32", "description": "The Age of Money as of the month", "minimum": -2147483648, "maximum": 2147483647}, "deleted": {"type": "boolean", "description": "Whether or not the month has been deleted. Deleted months will only be included in delta requests."}}}}, "server_knowledge": {"type": "integer", "format": "int64", "description": "The knowledge of the server", "minimum": -9223372036854776000, "maximum": 9223372036854776000}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/e53d7337-1089-4a10-bcc0-d92742b87da7/1/0 | YNAB | YNAB | 0 | getBudgetMonths | Returns all budget months | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/9d504c11-8154-448c-835b-eb8a219744c3/0/0 | YNAB | YNAB | 0 | getBudgetMonth | Returns a single budget month | 200 | null | {"data": {"month": {"month": "", "note": "", "income": 0, "budgeted": 0, "activity": 0, "to_be_budgeted": 0, "age_of_money": 0, "deleted": true, "categories": [{"id": "", "category_group_id": "", "name": "", "hidden": true, "original_category_group_id": "", "note": "", "budgeted": 0, "activity": 0, "balance": 0, "goal_type": "TB", "goal_creation_month": "", "goal_target": 0, "goal_target_month": "", "goal_percentage_complete": 0, "goal_months_to_budget": 0, "goal_under_funded": 0, "goal_overall_funded": 0, "goal_overall_left": 0, "deleted": true}]}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["month"], "properties": {"month": {"allOf": [{"type": "object", "required": ["activity", "budgeted", "deleted", "income", "month", "to_be_budgeted"], "properties": {"month": {"type": "string", "format": "date"}, "note": {"type": "string"}, "income": {"type": "integer", "format": "int64", "description": "The total amount of transactions categorized to 'Inflow: To be Budgeted' in the month", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "budgeted": {"type": "integer", "format": "int64", "description": "The total amount budgeted in the month", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activity": {"type": "integer", "format": "int64", "description": "The total amount of transactions in the month, excluding those categorized to 'Inflow: To be Budgeted'", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "to_be_budgeted": {"type": "integer", "format": "int64", "description": "The available amount for 'To be Budgeted'", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "age_of_money": {"type": "integer", "format": "int32", "description": "The Age of Money as of the month", "minimum": -2147483648, "maximum": 2147483647}, "deleted": {"type": "boolean", "description": "Whether or not the month has been deleted. Deleted months will only be included in delta requests."}}}, {"type": "object", "required": ["categories"], "properties": {"categories": {"type": "array", "description": "The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified.", "items": {"type": "object", "required": ["activity", "balance", "budgeted", "category_group_id", "deleted", "hidden", "id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "category_group_id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "hidden": {"type": "boolean", "description": "Whether or not the category is hidden"}, "original_category_group_id": {"type": "string", "format": "uuid", "description": "If category is hidden this is the id of the category group it originally belonged to before it was hidden."}, "note": {"type": "string"}, "budgeted": {"type": "integer", "format": "int64", "description": "Budgeted amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "activity": {"type": "integer", "format": "int64", "description": "Activity amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "balance": {"type": "integer", "format": "int64", "description": "Balance in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_type": {"type": "string", "description": "The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')", "enum": ["TB", "TBD", "MF", "NEED"]}, "goal_creation_month": {"type": "string", "format": "date", "description": "The month a goal was created"}, "goal_target": {"type": "integer", "format": "int64", "description": "The goal target amount in milliunits", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_target_month": {"type": "string", "format": "date", "description": "The original target month for the goal to be completed. Only some goal types specify this date."}, "goal_percentage_complete": {"type": "integer", "format": "int32", "description": "The percentage completion of the goal", "minimum": -2147483648, "maximum": 2147483647}, "goal_months_to_budget": {"type": "integer", "format": "int32", "description": "The number of months, including the current month, left in the current goal period.", "minimum": -2147483648, "maximum": 2147483647}, "goal_under_funded": {"type": "integer", "format": "int64", "description": "The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_funded": {"type": "integer", "format": "int64", "description": "The total amount funded towards the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "goal_overall_left": {"type": "integer", "format": "int64", "description": "The amount of funding still needed to complete the goal within the current goal period.", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "deleted": {"type": "boolean", "description": "Whether or not the category has been deleted. Deleted categories will only be included in delta requests."}}}}}}]}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/9d504c11-8154-448c-835b-eb8a219744c3/1/0 | YNAB | YNAB | 0 | getBudgetMonth | Returns a single budget month | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/f30961f9-3fa2-44b1-a841-2aa31b825f99/0/0 | YNAB | YNAB | 0 | getPayeeById | Returns a single payee | 200 | null | {"data": {"payee": {"id": "", "name": "", "transfer_account_id": "", "deleted": true}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["payee"], "properties": {"payee": {"type": "object", "required": ["deleted", "id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "transfer_account_id": {"type": "string", "description": "If a transfer payee, the `account_id` to which this payee transfers to"}, "deleted": {"type": "boolean", "description": "Whether or not the payee has been deleted. Deleted payees will only be included in delta requests."}}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/f30961f9-3fa2-44b1-a841-2aa31b825f99/1/0 | YNAB | YNAB | 0 | getPayeeById | Returns a single payee | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/2592dc13-5937-4b6a-befb-45912e66a829/0/0 | YNAB | YNAB | 0 | bulkCreateTransactions | Creates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions. | 400 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/2592dc13-5937-4b6a-befb-45912e66a829/1/0 | YNAB | YNAB | 0 | bulkCreateTransactions | Creates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions. | 201 | null | {"data": {"bulk": {"transaction_ids": [], "duplicate_import_ids": []}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["bulk"], "properties": {"bulk": {"type": "object", "required": ["duplicate_import_ids", "transaction_ids"], "properties": {"transaction_ids": {"type": "array", "description": "The list of Transaction ids that were created.", "items": {"type": "string"}}, "duplicate_import_ids": {"type": "array", "description": "If any Transactions were not created because they had an `import_id` matching a transaction already on the same account, the specified import_id(s) will be included in this list.", "items": {"type": "string"}}}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/37e59505-234f-4dc8-980d-18c8f366de79/0/0 | YNAB | YNAB | 0 | getUser | Returns authenticated user information | 200 | null | {"data": {"user": {"id": ""}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["user"], "properties": {"user": {"type": "object", "required": ["id"], "properties": {"id": {"type": "string", "format": "uuid"}}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/f04b6379-f62f-4b2e-b47b-36c7ab02a187/0/0 | YNAB | YNAB | 0 | getAccountById | Returns a single account | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/f04b6379-f62f-4b2e-b47b-36c7ab02a187/1/0 | YNAB | YNAB | 0 | getAccountById | Returns a single account | 200 | null | {"data": {"account": {"id": "", "name": "", "type": "checking", "on_budget": true, "closed": true, "note": "", "balance": 0, "cleared_balance": 0, "uncleared_balance": 0, "transfer_payee_id": "", "deleted": true}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["account"], "properties": {"account": {"type": "object", "required": ["balance", "cleared_balance", "closed", "deleted", "id", "name", "on_budget", "transfer_payee_id", "type", "uncleared_balance"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "type": {"type": "string", "description": "The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future.", "enum": ["checking", "savings", "cash", "creditCard", "lineOfCredit", "otherAsset", "otherLiability", "payPal", "merchantAccount", "investmentAccount", "mortgage"]}, "on_budget": {"type": "boolean", "description": "Whether this account is on budget or not"}, "closed": {"type": "boolean", "description": "Whether this account is closed or not"}, "note": {"type": "string"}, "balance": {"type": "integer", "format": "int64", "description": "The current balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "cleared_balance": {"type": "integer", "format": "int64", "description": "The current cleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "uncleared_balance": {"type": "integer", "format": "int64", "description": "The current uncleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "transfer_payee_id": {"type": "string", "format": "uuid", "description": "The payee id which should be used when transferring to this account"}, "deleted": {"type": "boolean", "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests."}}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/71151d62-5651-4848-9650-bb86308885c2/0/0 | YNAB | YNAB | 0 | getAccounts | Returns all accounts | 200 | null | {"data": {"accounts": [{"id": "", "name": "", "type": "checking", "on_budget": true, "closed": true, "note": "", "balance": 0, "cleared_balance": 0, "uncleared_balance": 0, "transfer_payee_id": "", "deleted": true}], "server_knowledge": 0}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["accounts", "server_knowledge"], "properties": {"accounts": {"type": "array", "items": {"type": "object", "required": ["balance", "cleared_balance", "closed", "deleted", "id", "name", "on_budget", "transfer_payee_id", "type", "uncleared_balance"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "type": {"type": "string", "description": "The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future.", "enum": ["checking", "savings", "cash", "creditCard", "lineOfCredit", "otherAsset", "otherLiability", "payPal", "merchantAccount", "investmentAccount", "mortgage"]}, "on_budget": {"type": "boolean", "description": "Whether this account is on budget or not"}, "closed": {"type": "boolean", "description": "Whether this account is closed or not"}, "note": {"type": "string"}, "balance": {"type": "integer", "format": "int64", "description": "The current balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "cleared_balance": {"type": "integer", "format": "int64", "description": "The current cleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "uncleared_balance": {"type": "integer", "format": "int64", "description": "The current uncleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "transfer_payee_id": {"type": "string", "format": "uuid", "description": "The payee id which should be used when transferring to this account"}, "deleted": {"type": "boolean", "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests."}}}}, "server_knowledge": {"type": "integer", "format": "int64", "description": "The knowledge of the server", "minimum": -9223372036854776000, "maximum": 9223372036854776000}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/71151d62-5651-4848-9650-bb86308885c2/1/0 | YNAB | YNAB | 0 | getAccounts | Returns all accounts | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/378c36cb-eea1-4b52-806b-4525b12c4b38/0/0 | YNAB | YNAB | 0 | createAccount | Creates a new account | 201 | null | {"data": {"account": {"id": "", "name": "", "type": "checking", "on_budget": true, "closed": true, "note": "", "balance": 0, "cleared_balance": 0, "uncleared_balance": 0, "transfer_payee_id": "", "deleted": true}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["account"], "properties": {"account": {"type": "object", "required": ["balance", "cleared_balance", "closed", "deleted", "id", "name", "on_budget", "transfer_payee_id", "type", "uncleared_balance"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "type": {"type": "string", "description": "The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future.", "enum": ["checking", "savings", "cash", "creditCard", "lineOfCredit", "otherAsset", "otherLiability", "payPal", "merchantAccount", "investmentAccount", "mortgage"]}, "on_budget": {"type": "boolean", "description": "Whether this account is on budget or not"}, "closed": {"type": "boolean", "description": "Whether this account is closed or not"}, "note": {"type": "string"}, "balance": {"type": "integer", "format": "int64", "description": "The current balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "cleared_balance": {"type": "integer", "format": "int64", "description": "The current cleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "uncleared_balance": {"type": "integer", "format": "int64", "description": "The current uncleared balance of the account in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "transfer_payee_id": {"type": "string", "format": "uuid", "description": "The payee id which should be used when transferring to this account"}, "deleted": {"type": "boolean", "description": "Whether or not the account has been deleted. Deleted accounts will only be included in delta requests."}}}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/378c36cb-eea1-4b52-806b-4525b12c4b38/1/0 | YNAB | YNAB | 0 | createAccount | Creates a new account | 400 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/0f0a56f3-cccc-4cb8-a9b4-d1f24ff849e2/0/0 | YNAB | YNAB | 0 | getPayees | Returns all payees | 200 | null | {"data": {"payees": [{"id": "", "name": "", "transfer_account_id": "", "deleted": true}], "server_knowledge": 0}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["payees", "server_knowledge"], "properties": {"payees": {"type": "array", "items": {"type": "object", "required": ["deleted", "id", "name"], "properties": {"id": {"type": "string", "format": "uuid"}, "name": {"type": "string"}, "transfer_account_id": {"type": "string", "description": "If a transfer payee, the `account_id` to which this payee transfers to"}, "deleted": {"type": "boolean", "description": "Whether or not the payee has been deleted. Deleted payees will only be included in delta requests."}}}}, "server_knowledge": {"type": "integer", "format": "int64", "description": "The knowledge of the server", "minimum": -9223372036854776000, "maximum": 9223372036854776000}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/0f0a56f3-cccc-4cb8-a9b4-d1f24ff849e2/1/0 | YNAB | YNAB | 0 | getPayees | Returns all payees | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/c8eb6e6f-f944-47cb-9ca3-803edcbfbd04/0/0 | YNAB | YNAB | 0 | getScheduledTransactionById | Returns a single scheduled transaction | 200 | null | {"data": {"scheduled_transaction": {"id": "", "date_first": "", "date_next": "", "frequency": "never", "amount": 0, "memo": "", "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "deleted": true, "account_name": "", "payee_name": "", "category_name": "", "subtransactions": [{"id": "", "scheduled_transaction_id": "", "amount": 0, "memo": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "deleted": true}]}}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["scheduled_transaction"], "properties": {"scheduled_transaction": {"allOf": [{"type": "object", "required": ["account_id", "amount", "date_first", "date_next", "deleted", "frequency", "id"], "properties": {"id": {"type": "string", "format": "uuid"}, "date_first": {"type": "string", "format": "date", "description": "The first date for which the Scheduled Transaction was scheduled."}, "date_next": {"type": "string", "format": "date", "description": "The next date for which the Scheduled Transaction is scheduled."}, "frequency": {"type": "string", "enum": ["never", "daily", "weekly", "everyOtherWeek", "twiceAMonth", "every4Weeks", "monthly", "everyOtherMonth", "every3Months", "every4Months", "twiceAYear", "yearly", "everyOtherYear"]}, "amount": {"type": "integer", "format": "int64", "description": "The scheduled transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "flag_color": {"type": "string", "description": "The scheduled transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the scheduled transaction transfers to"}, "deleted": {"type": "boolean", "description": "Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests."}}}, {"type": "object", "required": ["account_name", "subtransactions"], "properties": {"account_name": {"type": "string"}, "payee_name": {"type": "string"}, "category_name": {"type": "string"}, "subtransactions": {"type": "array", "description": "If a split scheduled transaction, the subtransactions.", "items": {"type": "object", "required": ["amount", "deleted", "id", "scheduled_transaction_id"], "properties": {"id": {"type": "string", "format": "uuid"}, "scheduled_transaction_id": {"type": "string", "format": "uuid"}, "amount": {"type": "integer", "format": "int64", "description": "The scheduled subtransaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the scheduled subtransaction transfers to"}, "deleted": {"type": "boolean", "description": "Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests."}}}}}}]}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/c8eb6e6f-f944-47cb-9ca3-803edcbfbd04/1/0 | YNAB | YNAB | 0 | getScheduledTransactionById | Returns a single scheduled transaction | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/12983763-cfaf-4bf6-93e4-86053c0276f1/0/0 | YNAB | YNAB | 0 | getScheduledTransactions | Returns all scheduled transactions | 404 | null | {"error": {"id": "", "name": "", "detail": ""}} | {"type": "object", "required": ["error"], "properties": {"error": {"type": "object", "required": ["detail", "id", "name"], "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "detail": {"type": "string"}}}}} |
5485c52e-7e9c-4322-8210-0236ea23e936/12983763-cfaf-4bf6-93e4-86053c0276f1/1/0 | YNAB | YNAB | 0 | getScheduledTransactions | Returns all scheduled transactions | 200 | null | {"data": {"scheduled_transactions": [{"id": "", "date_first": "", "date_next": "", "frequency": "never", "amount": 0, "memo": "", "flag_color": "red", "account_id": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "deleted": true, "account_name": "", "payee_name": "", "category_name": "", "subtransactions": [{"id": "", "scheduled_transaction_id": "", "amount": 0, "memo": "", "payee_id": "", "category_id": "", "transfer_account_id": "", "deleted": true}]}], "server_knowledge": 0}} | {"type": "object", "required": ["data"], "properties": {"data": {"type": "object", "required": ["scheduled_transactions", "server_knowledge"], "properties": {"scheduled_transactions": {"type": "array", "items": {"allOf": [{"type": "object", "required": ["account_id", "amount", "date_first", "date_next", "deleted", "frequency", "id"], "properties": {"id": {"type": "string", "format": "uuid"}, "date_first": {"type": "string", "format": "date", "description": "The first date for which the Scheduled Transaction was scheduled."}, "date_next": {"type": "string", "format": "date", "description": "The next date for which the Scheduled Transaction is scheduled."}, "frequency": {"type": "string", "enum": ["never", "daily", "weekly", "everyOtherWeek", "twiceAMonth", "every4Weeks", "monthly", "everyOtherMonth", "every3Months", "every4Months", "twiceAYear", "yearly", "everyOtherYear"]}, "amount": {"type": "integer", "format": "int64", "description": "The scheduled transaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "flag_color": {"type": "string", "description": "The scheduled transaction flag", "enum": ["red", "orange", "yellow", "green", "blue", "purple"]}, "account_id": {"type": "string", "format": "uuid"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the scheduled transaction transfers to"}, "deleted": {"type": "boolean", "description": "Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests."}}}, {"type": "object", "required": ["account_name", "subtransactions"], "properties": {"account_name": {"type": "string"}, "payee_name": {"type": "string"}, "category_name": {"type": "string"}, "subtransactions": {"type": "array", "description": "If a split scheduled transaction, the subtransactions.", "items": {"type": "object", "required": ["amount", "deleted", "id", "scheduled_transaction_id"], "properties": {"id": {"type": "string", "format": "uuid"}, "scheduled_transaction_id": {"type": "string", "format": "uuid"}, "amount": {"type": "integer", "format": "int64", "description": "The scheduled subtransaction amount in milliunits format", "minimum": -9223372036854776000, "maximum": 9223372036854776000}, "memo": {"type": "string"}, "payee_id": {"type": "string", "format": "uuid"}, "category_id": {"type": "string", "format": "uuid"}, "transfer_account_id": {"type": "string", "format": "uuid", "description": "If a transfer, the account_id which the scheduled subtransaction transfers to"}, "deleted": {"type": "boolean", "description": "Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests."}}}}}}]}}, "server_knowledge": {"type": "integer", "format": "int64", "description": "The knowledge of the server", "minimum": -9223372036854776000, "maximum": 9223372036854776000}}}}} |
e25b5387-d7af-4c9d-9b9b-a3248d5d594f/be2d584e-470c-4ccb-9375-9d8e0088b429/0/0 | Flutterwave | Flutterwave FLW-V3 | null | VIRTUAL CARDS | Create virtual card | 200 | New Example | {"key1": "value", "key2": "value"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"key1": {"type": "string"}, "key2": {"type": "string"}}, "required": ["key1", "key2"]} |
2c96bab4-e208-4998-9b7d-ab14760aa5d9/82ed0efb-8591-4b37-835f-2844b7cafc31/0/0 | Chinese IDCard Identify | No burping!
Refresh on the second day | null | basic | Identify Chinese IDCard | 200 | Success | {"code": 0, "data": "\u8ba4\u8bc1\u6210\u529f\uff01"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "data": {"type": "string"}}, "required": ["code", "data"]} |
2c96bab4-e208-4998-9b7d-ab14760aa5d9/82ed0efb-8591-4b37-835f-2844b7cafc31/0/1 | Chinese IDCard Identify | No burping!
Refresh on the second day | null | basic | Identify Chinese IDCard | 200 | Mismatch | {"code": 1, "message": "\u8ba4\u8bc1\u5931\u8d25\uff01\u8eab\u4efd\u4fe1\u606f\u65e0\u6548"} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "message": {"type": "string"}}, "required": ["code", "message"]} |
31ebef81-2a4e-4a27-be4e-50760917de70/ed89ff4c-4ad6-40be-ab4a-1edeca9bb8c1/0/0 | EPC QR Code | Generate EPC QR Codes to use it on your invoices and payment requests. | null | generateEpcQrCode | Generate EPC QR Codes to use it on your invoices and payment requests. | 406 | Example_1 | {"messages": []} | {"required": ["messages"], "type": "object", "properties": {"messages": {"description": "A list of error messages", "type": "array", "items": {"type": "string"}}}} |
31ebef81-2a4e-4a27-be4e-50760917de70/ed89ff4c-4ad6-40be-ab4a-1edeca9bb8c1/1/0 | EPC QR Code | Generate EPC QR Codes to use it on your invoices and payment requests. | null | generateEpcQrCode | Generate EPC QR Codes to use it on your invoices and payment requests. | 503 | Example_1 | {"messages": []} | {"required": ["messages"], "type": "object", "properties": {"messages": {"description": "A list of error messages", "type": "array", "items": {"type": "string"}}}} |
31ebef81-2a4e-4a27-be4e-50760917de70/ed89ff4c-4ad6-40be-ab4a-1edeca9bb8c1/2/0 | EPC QR Code | Generate EPC QR Codes to use it on your invoices and payment requests. | null | generateEpcQrCode | Generate EPC QR Codes to use it on your invoices and payment requests. | 403 | Example_1 | {"messages": []} | {"required": ["messages"], "type": "object", "properties": {"messages": {"description": "A list of error messages", "type": "array", "items": {"type": "string"}}}} |
31ebef81-2a4e-4a27-be4e-50760917de70/ed89ff4c-4ad6-40be-ab4a-1edeca9bb8c1/4/0 | EPC QR Code | Generate EPC QR Codes to use it on your invoices and payment requests. | null | generateEpcQrCode | Generate EPC QR Codes to use it on your invoices and payment requests. | 500 | Example_1 | {"messages": []} | {"required": ["messages"], "type": "object", "properties": {"messages": {"description": "A list of error messages", "type": "array", "items": {"type": "string"}}}} |
31ebef81-2a4e-4a27-be4e-50760917de70/ed89ff4c-4ad6-40be-ab4a-1edeca9bb8c1/5/0 | EPC QR Code | Generate EPC QR Codes to use it on your invoices and payment requests. | null | generateEpcQrCode | Generate EPC QR Codes to use it on your invoices and payment requests. | 402 | Example_1 | {"messages": []} | {"required": ["messages"], "type": "object", "properties": {"messages": {"description": "A list of error messages", "type": "array", "items": {"type": "string"}}}} |
af71f4b1-9a34-465a-a1c7-0a346e0cf8e6/2b7ae402-af22-43ef-84c0-f88257eec8fe/0/0 | Virtual Accounts API | Use this API to create virtual accounts, manage them, create financial transations, create transaction channels (payment provider). | 0.3 | GetTransactionsByAccount | To get transactions by account. | 500 | Example_1 | {"message": "in exercitation non", "generated_on": "1972-09-24T11:22:30.054Z", "data": "in", "api_version": "enim sit", "success": true} | {"type": "object", "properties": {"message": {"type": "string", "description": "", "default": "in exercitation non"}, "generated_on": {"type": "string", "description": "", "default": "1972-09-24T11:22:30.054Z"}, "data": {"type": "string", "description": "", "default": "in"}, "api_version": {"type": "string", "description": "", "default": "enim sit"}, "success": {"type": "boolean", "description": "", "default": true}}} |
af71f4b1-9a34-465a-a1c7-0a346e0cf8e6/2b7ae402-af22-43ef-84c0-f88257eec8fe/1/0 | Virtual Accounts API | Use this API to create virtual accounts, manage them, create financial transations, create transaction channels (payment provider). | 0.3 | GetTransactionsByAccount | To get transactions by account. | 200 | Example_1 | {"message": "Transactions retrieved successfully.", "generated_on": "2022-10-02T14:15:42.3201271+00:00", "data": [{"transactionId": "ee25e6ff-2ef5-441c-8efa-70f8fcad8458", "transactionSerial": 405508847, "transactionReference": "10201028273532320132012", "amount": 1500, "fee": 10, "creditedAccount": "5050189006", "debitedAccount": "1200022399", "account": null, "channel": null, "isDeleted": false, "isActive": true, "createdAt": "2022-10-02T14:13:47.4353328Z", "updateAt": "2022-10-02T14:13:47.4353331Z", "modifiedAt": "2022-10-02T14:15:42.3198311+00:00"}, {"transactionId": "0907fca0-699c-432e-8391-57ed3bb6c9b3", "transactionSerial": 120985074, "transactionReference": "102010282735323201320162", "amount": 1500, "fee": 10, "creditedAccount": "5050189006", "debitedAccount": "1200022399", "account": null, "channel": null, "isDeleted": false, "isActive": true, "createdAt": "2022-10-02T14:14:19.4663085Z", "updateAt": "2022-10-02T14:14:19.4663088Z", "modifiedAt": "2022-10-02T14:15:42.3199116+00:00"}], "api_version": "1.0", "success": true} | {"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"message": {"type": "string"}, "generated_on": {"type": "string"}, "data": {"type": "array", "items": {"type": "object", "properties": {"transactionId": {"type": "string"}, "transactionSerial": {"type": "integer"}, "transactionReference": {"type": "string"}, "amount": {"type": "integer"}, "fee": {"type": "integer"}, "creditedAccount": {"type": "string"}, "debitedAccount": {"type": "string"}, "account": {"type": "null"}, "channel": {"type": "null"}, "isDeleted": {"type": "boolean"}, "isActive": {"type": "boolean"}, "createdAt": {"type": "string"}, "updateAt": {"type": "string"}, "modifiedAt": {"type": "string"}}, "required": ["account", "amount", "channel", "createdAt", "creditedAccount", "debitedAccount", "fee", "isActive", "isDeleted", "modifiedAt", "transactionId", "transactionReference", "transactionSerial", "updateAt"]}}, "api_version": {"type": "string"}, "success": {"type": "boolean"}}, "required": ["api_version", "data", "generated_on", "message", "success"]} |
af71f4b1-9a34-465a-a1c7-0a346e0cf8e6/2b7ae402-af22-43ef-84c0-f88257eec8fe/2/0 | Virtual Accounts API | Use this API to create virtual accounts, manage them, create financial transations, create transaction channels (payment provider). | 0.3 | GetTransactionsByAccount | To get transactions by account. | 403 | Example_1 | {"error": "qui"} | {"type": "object", "properties": {"error": {"type": "string", "description": "", "default": "qui"}}} |
af71f4b1-9a34-465a-a1c7-0a346e0cf8e6/2b7ae402-af22-43ef-84c0-f88257eec8fe/3/0 | Virtual Accounts API | Use this API to create virtual accounts, manage them, create financial transations, create transaction channels (payment provider). | 0.3 | GetTransactionsByAccount | To get transactions by account. | 404 | Example_1 | {"error": "qui"} | {"type": "object", "properties": {"error": {"type": "string", "description": "", "default": "qui"}}} |
af71f4b1-9a34-465a-a1c7-0a346e0cf8e6/2b7ae402-af22-43ef-84c0-f88257eec8fe/4/0 | Virtual Accounts API | Use this API to create virtual accounts, manage them, create financial transations, create transaction channels (payment provider). | 0.3 | GetTransactionsByAccount | To get transactions by account. | 406 | Example_1 | {"error": "qui"} | {"type": "object", "properties": {"error": {"type": "string", "description": "", "default": "qui"}}} |
af71f4b1-9a34-465a-a1c7-0a346e0cf8e6/2b7ae402-af22-43ef-84c0-f88257eec8fe/5/0 | Virtual Accounts API | Use this API to create virtual accounts, manage them, create financial transations, create transaction channels (payment provider). | 0.3 | GetTransactionsByAccount | To get transactions by account. | 415 | Example_1 | {"error": "qui"} | {"type": "object", "properties": {"error": {"type": "string", "description": "", "default": "qui"}}} |
af71f4b1-9a34-465a-a1c7-0a346e0cf8e6/2b7ae402-af22-43ef-84c0-f88257eec8fe/6/0 | Virtual Accounts API | Use this API to create virtual accounts, manage them, create financial transations, create transaction channels (payment provider). | 0.3 | GetTransactionsByAccount | To get transactions by account. | 429 | Example_1 | {"error": "qui"} | {"type": "object", "properties": {"error": {"type": "string", "description": "", "default": "qui"}}} |
af71f4b1-9a34-465a-a1c7-0a346e0cf8e6/2b7ae402-af22-43ef-84c0-f88257eec8fe/7/0 | Virtual Accounts API | Use this API to create virtual accounts, manage them, create financial transations, create transaction channels (payment provider). | 0.3 | GetTransactionsByAccount | To get transactions by account. | 401 | Example_1 | {"error": "qui"} | {"type": "object", "properties": {"error": {"type": "string", "description": "", "default": "qui"}}} |
af71f4b1-9a34-465a-a1c7-0a346e0cf8e6/6ddf3655-b4e6-4b8f-985b-c14b5834c808/0/0 | Virtual Accounts API | Use this API to create virtual accounts, manage them, create financial transations, create transaction channels (payment provider). | 0.3 | GetByAccountNumber | To get a virtual account by account number. | 404 | Example_1 | {"error": "qui"} | {"type": "object", "properties": {"error": {"type": "string", "description": "", "default": "qui"}}} |
af71f4b1-9a34-465a-a1c7-0a346e0cf8e6/6ddf3655-b4e6-4b8f-985b-c14b5834c808/1/0 | Virtual Accounts API | Use this API to create virtual accounts, manage them, create financial transations, create transaction channels (payment provider). | 0.3 | GetByAccountNumber | To get a virtual account by account number. | 500 | Example_1 | {"message": "in exercitation non", "generated_on": "1972-09-24T11:22:30.054Z", "data": "in", "api_version": "enim sit", "success": true} | {"type": "object", "properties": {"message": {"type": "string", "description": "", "default": "in exercitation non"}, "generated_on": {"type": "string", "description": "", "default": "1972-09-24T11:22:30.054Z"}, "data": {"type": "string", "description": "", "default": "in"}, "api_version": {"type": "string", "description": "", "default": "enim sit"}, "success": {"type": "boolean", "description": "", "default": true}}} |
af71f4b1-9a34-465a-a1c7-0a346e0cf8e6/6ddf3655-b4e6-4b8f-985b-c14b5834c808/2/0 | Virtual Accounts API | Use this API to create virtual accounts, manage them, create financial transations, create transaction channels (payment provider). | 0.3 | GetByAccountNumber | To get a virtual account by account number. | 403 | Example_1 | {"error": "qui"} | {"type": "object", "properties": {"error": {"type": "string", "description": "", "default": "qui"}}} |
af71f4b1-9a34-465a-a1c7-0a346e0cf8e6/6ddf3655-b4e6-4b8f-985b-c14b5834c808/3/0 | Virtual Accounts API | Use this API to create virtual accounts, manage them, create financial transations, create transaction channels (payment provider). | 0.3 | GetByAccountNumber | To get a virtual account by account number. | 406 | Example_1 | {"error": "qui"} | {"type": "object", "properties": {"error": {"type": "string", "description": "", "default": "qui"}}} |
af71f4b1-9a34-465a-a1c7-0a346e0cf8e6/6ddf3655-b4e6-4b8f-985b-c14b5834c808/4/0 | Virtual Accounts API | Use this API to create virtual accounts, manage them, create financial transations, create transaction channels (payment provider). | 0.3 | GetByAccountNumber | To get a virtual account by account number. | 401 | Example_1 | {"error": "qui"} | {"type": "object", "properties": {"error": {"type": "string", "description": "", "default": "qui"}}} |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.