# Chift: English Developer Documentation API Reference ## API Reference ### API Reference Overview - [Overview](https://docs.chift.eu/api-reference/overview.md) ### Access & Connections #### Authentication - [Get access token](https://docs.chift.eu/api-reference/endpoints/general/get-access-token.md): Authenticates with your clientId, clientSecret, and accountId, then returns a Bearer access token valid for 30 minutes for use on all protected API endpoints. #### Consumers - [Create new consumer](https://docs.chift.eu/api-reference/endpoints/consumers/create-new-consumer.md): Creates a new consumer and returns the created consumer object. The consumer can then connect to the integrations enabled on your account. - [Get one consumer](https://docs.chift.eu/api-reference/endpoints/consumers/get-one-consumer.md): Returns the consumer matching the given ID. - [Get consumers](https://docs.chift.eu/api-reference/endpoints/consumers/get-consumers.md): Returns the list of consumers linked to your account, optionally filtered by name or internal reference. - [Update one consumer](https://docs.chift.eu/api-reference/endpoints/consumers/update-one-consumer.md): Updates one or more fields of an existing consumer and returns the updated consumer object. - [Delete one consumer](https://docs.chift.eu/api-reference/endpoints/consumers/delete-one-consumer.md): Deletes the specified consumer and all associated connections, then returns HTTP 204 on success. #### Connections - [Add new connection](https://docs.chift.eu/api-reference/endpoints/connections/add-new-connection.md): Returns the url that can be used by your client to enable his integrations. - [Get connections](https://docs.chift.eu/api-reference/endpoints/connections/get-connections.md): Returns a list of the connections (active or inactive) linked to your consumer - [Update an existing connection](https://docs.chift.eu/api-reference/endpoints/connections/update-an-existing-connection.md): Returns the url that can be used by your client to update the connection - [Delete one connection](https://docs.chift.eu/api-reference/endpoints/connections/delete-one-connection.md): Deletes the specified connection of a consumer and disables any associated webhooks, then returns HTTP 204 on success. #### Integrations - [Get list of integrations](https://docs.chift.eu/api-reference/endpoints/integrations/get-list-of-integrations.md): Returns a list of integrations (active and inactive) available for your account - [Get integration logo/icon (as base64)](https://docs.chift.eu/api-reference/endpoints/integrations/get-integration-logoicon-as-base64.md): Returns the logo or icon image of the specified integration as a base64-encoded string wrapped in a JSON object. ### Accounting #### Folders - [Get folders](https://docs.chift.eu/api-reference/endpoints/accounting/get-folders.md): Returns the list of accounting folders (companies or dossiers) the consumer has access to in the accounting system. - [Get one folder](https://docs.chift.eu/api-reference/endpoints/accounting/get-one-folder.md): Returns a single accounting folder (company or dossier) by its ID from the accounting system. #### Book years - [Get book years](https://docs.chift.eu/api-reference/endpoints/accounting/get-book-years.md): Returns the list of fiscal book years defined in the accounting system for the authenticated consumer. #### Clients - [Create client](https://docs.chift.eu/api-reference/endpoints/accounting/create-client.md): Creates a new client (customer/debtor partner) in the accounting system and returns the created record. - [Get one client](https://docs.chift.eu/api-reference/endpoints/accounting/get-one-client.md): Returns a specific client (customer/debtor partner) by its ID from the accounting system. - [Get clients](https://docs.chift.eu/api-reference/endpoints/accounting/get-clients.md): Returns the list of clients (customer/debtor partners) registered in the accounting system. - [Update client](https://docs.chift.eu/api-reference/endpoints/accounting/update-client.md): Endpoint that gives the possibility to update an accounting client #### Suppliers - [Create supplier](https://docs.chift.eu/api-reference/endpoints/accounting/create-supplier.md): Creates a new supplier (vendor/creditor partner) in the accounting system and returns the created record. - [Get one supplier](https://docs.chift.eu/api-reference/endpoints/accounting/get-one-supplier.md): Returns a specific supplier (vendor/creditor partner) by its ID from the accounting system. - [Get suppliers](https://docs.chift.eu/api-reference/endpoints/accounting/get-suppliers.md): Returns the list of suppliers (vendor/creditor partners) registered in the accounting system. - [Update one supplier](https://docs.chift.eu/api-reference/endpoints/accounting/update-one-supplier.md): Updates an existing supplier (vendor/creditor partner) record in the accounting system with the provided fields. #### Invoices - [Create sale/purchase entry](https://docs.chift.eu/api-reference/endpoints/accounting/create-salepurchase-entry.md): Creates a new sale or purchase invoice entry in the accounting system and returns the created record. - [Create sale/purchase entry (Multiple plans)](https://docs.chift.eu/api-reference/endpoints/accounting/create-salepurchase-entry-multiple-plans.md): Create a new sale/purchase entry with multiple analytic plans in the accounting - [Get invoices by type (sale/purchase entries)](https://docs.chift.eu/api-reference/endpoints/accounting/get-invoices-by-type-salepurchase-entries.md): Returns a list of invoices by a specific type (=sale/purchase entries). Each line of the invoice will include the analytic account linked to default analytic plan. Optionally dates can be defined to retrieve invoice from a certain date to another date - [Get one invoice (sale/purchase entry)](https://docs.chift.eu/api-reference/endpoints/accounting/get-one-invoice-salepurchase-entry.md): Returns a specific invoice (sale/purchase entry). Each line will include the analytic account linked to default analytic plan - [Get one invoice (sale/purchase entry - Multiple Analytic Plans)](https://docs.chift.eu/api-reference/endpoints/accounting/get-one-invoice-salepurchase-entry--multiple-analytic-plans.md): Returns a specific invoice (=sale/purchase entry) with invoice lines /oincluding multiple analytic plans - [Get invoices by type (sale/purchase entries - Multiple Analytic Plans)](https://docs.chift.eu/api-reference/endpoints/accounting/get-invoices-by-type-salepurchase-entries--multiple-analytic-plans.md): Returns a list of invoices by a specific type (=sale/purchase entries) with invoice lines including multiple analytic plans. Optionally dates can be defined to retrieve invoice from a certain date to another date - [Create an invoice payment](https://docs.chift.eu/api-reference/endpoints/accounting/create-an-invoice-payment.md): Records a payment against an invoice in the accounting system, marking the invoice as (partially) settled. - [Get payment methods](https://docs.chift.eu/api-reference/endpoints/accounting/get-payment-methods.md): Returns the list of payment method configurations available in the accounting system. - [Get payment terms](https://docs.chift.eu/api-reference/endpoints/accounting/get-payment-terms.md): Returns the list of payment term configurations (e.g., net 30, immediate) defined in the accounting system. #### Banking - [Create bank account](https://docs.chift.eu/api-reference/endpoints/accounting/create-bank-account.md): Creates a new bank account in the accounting system and returns the created object. - [Get bank accounts](https://docs.chift.eu/api-reference/endpoints/accounting/get-bank-accounts.md): Returns the list of bank accounts configured in the accounting system for the consumer. - [Create bank transactions](https://docs.chift.eu/api-reference/endpoints/accounting/create-bank-transactions.md): Creates new bank statement transactions (lines) in the accounting system for a given bank account. #### Ledger accounts - [Create ledger account](https://docs.chift.eu/api-reference/endpoints/accounting/create-ledger-account.md): Creates a new ledger account in the chart of accounts for the accounting system. - [Get chart of accounts](https://docs.chift.eu/api-reference/endpoints/accounting/get-chart-of-accounts.md): Returns the full list of ledger accounts in the chart of accounts for the accounting system. - [Get the balance of accounts](https://docs.chift.eu/api-reference/endpoints/accounting/get-the-balance-of-accounts.md): Get the balance of accounts in the accounting plan (chart of accounts) between specific months #### Journals - [Create journal](https://docs.chift.eu/api-reference/endpoints/accounting/create-journal.md): Creates a new accounting journal (e.g., sales, purchase, or bank journal) in the accounting system. - [Get journals](https://docs.chift.eu/api-reference/endpoints/accounting/get-journals.md): Returns the list of accounting journals (sales, purchase, bank, cash, etc.) defined in the accounting system. #### Journal entries - [Create Journal Entry](https://docs.chift.eu/api-reference/endpoints/accounting/create-journal-entry.md): Creates a new journal entry in the accounting system using the unified generic entry model. - [Create a financial entry](https://docs.chift.eu/api-reference/endpoints/accounting/create-a-financial-entry.md): Creates a new bank or cash journal financial entry in the accounting system and returns the created record. - [Get journal entries](https://docs.chift.eu/api-reference/endpoints/accounting/get-journal-entries.md): Returns a list of journal entries. Each item will include the analytic account linked to default analytic plan. Optionally, you can retrieve journal entries linked to a specific client/supplier using the partner_id parameter. When retrieving entries linked to a specific client/supplier, some journal… - [Get journal entries (Multiple Analytic Plans)](https://docs.chift.eu/api-reference/endpoints/accounting/get-journal-entries-multiple-analytic-plans.md): Returns a list of journal entries with invoice items including multiple analytic plan.Optionally, you can retrieve journal entries linked to a specific client/supplier using the partner_id parameter. When retrieving entries linked to a specific client/supplier, some journal items of an entry (e.g. a… - [Get one journal entry](https://docs.chift.eu/api-reference/endpoints/accounting/get-one-journal-entry.md): Returns a single journal entry by its ID from the accounting system. - [Match entries](https://docs.chift.eu/api-reference/endpoints/accounting/match-entries.md): Reconciles open accounting entries against each other in the accounting system, marking them as matched. #### Expenses - [Create an expense](https://docs.chift.eu/api-reference/endpoints/accounting/create-an-expense.md): Creates a new employee expense claim in the accounting system and returns the created record. #### Employees - [Get employees](https://docs.chift.eu/api-reference/endpoints/accounting/get-employees.md): Returns the list of employees linked to the company in the accounting system. #### Analytic plans - [Get analytic plans](https://docs.chift.eu/api-reference/endpoints/accounting/get-analytic-plans.md): Returns the list of analytic plan structures available in the accounting system for cost allocation. #### Analytic accounts - [Create analytic account](https://docs.chift.eu/api-reference/endpoints/accounting/create-analytic-account.md): Creates a new analytic account in the accounting system's default analytic plan and returns the created record. - [Create analytic account (Multiple Analytic Plans)](https://docs.chift.eu/api-reference/endpoints/accounting/create-analytic-account-multiple-analytic-plans.md): Creates a new analytic account in a specific analytic plan of the accounting system and returns the created record. - [Get analytic accounts](https://docs.chift.eu/api-reference/endpoints/accounting/get-analytic-accounts.md): Returns all analytic accounts belonging to the default analytic plan in the accounting system. - [Get analytic account](https://docs.chift.eu/api-reference/endpoints/accounting/get-analytic-account.md): Returns one specific analytic account of the default analytic plan - [Update analytic account](https://docs.chift.eu/api-reference/endpoints/accounting/update-analytic-account.md): Update one specific analytic account in the default analytic plan - [Get analytic account (Multiple Analytic Plans)](https://docs.chift.eu/api-reference/endpoints/accounting/get-analytic-account-multiple-analytic-plans.md): Returns one specific analytic account of a specific analytic plan - [Update analytic account (Multiple Analytic Plans)](https://docs.chift.eu/api-reference/endpoints/accounting/update-analytic-account-multiple-analytic-plans.md): Update one specific analytic account in a specific analytic plan - [Get analytic accounts (Multiple Analytic Plans)](https://docs.chift.eu/api-reference/endpoints/accounting/get-analytic-accounts-multiple-analytic-plans.md): Returns all analytic accounts across all analytic plans defined in the accounting system. #### Outstandings - [Get clients/suppliers outstanding items](https://docs.chift.eu/api-reference/endpoints/accounting/get-clientssuppliers-outstanding-items.md): Returns the list of outstanding (unpaid) items for clients and suppliers in the accounting system. #### VAT codes - [Get vat codes](https://docs.chift.eu/api-reference/endpoints/accounting/get-vat-codes.md): Returns the list of VAT/tax codes configured in the accounting system. #### Attachments - [Attach a document (PDF)](https://docs.chift.eu/api-reference/endpoints/accounting/attach-a-document-pdf.md): Attaches a PDF document to an existing invoice entry in the accounting system as a linked attachment. - [Get attachments](https://docs.chift.eu/api-reference/endpoints/accounting/get-attachments.md): Returns the file content of all attachments linked to an accounting entry (invoice or journal entry). Use this endpoint when an invoice or journal entry has attachments_info.status set to 'yes_to_request'. Pass type=invoice and document_id={invoice_id} for invoices, or type=entry and document_id={en… #### Exports - [Export entries in FEC format](https://docs.chift.eu/api-reference/endpoints/accounting/export-entries-in-fec-format.md): Returns accounting entries formatted according to the French FEC (Fichier des Écritures Comptables) standard. ### Invoicing #### Contacts - [Retrieve one contact](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-one-contact.md): Returns a specific contact from the invoicing system by their unique identifier. - [Retrieve all contacts](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-all-contacts.md): Returns a list of all the contacts. Optionally contact type can be defined to retrieve contact from a certain type. - [Create a contact](https://docs.chift.eu/api-reference/endpoints/invoicing/create-a-contact.md): Creates a new contact in the invoicing system and returns the created contact record. #### Invoices - [Retrieve one invoice](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-one-invoice.md): Returns a specific invoice from the invoicing system by its unique identifier. - [Retrieve all invoices](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-all-invoices.md): Returns a list of invoices. Optionally invoice type and dates can be defined to retrieve invoices of a certain type from a certain date to another date - [Create an invoice](https://docs.chift.eu/api-reference/endpoints/invoicing/create-an-invoice.md): Creates a new invoice in the invoicing system and returns the created invoice record. - [Upload a document (PDF)](https://docs.chift.eu/api-reference/endpoints/invoicing/upload-a-document-pdf.md): Uploads a PDF document to the invoicing system and returns a reference to the stored document. #### Products - [Retrieve one product](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-one-product.md): Returns a specific product or service from the invoicing system by its unique identifier. - [Retrieve all products](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-all-products.md): Returns the list of all products or services available in the invoicing system catalog. - [Create a product](https://docs.chift.eu/api-reference/endpoints/invoicing/create-a-product.md): Creates a new product or service in the invoicing system catalog and returns the created record. #### Taxes - [Retrieve one tax](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-one-tax.md): Returns a specific VAT or tax code from the invoicing system by its unique identifier. - [Retrieve all taxes](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-all-taxes.md): Returns the list of all VAT or tax codes configured in the invoicing system. #### Opportunities - [Retrieve one opportunity](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-one-opportunity.md): Returns a specific sales opportunity (deal or quote) from the invoicing system by its unique identifier. - [Retrieve all opportunities](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-all-opportunities.md): Returns the list of all sales opportunities (deals or quotes) available in the invoicing system. #### Payments - [Retrieve all payments (invoicing)](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-all-payments-invoicing.md): Returns the list of payment records registered in the invoicing system, optionally filtered. #### Payment methods - [Retrieve all payment methods](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-all-payment-methods.md): Returns the list of payment method configurations available in the invoicing system. #### Bank Accounts - [Retrieve all Bank Accounts](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-all-bank-accounts.md): Returns the list of bank accounts configured in the invoicing system. #### Bank Transactions - [Retrieve all Bank Transactions](https://docs.chift.eu/api-reference/endpoints/invoicing/retrieve-all-bank-transactions.md): Returns the list of bank statement transactions available in the invoicing system. ### POS #### Orders - [Get orders](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-orders.md): Returns the list of orders placed in the POS system, optionally filtered by date range or location. - [Get one order](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-one-order.md): Returns a specific order from the POS system by its unique identifier. - [Get sales](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-sales.md): Returns the aggregated sales summary for a given period, optionally broken down by location. - [Update order](https://docs.chift.eu/api-reference/endpoints/point-of-sale/update-order.md): Updates a specific order in the POS system with the provided fields and returns the updated record. #### Payment methods - [Get payment methods (POS)](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-payment-methods-pos.md): Returns the list of payment methods accepted and configured in the POS system. #### Payments - [Get payments](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-payments.md): Returns the list of payments collected in the POS system, optionally filtered by date or location. #### Closure / Report - [Get closure info for a specific day](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-closure-info-for-a-specific-day.md): Returns whether the closure was already done for a specific day or not - [Get report for a specific date (E-reporting)](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-report-for-a-specific-date-e-reporting.md): The endpoints returns the report for a specific date containing the required data for e-reporting #### Locations - [Get locations](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-locations.md): Returns the list of physical locations (outlets or terminals) configured in the POS system. #### Products - [Get products](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-products.md): Returns the list of products or menu items available for sale in the POS system. - [Get Modifiers](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-modifiers.md): Returns the list of product modifiers (add-ons or customization options) available in the POS system. #### Categories - [Get product categories](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-product-categories.md): Returns the list of product categories used to organize the menu or catalog in the POS system. - [Get accounting categories](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-accounting-categories.md): Returns a list of accounting categories. When not available for a specific POS, it will return the same values as the product categories. #### Customers - [Get customers](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-customers.md): Returns the list of customer profiles registered in the POS system, optionally filtered. - [Get one customer](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-one-customer.md): Returns a specific customer profile from the POS system by their unique identifier. - [Create one customer](https://docs.chift.eu/api-reference/endpoints/point-of-sale/create-one-customer.md): Creates a new customer profile in the POS system and returns the created customer record. #### Objectives - [Get objectives](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-objectives.md): Return the total amount and the tax amount for a specific period #### Taxes - [Get tax rates (POS)](https://docs.chift.eu/api-reference/endpoints/point-of-sale/get-tax-rates-pos.md): Returns the list of tax rates configured in the POS system for product and order pricing. ### eCommerce #### Orders - [Get all orders](https://docs.chift.eu/api-reference/endpoints/ecommerce/get-all-orders.md): Returns the list of orders placed in the e-commerce system, optionally filtered by date or status. - [Get one specific order](https://docs.chift.eu/api-reference/endpoints/ecommerce/get-one-specific-order.md): Returns a specific order from the e-commerce system by its unique identifier. - [Create an order](https://docs.chift.eu/api-reference/endpoints/ecommerce/create-an-order.md): Creates a new customer order in the e-commerce system and returns the created order record. #### Products & variants - [Get all products](https://docs.chift.eu/api-reference/endpoints/ecommerce/get-all-products.md): Returns the list of all products available in the e-commerce catalog, optionally filtered. - [Get one specific product](https://docs.chift.eu/api-reference/endpoints/ecommerce/get-one-specific-product.md): Returns a specific product from the e-commerce catalog by its unique identifier. - [Get one specific product variant](https://docs.chift.eu/api-reference/endpoints/ecommerce/get-one-specific-product-variant.md): Returns a specific product variant from the e-commerce system by its unique identifier. - [Update available quantity](https://docs.chift.eu/api-reference/endpoints/ecommerce/update-available-quantity.md): Update available quantity of a product variant in a specific location #### Categories - [Get all product categories](https://docs.chift.eu/api-reference/endpoints/ecommerce/get-all-product-categories.md): Returns the list of product categories defined in the e-commerce system for organizing the catalog. #### Customers - [Get all customers](https://docs.chift.eu/api-reference/endpoints/ecommerce/get-all-customers.md): Returns the list of all customers registered in the e-commerce system, optionally filtered. - [Get one specific customer](https://docs.chift.eu/api-reference/endpoints/ecommerce/get-one-specific-customer.md): Returns a specific customer from the e-commerce system by their unique identifier. #### Payment methods - [Get all payment methods](https://docs.chift.eu/api-reference/endpoints/ecommerce/get-all-payment-methods.md): Returns the list of payment methods accepted and configured in the e-commerce system. #### Locations - [Get all locations](https://docs.chift.eu/api-reference/endpoints/ecommerce/get-all-locations.md): Returns the list of all physical or virtual locations configured in the e-commerce system. #### Countries - [Get all countries](https://docs.chift.eu/api-reference/endpoints/ecommerce/get-all-countries.md): Returns the list of all activated countries available for shipping and billing in the e-commerce system. #### Taxes - [Get all tax rates](https://docs.chift.eu/api-reference/endpoints/ecommerce/get-all-tax-rates.md): Returns the list of all tax rates configured in the e-commerce system for product pricing. ### PMS #### Orders - [Get orders (PMS)](https://docs.chift.eu/api-reference/endpoints/property-management-system/get-orders-pms.md): Returns the list of orders (reservations or bookings) placed in the property management system. #### Invoices - [Get invoices (PMS)](https://docs.chift.eu/api-reference/endpoints/property-management-system/get-invoices-pms.md): Returns the list of invoices generated by the property management system for guests or reservations. #### Payment methods - [Get payment methods (PMS)](https://docs.chift.eu/api-reference/endpoints/property-management-system/get-payment-methods-pms.md): Returns the list of payment methods accepted and configured in the property management system. #### Payments - [Get payments (PMS)](https://docs.chift.eu/api-reference/endpoints/property-management-system/get-payments-pms.md): Returns the list of payments collected in the property management system, optionally filtered by date. #### Closure info - [Get closure info for a specific day (PMS)](https://docs.chift.eu/api-reference/endpoints/property-management-system/get-closure-info-for-a-specific-day-pms.md): Returns whether the closure was already done for a specific day or not #### Locations - [Get locations (PMS)](https://docs.chift.eu/api-reference/endpoints/property-management-system/get-locations-pms.md): Returns the list of physical locations (hotels, properties, or outlets) in the property management system. #### Categories - [Get accounting categories (PMS)](https://docs.chift.eu/api-reference/endpoints/property-management-system/get-accounting-categories-pms.md): Returns a list of accounting categories. When not available for a specific PMS,it will return the same values as the product categories. #### Customers - [Get customers (PMS)](https://docs.chift.eu/api-reference/endpoints/property-management-system/get-customers-pms.md): Returns the list of all guest or customer profiles registered in the property management system. #### Taxes - [Get tax rates (PMS)](https://docs.chift.eu/api-reference/endpoints/property-management-system/get-tax-rates-pms.md): Returns the list of tax rates configured in the property management system for billing purposes. #### Accounting transactions - [Get the accounting transactions (PMS)](https://docs.chift.eu/api-reference/endpoints/property-management-system/get-the-accounting-transactions-pms.md): Returns the list of accounting transactions generated by the property management system for reconciliation. ### Payment #### Payments - [Get a payment](https://docs.chift.eu/api-reference/endpoints/payment/get-a-payment.md): Returns a specific payment record from the payment connector by its unique identifier. - [Retrieve all payments](https://docs.chift.eu/api-reference/endpoints/payment/retrieve-all-payments.md): Returns the list of payment intents processed by the payment connector, optionally filtered by date. #### Balances - [Retrieve all balances](https://docs.chift.eu/api-reference/endpoints/payment/retrieve-all-balances.md): Returns the list of account balances available in the payment processor for the authenticated account. #### Transactions - [Retrieve all transactions](https://docs.chift.eu/api-reference/endpoints/payment/retrieve-all-transactions.md): Returns a list of transactions. Optionally transaction type and dates can be defined to retrieve transactions of a certain type from a certain date to another date #### Refunds - [Retrieve all refunds](https://docs.chift.eu/api-reference/endpoints/payment/retrieve-all-refunds.md): Returns the list of refund transactions processed by the payment connector, optionally filtered by date. ### Banking #### Financial institutions - [Get list of financial institutions](https://docs.chift.eu/api-reference/endpoints/banking/get-list-of-financial-institutions.md): Returns the list of financial institutions the user consent access to #### Banking accounts - [Get list of banking accounts](https://docs.chift.eu/api-reference/endpoints/banking/get-list-of-banking-accounts.md): Returns the list of banking accounts. - [Get aggregated list of account counterparts found in transactions](https://docs.chift.eu/api-reference/endpoints/banking/get-aggregated-list-of-account-counterparts-found-in-transactions.md): Returns the aggregated list of account counterpats found in transactions. Useful for categorisation. #### Transactions - [Get list of financial transactions](https://docs.chift.eu/api-reference/endpoints/banking/get-list-of-financial-transactions.md): Returns the list of bank transactions for a specific account, optionally filtered by date range. ### Other #### API transactions - [Get transaction information](https://docs.chift.eu/api-reference/endpoints/connections/get-transaction-information.md): Returns the API transaction matching the given client_request_id, allowing you to trace the outcome of a specific request made on behalf of a consumer. #### Webhooks - [Add new webhook instance](https://docs.chift.eu/api-reference/endpoints/webhooks/add-new-webhook-instance.md): Creates a new webhook subscription for the specified event and URL, then returns the created webhook instance. - [Get one webhook instance](https://docs.chift.eu/api-reference/endpoints/webhooks/get-one-webhook-instance.md): Returns the specified webhook instance. - [Get list of webhook instances](https://docs.chift.eu/api-reference/endpoints/webhooks/get-list-of-webhook-instances.md): Returns a list of webhook instances (active/inactive) for your account - [Update one webhook](https://docs.chift.eu/api-reference/endpoints/webhooks/update-one-webhook.md): Updates the URL, status, or signing secret of an existing webhook and returns the updated webhook instance. - [Delete one webhook](https://docs.chift.eu/api-reference/endpoints/webhooks/delete-one-webhook.md): Deletes the specified webhook subscription and its associated logs, then returns HTTP 204 on success. - [Get list of possible webhooks](https://docs.chift.eu/api-reference/endpoints/webhooks/get-list-of-possible-webhooks.md): Returns a list of webhook that are available for your account - [Get list of webhook logs for one webhook](https://docs.chift.eu/api-reference/endpoints/webhooks/get-list-of-webhook-logs-for-one-webhook.md): Returns a list of webhook logs for one webhook for your account #### Syncs - [Get syncs](https://docs.chift.eu/api-reference/endpoints/syncs/get-syncs.md): Returns all syncs configured for your account. - [Get sync](https://docs.chift.eu/api-reference/endpoints/syncs/get-sync.md): Returns the sync matching the given ID. - [Get sync information for one consumer](https://docs.chift.eu/api-reference/endpoints/consumers/get-sync-information-for-one-consumer.md): Returns sync information (creation date, mapping) related to a specific consumer - [Enable a flow for a specific consumer](https://docs.chift.eu/api-reference/endpoints/syncs/enable-a-flow-for-a-specific-consumer.md): Enables the specified flow for a consumer so that it starts executing on its configured schedule or triggers. - [Send a custom event for a specific flow (deprecated)](https://docs.chift.eu/api-reference/endpoints/syncs/send-a-custom-event-for-a-specific-flow-deprecated.md): Deprecated: use POST /syncs/{syncid}/flows/{flowid}/execute, which runs a flow for a list of consumers or for one consumer with settings. Kept working unchanged; not removed. - [Get execution details](https://docs.chift.eu/api-reference/endpoints/syncs/get-execution-details.md): Returns the details of a specific execution for the given sync and flow. - [Get execution data for a specific consumer and a specific datastore](https://docs.chift.eu/api-reference/endpoints/consumers/get-execution-data-for-a-specific-consumer-and-a-specific-datastore.md): Returns execution data related to a consumer and a datastore. Queryparams can be used to filter the restuls by datastore column or by executionid - [Get executions information for one consumer/flow/sync](https://docs.chift.eu/api-reference/endpoints/consumers/get-executions-information-for-one-consumerflowsync.md): Returns all execution records for the specified consumer, sync, and flow combination, optionally filtered by date range. - [Get executions for a sync](https://docs.chift.eu/api-reference/endpoints/syncs/get-executions-for-a-sync.md): Returns all executions for a sync with pagination. Optionally filter by flow. - [Update flow mappings for a specific consumer](https://docs.chift.eu/api-reference/endpoints/syncs/update-flow-mappings-for-a-specific-consumer.md): Replaces the flow mappings for a specific consumer with the provided configuration, overwriting the existing mappings. - [Update flow settings for a specific consumer](https://docs.chift.eu/api-reference/endpoints/syncs/update-flow-settings-for-a-specific-consumer.md): Updates the flow configuration for a specific consumer by merging the provided settings with the existing configuration. - [Retrieve the url of a sync for a specific consumer](https://docs.chift.eu/api-reference/endpoints/consumers/retrieve-the-url-of-a-sync-for-a-specific-consumer.md): Links the specified consumer to a sync and returns the URL to share with your client so they can complete the connection setup. #### Data layer - [Enable the datalayer sync for a connection](https://docs.chift.eu/api-reference/endpoints/datalayer/enable-the-datalayer-sync-for-a-connection.md): Enables the datalayer sync for the consumer's connection so it refreshes on schedule. Requires the datalayer to be configured for the connection's vertical. - [Refresh the datalayer sync for a connection](https://docs.chift.eu/api-reference/endpoints/datalayer/refresh-the-datalayer-sync-for-a-connection.md): Triggers an on-demand execution of the datalayer sync for the consumer's connection. Requires the datalayer to be configured for the connection's vertical and the sync enabled. - [Disable the datalayer sync for a connection](https://docs.chift.eu/api-reference/endpoints/datalayer/disable-the-datalayer-sync-for-a-connection.md): Disables the datalayer sync for the consumer's connection so it stops refreshing. Requires the datalayer to be configured for the connection's vertical. #### Issues - [Get issues](https://docs.chift.eu/api-reference/endpoints/issues/get-issues.md): Returns a list of the issues of your account. Filters can be used to query specific results. Filters can be combined and are inclusive. - [Get issues by consumer id](https://docs.chift.eu/api-reference/endpoints/issues/get-issues-by-consumer-id.md): Returns a list of the issues linked to specific consumer. Filters can be used to query specific results. Filters can be combined and are inclusive. - [Get details about one issue](https://docs.chift.eu/api-reference/endpoints/issues/get-details-about-one-issue.md): Returns one specific issue. This includes as well the list of events for this issue. #### Datastores - [Get list of datastores](https://docs.chift.eu/api-reference/endpoints/datastores/get-list-of-datastores.md): Returns a list of datastores (active and inactive) available for your account ## OpenAPI Specs - [openapi](/api-reference/openapi.json)