# Easyflow

This is the API documentation and must be used by everyone who wants to integrate with the Easyflow platform.
- [Pixel SDK](https://www.npmjs.com/package/@easyflow/pixel)
- [Web SDK](https://www.npmjs.com/package/@easyflow/javascript-sdk)


Easyflow API Document

Version: 1.0
License: 

## Servers

Production environment URL
```
https://wz0ppvhzw7.execute-api.sa-east-1.amazonaws.com
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Easyflow](https://mobile-docs.easyflow.digital/_bundle/openapi.yaml)

## Authentication

### Sign In

 - [POST /identity/sign-in](https://mobile-docs.easyflow.digital/openapi/authentication/identitysignin.md)

### Verify 2FA

 - [POST /accounts/verify-2fa](https://mobile-docs.easyflow.digital/openapi/authentication/verify2fa.md)

### Refresh access token

 - [POST /identity/refresh](https://mobile-docs.easyflow.digital/openapi/authentication/paths/~1identity~1refresh/post.md): Refresh the user's access token using a valid refresh token. Requires authentication via bearer token and device fingerprint. The refresh-token header must contain the current refresh token.

### Register new device

 - [POST /identity/devices](https://mobile-docs.easyflow.digital/openapi/authentication/paths/~1identity~1devices/post.md)

### Approve new device

 - [PATCH /identity/devices/approve](https://mobile-docs.easyflow.digital/openapi/authentication/paths/~1identity~1devices~1approve/patch.md)

### Validate account

 - [PATCH /identity/accounts/validate](https://mobile-docs.easyflow.digital/openapi/authentication/paths/~1identity~1accounts~1validate/patch.md)

### Resend EMAIL OTP

 - [POST /identity/otps/email](https://mobile-docs.easyflow.digital/openapi/authentication/paths/~1identity~1otps~1email/post.md)

### Resend SMS OTP

 - [POST /identity/otps/sms](https://mobile-docs.easyflow.digital/openapi/authentication/paths/~1identity~1otps~1sms/post.md)

## Users

### Get User

 - [GET /management/users/{userId}](https://mobile-docs.easyflow.digital/openapi/users/getuser.md): Retrieve details of a specific user by their ID.

## Organizations

### Get Organization

 - [GET /management/organizations/{id}](https://mobile-docs.easyflow.digital/openapi/organizations/getorganization.md): Retrieve details of a specific organization by its ID.

### List user organizations

 - [GET /management/organizations/list](https://mobile-docs.easyflow.digital/openapi/organizations/paths/~1management~1organizations~1list/get.md): Returns a paginated list of organizations associated with the authenticated user.

### List collaborators

 - [GET /easyflow/businesses/list-by-collaborator](https://mobile-docs.easyflow.digital/openapi/organizations/paths/~1easyflow~1businesses~1list-by-collaborator/get.md): List all businesses the collaborator is part of

## Sales

### Filter Sales

 - [POST /easyflow/sales/list](https://mobile-docs.easyflow.digital/openapi/sales/listsales.md): Retrieve a paginated list of sales with filtering and ordering options.

### Get order details

 - [GET /easyflow/orders/{orderId}](https://mobile-docs.easyflow.digital/openapi/sales/paths/~1easyflow~1orders~1%7Borderid%7D/get.md): Retrieve detailed information about a specific order, including buyer, items, payments, commissions, and refund information.

### Filter total sales

 - [POST /easyflow/sales/total-sales](https://mobile-docs.easyflow.digital/openapi/sales/paths/~1easyflow~1sales~1total-sales/post.md): Retrieve the total number of transactions per payment method based on optional filters such as date range, status, or free sales.

## Commissions

### Filter commissions

 - [POST /easyflow/commissions/{businessId}](https://mobile-docs.easyflow.digital/openapi/commissions/paths/~1easyflow~1commissions~1%7Bbusinessid%7D/post.md): Retrieve the total gross and net commissions for the authenticated user, optionally filtered by date range and commission status.

### List daily commissions

 - [POST /easyflow/commissions/daily-commissions-list](https://mobile-docs.easyflow.digital/openapi/commissions/paths/~1easyflow~1commissions~1daily-commissions-list/post.md): Retrieve a list of daily commissions, including the total number of commissions and total value earned per day, optionally filtered by date range and commission status.

## Financial

### Get business balance

 - [GET /easyflow/businesses/balance](https://mobile-docs.easyflow.digital/openapi/financial/paths/~1easyflow~1businesses~1balance/get.md): Retrieve the current balance.

### Filter movements group

 - [POST /easyflow/movement-groups/list](https://mobile-docs.easyflow.digital/openapi/financial/paths/~1easyflow~1movement-groups~1list/post.md): Retrieve paginated movement groups.

### Filter movements

 - [POST /easyflow/movements/list](https://mobile-docs.easyflow.digital/openapi/financial/paths/~1easyflow~1movements~1list/post.md): Retrieve paginated movement.

### Filter withdraw requests by business

 - [POST /easyflow/withdraw-requests/list-by-business](https://mobile-docs.easyflow.digital/openapi/financial/paths/~1easyflow~1withdraw-requests~1list-by-business/post.md): Filter all withdraw requests for the business.

### Get withdraw request details

 - [GET /easyflow/withdraw-requests/{withdrawRequestId}](https://mobile-docs.easyflow.digital/openapi/financial/paths/~1easyflow~1withdraw-requests~1%7Bwithdrawrequestid%7D/get.md): Get the full details of a specific withdraw request.

## Subscriptions

### Get subscription recurrence

 - [GET /easyflow/subscription-recurrences/{subscriptionRecurrenceId}](https://mobile-docs.easyflow.digital/openapi/subscriptions/paths/~1easyflow~1subscription-recurrences~1%7Bsubscriptionrecurrenceid%7D/get.md)