{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:adatree-data/banking-get-accounts":{"get":{"operationId":"finance_adatree_data_banking_get_accounts","summary":"Get Banking Accounts","description":"GET /data/banking/accounts","tags":["finance"],"parameters":[{"name":"useCaseIds","in":"query","required":false,"description":"Used to filter results on the useCaseId field.","schema":{"type":"array","description":"Used to filter results on the useCaseId field."}},{"name":"cdrArrangementIds","in":"query","required":false,"description":"Used to filter results on the cdrArrangementId field.","schema":{"type":"array","description":"Used to filter results on the cdrArrangementId field."}},{"name":"consentIds","in":"query","required":false,"description":"Used to filter results on the consentId field.","schema":{"type":"array","description":"Used to filter results on the consentId field."}},{"name":"consumerIds","in":"query","required":false,"description":"Used to filter results on the consumerId field.","schema":{"type":"array","description":"Used to filter results on the consumerId field."}},{"name":"accountIds","in":"query","required":false,"description":"Used to filter results on the accountId field.","schema":{"type":"array","description":"Used to filter results on the accountId field."}},{"name":"dataHolderBrandIds","in":"query","required":false,"description":"Used to filter results on the dataHolderBrandId field.","schema":{"type":"array","description":"Used to filter results on the dataHolderBrandId field."}},{"name":"isOwned","in":"query","required":false,"description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…","schema":{"type":"boolean","description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…"}},{"name":"openStatus","in":"query","required":false,"description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED","schema":{"type":"string","enum":["OPEN","CLOSED"],"description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED"}},{"name":"productCategories","in":"query","required":false,"description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…","schema":{"type":"array","description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…"}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"pageSize","in":"query","required":false,"description":"Page size to request","schema":{"type":"integer","default":25,"description":"Page size to request"}},{"name":"Adatree-Consumer-Auth-Date","in":"query","required":false,"description":"The time when the customer last logged in. Mandatory for consumer present calls using a Machine token.","schema":{"type":"string","description":"The time when the customer last logged in. Mandatory for consumer present calls using a Machine token."}},{"name":"Adatree-Consumer-Ip-Address","in":"query","required":false,"description":"The consumer's original IP address. Mandatory for consumer present calls using a Machine token.","schema":{"type":"string","description":"The consumer's original IP address. Mandatory for consumer present calls using a Machine token."}},{"name":"Adatree-Consumer-User-Agent","in":"query","required":false,"description":"User Agent header of the consumer facing application. Mandatory for consumer present calls using a Machine token.","schema":{"type":"string","description":"User Agent header of the consumer facing application. Mandatory for consumer present calls using a Machine token."}}],"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:adatree-data/banking-get-transactions":{"get":{"operationId":"finance_adatree_data_banking_get_transactions","summary":"Get Banking Transactions","description":"GET /data/banking/transactions","tags":["finance"],"parameters":[{"name":"useCaseIds","in":"query","required":false,"description":"Used to filter results on the useCaseId field.","schema":{"type":"array","description":"Used to filter results on the useCaseId field."}},{"name":"accountIds","in":"query","required":false,"description":"Used to filter results on the accountId field.","schema":{"type":"array","description":"Used to filter results on the accountId field."}},{"name":"cdrArrangementIds","in":"query","required":false,"description":"Used to filter results on the cdrArrangementId field.","schema":{"type":"array","description":"Used to filter results on the cdrArrangementId field."}},{"name":"consentIds","in":"query","required":false,"description":"Used to filter results on the consentId field.","schema":{"type":"array","description":"Used to filter results on the consentId field."}},{"name":"consumerIds","in":"query","required":false,"description":"Used to filter results on the consumerId field.","schema":{"type":"array","description":"Used to filter results on the consumerId field."}},{"name":"dataHolderBrandIds","in":"query","required":false,"description":"Used to filter results on the dataHolderBrandId field.","schema":{"type":"array","description":"Used to filter results on the dataHolderBrandId field."}},{"name":"types","in":"query","required":false,"description":"Used to filter results on the type field.","schema":{"type":"array","description":"Used to filter results on the type field."}},{"name":"statuses","in":"query","required":false,"description":"Used to filter results by status.","schema":{"type":"array","description":"Used to filter results by status."}},{"name":"minimumAmount","in":"query","required":false,"description":"Used to filter results on the amount field","schema":{"type":"number","description":"Used to filter results on the amount field"}},{"name":"maximumAmount","in":"query","required":false,"description":"Used to filter results on the amount field","schema":{"type":"number","description":"Used to filter results on the amount field"}},{"name":"oldestRetrievalTime","in":"query","required":false,"description":"Constrain the transaction history request to transactions with retrieval time at or after this date/time. Format is aligned to…","schema":{"type":"string","description":"Constrain the transaction history request to transactions with retrieval time at or after this date/time. Format is aligned to…"}},{"name":"newestRetrievalTime","in":"query","required":false,"description":"Constrain the transaction history request to transactions with retrieval time at or before this date/time. Format is aligned to…","schema":{"type":"string","description":"Constrain the transaction history request to transactions with retrieval time at or before this date/time. Format is aligned to…"}},{"name":"oldestTime","in":"query","required":false,"description":"Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to…","schema":{"type":"string","description":"Constrain the transaction history request to transactions with effective time at or after this date/time. If absent defaults to…"}},{"name":"newestTime","in":"query","required":false,"description":"Constrain the transaction history request to transactions with effective time at or before this date/time. Format is aligned to…","schema":{"type":"string","description":"Constrain the transaction history request to transactions with effective time at or before this date/time. Format is aligned to…"}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"pageSize","in":"query","required":false,"description":"Page size to request","schema":{"type":"integer","default":25,"description":"Page size to request"}}],"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:adatree-data/banking-get-payee-list":{"get":{"operationId":"finance_adatree_data_banking_get_payee_list","summary":"Get Banking Payees","description":"GET /data/banking/payees","tags":["finance"],"parameters":[{"name":"useCaseIds","in":"query","required":false,"description":"Used to filter results on the useCaseId field.","schema":{"type":"array","description":"Used to filter results on the useCaseId field."}},{"name":"cdrArrangementIds","in":"query","required":false,"description":"Used to filter results on the cdrArrangementId field.","schema":{"type":"array","description":"Used to filter results on the cdrArrangementId field."}},{"name":"consentIds","in":"query","required":false,"description":"Used to filter results on the consentId field.","schema":{"type":"array","description":"Used to filter results on the consentId field."}},{"name":"consumerIds","in":"query","required":false,"description":"Used to filter results on the consumerId field.","schema":{"type":"array","description":"Used to filter results on the consumerId field."}},{"name":"dataHolderBrandIds","in":"query","required":false,"description":"Used to filter results on the dataHolderBrandId field.","schema":{"type":"array","description":"Used to filter results on the dataHolderBrandId field."}},{"name":"types","in":"query","required":false,"description":"Used to filter results on the payee type field.","schema":{"type":"array","description":"Used to filter results on the payee type field."}},{"name":"payeeIds","in":"query","required":false,"description":"Used to filter results on the payeeId field.","schema":{"type":"array","description":"Used to filter results on the payeeId field."}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"pageSize","in":"query","required":false,"description":"Page size to request","schema":{"type":"integer","default":25,"description":"Page size to request"}}],"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:adatree-data/banking-get-direct-debits-list":{"get":{"operationId":"finance_adatree_data_banking_get_direct_debits_list","summary":"Get Banking Direct Debits","description":"GET /data/banking/payments/direct-debits","tags":["finance"],"parameters":[{"name":"useCaseIds","in":"query","required":false,"description":"Used to filter results on the useCaseId field.","schema":{"type":"array","description":"Used to filter results on the useCaseId field."}},{"name":"cdrArrangementIds","in":"query","required":false,"description":"Used to filter results on the cdrArrangementId field.","schema":{"type":"array","description":"Used to filter results on the cdrArrangementId field."}},{"name":"consentIds","in":"query","required":false,"description":"Used to filter results on the consentId field.","schema":{"type":"array","description":"Used to filter results on the consentId field."}},{"name":"consumerIds","in":"query","required":false,"description":"Used to filter results on the consumerId field.","schema":{"type":"array","description":"Used to filter results on the consumerId field."}},{"name":"dataHolderBrandIds","in":"query","required":false,"description":"Used to filter results on the dataHolderBrandId field.","schema":{"type":"array","description":"Used to filter results on the dataHolderBrandId field."}},{"name":"accountIds","in":"query","required":false,"description":"Used to filter results on the accountId field.","schema":{"type":"array","description":"Used to filter results on the accountId field."}},{"name":"isOwned","in":"query","required":false,"description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…","schema":{"type":"boolean","description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…"}},{"name":"openStatus","in":"query","required":false,"description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED","schema":{"type":"string","enum":["OPEN","CLOSED"],"description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED"}},{"name":"productCategories","in":"query","required":false,"description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…","schema":{"type":"array","description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…"}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"pageSize","in":"query","required":false,"description":"Page size to request","schema":{"type":"integer","default":25,"description":"Page size to request"}}],"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:adatree-data/banking-list-scheduled-payments":{"get":{"operationId":"finance_adatree_data_banking_list_scheduled_payments","summary":"Get Scheduled Payments","description":"GET /data/banking/payments/scheduled","tags":["finance"],"parameters":[{"name":"useCaseIds","in":"query","required":false,"description":"Used to filter results on the useCaseId field.","schema":{"type":"array","description":"Used to filter results on the useCaseId field."}},{"name":"cdrArrangementIds","in":"query","required":false,"description":"Used to filter results on the cdrArrangementId field.","schema":{"type":"array","description":"Used to filter results on the cdrArrangementId field."}},{"name":"consentIds","in":"query","required":false,"description":"Used to filter results on the consentId field.","schema":{"type":"array","description":"Used to filter results on the consentId field."}},{"name":"consumerIds","in":"query","required":false,"description":"Used to filter results on the consumerId field.","schema":{"type":"array","description":"Used to filter results on the consumerId field."}},{"name":"dataHolderBrandIds","in":"query","required":false,"description":"Used to filter results on the dataHolderBrandId field.","schema":{"type":"array","description":"Used to filter results on the dataHolderBrandId field."}},{"name":"accountIds","in":"query","required":false,"description":"Used to filter results on the accountId field.","schema":{"type":"array","description":"Used to filter results on the accountId field."}},{"name":"isOwned","in":"query","required":false,"description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…","schema":{"type":"boolean","description":"Filters accounts based on whether they are owned by the authorised customer. True for owned accounts, false for unowned accounts and…"}},{"name":"openStatus","in":"query","required":false,"description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED","schema":{"type":"string","enum":["OPEN","CLOSED"],"description":"Used to filter results according to open/closed status. Values can be OPEN, CLOSED"}},{"name":"productCategories","in":"query","required":false,"description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…","schema":{"type":"array","description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…"}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"pageSize","in":"query","required":false,"description":"Page size to request","schema":{"type":"integer","default":25,"description":"Page size to request"}}],"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:adatree-data/banking-get-banking-products":{"get":{"operationId":"finance_adatree_data_banking_get_banking_products","summary":"Get Banking Products","description":"GET /data/banking/products","tags":["finance"],"parameters":[{"name":"dataHolderBrandIds","in":"query","required":false,"description":"Used to filter results on the dataHolderBrandId field.","schema":{"type":"array","description":"Used to filter results on the dataHolderBrandId field."}},{"name":"productCategories","in":"query","required":false,"description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…","schema":{"type":"array","description":"Used to filter results on the productCategory field applicable to accounts. Any one of the valid values for this field can be supplied. If…"}},{"name":"productIds","in":"query","required":false,"description":"IDs of the specific products","schema":{"type":"array","description":"IDs of the specific products"}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"pageSize","in":"query","required":false,"description":"Page size to request","schema":{"type":"integer","default":25,"description":"Page size to request"}}],"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:adatree-data/common-get-consumer-list":{"get":{"operationId":"finance_adatree_data_common_get_consumer_list","summary":"Get Customers","description":"GET /data/common/customers","tags":["finance"],"parameters":[{"name":"useCaseIds","in":"query","required":false,"description":"Used to filter results on the useCaseId field.","schema":{"type":"array","description":"Used to filter results on the useCaseId field."}},{"name":"cdrArrangementIds","in":"query","required":false,"description":"Used to filter results on the cdrArrangementId field.","schema":{"type":"array","description":"Used to filter results on the cdrArrangementId field."}},{"name":"consentIds","in":"query","required":false,"description":"Used to filter results on the consentId field.","schema":{"type":"array","description":"Used to filter results on the consentId field."}},{"name":"consumerIds","in":"query","required":false,"description":"Used to filter results on the consumerId field.","schema":{"type":"array","description":"Used to filter results on the consumerId field."}},{"name":"dataHolderBrandIds","in":"query","required":false,"description":"Used to filter results on the dataHolderBrandId field.","schema":{"type":"array","description":"Used to filter results on the dataHolderBrandId field."}},{"name":"customerUTypes","in":"query","required":false,"description":"Used to filter results on the customerUType field applicable to customers. Any one of the valid values for this field can be supplied.","schema":{"type":"array","description":"Used to filter results on the customerUType field applicable to customers. Any one of the valid values for this field can be supplied."}}],"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:adatree-data/energy-get-plans":{"get":{"operationId":"finance_adatree_data_energy_get_plans","summary":"Get Energy Plans","description":"GET /data/energy/plans","tags":["finance"],"parameters":[{"name":"planIds","in":"query","required":false,"description":"Used to filter results on the planId field.","schema":{"type":"array","description":"Used to filter results on the planId field."}},{"name":"planTypes","in":"query","required":false,"description":"Used to filter results on the type field.","schema":{"type":"array","description":"Used to filter results on the type field."}},{"name":"fuelTypes","in":"query","required":false,"description":"Used to filter results on the fuel type field.","schema":{"type":"array","description":"Used to filter results on the fuel type field."}},{"name":"effective","in":"query","required":false,"description":"Used to filter results on the effective field.","schema":{"type":"string","enum":["CURRENT","FUTURE"],"description":"Used to filter results on the effective field."}},{"name":"updatedSince","in":"query","required":false,"description":"Used to filter results on the updatedSince field","schema":{"type":"string","description":"Used to filter results on the updatedSince field"}},{"name":"dataHolderBrandIds","in":"query","required":false,"description":"Used to filter results on the dataHolderBrandId field.","schema":{"type":"array","description":"Used to filter results on the dataHolderBrandId field."}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"pageSize","in":"query","required":false,"description":"Page size to request","schema":{"type":"integer","default":25,"description":"Page size to request"}}],"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:adatree-data/energy-get-consumer-energy-accounts":{"get":{"operationId":"finance_adatree_data_energy_get_consumer_energy_accounts","summary":"Get Energy Accounts","description":"GET /data/energy/accounts","tags":["finance"],"parameters":[{"name":"useCaseIds","in":"query","required":false,"description":"Used to filter results on the useCaseId field.","schema":{"type":"array","description":"Used to filter results on the useCaseId field."}},{"name":"cdrArrangementIds","in":"query","required":false,"description":"Used to filter results on the cdrArrangementId field.","schema":{"type":"array","description":"Used to filter results on the cdrArrangementId field."}},{"name":"consentIds","in":"query","required":false,"description":"Used to filter results on the consentId field.","schema":{"type":"array","description":"Used to filter results on the consentId field."}},{"name":"consumerIds","in":"query","required":false,"description":"Used to filter results on the consumerId field.","schema":{"type":"array","description":"Used to filter results on the consumerId field."}},{"name":"accountIds","in":"query","required":false,"description":"Used to filter results on the accountId field.","schema":{"type":"array","description":"Used to filter results on the accountId field."}},{"name":"dataHolderBrandIds","in":"query","required":false,"description":"Used to filter results on the dataHolderBrandId field.","schema":{"type":"array","description":"Used to filter results on the dataHolderBrandId field."}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"pageSize","in":"query","required":false,"description":"Page size to request","schema":{"type":"integer","default":25,"description":"Page size to request"}}],"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:adatree-data/energy-get-invoices":{"get":{"operationId":"finance_adatree_data_energy_get_invoices","summary":"Get Energy Invoices","description":"GET /data/energy/invoices","tags":["finance"],"parameters":[{"name":"useCaseIds","in":"query","required":false,"description":"Used to filter results on the useCaseId field.","schema":{"type":"array","description":"Used to filter results on the useCaseId field."}},{"name":"cdrArrangementIds","in":"query","required":false,"description":"Used to filter results on the cdrArrangementId field.","schema":{"type":"array","description":"Used to filter results on the cdrArrangementId field."}},{"name":"consentIds","in":"query","required":false,"description":"Used to filter results on the consentId field.","schema":{"type":"array","description":"Used to filter results on the consentId field."}},{"name":"consumerIds","in":"query","required":false,"description":"Used to filter results on the consumerId field.","schema":{"type":"array","description":"Used to filter results on the consumerId field."}},{"name":"accountIds","in":"query","required":false,"description":"Used to filter results on the accountId field.","schema":{"type":"array","description":"Used to filter results on the accountId field."}},{"name":"invoiceIds","in":"query","required":false,"description":"Used to filter results on the invoiceId field.","schema":{"type":"array","description":"Used to filter results on the invoiceId field."}},{"name":"dataHolderBrandIds","in":"query","required":false,"description":"Used to filter results on the dataHolderBrandId field.","schema":{"type":"array","description":"Used to filter results on the dataHolderBrandId field."}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"pageSize","in":"query","required":false,"description":"Page size to request","schema":{"type":"integer","default":25,"description":"Page size to request"}}],"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:adatree-data/energy-get-bills":{"get":{"operationId":"finance_adatree_data_energy_get_bills","summary":"Get Energy Bills","description":"GET /data/energy/bills","tags":["finance"],"parameters":[{"name":"useCaseIds","in":"query","required":false,"description":"Used to filter results on the useCaseId field.","schema":{"type":"array","description":"Used to filter results on the useCaseId field."}},{"name":"cdrArrangementIds","in":"query","required":false,"description":"Used to filter results on the cdrArrangementId field.","schema":{"type":"array","description":"Used to filter results on the cdrArrangementId field."}},{"name":"consentIds","in":"query","required":false,"description":"Used to filter results on the consentId field.","schema":{"type":"array","description":"Used to filter results on the consentId field."}},{"name":"consumerIds","in":"query","required":false,"description":"Used to filter results on the consumerId field.","schema":{"type":"array","description":"Used to filter results on the consumerId field."}},{"name":"accountIds","in":"query","required":false,"description":"Used to filter results on the accountId field.","schema":{"type":"array","description":"Used to filter results on the accountId field."}},{"name":"billingIds","in":"query","required":false,"description":"Used to filter results on the billingId field.","schema":{"type":"array","description":"Used to filter results on the billingId field."}},{"name":"dataHolderBrandIds","in":"query","required":false,"description":"Used to filter results on the dataHolderBrandId field.","schema":{"type":"array","description":"Used to filter results on the dataHolderBrandId field."}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"pageSize","in":"query","required":false,"description":"Page size to request","schema":{"type":"integer","default":25,"description":"Page size to request"}}],"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:adatree-data/energy-get-service-points":{"get":{"operationId":"finance_adatree_data_energy_get_service_points","summary":"Get Electricity Service Points","description":"GET /data/energy/electricity/servicepoints","tags":["finance"],"parameters":[{"name":"useCaseIds","in":"query","required":false,"description":"Used to filter results on the useCaseId field.","schema":{"type":"array","description":"Used to filter results on the useCaseId field."}},{"name":"cdrArrangementIds","in":"query","required":false,"description":"Used to filter results on the cdrArrangementId field.","schema":{"type":"array","description":"Used to filter results on the cdrArrangementId field."}},{"name":"consentIds","in":"query","required":false,"description":"Used to filter results on the consentId field.","schema":{"type":"array","description":"Used to filter results on the consentId field."}},{"name":"consumerIds","in":"query","required":false,"description":"Used to filter results on the consumerId field.","schema":{"type":"array","description":"Used to filter results on the consumerId field."}},{"name":"servicePointIds","in":"query","required":false,"description":"Used to filter results on the servicePointId field.","schema":{"type":"array","description":"Used to filter results on the servicePointId field."}},{"name":"dataHolderBrandIds","in":"query","required":false,"description":"Used to filter results on the dataHolderBrandId field.","schema":{"type":"array","description":"Used to filter results on the dataHolderBrandId field."}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"pageSize","in":"query","required":false,"description":"Page size to request","schema":{"type":"integer","default":25,"description":"Page size to request"}}],"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:adatree-data/energy-get-consumer-electricity-usage":{"get":{"operationId":"finance_adatree_data_energy_get_consumer_electricity_usage","summary":"Get Electricity Usage","description":"GET /data/energy/electricity/usage","tags":["finance"],"parameters":[{"name":"useCaseIds","in":"query","required":false,"description":"Used to filter results on the useCaseId field.","schema":{"type":"array","description":"Used to filter results on the useCaseId field."}},{"name":"cdrArrangementIds","in":"query","required":false,"description":"Used to filter results on the cdrArrangementId field.","schema":{"type":"array","description":"Used to filter results on the cdrArrangementId field."}},{"name":"consentIds","in":"query","required":false,"description":"Used to filter results on the consentId field.","schema":{"type":"array","description":"Used to filter results on the consentId field."}},{"name":"consumerIds","in":"query","required":false,"description":"Used to filter results on the consumerId field.","schema":{"type":"array","description":"Used to filter results on the consumerId field."}},{"name":"servicePointIds","in":"query","required":false,"description":"Used to filter results on the servicePointId field.","schema":{"type":"array","description":"Used to filter results on the servicePointId field."}},{"name":"dataHolderBrandIds","in":"query","required":false,"description":"Used to filter results on the dataHolderBrandId field.","schema":{"type":"array","description":"Used to filter results on the dataHolderBrandId field."}},{"name":"page","in":"query","required":false,"description":"Page of results to request (standard pagination)","schema":{"type":"integer","default":1,"description":"Page of results to request (standard pagination)"}},{"name":"pageSize","in":"query","required":false,"description":"Page size to request","schema":{"type":"integer","default":25,"description":"Page size to request"}},{"name":"oldestDate","in":"query","required":false,"description":"Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months.","schema":{"type":"string","description":"Constrain the request to records with effective date at or after this date. If absent defaults to newest-date minus 24 months."}},{"name":"newestDate","in":"query","required":false,"description":"Constrain the request to records with effective date at or before this date. If absent defaults to current date.","schema":{"type":"string","description":"Constrain the request to records with effective date at or before this date. If absent defaults to current date."}},{"name":"Adatree-Consumer-Auth-Date","in":"query","required":false,"description":"The time when the customer last logged in. Mandatory for consumer present calls using a Machine token.","schema":{"type":"string","description":"The time when the customer last logged in. Mandatory for consumer present calls using a Machine token."}},{"name":"Adatree-Consumer-Ip-Address","in":"query","required":false,"description":"The consumer's original IP address. Mandatory for consumer present calls using a Machine token.","schema":{"type":"string","description":"The consumer's original IP address. Mandatory for consumer present calls using a Machine token."}},{"name":"Adatree-Consumer-User-Agent","in":"query","required":false,"description":"User Agent header of the consumer facing application. Mandatory for consumer present calls using a Machine token.","schema":{"type":"string","description":"User Agent header of the consumer facing application. Mandatory for consumer present calls using a Machine token."}}],"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"}}}}}}}