{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:fire/get-accounts":{"get":{"operationId":"finance_fire_get_accounts","summary":"List all fire.com Accounts","description":"GET /v1/accounts","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/add-account":{"post":{"operationId":"finance_fire_add_account","summary":"Add a new account","description":"POST /v1/accounts","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/get-account-by-id":{"get":{"operationId":"finance_fire_get_account_by_id","summary":"Retrieve the details of a fire.com Account","description":"GET /v1/accounts/{ican}","tags":["finance"],"parameters":[{"name":"ican","in":"query","required":true,"description":"The ican of the account to retrieve","schema":{"type":"integer","description":"The ican of the account to retrieve"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/create-api-application":{"post":{"operationId":"finance_fire_create_api_application","summary":"Create a new API Application","description":"POST /v1/apps","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/authenticate":{"post":{"operationId":"finance_fire_authenticate","summary":"Authenticate with the API.","description":"POST /v1/apps/accesstokens","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/get-list-of-aspsps":{"get":{"operationId":"finance_fire_get_list_of_aspsps","summary":"Get list of ASPSPs / Banks","description":"GET /v1/aspsps","tags":["finance"],"parameters":[{"name":"currency","in":"query","required":false,"description":"The three letter code for the currency - either `EUR` or `GBP`. Use this to filter the list for banks that can be used to pay in a certain…","schema":{"type":"string","description":"The three letter code for the currency - either `EUR` or `GBP`. Use this to filter the list for banks that can be used to pay in a certain…"},"example":"EUR"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/get-batches":{"get":{"operationId":"finance_fire_get_batches","summary":"List batches","description":"GET /v1/batches","tags":["finance"],"parameters":[{"name":"batchStatus","in":"query","required":false,"description":"The status of the batch if internal transfer.","schema":{"type":"string","enum":["SUBMITTED","REMOVED","SUCCEEDED","FAILED"],"description":"The status of the batch if internal transfer."}},{"name":"batchTypes","in":"query","required":false,"description":"The type of the batch. Can be one of the listed enums.","schema":{"type":"string","enum":["INTERNAL_TRANSFER","BANK_TRANSFER","INTERNATIONAL_TRANSFER","NEW_PAYEE"],"description":"The type of the batch. Can be one of the listed enums."}},{"name":"orderBy","in":"query","required":false,"description":"You can order the batches by date. No other options at this time","schema":{"type":"string","enum":["DATE"],"description":"You can order the batches by date. No other options at this time"}},{"name":"order","in":"query","required":false,"description":"You can order the batches by ascending or descending order.","schema":{"type":"string","enum":["DESC","ASC"],"description":"You can order the batches by ascending or descending order."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/create-batch-payment":{"post":{"operationId":"finance_fire_create_batch_payment","summary":"Create a new batch of payments","description":"POST /v1/batches","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/get-details-single-batch":{"get":{"operationId":"finance_fire_get_details_single_batch","summary":"Get details of a single Batch","description":"GET /v1/batches/{batchUuid}","tags":["finance"],"parameters":[{"name":"batchUuid","in":"query","required":true,"description":"The uuid of the batch.","schema":{"type":"string","description":"The uuid of the batch."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/submit-batch":{"post":{"operationId":"finance_fire_submit_batch","summary":"Submit a batch for approval","description":"PUT /v1/batches/{batchUuid}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batchUuid"],"properties":{"batchUuid":{"type":"string","description":"The uuid of the batch."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/cancel-batch-payment":{"post":{"operationId":"finance_fire_cancel_batch_payment","summary":"Cancel a batch","description":"DELETE /v1/batches/{batchUuid}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batchUuid"],"properties":{"batchUuid":{"type":"string","description":"The uuid of the batch."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/get-listof-approvers-for-batch":{"get":{"operationId":"finance_fire_get_listof_approvers_for_batch","summary":"List Approvers for a Batch","description":"GET /v1/batches/{batchUuid}/approvals","tags":["finance"],"parameters":[{"name":"batchUuid","in":"query","required":true,"description":"The uuid of the batch.","schema":{"type":"string","description":"The uuid of the batch."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/get-items-batch-bank-transfer":{"get":{"operationId":"finance_fire_get_items_batch_bank_transfer","summary":"List items in a Batch (Bank Transfers)","description":"GET /v1/batches/{batchUuid}/banktransfers","tags":["finance"],"parameters":[{"name":"batchUuid","in":"query","required":true,"description":"The uuid of the batch.","schema":{"type":"string","description":"The uuid of the batch."}},{"name":"offset","in":"query","required":false,"description":"The page offset. Defaults to 0. This is the record number that the returned list will start at. E.g. offset = 40 and limit = 20 will…","schema":{"type":"integer","description":"The page offset. Defaults to 0. This is the record number that the returned list will start at. E.g. offset = 40 and limit = 20 will…"}},{"name":"limit","in":"query","required":false,"description":"The number of records to return. Defaults to 10 - max is 200.","schema":{"type":"integer","description":"The number of records to return. Defaults to 10 - max is 200."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/add-bank-transfer-batch-payment":{"post":{"operationId":"finance_fire_add_bank_transfer_batch_payment","summary":"Add a bank transfer payment to the batch.","description":"POST /v1/batches/{batchUuid}/banktransfers","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batchUuid","body"],"properties":{"batchUuid":{"type":"string","description":"The uuid of the batch."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/delete-bank-transfer-batch-payment":{"post":{"operationId":"finance_fire_delete_bank_transfer_batch_payment","summary":"Remove a Payment from the Batch (Bank Transfers)","description":"DELETE /v1/batches/{batchUuid}/banktransfers/{itemUuid}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batchUuid","itemUuid"],"properties":{"batchUuid":{"type":"string","description":"The uuid of the batch."},"itemUuid":{"type":"string","description":"The uuid of the item to remove."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/get-items-batch-internal-trasnfer":{"get":{"operationId":"finance_fire_get_items_batch_internal_trasnfer","summary":"List items in a Batch (Internal Transfers)","description":"GET /v1/batches/{batchUuid}/internaltransfers","tags":["finance"],"parameters":[{"name":"batchUuid","in":"query","required":true,"description":"The uuid of the batch.","schema":{"type":"string","description":"The uuid of the batch."}},{"name":"offset","in":"query","required":false,"description":"The page offset. Defaults to 0. This is the record number that the returned list will start at. E.g. offset = 40 and limit = 20 will…","schema":{"type":"integer","description":"The page offset. Defaults to 0. This is the record number that the returned list will start at. E.g. offset = 40 and limit = 20 will…"}},{"name":"limit","in":"query","required":false,"description":"The number of records to return. Defaults to 10 - max is 200.","schema":{"type":"integer","description":"The number of records to return. Defaults to 10 - max is 200."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/add-internal-transfer-batch-payment":{"post":{"operationId":"finance_fire_add_internal_transfer_batch_payment","summary":"Add an internal transfer payment to the batch","description":"POST /v1/batches/{batchUuid}/internaltransfers","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batchUuid","body"],"properties":{"batchUuid":{"type":"string","description":"The uuid of the batch."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/delete-internal-transfer-batch-payment":{"post":{"operationId":"finance_fire_delete_internal_transfer_batch_payment","summary":"Remove a Payment from the Batch (Internal Transfer)","description":"DELETE /v1/batches/{batchUuid}/internaltransfers/{itemUuid}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batchUuid","itemUuid"],"properties":{"batchUuid":{"type":"string","description":"The uuid of the batch."},"itemUuid":{"type":"string","description":"The uuid of the item to remove."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/get-listof-cards":{"get":{"operationId":"finance_fire_get_listof_cards","summary":"View List of Cards.","description":"GET /v1/cards","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/create-new-card":{"post":{"operationId":"finance_fire_create_new_card","summary":"Create a new debit card.","description":"POST /v1/cards","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/block-card":{"post":{"operationId":"finance_fire_block_card","summary":"Block a card","description":"POST /v1/cards/{cardId}/block","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cardId"],"properties":{"cardId":{"type":"integer","description":"The cardid of the card to block"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/get-listof-card-transactions":{"get":{"operationId":"finance_fire_get_listof_card_transactions","summary":"List Card Transactions.","description":"GET /v1/cards/{cardId}/transactions","tags":["finance"],"parameters":[{"name":"cardId","in":"query","required":true,"description":"The cardid of the card to retrieve the associated transactions","schema":{"type":"integer","description":"The cardid of the card to retrieve the associated transactions"}},{"name":"limit","in":"query","required":false,"description":"The number of records to return","schema":{"type":"integer","description":"The number of records to return"}},{"name":"offset","in":"query","required":false,"description":"The page of records to return","schema":{"type":"integer","description":"The page of records to return"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/unblock-card":{"post":{"operationId":"finance_fire_unblock_card","summary":"Unblock a card","description":"POST /v1/cards/{cardId}/unblock","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["cardId"],"properties":{"cardId":{"type":"integer","description":"The cardid of the card to unblock"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/get-direct-debits-for-mandate-uuid":{"get":{"operationId":"finance_fire_get_direct_debits_for_mandate_uuid","summary":"Get all DD payments associated with a direct debit mandate","description":"GET /v1/directdebits","tags":["finance"],"parameters":[{"name":"mandateUuid","in":"query","required":true,"description":"The mandate UUID to retrieve","schema":{"type":"string","description":"The mandate UUID to retrieve"},"example":"1A07774B-1461-4595-BC4B-423B739712AF"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/get-direct-debit-by-uuid":{"get":{"operationId":"finance_fire_get_direct_debit_by_uuid","summary":"Get the details of a direct debit","description":"GET /v1/directdebits/{directDebitUuid}","tags":["finance"],"parameters":[{"name":"directDebitUuid","in":"query","required":true,"description":"The uuid of the direct debit to retrieve.","schema":{"type":"string","description":"The uuid of the direct debit to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/reject-direct-debit":{"post":{"operationId":"finance_fire_reject_direct_debit","summary":"Reject a direct debit payment","description":"POST /v1/directdebits/{directDebitUuid}/reject","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["directDebitUuid"],"properties":{"directDebitUuid":{"type":"string","description":"The uuid of the direct debit to retrieve."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/get-direct-debit-mandates":{"get":{"operationId":"finance_fire_get_direct_debit_mandates","summary":"List all direct debit mandates","description":"GET /v1/mandates","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/get-mandate":{"get":{"operationId":"finance_fire_get_mandate","summary":"Get direct debit mandate details","description":"GET /v1/mandates/{mandateUuid}","tags":["finance"],"parameters":[{"name":"mandateUuid","in":"query","required":true,"description":"The uuid of the mandate to retrieve.","schema":{"type":"string","description":"The uuid of the mandate to retrieve."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/update-mandate-alias":{"post":{"operationId":"finance_fire_update_mandate_alias","summary":"Update a direct debit mandate alias","description":"POST /v1/mandates/{mandateUuid}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["mandateUuid"],"properties":{"mandateUuid":{"type":"string","description":"The uuid of the mandate to update."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/activate-mandate":{"post":{"operationId":"finance_fire_activate_mandate","summary":"Activate a direct debit mandate","description":"POST /v1/mandates/{mandateUuid}/activate","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["mandateUuid"],"properties":{"mandateUuid":{"type":"string","description":"The uuid of the mandate to activate."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/cancel-mandate-by-uuid":{"post":{"operationId":"finance_fire_cancel_mandate_by_uuid","summary":"Cancel a direct debit mandate","description":"POST /v1/mandates/{mandateUuid}/cancel","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["mandateUuid"],"properties":{"mandateUuid":{"type":"string","description":"The uuid of the mandate to cancel."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/get-payees":{"get":{"operationId":"finance_fire_get_payees","summary":"List all Payee Bank Accounts","description":"GET /v1/payees","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/new-payment-request":{"post":{"operationId":"finance_fire_new_payment_request","summary":"Create a Fire Open Payment request","description":"POST /v1/paymentrequests","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/get-payment-details":{"get":{"operationId":"finance_fire_get_payment_details","summary":"Get Payment Details","description":"GET /v1/payments/{paymentUuid}","tags":["finance"],"parameters":[{"name":"paymentUuid","in":"query","required":true,"description":"The unique id for the transaction.","schema":{"type":"string","description":"The unique id for the transaction."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/get-user":{"get":{"operationId":"finance_fire_get_user","summary":"Returns details of a specific fire.com user.","description":"GET /v1/user/{userId}","tags":["finance"],"parameters":[{"name":"userId","in":"query","required":true,"description":"Lists a specific User","schema":{"type":"integer","description":"Lists a specific User"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/get-users":{"get":{"operationId":"finance_fire_get_users","summary":"Returns list of all users on your fire.com account","description":"GET /v1/users","tags":["finance"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/get-items-batch-international-transfer":{"get":{"operationId":"finance_fire_get_items_batch_international_transfer","summary":"List items in a Batch (International Transfers)","description":"GET /v2/batches/{batchUuid}/internationaltransfers","tags":["finance"],"parameters":[{"name":"batchUuid","in":"query","required":true,"description":"The uuid of the batch.","schema":{"type":"string","description":"The uuid of the batch."}},{"name":"offset","in":"query","required":false,"description":"The page offset. Defaults to 0. This is the record number that the returned list will start at. E.g. offset = 40 and limit = 20 will…","schema":{"type":"integer","description":"The page offset. Defaults to 0. This is the record number that the returned list will start at. E.g. offset = 40 and limit = 20 will…"}},{"name":"limit","in":"query","required":false,"description":"The number of records to return. Defaults to 10 - max is 200.","schema":{"type":"integer","description":"The number of records to return. Defaults to 10 - max is 200."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/finance:fire/add-international-transfer-batch-payment":{"post":{"operationId":"finance_fire_add_international_transfer_batch_payment","summary":"Add an international transfer payment to the batch.","description":"POST /v2/batches/{batchUuid}/internationaltransfers","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batchUuid","body"],"properties":{"batchUuid":{"type":"string","description":"The uuid of the batch."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/delete-international-transfer-batch-payment":{"post":{"operationId":"finance_fire_delete_international_transfer_batch_payment","summary":"Remove a Payment from the Batch (International Transfers)","description":"DELETE /v2/batches/{batchUuid}/internationaltransfers/{itemUuid}","tags":["finance"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batchUuid","itemUuid"],"properties":{"batchUuid":{"type":"string","description":"The uuid of the batch."},"itemUuid":{"type":"string","description":"The uuid of the item to remove."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/finance:fire/get-transactions-by-account-idv3":{"get":{"operationId":"finance_fire_get_transactions_by_account_idv3","summary":"List transactions for an account (v3)","description":"GET /v3/accounts/{ican}/transactions","tags":["finance"],"parameters":[{"name":"ican","in":"query","required":true,"description":"The ican of the account to retrieve","schema":{"type":"integer","description":"The ican of the account to retrieve"}},{"name":"limit","in":"query","required":false,"description":"The number of records to return. Defaults to 10 - max is 200.","schema":{"type":"integer","description":"The number of records to return. Defaults to 10 - max is 200."}},{"name":"dateRangeFrom","in":"query","required":false,"description":"A millisecond epoch time specifying the date range start date.","schema":{"type":"integer","description":"A millisecond epoch time specifying the date range start date."}},{"name":"dateRangeTo","in":"query","required":false,"description":"A millisecond epoch time specifying the date range end date.","schema":{"type":"integer","description":"A millisecond epoch time specifying the date range end date."}},{"name":"startAfter","in":"query","required":false,"description":"A pointer to the position in the resultset to start from. Used when paging through results using the linked pages.","schema":{"type":"string","description":"A pointer to the position in the resultset to start from. Used when paging through results using the linked pages."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}