- Introduction - Limits - Common structure - API key - OAuth 2.0 - Basic methods - Filter - Search - Relations - Data types - Webhooks - Users - Custom fields - Customfields - Fieldsets - getGet - getList - Fields - postCreate - postUpdate - getDelete - getGet - getList - Options - postCreate - postUpdate - getDelete - getGet - getList - Selected checkboxes option - postCreate - postUpdate - getDelete - getGet - getList - My Team - Company - Employee time off - postCreate - postUpdate - getDelete - getGet - getList - Time off type - postCreate - postUpdate - getDelete - getGet - getList - Payables & Receivables - Payables & Receivables - postCreate - postUpdate - getDelete - getGet - getList - Linking to the transaction - postCreate - postUpdate - getDelete - getGet - getList - Linking to the PLS transaction - postCreate - postUpdate - getDelete - getGet - getList - Borrowed Loans - Borrowed Loans - postCreate - postUpdate - getDelete - getGet - getList - Linking credit to transaction - postCreate - postUpdate - getDelete - getGet - getList - Linking credit to P&L transaction - postCreate - postUpdate - getDelete - getGet - getList - Fixed Assets - Fixed Asset - postCreate - postUpdate - getDelete - getGet - getList - Allocation by business lines - postCreate - postUpdate - getDelete - getGet - getList - Asset transaction link - postCreate - postUpdate - getDelete - getGet - getList - Asset P&L transaction link - postCreate - postUpdate - getDelete - getGet - getList - Business line allocation groups - postCreate - postUpdate - getDelete - getGet - getList - Documents - postCreate - postUpdate - getDelete - getGet - getList - Tasks - Task - Tasks - postCreate - postUpdate - getDelete - getGet - getList - Payment logs for fixed cost tasks - postCreate - postUpdate - getDelete - getGet - getList - Lists - postCreate - postUpdate - getDelete - getGet - getList - Linking tasks & lists - postCreate - postUpdate - getDelete - getGet - getList - Followers - postCreate - postUpdate - getDelete - getGet - getList - postCreate - postUpdate - getDelete - getGet - getList - Collaborators - postCreate - postUpdate - getDelete - getGet - getList - Task Workflows - postCreate - postUpdate - getDelete - getGet - getList - Workflow Statuses - postCreate - postUpdate - getDelete - getGet - getList - Calendar - Calendar - postCreate - postUpdate - getDelete - getGet - getList - Agile Projects - Agile - Issues - postCreate - postUpdate - getDelete - getGet - getList - Followers - postCreate - postUpdate - getDelete - getGet - getList - postCreate - postUpdate - getDelete - getGet - getList - Issue relation types - postCreate - postUpdate - getDelete - getGet - getList - Issue relation names - postCreate - postUpdate - getDelete - getGet - getList - Issue relation - postCreate - postUpdate - getDelete - getGet - getList - Issue type - postCreate - postUpdate - getDelete - getGet - getList - Sprint - postCreate - postUpdate - getDelete - getGet - getList - Agile project - postCreate - postUpdate - getDelete - getGet - getList - Project users - postCreate - postUpdate - getDelete - getGet - getList - Workflow - postCreate - postUpdate - getDelete - getGet - getList - Stage - postCreate - postUpdate - getDelete - getGet - getList - Issue types and project relations - postCreate - postUpdate - getDelete - getGet - getList - Agile categories - postCreate - postUpdate - getDelete - getGet - getList - Reference issue relation - postCreate - postUpdate - getDelete - getGet - getList - Epics - postCreate - postUpdate - getDelete - getGet - getList - CRM - CRM - Accounts - postCreate - postUpdate - getDelete - getGet - getList - Relation - postCreate - postUpdate - getDelete - getGet - getList - Loss reasons - postCreate - postUpdate - getDelete - getGet - getList - Opportunities sources - postCreate - postUpdate - getDelete - getGet - getList - Opportunity stages - postCreate - postUpdate - getDelete - getGet - getList - Pipelines - postCreate - postUpdate - getDelete - getGet - getList - Opportunities - postCreate - postUpdate - getDelete - getGet - getList - Account types - postCreate - postUpdate - getDelete - getGet - getList - Account industries - postCreate - postUpdate - getDelete - getGet - getList - Honorifics - postCreate - postUpdate - getDelete - getGet - getList - Opportunity Followers - postCreate - postUpdate - getDelete - getGet - getList - Email - postCreate - postUpdate - getDelete - getGet - getList - Clients phone numbers - postCreate - postUpdate - getDelete - getGet - getList - Products & Services - postCreate - postUpdate - getDelete - getGet - getList - Link opportunity to CRM accounts - postCreate - postUpdate - getDelete - getGet - getList - Projects - Project - Project - postCreate - postUpdate - getDelete - getGet - getList - Project Templates - postCreate - postUpdate - getDelete - getGet - getList - Project stages - postCreate - postUpdate - getDelete - getGet - getList - Stage Checklist - postCreate - postUpdate - getDelete - getGet - getList - Project team - postCreate - postUpdate - getDelete - getGet - getList - Estimated Revenue - postCreate - postUpdate - getDelete - getGet - getList - Estimated Expenses - postCreate - postUpdate - getDelete - getGet - getList - Project portfolio - postCreate - postUpdate - getDelete - getGet - getList - CONFIG.M.ST.BASELINE.TITLE - postCreate - postUpdate - getDelete - getGet - getList - CONFIG.M.ST.BASELINE\_ITEM.TITLE - postCreate - postUpdate - getDelete - getGet - getList - Finance - Finance - Organization - postCreate - postUpdate - getDelete - getGet - getList - Invoice - postCreate - postUpdate - getDelete - getGet - getList - Business line - postCreate - postUpdate - getDelete - getGet - getList - Invoice items - postCreate - postUpdate - getDelete - getGet - getList - Money - postCreate - postUpdate - getDelete - getGet - getList - Invoice contacts - postCreate - postUpdate - getDelete - getGet - getList - Bank account - postCreate - postUpdate - getDelete - getGet - getList - Account groups - postCreate - postUpdate - getDelete - getGet - getList - Estimate - postCreate - postUpdate - getDelete - getGet - getList - Estimate items - postCreate - postUpdate - getDelete - getGet - getList - Estimate template - postCreate - postUpdate - getDelete - getGet - getList - Estimate contacts - postCreate - postUpdate - getDelete - getGet - getList - Transaction - postCreate - postUpdate - getDelete - getGet - getList - Transactions for the Profit and Loss statement - postCreate - postUpdate - getDelete - getGet - getList - Recurring invoice - postCreate - postUpdate - getDelete - getGet - getList - Liabilities - postCreate - postUpdate - getDelete - getGet - getList - Recurring Invoice settings - postCreate - postUpdate - getDelete - getGet - getList - Estimated Cash Flow - postCreate - postUpdate - getDelete - getGet - getList - Linking the invoice items - postCreate - postUpdate - getDelete - getGet - getList - Payment history by estimated cash flow - postCreate - postUpdate - getDelete - getGet - getList - Time Tracker - Time Tracker - Time sheet - postCreate - postUpdate - getDelete - getGet - getList - TIme Log - postCreate - postUpdate - getDelete - getGet - getList - User rates - postCreate - postUpdate - getDelete - getGet - getList - Products & Services - Product - Items - postCreate - postUpdate - getDelete - getGet - getList - Categories - postCreate - postUpdate - getDelete - getGet - getList - Price list - postCreate - postUpdate - getDelete - getGet - getList - Price list and item relation - postCreate - postUpdate - getDelete - getGet - getList - Price - postCreate - postUpdate - getDelete - getGet - getList - Units - postCreate - postUpdate - getDelete - getGet - getList - Warehouses - postCreate - postUpdate - getDelete - getGet - getList - Stock documents - postCreate - postUpdate - getDelete - getGet - getList - Stock document goods - postCreate - postUpdate - getDelete - getGet - getList - Accounts Payable to Vendors - postCreate - postUpdate - getDelete - getGet - getList - Business Processes - Business Process Tasks - Approve - Reject - Request additional information - Fill fields (response to information request) - Confirm task - Processes - postCreate - postUpdate - getDelete - getGet - getList - Stages - postCreate - postUpdate - getDelete - getGet - getList - Process instances - postCreate - postUpdate - getDelete - getGet - getList - More - Webhooks - Global tags - Journal - Permissions - Response Fields - Additional usage examples - Files API docs by Redocly](https://redocly.com/redoc/) # Flowlu Rest API Documentation ( 1.0) Download OpenAPI specification: [Download](https://www.flowlu.com/api/json/openapien.json?ver=1777490767044) ## [section/Introduction](https://www.flowlu.com/api/\#section/Introduction) Introduction All API calls are GET and POST HTTP requests to your account domain (except for requests to the authorization server) at the URL / api / v1 To authenticate each request, you must pass a server API key (parameter api\_key). ``` https://{{your_company}}.flowlu.com/api/v1/module/{{module_name}}/{{entity_name}}/{{method}}?api_key=dDhlTUtENmp4OFBGQkN0N2hUMUNUQ0FFeGI5N2JRZ0VfMQ ``` Data transfer must be in FORM URLEncoded format. ## [section/Limits](https://www.flowlu.com/api/\#section/Limits) Limits The number of requests per second per account is specified in the subscription. On trial the limit is 1 request per second. If the limit is exceeded, a response with status 429 with the header "Too Many Requests" is returned. ## [section/Common-structure](https://www.flowlu.com/api/\#section/Common-structure) Common structure - https://{{your\_company}}.flowlu.com/ — Your account URL, where your account code should be specified instead of your\_company - /api/v1/ - API address and version (v1) - /module/{{module\_name}}/ — points to module - /{{entity\_name}}/ —points to an entity - /{{method}} — points to a method (create, get, list, delete, update) - ?api\_key=\* — your personal API key The response to the request will be returned in JSON format with HTTP code 200. A successful request contains a response object. ## [section/API-key](https://www.flowlu.com/api/\#section/API-key) API key API key management is available in the System Settings → API Settings. You can create and delete keys, as well as configure access rights to individual modules of each key. Removing the key will permanently deactivate it. For authentication using an API key, it is required to pass it with each request to the server the api\_key parameter. Example: ``` https://{{your_company}}.flowlu.com/api/v1/module/crm/lead/list?api_key=dDhlTUtENmp4OFBGQkN0N2hUMUNUQ0FFeGI5N2JRZ0VfMQ ``` ## [section/OAuth-2.0](https://www.flowlu.com/api/\#section/OAuth-2.0) OAuth 2.0 Oauth 2.0 authorization allows access for external applications to Flowlu. Unlike API keys, the scope is certain users that allow access to their accounts for an external client. Registration is available only for the portal's administrator, but the number of applications is unlimited. #### How to get an authorization token To get access to OAuth 2.0 API endpoints, you need to follow steps below: 1. Create an application for external resources in the portal settings to connect to the API. 2. Request authorization approval: ``` GET https://my.flowlu.com/oauth2/authorize?client_id={{client_id}}&state={{state}} ``` Parameters: - **client\_id** (required) - application identifier, located on the detail page of the created application, - **state** \- random token which will be returned to the client. Use for CSRF attack prevention. The response to the request is a page of authorization approval. If the user is not logged in, they’ll be redirected to the Flowlu authorization page. 3. If the user allows access, Flowlu is redirected to the **redirect\_uri** of the application, requesting the authorization with a temporary code, **code** parameter and CSRF token you provided in the **state**. If the condition doesn't match, the request is created by the third part and you have to interrupt the process. The validity of the temporary code is 10 minutes. If access is denied by the user, redirection is performed with **GET** parameters **error** and **error\_description** with the description of the authorization error. 4. Authorization token receiving: `Content-Type: application / x-www-form-urlencoded` ``` POST https://my.flowlu.com/oauth2/access_token ``` Parameters (all required): - **grant\_type** \- the value of "code", authorization type; - **client\_id** \- unique identifier of the client application; - **client\_secret** \- application password; - **code** \- the authorization code that was previously received by the client application; - **redirect\_uri** \- the redirect URI of the client application, where it received the authorization code. The response is returning in JSON format. Example: ``` { "token_type": "Bearer", "expires_in": 5270400, "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9", "refresh_token": "def50200e167a482b9986d640a2cdba892b58aea5e9" } ``` - **token\_type** \- to bearer token type; - **expires\_in** \- authorization token lifetime in seconds; - **access\_token** \- JWT authorization token for API access; - **refresh\_token** \- refresh token. By sending requests to the API endpoints with authorization titles, you’ll be able to receive data according to the user access level of your portal. ``` Authorization: Bearer {{access_token}} ``` The authorization token lifetime is 2 days, and the refresh token is 6 months. Limited lifetime is saving your data from third-party interruptions while compromising. Requests with an expired token will be responded to with the 401 Unauthorized status. ``` { "error": "Access token has been revoked" } ``` To get a new authorization token, make a request: `Content-Type: application / x-www-form-urlencoded` ``` POST https://my.flowlu.com/oauth2/refresh_token ``` Parameters (all required): - **grant\_type** - value of "refresh\_token" _;_ - **client\_id** \- unique identifier of the client application; - **client\_secret** - the client secret value; - **refresh\_token** \- the refresh token. Example of cURL request: ``` curl -X "POST" "https://my.flowlu.com/oauth2/refresh_token" \ -H "Content-Type: application/x-www-form-urlencoded" \ --data-urlencode "grant_type={{refresh_token}}" \ --data-urlencode "client_id={{client_id}}" \ --data-urlencode "client_secret={{client_secret}}" \ --data-urlencode "refresh_token={{refresh_token}}" ``` Type of the response will be the same as it is with receiving an authorization token. Note, that the value of refresh\_token is updated, so it has to be recreated and applied during the next request. ## [section/Basic-methods](https://www.flowlu.com/api/\#section/Basic-methods) Basic methods ### GET - /{{module\_name}}/{{entity\_name}}/get/{id} - getting a record by id An example of getting a record with id = 42: ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/lead/get/42 ``` Record requests can return an error of the data received in the request ``` { "error": { "error_code": 20, "error_msg": "not found" } } ``` ### CREATE - /{{module\_name}}/{{entity\_name}}/create - creating a record An example of creating a record: ``` POST https://{{your_company}}.flowlu.com/api/v1/module/crm/lead/create ``` The response contains the id field with the identifier of the new record ``` { "response": { "id": 5, "_resultMessage": "Your application is accepted. Application number # 5" } } ``` A request to create a record may return a validation error for the data received in the request ``` { "error": "validation", "description": "Form filling error", "details": { "name": "name cannot be empty" } } ``` ### UPDATE /{{module\_name}}/{{entity\_name}}/update/{ID} — update record by id An example of updating a record with id = 42 ``` POST https://{{your_company}}.flowlu.com/api/v1/module/crm/lead/update/42 ``` The response contains all the fields in the updated record. Record update requests may return an error on the data received in the request ``` { "error": { "error_code": 20, "error_msg": "not found" } } ``` ### DELETE /DELETE/{ID} —deleting a record by id. Example of deleting a deal with id = 42 ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/lead/delete/42 ``` The response contains an id field with the identifier of the deleted record ``` { "response": { "id": "42" } } ``` ### LIST /LIST —getting a list of records with the ability to filter. ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/lead/list ``` ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?search=flowlu&page=3 ``` Available query parameters: - limit - the maximum number of records given per request. The default is 50, the maximum is 100. - page - page number of the query result. The default is 1. - filter - an array of parameters for filtering the resulting list of records. - search - search query. | Field | Description | | --- | --- | | total | total number of records, excluding the current search query and applied filters | | total\_result | total number of records, including the current search query and applied filters | | page | page number | | count | number of records in response | | items | array of objects of received records | ``` { "response": { "total": 3, "page": 1, "count": 3, "items": [\ {\ "id": 5,\ "active": 1,\ "name": "company5",\ },\ {\ "id": 4,\ "active": 1,\ "name": "company4",\ ...\ },\ ...\ \ ] } } ``` ## [section/Filter](https://www.flowlu.com/api/\#section/Filter) Filter To filter the received records, you need to pass the filter parameter, which is an array, in which the key is a field of records to filter. ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[active]=1 ``` Comma-separated list of values are available. ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[type_id]=1,2 ``` To exclude by value, use the! ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[type_id]=!1 ``` Filtering by time interval is possible by passing a JSON object, with fields start\_date and end\_date ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[created_date]={"start_date": "2017-02-05", "end_date": "2017-10-05"} ``` ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[closed_date]={"start_date": "2017-01-05"} ``` Filtering by tag ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[_tag_id]=69 ``` Filtering by custom fields ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[cf.field_1]=filter_value ``` Filtering by exact match (exact\_value) is possible by passing a JSON object with the value field, where the required value is specified ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[id]={"type": "exact_value", "value": 3} ``` Filtering by the 'less than' (less) condition is performed by passing a JSON object with the value field, where the maximum value is specified. The response will return records with smaller values ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[id]={"type": "less", "value": 3} ``` Filtering by the 'greater than' (more) condition is performed by passing a JSON object with the value field, where the minimum value is specified. The response will return records with greater values ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[id]={"type": "more", "value": 3} ``` Filtering by a value range is possible by passing a JSON object with the fields start\_value and end\_value ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?filter[id]={"type": "range", "start_value": 3, "end_value": 5} ``` To return only specific fields in the response, pass the fields parameter, listing the required attributes separated by commas ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?fields=id,name ``` ## [section/Search](https://www.flowlu.com/api/\#section/Search) Search To search % LIKE% by values, you need to pass the search = {{value}} parameter.. ``` GET https://{{your_company}}.flowlu.com/api/v1/module/crm/account/list?search=Flowlu ``` ## [section/Relations](https://www.flowlu.com/api/\#section/Relations) Relations Entities can have relationships with other entities using a foreign key. If the relationship goes on several fields, then additional foreign keys are used, which point to the fields. For the convenience of working with related entities, you can use the methods described below. Arguments - {{module}} - module name. - {{model}} - model name. - {{model \_id}} - model id - {{alias}} - Alias used for communication with the entity ### Many to one relationship (belongs to) > Keys are stored in the same entity. #### Receiving ``` GET https://{{your_company}}.flowlu.com/api/v1/module/{{module}}/{{model}}/{{model_id}}/{{alias}}/get ``` #### Update ``` POST https://{{your_company}}.flowlu.com/api/v1/module/{{module}}/{{model}}/{{model_id}}/{{alias}}/update ``` ### One to many relationship (has many) > Keys are stored in the associated entity. #### List ``` GET https://{{your_company}}.flowlu.com/api/v1/module/{{module}}/{{model}}/{{model_id}}/{{alias}}/list ``` #### Create ``` POST https://{{your_company}}.flowlu.com/api/v1/module/{{module}}/{{model}}/{{model_id}}/{{alias}}/create ``` ## [section/Data-types](https://www.flowlu.com/api/\#section/Data-types) Data types | Name | Description | Example | | --- | --- | --- | | int | A number in the range -2147483648 to 2147483647 | 586844 | | string | String with a maximum length of 255 characters | There can be text with a maximum length of 255 | | text | Text | There may be a lot of text here | | boolean | 1 or 0 | 1 ; 0 | | float | Floating point number | 457.45869 | | price | Number, the maximum total number of stored decimal places in which is 20 including 2 after the decimal point | 546.56 | | datetime | ISO 8601 format string (YYYY-MM-DD hh: mm: ss) | 2020-08-26 09:31:16 | | date | ISO 8601 format string (YYYY-MM-DD) | 2020-08-26 | ## [section/Webhooks](https://www.flowlu.com/api/\#section/Webhooks) Webhooks You can create a new webhook in Flowlu via the System Settings → Webhooks. The data is sent in JSON format. The request is made as an HTTP POST request. ### Format ```json { "meta": { "module": "crm", "model": "account", "action": "create" }, "current": (the object data as of this update), "previous": (the object data prior to this update) } ``` ### Fields | Field | type | description | | --- | --- | --- | | meta.module | string | Entity module name | | meta.model | string | Entity model name | | meta.action | string | Event name ("create", "update" or "delete") | | current | object or null | Entity current state | | previous | object or null | Entity previous state | Entity state is data that are placed in a way which conforms to our API Reference. ## [section/Users](https://www.flowlu.com/api/\#section/Users) Users This API allows you to manage users in the system. ### 1\. Conditions and Permissions To perform user creation and editing operations, the authenticated OAuth2.0 user (or API key) must meet one of the following conditions: - **Portal Administrator**: A user with administrator rights in the system. - **Access to "System" Module**: An API key with access to system methods. A user can also update **their own** data without special permissions. * * * ### 2\. User Object Fields The user object is composed of core fields and profile fields. Not all fields are writable, and available fields differ between `create` and `update` operations. #### Core Fields These fields contain the fundamental, read-only information about the user. | Field | Type | Description | | --- | --- | --- | | `id` | integer | Unique identifier for the user. | | `username` | string | Login name, typically the user's email address. | | `name` | string | The full name of the user, generated automatically. | | `lang_id` | integer | ID of the user's interface language. | | `register_date` | string | The date and time when the user was registered. | | `last_active` | string | The date and time of the user's last activity. | | `image` | string | URL path to the user's profile picture. | | `role_admin` | integer | `1` if the user is an administrator, `0` otherwise. | | `role_login` | integer | `1` if the user is allowed to log in, `0` otherwise. | | `role_external` | integer | `1` if the user is an external user, `0` otherwise. | #### Writable Core & Profile Fields These fields can be provided during create or update operations, as specified in the endpoint documentation. | Field | Type | Description | | --- | --- | --- | | `first_name` | string | User's first name. | | `second_name` | string | User's middle name or patronymic. | | `last_name` | string | User's last name. | | `birth_date` | string | User's birth date in `YYYY-MM-DD` format. | | `timezone` | string | The user's timezone (e.g., "Europe/Moscow"). | | `email_personal` | string | User's personal email address. | | `phone_mobile` | string | Mobile phone number. | | `phone_work` | string | Work phone number. | | `phone_internal` | string | Internal office phone number or extension. | | `web` | string | URL of a personal or company website. | | `description` | string | A short biography or description. | | `ref` | string | An external system reference identifier. | | `ref_id` | string | The ID for the external system reference. | | `position` | string | The user's job title or position. | | `link_*` | string | Social media links (e.g., `link_telegram`). | | `cf_*` | mixed | Custom fields defined in the system. | * * * ### 3\. Get List of Users **GET**`/api/v1/module/core/user/list` Retrieves a paginated and filterable list of users. _(See previous sections for full details)_ * * * ### 4\. Get User Details **GET**`/api/v1/module/core/user/get/{id}` Retrieves detailed information about a user by their ID. _(See previous sections for full details)_ * * * ### 5\. Get Current User Details **GET**`/api/v1/module/core/user/get` Retrieves detailed information about the currently authenticated user. _(See previous sections for full details)_ * * * ### 6\. Create User **POST**`/api/v1/module/core/user/create` Creates a new user. **Required Permissions**: The user must be a portal administrator or use an API key with access to system methods. #### Request Body Parameters: | Field | Type | Required | Description | | --- | --- | --- | --- | | `email` | string | Yes | User's email. This will be used to set the read-only `username` field. | | `role_login` | integer | No | `1` (default) allows login, `0` creates a "dummy" user record without login. | | `first_name` | string | No | User's first name. | | `last_name` | string | No | User's last name. | | `position` | string | No | User's job title. | | ... | ... | No | Any other writable Core & Profile fields. | #### Example Request: ``` POST /api/v1/module/core/user/create Content-Type: application/json { "email": "new.user@example.com", "first_name": "New", "last_name": "User", "role_login": 1, "position": "Manager" } ``` * * * ### 7\. Update User by ID **POST**`/api/v1/module/core/user/update/{id}` Updates an existing user's data. **Required Permissions**: - A user can update themselves. - A portal administrator or an API key with access to system methods can update any user. **Important Note**: Core fields (`first_name`, `last_name`, etc.) **will not be updated** if the user is a member of multiple accounts. Only Profile fields are updated in this scenario. #### Request Body Parameters: This endpoint accepts any of the "Writable Core & Profile Fields" listed in section 2. Fields like `id`, `username`, `email`, and `role_*` cannot be modified via this method. #### Example Request: ``` PUT /api/v1/module/core/user/update/123 Content-Type: application/json { "first_name": "Jonathan", "position": "Senior Developer", "link_telegram": "@jonathan_dev" } ``` * * * ### 8\. Update Current User Data **PUT**`/api/v1/module/core/user/update` Updates data for the currently authenticated user. #### Request Body Parameters: This endpoint accepts any of the "Writable Core & Profile Fields" listed in section 2. Fields like `id` and `role_*` cannot be modified. #### Example Request: ``` PUT /api/v1/module/core/user/update Content-Type: application/json { "position": "Lead Specialist" } ``` #### Response (200 OK - updated user object): ```json { "id": 123, "username": "current.user@example.com", "first_name": "Jane", "last_name": "Doe", "position": "Lead Specialist" // ... other updated fields } ``` ## [tag/Customfields](https://www.flowlu.com/api/\#tag/Customfields) Customfields An entity can have custom fields. Such fields are named using the pattern `cf_{{number}}`. In entity, you cannot create a new field from the API, but you can change, add and remove values, just like with regular entity fields. To get full information about a field, you need add `customfields = 1` in query parameters. If a custom field is configured to use an alias, field name has to look like `cf_{{alias}}`. To make the field work with an alias, `"alias"` and `"api_use_alias=1"` have to be filled. If you change the CustomField value but it doesn't update, try `cf.{{number}}` instead of `cf_{{number}}`. In some cases, `cf_{{number}}` template may not work correctly. To set values in checkboxes use square brackets `cf_900[]` (cf\_900\[\] = option\_id, cf\_900\[\] = option2\_id). Drop-down sets like a regular field (cf\_900 = option\_id). Examples: 1. https://{{your\_company}}.flowlu.com/api/v1/module/task/tasks/get/8225 ``` "response": { "id": 8225, "name": "Task 1", ... "crm_account_id": 0, "cf_900": "0", "cf_phone": "+46764055555" } ``` 2. https://{{your\_company}}.flowlu.com/api/v1/module/task/tasks/get/8225?customfields=1 ``` "response": { "id": 8225, "name": "Task 1", ... "crm_account_id": 0, "customfields": [\ {\ "id": "900",\ "title": "Yes-No",\ "type": "boolean",\ "value": "0"\ }\ {\ "id": "901",\ "title": "Phone number",\ "alias": "phone",\ "api_use_alias": "1"\ "type": "smalltext",\ "value": "+46764055555"\ }\ ] } ``` 3. Seting values in checkboxes ``` https://{{your_company}}.flowlu.com/api/v1/module/crm/contact/update/666?api_key=' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data 'cf_900[]=866' \ --data 'cf_900[]=897' https://{{your_company}}.flowlu.com/api/v1/module/crm/contact/update/666?api_key=' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data 'cf\_{{alias}}[]=866' \ --data 'cf\_{{alias}}[]=897' ``` ## [tag/Fieldsets](https://www.flowlu.com/api/\#tag/Fieldsets) Fieldsets ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [fields](https://www.flowlu.com/api/#tag/Fields) | Custom fields | Fields | fieldset\_id | ## [tag/Fieldsets/paths/~1customfields~1fieldsets~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Fieldsets/paths/~1customfields~1fieldsets~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/customfields/fieldsets/get/{id} https://{company}.flowlu.com/api/v1/module/customfields/fieldsets/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "module": "string", "model": "string", "group_id": 0, "group_field": "string" } }` ## [tag/Fieldsets/paths/~1customfields~1fieldsets~1list/get](https://www.flowlu.com/api/\#tag/Fieldsets/paths/~1customfields~1fieldsets~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/customfields/fieldsets/list https://{company}.flowlu.com/api/v1/module/customfields/fieldsets/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "module": "string",\ \ "model": "string",\ \ "group_id": 0,\ \ "group_field": "string"\ \ }\ \ ] } }` ## [tag/Fields](https://www.flowlu.com/api/\#tag/Fields) Fields ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [\_fieldset](https://www.flowlu.com/api/#tag/Fieldsets) | Custom fields | Fieldsets | fieldset\_id | | [parent\_cache](https://www.flowlu.com/api/#tag/Fields) | Custom fields | Fields | cache\_parent\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [options](https://www.flowlu.com/api/#tag/Options) | Custom fields | Options | field\_id | | [selected\_options](https://www.flowlu.com/api/#tag/Selected%20checkboxes%20option) | Custom fields | Selected checkboxes option | field\_id | | [cache\_fields](https://www.flowlu.com/api/#tag/Fields) | Custom fields | Fields | cache\_parent\_id | ## [tag/Fields/paths/~1customfields~1fields~1create/post](https://www.flowlu.com/api/\#tag/Fields/paths/~1customfields~1fields~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | fieldset\_id | integer
Id of the set of fields to which the field is bound | | name | string
Field name | | ordering | integer
The order in the output the larger the number, the lower the field will be shown | | type | string
Field type:
smalltext => Text
text => Multiline text
int => Integer
date => Date
< li> datetime => Date and time price => Price
decimal => Number (fractional number in decimal)
select.single => Dropdown list
select.multiple => Multiple list
model.file => File
model.user => User
boolean = > Yes / No
autonumber => Autonumber | | alias | string
Field alias | | api\_use\_alias | boolean
Use alias in API:
0 - Don't use
1 - Use | | webhook\_use\_alias | boolean
Use alias in webhooks:
0 - Don't use
1 - Use | | formula | string | | module | string | | model | string | | scope\_id | integer | | group\_id | integer
Custom list id | | group\_label\_field\_id | integer
Custom field Id in the list specified in group\_id. Used to link fields. | | active | integer
Active states:
0 - Inactive
1 - Active | | required | integer
1 - Required
0 - Optional | | hint | string
Tooltip | | show\_on\_detail\_page | boolean | | show\_in\_mobile | boolean | | parent\_id | integer | | hidden\_detail | boolean | | cache\_value | string | | cache\_parent\_id | integer | ### Responses **200** Successfully create an item post/customfields/fields/create https://{company}.flowlu.com/api/v1/module/customfields/fields/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "fieldset_id": 0, "name": "string", "ordering": 0, "type": "string", "alias": "string", "api_use_alias": true, "webhook_use_alias": true, "formula": "string", "module": "string", "model": "string", "scope_id": 0, "group_id": 0, "group_label_field_id": 0, "active": 0, "required": 0, "hint": "string", "show_on_detail_page": true, "show_in_mobile": true, "parent_id": 0, "hidden_detail": true, "cache_value": "string", "cache_parent_id": 0 } }` ## [tag/Fields/paths/~1customfields~1fields~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Fields/paths/~1customfields~1fields~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/customfields/fields/update/{id} https://{company}.flowlu.com/api/v1/module/customfields/fields/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "fieldset_id": 0, "name": "string", "ordering": 0, "type": "string", "alias": "string", "api_use_alias": true, "webhook_use_alias": true, "formula": "string", "module": "string", "model": "string", "scope_id": 0, "group_id": 0, "group_label_field_id": 0, "active": 0, "required": 0, "hint": "string", "show_on_detail_page": true, "show_in_mobile": true, "parent_id": 0, "hidden_detail": true, "cache_value": "string", "cache_parent_id": 0 } }` ## [tag/Fields/paths/~1customfields~1fields~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Fields/paths/~1customfields~1fields~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/customfields/fields/delete/{id} https://{company}.flowlu.com/api/v1/module/customfields/fields/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Fields/paths/~1customfields~1fields~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Fields/paths/~1customfields~1fields~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/customfields/fields/get/{id} https://{company}.flowlu.com/api/v1/module/customfields/fields/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "fieldset_id": 0, "name": "string", "ordering": 0, "type": "string", "alias": "string", "api_use_alias": true, "webhook_use_alias": true, "formula": "string", "module": "string", "model": "string", "scope_id": 0, "group_id": 0, "group_label_field_id": 0, "active": 0, "required": 0, "hint": "string", "show_on_detail_page": true, "show_in_mobile": true, "parent_id": 0, "hidden_detail": true, "cache_value": "string", "cache_parent_id": 0 } }` ## [tag/Fields/paths/~1customfields~1fields~1list/get](https://www.flowlu.com/api/\#tag/Fields/paths/~1customfields~1fields~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/customfields/fields/list https://{company}.flowlu.com/api/v1/module/customfields/fields/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "fieldset_id": 0,\ \ "name": "string",\ \ "ordering": 0,\ \ "type": "string",\ \ "alias": "string",\ \ "api_use_alias": true,\ \ "webhook_use_alias": true,\ \ "formula": "string",\ \ "module": "string",\ \ "model": "string",\ \ "scope_id": 0,\ \ "group_id": 0,\ \ "group_label_field_id": 0,\ \ "active": 0,\ \ "required": 0,\ \ "hint": "string",\ \ "show_on_detail_page": true,\ \ "show_in_mobile": true,\ \ "parent_id": 0,\ \ "hidden_detail": true,\ \ "cache_value": "string",\ \ "cache_parent_id": 0\ \ }\ \ ] } }` ## [tag/Options](https://www.flowlu.com/api/\#tag/Options) Options Options ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [field](https://www.flowlu.com/api/#tag/Options) | Custom fields | Options | field\_id | ## [tag/Options/paths/~1customfields~1fieldoptions~1create/post](https://www.flowlu.com/api/\#tag/Options/paths/~1customfields~1fieldoptions~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | field\_id | integer
Id of the field to which the options are bound | | type | string
Type | | value | string
Value | | ordering | integer
The order in the output the larger the number, the lower the field will be shown | | color | string
Option color | | ref | string
Ref | | ref\_id | string
Ref | ### Responses **200** Successfully create an item post/customfields/fieldoptions/create https://{company}.flowlu.com/api/v1/module/customfields/fieldoptions/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "field_id": 0, "type": "string", "value": "string", "ordering": 0, "color": "string", "ref": "string", "ref_id": "string" } }` ## [tag/Options/paths/~1customfields~1fieldoptions~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Options/paths/~1customfields~1fieldoptions~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/customfields/fieldoptions/update/{id} https://{company}.flowlu.com/api/v1/module/customfields/fieldoptions/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "field_id": 0, "type": "string", "value": "string", "ordering": 0, "color": "string", "ref": "string", "ref_id": "string" } }` ## [tag/Options/paths/~1customfields~1fieldoptions~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Options/paths/~1customfields~1fieldoptions~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/customfields/fieldoptions/delete/{id} https://{company}.flowlu.com/api/v1/module/customfields/fieldoptions/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Options/paths/~1customfields~1fieldoptions~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Options/paths/~1customfields~1fieldoptions~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/customfields/fieldoptions/get/{id} https://{company}.flowlu.com/api/v1/module/customfields/fieldoptions/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "field_id": 0, "type": "string", "value": "string", "ordering": 0, "color": "string", "ref": "string", "ref_id": "string" } }` ## [tag/Options/paths/~1customfields~1fieldoptions~1list/get](https://www.flowlu.com/api/\#tag/Options/paths/~1customfields~1fieldoptions~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/customfields/fieldoptions/list https://{company}.flowlu.com/api/v1/module/customfields/fieldoptions/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "field_id": 0,\ \ "type": "string",\ \ "value": "string",\ \ "ordering": 0,\ \ "color": "string",\ \ "ref": "string",\ \ "ref_id": "string"\ \ }\ \ ] } }` ## [tag/Selected-checkboxes-option](https://www.flowlu.com/api/\#tag/Selected-checkboxes-option) Selected checkboxes option ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [field](https://www.flowlu.com/api/#tag/Fields) | Custom fields | Fields | field\_id | | [option](https://www.flowlu.com/api/#tag/Options) | Custom fields | Options | fieldoption\_id | ## [tag/Selected-checkboxes-option/paths/~1customfields~1selected_options~1create/post](https://www.flowlu.com/api/\#tag/Selected-checkboxes-option/paths/~1customfields~1selected_options~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | item\_id | integer
Option id | | field\_id | integer
Custom field id | | fieldoption\_id | integer
Field option id | ### Responses **200** Successfully create an item post/customfields/selected\_options/create https://{company}.flowlu.com/api/v1/module/customfields/selected\_options/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "item_id": 0, "field_id": 0, "fieldoption_id": 0 } }` ## [tag/Selected-checkboxes-option/paths/~1customfields~1selected_options~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Selected-checkboxes-option/paths/~1customfields~1selected_options~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | item\_id | integer
Option id | | field\_id | integer
Custom field id | | fieldoption\_id | integer
Field option id | ### Responses **200** Successfully update an item post/customfields/selected\_options/update/{id} https://{company}.flowlu.com/api/v1/module/customfields/selected\_options/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "item_id": 0, "field_id": 0, "fieldoption_id": 0 } }` ## [tag/Selected-checkboxes-option/paths/~1customfields~1selected_options~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Selected-checkboxes-option/paths/~1customfields~1selected_options~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/customfields/selected\_options/delete/{id} https://{company}.flowlu.com/api/v1/module/customfields/selected\_options/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Selected-checkboxes-option/paths/~1customfields~1selected_options~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Selected-checkboxes-option/paths/~1customfields~1selected_options~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/customfields/selected\_options/get/{id} https://{company}.flowlu.com/api/v1/module/customfields/selected\_options/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "item_id": 0, "field_id": 0, "fieldoption_id": 0 } }` ## [tag/Selected-checkboxes-option/paths/~1customfields~1selected_options~1list/get](https://www.flowlu.com/api/\#tag/Selected-checkboxes-option/paths/~1customfields~1selected_options~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/customfields/selected\_options/list https://{company}.flowlu.com/api/v1/module/customfields/selected\_options/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "item_id": 0,\ \ "field_id": 0,\ \ "fieldoption_id": 0\ \ }\ \ ] } }` ## [tag/Company](https://www.flowlu.com/api/\#tag/Company) Company The module "Company" will help you track and record employees’ absence details. Flexible settings and custom types of absences will allow you to monitor each employee personally, so you won’t miss any detail. With a lifestream chart and list of current absences, you and your teammates will be able to check who’s off right now and when this person will get back to work, so you can manage your time and resources better. ## [tag/Employee-time-off](https://www.flowlu.com/api/\#tag/Employee-time-off) Employee time off Contains a list of time off ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [absence\_type](https://www.flowlu.com/api/#tag/Time%20off%20type) | My Team | Time off type | absence\_type\_id | ## [tag/Employee-time-off/paths/~1company~1absences~1create/post](https://www.flowlu.com/api/\#tag/Employee-time-off/paths/~1company~1absences~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | user\_id | integer
User's ID | | start\_date | string
Start date | | end\_date | string
End date | | original\_end\_date | string
End date excluding holidays | | absence\_type\_id | integer
Time off type ID | | comment | string
Comment | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/company/absences/create https://{company}.flowlu.com/api/v1/module/company/absences/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "user_id": 0, "start_date": "string", "end_date": "string", "original_end_date": "string", "absence_type_id": 0, "comment": "string", "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Employee-time-off/paths/~1company~1absences~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Employee-time-off/paths/~1company~1absences~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/company/absences/update/{id} https://{company}.flowlu.com/api/v1/module/company/absences/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "user_id": 0, "start_date": "string", "end_date": "string", "original_end_date": "string", "absence_type_id": 0, "comment": "string", "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Employee-time-off/paths/~1company~1absences~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Employee-time-off/paths/~1company~1absences~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/company/absences/delete/{id} https://{company}.flowlu.com/api/v1/module/company/absences/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Employee-time-off/paths/~1company~1absences~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Employee-time-off/paths/~1company~1absences~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/company/absences/get/{id} https://{company}.flowlu.com/api/v1/module/company/absences/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "user_id": 0, "start_date": "string", "end_date": "string", "original_end_date": "string", "absence_type_id": 0, "comment": "string", "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Employee-time-off/paths/~1company~1absences~1list/get](https://www.flowlu.com/api/\#tag/Employee-time-off/paths/~1company~1absences~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/company/absences/list https://{company}.flowlu.com/api/v1/module/company/absences/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "user_id": 0,\ \ "start_date": "string",\ \ "end_date": "string",\ \ "original_end_date": "string",\ \ "absence_type_id": 0,\ \ "comment": "string",\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Time-off-type](https://www.flowlu.com/api/\#tag/Time-off-type) Time off type Contains time off types ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [absences](https://www.flowlu.com/api/#tag/Employee%20time%20off) | My Team | Employee time off | absence\_type\_id | ## [tag/Time-off-type/paths/~1company~1absencetypes~1create/post](https://www.flowlu.com/api/\#tag/Time-off-type/paths/~1company~1absencetypes~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | title | string
Type name | | color | string
Type color | | default\_absence\_duration | integer
Default time off duration | | count\_holidays | boolean
Should holidays be taken into account | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/company/absencetypes/create https://{company}.flowlu.com/api/v1/module/company/absencetypes/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "title": "string", "color": "string", "default_absence_duration": 0, "count_holidays": true, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Time-off-type/paths/~1company~1absencetypes~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Time-off-type/paths/~1company~1absencetypes~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/company/absencetypes/update/{id} https://{company}.flowlu.com/api/v1/module/company/absencetypes/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "title": "string", "color": "string", "default_absence_duration": 0, "count_holidays": true, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Time-off-type/paths/~1company~1absencetypes~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Time-off-type/paths/~1company~1absencetypes~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/company/absencetypes/delete/{id} https://{company}.flowlu.com/api/v1/module/company/absencetypes/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Time-off-type/paths/~1company~1absencetypes~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Time-off-type/paths/~1company~1absencetypes~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/company/absencetypes/get/{id} https://{company}.flowlu.com/api/v1/module/company/absencetypes/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "title": "string", "color": "string", "default_absence_duration": 0, "count_holidays": true, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Time-off-type/paths/~1company~1absencetypes~1list/get](https://www.flowlu.com/api/\#tag/Time-off-type/paths/~1company~1absencetypes~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/company/absencetypes/list https://{company}.flowlu.com/api/v1/module/company/absencetypes/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "title": "string",\ \ "color": "string",\ \ "default_absence_duration": 0,\ \ "count_holidays": true,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Payables-and-Receivables](https://www.flowlu.com/api/\#tag/Payables-and-Receivables) Payables & Receivables ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | | [crm\_account](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | crm\_account\_id | | [business\_line](https://www.flowlu.com/api/#tag/Business%20line) | Finance | Business line | business\_line\_id | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | project\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [transaction\_pls\_relations](https://www.flowlu.com/api/#tag/Linking%20to%20the%20PLS%20transaction) | Payables & Receivables | Linking to the PLS transaction | apar\_id | | [transaction\_relations](https://www.flowlu.com/api/#tag/Linking%20to%20the%20transaction) | Payables & Receivables | Linking to the transaction | apar\_id | ## [tag/Payables-and-Receivables/paths/~1apar~1apar~1create/post](https://www.flowlu.com/api/\#tag/Payables-and-Receivables/paths/~1apar~1apar~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | org\_id | integer
Organization id | | project\_id | integer
Project id | | crm\_account\_id | integer
Account id | | date | string
Date | | accrual\_date | string
Accrual Date | | category\_id | integer
Category id Default- 0 | | type | integer
M.APAR.CONFIG.TYPE.DESC | | business\_line\_id | integer
business line ID | | vat | number
M.APAR.CONFIG.ASSET.VAT.DESC | | amount | number
Sum | | net\_amount | number
M.APAR.CONFIG.NET\_AMOUNT.DESC | | vat\_amount | number
M.APAR.CONFIG.VAT\_AMOUNT.DESC | | vat\_amount\_bcy | bcy\_price
VAT amount in application base currency. System field, value is set automatically | | amount\_bcy | bcy\_price
M.APAR.CONFIG.AMOUNT\_BCY.DESC | | net\_amount\_bcy | bcy\_price
M.APAR.CONFIG.NET\_AMOUNT.DESC | | paid\_amount | number
Payment | | paid\_amount\_bcy | bcy\_price
M.APAR.CONFIG.PAID\_AMOUNT\_BCY.DESC | | currency\_id | integer | | manager\_id | integer
Responsible person ID (only for Individual account type) | | status | enum | | description | string
Description | | created\_by | integer
User id | | updated\_by | integer
User id | | created\_date | string
Created date | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/apar/apar/create https://{company}.flowlu.com/api/v1/module/apar/apar/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "org_id": 0, "project_id": 0, "crm_account_id": 0, "date": "string", "accrual_date": "string", "category_id": 0, "type": 0, "business_line_id": 0, "vat": 0, "amount": 0, "net_amount": 0, "vat_amount": 0, "vat_amount_bcy": null, "amount_bcy": null, "net_amount_bcy": null, "paid_amount": 0, "paid_amount_bcy": null, "currency_id": 0, "manager_id": 0, "status": null, "description": "string", "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Payables-and-Receivables/paths/~1apar~1apar~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Payables-and-Receivables/paths/~1apar~1apar~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/apar/apar/update/{id} https://{company}.flowlu.com/api/v1/module/apar/apar/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "org_id": 0, "project_id": 0, "crm_account_id": 0, "date": "string", "accrual_date": "string", "category_id": 0, "type": 0, "business_line_id": 0, "vat": 0, "amount": 0, "net_amount": 0, "vat_amount": 0, "vat_amount_bcy": null, "amount_bcy": null, "net_amount_bcy": null, "paid_amount": 0, "paid_amount_bcy": null, "currency_id": 0, "manager_id": 0, "status": null, "description": "string", "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Payables-and-Receivables/paths/~1apar~1apar~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Payables-and-Receivables/paths/~1apar~1apar~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/apar/apar/delete/{id} https://{company}.flowlu.com/api/v1/module/apar/apar/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Payables-and-Receivables/paths/~1apar~1apar~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Payables-and-Receivables/paths/~1apar~1apar~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/apar/apar/get/{id} https://{company}.flowlu.com/api/v1/module/apar/apar/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "org_id": 0, "project_id": 0, "crm_account_id": 0, "date": "string", "accrual_date": "string", "category_id": 0, "type": 0, "business_line_id": 0, "vat": 0, "amount": 0, "net_amount": 0, "vat_amount": 0, "vat_amount_bcy": null, "amount_bcy": null, "net_amount_bcy": null, "paid_amount": 0, "paid_amount_bcy": null, "currency_id": 0, "manager_id": 0, "status": null, "description": "string", "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Payables-and-Receivables/paths/~1apar~1apar~1list/get](https://www.flowlu.com/api/\#tag/Payables-and-Receivables/paths/~1apar~1apar~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/apar/apar/list https://{company}.flowlu.com/api/v1/module/apar/apar/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "org_id": 0,\ \ "project_id": 0,\ \ "crm_account_id": 0,\ \ "date": "string",\ \ "accrual_date": "string",\ \ "category_id": 0,\ \ "type": 0,\ \ "business_line_id": 0,\ \ "vat": 0,\ \ "amount": 0,\ \ "net_amount": 0,\ \ "vat_amount": 0,\ \ "vat_amount_bcy": null,\ \ "amount_bcy": null,\ \ "net_amount_bcy": null,\ \ "paid_amount": 0,\ \ "paid_amount_bcy": null,\ \ "currency_id": 0,\ \ "manager_id": 0,\ \ "status": null,\ \ "description": "string",\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "created_date": "string",\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Linking-to-the-transaction](https://www.flowlu.com/api/\#tag/Linking-to-the-transaction) Linking to the transaction ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [apar](https://www.flowlu.com/api/#tag/Payables%20&%20Receivables) | Payables & Receivables | Payables & Receivables | apar\_id | | [transactions](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | transaction\_id | ## [tag/Linking-to-the-transaction/paths/~1apar~1transaction_relation~1create/post](https://www.flowlu.com/api/\#tag/Linking-to-the-transaction/paths/~1apar~1transaction_relation~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | transaction\_id | integer
Linked transaction ID | | apar\_id | integer
Apar ID | | apar\_amount | number
Entry id | | created\_date | string
Created date | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/apar/transaction\_relation/create https://{company}.flowlu.com/api/v1/module/apar/transaction\_relation/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "apar_id": 0, "apar_amount": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Linking-to-the-transaction/paths/~1apar~1transaction_relation~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Linking-to-the-transaction/paths/~1apar~1transaction_relation~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/apar/transaction\_relation/update/{id} https://{company}.flowlu.com/api/v1/module/apar/transaction\_relation/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "apar_id": 0, "apar_amount": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Linking-to-the-transaction/paths/~1apar~1transaction_relation~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Linking-to-the-transaction/paths/~1apar~1transaction_relation~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/apar/transaction\_relation/delete/{id} https://{company}.flowlu.com/api/v1/module/apar/transaction\_relation/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Linking-to-the-transaction/paths/~1apar~1transaction_relation~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Linking-to-the-transaction/paths/~1apar~1transaction_relation~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/apar/transaction\_relation/get/{id} https://{company}.flowlu.com/api/v1/module/apar/transaction\_relation/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "apar_id": 0, "apar_amount": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Linking-to-the-transaction/paths/~1apar~1transaction_relation~1list/get](https://www.flowlu.com/api/\#tag/Linking-to-the-transaction/paths/~1apar~1transaction_relation~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/apar/transaction\_relation/list https://{company}.flowlu.com/api/v1/module/apar/transaction\_relation/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "transaction_id": 0,\ \ "apar_id": 0,\ \ "apar_amount": 0,\ \ "created_date": "string",\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Linking-to-the-PLS-transaction](https://www.flowlu.com/api/\#tag/Linking-to-the-PLS-transaction) Linking to the PLS transaction ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [apar](https://www.flowlu.com/api/#tag/Payables%20&%20Receivables) | Payables & Receivables | Payables & Receivables | apar\_id | | [transactions\_pls](https://www.flowlu.com/api/#tag/Transactions%20for%20the%20Profit%20and%20Loss%20statement) | Finance | Transactions for the Profit and Loss statement | transaction\_id | ## [tag/Linking-to-the-PLS-transaction/paths/~1apar~1transaction_pls_relation~1create/post](https://www.flowlu.com/api/\#tag/Linking-to-the-PLS-transaction/paths/~1apar~1transaction_pls_relation~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully create an item post/apar/transaction\_pls\_relation/create https://{company}.flowlu.com/api/v1/module/apar/transaction\_pls\_relation/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "apar_id": 0, "apar_amount": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Linking-to-the-PLS-transaction/paths/~1apar~1transaction_pls_relation~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Linking-to-the-PLS-transaction/paths/~1apar~1transaction_pls_relation~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/apar/transaction\_pls\_relation/update/{id} https://{company}.flowlu.com/api/v1/module/apar/transaction\_pls\_relation/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "apar_id": 0, "apar_amount": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Linking-to-the-PLS-transaction/paths/~1apar~1transaction_pls_relation~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Linking-to-the-PLS-transaction/paths/~1apar~1transaction_pls_relation~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/apar/transaction\_pls\_relation/delete/{id} https://{company}.flowlu.com/api/v1/module/apar/transaction\_pls\_relation/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Linking-to-the-PLS-transaction/paths/~1apar~1transaction_pls_relation~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Linking-to-the-PLS-transaction/paths/~1apar~1transaction_pls_relation~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/apar/transaction\_pls\_relation/get/{id} https://{company}.flowlu.com/api/v1/module/apar/transaction\_pls\_relation/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "apar_id": 0, "apar_amount": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Linking-to-the-PLS-transaction/paths/~1apar~1transaction_pls_relation~1list/get](https://www.flowlu.com/api/\#tag/Linking-to-the-PLS-transaction/paths/~1apar~1transaction_pls_relation~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/apar/transaction\_pls\_relation/list https://{company}.flowlu.com/api/v1/module/apar/transaction\_pls\_relation/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "transaction_id": 0,\ \ "apar_id": 0,\ \ "apar_amount": 0,\ \ "created_date": "string",\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Borrowed-Loans](https://www.flowlu.com/api/\#tag/Borrowed-Loans) Borrowed Loans ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | | [business\_line](https://www.flowlu.com/api/#tag/Business%20line) | Finance | Business line | business\_line\_id | | [crm\_account](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | crm\_account\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [transaction\_relations](https://www.flowlu.com/api/#tag/Linking%20credit%20to%20transaction) | Borrowed Loans | Linking credit to transaction | loan\_id | | [transaction\_pls\_relations](https://www.flowlu.com/api/#tag/Linking%20credit%20to%20P&L%20transaction) | Borrowed Loans | Linking credit to P&L transaction | loan\_id | ## [tag/Borrowed-Loans/paths/~1loans~1loan~1create/post](https://www.flowlu.com/api/\#tag/Borrowed-Loans/paths/~1loans~1loan~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | issue\_date | string
(Required field) Loan/borrowing issuance date | | name | string
(Required field) Loan/borrowing name | | business\_line\_id | integer
Business line ID | | description | string
Description | | type | enum
(Required field) Type:
loan - loan
borrowing - borrowing | | repayment\_term | enum
(Required field) Repayment period:
short - short-term
long - long-term | | crm\_account\_id | integer
(Required field) Crm account ID | | amount | number
(Required field) Borrowing amount | | currency\_id | integer
(Required field) Currency ID | | bcy\_amount | bcy\_price
Amount in account base currency | | currency\_exchange\_rate | rate
Currency exchange rate | | org\_id | integer
(Required field) Organization ID | | repayment\_date | string
(Required field) Repayment date | | monthly\_payment\_day | integer
(Required field) Monthly payment day: enter a number from 1 to 31 for a specific day of the month, or -1 if the payment is made on the last day of the month. | | periodic\_payment\_amount | number
(Required field) Monthly payment amount, including annual interest | | rate | number
(Required field) Rate | | manager\_id | integer
Assigned user id | | active | boolean
If = 0, Inactive.
Default value = 1. | | created\_at | string
Created date | | created\_by | integer
User id | | updated\_at | string
Updated date | | updated\_by | integer
User id | ### Responses **200** Successfully create an item post/loans/loan/create https://{company}.flowlu.com/api/v1/module/loans/loan/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "issue_date": "string", "name": "string", "business_line_id": 0, "description": "string", "type": null, "repayment_term": null, "crm_account_id": 0, "amount": 0, "currency_id": 0, "bcy_amount": null, "currency_exchange_rate": null, "org_id": 0, "repayment_date": "string", "monthly_payment_day": 0, "periodic_payment_amount": 0, "rate": 0, "manager_id": 0, "active": true, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Borrowed-Loans/paths/~1loans~1loan~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Borrowed-Loans/paths/~1loans~1loan~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/loans/loan/update/{id} https://{company}.flowlu.com/api/v1/module/loans/loan/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "issue_date": "string", "name": "string", "business_line_id": 0, "description": "string", "type": null, "repayment_term": null, "crm_account_id": 0, "amount": 0, "currency_id": 0, "bcy_amount": null, "currency_exchange_rate": null, "org_id": 0, "repayment_date": "string", "monthly_payment_day": 0, "periodic_payment_amount": 0, "rate": 0, "manager_id": 0, "active": true, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Borrowed-Loans/paths/~1loans~1loan~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Borrowed-Loans/paths/~1loans~1loan~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/loans/loan/delete/{id} https://{company}.flowlu.com/api/v1/module/loans/loan/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Borrowed-Loans/paths/~1loans~1loan~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Borrowed-Loans/paths/~1loans~1loan~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/loans/loan/get/{id} https://{company}.flowlu.com/api/v1/module/loans/loan/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "issue_date": "string", "name": "string", "business_line_id": 0, "description": "string", "type": null, "repayment_term": null, "crm_account_id": 0, "amount": 0, "currency_id": 0, "bcy_amount": null, "currency_exchange_rate": null, "org_id": 0, "repayment_date": "string", "monthly_payment_day": 0, "periodic_payment_amount": 0, "rate": 0, "manager_id": 0, "active": true, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Borrowed-Loans/paths/~1loans~1loan~1list/get](https://www.flowlu.com/api/\#tag/Borrowed-Loans/paths/~1loans~1loan~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/loans/loan/list https://{company}.flowlu.com/api/v1/module/loans/loan/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "issue_date": "string",\ \ "name": "string",\ \ "business_line_id": 0,\ \ "description": "string",\ \ "type": null,\ \ "repayment_term": null,\ \ "crm_account_id": 0,\ \ "amount": 0,\ \ "currency_id": 0,\ \ "bcy_amount": null,\ \ "currency_exchange_rate": null,\ \ "org_id": 0,\ \ "repayment_date": "string",\ \ "monthly_payment_day": 0,\ \ "periodic_payment_amount": 0,\ \ "rate": 0,\ \ "manager_id": 0,\ \ "active": true,\ \ "created_at": "string",\ \ "created_by": 0,\ \ "updated_at": "string",\ \ "updated_by": 0\ \ }\ \ ] } }` ## [tag/Linking-credit-to-transaction](https://www.flowlu.com/api/\#tag/Linking-credit-to-transaction) Linking credit to transaction ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [loan](https://www.flowlu.com/api/#tag/Borrowed%20Loans) | Borrowed Loans | Borrowed Loans | loan\_id | | [transactions](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | transaction\_id | ## [tag/Linking-credit-to-transaction/paths/~1loans~1transaction_relation~1create/post](https://www.flowlu.com/api/\#tag/Linking-credit-to-transaction/paths/~1loans~1transaction_relation~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | transaction\_id | integer
Linked transaction ID | | loan\_id | integer
Loan ID | | created\_date | string
Created date | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/loans/transaction\_relation/create https://{company}.flowlu.com/api/v1/module/loans/transaction\_relation/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "loan_id": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Linking-credit-to-transaction/paths/~1loans~1transaction_relation~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Linking-credit-to-transaction/paths/~1loans~1transaction_relation~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/loans/transaction\_relation/update/{id} https://{company}.flowlu.com/api/v1/module/loans/transaction\_relation/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "loan_id": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Linking-credit-to-transaction/paths/~1loans~1transaction_relation~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Linking-credit-to-transaction/paths/~1loans~1transaction_relation~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/loans/transaction\_relation/delete/{id} https://{company}.flowlu.com/api/v1/module/loans/transaction\_relation/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Linking-credit-to-transaction/paths/~1loans~1transaction_relation~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Linking-credit-to-transaction/paths/~1loans~1transaction_relation~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/loans/transaction\_relation/get/{id} https://{company}.flowlu.com/api/v1/module/loans/transaction\_relation/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "loan_id": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Linking-credit-to-transaction/paths/~1loans~1transaction_relation~1list/get](https://www.flowlu.com/api/\#tag/Linking-credit-to-transaction/paths/~1loans~1transaction_relation~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/loans/transaction\_relation/list https://{company}.flowlu.com/api/v1/module/loans/transaction\_relation/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "transaction_id": 0,\ \ "loan_id": 0,\ \ "created_date": "string",\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Linking-credit-to-PandL-transaction](https://www.flowlu.com/api/\#tag/Linking-credit-to-PandL-transaction) Linking credit to P&L transaction ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [loan](https://www.flowlu.com/api/#tag/Borrowed%20Loans) | Borrowed Loans | Borrowed Loans | loan\_id | | [transactions\_pls](https://www.flowlu.com/api/#tag/Transactions%20for%20the%20Profit%20and%20Loss%20statement) | Finance | Transactions for the Profit and Loss statement | transaction\_id | ## [tag/Linking-credit-to-PandL-transaction/paths/~1loans~1transaction_pls_relation~1create/post](https://www.flowlu.com/api/\#tag/Linking-credit-to-PandL-transaction/paths/~1loans~1transaction_pls_relation~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully create an item post/loans/transaction\_pls\_relation/create https://{company}.flowlu.com/api/v1/module/loans/transaction\_pls\_relation/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "loan_id": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Linking-credit-to-PandL-transaction/paths/~1loans~1transaction_pls_relation~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Linking-credit-to-PandL-transaction/paths/~1loans~1transaction_pls_relation~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/loans/transaction\_pls\_relation/update/{id} https://{company}.flowlu.com/api/v1/module/loans/transaction\_pls\_relation/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "loan_id": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Linking-credit-to-PandL-transaction/paths/~1loans~1transaction_pls_relation~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Linking-credit-to-PandL-transaction/paths/~1loans~1transaction_pls_relation~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/loans/transaction\_pls\_relation/delete/{id} https://{company}.flowlu.com/api/v1/module/loans/transaction\_pls\_relation/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Linking-credit-to-PandL-transaction/paths/~1loans~1transaction_pls_relation~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Linking-credit-to-PandL-transaction/paths/~1loans~1transaction_pls_relation~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/loans/transaction\_pls\_relation/get/{id} https://{company}.flowlu.com/api/v1/module/loans/transaction\_pls\_relation/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "loan_id": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Linking-credit-to-PandL-transaction/paths/~1loans~1transaction_pls_relation~1list/get](https://www.flowlu.com/api/\#tag/Linking-credit-to-PandL-transaction/paths/~1loans~1transaction_pls_relation~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/loans/transaction\_pls\_relation/list https://{company}.flowlu.com/api/v1/module/loans/transaction\_pls\_relation/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "transaction_id": 0,\ \ "loan_id": 0,\ \ "created_date": "string",\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Fixed-Asset](https://www.flowlu.com/api/\#tag/Fixed-Asset) Fixed Asset ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | | [org\_account](https://www.flowlu.com/api/#tag/Bank%20account) | Finance | Bank account | org\_account\_id | | [crm\_account](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | crm\_account\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [transaction\_relations](https://www.flowlu.com/api/#tag/Asset%20transaction%20link) | Fixed Assets | Asset transaction link | asset\_id | | [transaction\_pls\_relations](https://www.flowlu.com/api/#tag/Asset%20P&L%20transaction%20link) | Fixed Assets | Asset P&L transaction link | asset\_id | | [documents](https://www.flowlu.com/api/#tag/Documents) | Fixed Assets | Documents | asset\_id | ## [tag/Fixed-Asset/paths/~1asset~1asset~1create/post](https://www.flowlu.com/api/\#tag/Fixed-Asset/paths/~1asset~1asset~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Asset name. Required field | | type | enum
Asset type. Required field.
material - Tangible fixed asset
intangible - intangible asset | | org\_id | integer
Organization ID. Required field | | currency\_id | integer
Currency ID. Required field | | org\_account\_id | integer
Organization account ID. Required field | | amount | number
Asset cost with VAT. Required field | | amount\_bcy | bcy\_price
Asset cost with VAT in application base currency. System field, value is set automatically | | vat | number
VAT rate. Required field | | vat\_amount | number
VAT amount. Required field | | vat\_amount\_bcy | bcy\_price
VAT amount in application base currency. System field, value is set automatically | | depreciation\_amount | number
Depreciable amount without VAT. Required field | | depreciation\_amount\_bcy | bcy\_price
Depreciable amount with VAT in application base currency. System field, value is set automatically | | acquisition\_date | string
Asset acquisition date | | start\_date\_pls | string
Depreciation start month (Y-m-01). Required field | | pre\_exist | boolean
Set if asset was purchased previously (Equipment amount owed will not be included in accounts payable) | | active | boolean
If = 0, Inactive.
Default value = 1. | | period\_amount | number
Monthly payment amount. Required field | | period\_amount\_bcy | bcy\_price
Monthly payment amount in application base currency. System field, value is set automatically | | period | integer
Depreciation period (months). Required field | | description | string
Description | | manager\_id | integer
Assigned user id | | crm\_account\_id | integer
Account id | | created\_at | string
Created date | | created\_by | integer
User id | | updated\_at | string
Updated date | | updated\_by | integer
User id | ### Responses **200** Successfully create an item post/asset/asset/create https://{company}.flowlu.com/api/v1/module/asset/asset/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "type": null, "org_id": 0, "currency_id": 0, "org_account_id": 0, "amount": 0, "amount_bcy": null, "vat": 0, "vat_amount": 0, "vat_amount_bcy": null, "depreciation_amount": 0, "depreciation_amount_bcy": null, "acquisition_date": "string", "start_date_pls": "string", "pre_exist": true, "active": true, "period_amount": 0, "period_amount_bcy": null, "period": 0, "description": "string", "manager_id": 0, "crm_account_id": 0, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Fixed-Asset/paths/~1asset~1asset~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Fixed-Asset/paths/~1asset~1asset~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/asset/asset/update/{id} https://{company}.flowlu.com/api/v1/module/asset/asset/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "type": null, "org_id": 0, "currency_id": 0, "org_account_id": 0, "amount": 0, "amount_bcy": null, "vat": 0, "vat_amount": 0, "vat_amount_bcy": null, "depreciation_amount": 0, "depreciation_amount_bcy": null, "acquisition_date": "string", "start_date_pls": "string", "pre_exist": true, "active": true, "period_amount": 0, "period_amount_bcy": null, "period": 0, "description": "string", "manager_id": 0, "crm_account_id": 0, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Fixed-Asset/paths/~1asset~1asset~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Fixed-Asset/paths/~1asset~1asset~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/asset/asset/delete/{id} https://{company}.flowlu.com/api/v1/module/asset/asset/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Fixed-Asset/paths/~1asset~1asset~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Fixed-Asset/paths/~1asset~1asset~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/asset/asset/get/{id} https://{company}.flowlu.com/api/v1/module/asset/asset/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "type": null, "org_id": 0, "currency_id": 0, "org_account_id": 0, "amount": 0, "amount_bcy": null, "vat": 0, "vat_amount": 0, "vat_amount_bcy": null, "depreciation_amount": 0, "depreciation_amount_bcy": null, "acquisition_date": "string", "start_date_pls": "string", "pre_exist": true, "active": true, "period_amount": 0, "period_amount_bcy": null, "period": 0, "description": "string", "manager_id": 0, "crm_account_id": 0, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Fixed-Asset/paths/~1asset~1asset~1list/get](https://www.flowlu.com/api/\#tag/Fixed-Asset/paths/~1asset~1asset~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/asset/asset/list https://{company}.flowlu.com/api/v1/module/asset/asset/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "type": null,\ \ "org_id": 0,\ \ "currency_id": 0,\ \ "org_account_id": 0,\ \ "amount": 0,\ \ "amount_bcy": null,\ \ "vat": 0,\ \ "vat_amount": 0,\ \ "vat_amount_bcy": null,\ \ "depreciation_amount": 0,\ \ "depreciation_amount_bcy": null,\ \ "acquisition_date": "string",\ \ "start_date_pls": "string",\ \ "pre_exist": true,\ \ "active": true,\ \ "period_amount": 0,\ \ "period_amount_bcy": null,\ \ "period": 0,\ \ "description": "string",\ \ "manager_id": 0,\ \ "crm_account_id": 0,\ \ "created_at": "string",\ \ "created_by": 0,\ \ "updated_at": "string",\ \ "updated_by": 0\ \ }\ \ ] } }` ## [tag/Allocation-by-business-lines](https://www.flowlu.com/api/\#tag/Allocation-by-business-lines) Allocation by business lines ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [business\_line](https://www.flowlu.com/api/#tag/Business%20line) | Finance | Business line | business\_line\_id | | [asset](https://www.flowlu.com/api/#tag/Fixed%20Asset) | Fixed Assets | Fixed Asset | asset\_id | ## [tag/Allocation-by-business-lines/paths/~1asset~1business_line_allocation~1create/post](https://www.flowlu.com/api/\#tag/Allocation-by-business-lines/paths/~1asset~1business_line_allocation~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | business\_line\_id | integer
business line ID | | percent | number
Allocation percentage. Required field | | asset\_id | integer
Asset ID. Required field | | group\_id | integer
Allocation group ID. Required field | | created\_at | string
Created date | | created\_by | integer
User id | | updated\_at | string
Updated date | | updated\_by | integer
User id | ### Responses **200** Successfully create an item post/asset/business\_line\_allocation/create https://{company}.flowlu.com/api/v1/module/asset/business\_line\_allocation/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "business_line_id": 0, "percent": 0, "asset_id": 0, "group_id": 0, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Allocation-by-business-lines/paths/~1asset~1business_line_allocation~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Allocation-by-business-lines/paths/~1asset~1business_line_allocation~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/asset/business\_line\_allocation/update/{id} https://{company}.flowlu.com/api/v1/module/asset/business\_line\_allocation/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "business_line_id": 0, "percent": 0, "asset_id": 0, "group_id": 0, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Allocation-by-business-lines/paths/~1asset~1business_line_allocation~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Allocation-by-business-lines/paths/~1asset~1business_line_allocation~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/asset/business\_line\_allocation/delete/{id} https://{company}.flowlu.com/api/v1/module/asset/business\_line\_allocation/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Allocation-by-business-lines/paths/~1asset~1business_line_allocation~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Allocation-by-business-lines/paths/~1asset~1business_line_allocation~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/asset/business\_line\_allocation/get/{id} https://{company}.flowlu.com/api/v1/module/asset/business\_line\_allocation/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "business_line_id": 0, "percent": 0, "asset_id": 0, "group_id": 0, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Allocation-by-business-lines/paths/~1asset~1business_line_allocation~1list/get](https://www.flowlu.com/api/\#tag/Allocation-by-business-lines/paths/~1asset~1business_line_allocation~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/asset/business\_line\_allocation/list https://{company}.flowlu.com/api/v1/module/asset/business\_line\_allocation/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "business_line_id": 0,\ \ "percent": 0,\ \ "asset_id": 0,\ \ "group_id": 0,\ \ "created_at": "string",\ \ "created_by": 0,\ \ "updated_at": "string",\ \ "updated_by": 0\ \ }\ \ ] } }` ## [tag/Asset-transaction-link](https://www.flowlu.com/api/\#tag/Asset-transaction-link) Asset transaction link ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [asset](https://www.flowlu.com/api/#tag/Fixed%20Asset) | Fixed Assets | Fixed Asset | asset\_id | | [transactions](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | transaction\_id | ## [tag/Asset-transaction-link/paths/~1asset~1transaction_relation~1create/post](https://www.flowlu.com/api/\#tag/Asset-transaction-link/paths/~1asset~1transaction_relation~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | transaction\_id | integer
Transaction ID. Required field | | asset\_id | integer
Asset ID. Required field | | asset\_amount | number
Total | | created\_date | string
Created date | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/asset/transaction\_relation/create https://{company}.flowlu.com/api/v1/module/asset/transaction\_relation/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "asset_id": 0, "asset_amount": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Asset-transaction-link/paths/~1asset~1transaction_relation~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Asset-transaction-link/paths/~1asset~1transaction_relation~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/asset/transaction\_relation/update/{id} https://{company}.flowlu.com/api/v1/module/asset/transaction\_relation/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "asset_id": 0, "asset_amount": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Asset-transaction-link/paths/~1asset~1transaction_relation~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Asset-transaction-link/paths/~1asset~1transaction_relation~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/asset/transaction\_relation/delete/{id} https://{company}.flowlu.com/api/v1/module/asset/transaction\_relation/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Asset-transaction-link/paths/~1asset~1transaction_relation~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Asset-transaction-link/paths/~1asset~1transaction_relation~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/asset/transaction\_relation/get/{id} https://{company}.flowlu.com/api/v1/module/asset/transaction\_relation/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "asset_id": 0, "asset_amount": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Asset-transaction-link/paths/~1asset~1transaction_relation~1list/get](https://www.flowlu.com/api/\#tag/Asset-transaction-link/paths/~1asset~1transaction_relation~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/asset/transaction\_relation/list https://{company}.flowlu.com/api/v1/module/asset/transaction\_relation/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "transaction_id": 0,\ \ "asset_id": 0,\ \ "asset_amount": 0,\ \ "created_date": "string",\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Asset-PandL-transaction-link](https://www.flowlu.com/api/\#tag/Asset-PandL-transaction-link) Asset P&L transaction link ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [asset](https://www.flowlu.com/api/#tag/Fixed%20Asset) | Fixed Assets | Fixed Asset | asset\_id | | [transactions\_pls](https://www.flowlu.com/api/#tag/Transactions%20for%20the%20Profit%20and%20Loss%20statement) | Finance | Transactions for the Profit and Loss statement | transaction\_id | ## [tag/Asset-PandL-transaction-link/paths/~1asset~1transaction_pls_relation~1create/post](https://www.flowlu.com/api/\#tag/Asset-PandL-transaction-link/paths/~1asset~1transaction_pls_relation~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully create an item post/asset/transaction\_pls\_relation/create https://{company}.flowlu.com/api/v1/module/asset/transaction\_pls\_relation/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "asset_id": 0, "asset_amount": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Asset-PandL-transaction-link/paths/~1asset~1transaction_pls_relation~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Asset-PandL-transaction-link/paths/~1asset~1transaction_pls_relation~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/asset/transaction\_pls\_relation/update/{id} https://{company}.flowlu.com/api/v1/module/asset/transaction\_pls\_relation/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "asset_id": 0, "asset_amount": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Asset-PandL-transaction-link/paths/~1asset~1transaction_pls_relation~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Asset-PandL-transaction-link/paths/~1asset~1transaction_pls_relation~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/asset/transaction\_pls\_relation/delete/{id} https://{company}.flowlu.com/api/v1/module/asset/transaction\_pls\_relation/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Asset-PandL-transaction-link/paths/~1asset~1transaction_pls_relation~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Asset-PandL-transaction-link/paths/~1asset~1transaction_pls_relation~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/asset/transaction\_pls\_relation/get/{id} https://{company}.flowlu.com/api/v1/module/asset/transaction\_pls\_relation/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "transaction_id": 0, "asset_id": 0, "asset_amount": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Asset-PandL-transaction-link/paths/~1asset~1transaction_pls_relation~1list/get](https://www.flowlu.com/api/\#tag/Asset-PandL-transaction-link/paths/~1asset~1transaction_pls_relation~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/asset/transaction\_pls\_relation/list https://{company}.flowlu.com/api/v1/module/asset/transaction\_pls\_relation/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "transaction_id": 0,\ \ "asset_id": 0,\ \ "asset_amount": 0,\ \ "created_date": "string",\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Business-line-allocation-groups](https://www.flowlu.com/api/\#tag/Business-line-allocation-groups) Business line allocation groups ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [asset](https://www.flowlu.com/api/#tag/Fixed%20Asset) | Fixed Assets | Fixed Asset | asset\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [allocations](https://www.flowlu.com/api/#tag/Allocation%20by%20business%20lines) | Fixed Assets | Allocation by business lines | group\_id | ## [tag/Business-line-allocation-groups/paths/~1asset~1business_line_allocation_group~1create/post](https://www.flowlu.com/api/\#tag/Business-line-allocation-groups/paths/~1asset~1business_line_allocation_group~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | date | string
Allocation start month (Y-m-01). Required field | | asset\_id | integer
Asset ID. Required field | | created\_at | string
Created date | | created\_by | integer
User id | | updated\_at | string
Updated date | | updated\_by | integer
User id | ### Responses **200** Successfully create an item post/asset/business\_line\_allocation\_group/create https://{company}.flowlu.com/api/v1/module/asset/business\_line\_allocation\_group/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "date": "string", "asset_id": 0, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Business-line-allocation-groups/paths/~1asset~1business_line_allocation_group~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Business-line-allocation-groups/paths/~1asset~1business_line_allocation_group~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/asset/business\_line\_allocation\_group/update/{id} https://{company}.flowlu.com/api/v1/module/asset/business\_line\_allocation\_group/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "date": "string", "asset_id": 0, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Business-line-allocation-groups/paths/~1asset~1business_line_allocation_group~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Business-line-allocation-groups/paths/~1asset~1business_line_allocation_group~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/asset/business\_line\_allocation\_group/delete/{id} https://{company}.flowlu.com/api/v1/module/asset/business\_line\_allocation\_group/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Business-line-allocation-groups/paths/~1asset~1business_line_allocation_group~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Business-line-allocation-groups/paths/~1asset~1business_line_allocation_group~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/asset/business\_line\_allocation\_group/get/{id} https://{company}.flowlu.com/api/v1/module/asset/business\_line\_allocation\_group/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "date": "string", "asset_id": 0, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Business-line-allocation-groups/paths/~1asset~1business_line_allocation_group~1list/get](https://www.flowlu.com/api/\#tag/Business-line-allocation-groups/paths/~1asset~1business_line_allocation_group~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/asset/business\_line\_allocation\_group/list https://{company}.flowlu.com/api/v1/module/asset/business\_line\_allocation\_group/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "date": "string",\ \ "asset_id": 0,\ \ "created_at": "string",\ \ "created_by": 0,\ \ "updated_at": "string",\ \ "updated_by": 0\ \ }\ \ ] } }` ## [tag/Documents](https://www.flowlu.com/api/\#tag/Documents) Documents ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | | [org\_account](https://www.flowlu.com/api/#tag/Bank%20account) | Finance | Bank account | org\_account\_id | | [business\_line](https://www.flowlu.com/api/#tag/Business%20line) | Finance | Business line | business\_line\_id | | [crm\_account](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | crm\_account\_id | | [asset](https://www.flowlu.com/api/#tag/Fixed%20Asset) | Fixed Assets | Fixed Asset | asset\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [transactions\_pls](https://www.flowlu.com/api/#tag/Asset%20P&L%20transaction%20link) | Fixed Assets | Asset P&L transaction link | asset\_id | | [transactions](https://www.flowlu.com/api/#tag/Asset%20transaction%20link) | Fixed Assets | Asset transaction link | asset\_id | ## [tag/Documents/paths/~1asset~1document~1create/post](https://www.flowlu.com/api/\#tag/Documents/paths/~1asset~1document~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | asset\_id | integer
Asset ID. Required field | | type | enum
Document type. Required field.
realization - fixed asset realization
write\_off - write-off | | date | string
Document date. Required field | | amount | number
Document amount. Required field | | amount\_bcy | bcy\_price
Document amount in application base currency. System field, value is set automatically | | net\_book\_value | number
M.ASSET.CONFIG.DOCUMENT.NET\_BOOK\_VALUE.DESC | | net\_book\_value\_bcy | bcy\_price
M.ASSET.CONFIG.DOCUMENT.NET\_BOOK\_VALUE\_BCY.DESC | | org\_account\_id | integer
Organization account ID. Required field | | org\_id | integer
Organization ID. Required field | | currency\_id | integer
Currency ID. Required field | | business\_line\_id | integer
business line ID | | description | string
Description | | manager\_id | integer
Assigned user id | | crm\_account\_id | integer
Account id | | created\_at | string
Created date | | created\_by | integer
User id | | updated\_at | string
Updated date | | updated\_by | integer
User id | ### Responses **200** Successfully create an item post/asset/document/create https://{company}.flowlu.com/api/v1/module/asset/document/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "asset_id": 0, "type": null, "date": "string", "amount": 0, "amount_bcy": null, "net_book_value": 0, "net_book_value_bcy": null, "org_account_id": 0, "org_id": 0, "currency_id": 0, "business_line_id": 0, "description": "string", "manager_id": 0, "crm_account_id": 0, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Documents/paths/~1asset~1document~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Documents/paths/~1asset~1document~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/asset/document/update/{id} https://{company}.flowlu.com/api/v1/module/asset/document/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "asset_id": 0, "type": null, "date": "string", "amount": 0, "amount_bcy": null, "net_book_value": 0, "net_book_value_bcy": null, "org_account_id": 0, "org_id": 0, "currency_id": 0, "business_line_id": 0, "description": "string", "manager_id": 0, "crm_account_id": 0, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Documents/paths/~1asset~1document~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Documents/paths/~1asset~1document~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/asset/document/delete/{id} https://{company}.flowlu.com/api/v1/module/asset/document/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Documents/paths/~1asset~1document~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Documents/paths/~1asset~1document~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/asset/document/get/{id} https://{company}.flowlu.com/api/v1/module/asset/document/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "asset_id": 0, "type": null, "date": "string", "amount": 0, "amount_bcy": null, "net_book_value": 0, "net_book_value_bcy": null, "org_account_id": 0, "org_id": 0, "currency_id": 0, "business_line_id": 0, "description": "string", "manager_id": 0, "crm_account_id": 0, "created_at": "string", "created_by": 0, "updated_at": "string", "updated_by": 0 } }` ## [tag/Documents/paths/~1asset~1document~1list/get](https://www.flowlu.com/api/\#tag/Documents/paths/~1asset~1document~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/asset/document/list https://{company}.flowlu.com/api/v1/module/asset/document/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "asset_id": 0,\ \ "type": null,\ \ "date": "string",\ \ "amount": 0,\ \ "amount_bcy": null,\ \ "net_book_value": 0,\ \ "net_book_value_bcy": null,\ \ "org_account_id": 0,\ \ "org_id": 0,\ \ "currency_id": 0,\ \ "business_line_id": 0,\ \ "description": "string",\ \ "manager_id": 0,\ \ "crm_account_id": 0,\ \ "created_at": "string",\ \ "created_by": 0,\ \ "updated_at": "string",\ \ "updated_by": 0\ \ }\ \ ] } }` ## [tag/Task](https://www.flowlu.com/api/\#tag/Task) Task The Tasks, inspired by ‘Getting things done’ methodology, allow you to organize collaborative work, delegate tasks, monitor the work of your team and deadlines. This module brings together all the tasks that are related to you. These are personal or delegated tasks, tasks you follow, etc. ## [tag/Tasks](https://www.flowlu.com/api/\#tag/Tasks) Tasks The tasks for the "Tasks" module and events for the "Calendar" module are described here. ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [company](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | crm\_account\_id | | | [template](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | template\_id | | | [calendar](https://www.flowlu.com/api/#tag/Calendar) | Calendar | Calendar | event\_calendar\_id | | | [workflow](https://www.flowlu.com/api/#tag/Task%20Workflows) | Tasks | Task Workflows | workflow\_id | | | [workflow\_stage](https://www.flowlu.com/api/#tag/Workflow%20Statuses) | Tasks | Workflow Statuses | workflow\_stage\_id | | | [parent](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | parent\_id | | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | model\_id | module = st, model = project | | [project\_template](https://www.flowlu.com/api/#tag/Project%20Templates) | Projects | Project Templates | model\_id | module = st, model = type | | [lead](https://www.flowlu.com/api/#tag/Opportunities) | CRM | Opportunities | model\_id | module = crm, model = leads | | [project\_stage](https://www.flowlu.com/api/#tag/Project%20stages) | Projects | Project stages | project\_stage\_id | module = st, model = project | | [project\_stage\_checkitem](https://www.flowlu.com/api/#tag/Stage%20Checklist) | Projects | Stage Checklist | project\_checkitem\_id | module = st, model = project | #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [model\_collaborators](https://www.flowlu.com/api/#tag/Followers) | Tasks | Followers | task\_id | | | [model\_participants](https://www.flowlu.com/api/#tag/Collaborators) | Tasks | Collaborators | task\_id | | | [subtasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | parent\_id | | | [item\_relation](https://www.flowlu.com/api/#tag/Linking%20the%20invoice%20items) | Finance | Linking the invoice items | model\_id | module = task, model = task | ## [tag/Tasks/paths/~1task~1tasks~1create/post](https://www.flowlu.com/api/\#tag/Tasks/paths/~1task~1tasks~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | report | string
Task Report | | parent\_id | integer
Parent Task ID | | prev\_task\_id | integer
Previous Task ID | | deadline | string
End Date (task only) | | deadline\_allowchange | boolean
Allow to change end date (task only, default- 0):
0 - False
1 - True | | plan\_start\_date | string
Estimated start date | | plan\_end\_date | string
End date (events only) | | priority | integer
Task Priority | | task\_checkbyowner | boolean
The task has been reviewed by the owner. | | responsible\_id | integer
Assigned user id | | time\_estimate | integer
Estimated time | | time\_spent | integer
Time spent | | cost | number
Sum of planned consumption by task | | price | number
Amount of planned income by task | | cost\_type | string
Type of time calculation for the sum of planned consumption by task | | price\_type | string
Type of time calculation for the sum of planned consumption by task | | created\_date | string
Created date | | owner\_id | integer
User id | | updated\_date | string
Updated date | | updated\_by | integer
User id | | status\_firstviewdate | string
Opened Date | | status | integer
Status:
1 - New task
3 - Task in progress
4 - Pending approval by the owner
5 - Task completed | | start\_date | string
The date the user started executing the task (Status changed to "In Progress"). Sets automatically | | first\_closed\_date | string
First completed date. Sets automatically | | closed\_date | string
Completed date. Sets automatically | | closed\_by | integer
Closed by user id. Sets automatically | | return\_count | integer
Return count | | rating | integer
Rating | | status\_updated\_by | integer
The id of the user who updated the status. Sets automatically | | status\_updated\_date | string
Status updated date. Sets automatically | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | | module | string
Module | | model | string
Model | | model\_id | integer
Model id | | project\_stage\_id | integer
Project stage id (module = ''st" model="project"). [Project stages](https://www.flowlu.com/api/#tag/Project-stages) | | project\_checkitem\_id | integer
Project checklist id with which the task is linked (module = ''st" model="project") [Stage checklist](https://www.flowlu.com/api/#tag/Stage-milestone) | | type | integer
Task type:
0 - Task
1 - Inbox
20 - Event
30 - Task template | | report\_complete | string
Task report complete | | crm\_account\_id | integer
Account id | | ordering | number
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | all\_day | boolean
All day (event only):
1 - True
0 - False | | uuid | string
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer systems | | public\_template | integer
Template Access (type=30):
1 - Public template
0 - Private template | | template\_id | integer
Template id by which the task was created (task with type = 30) | | is\_repeat | boolean
Is repeat (Default- 0):
0 - No
1 - Yes | | is\_recurrence | boolean
Recurring Event (Default- 0) | | recurrence\_id | integer
ID of the recurrence rule | | recurrence\_parent\_id | integer
ID of the associated recurring event | | recurrence\_original\_start\_date | string
The start date of the specific instance within the recurring event | | event\_location | string
Event location | | event\_color | string
Color in HEX format | | event\_busy\_status | integer
Availability (event only):
10 - Free
20 - Busy | | event\_access\_type | integer
Event Privacy Settings:
10 - Default
20 - Personal
30 - Public | | event\_calendar\_id | integer
The id of the calendar to which the event is linked | | event\_type | integer
Event type:
21 - Call
22 - Email
23 - Appointment | | event\_etag | string
Google Etag | | event\_sync\_type | integer
Google sync | | archive\_status | integer
Archive status (Default- 0):
0 - Active
10 - Archive | | is\_hidden | boolean
A parameter that hides a template from the general list of templates. It is used for task templates in the checklist of the project template. | | workflow\_id | integer
Task Workflow | | workflow\_stage\_id | integer
Task Workflow Status | ### Responses **200** Successfully create an item post/task/tasks/create https://{company}.flowlu.com/api/v1/module/task/tasks/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "report": "string", "parent_id": 0, "prev_task_id": 0, "deadline": "string", "deadline_allowchange": true, "plan_start_date": "string", "plan_end_date": "string", "priority": 0, "task_checkbyowner": true, "responsible_id": 0, "time_estimate": 0, "time_spent": 0, "cost": 0, "price": 0, "cost_type": "string", "price_type": "string", "created_date": "string", "owner_id": 0, "updated_date": "string", "updated_by": 0, "status_firstviewdate": "string", "status": 0, "start_date": "string", "first_closed_date": "string", "closed_date": "string", "closed_by": 0, "return_count": 0, "rating": 0, "status_updated_by": 0, "status_updated_date": "string", "ref": "string", "ref_id": "string", "module": "string", "model": "string", "model_id": 0, "project_stage_id": 0, "project_checkitem_id": 0, "type": 0, "report_complete": "string", "crm_account_id": 0, "ordering": 0, "all_day": true, "uuid": "string", "public_template": 0, "template_id": 0, "is_repeat": true, "is_recurrence": true, "recurrence_id": 0, "recurrence_parent_id": 0, "recurrence_original_start_date": "string", "event_location": "string", "event_color": "string", "event_busy_status": 0, "event_access_type": 0, "event_calendar_id": 0, "event_type": 0, "event_etag": "string", "event_sync_type": 0, "archive_status": 0, "is_hidden": true, "workflow_id": 0, "workflow_stage_id": 0 } }` ## [tag/Tasks/paths/~1task~1tasks~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Tasks/paths/~1task~1tasks~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/task/tasks/update/{id} https://{company}.flowlu.com/api/v1/module/task/tasks/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "report": "string", "parent_id": 0, "prev_task_id": 0, "deadline": "string", "deadline_allowchange": true, "plan_start_date": "string", "plan_end_date": "string", "priority": 0, "task_checkbyowner": true, "responsible_id": 0, "time_estimate": 0, "time_spent": 0, "cost": 0, "price": 0, "cost_type": "string", "price_type": "string", "created_date": "string", "owner_id": 0, "updated_date": "string", "updated_by": 0, "status_firstviewdate": "string", "status": 0, "start_date": "string", "first_closed_date": "string", "closed_date": "string", "closed_by": 0, "return_count": 0, "rating": 0, "status_updated_by": 0, "status_updated_date": "string", "ref": "string", "ref_id": "string", "module": "string", "model": "string", "model_id": 0, "project_stage_id": 0, "project_checkitem_id": 0, "type": 0, "report_complete": "string", "crm_account_id": 0, "ordering": 0, "all_day": true, "uuid": "string", "public_template": 0, "template_id": 0, "is_repeat": true, "is_recurrence": true, "recurrence_id": 0, "recurrence_parent_id": 0, "recurrence_original_start_date": "string", "event_location": "string", "event_color": "string", "event_busy_status": 0, "event_access_type": 0, "event_calendar_id": 0, "event_type": 0, "event_etag": "string", "event_sync_type": 0, "archive_status": 0, "is_hidden": true, "workflow_id": 0, "workflow_stage_id": 0 } }` ## [tag/Tasks/paths/~1task~1tasks~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Tasks/paths/~1task~1tasks~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/task/tasks/delete/{id} https://{company}.flowlu.com/api/v1/module/task/tasks/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Tasks/paths/~1task~1tasks~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Tasks/paths/~1task~1tasks~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/task/tasks/get/{id} https://{company}.flowlu.com/api/v1/module/task/tasks/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "report": "string", "parent_id": 0, "prev_task_id": 0, "deadline": "string", "deadline_allowchange": true, "plan_start_date": "string", "plan_end_date": "string", "priority": 0, "task_checkbyowner": true, "responsible_id": 0, "time_estimate": 0, "time_spent": 0, "cost": 0, "price": 0, "cost_type": "string", "price_type": "string", "created_date": "string", "owner_id": 0, "updated_date": "string", "updated_by": 0, "status_firstviewdate": "string", "status": 0, "start_date": "string", "first_closed_date": "string", "closed_date": "string", "closed_by": 0, "return_count": 0, "rating": 0, "status_updated_by": 0, "status_updated_date": "string", "ref": "string", "ref_id": "string", "module": "string", "model": "string", "model_id": 0, "project_stage_id": 0, "project_checkitem_id": 0, "type": 0, "report_complete": "string", "crm_account_id": 0, "ordering": 0, "all_day": true, "uuid": "string", "public_template": 0, "template_id": 0, "is_repeat": true, "is_recurrence": true, "recurrence_id": 0, "recurrence_parent_id": 0, "recurrence_original_start_date": "string", "event_location": "string", "event_color": "string", "event_busy_status": 0, "event_access_type": 0, "event_calendar_id": 0, "event_type": 0, "event_etag": "string", "event_sync_type": 0, "archive_status": 0, "is_hidden": true, "workflow_id": 0, "workflow_stage_id": 0 } }` ## [tag/Tasks/paths/~1task~1tasks~1list/get](https://www.flowlu.com/api/\#tag/Tasks/paths/~1task~1tasks~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/task/tasks/list https://{company}.flowlu.com/api/v1/module/task/tasks/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "report": "string",\ \ "parent_id": 0,\ \ "prev_task_id": 0,\ \ "deadline": "string",\ \ "deadline_allowchange": true,\ \ "plan_start_date": "string",\ \ "plan_end_date": "string",\ \ "priority": 0,\ \ "task_checkbyowner": true,\ \ "responsible_id": 0,\ \ "time_estimate": 0,\ \ "time_spent": 0,\ \ "cost": 0,\ \ "price": 0,\ \ "cost_type": "string",\ \ "price_type": "string",\ \ "created_date": "string",\ \ "owner_id": 0,\ \ "updated_date": "string",\ \ "updated_by": 0,\ \ "status_firstviewdate": "string",\ \ "status": 0,\ \ "start_date": "string",\ \ "first_closed_date": "string",\ \ "closed_date": "string",\ \ "closed_by": 0,\ \ "return_count": 0,\ \ "rating": 0,\ \ "status_updated_by": 0,\ \ "status_updated_date": "string",\ \ "ref": "string",\ \ "ref_id": "string",\ \ "module": "string",\ \ "model": "string",\ \ "model_id": 0,\ \ "project_stage_id": 0,\ \ "project_checkitem_id": 0,\ \ "type": 0,\ \ "report_complete": "string",\ \ "crm_account_id": 0,\ \ "ordering": 0,\ \ "all_day": true,\ \ "uuid": "string",\ \ "public_template": 0,\ \ "template_id": 0,\ \ "is_repeat": true,\ \ "is_recurrence": true,\ \ "recurrence_id": 0,\ \ "recurrence_parent_id": 0,\ \ "recurrence_original_start_date": "string",\ \ "event_location": "string",\ \ "event_color": "string",\ \ "event_busy_status": 0,\ \ "event_access_type": 0,\ \ "event_calendar_id": 0,\ \ "event_type": 0,\ \ "event_etag": "string",\ \ "event_sync_type": 0,\ \ "archive_status": 0,\ \ "is_hidden": true,\ \ "workflow_id": 0,\ \ "workflow_stage_id": 0\ \ }\ \ ] } }` ## [tag/Payment-logs-for-fixed-cost-tasks](https://www.flowlu.com/api/\#tag/Payment-logs-for-fixed-cost-tasks) Payment logs for fixed cost tasks The payment logs for fixed cost tasks are described here ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [task](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | task\_id | ## [tag/Payment-logs-for-fixed-cost-tasks/paths/~1task~1invoicing_logs~1create/post](https://www.flowlu.com/api/\#tag/Payment-logs-for-fixed-cost-tasks/paths/~1task~1invoicing_logs~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | task\_id | integer | | invoice\_id | integer | | amount | number | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/task/invoicing\_logs/create https://{company}.flowlu.com/api/v1/module/task/invoicing\_logs/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "invoice_id": 0, "amount": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Payment-logs-for-fixed-cost-tasks/paths/~1task~1invoicing_logs~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Payment-logs-for-fixed-cost-tasks/paths/~1task~1invoicing_logs~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/task/invoicing\_logs/update/{id} https://{company}.flowlu.com/api/v1/module/task/invoicing\_logs/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "invoice_id": 0, "amount": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Payment-logs-for-fixed-cost-tasks/paths/~1task~1invoicing_logs~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Payment-logs-for-fixed-cost-tasks/paths/~1task~1invoicing_logs~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/task/invoicing\_logs/delete/{id} https://{company}.flowlu.com/api/v1/module/task/invoicing\_logs/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Payment-logs-for-fixed-cost-tasks/paths/~1task~1invoicing_logs~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Payment-logs-for-fixed-cost-tasks/paths/~1task~1invoicing_logs~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/task/invoicing\_logs/get/{id} https://{company}.flowlu.com/api/v1/module/task/invoicing\_logs/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "invoice_id": 0, "amount": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Payment-logs-for-fixed-cost-tasks/paths/~1task~1invoicing_logs~1list/get](https://www.flowlu.com/api/\#tag/Payment-logs-for-fixed-cost-tasks/paths/~1task~1invoicing_logs~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/task/invoicing\_logs/list https://{company}.flowlu.com/api/v1/module/task/invoicing\_logs/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "task_id": 0,\ \ "invoice_id": 0,\ \ "amount": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Lists](https://www.flowlu.com/api/\#tag/Lists) Lists ## [tag/Lists/paths/~1task~1lists~1create/post](https://www.flowlu.com/api/\#tag/Lists/paths/~1task~1lists~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | user\_id | integer
Id of the user who has access to this list | | created\_date | string
Created date | | created\_by | integer
User id | | updated\_by | integer
User id | | updated\_date | string
Updated date | | active | boolean
If = 0, Inactive.
Default value = 1. | | color | string
Color HEX code | | icon | string
Icon code | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | ### Responses **200** Successfully create an item post/task/lists/create https://{company}.flowlu.com/api/v1/module/task/lists/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "user_id": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "active": true, "color": "string", "icon": "string", "ordering": 0 } }` ## [tag/Lists/paths/~1task~1lists~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Lists/paths/~1task~1lists~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/task/lists/update/{id} https://{company}.flowlu.com/api/v1/module/task/lists/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "user_id": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "active": true, "color": "string", "icon": "string", "ordering": 0 } }` ## [tag/Lists/paths/~1task~1lists~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Lists/paths/~1task~1lists~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/task/lists/delete/{id} https://{company}.flowlu.com/api/v1/module/task/lists/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Lists/paths/~1task~1lists~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Lists/paths/~1task~1lists~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/task/lists/get/{id} https://{company}.flowlu.com/api/v1/module/task/lists/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "user_id": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "active": true, "color": "string", "icon": "string", "ordering": 0 } }` ## [tag/Lists/paths/~1task~1lists~1list/get](https://www.flowlu.com/api/\#tag/Lists/paths/~1task~1lists~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/task/lists/list https://{company}.flowlu.com/api/v1/module/task/lists/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "user_id": 0,\ \ "created_date": "string",\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "active": true,\ \ "color": "string",\ \ "icon": "string",\ \ "ordering": 0\ \ }\ \ ] } }` ## [tag/Linking-tasks-and-lists](https://www.flowlu.com/api/\#tag/Linking-tasks-and-lists) Linking tasks & lists ## [tag/Linking-tasks-and-lists/paths/~1task~1taskslists~1create/post](https://www.flowlu.com/api/\#tag/Linking-tasks-and-lists/paths/~1task~1taskslists~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | task\_id | integer
Task ID | | list\_id | integer
List Id | | created\_date | string
Created date | | created\_by | integer
User id | | updated\_by | integer
User id | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/task/taskslists/create https://{company}.flowlu.com/api/v1/module/task/taskslists/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "list_id": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string" } }` ## [tag/Linking-tasks-and-lists/paths/~1task~1taskslists~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Linking-tasks-and-lists/paths/~1task~1taskslists~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/task/taskslists/update/{id} https://{company}.flowlu.com/api/v1/module/task/taskslists/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "list_id": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string" } }` ## [tag/Linking-tasks-and-lists/paths/~1task~1taskslists~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Linking-tasks-and-lists/paths/~1task~1taskslists~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/task/taskslists/delete/{id} https://{company}.flowlu.com/api/v1/module/task/taskslists/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Linking-tasks-and-lists/paths/~1task~1taskslists~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Linking-tasks-and-lists/paths/~1task~1taskslists~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/task/taskslists/get/{id} https://{company}.flowlu.com/api/v1/module/task/taskslists/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "list_id": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string" } }` ## [tag/Linking-tasks-and-lists/paths/~1task~1taskslists~1list/get](https://www.flowlu.com/api/\#tag/Linking-tasks-and-lists/paths/~1task~1taskslists~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/task/taskslists/list https://{company}.flowlu.com/api/v1/module/task/taskslists/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "task_id": 0,\ \ "list_id": 0,\ \ "created_date": "string",\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Followers](https://www.flowlu.com/api/\#tag/Followers) Followers ## [tag/Followers/paths/~1task~1followers~1create/post](https://www.flowlu.com/api/\#tag/Followers/paths/~1task~1followers~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | task\_id | integer
Task ID | | user\_id | integer
User id | | group\_id | integer
Group id | | role | integer
Follower role | | created\_date | string
Created date | | created\_by | integer
User id | | updated\_by | integer
User id | | updated\_date | string
Updated date | | event\_accepted\_status | boolean
Event accepted status | | event\_show\_user\_notification | boolean
Show employee event notifications, Default = 1 | ### Responses **200** Successfully create an item post/task/followers/create https://{company}.flowlu.com/api/v1/module/task/followers/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "user_id": 0, "group_id": 0, "role": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "event_accepted_status": true, "event_show_user_notification": true } }` ## [tag/Followers/paths/~1task~1followers~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Followers/paths/~1task~1followers~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/task/followers/update/{id} https://{company}.flowlu.com/api/v1/module/task/followers/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "user_id": 0, "group_id": 0, "role": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "event_accepted_status": true, "event_show_user_notification": true } }` ## [tag/Followers/paths/~1task~1followers~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Followers/paths/~1task~1followers~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/task/followers/delete/{id} https://{company}.flowlu.com/api/v1/module/task/followers/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Followers/paths/~1task~1followers~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Followers/paths/~1task~1followers~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/task/followers/get/{id} https://{company}.flowlu.com/api/v1/module/task/followers/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "user_id": 0, "group_id": 0, "role": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "event_accepted_status": true, "event_show_user_notification": true } }` ## [tag/Followers/paths/~1task~1followers~1list/get](https://www.flowlu.com/api/\#tag/Followers/paths/~1task~1followers~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/task/followers/list https://{company}.flowlu.com/api/v1/module/task/followers/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "task_id": 0,\ \ "user_id": 0,\ \ "group_id": 0,\ \ "role": 0,\ \ "created_date": "string",\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "event_accepted_status": true,\ \ "event_show_user_notification": true\ \ }\ \ ] } }` ## [tag/Followers/paths/~1agile~1followers~1create/post](https://www.flowlu.com/api/\#tag/Followers/paths/~1agile~1followers~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | issue\_id | integer
Task ID | | user\_id | integer
User id | | group\_id | integer
Group id | | role | integer
Follower role | | created\_date | string
Created date | | created\_by | integer
User id | | updated\_date | string
Updated date | | updated\_by | integer
User id | ### Responses **200** Successfully create an item post/agile/followers/create https://{company}.flowlu.com/api/v1/module/agile/followers/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "issue_id": 0, "user_id": 0, "group_id": 0, "role": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0 } }` ## [tag/Followers/paths/~1agile~1followers~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Followers/paths/~1agile~1followers~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/followers/update/{id} https://{company}.flowlu.com/api/v1/module/agile/followers/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "issue_id": 0, "user_id": 0, "group_id": 0, "role": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0 } }` ## [tag/Followers/paths/~1agile~1followers~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Followers/paths/~1agile~1followers~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/followers/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/followers/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Followers/paths/~1agile~1followers~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Followers/paths/~1agile~1followers~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/followers/get/{id} https://{company}.flowlu.com/api/v1/module/agile/followers/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "issue_id": 0, "user_id": 0, "group_id": 0, "role": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0 } }` ## [tag/Followers/paths/~1agile~1followers~1list/get](https://www.flowlu.com/api/\#tag/Followers/paths/~1agile~1followers~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/followers/list https://{company}.flowlu.com/api/v1/module/agile/followers/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "issue_id": 0,\ \ "user_id": 0,\ \ "group_id": 0,\ \ "role": 0,\ \ "created_date": "string",\ \ "created_by": 0,\ \ "updated_date": "string",\ \ "updated_by": 0\ \ }\ \ ] } }` ## [tag/Collaborators](https://www.flowlu.com/api/\#tag/Collaborators) Collaborators ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [task](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | task\_id | ## [tag/Collaborators/paths/~1task~1collaborators~1create/post](https://www.flowlu.com/api/\#tag/Collaborators/paths/~1task~1collaborators~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | task\_id | integer
Task ID | | user\_id | integer
User id | | group\_id | integer
Group id | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/task/collaborators/create https://{company}.flowlu.com/api/v1/module/task/collaborators/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "user_id": 0, "group_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Collaborators/paths/~1task~1collaborators~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Collaborators/paths/~1task~1collaborators~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/task/collaborators/update/{id} https://{company}.flowlu.com/api/v1/module/task/collaborators/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "user_id": 0, "group_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Collaborators/paths/~1task~1collaborators~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Collaborators/paths/~1task~1collaborators~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/task/collaborators/delete/{id} https://{company}.flowlu.com/api/v1/module/task/collaborators/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Collaborators/paths/~1task~1collaborators~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Collaborators/paths/~1task~1collaborators~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/task/collaborators/get/{id} https://{company}.flowlu.com/api/v1/module/task/collaborators/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "user_id": 0, "group_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Collaborators/paths/~1task~1collaborators~1list/get](https://www.flowlu.com/api/\#tag/Collaborators/paths/~1task~1collaborators~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/task/collaborators/list https://{company}.flowlu.com/api/v1/module/task/collaborators/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "task_id": 0,\ \ "user_id": 0,\ \ "group_id": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Task-Workflows](https://www.flowlu.com/api/\#tag/Task-Workflows) Task Workflows ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | workflow\_id | | [stages](https://www.flowlu.com/api/#tag/Workflow%20Statuses) | Tasks | Workflow Statuses | workflow\_id | | [projects](https://www.flowlu.com/api/#tag/Project) | Projects | Project | tasks\_workflow\_id | | [projects\_workflows](https://www.flowlu.com/api/#tag/Project%20Templates) | Projects | Project Templates | tasks\_workflow\_id | ## [tag/Task-Workflows/paths/~1task~1workflows~1create/post](https://www.flowlu.com/api/\#tag/Task-Workflows/paths/~1task~1workflows~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | ordering | number
Task Workflow Ordering | | created\_date | string
Created date | | created\_by | integer
User id | | updated\_by | integer
User id | | updated\_date | string
Updated date | | active | boolean
Active | ### Responses **200** Successfully create an item post/task/workflows/create https://{company}.flowlu.com/api/v1/module/task/workflows/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "ordering": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Task-Workflows/paths/~1task~1workflows~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Task-Workflows/paths/~1task~1workflows~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/task/workflows/update/{id} https://{company}.flowlu.com/api/v1/module/task/workflows/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "ordering": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Task-Workflows/paths/~1task~1workflows~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Task-Workflows/paths/~1task~1workflows~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/task/workflows/delete/{id} https://{company}.flowlu.com/api/v1/module/task/workflows/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Task-Workflows/paths/~1task~1workflows~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Task-Workflows/paths/~1task~1workflows~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/task/workflows/get/{id} https://{company}.flowlu.com/api/v1/module/task/workflows/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "ordering": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Task-Workflows/paths/~1task~1workflows~1list/get](https://www.flowlu.com/api/\#tag/Task-Workflows/paths/~1task~1workflows~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/task/workflows/list https://{company}.flowlu.com/api/v1/module/task/workflows/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "ordering": 0,\ \ "created_date": "string",\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "active": true\ \ }\ \ ] } }` ## [tag/Workflow-Statuses](https://www.flowlu.com/api/\#tag/Workflow-Statuses) Workflow Statuses ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [workflow](https://www.flowlu.com/api/#tag/Task%20Workflows) | Tasks | Task Workflows | workflow\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | workflow\_stage\_id | ## [tag/Workflow-Statuses/paths/~1task~1stages~1create/post](https://www.flowlu.com/api/\#tag/Workflow-Statuses/paths/~1task~1stages~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | ordering | integer
Ordering | | created\_date | string
Created date | | created\_by | integer
User id | | updated\_by | integer
User id | | updated\_date | string
Updated date | | workflow\_id | integer
Status and Workflow relation | | color | string
Status color | | task\_status | integer
Task Status.
1 - To do
3 - In progress
4 - Approval
5 - Task completed | ### Responses **200** Successfully create an item post/task/stages/create https://{company}.flowlu.com/api/v1/module/task/stages/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "ordering": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "workflow_id": 0, "color": "string", "task_status": 0 } }` ## [tag/Workflow-Statuses/paths/~1task~1stages~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Workflow-Statuses/paths/~1task~1stages~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/task/stages/update/{id} https://{company}.flowlu.com/api/v1/module/task/stages/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "ordering": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "workflow_id": 0, "color": "string", "task_status": 0 } }` ## [tag/Workflow-Statuses/paths/~1task~1stages~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Workflow-Statuses/paths/~1task~1stages~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/task/stages/delete/{id} https://{company}.flowlu.com/api/v1/module/task/stages/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Workflow-Statuses/paths/~1task~1stages~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Workflow-Statuses/paths/~1task~1stages~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/task/stages/get/{id} https://{company}.flowlu.com/api/v1/module/task/stages/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "ordering": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "workflow_id": 0, "color": "string", "task_status": 0 } }` ## [tag/Workflow-Statuses/paths/~1task~1stages~1list/get](https://www.flowlu.com/api/\#tag/Workflow-Statuses/paths/~1task~1stages~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/task/stages/list https://{company}.flowlu.com/api/v1/module/task/stages/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "ordering": 0,\ \ "created_date": "string",\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "workflow_id": 0,\ \ "color": "string",\ \ "task_status": 0\ \ }\ \ ] } }` ## [tag/Calendar](https://www.flowlu.com/api/\#tag/Calendar) Calendar ## [tag/Calendar/paths/~1calendar~1calendar~1create/post](https://www.flowlu.com/api/\#tag/Calendar/paths/~1calendar~1calendar~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | type | integer
Calendar type:
10 - Private
20 - Public
30 - My Tasks
40 - Primary | | color | string
Color in HEX format | | timezone | string
Calendar timezone (America/Pangnirtung) | | sync\_type | integer | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | uuid | string
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer systems | | etag | string
Google Etag | ### Responses **200** Successfully create an item post/calendar/calendar/create https://{company}.flowlu.com/api/v1/module/calendar/calendar/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "type": 0, "color": "string", "timezone": "string", "sync_type": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "uuid": "string", "etag": "string" } }` ## [tag/Calendar/paths/~1calendar~1calendar~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Calendar/paths/~1calendar~1calendar~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/calendar/calendar/update/{id} https://{company}.flowlu.com/api/v1/module/calendar/calendar/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "type": 0, "color": "string", "timezone": "string", "sync_type": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "uuid": "string", "etag": "string" } }` ## [tag/Calendar/paths/~1calendar~1calendar~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Calendar/paths/~1calendar~1calendar~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/calendar/calendar/delete/{id} https://{company}.flowlu.com/api/v1/module/calendar/calendar/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Calendar/paths/~1calendar~1calendar~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Calendar/paths/~1calendar~1calendar~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/calendar/calendar/get/{id} https://{company}.flowlu.com/api/v1/module/calendar/calendar/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "type": 0, "color": "string", "timezone": "string", "sync_type": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "uuid": "string", "etag": "string" } }` ## [tag/Calendar/paths/~1calendar~1calendar~1list/get](https://www.flowlu.com/api/\#tag/Calendar/paths/~1calendar~1calendar~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/calendar/calendar/list https://{company}.flowlu.com/api/v1/module/calendar/calendar/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "type": 0,\ \ "color": "string",\ \ "timezone": "string",\ \ "sync_type": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "uuid": "string",\ \ "etag": "string"\ \ }\ \ ] } }` ## [tag/Agile](https://www.flowlu.com/api/\#tag/Agile) Agile With the Agile, you can manage projects that frequently change requirements and priorities. The agile approach is frequently used in project management of various industries, such as software development, marketing, education, design, etc. An agile approach to project management is focused on bringing maximum value for the consumer. ## [tag/Issues](https://www.flowlu.com/api/\#tag/Issues) Issues ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [project](https://www.flowlu.com/api/#tag/Agile%20project) | Agile Projects | Agile project | project\_id | | [sprint](https://www.flowlu.com/api/#tag/Sprint) | Agile Projects | Sprint | sprint\_id | | [stage](https://www.flowlu.com/api/#tag/Stage) | Agile Projects | Stage | workflow\_stage\_id | | [type](https://www.flowlu.com/api/#tag/Issue%20type) | Agile Projects | Issue type | type\_id | | [category](https://www.flowlu.com/api/#tag/Agile%20categories) | Agile Projects | Agile categories | category\_id | | [parent\_issue](https://www.flowlu.com/api/#tag/Issues) | Agile Projects | Issues | parent\_issue\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [child\_issues](https://www.flowlu.com/api/#tag/Issues) | Agile Projects | Issues | parent\_issue\_id | | [parent\_issue\_relations](https://www.flowlu.com/api/#tag/Issue%20relation) | Agile Projects | Issue relation | parent\_issue\_id | | [child\_issue\_relations](https://www.flowlu.com/api/#tag/Issue%20relation) | Agile Projects | Issue relation | child\_issue\_id | | [subtasks](https://www.flowlu.com/api/#tag/Issues) | Agile Projects | Issues | parent\_issue\_id | | [ref\_tickets](https://www.flowlu.com/api/#tag/Reference%20issue%20relation) | Agile Projects | Reference issue relation | issue\_id | ## [tag/Issues/paths/~1agile~1issues~1create/post](https://www.flowlu.com/api/\#tag/Issues/paths/~1agile~1issues~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | number | integer
Issue number | | number\_label | string
Number label | | name | string
Summary | | description | string
Description | | ordering | number
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | type\_id | integer
Description | | estimate | number
Estimate | | value | string
Value | | effort | integer
Effort | | priority | integer
Priority:
10 - Blocker
20 - Critical
30 - High
40 - Medium
50 - Low | | category\_id | integer
Category id | | sprint\_id | integer
Sprint id | | project\_id | integer
Project id | | workflow\_stage\_id | integer
Stage ID | | assignee\_id | integer
Assigned user id | | parent\_issue\_id | integer
Parent issue id | | creator\_id | integer
User id | | epic\_id | integer | | is\_archived | boolean
Entity Archiving status | | archived\_date | string
Date of archiving | | completed\_date | string
Issue completion time | | created\_date | string
Created date | | updated\_date | string
Updated date | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | ### Responses **200** Successfully create an item post/agile/issues/create https://{company}.flowlu.com/api/v1/module/agile/issues/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "number": 0, "number_label": "string", "name": "string", "description": "string", "ordering": 0, "type_id": 0, "estimate": 0, "value": "string", "effort": 0, "priority": 0, "category_id": 0, "sprint_id": 0, "project_id": 0, "workflow_stage_id": 0, "assignee_id": 0, "parent_issue_id": 0, "creator_id": 0, "epic_id": 0, "is_archived": true, "archived_date": "string", "completed_date": "string", "created_date": "string", "updated_date": "string", "ref": "string", "ref_id": "string" } }` ## [tag/Issues/paths/~1agile~1issues~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Issues/paths/~1agile~1issues~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/issues/update/{id} https://{company}.flowlu.com/api/v1/module/agile/issues/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "number": 0, "number_label": "string", "name": "string", "description": "string", "ordering": 0, "type_id": 0, "estimate": 0, "value": "string", "effort": 0, "priority": 0, "category_id": 0, "sprint_id": 0, "project_id": 0, "workflow_stage_id": 0, "assignee_id": 0, "parent_issue_id": 0, "creator_id": 0, "epic_id": 0, "is_archived": true, "archived_date": "string", "completed_date": "string", "created_date": "string", "updated_date": "string", "ref": "string", "ref_id": "string" } }` ## [tag/Issues/paths/~1agile~1issues~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Issues/paths/~1agile~1issues~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/issues/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/issues/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Issues/paths/~1agile~1issues~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Issues/paths/~1agile~1issues~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/issues/get/{id} https://{company}.flowlu.com/api/v1/module/agile/issues/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "number": 0, "number_label": "string", "name": "string", "description": "string", "ordering": 0, "type_id": 0, "estimate": 0, "value": "string", "effort": 0, "priority": 0, "category_id": 0, "sprint_id": 0, "project_id": 0, "workflow_stage_id": 0, "assignee_id": 0, "parent_issue_id": 0, "creator_id": 0, "epic_id": 0, "is_archived": true, "archived_date": "string", "completed_date": "string", "created_date": "string", "updated_date": "string", "ref": "string", "ref_id": "string" } }` ## [tag/Issues/paths/~1agile~1issues~1list/get](https://www.flowlu.com/api/\#tag/Issues/paths/~1agile~1issues~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/issues/list https://{company}.flowlu.com/api/v1/module/agile/issues/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "number": 0,\ \ "number_label": "string",\ \ "name": "string",\ \ "description": "string",\ \ "ordering": 0,\ \ "type_id": 0,\ \ "estimate": 0,\ \ "value": "string",\ \ "effort": 0,\ \ "priority": 0,\ \ "category_id": 0,\ \ "sprint_id": 0,\ \ "project_id": 0,\ \ "workflow_stage_id": 0,\ \ "assignee_id": 0,\ \ "parent_issue_id": 0,\ \ "creator_id": 0,\ \ "epic_id": 0,\ \ "is_archived": true,\ \ "archived_date": "string",\ \ "completed_date": "string",\ \ "created_date": "string",\ \ "updated_date": "string",\ \ "ref": "string",\ \ "ref_id": "string"\ \ }\ \ ] } }` ## [tag/Followers](https://www.flowlu.com/api/\#tag/Followers) Followers ## [tag/Followers/paths/~1task~1followers~1create/post](https://www.flowlu.com/api/\#tag/Followers/paths/~1task~1followers~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully create an item post/task/followers/create https://{company}.flowlu.com/api/v1/module/task/followers/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "user_id": 0, "group_id": 0, "role": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "event_accepted_status": true, "event_show_user_notification": true } }` ## [tag/Followers/paths/~1task~1followers~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Followers/paths/~1task~1followers~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/task/followers/update/{id} https://{company}.flowlu.com/api/v1/module/task/followers/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "user_id": 0, "group_id": 0, "role": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "event_accepted_status": true, "event_show_user_notification": true } }` ## [tag/Followers/paths/~1task~1followers~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Followers/paths/~1task~1followers~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/task/followers/delete/{id} https://{company}.flowlu.com/api/v1/module/task/followers/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Followers/paths/~1task~1followers~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Followers/paths/~1task~1followers~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/task/followers/get/{id} https://{company}.flowlu.com/api/v1/module/task/followers/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "task_id": 0, "user_id": 0, "group_id": 0, "role": 0, "created_date": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "event_accepted_status": true, "event_show_user_notification": true } }` ## [tag/Followers/paths/~1task~1followers~1list/get](https://www.flowlu.com/api/\#tag/Followers/paths/~1task~1followers~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/task/followers/list https://{company}.flowlu.com/api/v1/module/task/followers/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, } }` ## [tag/Followers/paths/~1agile~1followers~1create/post](https://www.flowlu.com/api/\#tag/Followers/paths/~1agile~1followers~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully create an item post/agile/followers/create https://{company}.flowlu.com/api/v1/module/agile/followers/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "issue_id": 0, "user_id": 0, "group_id": 0, "role": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0 } }` ## [tag/Followers/paths/~1agile~1followers~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Followers/paths/~1agile~1followers~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/followers/update/{id} https://{company}.flowlu.com/api/v1/module/agile/followers/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "issue_id": 0, "user_id": 0, "group_id": 0, "role": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0 } }` ## [tag/Followers/paths/~1agile~1followers~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Followers/paths/~1agile~1followers~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/followers/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/followers/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Followers/paths/~1agile~1followers~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Followers/paths/~1agile~1followers~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/followers/get/{id} https://{company}.flowlu.com/api/v1/module/agile/followers/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "issue_id": 0, "user_id": 0, "group_id": 0, "role": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0 } }` ## [tag/Followers/paths/~1agile~1followers~1list/get](https://www.flowlu.com/api/\#tag/Followers/paths/~1agile~1followers~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/followers/list https://{company}.flowlu.com/api/v1/module/agile/followers/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, } }` ## [tag/Issue-relation-types](https://www.flowlu.com/api/\#tag/Issue-relation-types) Issue relation types ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [parent\_relation\_name](https://www.flowlu.com/api/#tag/Issue%20relation%20names) | Agile Projects | Issue relation names | parent\_relation\_name\_id | | [child\_relation\_name](https://www.flowlu.com/api/#tag/Issue%20relation%20names) | Agile Projects | Issue relation names | child\_relation\_name\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [issue\_relations](https://www.flowlu.com/api/#tag/Issue%20relation) | Agile Projects | Issue relation | type | ## [tag/Issue-relation-types/paths/~1agile~1issue_relation_types~1create/post](https://www.flowlu.com/api/\#tag/Issue-relation-types/paths/~1agile~1issue_relation_types~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | created\_date | string
Created date | | updated\_date | string
Updated date | | parent\_relation\_name\_id | integer
Parent relation id | | child\_relation\_name\_id | integer
Child relation id | ### Responses **200** Successfully create an item post/agile/issue\_relation\_types/create https://{company}.flowlu.com/api/v1/module/agile/issue\_relation\_types/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_date": "string", "updated_date": "string", "parent_relation_name_id": 0, "child_relation_name_id": 0 } }` ## [tag/Issue-relation-types/paths/~1agile~1issue_relation_types~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Issue-relation-types/paths/~1agile~1issue_relation_types~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/issue\_relation\_types/update/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_relation\_types/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_date": "string", "updated_date": "string", "parent_relation_name_id": 0, "child_relation_name_id": 0 } }` ## [tag/Issue-relation-types/paths/~1agile~1issue_relation_types~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Issue-relation-types/paths/~1agile~1issue_relation_types~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/issue\_relation\_types/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_relation\_types/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Issue-relation-types/paths/~1agile~1issue_relation_types~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Issue-relation-types/paths/~1agile~1issue_relation_types~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/issue\_relation\_types/get/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_relation\_types/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_date": "string", "updated_date": "string", "parent_relation_name_id": 0, "child_relation_name_id": 0 } }` ## [tag/Issue-relation-types/paths/~1agile~1issue_relation_types~1list/get](https://www.flowlu.com/api/\#tag/Issue-relation-types/paths/~1agile~1issue_relation_types~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/issue\_relation\_types/list https://{company}.flowlu.com/api/v1/module/agile/issue\_relation\_types/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "created_date": "string",\ \ "updated_date": "string",\ \ "parent_relation_name_id": 0,\ \ "child_relation_name_id": 0\ \ }\ \ ] } }` ## [tag/Issue-relation-names](https://www.flowlu.com/api/\#tag/Issue-relation-names) Issue relation names ## [tag/Issue-relation-names/paths/~1agile~1issue_relation_names~1create/post](https://www.flowlu.com/api/\#tag/Issue-relation-names/paths/~1agile~1issue_relation_names~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | created\_date | string
Created date | | updated\_date | string
Updated date | | tree\_type | boolean
Tree type | ### Responses **200** Successfully create an item post/agile/issue\_relation\_names/create https://{company}.flowlu.com/api/v1/module/agile/issue\_relation\_names/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_date": "string", "updated_date": "string", "tree_type": true } }` ## [tag/Issue-relation-names/paths/~1agile~1issue_relation_names~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Issue-relation-names/paths/~1agile~1issue_relation_names~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/issue\_relation\_names/update/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_relation\_names/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_date": "string", "updated_date": "string", "tree_type": true } }` ## [tag/Issue-relation-names/paths/~1agile~1issue_relation_names~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Issue-relation-names/paths/~1agile~1issue_relation_names~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/issue\_relation\_names/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_relation\_names/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Issue-relation-names/paths/~1agile~1issue_relation_names~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Issue-relation-names/paths/~1agile~1issue_relation_names~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/issue\_relation\_names/get/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_relation\_names/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_date": "string", "updated_date": "string", "tree_type": true } }` ## [tag/Issue-relation-names/paths/~1agile~1issue_relation_names~1list/get](https://www.flowlu.com/api/\#tag/Issue-relation-names/paths/~1agile~1issue_relation_names~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/issue\_relation\_names/list https://{company}.flowlu.com/api/v1/module/agile/issue\_relation\_names/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "created_date": "string",\ \ "updated_date": "string",\ \ "tree_type": true\ \ }\ \ ] } }` ## [tag/Issue-relation](https://www.flowlu.com/api/\#tag/Issue-relation) Issue relation ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [parent\_issue](https://www.flowlu.com/api/#tag/Issues) | Agile Projects | Issues | parent\_issue\_id | | [child\_issue](https://www.flowlu.com/api/#tag/Issues) | Agile Projects | Issues | child\_issue\_id | | [relation\_type](https://www.flowlu.com/api/#tag/Issue%20relation%20types) | Agile Projects | Issue relation types | type | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [parent\_issues](https://www.flowlu.com/api/#tag/Issues) | Agile Projects | Issues | parent\_issue\_id | ## [tag/Issue-relation/paths/~1agile~1issue_relations~1create/post](https://www.flowlu.com/api/\#tag/Issue-relation/paths/~1agile~1issue_relations~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | parent\_issue\_id | integer
Parent issue id | | child\_issue\_id | integer
Child issue id | | created\_date | string
Created date | | updated\_date | string
Updated date | | type | integer
Relation type | ### Responses **200** Successfully create an item post/agile/issue\_relations/create https://{company}.flowlu.com/api/v1/module/agile/issue\_relations/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "parent_issue_id": 0, "child_issue_id": 0, "created_date": "string", "updated_date": "string", "type": 0 } }` ## [tag/Issue-relation/paths/~1agile~1issue_relations~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Issue-relation/paths/~1agile~1issue_relations~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/issue\_relations/update/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_relations/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "parent_issue_id": 0, "child_issue_id": 0, "created_date": "string", "updated_date": "string", "type": 0 } }` ## [tag/Issue-relation/paths/~1agile~1issue_relations~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Issue-relation/paths/~1agile~1issue_relations~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/issue\_relations/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_relations/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Issue-relation/paths/~1agile~1issue_relations~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Issue-relation/paths/~1agile~1issue_relations~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/issue\_relations/get/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_relations/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "parent_issue_id": 0, "child_issue_id": 0, "created_date": "string", "updated_date": "string", "type": 0 } }` ## [tag/Issue-relation/paths/~1agile~1issue_relations~1list/get](https://www.flowlu.com/api/\#tag/Issue-relation/paths/~1agile~1issue_relations~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/issue\_relations/list https://{company}.flowlu.com/api/v1/module/agile/issue\_relations/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "parent_issue_id": 0,\ \ "child_issue_id": 0,\ \ "created_date": "string",\ \ "updated_date": "string",\ \ "type": 0\ \ }\ \ ] } }` ## [tag/Issue-type](https://www.flowlu.com/api/\#tag/Issue-type) Issue type ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [issues](https://www.flowlu.com/api/#tag/Issues) | Agile Projects | Issues | type\_id | ## [tag/Issue-type/paths/~1agile~1issue_type~1create/post](https://www.flowlu.com/api/\#tag/Issue-type/paths/~1agile~1issue_type~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | is\_default | boolean
Is default | | icon | string
Icon code | | created\_date | string
Created date | | updated\_date | string
Updated date | | color | string
Color HEX code | | type | integer
Type | | ordering | integer
Sorting | ### Responses **200** Successfully create an item post/agile/issue\_type/create https://{company}.flowlu.com/api/v1/module/agile/issue\_type/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "is_default": true, "icon": "string", "created_date": "string", "updated_date": "string", "color": "string", "type": 0, "ordering": 0 } }` ## [tag/Issue-type/paths/~1agile~1issue_type~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Issue-type/paths/~1agile~1issue_type~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/issue\_type/update/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_type/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "is_default": true, "icon": "string", "created_date": "string", "updated_date": "string", "color": "string", "type": 0, "ordering": 0 } }` ## [tag/Issue-type/paths/~1agile~1issue_type~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Issue-type/paths/~1agile~1issue_type~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/issue\_type/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_type/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Issue-type/paths/~1agile~1issue_type~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Issue-type/paths/~1agile~1issue_type~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/issue\_type/get/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_type/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "is_default": true, "icon": "string", "created_date": "string", "updated_date": "string", "color": "string", "type": 0, "ordering": 0 } }` ## [tag/Issue-type/paths/~1agile~1issue_type~1list/get](https://www.flowlu.com/api/\#tag/Issue-type/paths/~1agile~1issue_type~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/issue\_type/list https://{company}.flowlu.com/api/v1/module/agile/issue\_type/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "is_default": true,\ \ "icon": "string",\ \ "created_date": "string",\ \ "updated_date": "string",\ \ "color": "string",\ \ "type": 0,\ \ "ordering": 0\ \ }\ \ ] } }` ## [tag/Sprint](https://www.flowlu.com/api/\#tag/Sprint) Sprint ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [project](https://www.flowlu.com/api/#tag/Agile%20project) | Agile Projects | Agile project | project\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [issues](https://www.flowlu.com/api/#tag/Issues) | Agile Projects | Issues | sprint\_id | ## [tag/Sprint/paths/~1agile~1sprints~1create/post](https://www.flowlu.com/api/\#tag/Sprint/paths/~1agile~1sprints~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | start\_date | string
Sprint start date | | deadline | string
End Date | | standup\_time | string
Standup\_time | | project\_id | integer
Project ID | | started | boolean
Sprint started | | created\_date | string
Created date | | updated\_date | string
Updated date | | active | boolean
If = 0, Inactive.
Default value = 1. | | changelog | string
A list of changes made up of sprint tasks | ### Responses **200** Successfully create an item post/agile/sprints/create https://{company}.flowlu.com/api/v1/module/agile/sprints/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "start_date": "string", "deadline": "string", "standup_time": "string", "project_id": 0, "started": true, "created_date": "string", "updated_date": "string", "active": true, "changelog": "string" } }` ## [tag/Sprint/paths/~1agile~1sprints~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Sprint/paths/~1agile~1sprints~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/sprints/update/{id} https://{company}.flowlu.com/api/v1/module/agile/sprints/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "start_date": "string", "deadline": "string", "standup_time": "string", "project_id": 0, "started": true, "created_date": "string", "updated_date": "string", "active": true, "changelog": "string" } }` ## [tag/Sprint/paths/~1agile~1sprints~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Sprint/paths/~1agile~1sprints~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/sprints/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/sprints/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Sprint/paths/~1agile~1sprints~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Sprint/paths/~1agile~1sprints~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/sprints/get/{id} https://{company}.flowlu.com/api/v1/module/agile/sprints/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "start_date": "string", "deadline": "string", "standup_time": "string", "project_id": 0, "started": true, "created_date": "string", "updated_date": "string", "active": true, "changelog": "string" } }` ## [tag/Sprint/paths/~1agile~1sprints~1list/get](https://www.flowlu.com/api/\#tag/Sprint/paths/~1agile~1sprints~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/sprints/list https://{company}.flowlu.com/api/v1/module/agile/sprints/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "start_date": "string",\ \ "deadline": "string",\ \ "standup_time": "string",\ \ "project_id": 0,\ \ "started": true,\ \ "created_date": "string",\ \ "updated_date": "string",\ \ "active": true,\ \ "changelog": "string"\ \ }\ \ ] } }` ## [tag/Agile-project](https://www.flowlu.com/api/\#tag/Agile-project) Agile project ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [workflow](https://www.flowlu.com/api/#tag/Workflow) | Agile Projects | Workflow | workflow\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [sprints](https://www.flowlu.com/api/#tag/Sprint) | Agile Projects | Sprint | project\_id | | [issues](https://www.flowlu.com/api/#tag/Issues) | Agile Projects | Issues | project\_id | | [categories](https://www.flowlu.com/api/#tag/Agile%20categories) | Agile Projects | Agile categories | project\_id | | [project\_users](https://www.flowlu.com/api/#tag/Project%20users) | Agile Projects | Project users | project\_id | ## [tag/Agile-project/paths/~1agile~1projects~1create/post](https://www.flowlu.com/api/\#tag/Agile-project/paths/~1agile~1projects~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | prefix\_name | string
Prefix name | | workflow\_id | integer
Workflow id | | manager\_id | integer
Assignee | | created\_date | string
Created date | | updated\_date | string
Updated date | | archived\_date | string
Date of archiving | | is\_admin\_menu\_showing | boolean
Is admin menu showing | ### Responses **200** Successfully create an item post/agile/projects/create https://{company}.flowlu.com/api/v1/module/agile/projects/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "prefix_name": "string", "workflow_id": 0, "manager_id": 0, "created_date": "string", "updated_date": "string", "archived_date": "string", "is_admin_menu_showing": true } }` ## [tag/Agile-project/paths/~1agile~1projects~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Agile-project/paths/~1agile~1projects~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/projects/update/{id} https://{company}.flowlu.com/api/v1/module/agile/projects/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "prefix_name": "string", "workflow_id": 0, "manager_id": 0, "created_date": "string", "updated_date": "string", "archived_date": "string", "is_admin_menu_showing": true } }` ## [tag/Agile-project/paths/~1agile~1projects~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Agile-project/paths/~1agile~1projects~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/projects/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/projects/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Agile-project/paths/~1agile~1projects~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Agile-project/paths/~1agile~1projects~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/projects/get/{id} https://{company}.flowlu.com/api/v1/module/agile/projects/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "prefix_name": "string", "workflow_id": 0, "manager_id": 0, "created_date": "string", "updated_date": "string", "archived_date": "string", "is_admin_menu_showing": true } }` ## [tag/Agile-project/paths/~1agile~1projects~1list/get](https://www.flowlu.com/api/\#tag/Agile-project/paths/~1agile~1projects~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/projects/list https://{company}.flowlu.com/api/v1/module/agile/projects/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "prefix_name": "string",\ \ "workflow_id": 0,\ \ "manager_id": 0,\ \ "created_date": "string",\ \ "updated_date": "string",\ \ "archived_date": "string",\ \ "is_admin_menu_showing": true\ \ }\ \ ] } }` ## [tag/Project-users](https://www.flowlu.com/api/\#tag/Project-users) Project users ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation ## [tag/Project-users/paths/~1agile~1projects_users~1create/post](https://www.flowlu.com/api/\#tag/Project-users/paths/~1agile~1projects_users~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | project\_id | integer
Project id | | user\_id | integer
Project and user relation | | role\_id | tinyint
User role, project collaborator, or follower | ### Responses **200** Successfully create an item post/agile/projects\_users/create https://{company}.flowlu.com/api/v1/module/agile/projects\_users/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "user_id": 0, "role_id": null } }` ## [tag/Project-users/paths/~1agile~1projects_users~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Project-users/paths/~1agile~1projects_users~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/projects\_users/update/{id} https://{company}.flowlu.com/api/v1/module/agile/projects\_users/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "user_id": 0, "role_id": null } }` ## [tag/Project-users/paths/~1agile~1projects_users~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Project-users/paths/~1agile~1projects_users~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/projects\_users/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/projects\_users/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Project-users/paths/~1agile~1projects_users~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Project-users/paths/~1agile~1projects_users~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/projects\_users/get/{id} https://{company}.flowlu.com/api/v1/module/agile/projects\_users/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "user_id": 0, "role_id": null } }` ## [tag/Project-users/paths/~1agile~1projects_users~1list/get](https://www.flowlu.com/api/\#tag/Project-users/paths/~1agile~1projects_users~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/projects\_users/list https://{company}.flowlu.com/api/v1/module/agile/projects\_users/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "project_id": 0,\ \ "user_id": 0,\ \ "role_id": null\ \ }\ \ ] } }` ## [tag/Workflow](https://www.flowlu.com/api/\#tag/Workflow) Workflow ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [stages](https://www.flowlu.com/api/#tag/Stage) | Agile Projects | Stage | workflow\_id | | [projects](https://www.flowlu.com/api/#tag/Agile%20project) | Agile Projects | Agile project | workflow\_id | ## [tag/Workflow/paths/~1agile~1workflows~1create/post](https://www.flowlu.com/api/\#tag/Workflow/paths/~1agile~1workflows~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | created\_date | string
Created date | | updated\_date | string
Updated date | | description | string
Description | ### Responses **200** Successfully create an item post/agile/workflows/create https://{company}.flowlu.com/api/v1/module/agile/workflows/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_date": "string", "updated_date": "string", "description": "string" } }` ## [tag/Workflow/paths/~1agile~1workflows~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Workflow/paths/~1agile~1workflows~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/workflows/update/{id} https://{company}.flowlu.com/api/v1/module/agile/workflows/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_date": "string", "updated_date": "string", "description": "string" } }` ## [tag/Workflow/paths/~1agile~1workflows~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Workflow/paths/~1agile~1workflows~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/workflows/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/workflows/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Workflow/paths/~1agile~1workflows~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Workflow/paths/~1agile~1workflows~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/workflows/get/{id} https://{company}.flowlu.com/api/v1/module/agile/workflows/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_date": "string", "updated_date": "string", "description": "string" } }` ## [tag/Workflow/paths/~1agile~1workflows~1list/get](https://www.flowlu.com/api/\#tag/Workflow/paths/~1agile~1workflows~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/workflows/list https://{company}.flowlu.com/api/v1/module/agile/workflows/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "created_date": "string",\ \ "updated_date": "string",\ \ "description": "string"\ \ }\ \ ] } }` ## [tag/Stage](https://www.flowlu.com/api/\#tag/Stage) Stage ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [issues](https://www.flowlu.com/api/#tag/Issues) | Agile Projects | Issues | workflow\_stage\_id | ## [tag/Stage/paths/~1agile~1stages~1create/post](https://www.flowlu.com/api/\#tag/Stage/paths/~1agile~1stages~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | status | integer
Status | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | description | string
Description | | created\_date | string
Created date | | updated\_date | string
Updated date | | workflow\_id | integer
Workflow id | | color | string
Color HEX code | ### Responses **200** Successfully create an item post/agile/stages/create https://{company}.flowlu.com/api/v1/module/agile/stages/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "status": 0, "ordering": 0, "description": "string", "created_date": "string", "updated_date": "string", "workflow_id": 0, "color": "string" } }` ## [tag/Stage/paths/~1agile~1stages~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Stage/paths/~1agile~1stages~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/stages/update/{id} https://{company}.flowlu.com/api/v1/module/agile/stages/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "status": 0, "ordering": 0, "description": "string", "created_date": "string", "updated_date": "string", "workflow_id": 0, "color": "string" } }` ## [tag/Stage/paths/~1agile~1stages~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Stage/paths/~1agile~1stages~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/stages/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/stages/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Stage/paths/~1agile~1stages~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Stage/paths/~1agile~1stages~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/stages/get/{id} https://{company}.flowlu.com/api/v1/module/agile/stages/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "status": 0, "ordering": 0, "description": "string", "created_date": "string", "updated_date": "string", "workflow_id": 0, "color": "string" } }` ## [tag/Stage/paths/~1agile~1stages~1list/get](https://www.flowlu.com/api/\#tag/Stage/paths/~1agile~1stages~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/stages/list https://{company}.flowlu.com/api/v1/module/agile/stages/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "status": 0,\ \ "ordering": 0,\ \ "description": "string",\ \ "created_date": "string",\ \ "updated_date": "string",\ \ "workflow_id": 0,\ \ "color": "string"\ \ }\ \ ] } }` ## [tag/Issue-types-and-project-relations](https://www.flowlu.com/api/\#tag/Issue-types-and-project-relations) Issue types and project relations ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [issue\_type](https://www.flowlu.com/api/#tag/Issue%20type) | Agile Projects | Issue type | issue\_type\_id | | [project](https://www.flowlu.com/api/#tag/Agile%20project) | Agile Projects | Agile project | project\_id | ## [tag/Issue-types-and-project-relations/paths/~1agile~1issue_types_projects~1create/post](https://www.flowlu.com/api/\#tag/Issue-types-and-project-relations/paths/~1agile~1issue_types_projects~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | issue\_type\_id | integer
Issue type id | | project\_id | integer
Project id | ### Responses **200** Successfully create an item post/agile/issue\_types\_projects/create https://{company}.flowlu.com/api/v1/module/agile/issue\_types\_projects/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "issue_type_id": 0, "project_id": 0 } }` ## [tag/Issue-types-and-project-relations/paths/~1agile~1issue_types_projects~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Issue-types-and-project-relations/paths/~1agile~1issue_types_projects~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | issue\_type\_id | integer
Issue type id | | project\_id | integer
Project id | ### Responses **200** Successfully update an item post/agile/issue\_types\_projects/update/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_types\_projects/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "issue_type_id": 0, "project_id": 0 } }` ## [tag/Issue-types-and-project-relations/paths/~1agile~1issue_types_projects~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Issue-types-and-project-relations/paths/~1agile~1issue_types_projects~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/issue\_types\_projects/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_types\_projects/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Issue-types-and-project-relations/paths/~1agile~1issue_types_projects~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Issue-types-and-project-relations/paths/~1agile~1issue_types_projects~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/issue\_types\_projects/get/{id} https://{company}.flowlu.com/api/v1/module/agile/issue\_types\_projects/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "issue_type_id": 0, "project_id": 0 } }` ## [tag/Issue-types-and-project-relations/paths/~1agile~1issue_types_projects~1list/get](https://www.flowlu.com/api/\#tag/Issue-types-and-project-relations/paths/~1agile~1issue_types_projects~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/issue\_types\_projects/list https://{company}.flowlu.com/api/v1/module/agile/issue\_types\_projects/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "issue_type_id": 0,\ \ "project_id": 0\ \ }\ \ ] } }` ## [tag/Agile-categories](https://www.flowlu.com/api/\#tag/Agile-categories) Agile categories ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [issues](https://www.flowlu.com/api/#tag/Issues) | Agile Projects | Issues | category\_id | ## [tag/Agile-categories/paths/~1agile~1categories~1create/post](https://www.flowlu.com/api/\#tag/Agile-categories/paths/~1agile~1categories~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | assignee\_id | integer
Assigned user id | | color | string
Color HEX code | | parent\_id | integer
Entry id | | project\_id | integer
Project id | | created\_date | string
Created date | | updated\_date | string
Updated date | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | ### Responses **200** Successfully create an item post/agile/categories/create https://{company}.flowlu.com/api/v1/module/agile/categories/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "assignee_id": 0, "color": "string", "parent_id": 0, "project_id": 0, "created_date": "string", "updated_date": "string", "ordering": 0 } }` ## [tag/Agile-categories/paths/~1agile~1categories~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Agile-categories/paths/~1agile~1categories~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/categories/update/{id} https://{company}.flowlu.com/api/v1/module/agile/categories/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "assignee_id": 0, "color": "string", "parent_id": 0, "project_id": 0, "created_date": "string", "updated_date": "string", "ordering": 0 } }` ## [tag/Agile-categories/paths/~1agile~1categories~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Agile-categories/paths/~1agile~1categories~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/categories/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/categories/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Agile-categories/paths/~1agile~1categories~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Agile-categories/paths/~1agile~1categories~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/categories/get/{id} https://{company}.flowlu.com/api/v1/module/agile/categories/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "assignee_id": 0, "color": "string", "parent_id": 0, "project_id": 0, "created_date": "string", "updated_date": "string", "ordering": 0 } }` ## [tag/Agile-categories/paths/~1agile~1categories~1list/get](https://www.flowlu.com/api/\#tag/Agile-categories/paths/~1agile~1categories~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/categories/list https://{company}.flowlu.com/api/v1/module/agile/categories/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "assignee_id": 0,\ \ "color": "string",\ \ "parent_id": 0,\ \ "project_id": 0,\ \ "created_date": "string",\ \ "updated_date": "string",\ \ "ordering": 0\ \ }\ \ ] } }` ## [tag/Reference-issue-relation](https://www.flowlu.com/api/\#tag/Reference-issue-relation) Reference issue relation ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [issue](https://www.flowlu.com/api/#tag/Issues) | Agile Projects | Issues | issue\_id | ## [tag/Reference-issue-relation/paths/~1agile~1ref_issue_relation~1create/post](https://www.flowlu.com/api/\#tag/Reference-issue-relation/paths/~1agile~1ref_issue_relation~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | ref\_id | string
UUID in the system from where the import was made. | | issue\_id | integer
Reference Issue idissue relation | | ref | string
Name of the import source of the object (system, etc.) | ### Responses **200** Successfully create an item post/agile/ref\_issue\_relation/create https://{company}.flowlu.com/api/v1/module/agile/ref\_issue\_relation/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "ref_id": "string", "issue_id": 0, "ref": "string" } }` ## [tag/Reference-issue-relation/paths/~1agile~1ref_issue_relation~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Reference-issue-relation/paths/~1agile~1ref_issue_relation~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/ref\_issue\_relation/update/{id} https://{company}.flowlu.com/api/v1/module/agile/ref\_issue\_relation/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "ref_id": "string", "issue_id": 0, "ref": "string" } }` ## [tag/Reference-issue-relation/paths/~1agile~1ref_issue_relation~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Reference-issue-relation/paths/~1agile~1ref_issue_relation~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/ref\_issue\_relation/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/ref\_issue\_relation/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Reference-issue-relation/paths/~1agile~1ref_issue_relation~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Reference-issue-relation/paths/~1agile~1ref_issue_relation~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/ref\_issue\_relation/get/{id} https://{company}.flowlu.com/api/v1/module/agile/ref\_issue\_relation/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "ref_id": "string", "issue_id": 0, "ref": "string" } }` ## [tag/Reference-issue-relation/paths/~1agile~1ref_issue_relation~1list/get](https://www.flowlu.com/api/\#tag/Reference-issue-relation/paths/~1agile~1ref_issue_relation~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/ref\_issue\_relation/list https://{company}.flowlu.com/api/v1/module/agile/ref\_issue\_relation/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "ref_id": "string",\ \ "issue_id": 0,\ \ "ref": "string"\ \ }\ \ ] } }` ## [tag/Epics](https://www.flowlu.com/api/\#tag/Epics) Epics ## [tag/Epics/paths/~1agile~1epics~1create/post](https://www.flowlu.com/api/\#tag/Epics/paths/~1agile~1epics~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | project\_id | integer
Project id | | description | string
Description | | start\_date | string | | end\_date | string | | is\_completed | boolean | | ordering | number
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | created\_by | integer | | owner\_id | integer | | created\_date | string | | updated\_by | integer | | updated\_date | string | ### Responses **200** Successfully create an item post/agile/epics/create https://{company}.flowlu.com/api/v1/module/agile/epics/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "project_id": 0, "description": "string", "start_date": "string", "end_date": "string", "is_completed": true, "ordering": 0, "created_by": 0, "owner_id": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Epics/paths/~1agile~1epics~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Epics/paths/~1agile~1epics~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/agile/epics/update/{id} https://{company}.flowlu.com/api/v1/module/agile/epics/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "project_id": 0, "description": "string", "start_date": "string", "end_date": "string", "is_completed": true, "ordering": 0, "created_by": 0, "owner_id": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Epics/paths/~1agile~1epics~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Epics/paths/~1agile~1epics~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/agile/epics/delete/{id} https://{company}.flowlu.com/api/v1/module/agile/epics/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Epics/paths/~1agile~1epics~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Epics/paths/~1agile~1epics~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/agile/epics/get/{id} https://{company}.flowlu.com/api/v1/module/agile/epics/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "project_id": 0, "description": "string", "start_date": "string", "end_date": "string", "is_completed": true, "ordering": 0, "created_by": 0, "owner_id": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Epics/paths/~1agile~1epics~1list/get](https://www.flowlu.com/api/\#tag/Epics/paths/~1agile~1epics~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/agile/epics/list https://{company}.flowlu.com/api/v1/module/agile/epics/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "project_id": 0,\ \ "description": "string",\ \ "start_date": "string",\ \ "end_date": "string",\ \ "is_completed": true,\ \ "ordering": 0,\ \ "created_by": 0,\ \ "owner_id": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/CRM](https://www.flowlu.com/api/\#tag/CRM) CRM The CRM includes tools for managing opportunities and features all client information and interaction, i.e. events, tasks, emails, invoices, projects, etc.  CRM helps you build efficient sales processes and provides total control over the whole customer journey – from lead to order. There are several paths to access accounts: - `/crm/account/` \- companies and contacts - `/crm/company/` \- only companies (the same as `/crm/account/`, but with `type = 1`) - `/crm/contact/` \- only contacts (the same as `/crm/account/`, but with `type = 2`) You can use any path in most cases, but if you're working with custom fields, you need to choose the path that corresponds with the type of a  field. _Example:_ If you have custom fields `cf_1` created for "All Accounts" and `cf_2` for"Companies", use: - For `cf_1`: `/crm/account` - For `cf_2`: `/crm/company` _Example requests:_ ``` // correct request for cf_1 https://{account}.flowlu.com/api/v1/module/crm/account/list?api_key={api_key}&filter[cf.field_1]=accounts // there are no custom fields for cf_2, so the filter won't work https://{account}.flowlu.com/api/v1/module/crm/account/list?api_key={api_key}&filter[cf.field_2]=company // correct request for cf_2 https://{account}.flowlu.com/api/v1/module/crm/company/list?api_key={api_key}&filter[cf.field_2]=company ``` ## [tag/Accounts](https://www.flowlu.com/api/\#tag/Accounts) Accounts This entity in Flowlu is Company or Contact. Accounts can be your customers, suppliers, partners, competitors etc. Account can has different types (Company - 1 or Contact - 2). Each account can has relations (Relations entity) to other accounts (contact person in some company or companies). Also you can link to account tasks, leads, events, projects invoices and other entities. The account can be merged with others (if duplicates found). When account is merged, field merge\_to contains id of entry in which current was merged ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [category](https://www.flowlu.com/api/#tag/Account%20types) | CRM | Account types | account\_category\_id | | [industry](https://www.flowlu.com/api/#tag/Account%20industries) | CRM | Account industries | industry\_id | | [honorific](https://www.flowlu.com/api/#tag/Honorifics) | CRM | Honorifics | honorific\_title\_id | | [merged\_account](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | merged\_to | #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [parent\_relations](https://www.flowlu.com/api/#tag/Relation) | CRM | Relation | child\_acc\_id | | | [child\_relations](https://www.flowlu.com/api/#tag/Relation) | CRM | Relation | parent\_acc\_id | | | [contacts\_projects](https://www.flowlu.com/api/#tag/Project) | Projects | Project | customer\_crm\_contact\_id | | | [companies\_projects](https://www.flowlu.com/api/#tag/Project) | Projects | Project | customer\_id | | | [contacts\_tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | model\_id | module = crm, model = contact | | [companies\_tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | model\_id | module = crm, model = company | | [account\_tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | model\_id | module = crm, model = account | | [companies\_linked\_tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | crm\_account\_id | | | [tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | crm\_account\_id | | | [invoices](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | customer\_id | | | [payments\_in](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | crm\_account\_id | status = 10, type = 10 | | [payments\_out](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | crm\_account\_id | status = 10, type = 20 | | [payin](https://www.flowlu.com/api/#tag/Money) | Finance | Money | crm\_company\_id | | | [estimates](https://www.flowlu.com/api/#tag/Estimate) | Finance | Estimate | customer\_id | | | [plan\_money](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | crm\_company\_id | | | [plan\_incomes](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | crm\_company\_id | type = 30 | | [plan\_expenses](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | crm\_company\_id | type = 40 | | [transactions](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | crm\_account\_id | | | [multiemails](https://www.flowlu.com/api/#tag/Email) | CRM | Email | account\_id | | | [multiphones](https://www.flowlu.com/api/#tag/Clients%20phone%20numbers) | CRM | Clients phone numbers | account\_id | | | [lead\_accounts](https://www.flowlu.com/api/#tag/Link%20opportunity%20to%20CRM%20accounts) | CRM | Link opportunity to CRM accounts | account\_id | | ## [tag/Accounts/paths/~1crm~1account~1create/post](https://www.flowlu.com/api/\#tag/Accounts/paths/~1crm~1account~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | type | integer
(Required)Account type:
- Organization = 1
- Contact = 2 | | name | string
Name (title) for Organization | | honorific\_title\_id | integer
Honorific title for Contact | | first\_name | string
Contact first name | | middle\_name | string
Contact middle (second) name | | last\_name | string
Contact last name | | description | string
Description | | active | boolean
If = 0, Inactive.
Default value = 1. | | created\_date | string
Created date | | updated\_date | string
Updated date | | merged\_to | integer
Id of entry in which current account was merged | | owner\_id | integer
Assigned user id | | industry\_id | integer
id of entry in Industries table | | account\_category\_id | integer
Id of entry in Account Categories table | | birth\_date | string
Date of Birth | | name\_legal | string
Legal name for Organization | | name\_legal\_full | string
Full legal name for Organization | | phone | string
Primary phone number | | phone2 | string
Additional phone number | | phone3 | string
Additional phone number | | email | string
Email (Deprecated) To add an E-mail, use [E-mails](https://www.flowlu.com/api/#tag/Email) | | email\_personal | string
Personal email (Deprecated) To add an E-mail, use [E-mails](https://www.flowlu.com/api/#tag/Email) | | web | string
Website | | telegram | string
ICQ id | | social\_network\_link\_1 | string
Link to Skype | | social\_network\_link\_2 | string
Link to Telegram | | social\_network\_link\_3 | string
Link to Facebook | | social\_network\_link\_4 | string
Link to X | | social\_network\_link\_5 | string
Link to LinkedIn | | social\_network\_link\_6 | string
Link to Instagram | | VAT | string
Account VAT (or TAX ID) | | VAT1 | string
Additional Account VAT (or TAX ID) | | VAT2 | string
Additional Account VAT (or TAX ID) | | bank\_details | string
Bank Details text | | shipping\_country | string
Country | | shipping\_state | string
State, Region | | shipping\_city | string
City | | shipping\_zip | string
Zip Code | | shipping\_address\_line\_1 | string
Address Line 1 | | shipping\_address\_line\_2 | string
Address Line 2 | | shipping\_address\_line\_3 | string
Address Line 3 | | billing\_country | string
Country | | billing\_state | string
State, Region | | billing\_city | string
City | | billing\_zip | string
Zip Code | | billing\_address\_line\_1 | string
Address Line 1 | | billing\_address\_line\_2 | string
Address Line 2 | | billing\_address\_line\_3 | string
Address Line 3 | | address | string
Address | | address\_legal | string
Legal address | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | integer
UUID in the system from where the import was made. | | guid\_1c | string
1c GUID | | timezone | string | | organization\_employee\_count | integer | | organization\_revenue | number | | organization\_expenses | number | | organization\_registration\_date | string | | last\_activity\_id | integer | | last\_activity\_time | string | | last\_activity\_model | string | ### Responses **200** Successfully create an item post/crm/account/create https://{company}.flowlu.com/api/v1/module/crm/account/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "type": 0, "name": "string", "honorific_title_id": 0, "first_name": "string", "middle_name": "string", "last_name": "string", "description": "string", "active": true, "created_date": "string", "updated_date": "string", "merged_to": 0, "owner_id": 0, "industry_id": 0, "account_category_id": 0, "birth_date": "string", "name_legal": "string", "name_legal_full": "string", "phone": "string", "phone2": "string", "phone3": "string", "email": "string", "email_personal": "string", "web": "string", "telegram": "string", "social_network_link_1": "string", "social_network_link_2": "string", "social_network_link_3": "string", "social_network_link_4": "string", "social_network_link_5": "string", "social_network_link_6": "string", "VAT": "string", "VAT1": "string", "VAT2": "string", "bank_details": "string", "shipping_country": "string", "shipping_state": "string", "shipping_city": "string", "shipping_zip": "string", "shipping_address_line_1": "string", "shipping_address_line_2": "string", "shipping_address_line_3": "string", "billing_country": "string", "billing_state": "string", "billing_city": "string", "billing_zip": "string", "billing_address_line_1": "string", "billing_address_line_2": "string", "billing_address_line_3": "string", "address": "string", "address_legal": "string", "ref": "string", "ref_id": 0, "guid_1c": "string", "timezone": "string", "organization_employee_count": 0, "organization_revenue": 0, "organization_expenses": 0, "organization_registration_date": "string", "last_activity_id": 0, "last_activity_time": "string", "last_activity_model": "string" } }` ## [tag/Accounts/paths/~1crm~1account~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Accounts/paths/~1crm~1account~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/account/update/{id} https://{company}.flowlu.com/api/v1/module/crm/account/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "type": 0, "name": "string", "honorific_title_id": 0, "first_name": "string", "middle_name": "string", "last_name": "string", "description": "string", "active": true, "created_date": "string", "updated_date": "string", "merged_to": 0, "owner_id": 0, "industry_id": 0, "account_category_id": 0, "birth_date": "string", "name_legal": "string", "name_legal_full": "string", "phone": "string", "phone2": "string", "phone3": "string", "email": "string", "email_personal": "string", "web": "string", "telegram": "string", "social_network_link_1": "string", "social_network_link_2": "string", "social_network_link_3": "string", "social_network_link_4": "string", "social_network_link_5": "string", "social_network_link_6": "string", "VAT": "string", "VAT1": "string", "VAT2": "string", "bank_details": "string", "shipping_country": "string", "shipping_state": "string", "shipping_city": "string", "shipping_zip": "string", "shipping_address_line_1": "string", "shipping_address_line_2": "string", "shipping_address_line_3": "string", "billing_country": "string", "billing_state": "string", "billing_city": "string", "billing_zip": "string", "billing_address_line_1": "string", "billing_address_line_2": "string", "billing_address_line_3": "string", "address": "string", "address_legal": "string", "ref": "string", "ref_id": 0, "guid_1c": "string", "timezone": "string", "organization_employee_count": 0, "organization_revenue": 0, "organization_expenses": 0, "organization_registration_date": "string", "last_activity_id": 0, "last_activity_time": "string", "last_activity_model": "string" } }` ## [tag/Accounts/paths/~1crm~1account~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Accounts/paths/~1crm~1account~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/account/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/account/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Accounts/paths/~1crm~1account~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Accounts/paths/~1crm~1account~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/account/get/{id} https://{company}.flowlu.com/api/v1/module/crm/account/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "type": 0, "name": "string", "honorific_title_id": 0, "first_name": "string", "middle_name": "string", "last_name": "string", "description": "string", "active": true, "created_date": "string", "updated_date": "string", "merged_to": 0, "owner_id": 0, "industry_id": 0, "account_category_id": 0, "birth_date": "string", "name_legal": "string", "name_legal_full": "string", "phone": "string", "phone2": "string", "phone3": "string", "email": "string", "email_personal": "string", "web": "string", "telegram": "string", "social_network_link_1": "string", "social_network_link_2": "string", "social_network_link_3": "string", "social_network_link_4": "string", "social_network_link_5": "string", "social_network_link_6": "string", "VAT": "string", "VAT1": "string", "VAT2": "string", "bank_details": "string", "shipping_country": "string", "shipping_state": "string", "shipping_city": "string", "shipping_zip": "string", "shipping_address_line_1": "string", "shipping_address_line_2": "string", "shipping_address_line_3": "string", "billing_country": "string", "billing_state": "string", "billing_city": "string", "billing_zip": "string", "billing_address_line_1": "string", "billing_address_line_2": "string", "billing_address_line_3": "string", "address": "string", "address_legal": "string", "ref": "string", "ref_id": 0, "guid_1c": "string", "timezone": "string", "organization_employee_count": 0, "organization_revenue": 0, "organization_expenses": 0, "organization_registration_date": "string", "last_activity_id": 0, "last_activity_time": "string", "last_activity_model": "string" } }` ## [tag/Accounts/paths/~1crm~1account~1list/get](https://www.flowlu.com/api/\#tag/Accounts/paths/~1crm~1account~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/account/list https://{company}.flowlu.com/api/v1/module/crm/account/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "type": 0,\ \ "name": "string",\ \ "honorific_title_id": 0,\ \ "first_name": "string",\ \ "middle_name": "string",\ \ "last_name": "string",\ \ "description": "string",\ \ "active": true,\ \ "created_date": "string",\ \ "updated_date": "string",\ \ "merged_to": 0,\ \ "owner_id": 0,\ \ "industry_id": 0,\ \ "account_category_id": 0,\ \ "birth_date": "string",\ \ "name_legal": "string",\ \ "name_legal_full": "string",\ \ "phone": "string",\ \ "phone2": "string",\ \ "phone3": "string",\ \ "email": "string",\ \ "email_personal": "string",\ \ "web": "string",\ \ "telegram": "string",\ \ "social_network_link_1": "string",\ \ "social_network_link_2": "string",\ \ "social_network_link_3": "string",\ \ "social_network_link_4": "string",\ \ "social_network_link_5": "string",\ \ "social_network_link_6": "string",\ \ "VAT": "string",\ \ "VAT1": "string",\ \ "VAT2": "string",\ \ "bank_details": "string",\ \ "shipping_country": "string",\ \ "shipping_state": "string",\ \ "shipping_city": "string",\ \ "shipping_zip": "string",\ \ "shipping_address_line_1": "string",\ \ "shipping_address_line_2": "string",\ \ "shipping_address_line_3": "string",\ \ "billing_country": "string",\ \ "billing_state": "string",\ \ "billing_city": "string",\ \ "billing_zip": "string",\ \ "billing_address_line_1": "string",\ \ "billing_address_line_2": "string",\ \ "billing_address_line_3": "string",\ \ "address": "string",\ \ "address_legal": "string",\ \ "ref": "string",\ \ "ref_id": 0,\ \ "guid_1c": "string",\ \ "timezone": "string",\ \ "organization_employee_count": 0,\ \ "organization_revenue": 0,\ \ "organization_expenses": 0,\ \ "organization_registration_date": "string",\ \ "last_activity_id": 0,\ \ "last_activity_time": "string",\ \ "last_activity_model": "string"\ \ }\ \ ] } }` ## [tag/Relation](https://www.flowlu.com/api/\#tag/Relation) Relation Relation ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [account\_parent](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | parent\_acc\_id | | [account\_child](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | child\_acc\_id | ## [tag/Relation/paths/~1crm~1relation~1create/post](https://www.flowlu.com/api/\#tag/Relation/paths/~1crm~1relation~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | parent\_acc\_id | integer
Id of parent account | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | child\_acc\_id | integer
id of child account | | relation\_name | string
title of relation (position etc) | | type | integer
1 - employee
2 - company | ### Responses **200** Successfully create an item post/crm/relation/create https://{company}.flowlu.com/api/v1/module/crm/relation/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "parent_acc_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "child_acc_id": 0, "relation_name": "string", "type": 0 } }` ## [tag/Relation/paths/~1crm~1relation~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Relation/paths/~1crm~1relation~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/relation/update/{id} https://{company}.flowlu.com/api/v1/module/crm/relation/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "parent_acc_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "child_acc_id": 0, "relation_name": "string", "type": 0 } }` ## [tag/Relation/paths/~1crm~1relation~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Relation/paths/~1crm~1relation~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/relation/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/relation/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Relation/paths/~1crm~1relation~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Relation/paths/~1crm~1relation~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/relation/get/{id} https://{company}.flowlu.com/api/v1/module/crm/relation/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "parent_acc_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "child_acc_id": 0, "relation_name": "string", "type": 0 } }` ## [tag/Relation/paths/~1crm~1relation~1list/get](https://www.flowlu.com/api/\#tag/Relation/paths/~1crm~1relation~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/relation/list https://{company}.flowlu.com/api/v1/module/crm/relation/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "parent_acc_id": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "child_acc_id": 0,\ \ "relation_name": "string",\ \ "type": 0\ \ }\ \ ] } }` ## [tag/Loss-reasons](https://www.flowlu.com/api/\#tag/Loss-reasons) Loss reasons Opportunity Loss Reasons. When an opportunity is marked as lost, you're required to fill in the Loss Reason field. This helps analyze patterns and improve your sales process by addressing the most common reasons for losing deals. Account administrators can customize Loss Reasons in the Portal Settings. ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [leads](https://www.flowlu.com/api/#tag/Opportunities) | CRM | Opportunities | closing\_status\_id | active = 2 | ## [tag/Loss-reasons/paths/~1crm~1loss_reason~1create/post](https://www.flowlu.com/api/\#tag/Loss-reasons/paths/~1crm~1loss_reason~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | active | boolean
If = 0, Inactive.
Default value = 1. | ### Responses **200** Successfully create an item post/crm/loss\_reason/create https://{company}.flowlu.com/api/v1/module/crm/loss\_reason/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Loss-reasons/paths/~1crm~1loss_reason~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Loss-reasons/paths/~1crm~1loss_reason~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/loss\_reason/update/{id} https://{company}.flowlu.com/api/v1/module/crm/loss\_reason/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Loss-reasons/paths/~1crm~1loss_reason~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Loss-reasons/paths/~1crm~1loss_reason~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/loss\_reason/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/loss\_reason/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Loss-reasons/paths/~1crm~1loss_reason~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Loss-reasons/paths/~1crm~1loss_reason~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/loss\_reason/get/{id} https://{company}.flowlu.com/api/v1/module/crm/loss\_reason/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Loss-reasons/paths/~1crm~1loss_reason~1list/get](https://www.flowlu.com/api/\#tag/Loss-reasons/paths/~1crm~1loss_reason~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/loss\_reason/list https://{company}.flowlu.com/api/v1/module/crm/loss\_reason/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "ordering": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "active": true\ \ }\ \ ] } }` ## [tag/Opportunities-sources](https://www.flowlu.com/api/\#tag/Opportunities-sources) Opportunities sources The opportunity source shows where a potential sale originated — for example, an email, phone call, ad campaign, and so on. Account administrators can set up custom sources in the Portal Settings. ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [leads](https://www.flowlu.com/api/#tag/Opportunities) | CRM | Opportunities | source\_id | ## [tag/Opportunities-sources/paths/~1crm~1source~1create/post](https://www.flowlu.com/api/\#tag/Opportunities-sources/paths/~1crm~1source~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | active | boolean
If = 0, Inactive.
Default value = 1. | | description | string
Description | ### Responses **200** Successfully create an item post/crm/source/create https://{company}.flowlu.com/api/v1/module/crm/source/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true, "description": "string" } }` ## [tag/Opportunities-sources/paths/~1crm~1source~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Opportunities-sources/paths/~1crm~1source~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/source/update/{id} https://{company}.flowlu.com/api/v1/module/crm/source/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true, "description": "string" } }` ## [tag/Opportunities-sources/paths/~1crm~1source~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Opportunities-sources/paths/~1crm~1source~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/source/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/source/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Opportunities-sources/paths/~1crm~1source~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Opportunities-sources/paths/~1crm~1source~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/source/get/{id} https://{company}.flowlu.com/api/v1/module/crm/source/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true, "description": "string" } }` ## [tag/Opportunities-sources/paths/~1crm~1source~1list/get](https://www.flowlu.com/api/\#tag/Opportunities-sources/paths/~1crm~1source~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/source/list https://{company}.flowlu.com/api/v1/module/crm/source/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "ordering": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "active": true,\ \ "description": "string"\ \ }\ \ ] } }` ## [tag/Opportunity-stages](https://www.flowlu.com/api/\#tag/Opportunity-stages) Opportunity stages Pipeline Stages are a set of steps by which the salesperson navigates the client from the first request to closing the deal. Every stage is linked to the pipeline. ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [pipeline](https://www.flowlu.com/api/#tag/Pipelines) | CRM | Pipelines | pipeline\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [leads](https://www.flowlu.com/api/#tag/Opportunities) | CRM | Opportunities | pipeline\_stage\_id | ## [tag/Opportunity-stages/paths/~1crm~1pipeline_stage~1create/post](https://www.flowlu.com/api/\#tag/Opportunity-stages/paths/~1crm~1pipeline_stage~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Stage name | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | active | boolean
If = 0, Inactive.
Default value = 1. | | color | string
Color HEX code | | pipeline\_id | integer
Pipeline id | ### Responses **200** Successfully create an item post/crm/pipeline\_stage/create https://{company}.flowlu.com/api/v1/module/crm/pipeline\_stage/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "ordering": 0, "active": true, "color": "string", "pipeline_id": 0 } }` ## [tag/Opportunity-stages/paths/~1crm~1pipeline_stage~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Opportunity-stages/paths/~1crm~1pipeline_stage~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/pipeline\_stage/update/{id} https://{company}.flowlu.com/api/v1/module/crm/pipeline\_stage/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "ordering": 0, "active": true, "color": "string", "pipeline_id": 0 } }` ## [tag/Opportunity-stages/paths/~1crm~1pipeline_stage~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Opportunity-stages/paths/~1crm~1pipeline_stage~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/pipeline\_stage/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/pipeline\_stage/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Opportunity-stages/paths/~1crm~1pipeline_stage~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Opportunity-stages/paths/~1crm~1pipeline_stage~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/pipeline\_stage/get/{id} https://{company}.flowlu.com/api/v1/module/crm/pipeline\_stage/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "ordering": 0, "active": true, "color": "string", "pipeline_id": 0 } }` ## [tag/Opportunity-stages/paths/~1crm~1pipeline_stage~1list/get](https://www.flowlu.com/api/\#tag/Opportunity-stages/paths/~1crm~1pipeline_stage~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/pipeline\_stage/list https://{company}.flowlu.com/api/v1/module/crm/pipeline\_stage/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "ordering": 0,\ \ "active": true,\ \ "color": "string",\ \ "pipeline_id": 0\ \ }\ \ ] } }` ## [tag/Pipelines](https://www.flowlu.com/api/\#tag/Pipelines) Pipelines The pipeline represents the customer’s path from the first interaction to the final purchase. It’s made up of steps that guide the client from the initial inquiry to closing the deal — each step is called a funnel stage. The funnel shows both the potential sales value and the number of opportunities. ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [leads](https://www.flowlu.com/api/#tag/Opportunities) | CRM | Opportunities | pipeline\_id | | [stages](https://www.flowlu.com/api/#tag/Opportunity%20stages) | CRM | Opportunity stages | pipeline\_id | | [deals](https://www.flowlu.com/api/#tag/Opportunities) | CRM | Opportunities | pipeline\_id | ## [tag/Pipelines/paths/~1crm~1pipeline~1create/post](https://www.flowlu.com/api/\#tag/Pipelines/paths/~1crm~1pipeline~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | type\_access | tinyint
Pipeline Type | | ordering | number
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | description | string
Description | ### Responses **200** Successfully create an item post/crm/pipeline/create https://{company}.flowlu.com/api/v1/module/crm/pipeline/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "type_access": null, "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "description": "string" } }` ## [tag/Pipelines/paths/~1crm~1pipeline~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Pipelines/paths/~1crm~1pipeline~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/pipeline/update/{id} https://{company}.flowlu.com/api/v1/module/crm/pipeline/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "type_access": null, "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "description": "string" } }` ## [tag/Pipelines/paths/~1crm~1pipeline~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Pipelines/paths/~1crm~1pipeline~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/pipeline/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/pipeline/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Pipelines/paths/~1crm~1pipeline~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Pipelines/paths/~1crm~1pipeline~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/pipeline/get/{id} https://{company}.flowlu.com/api/v1/module/crm/pipeline/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "type_access": null, "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "description": "string" } }` ## [tag/Pipelines/paths/~1crm~1pipeline~1list/get](https://www.flowlu.com/api/\#tag/Pipelines/paths/~1crm~1pipeline~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/pipeline/list https://{company}.flowlu.com/api/v1/module/crm/pipeline/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "type_access": null,\ \ "ordering": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "description": "string"\ \ }\ \ ] } }` ## [tag/Opportunities](https://www.flowlu.com/api/\#tag/Opportunities) Opportunities Opportunities are designed for managing your potential deals. Each request of your potential customer, whether it's an email, a completed web form on the website or an incoming call — all of them are opportunities. During the selling process, the opportunity goes through the stages of the sales funnel. Opportunity records track details about deals, including the value of potential sales, client's interaction history, estimates and invoices, etc. ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [merged\_to](https://www.flowlu.com/api/#tag/Opportunities) | CRM | Opportunities | merged\_to\_id | | [status](https://www.flowlu.com/api/#tag/Loss%20reasons) | CRM | Loss reasons | closing\_status\_id | | [stage](https://www.flowlu.com/api/#tag/Opportunity%20stages) | CRM | Opportunity stages | pipeline\_stage\_id | | [source](https://www.flowlu.com/api/#tag/Opportunities%20sources) | CRM | Opportunities sources | source\_id | | [pipeline](https://www.flowlu.com/api/#tag/Pipelines) | CRM | Pipelines | pipeline\_id | #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | model\_id | module = crm, model = leads | | [invoices](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | model\_id | module = crm, model = leads | | [estimates](https://www.flowlu.com/api/#tag/Estimate) | Finance | Estimate | model\_id | module = crm, model = leads | | [items](https://www.flowlu.com/api/#tag/Products%20&%20Services) | CRM | Products & Services | lead\_id | | | [lead\_accounts](https://www.flowlu.com/api/#tag/Link%20opportunity%20to%20CRM%20accounts) | CRM | Link opportunity to CRM accounts | lead\_id | | ## [tag/Opportunities/paths/~1crm~1lead~1create/post](https://www.flowlu.com/api/\#tag/Opportunities/paths/~1crm~1lead~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | budget | number
Opportunity value | | merged\_to\_id | integer
Contains the ID of the lead into which this lead was merged. | | source\_id | integer
Id of entry from Opportunity Source table | | assignee\_id | integer
Assigned user id | | start\_date | string
Opportunity start date | | deadline | string
Opportunity planned close date | | pipeline\_id | integer
Pipeline id | | pipeline\_stage\_id | integer
Stage id | | active | boolean
Lead health status
1 - lead in progress
2 - lead is lost;
3 - lead is won; | | closing\_date | string
Opportunity Close Date (this field needs to be filled out if opportunity has active = 2 or 3) | | closing\_comment | string
Comment or note describes reason or situation | | closing\_status\_id | integer
Id of entry in Loss Reasons table | | contact\_name | string
Contact name | | contact\_phone | string
Contact phone | | contact\_mobile | string
Contact mobile phone (or additional phone) | | contact\_email | string
Contact email | | contact\_web | string
Website | | contact\_position | string
Contact position | | contact\_company | string
Contact's Organization | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | integer
UUID in the system from where the import was made. | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_date | string
Updated date | | last\_activity\_id | integer | | last\_activity\_time | string | | last\_activity\_model | string | | ordering | number
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | auto\_calc | tinyint | | shipping\_charge | number | | adjustment | number | | adjustment\_description | string | | pricelist\_id | integer | ### Responses **200** Successfully create an item post/crm/lead/create https://{company}.flowlu.com/api/v1/module/crm/lead/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "budget": 0, "merged_to_id": 0, "source_id": 0, "assignee_id": 0, "start_date": "string", "deadline": "string", "pipeline_id": 0, "pipeline_stage_id": 0, "active": true, "closing_date": "string", "closing_comment": "string", "closing_status_id": 0, "contact_name": "string", "contact_phone": "string", "contact_mobile": "string", "contact_email": "string", "contact_web": "string", "contact_position": "string", "contact_company": "string", "ref": "string", "ref_id": 0, "created_by": 0, "created_date": "string", "updated_date": "string", "last_activity_id": 0, "last_activity_time": "string", "last_activity_model": "string", "ordering": 0, "auto_calc": null, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "pricelist_id": 0 } }` ## [tag/Opportunities/paths/~1crm~1lead~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Opportunities/paths/~1crm~1lead~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/lead/update/{id} https://{company}.flowlu.com/api/v1/module/crm/lead/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "budget": 0, "merged_to_id": 0, "source_id": 0, "assignee_id": 0, "start_date": "string", "deadline": "string", "pipeline_id": 0, "pipeline_stage_id": 0, "active": true, "closing_date": "string", "closing_comment": "string", "closing_status_id": 0, "contact_name": "string", "contact_phone": "string", "contact_mobile": "string", "contact_email": "string", "contact_web": "string", "contact_position": "string", "contact_company": "string", "ref": "string", "ref_id": 0, "created_by": 0, "created_date": "string", "updated_date": "string", "last_activity_id": 0, "last_activity_time": "string", "last_activity_model": "string", "ordering": 0, "auto_calc": null, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "pricelist_id": 0 } }` ## [tag/Opportunities/paths/~1crm~1lead~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Opportunities/paths/~1crm~1lead~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/lead/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/lead/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Opportunities/paths/~1crm~1lead~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Opportunities/paths/~1crm~1lead~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/lead/get/{id} https://{company}.flowlu.com/api/v1/module/crm/lead/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "budget": 0, "merged_to_id": 0, "source_id": 0, "assignee_id": 0, "start_date": "string", "deadline": "string", "pipeline_id": 0, "pipeline_stage_id": 0, "active": true, "closing_date": "string", "closing_comment": "string", "closing_status_id": 0, "contact_name": "string", "contact_phone": "string", "contact_mobile": "string", "contact_email": "string", "contact_web": "string", "contact_position": "string", "contact_company": "string", "ref": "string", "ref_id": 0, "created_by": 0, "created_date": "string", "updated_date": "string", "last_activity_id": 0, "last_activity_time": "string", "last_activity_model": "string", "ordering": 0, "auto_calc": null, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "pricelist_id": 0 } }` ## [tag/Opportunities/paths/~1crm~1lead~1list/get](https://www.flowlu.com/api/\#tag/Opportunities/paths/~1crm~1lead~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/lead/list https://{company}.flowlu.com/api/v1/module/crm/lead/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "budget": 0,\ \ "merged_to_id": 0,\ \ "source_id": 0,\ \ "assignee_id": 0,\ \ "start_date": "string",\ \ "deadline": "string",\ \ "pipeline_id": 0,\ \ "pipeline_stage_id": 0,\ \ "active": true,\ \ "closing_date": "string",\ \ "closing_comment": "string",\ \ "closing_status_id": 0,\ \ "contact_name": "string",\ \ "contact_phone": "string",\ \ "contact_mobile": "string",\ \ "contact_email": "string",\ \ "contact_web": "string",\ \ "contact_position": "string",\ \ "contact_company": "string",\ \ "ref": "string",\ \ "ref_id": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_date": "string",\ \ "last_activity_id": 0,\ \ "last_activity_time": "string",\ \ "last_activity_model": "string",\ \ "ordering": 0,\ \ "auto_calc": null,\ \ "shipping_charge": 0,\ \ "adjustment": 0,\ \ "adjustment_description": "string",\ \ "pricelist_id": 0\ \ }\ \ ] } }` ## [tag/Account-types](https://www.flowlu.com/api/\#tag/Account-types) Account types The account categories allow to classify them by type of interaction.
For example, - Customers - Suppliers - Partners - Competitors ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [crm\_accounts](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | account\_category\_id | ## [tag/Account-types/paths/~1crm~1account_category~1create/post](https://www.flowlu.com/api/\#tag/Account-types/paths/~1crm~1account_category~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully create an item post/crm/account\_category/create https://{company}.flowlu.com/api/v1/module/crm/account\_category/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Account-types/paths/~1crm~1account_category~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Account-types/paths/~1crm~1account_category~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/account\_category/update/{id} https://{company}.flowlu.com/api/v1/module/crm/account\_category/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Account-types/paths/~1crm~1account_category~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Account-types/paths/~1crm~1account_category~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/account\_category/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/account\_category/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Account-types/paths/~1crm~1account_category~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Account-types/paths/~1crm~1account_category~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/account\_category/get/{id} https://{company}.flowlu.com/api/v1/module/crm/account\_category/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Account-types/paths/~1crm~1account_category~1list/get](https://www.flowlu.com/api/\#tag/Account-types/paths/~1crm~1account_category~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/account\_category/list https://{company}.flowlu.com/api/v1/module/crm/account\_category/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, } }` ## [tag/Account-industries](https://www.flowlu.com/api/\#tag/Account-industries) Account industries The Industries allow you to classify CRM accounts by their main activity. ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [crm\_accounts](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | industry\_id | ## [tag/Account-industries/paths/~1crm~1industry~1create/post](https://www.flowlu.com/api/\#tag/Account-industries/paths/~1crm~1industry~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully create an item post/crm/industry/create https://{company}.flowlu.com/api/v1/module/crm/industry/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Account-industries/paths/~1crm~1industry~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Account-industries/paths/~1crm~1industry~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/industry/update/{id} https://{company}.flowlu.com/api/v1/module/crm/industry/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Account-industries/paths/~1crm~1industry~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Account-industries/paths/~1crm~1industry~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/industry/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/industry/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Account-industries/paths/~1crm~1industry~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Account-industries/paths/~1crm~1industry~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/industry/get/{id} https://{company}.flowlu.com/api/v1/module/crm/industry/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Account-industries/paths/~1crm~1industry~1list/get](https://www.flowlu.com/api/\#tag/Account-industries/paths/~1crm~1industry~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/industry/list https://{company}.flowlu.com/api/v1/module/crm/industry/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, } }` ## [tag/Honorifics](https://www.flowlu.com/api/\#tag/Honorifics) Honorifics An honorific is a title that conveys esteem, courtesy, or respect for position or rank when used in addressing or referring to a person. ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [crm\_accounts](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | honorific\_title\_id | ## [tag/Honorifics/paths/~1crm~1honorific_title~1create/post](https://www.flowlu.com/api/\#tag/Honorifics/paths/~1crm~1honorific_title~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully create an item post/crm/honorific\_title/create https://{company}.flowlu.com/api/v1/module/crm/honorific\_title/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Honorifics/paths/~1crm~1honorific_title~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Honorifics/paths/~1crm~1honorific_title~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/honorific\_title/update/{id} https://{company}.flowlu.com/api/v1/module/crm/honorific\_title/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Honorifics/paths/~1crm~1honorific_title~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Honorifics/paths/~1crm~1honorific_title~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/honorific\_title/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/honorific\_title/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Honorifics/paths/~1crm~1honorific_title~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Honorifics/paths/~1crm~1honorific_title~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/honorific\_title/get/{id} https://{company}.flowlu.com/api/v1/module/crm/honorific\_title/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "active": true } }` ## [tag/Honorifics/paths/~1crm~1honorific_title~1list/get](https://www.flowlu.com/api/\#tag/Honorifics/paths/~1crm~1honorific_title~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/honorific\_title/list https://{company}.flowlu.com/api/v1/module/crm/honorific\_title/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, } }` ## [tag/Opportunity-Followers](https://www.flowlu.com/api/\#tag/Opportunity-Followers) Opportunity Followers Opportunity Followers ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [lead](https://www.flowlu.com/api/#tag/Opportunities) | CRM | Opportunities | lead\_id | ## [tag/Opportunity-Followers/paths/~1crm~1lead_followers~1create/post](https://www.flowlu.com/api/\#tag/Opportunity-Followers/paths/~1crm~1lead_followers~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | lead\_id | integer
Opportunity ID | | user\_id | integer
User id | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | extrafields | string | ### Responses **200** Successfully create an item post/crm/lead\_followers/create https://{company}.flowlu.com/api/v1/module/crm/lead\_followers/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "lead_id": 0, "user_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "extrafields": "string" } }` ## [tag/Opportunity-Followers/paths/~1crm~1lead_followers~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Opportunity-Followers/paths/~1crm~1lead_followers~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/lead\_followers/update/{id} https://{company}.flowlu.com/api/v1/module/crm/lead\_followers/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "lead_id": 0, "user_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "extrafields": "string" } }` ## [tag/Opportunity-Followers/paths/~1crm~1lead_followers~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Opportunity-Followers/paths/~1crm~1lead_followers~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/lead\_followers/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/lead\_followers/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Opportunity-Followers/paths/~1crm~1lead_followers~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Opportunity-Followers/paths/~1crm~1lead_followers~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/lead\_followers/get/{id} https://{company}.flowlu.com/api/v1/module/crm/lead\_followers/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "lead_id": 0, "user_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "extrafields": "string" } }` ## [tag/Opportunity-Followers/paths/~1crm~1lead_followers~1list/get](https://www.flowlu.com/api/\#tag/Opportunity-Followers/paths/~1crm~1lead_followers~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/lead\_followers/list https://{company}.flowlu.com/api/v1/module/crm/lead\_followers/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "lead_id": 0,\ \ "user_id": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "extrafields": "string"\ \ }\ \ ] } }` ## [tag/Email](https://www.flowlu.com/api/\#tag/Email) Email Email ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [account](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | account\_id | ## [tag/Email/paths/~1crm~1emails~1create/post](https://www.flowlu.com/api/\#tag/Email/paths/~1crm~1emails~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | email | string
Email | | type | integer
Address type: 10 - Work, 20 - Personal, 40 - Other. | | comment | string
Comment | | account\_id | integer
Account id | ### Responses **200** Successfully create an item post/crm/emails/create https://{company}.flowlu.com/api/v1/module/crm/emails/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "email": "string", "type": 0, "comment": "string", "account_id": 0 } }` ## [tag/Email/paths/~1crm~1emails~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Email/paths/~1crm~1emails~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/emails/update/{id} https://{company}.flowlu.com/api/v1/module/crm/emails/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "email": "string", "type": 0, "comment": "string", "account_id": 0 } }` ## [tag/Email/paths/~1crm~1emails~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Email/paths/~1crm~1emails~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/emails/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/emails/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Email/paths/~1crm~1emails~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Email/paths/~1crm~1emails~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/emails/get/{id} https://{company}.flowlu.com/api/v1/module/crm/emails/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "email": "string", "type": 0, "comment": "string", "account_id": 0 } }` ## [tag/Email/paths/~1crm~1emails~1list/get](https://www.flowlu.com/api/\#tag/Email/paths/~1crm~1emails~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/emails/list https://{company}.flowlu.com/api/v1/module/crm/emails/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "email": "string",\ \ "type": 0,\ \ "comment": "string",\ \ "account_id": 0\ \ }\ \ ] } }` ## [tag/Clients-phone-numbers](https://www.flowlu.com/api/\#tag/Clients-phone-numbers) Clients phone numbers ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [crm\_account](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | account\_id | ## [tag/Clients-phone-numbers/paths/~1crm~1phones~1create/post](https://www.flowlu.com/api/\#tag/Clients-phone-numbers/paths/~1crm~1phones~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | phone | string
Phone number | | phone\_masked | string
Formatted phone number | | type | integer
Phone number type
10 - Work
20 - Personal
30 - Other | | old\_phone | string
Old phone number | | comment | string
Comment | | account\_id | integer
Account id | ### Responses **200** Successfully create an item post/crm/phones/create https://{company}.flowlu.com/api/v1/module/crm/phones/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "phone": "string", "phone_masked": "string", "type": 0, "old_phone": "string", "comment": "string", "account_id": 0 } }` ## [tag/Clients-phone-numbers/paths/~1crm~1phones~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Clients-phone-numbers/paths/~1crm~1phones~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/phones/update/{id} https://{company}.flowlu.com/api/v1/module/crm/phones/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "phone": "string", "phone_masked": "string", "type": 0, "old_phone": "string", "comment": "string", "account_id": 0 } }` ## [tag/Clients-phone-numbers/paths/~1crm~1phones~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Clients-phone-numbers/paths/~1crm~1phones~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/phones/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/phones/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Clients-phone-numbers/paths/~1crm~1phones~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Clients-phone-numbers/paths/~1crm~1phones~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/phones/get/{id} https://{company}.flowlu.com/api/v1/module/crm/phones/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "phone": "string", "phone_masked": "string", "type": 0, "old_phone": "string", "comment": "string", "account_id": 0 } }` ## [tag/Clients-phone-numbers/paths/~1crm~1phones~1list/get](https://www.flowlu.com/api/\#tag/Clients-phone-numbers/paths/~1crm~1phones~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/phones/list https://{company}.flowlu.com/api/v1/module/crm/phones/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "phone": "string",\ \ "phone_masked": "string",\ \ "type": 0,\ \ "old_phone": "string",\ \ "comment": "string",\ \ "account_id": 0\ \ }\ \ ] } }` ## [tag/Products-and-Services](https://www.flowlu.com/api/\#tag/Products-and-Services) Products & Services ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [lead](https://www.flowlu.com/api/#tag/Opportunities) | CRM | Opportunities | lead\_id | ## [tag/Products-and-Services/paths/~1crm~1leads_items~1create/post](https://www.flowlu.com/api/\#tag/Products-and-Services/paths/~1crm~1leads_items~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | lead\_id | integer | | ordering | integer | | item\_id | integer | | name | string | | description | string | | unit\_price | number | | unit | string | | unit\_id | integer | | quantity | tax | | tax1 | number | | tax1\_included | boolean | | tax1\_amount | number | | tax2 | number | | tax2\_included | boolean | | tax2\_amount | number | | discount\_amount | number | | discount | string | | discount\_is\_percent | integer | | sub\_total | number | | tax\_total | number | | tax\_displayed | string
The tax value displayed in printed forms (%) | | total | number | | ref | string | | ref\_id | string | | type | integer | ### Responses **200** Successfully create an item post/crm/leads\_items/create https://{company}.flowlu.com/api/v1/module/crm/leads\_items/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "lead_id": 0, "ordering": 0, "item_id": 0, "name": "string", "description": "string", "unit_price": 0, "unit": "string", "unit_id": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": 0, "sub_total": 0, "tax_total": 0, "tax_displayed": "string", "total": 0, "ref": "string", "ref_id": "string", "type": 0 } }` ## [tag/Products-and-Services/paths/~1crm~1leads_items~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Products-and-Services/paths/~1crm~1leads_items~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/leads\_items/update/{id} https://{company}.flowlu.com/api/v1/module/crm/leads\_items/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "lead_id": 0, "ordering": 0, "item_id": 0, "name": "string", "description": "string", "unit_price": 0, "unit": "string", "unit_id": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": 0, "sub_total": 0, "tax_total": 0, "tax_displayed": "string", "total": 0, "ref": "string", "ref_id": "string", "type": 0 } }` ## [tag/Products-and-Services/paths/~1crm~1leads_items~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Products-and-Services/paths/~1crm~1leads_items~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/leads\_items/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/leads\_items/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Products-and-Services/paths/~1crm~1leads_items~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Products-and-Services/paths/~1crm~1leads_items~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/leads\_items/get/{id} https://{company}.flowlu.com/api/v1/module/crm/leads\_items/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "lead_id": 0, "ordering": 0, "item_id": 0, "name": "string", "description": "string", "unit_price": 0, "unit": "string", "unit_id": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": 0, "sub_total": 0, "tax_total": 0, "tax_displayed": "string", "total": 0, "ref": "string", "ref_id": "string", "type": 0 } }` ## [tag/Products-and-Services/paths/~1crm~1leads_items~1list/get](https://www.flowlu.com/api/\#tag/Products-and-Services/paths/~1crm~1leads_items~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/leads\_items/list https://{company}.flowlu.com/api/v1/module/crm/leads\_items/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "lead_id": 0,\ \ "ordering": 0,\ \ "item_id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "unit_price": 0,\ \ "unit": "string",\ \ "unit_id": 0,\ \ "quantity": null,\ \ "tax1": 0,\ \ "tax1_included": true,\ \ "tax1_amount": 0,\ \ "tax2": 0,\ \ "tax2_included": true,\ \ "tax2_amount": 0,\ \ "discount_amount": 0,\ \ "discount": "string",\ \ "discount_is_percent": 0,\ \ "sub_total": 0,\ \ "tax_total": 0,\ \ "tax_displayed": "string",\ \ "total": 0,\ \ "ref": "string",\ \ "ref_id": "string",\ \ "type": 0\ \ }\ \ ] } }` ## [tag/Link-opportunity-to-CRM-accounts](https://www.flowlu.com/api/\#tag/Link-opportunity-to-CRM-accounts) Link opportunity to CRM accounts ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [lead](https://www.flowlu.com/api/#tag/Opportunities) | CRM | Opportunities | lead\_id | | [account](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | account\_id | ## [tag/Link-opportunity-to-CRM-accounts/paths/~1crm~1lead_accounts~1create/post](https://www.flowlu.com/api/\#tag/Link-opportunity-to-CRM-accounts/paths/~1crm~1lead_accounts~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | lead\_id | integer
(Required field) The ID of the opportunity to which the CRM account will be linked (account\_id) | | account\_id | integer
(Required field) The ID of the CRM account that will be linked to the specified opportunity (lead\_id) | | account\_type | integer
(Required)Account type:
- Organization = 1
- Contact = 2 | | created\_at | string
Created date | | updated\_at | string
Updated date | ### Responses **200** Successfully create an item post/crm/lead\_accounts/create https://{company}.flowlu.com/api/v1/module/crm/lead\_accounts/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "lead_id": 0, "account_id": 0, "account_type": 0, "created_at": "string", "updated_at": "string" } }` ## [tag/Link-opportunity-to-CRM-accounts/paths/~1crm~1lead_accounts~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Link-opportunity-to-CRM-accounts/paths/~1crm~1lead_accounts~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/crm/lead\_accounts/update/{id} https://{company}.flowlu.com/api/v1/module/crm/lead\_accounts/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "lead_id": 0, "account_id": 0, "account_type": 0, "created_at": "string", "updated_at": "string" } }` ## [tag/Link-opportunity-to-CRM-accounts/paths/~1crm~1lead_accounts~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Link-opportunity-to-CRM-accounts/paths/~1crm~1lead_accounts~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/crm/lead\_accounts/delete/{id} https://{company}.flowlu.com/api/v1/module/crm/lead\_accounts/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Link-opportunity-to-CRM-accounts/paths/~1crm~1lead_accounts~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Link-opportunity-to-CRM-accounts/paths/~1crm~1lead_accounts~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/crm/lead\_accounts/get/{id} https://{company}.flowlu.com/api/v1/module/crm/lead\_accounts/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "lead_id": 0, "account_id": 0, "account_type": 0, "created_at": "string", "updated_at": "string" } }` ## [tag/Link-opportunity-to-CRM-accounts/paths/~1crm~1lead_accounts~1list/get](https://www.flowlu.com/api/\#tag/Link-opportunity-to-CRM-accounts/paths/~1crm~1lead_accounts~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/crm/lead\_accounts/list https://{company}.flowlu.com/api/v1/module/crm/lead\_accounts/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "lead_id": 0,\ \ "account_id": 0,\ \ "account_type": 0,\ \ "created_at": "string",\ \ "updated_at": "string"\ \ }\ \ ] } }` ## [tag/Project](https://www.flowlu.com/api/\#tag/Project) Project The Projects allow planning and collaborative working on project implementation. With the Projects, you can view project progress, manage key milestones and deadlines, track time spent on a project, determine project budget, issue invoices and calculate costs. ## [tag/Project](https://www.flowlu.com/api/\#tag/Project) Project A project is an entry in module ST that reflects information about the projects your company is doing. Projects have stages, a team that deals with the project, an employee responsible for the project. A project can be linked to a deal. ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [stage](https://www.flowlu.com/api/#tag/Project%20stages) | Projects | Project stages | stage\_id | | [company](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | customer\_id | | [contact](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | customer\_crm\_contact\_id | | [type](https://www.flowlu.com/api/#tag/Project%20Templates) | Projects | Project Templates | project\_type\_id | | [leads](https://www.flowlu.com/api/#tag/Opportunities) | CRM | Opportunities | crm\_lead\_id | | [workflow](https://www.flowlu.com/api/#tag/Project%20Templates) | Projects | Project Templates | project\_type\_id | | [tasks\_workflow](https://www.flowlu.com/api/#tag/Task%20Workflows) | Tasks | Task Workflows | tasks\_workflow\_id | | [briefcase](https://www.flowlu.com/api/#tag/Project%20portfolio) | Projects | Project portfolio | briefcase\_id | #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [project\_resources](https://www.flowlu.com/api/#tag/Money) | Finance | Money | project\_id | type = 21 | | [observer\_relations](https://www.flowlu.com/api/#tag/Project%20team) | Projects | Project team | project\_id | role = 10 | | [payin](https://www.flowlu.com/api/#tag/Money) | Finance | Money | project\_id | | | [transactions](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | project\_id | | | [transactions\_pls](https://www.flowlu.com/api/#tag/Transactions%20for%20the%20Profit%20and%20Loss%20statement) | Finance | Transactions for the Profit and Loss statement | project\_id | | | [pays](https://www.flowlu.com/api/#tag/Money) | Finance | Money | project\_id | type = 11 | | [stages](https://www.flowlu.com/api/#tag/Project%20stages) | Projects | Project stages | project\_id | | | [invoices](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | model\_id | module = st, model = projects | | [estimates](https://www.flowlu.com/api/#tag/Estimate) | Finance | Estimate | model\_id | module = st, model = project | | [tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | model\_id | module = st, model = project | | [stages\_only\_tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | model\_id | module = st, model = project | | [project\_tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | model\_id | module = st, model = project | | [plan\_money](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | project\_id | | | [plan\_incomes](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | project\_id | | [checkitems](https://www.flowlu.com/api/#tag/Stage%20Checklist) | Projects | Stage Checklist | project\_id | | | [plan\_expenses](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | project\_id | | [store\_doc](https://www.flowlu.com/api/#tag/Stock%20documents) | Products & Services | Stock documents | project\_id | | | [income\_store\_doc](https://www.flowlu.com/api/#tag/Stock%20documents) | Products & Services | Stock documents | project\_id | | [expenses\_store\_doc](https://www.flowlu.com/api/#tag/Stock%20documents) | Products & Services | Stock documents | project\_id | | [apar](https://www.flowlu.com/api/#tag/Payables%20&%20Receivables) | Payables & Receivables | Payables & Receivables | project\_id | | ## [tag/Project/paths/~1st~1projects~1create/post](https://www.flowlu.com/api/\#tag/Project/paths/~1st~1projects~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | estimated\_revenue | number
Contract sum | | estimated\_expenses | number
Expense sum | | startdate | string
Start date | | enddate | string
End date | | manager\_id | integer
Assigned user id | | description | string
Project description | | ordering | number
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | stage\_id | integer
Stage | | project\_type\_id | integer
Project type id | | briefcase\_id | integer
Portfolio | | is\_archive | boolean
Archived:
1 - Archived
0 - Not archived | | priority | integer
Priority:
1 - Low
2 - Medium
3 - High | | customer\_id | integer
CRM company id | | customer\_crm\_contact\_id | integer
CRM contact id | | archive\_date | string
Archive date | | workspace\_id | integer
Group id | | archive\_description | string
Description | | crm\_lead\_id | integer
CRM lead id | | uuid | string
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer systems | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | billing\_type | integer
Billing type (Default- 0):
0 - Fixed values of the plan of revenue and expenses
10 - Based on Task Hours
20 -Cash flow planning
30 - Ignore finances | | default\_billing\_rate | number
Default billing rate | | default\_employee\_cost\_rate | number
Standard cost of work for an employee | | default\_bill\_time\_type | string
Default bill time type | | default\_time\_cost\_type | string
Default bill time type | | use\_default\_invoice\_split\_type | boolean
Use default invoice split type(Default- 0) | | default\_only\_completed\_task | string | | bill\_taxes | boolean | | default\_invoice\_split\_type\_in\_project | integer
Default invoice split type in project | | default\_invoice\_item\_format | string
Default invoice item format | | use\_billing\_tasks | boolean | | use\_expenditure\_part\_tasks | boolean | | tasks\_workflow\_id | integer
Project Task Workflow ID | ### Responses **200** Successfully create an item post/st/projects/create https://{company}.flowlu.com/api/v1/module/st/projects/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "estimated_revenue": 0, "estimated_expenses": 0, "startdate": "string", "enddate": "string", "manager_id": 0, "description": "string", "ordering": 0, "stage_id": 0, "project_type_id": 0, "briefcase_id": 0, "is_archive": true, "priority": 0, "customer_id": 0, "customer_crm_contact_id": 0, "archive_date": "string", "workspace_id": 0, "archive_description": "string", "crm_lead_id": 0, "uuid": "string", "ref": "string", "ref_id": "string", "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "billing_type": 0, "default_billing_rate": 0, "default_employee_cost_rate": 0, "default_bill_time_type": "string", "default_time_cost_type": "string", "use_default_invoice_split_type": true, "default_only_completed_task": "string", "bill_taxes": true, "default_invoice_split_type_in_project": 0, "default_invoice_item_format": "string", "use_billing_tasks": true, "use_expenditure_part_tasks": true, "tasks_workflow_id": 0 } }` ## [tag/Project/paths/~1st~1projects~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Project/paths/~1st~1projects~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/st/projects/update/{id} https://{company}.flowlu.com/api/v1/module/st/projects/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "estimated_revenue": 0, "estimated_expenses": 0, "startdate": "string", "enddate": "string", "manager_id": 0, "description": "string", "ordering": 0, "stage_id": 0, "project_type_id": 0, "briefcase_id": 0, "is_archive": true, "priority": 0, "customer_id": 0, "customer_crm_contact_id": 0, "archive_date": "string", "workspace_id": 0, "archive_description": "string", "crm_lead_id": 0, "uuid": "string", "ref": "string", "ref_id": "string", "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "billing_type": 0, "default_billing_rate": 0, "default_employee_cost_rate": 0, "default_bill_time_type": "string", "default_time_cost_type": "string", "use_default_invoice_split_type": true, "default_only_completed_task": "string", "bill_taxes": true, "default_invoice_split_type_in_project": 0, "default_invoice_item_format": "string", "use_billing_tasks": true, "use_expenditure_part_tasks": true, "tasks_workflow_id": 0 } }` ## [tag/Project/paths/~1st~1projects~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Project/paths/~1st~1projects~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/st/projects/delete/{id} https://{company}.flowlu.com/api/v1/module/st/projects/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Project/paths/~1st~1projects~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Project/paths/~1st~1projects~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/st/projects/get/{id} https://{company}.flowlu.com/api/v1/module/st/projects/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "estimated_revenue": 0, "estimated_expenses": 0, "startdate": "string", "enddate": "string", "manager_id": 0, "description": "string", "ordering": 0, "stage_id": 0, "project_type_id": 0, "briefcase_id": 0, "is_archive": true, "priority": 0, "customer_id": 0, "customer_crm_contact_id": 0, "archive_date": "string", "workspace_id": 0, "archive_description": "string", "crm_lead_id": 0, "uuid": "string", "ref": "string", "ref_id": "string", "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "billing_type": 0, "default_billing_rate": 0, "default_employee_cost_rate": 0, "default_bill_time_type": "string", "default_time_cost_type": "string", "use_default_invoice_split_type": true, "default_only_completed_task": "string", "bill_taxes": true, "default_invoice_split_type_in_project": 0, "default_invoice_item_format": "string", "use_billing_tasks": true, "use_expenditure_part_tasks": true, "tasks_workflow_id": 0 } }` ## [tag/Project/paths/~1st~1projects~1list/get](https://www.flowlu.com/api/\#tag/Project/paths/~1st~1projects~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/st/projects/list https://{company}.flowlu.com/api/v1/module/st/projects/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "estimated_revenue": 0,\ \ "estimated_expenses": 0,\ \ "startdate": "string",\ \ "enddate": "string",\ \ "manager_id": 0,\ \ "description": "string",\ \ "ordering": 0,\ \ "stage_id": 0,\ \ "project_type_id": 0,\ \ "briefcase_id": 0,\ \ "is_archive": true,\ \ "priority": 0,\ \ "customer_id": 0,\ \ "customer_crm_contact_id": 0,\ \ "archive_date": "string",\ \ "workspace_id": 0,\ \ "archive_description": "string",\ \ "crm_lead_id": 0,\ \ "uuid": "string",\ \ "ref": "string",\ \ "ref_id": "string",\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "billing_type": 0,\ \ "default_billing_rate": 0,\ \ "default_employee_cost_rate": 0,\ \ "default_bill_time_type": "string",\ \ "default_time_cost_type": "string",\ \ "use_default_invoice_split_type": true,\ \ "default_only_completed_task": "string",\ \ "bill_taxes": true,\ \ "default_invoice_split_type_in_project": 0,\ \ "default_invoice_item_format": "string",\ \ "use_billing_tasks": true,\ \ "use_expenditure_part_tasks": true,\ \ "tasks_workflow_id": 0\ \ }\ \ ] } }` ## [tag/Project-Templates](https://www.flowlu.com/api/\#tag/Project-Templates) Project Templates ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [tasks\_workflow](https://www.flowlu.com/api/#tag/Task%20Workflows) | Tasks | Task Workflows | tasks\_workflow\_id | #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [stages](https://www.flowlu.com/api/#tag/Project%20stages) | Projects | Project stages | project\_type\_id | | | [projects](https://www.flowlu.com/api/#tag/Project) | Projects | Project | project\_type\_id | | | [task\_templates](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | model\_id | module = st, model = type | ## [tag/Project-Templates/paths/~1st~1project_types~1create/post](https://www.flowlu.com/api/\#tag/Project-Templates/paths/~1st~1project_types~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | report | string | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | auto\_startdate\_plus\_days | integer
When creating a new project, the project start date will be calculated as current date + no startdate\_plus\_days (Default - 0) | | auto\_enddate\_plus\_days | integer
When creating a new project, the project end date will be calculated as current date + no enddate\_plus\_days (Default is 0) | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | | create\_tasks\_next\_stage | boolean
Task creation mode (Default- 0):
1 - Create tasks for the current stage only
0 - Create all tasks when creating a project | | manual\_close\_checkitems | boolean
Complete the checklist item manually. Allow users to manually mark a checklist item as completed, even if it has unfinished tasks.
1 - Allow
0 - Deny
The default | | is\_active | boolean
If = 0, Inactive.
Default value = 1. | | description\_project | string
Description | | tasks\_workflow\_id | integer
Project Task Workflow ID | ### Responses **200** Successfully create an item post/st/project\_types/create https://{company}.flowlu.com/api/v1/module/st/project\_types/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "report": "string", "ordering": 0, "auto_startdate_plus_days": 0, "auto_enddate_plus_days": 0, "ref": "string", "ref_id": "string", "create_tasks_next_stage": true, "manual_close_checkitems": true, "is_active": true, "description_project": "string", "tasks_workflow_id": 0 } }` ## [tag/Project-Templates/paths/~1st~1project_types~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Project-Templates/paths/~1st~1project_types~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/st/project\_types/update/{id} https://{company}.flowlu.com/api/v1/module/st/project\_types/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "report": "string", "ordering": 0, "auto_startdate_plus_days": 0, "auto_enddate_plus_days": 0, "ref": "string", "ref_id": "string", "create_tasks_next_stage": true, "manual_close_checkitems": true, "is_active": true, "description_project": "string", "tasks_workflow_id": 0 } }` ## [tag/Project-Templates/paths/~1st~1project_types~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Project-Templates/paths/~1st~1project_types~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/st/project\_types/delete/{id} https://{company}.flowlu.com/api/v1/module/st/project\_types/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Project-Templates/paths/~1st~1project_types~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Project-Templates/paths/~1st~1project_types~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/st/project\_types/get/{id} https://{company}.flowlu.com/api/v1/module/st/project\_types/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "report": "string", "ordering": 0, "auto_startdate_plus_days": 0, "auto_enddate_plus_days": 0, "ref": "string", "ref_id": "string", "create_tasks_next_stage": true, "manual_close_checkitems": true, "is_active": true, "description_project": "string", "tasks_workflow_id": 0 } }` ## [tag/Project-Templates/paths/~1st~1project_types~1list/get](https://www.flowlu.com/api/\#tag/Project-Templates/paths/~1st~1project_types~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/st/project\_types/list https://{company}.flowlu.com/api/v1/module/st/project\_types/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "report": "string",\ \ "ordering": 0,\ \ "auto_startdate_plus_days": 0,\ \ "auto_enddate_plus_days": 0,\ \ "ref": "string",\ \ "ref_id": "string",\ \ "create_tasks_next_stage": true,\ \ "manual_close_checkitems": true,\ \ "is_active": true,\ \ "description_project": "string",\ \ "tasks_workflow_id": 0\ \ }\ \ ] } }` ## [tag/Project-stages](https://www.flowlu.com/api/\#tag/Project-stages) Project stages Board Stages ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [type](https://www.flowlu.com/api/#tag/Project%20Templates) | Projects | Project Templates | project\_type\_id | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | project\_id | #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [checkitems](https://www.flowlu.com/api/#tag/Stage%20Checklist) | Projects | Stage Checklist | stage\_id | | | [template\_checkitems](https://www.flowlu.com/api/#tag/Stage%20Checklist) | Projects | Stage Checklist | stage\_id | project\_id = null | | [projects](https://www.flowlu.com/api/#tag/Project) | Projects | Project | stage\_id | | | [tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | project\_stage\_id | module = st, model = project | | [task\_templates](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | project\_stage\_id | module = st, model = type | | [parent\_tasks\_projects](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | project\_stage\_id | module = st, model = project, parent\_id = null | | [parent\_tasks\_templates](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | project\_stage\_id | module = st, model = type, parent\_id = null | | [parent\_tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | project\_stage\_id | module = st, parent\_id = null | ## [tag/Project-stages/paths/~1st~1stages~1create/post](https://www.flowlu.com/api/\#tag/Project-stages/paths/~1st~1stages~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | fullname | string
Full name | | project\_type\_id | integer
Project type id | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | color\_class | string
Color class | | description | string
Description | | project\_id | integer
Project id | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | | color | string
Color HEX code | ### Responses **200** Successfully create an item post/st/stages/create https://{company}.flowlu.com/api/v1/module/st/stages/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "fullname": "string", "project_type_id": 0, "ordering": 0, "color_class": "string", "description": "string", "project_id": 0, "ref": "string", "ref_id": "string", "color": "string" } }` ## [tag/Project-stages/paths/~1st~1stages~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Project-stages/paths/~1st~1stages~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/st/stages/update/{id} https://{company}.flowlu.com/api/v1/module/st/stages/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "fullname": "string", "project_type_id": 0, "ordering": 0, "color_class": "string", "description": "string", "project_id": 0, "ref": "string", "ref_id": "string", "color": "string" } }` ## [tag/Project-stages/paths/~1st~1stages~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Project-stages/paths/~1st~1stages~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/st/stages/delete/{id} https://{company}.flowlu.com/api/v1/module/st/stages/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Project-stages/paths/~1st~1stages~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Project-stages/paths/~1st~1stages~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/st/stages/get/{id} https://{company}.flowlu.com/api/v1/module/st/stages/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "fullname": "string", "project_type_id": 0, "ordering": 0, "color_class": "string", "description": "string", "project_id": 0, "ref": "string", "ref_id": "string", "color": "string" } }` ## [tag/Project-stages/paths/~1st~1stages~1list/get](https://www.flowlu.com/api/\#tag/Project-stages/paths/~1st~1stages~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/st/stages/list https://{company}.flowlu.com/api/v1/module/st/stages/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "fullname": "string",\ \ "project_type_id": 0,\ \ "ordering": 0,\ \ "color_class": "string",\ \ "description": "string",\ \ "project_id": 0,\ \ "ref": "string",\ \ "ref_id": "string",\ \ "color": "string"\ \ }\ \ ] } }` ## [tag/Stage-Checklist](https://www.flowlu.com/api/\#tag/Stage-Checklist) Stage Checklist ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [stage](https://www.flowlu.com/api/#tag/Project%20stages) | Projects | Project stages | stage\_id | | [from\_checkitem](https://www.flowlu.com/api/#tag/Stage%20Checklist) | Projects | Stage Checklist | from\_checkitem\_id | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | project\_id | #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [copied\_checkitems](https://www.flowlu.com/api/#tag/Stage%20Checklist) | Projects | Stage Checklist | from\_checkitem\_id | | | [tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | project\_checkitem\_id | module = st | | [parent\_tasks](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | project\_checkitem\_id | module = st, parent\_id = null | ## [tag/Stage-Checklist/paths/~1st~1stage_checkitems~1create/post](https://www.flowlu.com/api/\#tag/Stage-Checklist/paths/~1st~1stage_checkitems~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | active | boolean
If = 0, Inactive.
Default value = 1. | | name | string
Name | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | stage\_id | integer
Stage ID | | description | string
Description | | report | string
Checklist report | | project\_id | integer
Project id | | checked | boolean
Checked (Default- 0):
1-Check
0 - Uncheck | | from\_checkitem\_id | integer
From checklist ID | | enddate | string
End date | | responsible\_id | integer
Assigned user id | | created\_by | integer
User id | | updated\_by | integer
User id | | created\_date | string
Created date | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/st/stage\_checkitems/create https://{company}.flowlu.com/api/v1/module/st/stage\_checkitems/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "active": true, "name": "string", "ordering": 0, "stage_id": 0, "description": "string", "report": "string", "project_id": 0, "checked": true, "from_checkitem_id": 0, "enddate": "string", "responsible_id": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Stage-Checklist/paths/~1st~1stage_checkitems~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Stage-Checklist/paths/~1st~1stage_checkitems~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/st/stage\_checkitems/update/{id} https://{company}.flowlu.com/api/v1/module/st/stage\_checkitems/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "active": true, "name": "string", "ordering": 0, "stage_id": 0, "description": "string", "report": "string", "project_id": 0, "checked": true, "from_checkitem_id": 0, "enddate": "string", "responsible_id": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Stage-Checklist/paths/~1st~1stage_checkitems~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Stage-Checklist/paths/~1st~1stage_checkitems~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/st/stage\_checkitems/delete/{id} https://{company}.flowlu.com/api/v1/module/st/stage\_checkitems/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Stage-Checklist/paths/~1st~1stage_checkitems~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Stage-Checklist/paths/~1st~1stage_checkitems~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/st/stage\_checkitems/get/{id} https://{company}.flowlu.com/api/v1/module/st/stage\_checkitems/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "active": true, "name": "string", "ordering": 0, "stage_id": 0, "description": "string", "report": "string", "project_id": 0, "checked": true, "from_checkitem_id": 0, "enddate": "string", "responsible_id": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Stage-Checklist/paths/~1st~1stage_checkitems~1list/get](https://www.flowlu.com/api/\#tag/Stage-Checklist/paths/~1st~1stage_checkitems~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/st/stage\_checkitems/list https://{company}.flowlu.com/api/v1/module/st/stage\_checkitems/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "active": true,\ \ "name": "string",\ \ "ordering": 0,\ \ "stage_id": 0,\ \ "description": "string",\ \ "report": "string",\ \ "project_id": 0,\ \ "checked": true,\ \ "from_checkitem_id": 0,\ \ "enddate": "string",\ \ "responsible_id": 0,\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "created_date": "string",\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Project-team](https://www.flowlu.com/api/\#tag/Project-team) Project team Project followers ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | project\_id | ## [tag/Project-team/paths/~1st~1project_observers~1create/post](https://www.flowlu.com/api/\#tag/Project-team/paths/~1st~1project_observers~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | project\_id | integer
Project id | | user\_id | integer
Project and user relation | | role | integer
Role of the employee in the project | ### Responses **200** Successfully create an item post/st/project\_observers/create https://{company}.flowlu.com/api/v1/module/st/project\_observers/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "user_id": 0, "role": 0 } }` ## [tag/Project-team/paths/~1st~1project_observers~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Project-team/paths/~1st~1project_observers~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/st/project\_observers/update/{id} https://{company}.flowlu.com/api/v1/module/st/project\_observers/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "user_id": 0, "role": 0 } }` ## [tag/Project-team/paths/~1st~1project_observers~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Project-team/paths/~1st~1project_observers~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/st/project\_observers/delete/{id} https://{company}.flowlu.com/api/v1/module/st/project\_observers/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Project-team/paths/~1st~1project_observers~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Project-team/paths/~1st~1project_observers~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/st/project\_observers/get/{id} https://{company}.flowlu.com/api/v1/module/st/project\_observers/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "user_id": 0, "role": 0 } }` ## [tag/Project-team/paths/~1st~1project_observers~1list/get](https://www.flowlu.com/api/\#tag/Project-team/paths/~1st~1project_observers~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/st/project\_observers/list https://{company}.flowlu.com/api/v1/module/st/project\_observers/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "project_id": 0,\ \ "user_id": 0,\ \ "role": 0\ \ }\ \ ] } }` ## [tag/Estimated-Revenue](https://www.flowlu.com/api/\#tag/Estimated-Revenue) Estimated Revenue Before adding the estimated revenue to the project, make sure that the financial management mode "Cash flow planning" is selected. ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | project\_id | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | | [org\_account](https://www.flowlu.com/api/#tag/Bank%20account) | Finance | Bank account | org\_account\_id | | [company](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | crm\_company\_id | | [project\_stage](https://www.flowlu.com/api/#tag/Project%20stages) | Projects | Project stages | project\_stage\_id | | [invoice](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | invoice\_id | #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [transactions](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | project\_money\_stage\_id | | | [transactions\_in](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | project\_money\_stage\_id | type = 10 | | [transactions\_out](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | project\_money\_stage\_id | type = 20 | ## [tag/Estimated-Revenue/paths/~1st~1project_money_stage~1create/post](https://www.flowlu.com/api/\#tag/Estimated-Revenue/paths/~1st~1project_money_stage~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | project\_id | integer
Project id | | name | string
Name | | total | number
Total | | status\_paid | integer
Status paid | | paid\_date | string
Payment creation date | | plan\_paid\_date | string
Estimated payment date | | org\_id | integer
Organization id | | category\_id | integer
Category id | | manager\_id | integer
Assigned user id | | description | string
Description | | project\_stage\_id | integer
Project stage id | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | org\_account\_id | integer
Organization account id | | currency\_id | integer | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | crm\_company\_id | integer
CRM company id | | invoice\_id | integer
Invoice ID | ### Responses **200** Successfully create an item post/st/project\_money\_stage/create https://{company}.flowlu.com/api/v1/module/st/project\_money\_stage/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "name": "string", "total": 0, "status_paid": 0, "paid_date": "string", "plan_paid_date": "string", "org_id": 0, "category_id": 0, "manager_id": 0, "description": "string", "project_stage_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "org_account_id": 0, "currency_id": 0, "ordering": 0, "crm_company_id": 0, "invoice_id": 0 } }` ## [tag/Estimated-Revenue/paths/~1st~1project_money_stage~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Estimated-Revenue/paths/~1st~1project_money_stage~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/st/project\_money\_stage/update/{id} https://{company}.flowlu.com/api/v1/module/st/project\_money\_stage/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "name": "string", "total": 0, "status_paid": 0, "paid_date": "string", "plan_paid_date": "string", "org_id": 0, "category_id": 0, "manager_id": 0, "description": "string", "project_stage_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "org_account_id": 0, "currency_id": 0, "ordering": 0, "crm_company_id": 0, "invoice_id": 0 } }` ## [tag/Estimated-Revenue/paths/~1st~1project_money_stage~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Estimated-Revenue/paths/~1st~1project_money_stage~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/st/project\_money\_stage/delete/{id} https://{company}.flowlu.com/api/v1/module/st/project\_money\_stage/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Estimated-Revenue/paths/~1st~1project_money_stage~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Estimated-Revenue/paths/~1st~1project_money_stage~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/st/project\_money\_stage/get/{id} https://{company}.flowlu.com/api/v1/module/st/project\_money\_stage/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "name": "string", "total": 0, "status_paid": 0, "paid_date": "string", "plan_paid_date": "string", "org_id": 0, "category_id": 0, "manager_id": 0, "description": "string", "project_stage_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "org_account_id": 0, "currency_id": 0, "ordering": 0, "crm_company_id": 0, "invoice_id": 0 } }` ## [tag/Estimated-Revenue/paths/~1st~1project_money_stage~1list/get](https://www.flowlu.com/api/\#tag/Estimated-Revenue/paths/~1st~1project_money_stage~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/st/project\_money\_stage/list https://{company}.flowlu.com/api/v1/module/st/project\_money\_stage/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "project_id": 0,\ \ "name": "string",\ \ "total": 0,\ \ "status_paid": 0,\ \ "paid_date": "string",\ \ "plan_paid_date": "string",\ \ "org_id": 0,\ \ "category_id": 0,\ \ "manager_id": 0,\ \ "description": "string",\ \ "project_stage_id": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "org_account_id": 0,\ \ "currency_id": 0,\ \ "ordering": 0,\ \ "crm_company_id": 0,\ \ "invoice_id": 0\ \ }\ \ ] } }` ## [tag/Estimated-Expenses](https://www.flowlu.com/api/\#tag/Estimated-Expenses) Estimated Expenses Before adding estimated costs to the project, make sure that the "Cash flow planning" financial management mode is selected. ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [transactions](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | project\_expense\_id | | | [transactions\_in](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | project\_expense\_id | type = 10 | | [transactions\_out](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | project\_expense\_id | type = 20 | ## [tag/Estimated-Expenses/paths/~1st~1project_expense~1create/post](https://www.flowlu.com/api/\#tag/Estimated-Expenses/paths/~1st~1project_expense~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | project\_id | integer
Project id | | name | string
Name | | total | number
Total | | status\_paid | integer
Paid status | | org\_id | integer
Organization id | | category\_id | integer
Category id | | manager\_id | integer
Assigned user id | | description | string
Description | | project\_stage\_id | integer
Stage id | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | org\_account\_id | integer
Organization account id | | currency\_id | integer | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | crm\_company\_id | integer
CRM company id | | date | string
Date | ### Responses **200** Successfully create an item post/st/project\_expense/create https://{company}.flowlu.com/api/v1/module/st/project\_expense/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "name": "string", "total": 0, "status_paid": 0, "org_id": 0, "category_id": 0, "manager_id": 0, "description": "string", "project_stage_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "org_account_id": 0, "currency_id": 0, "ordering": 0, "crm_company_id": 0, "date": "string" } }` ## [tag/Estimated-Expenses/paths/~1st~1project_expense~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Estimated-Expenses/paths/~1st~1project_expense~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/st/project\_expense/update/{id} https://{company}.flowlu.com/api/v1/module/st/project\_expense/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "name": "string", "total": 0, "status_paid": 0, "org_id": 0, "category_id": 0, "manager_id": 0, "description": "string", "project_stage_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "org_account_id": 0, "currency_id": 0, "ordering": 0, "crm_company_id": 0, "date": "string" } }` ## [tag/Estimated-Expenses/paths/~1st~1project_expense~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Estimated-Expenses/paths/~1st~1project_expense~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/st/project\_expense/delete/{id} https://{company}.flowlu.com/api/v1/module/st/project\_expense/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Estimated-Expenses/paths/~1st~1project_expense~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Estimated-Expenses/paths/~1st~1project_expense~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/st/project\_expense/get/{id} https://{company}.flowlu.com/api/v1/module/st/project\_expense/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "name": "string", "total": 0, "status_paid": 0, "org_id": 0, "category_id": 0, "manager_id": 0, "description": "string", "project_stage_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "org_account_id": 0, "currency_id": 0, "ordering": 0, "crm_company_id": 0, "date": "string" } }` ## [tag/Estimated-Expenses/paths/~1st~1project_expense~1list/get](https://www.flowlu.com/api/\#tag/Estimated-Expenses/paths/~1st~1project_expense~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/st/project\_expense/list https://{company}.flowlu.com/api/v1/module/st/project\_expense/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "project_id": 0,\ \ "name": "string",\ \ "total": 0,\ \ "status_paid": 0,\ \ "org_id": 0,\ \ "category_id": 0,\ \ "manager_id": 0,\ \ "description": "string",\ \ "project_stage_id": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "org_account_id": 0,\ \ "currency_id": 0,\ \ "ordering": 0,\ \ "crm_company_id": 0,\ \ "date": "string"\ \ }\ \ ] } }` ## [tag/Project-portfolio](https://www.flowlu.com/api/\#tag/Project-portfolio) Project portfolio This section presents portfolios by which you can group your projects ## [tag/Project-portfolio/paths/~1st~1portfolio~1create/post](https://www.flowlu.com/api/\#tag/Project-portfolio/paths/~1st~1portfolio~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | active | boolean
If = 0, Inactive.
Default value = 1. | | status | integer
CONFIG.STATUS.DESC | | archive\_date | string
Archive date | | archive\_description | string
Description | | ordering | number
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/st/portfolio/create https://{company}.flowlu.com/api/v1/module/st/portfolio/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "active": true, "status": 0, "archive_date": "string", "archive_description": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Project-portfolio/paths/~1st~1portfolio~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Project-portfolio/paths/~1st~1portfolio~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/st/portfolio/update/{id} https://{company}.flowlu.com/api/v1/module/st/portfolio/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "active": true, "status": 0, "archive_date": "string", "archive_description": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Project-portfolio/paths/~1st~1portfolio~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Project-portfolio/paths/~1st~1portfolio~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/st/portfolio/delete/{id} https://{company}.flowlu.com/api/v1/module/st/portfolio/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Project-portfolio/paths/~1st~1portfolio~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Project-portfolio/paths/~1st~1portfolio~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/st/portfolio/get/{id} https://{company}.flowlu.com/api/v1/module/st/portfolio/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "active": true, "status": 0, "archive_date": "string", "archive_description": "string", "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Project-portfolio/paths/~1st~1portfolio~1list/get](https://www.flowlu.com/api/\#tag/Project-portfolio/paths/~1st~1portfolio~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/st/portfolio/list https://{company}.flowlu.com/api/v1/module/st/portfolio/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "active": true,\ \ "status": 0,\ \ "archive_date": "string",\ \ "archive_description": "string",\ \ "ordering": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/CONFIG.M.ST.BASELINE.TITLE](https://www.flowlu.com/api/\#tag/CONFIG.M.ST.BASELINE.TITLE) CONFIG.M.ST.BASELINE.TITLE CONFIG.M.ST.BASELINE.DESC ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | project\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [items](https://www.flowlu.com/api/#tag/CONFIG.M.ST.BASELINE_ITEM.TITLE) | Projects | CONFIG.M.ST.BASELINE\_ITEM.TITLE | baseline\_id | ## [tag/CONFIG.M.ST.BASELINE.TITLE/paths/~1st~1project_baselines~1create/post](https://www.flowlu.com/api/\#tag/CONFIG.M.ST.BASELINE.TITLE/paths/~1st~1project_baselines~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | project\_id | integer
Project id | | name | string
Name | | created\_by | integer
User id | | updated\_by | integer
User id | | created\_at | string
Created date | | updated\_at | string
Updated date | ### Responses **200** Successfully create an item post/st/project\_baselines/create https://{company}.flowlu.com/api/v1/module/st/project\_baselines/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "name": "string", "created_by": 0, "updated_by": 0, "created_at": "string", "updated_at": "string" } }` ## [tag/CONFIG.M.ST.BASELINE.TITLE/paths/~1st~1project_baselines~1update~1{id}/post](https://www.flowlu.com/api/\#tag/CONFIG.M.ST.BASELINE.TITLE/paths/~1st~1project_baselines~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/st/project\_baselines/update/{id} https://{company}.flowlu.com/api/v1/module/st/project\_baselines/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "name": "string", "created_by": 0, "updated_by": 0, "created_at": "string", "updated_at": "string" } }` ## [tag/CONFIG.M.ST.BASELINE.TITLE/paths/~1st~1project_baselines~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/CONFIG.M.ST.BASELINE.TITLE/paths/~1st~1project_baselines~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/st/project\_baselines/delete/{id} https://{company}.flowlu.com/api/v1/module/st/project\_baselines/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/CONFIG.M.ST.BASELINE.TITLE/paths/~1st~1project_baselines~1get~1{id}/get](https://www.flowlu.com/api/\#tag/CONFIG.M.ST.BASELINE.TITLE/paths/~1st~1project_baselines~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/st/project\_baselines/get/{id} https://{company}.flowlu.com/api/v1/module/st/project\_baselines/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "project_id": 0, "name": "string", "created_by": 0, "updated_by": 0, "created_at": "string", "updated_at": "string" } }` ## [tag/CONFIG.M.ST.BASELINE.TITLE/paths/~1st~1project_baselines~1list/get](https://www.flowlu.com/api/\#tag/CONFIG.M.ST.BASELINE.TITLE/paths/~1st~1project_baselines~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/st/project\_baselines/list https://{company}.flowlu.com/api/v1/module/st/project\_baselines/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "project_id": 0,\ \ "name": "string",\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "created_at": "string",\ \ "updated_at": "string"\ \ }\ \ ] } }` ## [tag/CONFIG.M.ST.BASELINE_ITEM.TITLE](https://www.flowlu.com/api/\#tag/CONFIG.M.ST.BASELINE_ITEM.TITLE) CONFIG.M.ST.BASELINE\_ITEM.TITLE CONFIG.M.ST.BASELINE\_ITEM.DESC ## [tag/CONFIG.M.ST.BASELINE_ITEM.TITLE/paths/~1st~1project_baseline_items~1create/post](https://www.flowlu.com/api/\#tag/CONFIG.M.ST.BASELINE_ITEM.TITLE/paths/~1st~1project_baseline_items~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | baseline\_id | integer
CONFIG.M.ST.BASELINE\_ITEM.BASELINE\_ID.DESC | | task\_id | string
CONFIG.M.ST.BASELINE\_ITEM.TASK\_ID.DESC | | type | string
CONFIG.M.ST.BASELINE\_ITEM.TYPE.DESC | | start\_date | string
CONFIG.M.ST.BASELINE\_ITEM.START\_DATE.DESC | | end\_date | string
CONFIG.M.ST.BASELINE\_ITEM.END\_DATE.DESC | ### Responses **200** Successfully create an item post/st/project\_baseline\_items/create https://{company}.flowlu.com/api/v1/module/st/project\_baseline\_items/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "baseline_id": 0, "task_id": "string", "type": "string", "start_date": "string", "end_date": "string" } }` ## [tag/CONFIG.M.ST.BASELINE_ITEM.TITLE/paths/~1st~1project_baseline_items~1update~1{id}/post](https://www.flowlu.com/api/\#tag/CONFIG.M.ST.BASELINE_ITEM.TITLE/paths/~1st~1project_baseline_items~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/st/project\_baseline\_items/update/{id} https://{company}.flowlu.com/api/v1/module/st/project\_baseline\_items/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "baseline_id": 0, "task_id": "string", "type": "string", "start_date": "string", "end_date": "string" } }` ## [tag/CONFIG.M.ST.BASELINE_ITEM.TITLE/paths/~1st~1project_baseline_items~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/CONFIG.M.ST.BASELINE_ITEM.TITLE/paths/~1st~1project_baseline_items~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/st/project\_baseline\_items/delete/{id} https://{company}.flowlu.com/api/v1/module/st/project\_baseline\_items/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/CONFIG.M.ST.BASELINE_ITEM.TITLE/paths/~1st~1project_baseline_items~1get~1{id}/get](https://www.flowlu.com/api/\#tag/CONFIG.M.ST.BASELINE_ITEM.TITLE/paths/~1st~1project_baseline_items~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/st/project\_baseline\_items/get/{id} https://{company}.flowlu.com/api/v1/module/st/project\_baseline\_items/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "baseline_id": 0, "task_id": "string", "type": "string", "start_date": "string", "end_date": "string" } }` ## [tag/CONFIG.M.ST.BASELINE_ITEM.TITLE/paths/~1st~1project_baseline_items~1list/get](https://www.flowlu.com/api/\#tag/CONFIG.M.ST.BASELINE_ITEM.TITLE/paths/~1st~1project_baseline_items~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/st/project\_baseline\_items/list https://{company}.flowlu.com/api/v1/module/st/project\_baseline\_items/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "baseline_id": 0,\ \ "task_id": "string",\ \ "type": "string",\ \ "start_date": "string",\ \ "end_date": "string"\ \ }\ \ ] } }` ## [tag/Finance](https://www.flowlu.com/api/\#tag/Finance) Finance With the Finance, you can create and send estimates, issue invoices, manage revenue and costs, classify expenses and received payments with financial categories, manage cash flow and invoices of several organization, set up integration with major online payment gateway. ## [tag/Organization](https://www.flowlu.com/api/\#tag/Organization) Organization ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [payin](https://www.flowlu.com/api/#tag/Money) | Finance | Money | org\_id | | [invoices](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | org\_id | | [accounts](https://www.flowlu.com/api/#tag/Bank%20account) | Finance | Bank account | org\_id | | [estimates](https://www.flowlu.com/api/#tag/Estimate) | Finance | Estimate | org\_id | | [transactions](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | org\_id | | [transactions\_pls](https://www.flowlu.com/api/#tag/Transactions%20for%20the%20Profit%20and%20Loss%20statement) | Finance | Transactions for the Profit and Loss statement | org\_id | | [estimate\_templates](https://www.flowlu.com/api/#tag/Estimate%20template) | Finance | Estimate template | org\_id | | [plan\_money](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | org\_id | | [apars](https://www.flowlu.com/api/#tag/Payables%20&%20Receivables) | Payables & Receivables | Payables & Receivables | org\_id | | [loans](https://www.flowlu.com/api/#tag/Borrowed%20Loans) | Borrowed Loans | Borrowed Loans | org\_id | | [assets](https://www.flowlu.com/api/#tag/Fixed%20Asset) | Fixed Assets | Fixed Asset | org\_id | | [recurring\_invoice](https://www.flowlu.com/api/#tag/Recurring%20invoice) | Finance | Recurring invoice | org\_id | ## [tag/Organization/paths/~1fin~1organization~1create/post](https://www.flowlu.com/api/\#tag/Organization/paths/~1fin~1organization~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | legal\_name | string
Organization legal name | | contact\_person | string
First person | | contact\_person\_position | string
First contact position | | show\_add\_sign\_string | boolean
Show additional sigh string | | contact\_person2 | string
Secont contact | | contact\_person2\_position | string
Second contact position | | address1\_address | string
First Address | | address1\_city | string
First Address city | | address1\_state | string
First Address state | | address1\_zip | string
First Address ZIP | | address1\_country\_id | integer
First Address country id | | address2\_address | string
Second address | | address2\_city | string
Second address city | | address2\_state | string
Second address state | | address2\_zip | string
Second address ZIP | | address2\_country\_id | integer
Second country id | | company\_web | string
Company web | | company\_email | string
Company email | | company\_phone | string
Phone | | company\_phone2 | string
Company second phone | | company\_mobile | string
Company mobile | | company\_fax | string
Company fax | | vat | string
Business Tax ID | | vat2 | string
Additional Account VAT (or TAX ID) | | registration\_number | string
Business Registration Number | | registration\_number\_date | string
Business Registration Number date | | tax1 | number
Tax 1 (%) | | tax1\_included | boolean
1 - Include in price
0 - Not included | | tax2 | number
Tax 2 (%) | | tax2\_included | boolean
TAX2:
1 - Include in price
0 - Not included | | use\_manual\_taxes | integer
CONFIG.USE\_MANUAL\_TAXES.DESC | | tax\_country\_id | integer
CONFIG.TAX\_COUNTRY\_ID.DESC | | tax\_country\_included | integer
CONFIG.TAX\_COUNTRY\_INCLUDED.DESC | | invoice\_enabled | boolean
Invoice enabled | | invoice\_logo | integer
Invoice logo | | invoice\_print\_sign | integer
invoice print sign | | invoice\_color | string
Invoice color | | invoice\_prefix | string
Invoice prefix | | act\_prefix | string
Act prefix | | reconciliation\_act\_prefix | string
Act prefix | | advance\_invoice\_prefix | string
Prefix of the advance invoice | | estimate\_prefix | string
Estimate prefix | | estimate\_start\_number | integer
Estimate start number | | invoice\_due | integer
invoice due | | invoice\_start\_number | integer
Invoice start number | | act\_start\_number | integer
Initial act number | | reconciliation\_act\_start\_number | integer
Initial reconciliation act number | | advance\_invoice\_start\_number | integer
Starting number of the advance invoice | | invoice\_show\_taxes | boolean
Invoice show taxes | | invoice\_footer | string
Invoice footer | | invoice\_terms | string
Invoice terms | | active | integer
If = 0, Inactive.
Default value = 1. | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | comment | string
Comment | | default\_organization | integer
Default organization:
1 - Yes
0 - No | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | ### Responses **200** Successfully create an item post/fin/organization/create https://{company}.flowlu.com/api/v1/module/fin/organization/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "legal_name": "string", "contact_person": "string", "contact_person_position": "string", "show_add_sign_string": true, "contact_person2": "string", "contact_person2_position": "string", "address1_address": "string", "address1_city": "string", "address1_state": "string", "address1_zip": "string", "address1_country_id": 0, "address2_address": "string", "address2_city": "string", "address2_state": "string", "address2_zip": "string", "address2_country_id": 0, "company_web": "string", "company_email": "string", "company_phone": "string", "company_phone2": "string", "company_mobile": "string", "company_fax": "string", "vat": "string", "vat2": "string", "registration_number": "string", "registration_number_date": "string", "tax1": 0, "tax1_included": true, "tax2": 0, "tax2_included": true, "use_manual_taxes": 0, "tax_country_id": 0, "tax_country_included": 0, "invoice_enabled": true, "invoice_logo": 0, "invoice_print_sign": 0, "invoice_color": "string", "invoice_prefix": "string", "act_prefix": "string", "reconciliation_act_prefix": "string", "advance_invoice_prefix": "string", "estimate_prefix": "string", "estimate_start_number": 0, "invoice_due": 0, "invoice_start_number": 0, "act_start_number": 0, "reconciliation_act_start_number": 0, "advance_invoice_start_number": 0, "invoice_show_taxes": true, "invoice_footer": "string", "invoice_terms": "string", "active": 0, "ordering": 0, "comment": "string", "default_organization": 0, "ref": "string", "ref_id": "string" } }` ## [tag/Organization/paths/~1fin~1organization~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Organization/paths/~1fin~1organization~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/organization/update/{id} https://{company}.flowlu.com/api/v1/module/fin/organization/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "legal_name": "string", "contact_person": "string", "contact_person_position": "string", "show_add_sign_string": true, "contact_person2": "string", "contact_person2_position": "string", "address1_address": "string", "address1_city": "string", "address1_state": "string", "address1_zip": "string", "address1_country_id": 0, "address2_address": "string", "address2_city": "string", "address2_state": "string", "address2_zip": "string", "address2_country_id": 0, "company_web": "string", "company_email": "string", "company_phone": "string", "company_phone2": "string", "company_mobile": "string", "company_fax": "string", "vat": "string", "vat2": "string", "registration_number": "string", "registration_number_date": "string", "tax1": 0, "tax1_included": true, "tax2": 0, "tax2_included": true, "use_manual_taxes": 0, "tax_country_id": 0, "tax_country_included": 0, "invoice_enabled": true, "invoice_logo": 0, "invoice_print_sign": 0, "invoice_color": "string", "invoice_prefix": "string", "act_prefix": "string", "reconciliation_act_prefix": "string", "advance_invoice_prefix": "string", "estimate_prefix": "string", "estimate_start_number": 0, "invoice_due": 0, "invoice_start_number": 0, "act_start_number": 0, "reconciliation_act_start_number": 0, "advance_invoice_start_number": 0, "invoice_show_taxes": true, "invoice_footer": "string", "invoice_terms": "string", "active": 0, "ordering": 0, "comment": "string", "default_organization": 0, "ref": "string", "ref_id": "string" } }` ## [tag/Organization/paths/~1fin~1organization~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Organization/paths/~1fin~1organization~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/organization/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/organization/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Organization/paths/~1fin~1organization~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Organization/paths/~1fin~1organization~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/organization/get/{id} https://{company}.flowlu.com/api/v1/module/fin/organization/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "legal_name": "string", "contact_person": "string", "contact_person_position": "string", "show_add_sign_string": true, "contact_person2": "string", "contact_person2_position": "string", "address1_address": "string", "address1_city": "string", "address1_state": "string", "address1_zip": "string", "address1_country_id": 0, "address2_address": "string", "address2_city": "string", "address2_state": "string", "address2_zip": "string", "address2_country_id": 0, "company_web": "string", "company_email": "string", "company_phone": "string", "company_phone2": "string", "company_mobile": "string", "company_fax": "string", "vat": "string", "vat2": "string", "registration_number": "string", "registration_number_date": "string", "tax1": 0, "tax1_included": true, "tax2": 0, "tax2_included": true, "use_manual_taxes": 0, "tax_country_id": 0, "tax_country_included": 0, "invoice_enabled": true, "invoice_logo": 0, "invoice_print_sign": 0, "invoice_color": "string", "invoice_prefix": "string", "act_prefix": "string", "reconciliation_act_prefix": "string", "advance_invoice_prefix": "string", "estimate_prefix": "string", "estimate_start_number": 0, "invoice_due": 0, "invoice_start_number": 0, "act_start_number": 0, "reconciliation_act_start_number": 0, "advance_invoice_start_number": 0, "invoice_show_taxes": true, "invoice_footer": "string", "invoice_terms": "string", "active": 0, "ordering": 0, "comment": "string", "default_organization": 0, "ref": "string", "ref_id": "string" } }` ## [tag/Organization/paths/~1fin~1organization~1list/get](https://www.flowlu.com/api/\#tag/Organization/paths/~1fin~1organization~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/organization/list https://{company}.flowlu.com/api/v1/module/fin/organization/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "legal_name": "string",\ \ "contact_person": "string",\ \ "contact_person_position": "string",\ \ "show_add_sign_string": true,\ \ "contact_person2": "string",\ \ "contact_person2_position": "string",\ \ "address1_address": "string",\ \ "address1_city": "string",\ \ "address1_state": "string",\ \ "address1_zip": "string",\ \ "address1_country_id": 0,\ \ "address2_address": "string",\ \ "address2_city": "string",\ \ "address2_state": "string",\ \ "address2_zip": "string",\ \ "address2_country_id": 0,\ \ "company_web": "string",\ \ "company_email": "string",\ \ "company_phone": "string",\ \ "company_phone2": "string",\ \ "company_mobile": "string",\ \ "company_fax": "string",\ \ "vat": "string",\ \ "vat2": "string",\ \ "registration_number": "string",\ \ "registration_number_date": "string",\ \ "tax1": 0,\ \ "tax1_included": true,\ \ "tax2": 0,\ \ "tax2_included": true,\ \ "use_manual_taxes": 0,\ \ "tax_country_id": 0,\ \ "tax_country_included": 0,\ \ "invoice_enabled": true,\ \ "invoice_logo": 0,\ \ "invoice_print_sign": 0,\ \ "invoice_color": "string",\ \ "invoice_prefix": "string",\ \ "act_prefix": "string",\ \ "reconciliation_act_prefix": "string",\ \ "advance_invoice_prefix": "string",\ \ "estimate_prefix": "string",\ \ "estimate_start_number": 0,\ \ "invoice_due": 0,\ \ "invoice_start_number": 0,\ \ "act_start_number": 0,\ \ "reconciliation_act_start_number": 0,\ \ "advance_invoice_start_number": 0,\ \ "invoice_show_taxes": true,\ \ "invoice_footer": "string",\ \ "invoice_terms": "string",\ \ "active": 0,\ \ "ordering": 0,\ \ "comment": "string",\ \ "default_organization": 0,\ \ "ref": "string",\ \ "ref_id": "string"\ \ }\ \ ] } }` ## [tag/Invoice](https://www.flowlu.com/api/\#tag/Invoice) Invoice ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | | | [org\_account](https://www.flowlu.com/api/#tag/Bank%20account) | Finance | Bank account | org\_account\_id | | | [client](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | customer\_id | | | [pricelist](https://www.flowlu.com/api/#tag/Price%20list) | Products & Services | Price list | pricelist\_id | | | [estimate](https://www.flowlu.com/api/#tag/Estimate) | Finance | Estimate | estimate\_id | | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | model\_id | module = st, model = project | | [template](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | template\_id | | | [recurring\_invoice](https://www.flowlu.com/api/#tag/Recurring%20invoice) | Finance | Recurring invoice | recurring\_invoice\_id | | | [plan\_money](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | plan\_money\_id | | #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [contacts](https://www.flowlu.com/api/#tag/Invoice%20contacts) | Finance | Invoice contacts | invoice\_id | | | [items](https://www.flowlu.com/api/#tag/Invoice%20items) | Finance | Invoice items | invoice\_id | | | [transactions\_in](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | invoice\_id | type = 10 | | [transactions\_pls](https://www.flowlu.com/api/#tag/Transactions%20for%20the%20Profit%20and%20Loss%20statement) | Finance | Transactions for the Profit and Loss statement | invoice\_id | | | [task\_invoicing\_logs](https://www.flowlu.com/api/#tag/Payment%20logs%20for%20fixed%20cost%20tasks) | Tasks | Payment logs for fixed cost tasks | invoice\_id | | ## [tag/Invoice/paths/~1fin~1invoice~1create/post](https://www.flowlu.com/api/\#tag/Invoice/paths/~1fin~1invoice~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | active | boolean
If = 0, Inactive.
Default value = 1. | | invoice\_number | integer
Invoice number | | invoice\_number\_print | string
Invoice print number | | assignee\_id | integer
Assigned user id | | category\_id | integer
Category id Default- 0 | | customer\_name | string
Customer name | | note | string
Note | | customer\_legal\_name | string
Customer legal name | | contact\_person | string
Contact | | contact\_person\_position | string
Contact position | | show\_add\_sign\_string | boolean
Show additional sigh string | | contact\_person2 | string
Secont contact | | contact\_person2\_position | string
Second contact position | | invoice\_date | string
Invoice date | | due\_date | string
Due date | | status\_id | integer
Status id:
5 - Empty
10 - New
12 - Need aproove
13 - Approved
20 - Partially Paid
30 - Overpaid
40 - Paid | | template\_id | integer
Invoice template id | | currency\_id | integer
Currency symbol | | use\_multiple\_pm | boolean
Use of multiple linking to planned payments (Deprecated) | | ps\_currency\_id | integer
Currency Id of estimated revenue | | plan\_money\_id | integer
Estimated Payment id | | pm\_currency\_id | integer
Currency of estimated revenue | | plan\_money\_total | bcy\_price
Amount of estimated revenue | | doc\_id | integer
Contract ID | | currency\_code | string
Currency code | | sub\_total | number
Subtotal | | tax\_total | number
Tax total | | total | number
Total | | bcy\_paid\_total | bcy\_price
Amount in the account's base currency | | pscy\_paid\_total | bcy\_price
Amount in the currency of estimated revenue | | shipping\_charge | number
Shipping charge | | adjustment | number
Adjustment | | adjustment\_description | string
Adjustment description | | discount | number
Discount | | discount\_before\_tax | boolean
Discount before tax | | is\_invoice\_emailed | boolean
Email status.
1 - Sended
0 - Not sended | | invoice\_emailed\_date | string
Invoice emailed date | | is\_reminder\_sent | boolean
Remainder sent | | reminders\_sent\_date | string
Sent date | | payment\_options | string
Payment options | | invoice\_footer\_text | string
Custom Note | | invoice\_terms\_text | string
CONFIG.M.FIN.INVOICE.INVOICE\_TERMS\_TEXT.DESCTerms and Conditions | | bill\_from\_address | string
Bill from address | | bill\_from\_city | string
Bill from city | | bill\_from\_state | string
Bill from state | | bill\_from\_zip | string
Bill from zip | | bill\_from\_country\_id | integer
Bill from country | | bill\_to\_address | string
Address | | bill\_to\_city | string
Bill to city | | bill\_to\_state | string
Bill to state | | bill\_to\_zip | string
Bill to ZIP | | bill\_to\_country\_id | integer
Country ID | | client\_shipping\_address | string
Legal address of the payer | | client\_shipping\_city | string
Country (current address) | | client\_shipping\_state | string
State/Region (current address) | | client\_shipping\_zip | string
ZIP code (current address) | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | module | string
Module | | model | string
Model | | model\_id | integer
Model id | | group\_id | integer
Group id | | org\_id | integer
Organization id | | org\_account\_id | integer
Organization account id | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | | company\_phone | string
Phone | | company\_phone2 | string
Company second phone | | company\_vat | string
Business Tax ID | | company\_vat2 | string
Additional Account VAT (or TAX ID) | | org\_phone | string
Organization phone | | org\_phone2 | string
Organization phone | | org\_vat | string
Business Tax ID | | org\_vat2 | string
Additional Account VAT (or TAX ID) | | tax1 | number
Tax 1 (%) | | tax2 | number
Tax 2 (%) | | tax1\_included | boolean
1 - Include in price
0 - Not included | | tax2\_included | boolean
TAX2:
1 - Include in price
0 - Not included | | is\_discount\_percent | boolean
Is discount percent (Default - 1):
1 - Yes
0 - No
Default - 1 | | customer\_id | integer
Customer id | | uuid | string
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer systems | | type | integer
Invoice type | | is\_template | boolean
Is template:
1 - Yes
0 - No | | template\_name | string
Template name | | pricelist\_id | integer
Price list id | | bank\_id | integer
Bank id | | bank | string
Bank name | | paymethod\_id | integer
Print templates id | | estimate\_id | integer
Estimate id | | exported\_1c | boolean
Exported 1C | | reference | string
Name of the import source of the object (system, etc.) | | paid\_date | string
Paid date | | recurring\_invoice\_id | integer
Recurring invoice id | ### Responses **200** Successfully create an item post/fin/invoice/create https://{company}.flowlu.com/api/v1/module/fin/invoice/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "active": true, "invoice_number": 0, "invoice_number_print": "string", "assignee_id": 0, "category_id": 0, "customer_name": "string", "note": "string", "customer_legal_name": "string", "contact_person": "string", "contact_person_position": "string", "show_add_sign_string": true, "contact_person2": "string", "contact_person2_position": "string", "invoice_date": "string", "due_date": "string", "status_id": 0, "template_id": 0, "currency_id": 0, "use_multiple_pm": true, "ps_currency_id": 0, "plan_money_id": 0, "pm_currency_id": 0, "plan_money_total": null, "doc_id": 0, "currency_code": "string", "sub_total": 0, "tax_total": 0, "total": 0, "bcy_paid_total": null, "pscy_paid_total": null, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "discount": 0, "discount_before_tax": true, "is_invoice_emailed": true, "invoice_emailed_date": "string", "is_reminder_sent": true, "reminders_sent_date": "string", "payment_options": "string", "invoice_footer_text": "string", "invoice_terms_text": "string", "bill_from_address": "string", "bill_from_city": "string", "bill_from_state": "string", "bill_from_zip": "string", "bill_from_country_id": 0, "bill_to_address": "string", "bill_to_city": "string", "bill_to_state": "string", "bill_to_zip": "string", "bill_to_country_id": 0, "client_shipping_address": "string", "client_shipping_city": "string", "client_shipping_state": "string", "client_shipping_zip": "string", "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "module": "string", "model": "string", "model_id": 0, "group_id": 0, "org_id": 0, "org_account_id": 0, "ref": "string", "ref_id": "string", "company_phone": "string", "company_phone2": "string", "company_vat": "string", "company_vat2": "string", "org_phone": "string", "org_phone2": "string", "org_vat": "string", "org_vat2": "string", "tax1": 0, "tax2": 0, "tax1_included": true, "tax2_included": true, "is_discount_percent": true, "customer_id": 0, "uuid": "string", "type": 0, "is_template": true, "template_name": "string", "pricelist_id": 0, "bank_id": 0, "bank": "string", "paymethod_id": 0, "estimate_id": 0, "exported_1c": true, "reference": "string", "paid_date": "string", "recurring_invoice_id": 0 } }` ## [tag/Invoice/paths/~1fin~1invoice~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Invoice/paths/~1fin~1invoice~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/invoice/update/{id} https://{company}.flowlu.com/api/v1/module/fin/invoice/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "active": true, "invoice_number": 0, "invoice_number_print": "string", "assignee_id": 0, "category_id": 0, "customer_name": "string", "note": "string", "customer_legal_name": "string", "contact_person": "string", "contact_person_position": "string", "show_add_sign_string": true, "contact_person2": "string", "contact_person2_position": "string", "invoice_date": "string", "due_date": "string", "status_id": 0, "template_id": 0, "currency_id": 0, "use_multiple_pm": true, "ps_currency_id": 0, "plan_money_id": 0, "pm_currency_id": 0, "plan_money_total": null, "doc_id": 0, "currency_code": "string", "sub_total": 0, "tax_total": 0, "total": 0, "bcy_paid_total": null, "pscy_paid_total": null, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "discount": 0, "discount_before_tax": true, "is_invoice_emailed": true, "invoice_emailed_date": "string", "is_reminder_sent": true, "reminders_sent_date": "string", "payment_options": "string", "invoice_footer_text": "string", "invoice_terms_text": "string", "bill_from_address": "string", "bill_from_city": "string", "bill_from_state": "string", "bill_from_zip": "string", "bill_from_country_id": 0, "bill_to_address": "string", "bill_to_city": "string", "bill_to_state": "string", "bill_to_zip": "string", "bill_to_country_id": 0, "client_shipping_address": "string", "client_shipping_city": "string", "client_shipping_state": "string", "client_shipping_zip": "string", "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "module": "string", "model": "string", "model_id": 0, "group_id": 0, "org_id": 0, "org_account_id": 0, "ref": "string", "ref_id": "string", "company_phone": "string", "company_phone2": "string", "company_vat": "string", "company_vat2": "string", "org_phone": "string", "org_phone2": "string", "org_vat": "string", "org_vat2": "string", "tax1": 0, "tax2": 0, "tax1_included": true, "tax2_included": true, "is_discount_percent": true, "customer_id": 0, "uuid": "string", "type": 0, "is_template": true, "template_name": "string", "pricelist_id": 0, "bank_id": 0, "bank": "string", "paymethod_id": 0, "estimate_id": 0, "exported_1c": true, "reference": "string", "paid_date": "string", "recurring_invoice_id": 0 } }` ## [tag/Invoice/paths/~1fin~1invoice~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Invoice/paths/~1fin~1invoice~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/invoice/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/invoice/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Invoice/paths/~1fin~1invoice~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Invoice/paths/~1fin~1invoice~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/invoice/get/{id} https://{company}.flowlu.com/api/v1/module/fin/invoice/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "active": true, "invoice_number": 0, "invoice_number_print": "string", "assignee_id": 0, "category_id": 0, "customer_name": "string", "note": "string", "customer_legal_name": "string", "contact_person": "string", "contact_person_position": "string", "show_add_sign_string": true, "contact_person2": "string", "contact_person2_position": "string", "invoice_date": "string", "due_date": "string", "status_id": 0, "template_id": 0, "currency_id": 0, "use_multiple_pm": true, "ps_currency_id": 0, "plan_money_id": 0, "pm_currency_id": 0, "plan_money_total": null, "doc_id": 0, "currency_code": "string", "sub_total": 0, "tax_total": 0, "total": 0, "bcy_paid_total": null, "pscy_paid_total": null, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "discount": 0, "discount_before_tax": true, "is_invoice_emailed": true, "invoice_emailed_date": "string", "is_reminder_sent": true, "reminders_sent_date": "string", "payment_options": "string", "invoice_footer_text": "string", "invoice_terms_text": "string", "bill_from_address": "string", "bill_from_city": "string", "bill_from_state": "string", "bill_from_zip": "string", "bill_from_country_id": 0, "bill_to_address": "string", "bill_to_city": "string", "bill_to_state": "string", "bill_to_zip": "string", "bill_to_country_id": 0, "client_shipping_address": "string", "client_shipping_city": "string", "client_shipping_state": "string", "client_shipping_zip": "string", "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "module": "string", "model": "string", "model_id": 0, "group_id": 0, "org_id": 0, "org_account_id": 0, "ref": "string", "ref_id": "string", "company_phone": "string", "company_phone2": "string", "company_vat": "string", "company_vat2": "string", "org_phone": "string", "org_phone2": "string", "org_vat": "string", "org_vat2": "string", "tax1": 0, "tax2": 0, "tax1_included": true, "tax2_included": true, "is_discount_percent": true, "customer_id": 0, "uuid": "string", "type": 0, "is_template": true, "template_name": "string", "pricelist_id": 0, "bank_id": 0, "bank": "string", "paymethod_id": 0, "estimate_id": 0, "exported_1c": true, "reference": "string", "paid_date": "string", "recurring_invoice_id": 0 } }` ## [tag/Invoice/paths/~1fin~1invoice~1list/get](https://www.flowlu.com/api/\#tag/Invoice/paths/~1fin~1invoice~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/invoice/list https://{company}.flowlu.com/api/v1/module/fin/invoice/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "active": true,\ \ "invoice_number": 0,\ \ "invoice_number_print": "string",\ \ "assignee_id": 0,\ \ "category_id": 0,\ \ "customer_name": "string",\ \ "note": "string",\ \ "customer_legal_name": "string",\ \ "contact_person": "string",\ \ "contact_person_position": "string",\ \ "show_add_sign_string": true,\ \ "contact_person2": "string",\ \ "contact_person2_position": "string",\ \ "invoice_date": "string",\ \ "due_date": "string",\ \ "status_id": 0,\ \ "template_id": 0,\ \ "currency_id": 0,\ \ "use_multiple_pm": true,\ \ "ps_currency_id": 0,\ \ "plan_money_id": 0,\ \ "pm_currency_id": 0,\ \ "plan_money_total": null,\ \ "doc_id": 0,\ \ "currency_code": "string",\ \ "sub_total": 0,\ \ "tax_total": 0,\ \ "total": 0,\ \ "bcy_paid_total": null,\ \ "pscy_paid_total": null,\ \ "shipping_charge": 0,\ \ "adjustment": 0,\ \ "adjustment_description": "string",\ \ "discount": 0,\ \ "discount_before_tax": true,\ \ "is_invoice_emailed": true,\ \ "invoice_emailed_date": "string",\ \ "is_reminder_sent": true,\ \ "reminders_sent_date": "string",\ \ "payment_options": "string",\ \ "invoice_footer_text": "string",\ \ "invoice_terms_text": "string",\ \ "bill_from_address": "string",\ \ "bill_from_city": "string",\ \ "bill_from_state": "string",\ \ "bill_from_zip": "string",\ \ "bill_from_country_id": 0,\ \ "bill_to_address": "string",\ \ "bill_to_city": "string",\ \ "bill_to_state": "string",\ \ "bill_to_zip": "string",\ \ "bill_to_country_id": 0,\ \ "client_shipping_address": "string",\ \ "client_shipping_city": "string",\ \ "client_shipping_state": "string",\ \ "client_shipping_zip": "string",\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "module": "string",\ \ "model": "string",\ \ "model_id": 0,\ \ "group_id": 0,\ \ "org_id": 0,\ \ "org_account_id": 0,\ \ "ref": "string",\ \ "ref_id": "string",\ \ "company_phone": "string",\ \ "company_phone2": "string",\ \ "company_vat": "string",\ \ "company_vat2": "string",\ \ "org_phone": "string",\ \ "org_phone2": "string",\ \ "org_vat": "string",\ \ "org_vat2": "string",\ \ "tax1": 0,\ \ "tax2": 0,\ \ "tax1_included": true,\ \ "tax2_included": true,\ \ "is_discount_percent": true,\ \ "customer_id": 0,\ \ "uuid": "string",\ \ "type": 0,\ \ "is_template": true,\ \ "template_name": "string",\ \ "pricelist_id": 0,\ \ "bank_id": 0,\ \ "bank": "string",\ \ "paymethod_id": 0,\ \ "estimate_id": 0,\ \ "exported_1c": true,\ \ "reference": "string",\ \ "paid_date": "string",\ \ "recurring_invoice_id": 0\ \ }\ \ ] } }` ## [tag/Business-line](https://www.flowlu.com/api/\#tag/Business-line) Business line ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [transactions](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | business\_line\_id | | [transactions\_pls](https://www.flowlu.com/api/#tag/Transactions%20for%20the%20Profit%20and%20Loss%20statement) | Finance | Transactions for the Profit and Loss statement | business\_line\_id | ## [tag/Business-line/paths/~1fin~1business_line~1create/post](https://www.flowlu.com/api/\#tag/Business-line/paths/~1fin~1business_line~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | active | integer
If = 0, Inactive.
Default value = 1. | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/fin/business\_line/create https://{company}.flowlu.com/api/v1/module/fin/business\_line/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": 0, "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Business-line/paths/~1fin~1business_line~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Business-line/paths/~1fin~1business_line~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/business\_line/update/{id} https://{company}.flowlu.com/api/v1/module/fin/business\_line/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": 0, "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Business-line/paths/~1fin~1business_line~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Business-line/paths/~1fin~1business_line~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/business\_line/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/business\_line/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Business-line/paths/~1fin~1business_line~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Business-line/paths/~1fin~1business_line~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/business\_line/get/{id} https://{company}.flowlu.com/api/v1/module/fin/business\_line/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": 0, "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Business-line/paths/~1fin~1business_line~1list/get](https://www.flowlu.com/api/\#tag/Business-line/paths/~1fin~1business_line~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/business\_line/list https://{company}.flowlu.com/api/v1/module/fin/business\_line/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "active": 0,\ \ "ordering": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Invoice-items](https://www.flowlu.com/api/\#tag/Invoice-items) Invoice items ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [invoice](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | invoice\_id | | [product\_item](https://www.flowlu.com/api/#tag/Items) | Products & Services | Items | item\_id | | [plan\_money](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | plan\_money\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [relations](https://www.flowlu.com/api/#tag/Linking%20the%20invoice%20items) | Finance | Linking the invoice items | invoice\_item\_id | ## [tag/Invoice-items/paths/~1fin~1invoice_item~1create/post](https://www.flowlu.com/api/\#tag/Invoice-items/paths/~1fin~1invoice_item~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | invoice\_id | integer
Invoice ID | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | item\_id | integer
Item id | | plan\_money\_id | integer
Estimated Payment id | | name | string
Name | | description | string
Description | | unit\_price | number
Unit price | | unit\_id | integer
Item unit id | | quantity | tax
Quantity | | tax1 | number
Tax 1 (%) | | tax1\_included | boolean
1 - Include in price
0 - Not included | | tax1\_amount | number
Tax amount | | tax2 | number
Tax 2 (%) | | tax2\_included | boolean
TAX2:
1 - Include in price
0 - Not included | | tax2\_amount | number
Tax | | discount\_amount | number
Discount amount (calculated field based on discount) | | discount | string
Discount | | discount\_is\_percent | integer
Is discount percent (Default - 1):
1 - Yes
0 - No
Default - 1 | | sub\_total | number
Subtotal | | tax\_total | tax
Tax total | | tax\_displayed | string
The tax value displayed in printed forms (%) | | total | number
Total | | paid\_total | number
Paid sum | | bcy\_paid\_total | bcy\_price
Amount in the account's base currency | | plan\_money\_total | bcy\_price
Amount of estimated revenue | | paid\_date | string
Paid date | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | | online\_payment\_type | integer
Attribute of payment method when using online fiscalization | | online\_payment\_subject\_type | integer
Attribute of settlement item when using online fiscalization | | online\_payment\_vat | integer
VAT when using online fiscalization | | type | integer
10 - Line
20 - Header | ### Responses **200** Successfully create an item post/fin/invoice\_item/create https://{company}.flowlu.com/api/v1/module/fin/invoice\_item/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "invoice_id": 0, "ordering": 0, "item_id": 0, "plan_money_id": 0, "name": "string", "description": "string", "unit_price": 0, "unit_id": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": 0, "sub_total": 0, "tax_total": null, "tax_displayed": "string", "total": 0, "paid_total": 0, "bcy_paid_total": null, "plan_money_total": null, "paid_date": "string", "ref": "string", "ref_id": "string", "online_payment_type": 0, "online_payment_subject_type": 0, "online_payment_vat": 0, "type": 0 } }` ## [tag/Invoice-items/paths/~1fin~1invoice_item~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Invoice-items/paths/~1fin~1invoice_item~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/invoice\_item/update/{id} https://{company}.flowlu.com/api/v1/module/fin/invoice\_item/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "invoice_id": 0, "ordering": 0, "item_id": 0, "plan_money_id": 0, "name": "string", "description": "string", "unit_price": 0, "unit_id": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": 0, "sub_total": 0, "tax_total": null, "tax_displayed": "string", "total": 0, "paid_total": 0, "bcy_paid_total": null, "plan_money_total": null, "paid_date": "string", "ref": "string", "ref_id": "string", "online_payment_type": 0, "online_payment_subject_type": 0, "online_payment_vat": 0, "type": 0 } }` ## [tag/Invoice-items/paths/~1fin~1invoice_item~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Invoice-items/paths/~1fin~1invoice_item~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/invoice\_item/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/invoice\_item/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Invoice-items/paths/~1fin~1invoice_item~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Invoice-items/paths/~1fin~1invoice_item~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/invoice\_item/get/{id} https://{company}.flowlu.com/api/v1/module/fin/invoice\_item/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "invoice_id": 0, "ordering": 0, "item_id": 0, "plan_money_id": 0, "name": "string", "description": "string", "unit_price": 0, "unit_id": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": 0, "sub_total": 0, "tax_total": null, "tax_displayed": "string", "total": 0, "paid_total": 0, "bcy_paid_total": null, "plan_money_total": null, "paid_date": "string", "ref": "string", "ref_id": "string", "online_payment_type": 0, "online_payment_subject_type": 0, "online_payment_vat": 0, "type": 0 } }` ## [tag/Invoice-items/paths/~1fin~1invoice_item~1list/get](https://www.flowlu.com/api/\#tag/Invoice-items/paths/~1fin~1invoice_item~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/invoice\_item/list https://{company}.flowlu.com/api/v1/module/fin/invoice\_item/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "invoice_id": 0,\ \ "ordering": 0,\ \ "item_id": 0,\ \ "plan_money_id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "unit_price": 0,\ \ "unit_id": 0,\ \ "quantity": null,\ \ "tax1": 0,\ \ "tax1_included": true,\ \ "tax1_amount": 0,\ \ "tax2": 0,\ \ "tax2_included": true,\ \ "tax2_amount": 0,\ \ "discount_amount": 0,\ \ "discount": "string",\ \ "discount_is_percent": 0,\ \ "sub_total": 0,\ \ "tax_total": null,\ \ "tax_displayed": "string",\ \ "total": 0,\ \ "paid_total": 0,\ \ "bcy_paid_total": null,\ \ "plan_money_total": null,\ \ "paid_date": "string",\ \ "ref": "string",\ \ "ref_id": "string",\ \ "online_payment_type": 0,\ \ "online_payment_subject_type": 0,\ \ "online_payment_vat": 0,\ \ "type": 0\ \ }\ \ ] } }` ## [tag/Money](https://www.flowlu.com/api/\#tag/Money) Money The Money section includes payments, expenses and transfers. Based on these records, you can create several transactions for different financial categories and, if needed, link them to different projects and invoices. ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [company](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | crm\_company\_id | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | | [org\_account](https://www.flowlu.com/api/#tag/Bank%20account) | Finance | Bank account | bank\_account\_id | | [accounts](https://www.flowlu.com/api/#tag/Bank%20account) | Finance | Bank account | bank\_account\_id | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | project\_id | | [project\_stage](https://www.flowlu.com/api/#tag/Project%20stages) | Projects | Project stages | project\_stage\_id | #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [transactions](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | reference\_id | | | [transactions\_pls](https://www.flowlu.com/api/#tag/Transactions%20for%20the%20Profit%20and%20Loss%20statement) | Finance | Transactions for the Profit and Loss statement | reference\_id | | | [transactions\_in](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | reference\_id | type = 10 | | [transactions\_out](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | reference\_id | type = 20 | ## [tag/Money/paths/~1fin~1customer_payment~1create/post](https://www.flowlu.com/api/\#tag/Money/paths/~1fin~1customer_payment~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | created\_date | string
Created date | | created\_by | integer
User id | | total | number
Total | | charge | number
Customer payment charge | | date | string
Date | | reference | string
Name of the import source of the object (system, etc.) | | owner\_id | integer
Assigned user id | | status | integer
Status
0 - New
10 - Executed | | status\_pls | integer
P&L accounting flag
- 0 — P&L off
- 1 — P&L on
For transfer type — always 0. | | org\_id | integer
Organization id | | bank\_account\_id | integer
Organization account id | | currency\_id | integer
Currency symbol | | description | string
Description | | crm\_company\_id | integer
CRM company id | | type | integer
Type:
10 - Payment
11 - Project Payment
20 - Expense
21 - Project Expense
30 - Transfer
40 - Return | | startdate | string
Start date | | enddate | string
End date | | complete\_date | string
Complete date | | is\_complete | boolean
Is complete | | is\_manual | boolean
Manual edited document | | is\_owed | boolean
Accounts Payable to Vendor | | project\_id | integer
Project id | | updated\_by | integer
User id | | project\_stage\_id | integer
The identifier of the stage in which the project is currently located, stages are created manually in projects. | | updated\_date | string
Updated date | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | | ref\_uuid | string
Reference UUID | | uuid | string
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer systems | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | need\_approve | boolean
Needs approval | ### Responses **200** Successfully create an item post/fin/customer\_payment/create https://{company}.flowlu.com/api/v1/module/fin/customer\_payment/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_date": "string", "created_by": 0, "total": 0, "charge": 0, "date": "string", "reference": "string", "owner_id": 0, "status": 0, "status_pls": 0, "org_id": 0, "bank_account_id": 0, "currency_id": 0, "description": "string", "crm_company_id": 0, "type": 0, "startdate": "string", "enddate": "string", "complete_date": "string", "is_complete": true, "is_manual": true, "is_owed": true, "project_id": 0, "updated_by": 0, "project_stage_id": 0, "updated_date": "string", "ref": "string", "ref_id": "string", "ref_uuid": "string", "uuid": "string", "ordering": 0, "need_approve": true } }` ## [tag/Money/paths/~1fin~1customer_payment~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Money/paths/~1fin~1customer_payment~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/customer\_payment/update/{id} https://{company}.flowlu.com/api/v1/module/fin/customer\_payment/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_date": "string", "created_by": 0, "total": 0, "charge": 0, "date": "string", "reference": "string", "owner_id": 0, "status": 0, "status_pls": 0, "org_id": 0, "bank_account_id": 0, "currency_id": 0, "description": "string", "crm_company_id": 0, "type": 0, "startdate": "string", "enddate": "string", "complete_date": "string", "is_complete": true, "is_manual": true, "is_owed": true, "project_id": 0, "updated_by": 0, "project_stage_id": 0, "updated_date": "string", "ref": "string", "ref_id": "string", "ref_uuid": "string", "uuid": "string", "ordering": 0, "need_approve": true } }` ## [tag/Money/paths/~1fin~1customer_payment~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Money/paths/~1fin~1customer_payment~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/customer\_payment/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/customer\_payment/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Money/paths/~1fin~1customer_payment~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Money/paths/~1fin~1customer_payment~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/customer\_payment/get/{id} https://{company}.flowlu.com/api/v1/module/fin/customer\_payment/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "created_date": "string", "created_by": 0, "total": 0, "charge": 0, "date": "string", "reference": "string", "owner_id": 0, "status": 0, "status_pls": 0, "org_id": 0, "bank_account_id": 0, "currency_id": 0, "description": "string", "crm_company_id": 0, "type": 0, "startdate": "string", "enddate": "string", "complete_date": "string", "is_complete": true, "is_manual": true, "is_owed": true, "project_id": 0, "updated_by": 0, "project_stage_id": 0, "updated_date": "string", "ref": "string", "ref_id": "string", "ref_uuid": "string", "uuid": "string", "ordering": 0, "need_approve": true } }` ## [tag/Money/paths/~1fin~1customer_payment~1list/get](https://www.flowlu.com/api/\#tag/Money/paths/~1fin~1customer_payment~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/customer\_payment/list https://{company}.flowlu.com/api/v1/module/fin/customer\_payment/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "created_date": "string",\ \ "created_by": 0,\ \ "total": 0,\ \ "charge": 0,\ \ "date": "string",\ \ "reference": "string",\ \ "owner_id": 0,\ \ "status": 0,\ \ "status_pls": 0,\ \ "org_id": 0,\ \ "bank_account_id": 0,\ \ "currency_id": 0,\ \ "description": "string",\ \ "crm_company_id": 0,\ \ "type": 0,\ \ "startdate": "string",\ \ "enddate": "string",\ \ "complete_date": "string",\ \ "is_complete": true,\ \ "is_manual": true,\ \ "is_owed": true,\ \ "project_id": 0,\ \ "updated_by": 0,\ \ "project_stage_id": 0,\ \ "updated_date": "string",\ \ "ref": "string",\ \ "ref_id": "string",\ \ "ref_uuid": "string",\ \ "uuid": "string",\ \ "ordering": 0,\ \ "need_approve": true\ \ }\ \ ] } }` ## [tag/Invoice-contacts](https://www.flowlu.com/api/\#tag/Invoice-contacts) Invoice contacts These are the contacts to whom the invoice was sent by email (recipients). ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [invoice](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | invoice\_id | | [contact](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | contact\_id | | [email](https://www.flowlu.com/api/#tag/Email) | CRM | Email | email\_id | ## [tag/Invoice-contacts/paths/~1fin~1invoice_contacts~1create/post](https://www.flowlu.com/api/\#tag/Invoice-contacts/paths/~1fin~1invoice_contacts~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | invoice\_id | integer
Invoice ID | | contact\_id | string
Account id | | email\_id | integer
Invoice recipients by email | | invoice\_emailed | boolean
Email sent | | invoice\_emailed\_date | string
Invoice emailed date | | reminders\_sent | boolean
Remainder sent | | reminders\_sent\_date | string
Sent date | | is\_primary | boolean
Invoice Email Recipient | ### Responses **200** Successfully create an item post/fin/invoice\_contacts/create https://{company}.flowlu.com/api/v1/module/fin/invoice\_contacts/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "invoice_id": 0, "contact_id": "string", "email_id": 0, "invoice_emailed": true, "invoice_emailed_date": "string", "reminders_sent": true, "reminders_sent_date": "string", "is_primary": true } }` ## [tag/Invoice-contacts/paths/~1fin~1invoice_contacts~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Invoice-contacts/paths/~1fin~1invoice_contacts~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/invoice\_contacts/update/{id} https://{company}.flowlu.com/api/v1/module/fin/invoice\_contacts/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "invoice_id": 0, "contact_id": "string", "email_id": 0, "invoice_emailed": true, "invoice_emailed_date": "string", "reminders_sent": true, "reminders_sent_date": "string", "is_primary": true } }` ## [tag/Invoice-contacts/paths/~1fin~1invoice_contacts~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Invoice-contacts/paths/~1fin~1invoice_contacts~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/invoice\_contacts/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/invoice\_contacts/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Invoice-contacts/paths/~1fin~1invoice_contacts~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Invoice-contacts/paths/~1fin~1invoice_contacts~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/invoice\_contacts/get/{id} https://{company}.flowlu.com/api/v1/module/fin/invoice\_contacts/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "invoice_id": 0, "contact_id": "string", "email_id": 0, "invoice_emailed": true, "invoice_emailed_date": "string", "reminders_sent": true, "reminders_sent_date": "string", "is_primary": true } }` ## [tag/Invoice-contacts/paths/~1fin~1invoice_contacts~1list/get](https://www.flowlu.com/api/\#tag/Invoice-contacts/paths/~1fin~1invoice_contacts~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/invoice\_contacts/list https://{company}.flowlu.com/api/v1/module/fin/invoice\_contacts/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "invoice_id": 0,\ \ "contact_id": "string",\ \ "email_id": 0,\ \ "invoice_emailed": true,\ \ "invoice_emailed_date": "string",\ \ "reminders_sent": true,\ \ "reminders_sent_date": "string",\ \ "is_primary": true\ \ }\ \ ] } }` ## [tag/Bank-account](https://www.flowlu.com/api/\#tag/Bank-account) Bank account ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [account\_group](https://www.flowlu.com/api/#tag/Account%20groups) | Finance | Account groups | account\_group\_id | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [reference\_out](https://www.flowlu.com/api/#tag/Money) | Finance | Money | bank\_account\_id | type = 20 | | [reference\_in](https://www.flowlu.com/api/#tag/Money) | Finance | Money | bank\_account\_id | type = 10 | | [reference\_project\_out](https://www.flowlu.com/api/#tag/Money) | Finance | Money | bank\_account\_id | type = 21 | | [reference\_project\_in](https://www.flowlu.com/api/#tag/Money) | Finance | Money | bank\_account\_id | type = 11 | | [transactions](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | org\_account\_id | | | [plan\_money](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | org\_account\_id | | ## [tag/Bank-account/paths/~1fin~1bank_account~1create/post](https://www.flowlu.com/api/\#tag/Bank-account/paths/~1fin~1bank_account~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | org\_id | integer
Organization id | | type | integer
Account type:
- 101 - Cash account
- 102 - Foreign currency account
- 103 - Checking account
- 104 - Personal account
- 105 - Cryptocurrency account
- 301 - PayPal account | | name | string
Name | | currency\_id | integer
Currency symbol | | fixed\_balance | number
Fixed opening balance of the account | | fixed\_balance\_date | string
Date of fixed opening balance of the account | | pls\_fixed\_balance | number
Fixed opening balance by P&L | | pls\_fixed\_balance\_date | string
Date of fixed opening balance by P&L | | pls\_bcy\_balance | bcy\_price
Fixed opening balance by P&L in base currency | | excluded\_balance | boolean
Exclude account from total balance | | bcy\_balance | bcy\_price
Fixed opening balance of the account in base currency | | currency\_exchange\_rate | rate
Currency exchange rate | | active | integer
If = 0, Inactive.
Default value = 1. | | is\_displayed\_closed | boolean
Display in filters by Accounts after closing | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | ordering\_by\_group | integer
Sorting index within the account group. The system sorts from smaller to larger. For example: a record with field value 1 will be above a record with field value 2 | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | | closed\_at | string
Account closing date | | manager\_id | integer
Responsible person ID (only for Individual account type) | | account\_group\_id | integer
Account group ID | ### Responses **200** Successfully create an item post/fin/bank\_account/create https://{company}.flowlu.com/api/v1/module/fin/bank\_account/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "org_id": 0, "type": 0, "name": "string", "currency_id": 0, "fixed_balance": 0, "fixed_balance_date": "string", "pls_fixed_balance": 0, "pls_fixed_balance_date": "string", "pls_bcy_balance": null, "excluded_balance": true, "bcy_balance": null, "currency_exchange_rate": null, "active": 0, "is_displayed_closed": true, "ordering": 0, "ordering_by_group": 0, "ref": "string", "ref_id": "string", "closed_at": "string", "manager_id": 0, "account_group_id": 0 } }` ## [tag/Bank-account/paths/~1fin~1bank_account~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Bank-account/paths/~1fin~1bank_account~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/bank\_account/update/{id} https://{company}.flowlu.com/api/v1/module/fin/bank\_account/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "org_id": 0, "type": 0, "name": "string", "currency_id": 0, "fixed_balance": 0, "fixed_balance_date": "string", "pls_fixed_balance": 0, "pls_fixed_balance_date": "string", "pls_bcy_balance": null, "excluded_balance": true, "bcy_balance": null, "currency_exchange_rate": null, "active": 0, "is_displayed_closed": true, "ordering": 0, "ordering_by_group": 0, "ref": "string", "ref_id": "string", "closed_at": "string", "manager_id": 0, "account_group_id": 0 } }` ## [tag/Bank-account/paths/~1fin~1bank_account~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Bank-account/paths/~1fin~1bank_account~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/bank\_account/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/bank\_account/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Bank-account/paths/~1fin~1bank_account~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Bank-account/paths/~1fin~1bank_account~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/bank\_account/get/{id} https://{company}.flowlu.com/api/v1/module/fin/bank\_account/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "org_id": 0, "type": 0, "name": "string", "currency_id": 0, "fixed_balance": 0, "fixed_balance_date": "string", "pls_fixed_balance": 0, "pls_fixed_balance_date": "string", "pls_bcy_balance": null, "excluded_balance": true, "bcy_balance": null, "currency_exchange_rate": null, "active": 0, "is_displayed_closed": true, "ordering": 0, "ordering_by_group": 0, "ref": "string", "ref_id": "string", "closed_at": "string", "manager_id": 0, "account_group_id": 0 } }` ## [tag/Bank-account/paths/~1fin~1bank_account~1list/get](https://www.flowlu.com/api/\#tag/Bank-account/paths/~1fin~1bank_account~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/bank\_account/list https://{company}.flowlu.com/api/v1/module/fin/bank\_account/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "org_id": 0,\ \ "type": 0,\ \ "name": "string",\ \ "currency_id": 0,\ \ "fixed_balance": 0,\ \ "fixed_balance_date": "string",\ \ "pls_fixed_balance": 0,\ \ "pls_fixed_balance_date": "string",\ \ "pls_bcy_balance": null,\ \ "excluded_balance": true,\ \ "bcy_balance": null,\ \ "currency_exchange_rate": null,\ \ "active": 0,\ \ "is_displayed_closed": true,\ \ "ordering": 0,\ \ "ordering_by_group": 0,\ \ "ref": "string",\ \ "ref_id": "string",\ \ "closed_at": "string",\ \ "manager_id": 0,\ \ "account_group_id": 0\ \ }\ \ ] } }` ## [tag/Account-groups](https://www.flowlu.com/api/\#tag/Account-groups) Account groups ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [org\_accounts](https://www.flowlu.com/api/#tag/Bank%20account) | Finance | Bank account | account\_group\_id | ## [tag/Account-groups/paths/~1fin~1bank_account_group~1create/post](https://www.flowlu.com/api/\#tag/Account-groups/paths/~1fin~1bank_account_group~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully create an item post/fin/bank\_account\_group/create https://{company}.flowlu.com/api/v1/module/fin/bank\_account\_group/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": 0, "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Account-groups/paths/~1fin~1bank_account_group~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Account-groups/paths/~1fin~1bank_account_group~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/bank\_account\_group/update/{id} https://{company}.flowlu.com/api/v1/module/fin/bank\_account\_group/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": 0, "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Account-groups/paths/~1fin~1bank_account_group~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Account-groups/paths/~1fin~1bank_account_group~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/bank\_account\_group/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/bank\_account\_group/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Account-groups/paths/~1fin~1bank_account_group~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Account-groups/paths/~1fin~1bank_account_group~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/bank\_account\_group/get/{id} https://{company}.flowlu.com/api/v1/module/fin/bank\_account\_group/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": 0, "ordering": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Account-groups/paths/~1fin~1bank_account_group~1list/get](https://www.flowlu.com/api/\#tag/Account-groups/paths/~1fin~1bank_account_group~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/bank\_account\_group/list https://{company}.flowlu.com/api/v1/module/fin/bank\_account\_group/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, } }` ## [tag/Estimate](https://www.flowlu.com/api/\#tag/Estimate) Estimate ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | | | [client](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | customer\_id | | | [pricelist](https://www.flowlu.com/api/#tag/Price%20list) | Products & Services | Price list | pricelist\_id | | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | model\_id | module = st, model = project | | [printed\_form](https://www.flowlu.com/api/#tag/Estimate%20template) | Finance | Estimate template | template\_id | | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [contacts](https://www.flowlu.com/api/#tag/Estimate%20contacts) | Finance | Estimate contacts | estimate\_id | | [items](https://www.flowlu.com/api/#tag/Estimate%20items) | Finance | Estimate items | estimate\_id | | [invoices](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | estimate\_id | ## [tag/Estimate/paths/~1fin~1estimate~1create/post](https://www.flowlu.com/api/\#tag/Estimate/paths/~1fin~1estimate~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | active | boolean
If = 0, Inactive.
Default value = 1. | | estimate\_number | integer
Estimate number | | estimate\_number\_print | string
Estimate number for printing | | reference\_number | string
Reference number | | assignee\_id | integer
Assigned user id | | customer\_id | integer
Customer id | | customer\_name | string
Customer name | | customer\_legal\_name | string
Customer legal name | | company\_phone | string
Phone | | company\_phone2 | string
Company second phone | | company\_vat | string
Business Tax ID | | company\_vat2 | string
Additional Account VAT (or TAX ID) | | contact\_person | string
Contact | | contact\_person\_position | string
Contact position | | invoice\_date | string
Date | | expire\_date | string
Expiration date | | status\_id | integer
Status id | | template\_id | integer
Estimate template id | | currency\_id | integer
Currency symbol | | currency\_code | string
Currency code | | exchange\_rate | rate
Exchange Rate | | sub\_total | number
Subtotal | | tax\_total | number
Tax total | | total | number
Total | | shipping\_charge | number
Shipping charge | | adjustment | number
Adjustment | | adjustment\_description | string
Adjustment description | | discount | number
Discount | | is\_discount\_percent | boolean
Is discount percent (Default - 1):
1 - Yes
0 - No
Default - 1 | | discount\_before\_tax | boolean
Discount before tax | | tax1 | number
Tax 1 (%) | | tax2 | number
Tax 2 (%) | | tax1\_included | boolean
1 - Include in price
0 - Not included | | tax2\_included | boolean
TAX2:
1 - Include in price
0 - Not included | | estimate\_emailed\_date | string
Email sent date | | estimate\_footer\_text | string
Customer Notes | | estimate\_terms\_text | string
Terms & Conditions | | org\_id | integer
Organization id | | org\_phone | string
Organization phone | | org\_phone2 | string
Organization phone | | org\_vat | string
Business Tax ID | | org\_vat2 | string
Organization VAT 2 | | bill\_from\_address | string
Bill from address | | bill\_from\_city | string
Bill from city | | bill\_from\_state | string
Bill from state | | bill\_from\_zip | string
Bill from zip | | bill\_from\_country\_id | integer
Bill from country | | bill\_to\_address | string
Address | | bill\_to\_city | string
Bill to city | | bill\_to\_state | string
Bill to state | | bill\_to\_zip | string
Bill to ZIP | | bill\_to\_country\_id | integer
Country ID | | client\_shipping\_address | string
Legal address of the payer | | client\_shipping\_city | string
Country (current address) | | client\_shipping\_state | string
State/Region (current address) | | client\_shipping\_zip | string
ZIP code (current address) | | created\_by | integer
User id | | updated\_by | integer
User id | | updated\_date | string
Updated date | | module | string
Module | | model | string
Model | | model\_id | integer
Model id | | group\_id | integer
Group id | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | | type | integer
Estimate type | | pricelist\_id | integer
Price list id | | uuid | string
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer systems | ### Responses **200** Successfully create an item post/fin/estimate/create https://{company}.flowlu.com/api/v1/module/fin/estimate/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "active": true, "estimate_number": 0, "estimate_number_print": "string", "reference_number": "string", "assignee_id": 0, "customer_id": 0, "customer_name": "string", "customer_legal_name": "string", "company_phone": "string", "company_phone2": "string", "company_vat": "string", "company_vat2": "string", "contact_person": "string", "contact_person_position": "string", "invoice_date": "string", "expire_date": "string", "status_id": 0, "template_id": 0, "currency_id": 0, "currency_code": "string", "exchange_rate": null, "sub_total": 0, "tax_total": 0, "total": 0, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "discount": 0, "is_discount_percent": true, "discount_before_tax": true, "tax1": 0, "tax2": 0, "tax1_included": true, "tax2_included": true, "estimate_emailed_date": "string", "estimate_footer_text": "string", "estimate_terms_text": "string", "org_id": 0, "org_phone": "string", "org_phone2": "string", "org_vat": "string", "org_vat2": "string", "bill_from_address": "string", "bill_from_city": "string", "bill_from_state": "string", "bill_from_zip": "string", "bill_from_country_id": 0, "bill_to_address": "string", "bill_to_city": "string", "bill_to_state": "string", "bill_to_zip": "string", "bill_to_country_id": 0, "client_shipping_address": "string", "client_shipping_city": "string", "client_shipping_state": "string", "client_shipping_zip": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "module": "string", "model": "string", "model_id": 0, "group_id": 0, "ref": "string", "ref_id": "string", "type": 0, "pricelist_id": 0, "uuid": "string" } }` ## [tag/Estimate/paths/~1fin~1estimate~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Estimate/paths/~1fin~1estimate~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/estimate/update/{id} https://{company}.flowlu.com/api/v1/module/fin/estimate/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "active": true, "estimate_number": 0, "estimate_number_print": "string", "reference_number": "string", "assignee_id": 0, "customer_id": 0, "customer_name": "string", "customer_legal_name": "string", "company_phone": "string", "company_phone2": "string", "company_vat": "string", "company_vat2": "string", "contact_person": "string", "contact_person_position": "string", "invoice_date": "string", "expire_date": "string", "status_id": 0, "template_id": 0, "currency_id": 0, "currency_code": "string", "exchange_rate": null, "sub_total": 0, "tax_total": 0, "total": 0, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "discount": 0, "is_discount_percent": true, "discount_before_tax": true, "tax1": 0, "tax2": 0, "tax1_included": true, "tax2_included": true, "estimate_emailed_date": "string", "estimate_footer_text": "string", "estimate_terms_text": "string", "org_id": 0, "org_phone": "string", "org_phone2": "string", "org_vat": "string", "org_vat2": "string", "bill_from_address": "string", "bill_from_city": "string", "bill_from_state": "string", "bill_from_zip": "string", "bill_from_country_id": 0, "bill_to_address": "string", "bill_to_city": "string", "bill_to_state": "string", "bill_to_zip": "string", "bill_to_country_id": 0, "client_shipping_address": "string", "client_shipping_city": "string", "client_shipping_state": "string", "client_shipping_zip": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "module": "string", "model": "string", "model_id": 0, "group_id": 0, "ref": "string", "ref_id": "string", "type": 0, "pricelist_id": 0, "uuid": "string" } }` ## [tag/Estimate/paths/~1fin~1estimate~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Estimate/paths/~1fin~1estimate~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/estimate/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/estimate/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Estimate/paths/~1fin~1estimate~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Estimate/paths/~1fin~1estimate~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/estimate/get/{id} https://{company}.flowlu.com/api/v1/module/fin/estimate/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "active": true, "estimate_number": 0, "estimate_number_print": "string", "reference_number": "string", "assignee_id": 0, "customer_id": 0, "customer_name": "string", "customer_legal_name": "string", "company_phone": "string", "company_phone2": "string", "company_vat": "string", "company_vat2": "string", "contact_person": "string", "contact_person_position": "string", "invoice_date": "string", "expire_date": "string", "status_id": 0, "template_id": 0, "currency_id": 0, "currency_code": "string", "exchange_rate": null, "sub_total": 0, "tax_total": 0, "total": 0, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "discount": 0, "is_discount_percent": true, "discount_before_tax": true, "tax1": 0, "tax2": 0, "tax1_included": true, "tax2_included": true, "estimate_emailed_date": "string", "estimate_footer_text": "string", "estimate_terms_text": "string", "org_id": 0, "org_phone": "string", "org_phone2": "string", "org_vat": "string", "org_vat2": "string", "bill_from_address": "string", "bill_from_city": "string", "bill_from_state": "string", "bill_from_zip": "string", "bill_from_country_id": 0, "bill_to_address": "string", "bill_to_city": "string", "bill_to_state": "string", "bill_to_zip": "string", "bill_to_country_id": 0, "client_shipping_address": "string", "client_shipping_city": "string", "client_shipping_state": "string", "client_shipping_zip": "string", "created_by": 0, "updated_by": 0, "updated_date": "string", "module": "string", "model": "string", "model_id": 0, "group_id": 0, "ref": "string", "ref_id": "string", "type": 0, "pricelist_id": 0, "uuid": "string" } }` ## [tag/Estimate/paths/~1fin~1estimate~1list/get](https://www.flowlu.com/api/\#tag/Estimate/paths/~1fin~1estimate~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/estimate/list https://{company}.flowlu.com/api/v1/module/fin/estimate/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "active": true,\ \ "estimate_number": 0,\ \ "estimate_number_print": "string",\ \ "reference_number": "string",\ \ "assignee_id": 0,\ \ "customer_id": 0,\ \ "customer_name": "string",\ \ "customer_legal_name": "string",\ \ "company_phone": "string",\ \ "company_phone2": "string",\ \ "company_vat": "string",\ \ "company_vat2": "string",\ \ "contact_person": "string",\ \ "contact_person_position": "string",\ \ "invoice_date": "string",\ \ "expire_date": "string",\ \ "status_id": 0,\ \ "template_id": 0,\ \ "currency_id": 0,\ \ "currency_code": "string",\ \ "exchange_rate": null,\ \ "sub_total": 0,\ \ "tax_total": 0,\ \ "total": 0,\ \ "shipping_charge": 0,\ \ "adjustment": 0,\ \ "adjustment_description": "string",\ \ "discount": 0,\ \ "is_discount_percent": true,\ \ "discount_before_tax": true,\ \ "tax1": 0,\ \ "tax2": 0,\ \ "tax1_included": true,\ \ "tax2_included": true,\ \ "estimate_emailed_date": "string",\ \ "estimate_footer_text": "string",\ \ "estimate_terms_text": "string",\ \ "org_id": 0,\ \ "org_phone": "string",\ \ "org_phone2": "string",\ \ "org_vat": "string",\ \ "org_vat2": "string",\ \ "bill_from_address": "string",\ \ "bill_from_city": "string",\ \ "bill_from_state": "string",\ \ "bill_from_zip": "string",\ \ "bill_from_country_id": 0,\ \ "bill_to_address": "string",\ \ "bill_to_city": "string",\ \ "bill_to_state": "string",\ \ "bill_to_zip": "string",\ \ "bill_to_country_id": 0,\ \ "client_shipping_address": "string",\ \ "client_shipping_city": "string",\ \ "client_shipping_state": "string",\ \ "client_shipping_zip": "string",\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "module": "string",\ \ "model": "string",\ \ "model_id": 0,\ \ "group_id": 0,\ \ "ref": "string",\ \ "ref_id": "string",\ \ "type": 0,\ \ "pricelist_id": 0,\ \ "uuid": "string"\ \ }\ \ ] } }` ## [tag/Estimate-items](https://www.flowlu.com/api/\#tag/Estimate-items) Estimate items ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [estimate](https://www.flowlu.com/api/#tag/Estimate) | Finance | Estimate | estimate\_id | | [product\_item](https://www.flowlu.com/api/#tag/Items) | Products & Services | Items | item\_id | ## [tag/Estimate-items/paths/~1fin~1estimate_item~1create/post](https://www.flowlu.com/api/\#tag/Estimate-items/paths/~1fin~1estimate_item~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | estimate\_id | integer
Estimate id | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | item\_id | integer
Item id | | name | string
Name | | description | string
Description | | unit\_price | number
Unit price | | unit\_id | integer
Item unit id | | quantity | tax
Quantity | | tax1 | number
Tax 1 (%) | | tax1\_included | boolean
1 - Include in price
0 - Not included | | tax1\_amount | number
Tax amount | | tax2 | number
Tax 2 (%) | | tax2\_included | boolean
TAX2:
1 - Include in price
0 - Not included | | tax2\_amount | number
Tax | | discount\_amount | number
Discount amount (calculated field based on discount) | | discount | string
Discount | | discount\_is\_percent | integer
Is discount percent (Default - 1):
1 - Yes
0 - No
Default - 1 | | sub\_total | number
Subtotal | | tax\_total | tax
Tax total | | tax\_displayed | string
The tax value displayed in printed forms (%) | | total | number
Total | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | | type | integer
10 - Line
20 - Header | ### Responses **200** Successfully create an item post/fin/estimate\_item/create https://{company}.flowlu.com/api/v1/module/fin/estimate\_item/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "estimate_id": 0, "ordering": 0, "item_id": 0, "name": "string", "description": "string", "unit_price": 0, "unit_id": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": 0, "sub_total": 0, "tax_total": null, "tax_displayed": "string", "total": 0, "ref": "string", "ref_id": "string", "type": 0 } }` ## [tag/Estimate-items/paths/~1fin~1estimate_item~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Estimate-items/paths/~1fin~1estimate_item~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/estimate\_item/update/{id} https://{company}.flowlu.com/api/v1/module/fin/estimate\_item/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "estimate_id": 0, "ordering": 0, "item_id": 0, "name": "string", "description": "string", "unit_price": 0, "unit_id": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": 0, "sub_total": 0, "tax_total": null, "tax_displayed": "string", "total": 0, "ref": "string", "ref_id": "string", "type": 0 } }` ## [tag/Estimate-items/paths/~1fin~1estimate_item~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Estimate-items/paths/~1fin~1estimate_item~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/estimate\_item/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/estimate\_item/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Estimate-items/paths/~1fin~1estimate_item~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Estimate-items/paths/~1fin~1estimate_item~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/estimate\_item/get/{id} https://{company}.flowlu.com/api/v1/module/fin/estimate\_item/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "estimate_id": 0, "ordering": 0, "item_id": 0, "name": "string", "description": "string", "unit_price": 0, "unit_id": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": 0, "sub_total": 0, "tax_total": null, "tax_displayed": "string", "total": 0, "ref": "string", "ref_id": "string", "type": 0 } }` ## [tag/Estimate-items/paths/~1fin~1estimate_item~1list/get](https://www.flowlu.com/api/\#tag/Estimate-items/paths/~1fin~1estimate_item~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/estimate\_item/list https://{company}.flowlu.com/api/v1/module/fin/estimate\_item/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "estimate_id": 0,\ \ "ordering": 0,\ \ "item_id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "unit_price": 0,\ \ "unit_id": 0,\ \ "quantity": null,\ \ "tax1": 0,\ \ "tax1_included": true,\ \ "tax1_amount": 0,\ \ "tax2": 0,\ \ "tax2_included": true,\ \ "tax2_amount": 0,\ \ "discount_amount": 0,\ \ "discount": "string",\ \ "discount_is_percent": 0,\ \ "sub_total": 0,\ \ "tax_total": null,\ \ "tax_displayed": "string",\ \ "total": 0,\ \ "ref": "string",\ \ "ref_id": "string",\ \ "type": 0\ \ }\ \ ] } }` ## [tag/Estimate-template](https://www.flowlu.com/api/\#tag/Estimate-template) Estimate template ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | ## [tag/Estimate-template/paths/~1fin~1estimate_template~1create/post](https://www.flowlu.com/api/\#tag/Estimate-template/paths/~1fin~1estimate_template~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | created\_date | string
Created date | | created\_by | integer
User id | | updated\_date | string
Updated date | | updated\_by | integer
User id | | name | string
Name | | org\_id | integer
Organization id | | code | string
Estimate template code | | doctemplater\_id | integer
ID of the printed form of the document designer | | description | string
Description | | active | integer
If = 0, Inactive.
Default value = 1. | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | params | string
Estimate template parametres | | uuid | string
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer systems | ### Responses **200** Successfully create an item post/fin/estimate\_template/create https://{company}.flowlu.com/api/v1/module/fin/estimate\_template/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0, "name": "string", "org_id": 0, "code": "string", "doctemplater_id": 0, "description": "string", "active": 0, "ordering": 0, "params": "string", "uuid": "string" } }` ## [tag/Estimate-template/paths/~1fin~1estimate_template~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Estimate-template/paths/~1fin~1estimate_template~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/estimate\_template/update/{id} https://{company}.flowlu.com/api/v1/module/fin/estimate\_template/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0, "name": "string", "org_id": 0, "code": "string", "doctemplater_id": 0, "description": "string", "active": 0, "ordering": 0, "params": "string", "uuid": "string" } }` ## [tag/Estimate-template/paths/~1fin~1estimate_template~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Estimate-template/paths/~1fin~1estimate_template~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/estimate\_template/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/estimate\_template/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Estimate-template/paths/~1fin~1estimate_template~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Estimate-template/paths/~1fin~1estimate_template~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/estimate\_template/get/{id} https://{company}.flowlu.com/api/v1/module/fin/estimate\_template/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0, "name": "string", "org_id": 0, "code": "string", "doctemplater_id": 0, "description": "string", "active": 0, "ordering": 0, "params": "string", "uuid": "string" } }` ## [tag/Estimate-template/paths/~1fin~1estimate_template~1list/get](https://www.flowlu.com/api/\#tag/Estimate-template/paths/~1fin~1estimate_template~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/estimate\_template/list https://{company}.flowlu.com/api/v1/module/fin/estimate\_template/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "created_date": "string",\ \ "created_by": 0,\ \ "updated_date": "string",\ \ "updated_by": 0,\ \ "name": "string",\ \ "org_id": 0,\ \ "code": "string",\ \ "doctemplater_id": 0,\ \ "description": "string",\ \ "active": 0,\ \ "ordering": 0,\ \ "params": "string",\ \ "uuid": "string"\ \ }\ \ ] } }` ## [tag/Estimate-contacts](https://www.flowlu.com/api/\#tag/Estimate-contacts) Estimate contacts Estimate contacts ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [estimate](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | estimate\_id | | [contact](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | contact\_id | | [email](https://www.flowlu.com/api/#tag/Email) | CRM | Email | email\_id | ## [tag/Estimate-contacts/paths/~1fin~1estimate_contacts~1create/post](https://www.flowlu.com/api/\#tag/Estimate-contacts/paths/~1fin~1estimate_contacts~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | estimate\_id | integer
Estimate id | | contact\_id | string
Account id | | email\_id | integer
ID of estimate recipients by email | | estimate\_emailed | boolean
Email send | | estimate\_emailed\_date | string
Email sent date | | is\_primary | boolean
Offer recipient by email. | ### Responses **200** Successfully create an item post/fin/estimate\_contacts/create https://{company}.flowlu.com/api/v1/module/fin/estimate\_contacts/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "estimate_id": 0, "contact_id": "string", "email_id": 0, "estimate_emailed": true, "estimate_emailed_date": "string", "is_primary": true } }` ## [tag/Estimate-contacts/paths/~1fin~1estimate_contacts~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Estimate-contacts/paths/~1fin~1estimate_contacts~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/estimate\_contacts/update/{id} https://{company}.flowlu.com/api/v1/module/fin/estimate\_contacts/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "estimate_id": 0, "contact_id": "string", "email_id": 0, "estimate_emailed": true, "estimate_emailed_date": "string", "is_primary": true } }` ## [tag/Estimate-contacts/paths/~1fin~1estimate_contacts~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Estimate-contacts/paths/~1fin~1estimate_contacts~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/estimate\_contacts/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/estimate\_contacts/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Estimate-contacts/paths/~1fin~1estimate_contacts~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Estimate-contacts/paths/~1fin~1estimate_contacts~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/estimate\_contacts/get/{id} https://{company}.flowlu.com/api/v1/module/fin/estimate\_contacts/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "estimate_id": 0, "contact_id": "string", "email_id": 0, "estimate_emailed": true, "estimate_emailed_date": "string", "is_primary": true } }` ## [tag/Estimate-contacts/paths/~1fin~1estimate_contacts~1list/get](https://www.flowlu.com/api/\#tag/Estimate-contacts/paths/~1fin~1estimate_contacts~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/estimate\_contacts/list https://{company}.flowlu.com/api/v1/module/fin/estimate\_contacts/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "estimate_id": 0,\ \ "contact_id": "string",\ \ "email_id": 0,\ \ "estimate_emailed": true,\ \ "estimate_emailed_date": "string",\ \ "is_primary": true\ \ }\ \ ] } }` ## [tag/Transaction](https://www.flowlu.com/api/\#tag/Transaction) Transaction ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | | [invoice](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | invoice\_id | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | project\_id | | [crm\_account](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | crm\_account\_id | | [org\_account](https://www.flowlu.com/api/#tag/Bank%20account) | Finance | Bank account | org\_account\_id | | [business\_line](https://www.flowlu.com/api/#tag/Business%20line) | Finance | Business line | business\_line\_id | | [reference\_doc](https://www.flowlu.com/api/#tag/Money) | Finance | Money | reference\_id | | [plan\_money](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | plan\_money\_id | | [store\_doc](https://www.flowlu.com/api/#tag/Stock%20documents) | Products & Services | Stock documents | store\_doc\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [transactions\_pls](https://www.flowlu.com/api/#tag/Transactions%20for%20the%20Profit%20and%20Loss%20statement) | Finance | Transactions for the Profit and Loss statement | fin\_transaction\_id | ## [tag/Transaction/paths/~1fin~1transaction~1create/post](https://www.flowlu.com/api/\#tag/Transaction/paths/~1fin~1transaction~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | date | string
Date | | reference | string
Name of the import source of the object (system, etc.) | | income | number
Transaction title | | outcome | number
Expense | | bcy\_income | bcy\_price
Income in Base Currency of the Account | | bcy\_outcome | bcy\_price
Expense in Base Currency of the Account | | default\_bcy\_income | bcy\_price
Amount spent in base currency at the main provider's rate | | default\_bcy\_outcome | bcy\_price
Amount spent in base currency at the main provider's rate | | charge | number
Commission | | bcy\_charge | bcy\_price
Commission in base currency | | currency\_id | integer
Currency symbol | | currency\_exchange\_rate | rate
Currency exchange rate | | default\_currency\_exchange\_rate | rate
Exchange rate for currency conversion from the main provider | | reference\_id | integer
The identifier of the record in Money to which the transaction is linked | | type | integer
Type:
10 - Payment
20 - Expance | | status | integer
Transaction status (Default- 0):
10 - Paid
0 -Not paid. | | project\_id | integer
Project id | | invoice\_id | integer
Invoice ID | | doc\_id | integer
Contract ID | | invoice\_currency\_id | integer
Invoice currency ID | | icy\_total | bcy\_price | | store\_doc\_id | integer
Store document ID | | store\_doc\_currency\_id | integer
Store document currency ID | | store\_doc\_total | bcy\_price
Store document amount | | org\_id | integer
Organization id | | org\_account\_id | integer
Organization account id | | crm\_account\_id | integer
Account id | | manager\_id | integer
Assigned user id | | category\_id | integer
Category id Default- 0 | | plan\_money\_id | integer
Estimated Payment id | | pm\_currency\_id | integer
Currency of estimated revenue | | plan\_money\_total | bcy\_price
Amount of estimated revenue | | project\_money\_stage\_id | integer
Project money stage | | project\_expense\_id | integer
Project expense id | | project\_currency\_id | integer
Project currency ID | | project\_currency\_total | bcy\_price
Transaction amount converted to project currency | | is\_generated | boolean
Is generated Default- 0 | | is\_charge | boolean
Charges | | is\_storno | boolean
Reversed | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | accounting\_type | enum | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | integer
UUID in the system from where the import was made. | | ref\_uuid | string
Reference UUID | | uuid | string
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer systems | | business\_line\_id | integer
business line ID | ### Responses **200** Successfully create an item post/fin/transaction/create https://{company}.flowlu.com/api/v1/module/fin/transaction/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "date": "string", "reference": "string", "income": 0, "outcome": 0, "bcy_income": null, "bcy_outcome": null, "default_bcy_income": null, "default_bcy_outcome": null, "charge": 0, "bcy_charge": null, "currency_id": 0, "currency_exchange_rate": null, "default_currency_exchange_rate": null, "reference_id": 0, "type": 0, "status": 0, "project_id": 0, "invoice_id": 0, "doc_id": 0, "invoice_currency_id": 0, "icy_total": null, "store_doc_id": 0, "store_doc_currency_id": 0, "store_doc_total": null, "org_id": 0, "org_account_id": 0, "crm_account_id": 0, "manager_id": 0, "category_id": 0, "plan_money_id": 0, "pm_currency_id": 0, "plan_money_total": null, "project_money_stage_id": 0, "project_expense_id": 0, "project_currency_id": 0, "project_currency_total": null, "is_generated": true, "is_charge": true, "is_storno": true, "ordering": 0, "accounting_type": null, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "ref": "string", "ref_id": 0, "ref_uuid": "string", "uuid": "string", "business_line_id": 0 } }` ## [tag/Transaction/paths/~1fin~1transaction~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Transaction/paths/~1fin~1transaction~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/transaction/update/{id} https://{company}.flowlu.com/api/v1/module/fin/transaction/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "date": "string", "reference": "string", "income": 0, "outcome": 0, "bcy_income": null, "bcy_outcome": null, "default_bcy_income": null, "default_bcy_outcome": null, "charge": 0, "bcy_charge": null, "currency_id": 0, "currency_exchange_rate": null, "default_currency_exchange_rate": null, "reference_id": 0, "type": 0, "status": 0, "project_id": 0, "invoice_id": 0, "doc_id": 0, "invoice_currency_id": 0, "icy_total": null, "store_doc_id": 0, "store_doc_currency_id": 0, "store_doc_total": null, "org_id": 0, "org_account_id": 0, "crm_account_id": 0, "manager_id": 0, "category_id": 0, "plan_money_id": 0, "pm_currency_id": 0, "plan_money_total": null, "project_money_stage_id": 0, "project_expense_id": 0, "project_currency_id": 0, "project_currency_total": null, "is_generated": true, "is_charge": true, "is_storno": true, "ordering": 0, "accounting_type": null, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "ref": "string", "ref_id": 0, "ref_uuid": "string", "uuid": "string", "business_line_id": 0 } }` ## [tag/Transaction/paths/~1fin~1transaction~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Transaction/paths/~1fin~1transaction~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/transaction/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/transaction/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Transaction/paths/~1fin~1transaction~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Transaction/paths/~1fin~1transaction~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/transaction/get/{id} https://{company}.flowlu.com/api/v1/module/fin/transaction/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "date": "string", "reference": "string", "income": 0, "outcome": 0, "bcy_income": null, "bcy_outcome": null, "default_bcy_income": null, "default_bcy_outcome": null, "charge": 0, "bcy_charge": null, "currency_id": 0, "currency_exchange_rate": null, "default_currency_exchange_rate": null, "reference_id": 0, "type": 0, "status": 0, "project_id": 0, "invoice_id": 0, "doc_id": 0, "invoice_currency_id": 0, "icy_total": null, "store_doc_id": 0, "store_doc_currency_id": 0, "store_doc_total": null, "org_id": 0, "org_account_id": 0, "crm_account_id": 0, "manager_id": 0, "category_id": 0, "plan_money_id": 0, "pm_currency_id": 0, "plan_money_total": null, "project_money_stage_id": 0, "project_expense_id": 0, "project_currency_id": 0, "project_currency_total": null, "is_generated": true, "is_charge": true, "is_storno": true, "ordering": 0, "accounting_type": null, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "ref": "string", "ref_id": 0, "ref_uuid": "string", "uuid": "string", "business_line_id": 0 } }` ## [tag/Transaction/paths/~1fin~1transaction~1list/get](https://www.flowlu.com/api/\#tag/Transaction/paths/~1fin~1transaction~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/transaction/list https://{company}.flowlu.com/api/v1/module/fin/transaction/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "date": "string",\ \ "reference": "string",\ \ "income": 0,\ \ "outcome": 0,\ \ "bcy_income": null,\ \ "bcy_outcome": null,\ \ "default_bcy_income": null,\ \ "default_bcy_outcome": null,\ \ "charge": 0,\ \ "bcy_charge": null,\ \ "currency_id": 0,\ \ "currency_exchange_rate": null,\ \ "default_currency_exchange_rate": null,\ \ "reference_id": 0,\ \ "type": 0,\ \ "status": 0,\ \ "project_id": 0,\ \ "invoice_id": 0,\ \ "doc_id": 0,\ \ "invoice_currency_id": 0,\ \ "icy_total": null,\ \ "store_doc_id": 0,\ \ "store_doc_currency_id": 0,\ \ "store_doc_total": null,\ \ "org_id": 0,\ \ "org_account_id": 0,\ \ "crm_account_id": 0,\ \ "manager_id": 0,\ \ "category_id": 0,\ \ "plan_money_id": 0,\ \ "pm_currency_id": 0,\ \ "plan_money_total": null,\ \ "project_money_stage_id": 0,\ \ "project_expense_id": 0,\ \ "project_currency_id": 0,\ \ "project_currency_total": null,\ \ "is_generated": true,\ \ "is_charge": true,\ \ "is_storno": true,\ \ "ordering": 0,\ \ "accounting_type": null,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "ref": "string",\ \ "ref_id": 0,\ \ "ref_uuid": "string",\ \ "uuid": "string",\ \ "business_line_id": 0\ \ }\ \ ] } }` ## [tag/Transactions-for-the-Profit-and-Loss-statement](https://www.flowlu.com/api/\#tag/Transactions-for-the-Profit-and-Loss-statement) Transactions for the Profit and Loss statement ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [transaction](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | fin\_transaction\_id | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | | [invoice](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | invoice\_id | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | project\_id | | [crm\_account](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | crm\_account\_id | | [org\_account](https://www.flowlu.com/api/#tag/Bank%20account) | Finance | Bank account | org\_account\_id | | [business\_line](https://www.flowlu.com/api/#tag/Business%20line) | Finance | Business line | business\_line\_id | | [reference\_doc](https://www.flowlu.com/api/#tag/Money) | Finance | Money | reference\_id | | [plan\_money](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | plan\_money\_id | ## [tag/Transactions-for-the-Profit-and-Loss-statement/paths/~1fin~1transaction_pls~1create/post](https://www.flowlu.com/api/\#tag/Transactions-for-the-Profit-and-Loss-statement/paths/~1fin~1transaction_pls~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | fin\_transaction\_id | integer
Relationship with fin\_transaction | | date | string
Date | | reference | string
Name of the import source of the object (system, etc.) | | income | number
Transaction title | | outcome | number
Expense | | bcy\_income | bcy\_price
Income in Base Currency of the Account | | bcy\_outcome | bcy\_price
Expense in Base Currency of the Account | | default\_bcy\_income | bcy\_price
Amount received in base currency at the main provider's rate | | default\_bcy\_outcome | bcy\_price
Amount spent in base currency at the main provider's rate | | currency\_id | integer
Currency symbol | | currency\_exchange\_rate | rate
Currency exchange rate | | default\_currency\_exchange\_rate | rate
Exchange rate for currency conversion from the main provider | | reference\_id | integer
The identifier of the record in Money to which the transaction is linked | | type | integer
Type:
10 - Payment
20 - Expance | | status | integer
Transaction status (Default- 0):
1 - Paid
0 -Not paid. | | project\_id | integer
Project id | | invoice\_id | integer
Invoice ID | | doc\_id | integer
Contract ID | | act\_id | integer
Act ID | | org\_id | integer
Organization id | | org\_account\_id | integer
Organization account id | | crm\_account\_id | integer
Account id | | manager\_id | integer
Assigned user id | | category\_id | integer
Category id Default- 0 | | plan\_money\_id | integer
Estimated Payment id | | pm\_currency\_id | integer
Currency of estimated revenue | | plan\_money\_total | bcy\_price
Amount of estimated revenue | | store\_doc\_id | integer
Store document ID | | store\_doc\_currency\_id | integer
Store document currency ID | | store\_doc\_total | bcy\_price
Store document amount | | project\_money\_stage\_id | integer
Project money stage | | project\_expense\_id | integer
Project expense id | | is\_generated | boolean
Is generated Default- 0 | | is\_charge | boolean
Charges | | is\_storno | boolean
Reversed | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | accounting\_type | enum | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | integer
UUID in the system from where the import was made. | | ref\_uuid | string
Reference UUID | | uuid | string
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer systems | | business\_line\_id | integer
business line ID | ### Responses **200** Successfully create an item post/fin/transaction\_pls/create https://{company}.flowlu.com/api/v1/module/fin/transaction\_pls/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "fin_transaction_id": 0, "date": "string", "reference": "string", "income": 0, "outcome": 0, "bcy_income": null, "bcy_outcome": null, "default_bcy_income": null, "default_bcy_outcome": null, "currency_id": 0, "currency_exchange_rate": null, "default_currency_exchange_rate": null, "reference_id": 0, "type": 0, "status": 0, "project_id": 0, "invoice_id": 0, "doc_id": 0, "act_id": 0, "org_id": 0, "org_account_id": 0, "crm_account_id": 0, "manager_id": 0, "category_id": 0, "plan_money_id": 0, "pm_currency_id": 0, "plan_money_total": null, "store_doc_id": 0, "store_doc_currency_id": 0, "store_doc_total": null, "project_money_stage_id": 0, "project_expense_id": 0, "is_generated": true, "is_charge": true, "is_storno": true, "ordering": 0, "accounting_type": null, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "ref": "string", "ref_id": 0, "ref_uuid": "string", "uuid": "string", "business_line_id": 0 } }` ## [tag/Transactions-for-the-Profit-and-Loss-statement/paths/~1fin~1transaction_pls~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Transactions-for-the-Profit-and-Loss-statement/paths/~1fin~1transaction_pls~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/transaction\_pls/update/{id} https://{company}.flowlu.com/api/v1/module/fin/transaction\_pls/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "fin_transaction_id": 0, "date": "string", "reference": "string", "income": 0, "outcome": 0, "bcy_income": null, "bcy_outcome": null, "default_bcy_income": null, "default_bcy_outcome": null, "currency_id": 0, "currency_exchange_rate": null, "default_currency_exchange_rate": null, "reference_id": 0, "type": 0, "status": 0, "project_id": 0, "invoice_id": 0, "doc_id": 0, "act_id": 0, "org_id": 0, "org_account_id": 0, "crm_account_id": 0, "manager_id": 0, "category_id": 0, "plan_money_id": 0, "pm_currency_id": 0, "plan_money_total": null, "store_doc_id": 0, "store_doc_currency_id": 0, "store_doc_total": null, "project_money_stage_id": 0, "project_expense_id": 0, "is_generated": true, "is_charge": true, "is_storno": true, "ordering": 0, "accounting_type": null, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "ref": "string", "ref_id": 0, "ref_uuid": "string", "uuid": "string", "business_line_id": 0 } }` ## [tag/Transactions-for-the-Profit-and-Loss-statement/paths/~1fin~1transaction_pls~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Transactions-for-the-Profit-and-Loss-statement/paths/~1fin~1transaction_pls~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/transaction\_pls/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/transaction\_pls/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Transactions-for-the-Profit-and-Loss-statement/paths/~1fin~1transaction_pls~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Transactions-for-the-Profit-and-Loss-statement/paths/~1fin~1transaction_pls~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/transaction\_pls/get/{id} https://{company}.flowlu.com/api/v1/module/fin/transaction\_pls/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "fin_transaction_id": 0, "date": "string", "reference": "string", "income": 0, "outcome": 0, "bcy_income": null, "bcy_outcome": null, "default_bcy_income": null, "default_bcy_outcome": null, "currency_id": 0, "currency_exchange_rate": null, "default_currency_exchange_rate": null, "reference_id": 0, "type": 0, "status": 0, "project_id": 0, "invoice_id": 0, "doc_id": 0, "act_id": 0, "org_id": 0, "org_account_id": 0, "crm_account_id": 0, "manager_id": 0, "category_id": 0, "plan_money_id": 0, "pm_currency_id": 0, "plan_money_total": null, "store_doc_id": 0, "store_doc_currency_id": 0, "store_doc_total": null, "project_money_stage_id": 0, "project_expense_id": 0, "is_generated": true, "is_charge": true, "is_storno": true, "ordering": 0, "accounting_type": null, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "ref": "string", "ref_id": 0, "ref_uuid": "string", "uuid": "string", "business_line_id": 0 } }` ## [tag/Transactions-for-the-Profit-and-Loss-statement/paths/~1fin~1transaction_pls~1list/get](https://www.flowlu.com/api/\#tag/Transactions-for-the-Profit-and-Loss-statement/paths/~1fin~1transaction_pls~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/transaction\_pls/list https://{company}.flowlu.com/api/v1/module/fin/transaction\_pls/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "fin_transaction_id": 0,\ \ "date": "string",\ \ "reference": "string",\ \ "income": 0,\ \ "outcome": 0,\ \ "bcy_income": null,\ \ "bcy_outcome": null,\ \ "default_bcy_income": null,\ \ "default_bcy_outcome": null,\ \ "currency_id": 0,\ \ "currency_exchange_rate": null,\ \ "default_currency_exchange_rate": null,\ \ "reference_id": 0,\ \ "type": 0,\ \ "status": 0,\ \ "project_id": 0,\ \ "invoice_id": 0,\ \ "doc_id": 0,\ \ "act_id": 0,\ \ "org_id": 0,\ \ "org_account_id": 0,\ \ "crm_account_id": 0,\ \ "manager_id": 0,\ \ "category_id": 0,\ \ "plan_money_id": 0,\ \ "pm_currency_id": 0,\ \ "plan_money_total": null,\ \ "store_doc_id": 0,\ \ "store_doc_currency_id": 0,\ \ "store_doc_total": null,\ \ "project_money_stage_id": 0,\ \ "project_expense_id": 0,\ \ "is_generated": true,\ \ "is_charge": true,\ \ "is_storno": true,\ \ "ordering": 0,\ \ "accounting_type": null,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "ref": "string",\ \ "ref_id": 0,\ \ "ref_uuid": "string",\ \ "uuid": "string",\ \ "business_line_id": 0\ \ }\ \ ] } }` ## [tag/Recurring-invoice](https://www.flowlu.com/api/\#tag/Recurring-invoice) Recurring invoice Recurring invoices ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | | [org\_account](https://www.flowlu.com/api/#tag/Bank%20account) | Finance | Bank account | org\_account\_id | | [client](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | customer\_id | | [pricelist](https://www.flowlu.com/api/#tag/Price%20list) | Products & Services | Price list | pricelist\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [items](https://www.flowlu.com/api/#tag/Recurring%20Invoice%20settings) | Finance | Recurring Invoice settings | invoice\_id | | [invoices](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | recurring\_invoice\_id | ## [tag/Recurring-invoice/paths/~1fin~1recurring_invoice~1create/post](https://www.flowlu.com/api/\#tag/Recurring-invoice/paths/~1fin~1recurring_invoice~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | repeat\_type | integer
Repeat every | | repeat\_settings | string
Repeat Every | | start\_date | string
Start date | | end\_date | string
End date | | next\_run\_date | string
Recurring invoice next run | | never\_expire | integer
Recuring invoice never expire | | due\_receipt | string
Due receipt | | create\_type | integer
Type | | active | boolean
If = 0, Inactive.
Default value = 1. | | assignee\_id | integer
Assigned user id | | customer\_name | string
Customer name | | customer\_legal\_name | string
Customer legal name | | contact\_person | string
Contact | | contact\_person\_position | string
Contact position | | show\_add\_sign\_string | boolean
Show additional sigh string | | contact\_person2 | string
Second person | | contact\_person2\_position | string
Second contact position | | currency\_id | integer
Currency symbol | | use\_multiple\_pm | boolean
Use of multiple linking to planned payments (Deprecated) | | currency\_code | string
Currency code | | exchange\_rate | rate
Exchange Rate | | sub\_total | number
Subtotal | | tax\_total | number
Tax total | | total | number
Total | | shipping\_charge | number
Shipping charge | | adjustment | number
Adjustment | | adjustment\_description | string
Adjustment description | | payment\_options | string
Payment options | | invoice\_footer\_text | string
Customer Notes | | invoice\_terms\_text | string
Terms and Conditions | | bill\_from\_address | string
Bill from address | | bill\_from\_city | string
Bill from city | | bill\_from\_state | string
Bill from state | | bill\_from\_zip | string
Bill from zip | | bill\_from\_country\_id | integer
Bill from country | | bill\_to\_address | string
Address | | bill\_to\_city | string
Bill to city | | bill\_to\_state | string
Bill to state | | bill\_to\_zip | string
Bill to ZIP | | bill\_to\_country\_id | integer
Country ID | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | | module | string
Module | | model | string
Model | | model\_id | integer
Model id | | group\_id | integer
Group id | | org\_id | integer
Organization id | | doc\_id | integer
Contract ID | | org\_account\_id | integer
Organization account id | | company\_phone | string
Phone | | company\_phone2 | string
Company second phone | | company\_vat | string
Business Tax ID | | company\_vat2 | string
VAT2 | | org\_phone | string
Organization phone | | org\_phone2 | string
Organization phone | | org\_vat | string
Business Tax ID | | org\_vat2 | string
Organization VAT 2 | | tax1 | number
Tax 1 (%) | | tax2 | number
Tax 2 (%) | | tax1\_included | boolean
1 - Include in price
0 - Not included | | tax2\_included | boolean
TAX2:
1 - Include in price
0 - Not included | | discount | number
Discount | | discount\_before\_tax | boolean
Discount before tax | | is\_discount\_percent | boolean
Is discount percent (Default - 1):
1 - Yes
0 - No
Default - 1 | | customer\_id | integer
Customer id | | uuid | string
A universally unique identifier (UUID) is a 128-bit number used to identify information in computer systems | | pricelist\_id | integer
Price list id | | paymethod\_id | integer
Payment method | | reference | string
Name of the import source of the object (system, etc.) | ### Responses **200** Successfully create an item post/fin/recurring\_invoice/create https://{company}.flowlu.com/api/v1/module/fin/recurring\_invoice/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "repeat_type": 0, "repeat_settings": "string", "start_date": "string", "end_date": "string", "next_run_date": "string", "never_expire": 0, "due_receipt": "string", "create_type": 0, "active": true, "assignee_id": 0, "customer_name": "string", "customer_legal_name": "string", "contact_person": "string", "contact_person_position": "string", "show_add_sign_string": true, "contact_person2": "string", "contact_person2_position": "string", "currency_id": 0, "use_multiple_pm": true, "currency_code": "string", "exchange_rate": null, "sub_total": 0, "tax_total": 0, "total": 0, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "payment_options": "string", "invoice_footer_text": "string", "invoice_terms_text": "string", "bill_from_address": "string", "bill_from_city": "string", "bill_from_state": "string", "bill_from_zip": "string", "bill_from_country_id": 0, "bill_to_address": "string", "bill_to_city": "string", "bill_to_state": "string", "bill_to_zip": "string", "bill_to_country_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "module": "string", "model": "string", "model_id": 0, "group_id": 0, "org_id": 0, "doc_id": 0, "org_account_id": 0, "company_phone": "string", "company_phone2": "string", "company_vat": "string", "company_vat2": "string", "org_phone": "string", "org_phone2": "string", "org_vat": "string", "org_vat2": "string", "tax1": 0, "tax2": 0, "tax1_included": true, "tax2_included": true, "discount": 0, "discount_before_tax": true, "is_discount_percent": true, "customer_id": 0, "uuid": "string", "pricelist_id": 0, "paymethod_id": 0, "reference": "string" } }` ## [tag/Recurring-invoice/paths/~1fin~1recurring_invoice~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Recurring-invoice/paths/~1fin~1recurring_invoice~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/recurring\_invoice/update/{id} https://{company}.flowlu.com/api/v1/module/fin/recurring\_invoice/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "repeat_type": 0, "repeat_settings": "string", "start_date": "string", "end_date": "string", "next_run_date": "string", "never_expire": 0, "due_receipt": "string", "create_type": 0, "active": true, "assignee_id": 0, "customer_name": "string", "customer_legal_name": "string", "contact_person": "string", "contact_person_position": "string", "show_add_sign_string": true, "contact_person2": "string", "contact_person2_position": "string", "currency_id": 0, "use_multiple_pm": true, "currency_code": "string", "exchange_rate": null, "sub_total": 0, "tax_total": 0, "total": 0, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "payment_options": "string", "invoice_footer_text": "string", "invoice_terms_text": "string", "bill_from_address": "string", "bill_from_city": "string", "bill_from_state": "string", "bill_from_zip": "string", "bill_from_country_id": 0, "bill_to_address": "string", "bill_to_city": "string", "bill_to_state": "string", "bill_to_zip": "string", "bill_to_country_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "module": "string", "model": "string", "model_id": 0, "group_id": 0, "org_id": 0, "doc_id": 0, "org_account_id": 0, "company_phone": "string", "company_phone2": "string", "company_vat": "string", "company_vat2": "string", "org_phone": "string", "org_phone2": "string", "org_vat": "string", "org_vat2": "string", "tax1": 0, "tax2": 0, "tax1_included": true, "tax2_included": true, "discount": 0, "discount_before_tax": true, "is_discount_percent": true, "customer_id": 0, "uuid": "string", "pricelist_id": 0, "paymethod_id": 0, "reference": "string" } }` ## [tag/Recurring-invoice/paths/~1fin~1recurring_invoice~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Recurring-invoice/paths/~1fin~1recurring_invoice~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/recurring\_invoice/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/recurring\_invoice/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Recurring-invoice/paths/~1fin~1recurring_invoice~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Recurring-invoice/paths/~1fin~1recurring_invoice~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/recurring\_invoice/get/{id} https://{company}.flowlu.com/api/v1/module/fin/recurring\_invoice/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "repeat_type": 0, "repeat_settings": "string", "start_date": "string", "end_date": "string", "next_run_date": "string", "never_expire": 0, "due_receipt": "string", "create_type": 0, "active": true, "assignee_id": 0, "customer_name": "string", "customer_legal_name": "string", "contact_person": "string", "contact_person_position": "string", "show_add_sign_string": true, "contact_person2": "string", "contact_person2_position": "string", "currency_id": 0, "use_multiple_pm": true, "currency_code": "string", "exchange_rate": null, "sub_total": 0, "tax_total": 0, "total": 0, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "payment_options": "string", "invoice_footer_text": "string", "invoice_terms_text": "string", "bill_from_address": "string", "bill_from_city": "string", "bill_from_state": "string", "bill_from_zip": "string", "bill_from_country_id": 0, "bill_to_address": "string", "bill_to_city": "string", "bill_to_state": "string", "bill_to_zip": "string", "bill_to_country_id": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string", "module": "string", "model": "string", "model_id": 0, "group_id": 0, "org_id": 0, "doc_id": 0, "org_account_id": 0, "company_phone": "string", "company_phone2": "string", "company_vat": "string", "company_vat2": "string", "org_phone": "string", "org_phone2": "string", "org_vat": "string", "org_vat2": "string", "tax1": 0, "tax2": 0, "tax1_included": true, "tax2_included": true, "discount": 0, "discount_before_tax": true, "is_discount_percent": true, "customer_id": 0, "uuid": "string", "pricelist_id": 0, "paymethod_id": 0, "reference": "string" } }` ## [tag/Recurring-invoice/paths/~1fin~1recurring_invoice~1list/get](https://www.flowlu.com/api/\#tag/Recurring-invoice/paths/~1fin~1recurring_invoice~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/recurring\_invoice/list https://{company}.flowlu.com/api/v1/module/fin/recurring\_invoice/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "repeat_type": 0,\ \ "repeat_settings": "string",\ \ "start_date": "string",\ \ "end_date": "string",\ \ "next_run_date": "string",\ \ "never_expire": 0,\ \ "due_receipt": "string",\ \ "create_type": 0,\ \ "active": true,\ \ "assignee_id": 0,\ \ "customer_name": "string",\ \ "customer_legal_name": "string",\ \ "contact_person": "string",\ \ "contact_person_position": "string",\ \ "show_add_sign_string": true,\ \ "contact_person2": "string",\ \ "contact_person2_position": "string",\ \ "currency_id": 0,\ \ "use_multiple_pm": true,\ \ "currency_code": "string",\ \ "exchange_rate": null,\ \ "sub_total": 0,\ \ "tax_total": 0,\ \ "total": 0,\ \ "shipping_charge": 0,\ \ "adjustment": 0,\ \ "adjustment_description": "string",\ \ "payment_options": "string",\ \ "invoice_footer_text": "string",\ \ "invoice_terms_text": "string",\ \ "bill_from_address": "string",\ \ "bill_from_city": "string",\ \ "bill_from_state": "string",\ \ "bill_from_zip": "string",\ \ "bill_from_country_id": 0,\ \ "bill_to_address": "string",\ \ "bill_to_city": "string",\ \ "bill_to_state": "string",\ \ "bill_to_zip": "string",\ \ "bill_to_country_id": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string",\ \ "module": "string",\ \ "model": "string",\ \ "model_id": 0,\ \ "group_id": 0,\ \ "org_id": 0,\ \ "doc_id": 0,\ \ "org_account_id": 0,\ \ "company_phone": "string",\ \ "company_phone2": "string",\ \ "company_vat": "string",\ \ "company_vat2": "string",\ \ "org_phone": "string",\ \ "org_phone2": "string",\ \ "org_vat": "string",\ \ "org_vat2": "string",\ \ "tax1": 0,\ \ "tax2": 0,\ \ "tax1_included": true,\ \ "tax2_included": true,\ \ "discount": 0,\ \ "discount_before_tax": true,\ \ "is_discount_percent": true,\ \ "customer_id": 0,\ \ "uuid": "string",\ \ "pricelist_id": 0,\ \ "paymethod_id": 0,\ \ "reference": "string"\ \ }\ \ ] } }` ## [tag/Liabilities](https://www.flowlu.com/api/\#tag/Liabilities) Liabilities ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | ## [tag/Liabilities/paths/~1fin~1commitment~1create/post](https://www.flowlu.com/api/\#tag/Liabilities/paths/~1fin~1commitment~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | date | string
Date | | description | string
Description | | type | string
Type | | crm\_acc\_id | integer
CRM account ID | | org\_id | integer
Organization id | | amount | integer
Liability amount | | currency\_id | integer
Currency symbol | | doc\_id | integer
Contract ID | | amount\_bcy | integer
Amount of the obligation in the base currency | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/fin/commitment/create https://{company}.flowlu.com/api/v1/module/fin/commitment/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "date": "string", "description": "string", "type": "string", "crm_acc_id": 0, "org_id": 0, "amount": 0, "currency_id": 0, "doc_id": 0, "amount_bcy": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Liabilities/paths/~1fin~1commitment~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Liabilities/paths/~1fin~1commitment~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/commitment/update/{id} https://{company}.flowlu.com/api/v1/module/fin/commitment/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "date": "string", "description": "string", "type": "string", "crm_acc_id": 0, "org_id": 0, "amount": 0, "currency_id": 0, "doc_id": 0, "amount_bcy": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Liabilities/paths/~1fin~1commitment~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Liabilities/paths/~1fin~1commitment~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/commitment/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/commitment/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Liabilities/paths/~1fin~1commitment~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Liabilities/paths/~1fin~1commitment~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/commitment/get/{id} https://{company}.flowlu.com/api/v1/module/fin/commitment/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "date": "string", "description": "string", "type": "string", "crm_acc_id": 0, "org_id": 0, "amount": 0, "currency_id": 0, "doc_id": 0, "amount_bcy": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Liabilities/paths/~1fin~1commitment~1list/get](https://www.flowlu.com/api/\#tag/Liabilities/paths/~1fin~1commitment~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/commitment/list https://{company}.flowlu.com/api/v1/module/fin/commitment/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "date": "string",\ \ "description": "string",\ \ "type": "string",\ \ "crm_acc_id": 0,\ \ "org_id": 0,\ \ "amount": 0,\ \ "currency_id": 0,\ \ "doc_id": 0,\ \ "amount_bcy": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Recurring-Invoice-settings](https://www.flowlu.com/api/\#tag/Recurring-Invoice-settings) Recurring Invoice settings ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [invoice](https://www.flowlu.com/api/#tag/Recurring%20invoice) | Finance | Recurring invoice | invoice\_id | | [product\_item](https://www.flowlu.com/api/#tag/Items) | Products & Services | Items | item\_id | | [plan\_money](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | plan\_money\_id | ## [tag/Recurring-Invoice-settings/paths/~1fin~1recurring_invoice_item~1create/post](https://www.flowlu.com/api/\#tag/Recurring-Invoice-settings/paths/~1fin~1recurring_invoice_item~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully create an item post/fin/recurring\_invoice\_item/create https://{company}.flowlu.com/api/v1/module/fin/recurring\_invoice\_item/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "invoice_id": 0, "ordering": 0, "item_id": 0, "plan_money_id": 0, "name": "string", "description": "string", "unit_price": 0, "unit_id": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": 0, "sub_total": 0, "tax_total": null, "tax_displayed": "string", "total": 0, "paid_total": 0, "bcy_paid_total": null, "plan_money_total": null, "paid_date": "string", "ref": "string", "ref_id": "string", "online_payment_type": 0, "online_payment_subject_type": 0, "online_payment_vat": 0, "type": 0 } }` ## [tag/Recurring-Invoice-settings/paths/~1fin~1recurring_invoice_item~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Recurring-Invoice-settings/paths/~1fin~1recurring_invoice_item~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/recurring\_invoice\_item/update/{id} https://{company}.flowlu.com/api/v1/module/fin/recurring\_invoice\_item/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "invoice_id": 0, "ordering": 0, "item_id": 0, "plan_money_id": 0, "name": "string", "description": "string", "unit_price": 0, "unit_id": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": 0, "sub_total": 0, "tax_total": null, "tax_displayed": "string", "total": 0, "paid_total": 0, "bcy_paid_total": null, "plan_money_total": null, "paid_date": "string", "ref": "string", "ref_id": "string", "online_payment_type": 0, "online_payment_subject_type": 0, "online_payment_vat": 0, "type": 0 } }` ## [tag/Recurring-Invoice-settings/paths/~1fin~1recurring_invoice_item~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Recurring-Invoice-settings/paths/~1fin~1recurring_invoice_item~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/recurring\_invoice\_item/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/recurring\_invoice\_item/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Recurring-Invoice-settings/paths/~1fin~1recurring_invoice_item~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Recurring-Invoice-settings/paths/~1fin~1recurring_invoice_item~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/recurring\_invoice\_item/get/{id} https://{company}.flowlu.com/api/v1/module/fin/recurring\_invoice\_item/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "invoice_id": 0, "ordering": 0, "item_id": 0, "plan_money_id": 0, "name": "string", "description": "string", "unit_price": 0, "unit_id": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": 0, "sub_total": 0, "tax_total": null, "tax_displayed": "string", "total": 0, "paid_total": 0, "bcy_paid_total": null, "plan_money_total": null, "paid_date": "string", "ref": "string", "ref_id": "string", "online_payment_type": 0, "online_payment_subject_type": 0, "online_payment_vat": 0, "type": 0 } }` ## [tag/Recurring-Invoice-settings/paths/~1fin~1recurring_invoice_item~1list/get](https://www.flowlu.com/api/\#tag/Recurring-Invoice-settings/paths/~1fin~1recurring_invoice_item~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/recurring\_invoice\_item/list https://{company}.flowlu.com/api/v1/module/fin/recurring\_invoice\_item/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, } }` ## [tag/Estimated-Cash-Flow](https://www.flowlu.com/api/\#tag/Estimated-Cash-Flow) Estimated Cash Flow Planned money ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | | [org\_account](https://www.flowlu.com/api/#tag/Bank%20account) | Finance | Bank account | org\_account\_id | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | project\_id | | [project\_stage](https://www.flowlu.com/api/#tag/Project%20stages) | Projects | Project stages | project\_stage\_id | | [company](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | crm\_company\_id | | [loan](https://www.flowlu.com/api/#tag/Borrowed%20Loans) | Borrowed Loans | Borrowed Loans | loan\_id | | [business\_line](https://www.flowlu.com/api/#tag/Business%20line) | Finance | Business line | business\_line\_id | #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [transactions](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | plan\_money\_id | | | [transactions\_in](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | plan\_money\_id | type = 10 | | [transactions\_out](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | plan\_money\_id | type = 20 | | [invoices](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | plan\_money\_id | | | [invoice\_items](https://www.flowlu.com/api/#tag/Invoice%20items) | Finance | Invoice items | plan\_money\_id | | | [children](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | parent\_id | | | [paymentlogs](https://www.flowlu.com/api/#tag/Payment%20history%20by%20estimated%20cash%20flow) | Finance | Payment history by estimated cash flow | plan\_money\_id | | | [transactions\_pls](https://www.flowlu.com/api/#tag/Transactions%20for%20the%20Profit%20and%20Loss%20statement) | Finance | Transactions for the Profit and Loss statement | plan\_money\_id | | | [store\_docs](https://www.flowlu.com/api/#tag/Stock%20documents) | Products & Services | Stock documents | plan\_money\_id | | ## [tag/Estimated-Cash-Flow/paths/~1fin~1plan_money~1create/post](https://www.flowlu.com/api/\#tag/Estimated-Cash-Flow/paths/~1fin~1plan_money~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | total | number
Total | | paid\_total | number
Paid sum | | vat\_total | number
VAT amount | | vat\_total\_bcy | bcy\_price
VAT amount in application base currency. System field, value is set automatically | | net\_total | number
Revenue plan | | net\_total\_bcy | bcy\_price
Revenue plan in the account base currency | | vat | number
VAT rate | | bcy\_paid\_total | bcy\_price
Amount in the account's base currency | | startdate | string
Start date | | enddate | string
End date | | last\_child\_date | string | | status\_paid | integer
Status:
0 - Not paid
10 - Paid
20 - Overpaid
30 - Partially paid
40 - Executed | | paid\_date | string
Payment creation date | | plan\_paid\_date | string
Estimated payment date | | pls\_date | string
Accrual Date | | type | integer
- 10 - planned income
- 20 - planned expense
- 30 - planned project income
- 40 - planned project expense
- 50 - planned based on invoice
- 60 - planned project task income
- 70 - planned project task expense | | is\_complete | boolean
Flag indicating whether the planned payment is completed:
- 0 - Not completed
- 1 - Completed | | is\_task\_default | boolean | | complete\_date | string | | is\_repeat | boolean
Recurring payment flag
- 1 - recurring payment
- 0 - one-time payment | | description | string
Description | | ordering | integer
Sorting | | parent\_id | integer | | last\_child\_id | integer | | crm\_company\_id | integer
CRM company id | | category\_id | integer
Category id Default- 0 | | manager\_id | integer
Assigned user id | | org\_id | integer
Organization id | | org\_account\_id | integer
Organization account id | | currency\_id | integer
Currency symbol | | invoice\_id | integer
Invoice ID | | tax\_id | integer | | project\_id | integer
Project id | | project\_stage\_id | integer
Project stage id | | budget\_id | integer
Budget ID | | business\_line\_id | integer
business line ID | | loan\_id | integer
Borrowing ID | | created\_by | integer
User id | | updated\_by | integer
User id | | created\_date | string
Created date | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/fin/plan\_money/create https://{company}.flowlu.com/api/v1/module/fin/plan\_money/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "total": 0, "paid_total": 0, "vat_total": 0, "vat_total_bcy": null, "net_total": 0, "net_total_bcy": null, "vat": 0, "bcy_paid_total": null, "startdate": "string", "enddate": "string", "last_child_date": "string", "status_paid": 0, "paid_date": "string", "plan_paid_date": "string", "pls_date": "string", "type": 0, "is_complete": true, "is_task_default": true, "complete_date": "string", "is_repeat": true, "description": "string", "ordering": 0, "parent_id": 0, "last_child_id": 0, "crm_company_id": 0, "category_id": 0, "manager_id": 0, "org_id": 0, "org_account_id": 0, "currency_id": 0, "invoice_id": 0, "tax_id": 0, "project_id": 0, "project_stage_id": 0, "budget_id": 0, "business_line_id": 0, "loan_id": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Estimated-Cash-Flow/paths/~1fin~1plan_money~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Estimated-Cash-Flow/paths/~1fin~1plan_money~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/plan\_money/update/{id} https://{company}.flowlu.com/api/v1/module/fin/plan\_money/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "total": 0, "paid_total": 0, "vat_total": 0, "vat_total_bcy": null, "net_total": 0, "net_total_bcy": null, "vat": 0, "bcy_paid_total": null, "startdate": "string", "enddate": "string", "last_child_date": "string", "status_paid": 0, "paid_date": "string", "plan_paid_date": "string", "pls_date": "string", "type": 0, "is_complete": true, "is_task_default": true, "complete_date": "string", "is_repeat": true, "description": "string", "ordering": 0, "parent_id": 0, "last_child_id": 0, "crm_company_id": 0, "category_id": 0, "manager_id": 0, "org_id": 0, "org_account_id": 0, "currency_id": 0, "invoice_id": 0, "tax_id": 0, "project_id": 0, "project_stage_id": 0, "budget_id": 0, "business_line_id": 0, "loan_id": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Estimated-Cash-Flow/paths/~1fin~1plan_money~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Estimated-Cash-Flow/paths/~1fin~1plan_money~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/plan\_money/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/plan\_money/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Estimated-Cash-Flow/paths/~1fin~1plan_money~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Estimated-Cash-Flow/paths/~1fin~1plan_money~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/plan\_money/get/{id} https://{company}.flowlu.com/api/v1/module/fin/plan\_money/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "total": 0, "paid_total": 0, "vat_total": 0, "vat_total_bcy": null, "net_total": 0, "net_total_bcy": null, "vat": 0, "bcy_paid_total": null, "startdate": "string", "enddate": "string", "last_child_date": "string", "status_paid": 0, "paid_date": "string", "plan_paid_date": "string", "pls_date": "string", "type": 0, "is_complete": true, "is_task_default": true, "complete_date": "string", "is_repeat": true, "description": "string", "ordering": 0, "parent_id": 0, "last_child_id": 0, "crm_company_id": 0, "category_id": 0, "manager_id": 0, "org_id": 0, "org_account_id": 0, "currency_id": 0, "invoice_id": 0, "tax_id": 0, "project_id": 0, "project_stage_id": 0, "budget_id": 0, "business_line_id": 0, "loan_id": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Estimated-Cash-Flow/paths/~1fin~1plan_money~1list/get](https://www.flowlu.com/api/\#tag/Estimated-Cash-Flow/paths/~1fin~1plan_money~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/plan\_money/list https://{company}.flowlu.com/api/v1/module/fin/plan\_money/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "total": 0,\ \ "paid_total": 0,\ \ "vat_total": 0,\ \ "vat_total_bcy": null,\ \ "net_total": 0,\ \ "net_total_bcy": null,\ \ "vat": 0,\ \ "bcy_paid_total": null,\ \ "startdate": "string",\ \ "enddate": "string",\ \ "last_child_date": "string",\ \ "status_paid": 0,\ \ "paid_date": "string",\ \ "plan_paid_date": "string",\ \ "pls_date": "string",\ \ "type": 0,\ \ "is_complete": true,\ \ "is_task_default": true,\ \ "complete_date": "string",\ \ "is_repeat": true,\ \ "description": "string",\ \ "ordering": 0,\ \ "parent_id": 0,\ \ "last_child_id": 0,\ \ "crm_company_id": 0,\ \ "category_id": 0,\ \ "manager_id": 0,\ \ "org_id": 0,\ \ "org_account_id": 0,\ \ "currency_id": 0,\ \ "invoice_id": 0,\ \ "tax_id": 0,\ \ "project_id": 0,\ \ "project_stage_id": 0,\ \ "budget_id": 0,\ \ "business_line_id": 0,\ \ "loan_id": 0,\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "created_date": "string",\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Linking-the-invoice-items](https://www.flowlu.com/api/\#tag/Linking-the-invoice-items) Linking the invoice items A table that stores account position relationships with task and time records ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [invoice](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | invoice\_id | ## [tag/Linking-the-invoice-items/paths/~1fin~1item_relations~1create/post](https://www.flowlu.com/api/\#tag/Linking-the-invoice-items/paths/~1fin~1item_relations~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | invoice\_item\_id | integer
Invoice item id | | invoice\_id | integer
Invoice ID | | module | string
Module | | model | string
Model | | model\_id | integer
Model id | | amount | number
Total | | created\_date | string
Created date | | updated\_date | string
Updated date | | created\_by | integer
User id | | updated\_by | integer
User id | ### Responses **200** Successfully create an item post/fin/item\_relations/create https://{company}.flowlu.com/api/v1/module/fin/item\_relations/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "invoice_item_id": 0, "invoice_id": 0, "module": "string", "model": "string", "model_id": 0, "amount": 0, "created_date": "string", "updated_date": "string", "created_by": 0, "updated_by": 0 } }` ## [tag/Linking-the-invoice-items/paths/~1fin~1item_relations~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Linking-the-invoice-items/paths/~1fin~1item_relations~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/item\_relations/update/{id} https://{company}.flowlu.com/api/v1/module/fin/item\_relations/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "invoice_item_id": 0, "invoice_id": 0, "module": "string", "model": "string", "model_id": 0, "amount": 0, "created_date": "string", "updated_date": "string", "created_by": 0, "updated_by": 0 } }` ## [tag/Linking-the-invoice-items/paths/~1fin~1item_relations~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Linking-the-invoice-items/paths/~1fin~1item_relations~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/item\_relations/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/item\_relations/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Linking-the-invoice-items/paths/~1fin~1item_relations~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Linking-the-invoice-items/paths/~1fin~1item_relations~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/item\_relations/get/{id} https://{company}.flowlu.com/api/v1/module/fin/item\_relations/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "invoice_item_id": 0, "invoice_id": 0, "module": "string", "model": "string", "model_id": 0, "amount": 0, "created_date": "string", "updated_date": "string", "created_by": 0, "updated_by": 0 } }` ## [tag/Linking-the-invoice-items/paths/~1fin~1item_relations~1list/get](https://www.flowlu.com/api/\#tag/Linking-the-invoice-items/paths/~1fin~1item_relations~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/item\_relations/list https://{company}.flowlu.com/api/v1/module/fin/item\_relations/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "invoice_item_id": 0,\ \ "invoice_id": 0,\ \ "module": "string",\ \ "model": "string",\ \ "model_id": 0,\ \ "amount": 0,\ \ "created_date": "string",\ \ "updated_date": "string",\ \ "created_by": 0,\ \ "updated_by": 0\ \ }\ \ ] } }` ## [tag/Payment-history-by-estimated-cash-flow](https://www.flowlu.com/api/\#tag/Payment-history-by-estimated-cash-flow) Payment history by estimated cash flow Payment history by estimated cash flow ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [plan\_money](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | plan\_money\_id | ## [tag/Payment-history-by-estimated-cash-flow/paths/~1fin~1plan_money_payment_log~1create/post](https://www.flowlu.com/api/\#tag/Payment-history-by-estimated-cash-flow/paths/~1fin~1plan_money_payment_log~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | date | string
Date | | total | number
Total | | bcy\_total | bcy\_price
The amount in the application's base currency | | plan\_money\_id | integer
Estimated Payment id | | module | string
Module | | model | string
Model | | model\_id | integer
Model id | | item\_id | integer
Item id | | currency\_id | integer
Currency symbol | | created\_by | integer
User id | | updated\_by | integer
User id | | created\_date | string
Created date | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/fin/plan\_money\_payment\_log/create https://{company}.flowlu.com/api/v1/module/fin/plan\_money\_payment\_log/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "date": "string", "total": 0, "bcy_total": null, "plan_money_id": 0, "module": "string", "model": "string", "model_id": 0, "item_id": 0, "currency_id": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Payment-history-by-estimated-cash-flow/paths/~1fin~1plan_money_payment_log~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Payment-history-by-estimated-cash-flow/paths/~1fin~1plan_money_payment_log~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/fin/plan\_money\_payment\_log/update/{id} https://{company}.flowlu.com/api/v1/module/fin/plan\_money\_payment\_log/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "date": "string", "total": 0, "bcy_total": null, "plan_money_id": 0, "module": "string", "model": "string", "model_id": 0, "item_id": 0, "currency_id": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Payment-history-by-estimated-cash-flow/paths/~1fin~1plan_money_payment_log~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Payment-history-by-estimated-cash-flow/paths/~1fin~1plan_money_payment_log~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/fin/plan\_money\_payment\_log/delete/{id} https://{company}.flowlu.com/api/v1/module/fin/plan\_money\_payment\_log/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Payment-history-by-estimated-cash-flow/paths/~1fin~1plan_money_payment_log~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Payment-history-by-estimated-cash-flow/paths/~1fin~1plan_money_payment_log~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/fin/plan\_money\_payment\_log/get/{id} https://{company}.flowlu.com/api/v1/module/fin/plan\_money\_payment\_log/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "date": "string", "total": 0, "bcy_total": null, "plan_money_id": 0, "module": "string", "model": "string", "model_id": 0, "item_id": 0, "currency_id": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Payment-history-by-estimated-cash-flow/paths/~1fin~1plan_money_payment_log~1list/get](https://www.flowlu.com/api/\#tag/Payment-history-by-estimated-cash-flow/paths/~1fin~1plan_money_payment_log~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/fin/plan\_money\_payment\_log/list https://{company}.flowlu.com/api/v1/module/fin/plan\_money\_payment\_log/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "date": "string",\ \ "total": 0,\ \ "bcy_total": null,\ \ "plan_money_id": 0,\ \ "module": "string",\ \ "model": "string",\ \ "model_id": 0,\ \ "item_id": 0,\ \ "currency_id": 0,\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "created_date": "string",\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Time-Tracker](https://www.flowlu.com/api/\#tag/Time-Tracker) Time Tracker The Time Tracker allows you to track time spent on tasks and projects, set the rate of your team's work hour and issue invoices to the customers based on the estimated and spent time. ## [tag/Time-sheet](https://www.flowlu.com/api/\#tag/Time-sheet) Time sheet ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [parent\_sheet](https://www.flowlu.com/api/#tag/Time%20sheet) | Time Tracker | Time sheet | parent\_sheet\_id | | | [invoice](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | invoice\_id | | | [task](https://www.flowlu.com/api/#tag/Tasks) | Tasks | Tasks | model\_id | module = task, model = task | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [timelogs](https://www.flowlu.com/api/#tag/TIme%20Log) | Time Tracker | TIme Log | timesheet\_id | | [child\_sheets](https://www.flowlu.com/api/#tag/Time%20sheet) | Time Tracker | Time sheet | parent\_sheet\_id | ## [tag/Time-sheet/paths/~1timetracker~1timesheets~1create/post](https://www.flowlu.com/api/\#tag/Time-sheet/paths/~1timetracker~1timesheets~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | parent\_sheet\_id | integer
Parent sheet id | | description | string
Description | | is\_billable | boolean
Is billable | | is\_billable\_employee | boolean
Whether the employee receives payment for their work | | aggregated\_time\_estimate | integer
Total Time Estimate | | time\_estimate | integer
Time estimate | | time\_spent | integer
Time spent | | rate | number
Rate | | billing\_rate | number
Billing rate | | employee\_cost\_rate | number
Cost per hour of employee work | | amount\_timespent | number
Amount time spent | | bill\_amount\_timespent | number
Parent sheet id | | amount\_timeestimate | number
Amount time estimate | | bill\_amount\_timeestimate | number
Bill amount time estimate | | bill\_cost\_timeestimate | number
Estimated time of planned flow amount | | bill\_cost\_timespent | number
Actual estimated time of planned consumption amount | | currency\_id | integer
Currency symbol | | module | string
Module | | model | string
Model | | model\_id | integer
Model id | | created\_date | string
Created date | | created\_by | integer
User id | | updated\_date | string
Updated date | | updated\_by | integer
User id | | bill\_time | integer
Bill time | | unbill\_time | integer
Unbilled time | | bill\_time\_type | string
Billed time type | | cost\_time\_type | string | | billing\_status | integer
Billing status | | invoice\_id | integer
Invoice ID (Deprecated) | | bill\_time\_estimate | integer
Bill time estimate | | unbill\_time\_estimate | integer
Unbill time estimate | ### Responses **200** Successfully create an item post/timetracker/timesheets/create https://{company}.flowlu.com/api/v1/module/timetracker/timesheets/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "parent_sheet_id": 0, "description": "string", "is_billable": true, "is_billable_employee": true, "aggregated_time_estimate": 0, "time_estimate": 0, "time_spent": 0, "rate": 0, "billing_rate": 0, "employee_cost_rate": 0, "amount_timespent": 0, "bill_amount_timespent": 0, "amount_timeestimate": 0, "bill_amount_timeestimate": 0, "bill_cost_timeestimate": 0, "bill_cost_timespent": 0, "currency_id": 0, "module": "string", "model": "string", "model_id": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0, "bill_time": 0, "unbill_time": 0, "bill_time_type": "string", "cost_time_type": "string", "billing_status": 0, "invoice_id": 0, "bill_time_estimate": 0, "unbill_time_estimate": 0 } }` ## [tag/Time-sheet/paths/~1timetracker~1timesheets~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Time-sheet/paths/~1timetracker~1timesheets~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/timetracker/timesheets/update/{id} https://{company}.flowlu.com/api/v1/module/timetracker/timesheets/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "parent_sheet_id": 0, "description": "string", "is_billable": true, "is_billable_employee": true, "aggregated_time_estimate": 0, "time_estimate": 0, "time_spent": 0, "rate": 0, "billing_rate": 0, "employee_cost_rate": 0, "amount_timespent": 0, "bill_amount_timespent": 0, "amount_timeestimate": 0, "bill_amount_timeestimate": 0, "bill_cost_timeestimate": 0, "bill_cost_timespent": 0, "currency_id": 0, "module": "string", "model": "string", "model_id": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0, "bill_time": 0, "unbill_time": 0, "bill_time_type": "string", "cost_time_type": "string", "billing_status": 0, "invoice_id": 0, "bill_time_estimate": 0, "unbill_time_estimate": 0 } }` ## [tag/Time-sheet/paths/~1timetracker~1timesheets~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Time-sheet/paths/~1timetracker~1timesheets~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/timetracker/timesheets/delete/{id} https://{company}.flowlu.com/api/v1/module/timetracker/timesheets/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Time-sheet/paths/~1timetracker~1timesheets~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Time-sheet/paths/~1timetracker~1timesheets~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/timetracker/timesheets/get/{id} https://{company}.flowlu.com/api/v1/module/timetracker/timesheets/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "parent_sheet_id": 0, "description": "string", "is_billable": true, "is_billable_employee": true, "aggregated_time_estimate": 0, "time_estimate": 0, "time_spent": 0, "rate": 0, "billing_rate": 0, "employee_cost_rate": 0, "amount_timespent": 0, "bill_amount_timespent": 0, "amount_timeestimate": 0, "bill_amount_timeestimate": 0, "bill_cost_timeestimate": 0, "bill_cost_timespent": 0, "currency_id": 0, "module": "string", "model": "string", "model_id": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0, "bill_time": 0, "unbill_time": 0, "bill_time_type": "string", "cost_time_type": "string", "billing_status": 0, "invoice_id": 0, "bill_time_estimate": 0, "unbill_time_estimate": 0 } }` ## [tag/Time-sheet/paths/~1timetracker~1timesheets~1list/get](https://www.flowlu.com/api/\#tag/Time-sheet/paths/~1timetracker~1timesheets~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/timetracker/timesheets/list https://{company}.flowlu.com/api/v1/module/timetracker/timesheets/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "parent_sheet_id": 0,\ \ "description": "string",\ \ "is_billable": true,\ \ "is_billable_employee": true,\ \ "aggregated_time_estimate": 0,\ \ "time_estimate": 0,\ \ "time_spent": 0,\ \ "rate": 0,\ \ "billing_rate": 0,\ \ "employee_cost_rate": 0,\ \ "amount_timespent": 0,\ \ "bill_amount_timespent": 0,\ \ "amount_timeestimate": 0,\ \ "bill_amount_timeestimate": 0,\ \ "bill_cost_timeestimate": 0,\ \ "bill_cost_timespent": 0,\ \ "currency_id": 0,\ \ "module": "string",\ \ "model": "string",\ \ "model_id": 0,\ \ "created_date": "string",\ \ "created_by": 0,\ \ "updated_date": "string",\ \ "updated_by": 0,\ \ "bill_time": 0,\ \ "unbill_time": 0,\ \ "bill_time_type": "string",\ \ "cost_time_type": "string",\ \ "billing_status": 0,\ \ "invoice_id": 0,\ \ "bill_time_estimate": 0,\ \ "unbill_time_estimate": 0\ \ }\ \ ] } }` ## [tag/TIme-Log](https://www.flowlu.com/api/\#tag/TIme-Log) TIme Log ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [timesheet](https://www.flowlu.com/api/#tag/Time%20sheet) | Time Tracker | Time sheet | timesheet\_id | | [invoice](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | invoice\_id | #### Has many relation | Alias | Module | Model | Foreign key | Foreigh keys | | --- | --- | --- | --- | --- | | [item\_relations](https://www.flowlu.com/api/#tag/Linking%20the%20invoice%20items) | Finance | Linking the invoice items | model\_id | module = timetracker, model = timelog | ## [tag/TIme-Log/paths/~1timetracker~1timelogs~1create/post](https://www.flowlu.com/api/\#tag/TIme-Log/paths/~1timetracker~1timelogs~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | is\_billable | boolean
Is billable | | is\_billable\_employee | boolean
CONFIG.M.TIMETRACKER.TIMELOGS.IS\_BILLABLE\_EMPLOYEE.DESC | | time\_spent | integer
Time spent | | rate | number
Rate | | billing\_rate | number
Billing rate | | employee\_cost\_rate | number
Cost per hour of employee work | | amount | number
Amount | | billing\_amount | number
Billing amount | | employee\_cost\_amount | number | | currency\_id | integer
Currency symbol | | timesheet\_id | integer
Timesheet id | | created\_date | string
Created date | | created\_by | integer
User id | | updated\_date | string
Updated date | | updated\_by | integer
User id | | user\_id | integer
Project and user relation | | is\_manual | boolean
```
Manual time tracker
``` | | start\_timestamp | integer
Time Tracker Started | | stop\_timestamp | integer
Time Tracker Finished | | is\_approved | boolean
Is approved | | invoice\_id | integer
Invoice ID (Deprecated) | | status | integer
Time log status:
- 10 - Running
- 20 - Pause
- 30 - Stopped
- 0 - New | ### Responses **200** Successfully create an item post/timetracker/timelogs/create https://{company}.flowlu.com/api/v1/module/timetracker/timelogs/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "is_billable": true, "is_billable_employee": true, "time_spent": 0, "rate": 0, "billing_rate": 0, "employee_cost_rate": 0, "amount": 0, "billing_amount": 0, "employee_cost_amount": 0, "currency_id": 0, "timesheet_id": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0, "user_id": 0, "is_manual": true, "start_timestamp": 0, "stop_timestamp": 0, "is_approved": true, "invoice_id": 0, "status": 0 } }` ## [tag/TIme-Log/paths/~1timetracker~1timelogs~1update~1{id}/post](https://www.flowlu.com/api/\#tag/TIme-Log/paths/~1timetracker~1timelogs~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/timetracker/timelogs/update/{id} https://{company}.flowlu.com/api/v1/module/timetracker/timelogs/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "is_billable": true, "is_billable_employee": true, "time_spent": 0, "rate": 0, "billing_rate": 0, "employee_cost_rate": 0, "amount": 0, "billing_amount": 0, "employee_cost_amount": 0, "currency_id": 0, "timesheet_id": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0, "user_id": 0, "is_manual": true, "start_timestamp": 0, "stop_timestamp": 0, "is_approved": true, "invoice_id": 0, "status": 0 } }` ## [tag/TIme-Log/paths/~1timetracker~1timelogs~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/TIme-Log/paths/~1timetracker~1timelogs~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/timetracker/timelogs/delete/{id} https://{company}.flowlu.com/api/v1/module/timetracker/timelogs/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/TIme-Log/paths/~1timetracker~1timelogs~1get~1{id}/get](https://www.flowlu.com/api/\#tag/TIme-Log/paths/~1timetracker~1timelogs~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/timetracker/timelogs/get/{id} https://{company}.flowlu.com/api/v1/module/timetracker/timelogs/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "is_billable": true, "is_billable_employee": true, "time_spent": 0, "rate": 0, "billing_rate": 0, "employee_cost_rate": 0, "amount": 0, "billing_amount": 0, "employee_cost_amount": 0, "currency_id": 0, "timesheet_id": 0, "created_date": "string", "created_by": 0, "updated_date": "string", "updated_by": 0, "user_id": 0, "is_manual": true, "start_timestamp": 0, "stop_timestamp": 0, "is_approved": true, "invoice_id": 0, "status": 0 } }` ## [tag/TIme-Log/paths/~1timetracker~1timelogs~1list/get](https://www.flowlu.com/api/\#tag/TIme-Log/paths/~1timetracker~1timelogs~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/timetracker/timelogs/list https://{company}.flowlu.com/api/v1/module/timetracker/timelogs/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "is_billable": true,\ \ "is_billable_employee": true,\ \ "time_spent": 0,\ \ "rate": 0,\ \ "billing_rate": 0,\ \ "employee_cost_rate": 0,\ \ "amount": 0,\ \ "billing_amount": 0,\ \ "employee_cost_amount": 0,\ \ "currency_id": 0,\ \ "timesheet_id": 0,\ \ "created_date": "string",\ \ "created_by": 0,\ \ "updated_date": "string",\ \ "updated_by": 0,\ \ "user_id": 0,\ \ "is_manual": true,\ \ "start_timestamp": 0,\ \ "stop_timestamp": 0,\ \ "is_approved": true,\ \ "invoice_id": 0,\ \ "status": 0\ \ }\ \ ] } }` ## [tag/User-rates](https://www.flowlu.com/api/\#tag/User-rates) User rates The individual user rates for the “Timetracker” module are described here ## [tag/User-rates/paths/~1timetracker~1billing_entities_list~1create/post](https://www.flowlu.com/api/\#tag/User-rates/paths/~1timetracker~1billing_entities_list~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | group\_id | integer | | user\_id | integer | | cost\_rate | number | | billing\_rate | number | | type | integer | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/timetracker/billing\_entities\_list/create https://{company}.flowlu.com/api/v1/module/timetracker/billing\_entities\_list/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "group_id": 0, "user_id": 0, "cost_rate": 0, "billing_rate": 0, "type": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/User-rates/paths/~1timetracker~1billing_entities_list~1update~1{id}/post](https://www.flowlu.com/api/\#tag/User-rates/paths/~1timetracker~1billing_entities_list~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/timetracker/billing\_entities\_list/update/{id} https://{company}.flowlu.com/api/v1/module/timetracker/billing\_entities\_list/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "group_id": 0, "user_id": 0, "cost_rate": 0, "billing_rate": 0, "type": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/User-rates/paths/~1timetracker~1billing_entities_list~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/User-rates/paths/~1timetracker~1billing_entities_list~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/timetracker/billing\_entities\_list/delete/{id} https://{company}.flowlu.com/api/v1/module/timetracker/billing\_entities\_list/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/User-rates/paths/~1timetracker~1billing_entities_list~1get~1{id}/get](https://www.flowlu.com/api/\#tag/User-rates/paths/~1timetracker~1billing_entities_list~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/timetracker/billing\_entities\_list/get/{id} https://{company}.flowlu.com/api/v1/module/timetracker/billing\_entities\_list/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "group_id": 0, "user_id": 0, "cost_rate": 0, "billing_rate": 0, "type": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/User-rates/paths/~1timetracker~1billing_entities_list~1list/get](https://www.flowlu.com/api/\#tag/User-rates/paths/~1timetracker~1billing_entities_list~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/timetracker/billing\_entities\_list/list https://{company}.flowlu.com/api/v1/module/timetracker/billing\_entities\_list/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "group_id": 0,\ \ "user_id": 0,\ \ "cost_rate": 0,\ \ "billing_rate": 0,\ \ "type": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Product](https://www.flowlu.com/api/\#tag/Product) Product The Products enable you to organize a custom list of products and services and capture vital information like manufacturer, price, category, etc.  This way, you can effortlessly add items to your invoices and estimates and send them to your clients. ## [tag/Items](https://www.flowlu.com/api/\#tag/Items) Items Items ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [business\_line](https://www.flowlu.com/api/#tag/Business%20line) | Finance | Business line | business\_line\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [estimate\_items](https://www.flowlu.com/api/#tag/Estimate%20items) | Finance | Estimate items | item\_id | ## [tag/Items/paths/~1products~1product~1create/post](https://www.flowlu.com/api/\#tag/Items/paths/~1products~1product~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | active | boolean
If = 0, Inactive.
Default value = 1. | | type | integer
Item type | | code | string
Item code | | article | string
SKU | | section\_id | integer
Item category id | | unit\_id | integer
Item unit id | | description | string
Description | | full\_description | string
Full item description | | created | string
Created date | | created\_by | integer
User id | | updated | string
Updated date | | updated\_by | integer
User id | | uom\_id | integer
UOM id | | code\_upc | string
UPS | | code\_ean | string
The International Article Number (also known as European Article Number or EAN) | | code\_mpn | string
Manufacturer Part Number | | code\_isbn | string
International Standard Book Number | | manufacturer\_id | integer
Manufacturer id | | taxable | boolean
Taxable | | tax | number
Tax rate (%) | | tax\_included | boolean
1 - Include in price
0 - Not included | | tax\_desc | string
Value when the tax rate is zero/not set | | country\_id | integer
Country ID code | | declaration\_number | string
Cargo Customs Declaration Number | | hide\_quantity | boolean
Quantity visibility in print form:
1 - Hide quantity
0 - Show quantity
Default: 0 | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | | online\_payment\_type | integer
Online payment type | | online\_payment\_subject\_type | integer
Online payment type | | online\_payment\_vat | integer | | category\_id | integer
Category id Default- 0 | | business\_line\_id | integer
Business line | ### Responses **200** Successfully create an item post/products/product/create https://{company}.flowlu.com/api/v1/module/products/product/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": true, "type": 0, "code": "string", "article": "string", "section_id": 0, "unit_id": 0, "description": "string", "full_description": "string", "created": "string", "created_by": 0, "updated": "string", "updated_by": 0, "uom_id": 0, "code_upc": "string", "code_ean": "string", "code_mpn": "string", "code_isbn": "string", "manufacturer_id": 0, "taxable": true, "tax": 0, "tax_included": true, "tax_desc": "string", "country_id": 0, "declaration_number": "string", "hide_quantity": true, "ref": "string", "ref_id": "string", "online_payment_type": 0, "online_payment_subject_type": 0, "online_payment_vat": 0, "category_id": 0, "business_line_id": 0 } }` ## [tag/Items/paths/~1products~1product~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Items/paths/~1products~1product~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/products/product/update/{id} https://{company}.flowlu.com/api/v1/module/products/product/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": true, "type": 0, "code": "string", "article": "string", "section_id": 0, "unit_id": 0, "description": "string", "full_description": "string", "created": "string", "created_by": 0, "updated": "string", "updated_by": 0, "uom_id": 0, "code_upc": "string", "code_ean": "string", "code_mpn": "string", "code_isbn": "string", "manufacturer_id": 0, "taxable": true, "tax": 0, "tax_included": true, "tax_desc": "string", "country_id": 0, "declaration_number": "string", "hide_quantity": true, "ref": "string", "ref_id": "string", "online_payment_type": 0, "online_payment_subject_type": 0, "online_payment_vat": 0, "category_id": 0, "business_line_id": 0 } }` ## [tag/Items/paths/~1products~1product~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Items/paths/~1products~1product~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/products/product/delete/{id} https://{company}.flowlu.com/api/v1/module/products/product/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Items/paths/~1products~1product~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Items/paths/~1products~1product~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/products/product/get/{id} https://{company}.flowlu.com/api/v1/module/products/product/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": true, "type": 0, "code": "string", "article": "string", "section_id": 0, "unit_id": 0, "description": "string", "full_description": "string", "created": "string", "created_by": 0, "updated": "string", "updated_by": 0, "uom_id": 0, "code_upc": "string", "code_ean": "string", "code_mpn": "string", "code_isbn": "string", "manufacturer_id": 0, "taxable": true, "tax": 0, "tax_included": true, "tax_desc": "string", "country_id": 0, "declaration_number": "string", "hide_quantity": true, "ref": "string", "ref_id": "string", "online_payment_type": 0, "online_payment_subject_type": 0, "online_payment_vat": 0, "category_id": 0, "business_line_id": 0 } }` ## [tag/Items/paths/~1products~1product~1list/get](https://www.flowlu.com/api/\#tag/Items/paths/~1products~1product~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/products/product/list https://{company}.flowlu.com/api/v1/module/products/product/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "active": true,\ \ "type": 0,\ \ "code": "string",\ \ "article": "string",\ \ "section_id": 0,\ \ "unit_id": 0,\ \ "description": "string",\ \ "full_description": "string",\ \ "created": "string",\ \ "created_by": 0,\ \ "updated": "string",\ \ "updated_by": 0,\ \ "uom_id": 0,\ \ "code_upc": "string",\ \ "code_ean": "string",\ \ "code_mpn": "string",\ \ "code_isbn": "string",\ \ "manufacturer_id": 0,\ \ "taxable": true,\ \ "tax": 0,\ \ "tax_included": true,\ \ "tax_desc": "string",\ \ "country_id": 0,\ \ "declaration_number": "string",\ \ "hide_quantity": true,\ \ "ref": "string",\ \ "ref_id": "string",\ \ "online_payment_type": 0,\ \ "online_payment_subject_type": 0,\ \ "online_payment_vat": 0,\ \ "category_id": 0,\ \ "business_line_id": 0\ \ }\ \ ] } }` ## [tag/Categories](https://www.flowlu.com/api/\#tag/Categories) Categories Categories ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [items](https://www.flowlu.com/api/#tag/Items) | Products & Services | Items | section\_id | ## [tag/Categories/paths/~1products~1category~1create/post](https://www.flowlu.com/api/\#tag/Categories/paths/~1products~1category~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | active | boolean
If = 0, Inactive.
Default value = 1. | | parent\_id | integer
Parent id | | created | string
Created date | | created\_by | integer
User id | | updated | string
Updated date | | updated\_by | integer
User id | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | ### Responses **200** Successfully create an item post/products/category/create https://{company}.flowlu.com/api/v1/module/products/category/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "active": true, "parent_id": 0, "created": "string", "created_by": 0, "updated": "string", "updated_by": 0, "ref": "string", "ref_id": "string" } }` ## [tag/Categories/paths/~1products~1category~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Categories/paths/~1products~1category~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/products/category/update/{id} https://{company}.flowlu.com/api/v1/module/products/category/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "active": true, "parent_id": 0, "created": "string", "created_by": 0, "updated": "string", "updated_by": 0, "ref": "string", "ref_id": "string" } }` ## [tag/Categories/paths/~1products~1category~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Categories/paths/~1products~1category~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/products/category/delete/{id} https://{company}.flowlu.com/api/v1/module/products/category/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Categories/paths/~1products~1category~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Categories/paths/~1products~1category~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/products/category/get/{id} https://{company}.flowlu.com/api/v1/module/products/category/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "active": true, "parent_id": 0, "created": "string", "created_by": 0, "updated": "string", "updated_by": 0, "ref": "string", "ref_id": "string" } }` ## [tag/Categories/paths/~1products~1category~1list/get](https://www.flowlu.com/api/\#tag/Categories/paths/~1products~1category~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/products/category/list https://{company}.flowlu.com/api/v1/module/products/category/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "active": true,\ \ "parent_id": 0,\ \ "created": "string",\ \ "created_by": 0,\ \ "updated": "string",\ \ "updated_by": 0,\ \ "ref": "string",\ \ "ref_id": "string"\ \ }\ \ ] } }` ## [tag/Price-list](https://www.flowlu.com/api/\#tag/Price-list) Price list Price list ## [tag/Price-list/paths/~1products~1pricelist~1create/post](https://www.flowlu.com/api/\#tag/Price-list/paths/~1products~1pricelist~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | active | boolean
If = 0, Inactive.
Default value = 1. | | default | boolean | | type | integer
Type | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | description | string
Description | | created | string
Created | | created\_by | integer
User id | | updated | string
Updated date | | updated\_by | integer
User id | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | ### Responses **200** Successfully create an item post/products/pricelist/create https://{company}.flowlu.com/api/v1/module/products/pricelist/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": true, "default": true, "type": 0, "ordering": 0, "description": "string", "created": "string", "created_by": 0, "updated": "string", "updated_by": 0, "ref": "string", "ref_id": "string" } }` ## [tag/Price-list/paths/~1products~1pricelist~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Price-list/paths/~1products~1pricelist~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/products/pricelist/update/{id} https://{company}.flowlu.com/api/v1/module/products/pricelist/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": true, "default": true, "type": 0, "ordering": 0, "description": "string", "created": "string", "created_by": 0, "updated": "string", "updated_by": 0, "ref": "string", "ref_id": "string" } }` ## [tag/Price-list/paths/~1products~1pricelist~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Price-list/paths/~1products~1pricelist~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/products/pricelist/delete/{id} https://{company}.flowlu.com/api/v1/module/products/pricelist/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Price-list/paths/~1products~1pricelist~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Price-list/paths/~1products~1pricelist~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/products/pricelist/get/{id} https://{company}.flowlu.com/api/v1/module/products/pricelist/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": true, "default": true, "type": 0, "ordering": 0, "description": "string", "created": "string", "created_by": 0, "updated": "string", "updated_by": 0, "ref": "string", "ref_id": "string" } }` ## [tag/Price-list/paths/~1products~1pricelist~1list/get](https://www.flowlu.com/api/\#tag/Price-list/paths/~1products~1pricelist~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/products/pricelist/list https://{company}.flowlu.com/api/v1/module/products/pricelist/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "active": true,\ \ "default": true,\ \ "type": 0,\ \ "ordering": 0,\ \ "description": "string",\ \ "created": "string",\ \ "created_by": 0,\ \ "updated": "string",\ \ "updated_by": 0,\ \ "ref": "string",\ \ "ref_id": "string"\ \ }\ \ ] } }` ## [tag/Price-list-and-item-relation](https://www.flowlu.com/api/\#tag/Price-list-and-item-relation) Price list and item relation Price list and item relation ## [tag/Price-list-and-item-relation/paths/~1products~1pricelist_item~1create/post](https://www.flowlu.com/api/\#tag/Price-list-and-item-relation/paths/~1products~1pricelist_item~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | pricelist\_id | integer
Price list id | | currency\_id | integer
Currency Id of estimated revenue | | item\_id | integer
Item id | | price | number
Item id | | created | string
Created date | | created\_by | integer
User id | | updated | string
Updated date | | updated\_by | integer
User id | ### Responses **200** Successfully create an item post/products/pricelist\_item/create https://{company}.flowlu.com/api/v1/module/products/pricelist\_item/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "pricelist_id": 0, "currency_id": 0, "item_id": 0, "price": 0, "created": "string", "created_by": 0, "updated": "string", "updated_by": 0 } }` ## [tag/Price-list-and-item-relation/paths/~1products~1pricelist_item~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Price-list-and-item-relation/paths/~1products~1pricelist_item~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/products/pricelist\_item/update/{id} https://{company}.flowlu.com/api/v1/module/products/pricelist\_item/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "pricelist_id": 0, "currency_id": 0, "item_id": 0, "price": 0, "created": "string", "created_by": 0, "updated": "string", "updated_by": 0 } }` ## [tag/Price-list-and-item-relation/paths/~1products~1pricelist_item~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Price-list-and-item-relation/paths/~1products~1pricelist_item~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/products/pricelist\_item/delete/{id} https://{company}.flowlu.com/api/v1/module/products/pricelist\_item/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Price-list-and-item-relation/paths/~1products~1pricelist_item~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Price-list-and-item-relation/paths/~1products~1pricelist_item~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/products/pricelist\_item/get/{id} https://{company}.flowlu.com/api/v1/module/products/pricelist\_item/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "pricelist_id": 0, "currency_id": 0, "item_id": 0, "price": 0, "created": "string", "created_by": 0, "updated": "string", "updated_by": 0 } }` ## [tag/Price-list-and-item-relation/paths/~1products~1pricelist_item~1list/get](https://www.flowlu.com/api/\#tag/Price-list-and-item-relation/paths/~1products~1pricelist_item~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/products/pricelist\_item/list https://{company}.flowlu.com/api/v1/module/products/pricelist\_item/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "pricelist_id": 0,\ \ "currency_id": 0,\ \ "item_id": 0,\ \ "price": 0,\ \ "created": "string",\ \ "created_by": 0,\ \ "updated": "string",\ \ "updated_by": 0\ \ }\ \ ] } }` ## [tag/Price](https://www.flowlu.com/api/\#tag/Price) Price Manufacturers ## [tag/Price/paths/~1products~1manufacturer~1create/post](https://www.flowlu.com/api/\#tag/Price/paths/~1products~1manufacturer~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | active | boolean
If = 0, Inactive.
Default value = 1. | | description | string
Description | | created | string
Created date | | created\_by | integer
User id | | updated | string
Updated date | | updated\_by | integer
User id | | currency\_id | integer
Currency symbol | | crm\_company\_id | integer
CRM company id | | ref | string
Name of the import source of the object (system, etc.) | | ref\_id | string
UUID in the system from where the import was made. | ### Responses **200** Successfully create an item post/products/manufacturer/create https://{company}.flowlu.com/api/v1/module/products/manufacturer/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": true, "description": "string", "created": "string", "created_by": 0, "updated": "string", "updated_by": 0, "currency_id": 0, "crm_company_id": 0, "ref": "string", "ref_id": "string" } }` ## [tag/Price/paths/~1products~1manufacturer~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Price/paths/~1products~1manufacturer~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/products/manufacturer/update/{id} https://{company}.flowlu.com/api/v1/module/products/manufacturer/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": true, "description": "string", "created": "string", "created_by": 0, "updated": "string", "updated_by": 0, "currency_id": 0, "crm_company_id": 0, "ref": "string", "ref_id": "string" } }` ## [tag/Price/paths/~1products~1manufacturer~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Price/paths/~1products~1manufacturer~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/products/manufacturer/delete/{id} https://{company}.flowlu.com/api/v1/module/products/manufacturer/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Price/paths/~1products~1manufacturer~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Price/paths/~1products~1manufacturer~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/products/manufacturer/get/{id} https://{company}.flowlu.com/api/v1/module/products/manufacturer/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "active": true, "description": "string", "created": "string", "created_by": 0, "updated": "string", "updated_by": 0, "currency_id": 0, "crm_company_id": 0, "ref": "string", "ref_id": "string" } }` ## [tag/Price/paths/~1products~1manufacturer~1list/get](https://www.flowlu.com/api/\#tag/Price/paths/~1products~1manufacturer~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/products/manufacturer/list https://{company}.flowlu.com/api/v1/module/products/manufacturer/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "active": true,\ \ "description": "string",\ \ "created": "string",\ \ "created_by": 0,\ \ "updated": "string",\ \ "updated_by": 0,\ \ "currency_id": 0,\ \ "crm_company_id": 0,\ \ "ref": "string",\ \ "ref_id": "string"\ \ }\ \ ] } }` ## [tag/Units](https://www.flowlu.com/api/\#tag/Units) Units Units ## [tag/Units/paths/~1products~1units~1create/post](https://www.flowlu.com/api/\#tag/Units/paths/~1products~1units~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | symbol | string
Short name | | active | boolean
If = 0, Inactive.
Default value = 1. | | code | string
Code | | description | string
Description | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | created | string
Created date | | created\_by | integer
User id | | updated | string
Updated date | | updated\_by | integer
User id | ### Responses **200** Successfully create an item post/products/units/create https://{company}.flowlu.com/api/v1/module/products/units/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "symbol": "string", "active": true, "code": "string", "description": "string", "ordering": 0, "created": "string", "created_by": 0, "updated": "string", "updated_by": 0 } }` ## [tag/Units/paths/~1products~1units~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Units/paths/~1products~1units~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/products/units/update/{id} https://{company}.flowlu.com/api/v1/module/products/units/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "symbol": "string", "active": true, "code": "string", "description": "string", "ordering": 0, "created": "string", "created_by": 0, "updated": "string", "updated_by": 0 } }` ## [tag/Units/paths/~1products~1units~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Units/paths/~1products~1units~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/products/units/delete/{id} https://{company}.flowlu.com/api/v1/module/products/units/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Units/paths/~1products~1units~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Units/paths/~1products~1units~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/products/units/get/{id} https://{company}.flowlu.com/api/v1/module/products/units/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "symbol": "string", "active": true, "code": "string", "description": "string", "ordering": 0, "created": "string", "created_by": 0, "updated": "string", "updated_by": 0 } }` ## [tag/Units/paths/~1products~1units~1list/get](https://www.flowlu.com/api/\#tag/Units/paths/~1products~1units~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/products/units/list https://{company}.flowlu.com/api/v1/module/products/units/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "symbol": "string",\ \ "active": true,\ \ "code": "string",\ \ "description": "string",\ \ "ordering": 0,\ \ "created": "string",\ \ "created_by": 0,\ \ "updated": "string",\ \ "updated_by": 0\ \ }\ \ ] } }` ## [tag/Warehouses](https://www.flowlu.com/api/\#tag/Warehouses) Warehouses Warehouses ## [tag/Warehouses/paths/~1products~1store~1create/post](https://www.flowlu.com/api/\#tag/Warehouses/paths/~1products~1store~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | access\_type | integer | | address | string
Address | | description | string
Description | | active | boolean
If = 0, Inactive.
Default value = 1. | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | created\_by | integer
User id | | updated\_by | integer
Updated date | | created\_date | string
Created date | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/products/store/create https://{company}.flowlu.com/api/v1/module/products/store/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "access_type": 0, "address": "string", "description": "string", "active": true, "ordering": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Warehouses/paths/~1products~1store~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Warehouses/paths/~1products~1store~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/products/store/update/{id} https://{company}.flowlu.com/api/v1/module/products/store/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "access_type": 0, "address": "string", "description": "string", "active": true, "ordering": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Warehouses/paths/~1products~1store~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Warehouses/paths/~1products~1store~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/products/store/delete/{id} https://{company}.flowlu.com/api/v1/module/products/store/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Warehouses/paths/~1products~1store~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Warehouses/paths/~1products~1store~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/products/store/get/{id} https://{company}.flowlu.com/api/v1/module/products/store/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "access_type": 0, "address": "string", "description": "string", "active": true, "ordering": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Warehouses/paths/~1products~1store~1list/get](https://www.flowlu.com/api/\#tag/Warehouses/paths/~1products~1store~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/products/store/list https://{company}.flowlu.com/api/v1/module/products/store/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "access_type": 0,\ \ "address": "string",\ \ "description": "string",\ \ "active": true,\ \ "ordering": 0,\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "created_date": "string",\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Stock-documents](https://www.flowlu.com/api/\#tag/Stock-documents) Stock documents Stock documents ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [client](https://www.flowlu.com/api/#tag/Accounts) | CRM | Accounts | crm\_company\_id | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | | [pricelist](https://www.flowlu.com/api/#tag/Price%20list) | Products & Services | Price list | pricelist\_id | | [store](https://www.flowlu.com/api/#tag/Warehouses) | Products & Services | Warehouses | store\_id | | [sender\_store](https://www.flowlu.com/api/#tag/Warehouses) | Products & Services | Warehouses | sender\_store\_id | | [project](https://www.flowlu.com/api/#tag/Project) | Projects | Project | project\_id | | [lead](https://www.flowlu.com/api/#tag/Opportunities) | CRM | Opportunities | crm\_lead\_id | | [invoice](https://www.flowlu.com/api/#tag/Invoice) | Finance | Invoice | invoice\_id | | [plan\_money](https://www.flowlu.com/api/#tag/Estimated%20Cash%20Flow) | Finance | Estimated Cash Flow | plan\_money\_id | #### Has many relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [items](https://www.flowlu.com/api/#tag/Stock%20document%20goods) | Products & Services | Stock document goods | store\_doc\_id | | [transactions](https://www.flowlu.com/api/#tag/Transaction) | Finance | Transaction | store\_doc\_id | | [transactions\_pls](https://www.flowlu.com/api/#tag/Transactions%20for%20the%20Profit%20and%20Loss%20statement) | Finance | Transactions for the Profit and Loss statement | store\_doc\_id | ## [tag/Stock-documents/paths/~1products~1store_document~1create/post](https://www.flowlu.com/api/\#tag/Stock-documents/paths/~1products~1store_document~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | type | integer
Type | | status | integer | | paid\_status | integer | | date | string
Date | | total | number
Total | | shipping\_charge | number
Shipping charge | | adjustment | number
Adjustment | | adjustment\_description | string
Adjustment description | | org\_id | integer
Organization id | | currency\_id | integer | | currency\_code | string | | paid\_total | number
Paid sum | | bcy\_paid\_total | bcy\_price
Amount in the account's base currency | | plan\_money\_total | bcy\_price
Amount of estimated revenue | | crm\_company\_id | integer
CRM company id | | crm\_lead\_id | integer
Opportunity ID | | invoice\_id | integer
Invoice ID | | manager\_id | integer
Assigned user id | | pricelist\_id | integer
Price list id | | project\_id | integer
Project id | | plan\_money\_id | integer
Estimated Payment id | | store\_id | integer | | sender\_store\_id | integer | | reason | string
Name of the import source of the object (system, etc.) | | doc\_number | integer
Document number | | utd\_template\_id | integer
ID of the linked UTD template | | company\_name | string
Company Name | | company\_legal\_name | string
Company legal name | | company\_phone | string
Phone | | company\_phone2 | string
Company second phone | | company\_vat | string
Business Tax ID | | company\_vat2 | string
Additional Account VAT (or TAX ID) | | org\_name | string | | org\_legal\_name | string | | org\_phone | string
Organization phone | | org\_phone2 | string
Organization phone | | org\_vat | string
Business Tax ID | | org\_vat2 | string
Organization VAT 2 | | bill\_from\_address | string
Bill from address | | bill\_from\_city | string
Bill from city | | bill\_from\_state | string
Bill from state | | bill\_from\_zip | string
Bill from zip | | bill\_from\_country\_id | integer
Bill from country | | bill\_to\_address | string
Address | | bill\_to\_city | string
Bill to city | | bill\_to\_state | string
Bill to state | | bill\_to\_zip | string
Bill to ZIP | | bill\_to\_country\_id | integer
Country ID | | created\_by | integer
User id | | updated\_by | integer
Updated date | | created\_date | string
Created date | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/products/store\_document/create https://{company}.flowlu.com/api/v1/module/products/store\_document/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "type": 0, "status": 0, "paid_status": 0, "date": "string", "total": 0, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "org_id": 0, "currency_id": 0, "currency_code": "string", "paid_total": 0, "bcy_paid_total": null, "plan_money_total": null, "crm_company_id": 0, "crm_lead_id": 0, "invoice_id": 0, "manager_id": 0, "pricelist_id": 0, "project_id": 0, "plan_money_id": 0, "store_id": 0, "sender_store_id": 0, "reason": "string", "doc_number": 0, "utd_template_id": 0, "company_name": "string", "company_legal_name": "string", "company_phone": "string", "company_phone2": "string", "company_vat": "string", "company_vat2": "string", "org_name": "string", "org_legal_name": "string", "org_phone": "string", "org_phone2": "string", "org_vat": "string", "org_vat2": "string", "bill_from_address": "string", "bill_from_city": "string", "bill_from_state": "string", "bill_from_zip": "string", "bill_from_country_id": 0, "bill_to_address": "string", "bill_to_city": "string", "bill_to_state": "string", "bill_to_zip": "string", "bill_to_country_id": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Stock-documents/paths/~1products~1store_document~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Stock-documents/paths/~1products~1store_document~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/products/store\_document/update/{id} https://{company}.flowlu.com/api/v1/module/products/store\_document/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "type": 0, "status": 0, "paid_status": 0, "date": "string", "total": 0, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "org_id": 0, "currency_id": 0, "currency_code": "string", "paid_total": 0, "bcy_paid_total": null, "plan_money_total": null, "crm_company_id": 0, "crm_lead_id": 0, "invoice_id": 0, "manager_id": 0, "pricelist_id": 0, "project_id": 0, "plan_money_id": 0, "store_id": 0, "sender_store_id": 0, "reason": "string", "doc_number": 0, "utd_template_id": 0, "company_name": "string", "company_legal_name": "string", "company_phone": "string", "company_phone2": "string", "company_vat": "string", "company_vat2": "string", "org_name": "string", "org_legal_name": "string", "org_phone": "string", "org_phone2": "string", "org_vat": "string", "org_vat2": "string", "bill_from_address": "string", "bill_from_city": "string", "bill_from_state": "string", "bill_from_zip": "string", "bill_from_country_id": 0, "bill_to_address": "string", "bill_to_city": "string", "bill_to_state": "string", "bill_to_zip": "string", "bill_to_country_id": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Stock-documents/paths/~1products~1store_document~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Stock-documents/paths/~1products~1store_document~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/products/store\_document/delete/{id} https://{company}.flowlu.com/api/v1/module/products/store\_document/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Stock-documents/paths/~1products~1store_document~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Stock-documents/paths/~1products~1store_document~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/products/store\_document/get/{id} https://{company}.flowlu.com/api/v1/module/products/store\_document/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "type": 0, "status": 0, "paid_status": 0, "date": "string", "total": 0, "shipping_charge": 0, "adjustment": 0, "adjustment_description": "string", "org_id": 0, "currency_id": 0, "currency_code": "string", "paid_total": 0, "bcy_paid_total": null, "plan_money_total": null, "crm_company_id": 0, "crm_lead_id": 0, "invoice_id": 0, "manager_id": 0, "pricelist_id": 0, "project_id": 0, "plan_money_id": 0, "store_id": 0, "sender_store_id": 0, "reason": "string", "doc_number": 0, "utd_template_id": 0, "company_name": "string", "company_legal_name": "string", "company_phone": "string", "company_phone2": "string", "company_vat": "string", "company_vat2": "string", "org_name": "string", "org_legal_name": "string", "org_phone": "string", "org_phone2": "string", "org_vat": "string", "org_vat2": "string", "bill_from_address": "string", "bill_from_city": "string", "bill_from_state": "string", "bill_from_zip": "string", "bill_from_country_id": 0, "bill_to_address": "string", "bill_to_city": "string", "bill_to_state": "string", "bill_to_zip": "string", "bill_to_country_id": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Stock-documents/paths/~1products~1store_document~1list/get](https://www.flowlu.com/api/\#tag/Stock-documents/paths/~1products~1store_document~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/products/store\_document/list https://{company}.flowlu.com/api/v1/module/products/store\_document/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "type": 0,\ \ "status": 0,\ \ "paid_status": 0,\ \ "date": "string",\ \ "total": 0,\ \ "shipping_charge": 0,\ \ "adjustment": 0,\ \ "adjustment_description": "string",\ \ "org_id": 0,\ \ "currency_id": 0,\ \ "currency_code": "string",\ \ "paid_total": 0,\ \ "bcy_paid_total": null,\ \ "plan_money_total": null,\ \ "crm_company_id": 0,\ \ "crm_lead_id": 0,\ \ "invoice_id": 0,\ \ "manager_id": 0,\ \ "pricelist_id": 0,\ \ "project_id": 0,\ \ "plan_money_id": 0,\ \ "store_id": 0,\ \ "sender_store_id": 0,\ \ "reason": "string",\ \ "doc_number": 0,\ \ "utd_template_id": 0,\ \ "company_name": "string",\ \ "company_legal_name": "string",\ \ "company_phone": "string",\ \ "company_phone2": "string",\ \ "company_vat": "string",\ \ "company_vat2": "string",\ \ "org_name": "string",\ \ "org_legal_name": "string",\ \ "org_phone": "string",\ \ "org_phone2": "string",\ \ "org_vat": "string",\ \ "org_vat2": "string",\ \ "bill_from_address": "string",\ \ "bill_from_city": "string",\ \ "bill_from_state": "string",\ \ "bill_from_zip": "string",\ \ "bill_from_country_id": 0,\ \ "bill_to_address": "string",\ \ "bill_to_city": "string",\ \ "bill_to_state": "string",\ \ "bill_to_zip": "string",\ \ "bill_to_country_id": 0,\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "created_date": "string",\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Stock-document-goods](https://www.flowlu.com/api/\#tag/Stock-document-goods) Stock document goods Stock document goods ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [store\_doc](https://www.flowlu.com/api/#tag/Stock%20documents) | Products & Services | Stock documents | store\_doc\_id | | [product\_item](https://www.flowlu.com/api/#tag/Items) | Products & Services | Items | item\_id | ## [tag/Stock-document-goods/paths/~1products~1document_items~1create/post](https://www.flowlu.com/api/\#tag/Stock-document-goods/paths/~1products~1document_items~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | unit\_price | number
Unit price | | quantity | tax
Quantity | | tax1 | number
Tax 1 (%) | | tax1\_included | boolean
1 - Include in price
0 - Not included | | tax1\_amount | number
Tax amount | | tax2 | number
Tax 2 (%) | | tax2\_included | boolean
TAX2:
1 - Include in price
0 - Not included | | tax2\_amount | number
Tax | | discount\_amount | number
Discount amount (calculated field based on discount) | | discount | string
Discount | | discount\_is\_percent | boolean
Is discount percent (Default - 1):
1 - Yes
0 - No
Default - 1 | | sub\_total | number
Subtotal | | tax\_total | tax
Tax total | | tax\_displayed | string
The tax value displayed in printed forms (%) | | country\_id | integer
Country ID code | | declaration\_number | string
Cargo Customs Declaration Number | | total | number
Total | | store\_doc\_id | integer | | item\_id | integer | | variation\_id | integer | | unit\_id | integer | | type | integer | | ordering | integer
Document number | | created\_by | integer
User id | | updated\_by | integer
Updated date | | created\_date | string
Created date | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/products/document\_items/create https://{company}.flowlu.com/api/v1/module/products/document\_items/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "unit_price": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": true, "sub_total": 0, "tax_total": null, "tax_displayed": "string", "country_id": 0, "declaration_number": "string", "total": 0, "store_doc_id": 0, "item_id": 0, "variation_id": 0, "unit_id": 0, "type": 0, "ordering": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Stock-document-goods/paths/~1products~1document_items~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Stock-document-goods/paths/~1products~1document_items~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/products/document\_items/update/{id} https://{company}.flowlu.com/api/v1/module/products/document\_items/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "unit_price": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": true, "sub_total": 0, "tax_total": null, "tax_displayed": "string", "country_id": 0, "declaration_number": "string", "total": 0, "store_doc_id": 0, "item_id": 0, "variation_id": 0, "unit_id": 0, "type": 0, "ordering": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Stock-document-goods/paths/~1products~1document_items~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Stock-document-goods/paths/~1products~1document_items~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/products/document\_items/delete/{id} https://{company}.flowlu.com/api/v1/module/products/document\_items/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Stock-document-goods/paths/~1products~1document_items~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Stock-document-goods/paths/~1products~1document_items~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/products/document\_items/get/{id} https://{company}.flowlu.com/api/v1/module/products/document\_items/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "unit_price": 0, "quantity": null, "tax1": 0, "tax1_included": true, "tax1_amount": 0, "tax2": 0, "tax2_included": true, "tax2_amount": 0, "discount_amount": 0, "discount": "string", "discount_is_percent": true, "sub_total": 0, "tax_total": null, "tax_displayed": "string", "country_id": 0, "declaration_number": "string", "total": 0, "store_doc_id": 0, "item_id": 0, "variation_id": 0, "unit_id": 0, "type": 0, "ordering": 0, "created_by": 0, "updated_by": 0, "created_date": "string", "updated_date": "string" } }` ## [tag/Stock-document-goods/paths/~1products~1document_items~1list/get](https://www.flowlu.com/api/\#tag/Stock-document-goods/paths/~1products~1document_items~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/products/document\_items/list https://{company}.flowlu.com/api/v1/module/products/document\_items/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "unit_price": 0,\ \ "quantity": null,\ \ "tax1": 0,\ \ "tax1_included": true,\ \ "tax1_amount": 0,\ \ "tax2": 0,\ \ "tax2_included": true,\ \ "tax2_amount": 0,\ \ "discount_amount": 0,\ \ "discount": "string",\ \ "discount_is_percent": true,\ \ "sub_total": 0,\ \ "tax_total": null,\ \ "tax_displayed": "string",\ \ "country_id": 0,\ \ "declaration_number": "string",\ \ "total": 0,\ \ "store_doc_id": 0,\ \ "item_id": 0,\ \ "variation_id": 0,\ \ "unit_id": 0,\ \ "type": 0,\ \ "ordering": 0,\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "created_date": "string",\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Accounts-Payable-to-Vendors](https://www.flowlu.com/api/\#tag/Accounts-Payable-to-Vendors) Accounts Payable to Vendors Accounts Payable to Vendors ### [Model relations](https://www.flowlu.com/api/\#section/Relations) * * * #### Belongs to relation | Alias | Module | Model | Foreign key | | --- | --- | --- | --- | | [org](https://www.flowlu.com/api/#tag/Organization) | Finance | Organization | org\_id | ## [tag/Accounts-Payable-to-Vendors/paths/~1products~1owed~1create/post](https://www.flowlu.com/api/\#tag/Accounts-Payable-to-Vendors/paths/~1products~1owed~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | date | string
Date | | description | string
Description | | type | string
Type | | crm\_acc\_id | integer
CRM account ID | | org\_id | integer
Organization id | | amount | number
Liability amount | | currency\_id | integer
Currency symbol | | amount\_bcy | number
Amount of the obligation in the base currency | | created\_by | integer
User id | | created\_date | string
Created date | | updated\_by | integer
User id | | updated\_date | string
Updated date | ### Responses **200** Successfully create an item post/products/owed/create https://{company}.flowlu.com/api/v1/module/products/owed/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "date": "string", "description": "string", "type": "string", "crm_acc_id": 0, "org_id": 0, "amount": 0, "currency_id": 0, "amount_bcy": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Accounts-Payable-to-Vendors/paths/~1products~1owed~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Accounts-Payable-to-Vendors/paths/~1products~1owed~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/products/owed/update/{id} https://{company}.flowlu.com/api/v1/module/products/owed/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "date": "string", "description": "string", "type": "string", "crm_acc_id": 0, "org_id": 0, "amount": 0, "currency_id": 0, "amount_bcy": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Accounts-Payable-to-Vendors/paths/~1products~1owed~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Accounts-Payable-to-Vendors/paths/~1products~1owed~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/products/owed/delete/{id} https://{company}.flowlu.com/api/v1/module/products/owed/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Accounts-Payable-to-Vendors/paths/~1products~1owed~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Accounts-Payable-to-Vendors/paths/~1products~1owed~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/products/owed/get/{id} https://{company}.flowlu.com/api/v1/module/products/owed/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "date": "string", "description": "string", "type": "string", "crm_acc_id": 0, "org_id": 0, "amount": 0, "currency_id": 0, "amount_bcy": 0, "created_by": 0, "created_date": "string", "updated_by": 0, "updated_date": "string" } }` ## [tag/Accounts-Payable-to-Vendors/paths/~1products~1owed~1list/get](https://www.flowlu.com/api/\#tag/Accounts-Payable-to-Vendors/paths/~1products~1owed~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/products/owed/list https://{company}.flowlu.com/api/v1/module/products/owed/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "date": "string",\ \ "description": "string",\ \ "type": "string",\ \ "crm_acc_id": 0,\ \ "org_id": 0,\ \ "amount": 0,\ \ "currency_id": 0,\ \ "amount_bcy": 0,\ \ "created_by": 0,\ \ "created_date": "string",\ \ "updated_by": 0,\ \ "updated_date": "string"\ \ }\ \ ] } }` ## [tag/Business-Process-Tasks](https://www.flowlu.com/api/\#tag/Business-Process-Tasks) Business Process Tasks ## [tag/Business-Process-Tasks/Approve](https://www.flowlu.com/api/\#tag/Business-Process-Tasks/Approve) Approve ```shell POST https://{{your_company}}.flowlu.com/api/v1/module/businessprocess/task/approve/{id} ``` Task type: **Approve or reject** (type = 10) * * * ## [tag/Business-Process-Tasks/Reject](https://www.flowlu.com/api/\#tag/Business-Process-Tasks/Reject) Reject ```shell POST https://{{your_company}}.flowlu.com/api/v1/module/businessprocess/task/reject/{id} ``` Task type: **Approve or reject** (type = 10) Request body (optional — reason for rejection): ```json { "resolution": "Does not meet the requirements" } ``` * * * ## [tag/Business-Process-Tasks/Request-additional-information](https://www.flowlu.com/api/\#tag/Business-Process-Tasks/Request-additional-information) Request additional information ```shell POST https://{{your_company}}.flowlu.com/api/v1/module/businessprocess/task/request_info/{id} ``` Task type: **Approve or reject** (type = 10) Request body: ```json { "request_info": { "comment": "Please clarify the contract amount", "fillable": {"field_name": true}, "assignee": 999 } } ``` * * * ## [tag/Business-Process-Tasks/Fill-fields-(response-to-information-request)](https://www.flowlu.com/api/\#tag/Business-Process-Tasks/Fill-fields-(response-to-information-request)) Fill fields (response to information request) ```shell POST https://{{your_company}}.flowlu.com/api/v1/module/businessprocess/task/fill/{id} ``` Task type: **Request information** (type = 20) Request body: ```json { "values": { "field_name_1": "value", "field_name_2": 12345 } } ``` * * * ## [tag/Business-Process-Tasks/Confirm-task](https://www.flowlu.com/api/\#tag/Business-Process-Tasks/Confirm-task) Confirm task ```shell POST https://{{your_company}}.flowlu.com/api/v1/module/businessprocess/task/confirm/{id} ``` Task type: **Get familiar with the information** (type = 30) Request body — not required. * * * ### Response (200 OK) Identical for all endpoints: ```json { "id": 1, "name": "Contract approval #123", "description": "...", "module": "businessprocess", "model": "instance", "model_id": 1, "robot_activity_id": 1, "type": 10, "resolve_type": 0, "status": 20, "parent_id": null, "created_by": 1, "created_at": "YYYY-MM-DD HH:MM:SS", "updated_at": "YYYY-MM-DD HH:MM:SS" } ``` ## [tag/Processes](https://www.flowlu.com/api/\#tag/Processes) Processes ## [tag/Processes/paths/~1businessprocess~1process~1create/post](https://www.flowlu.com/api/\#tag/Processes/paths/~1businessprocess~1process~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | description | string
Description | | icon | string
Icon code | | is\_archived | boolean
Entity Archiving status | | archived\_at | string
Date of archiving | | created\_by | integer
User id | | updated\_by | integer
User id | | created\_at | string
Created date | | updated\_at | string
Updated date | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | ### Responses **200** Successfully create an item post/businessprocess/process/create https://{company}.flowlu.com/api/v1/module/businessprocess/process/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "icon": "string", "is_archived": true, "archived_at": "string", "created_by": 0, "updated_by": 0, "created_at": "string", "updated_at": "string", "ordering": 0 } }` ## [tag/Processes/paths/~1businessprocess~1process~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Processes/paths/~1businessprocess~1process~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/businessprocess/process/update/{id} https://{company}.flowlu.com/api/v1/module/businessprocess/process/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "icon": "string", "is_archived": true, "archived_at": "string", "created_by": 0, "updated_by": 0, "created_at": "string", "updated_at": "string", "ordering": 0 } }` ## [tag/Processes/paths/~1businessprocess~1process~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Processes/paths/~1businessprocess~1process~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/businessprocess/process/delete/{id} https://{company}.flowlu.com/api/v1/module/businessprocess/process/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Processes/paths/~1businessprocess~1process~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Processes/paths/~1businessprocess~1process~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/businessprocess/process/get/{id} https://{company}.flowlu.com/api/v1/module/businessprocess/process/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "description": "string", "icon": "string", "is_archived": true, "archived_at": "string", "created_by": 0, "updated_by": 0, "created_at": "string", "updated_at": "string", "ordering": 0 } }` ## [tag/Processes/paths/~1businessprocess~1process~1list/get](https://www.flowlu.com/api/\#tag/Processes/paths/~1businessprocess~1process~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/businessprocess/process/list https://{company}.flowlu.com/api/v1/module/businessprocess/process/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "description": "string",\ \ "icon": "string",\ \ "is_archived": true,\ \ "archived_at": "string",\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "created_at": "string",\ \ "updated_at": "string",\ \ "ordering": 0\ \ }\ \ ] } }` ## [tag/Stages](https://www.flowlu.com/api/\#tag/Stages) Stages ## [tag/Stages/paths/~1businessprocess~1stage~1create/post](https://www.flowlu.com/api/\#tag/Stages/paths/~1businessprocess~1stage~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | process\_id | integer
Business process ID | | status | integer
Business process stage status. Defines the role of the stage in the process lifecycle: 10 — intermediate stage, 20 — final (successful completion), 30 — final (unsuccessful completion) | | ordering | integer
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | description | string
Description | | color | string
Color HEX code | | created\_by | integer
User id | | updated\_by | integer
User id | | created\_at | string
Created date | | updated\_at | string
Updated date | ### Responses **200** Successfully create an item post/businessprocess/stage/create https://{company}.flowlu.com/api/v1/module/businessprocess/stage/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "process_id": 0, "status": 0, "ordering": 0, "description": "string", "color": "string", "created_by": 0, "updated_by": 0, "created_at": "string", "updated_at": "string" } }` ## [tag/Stages/paths/~1businessprocess~1stage~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Stages/paths/~1businessprocess~1stage~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/businessprocess/stage/update/{id} https://{company}.flowlu.com/api/v1/module/businessprocess/stage/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "process_id": 0, "status": 0, "ordering": 0, "description": "string", "color": "string", "created_by": 0, "updated_by": 0, "created_at": "string", "updated_at": "string" } }` ## [tag/Stages/paths/~1businessprocess~1stage~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Stages/paths/~1businessprocess~1stage~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/businessprocess/stage/delete/{id} https://{company}.flowlu.com/api/v1/module/businessprocess/stage/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Stages/paths/~1businessprocess~1stage~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Stages/paths/~1businessprocess~1stage~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/businessprocess/stage/get/{id} https://{company}.flowlu.com/api/v1/module/businessprocess/stage/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "process_id": 0, "status": 0, "ordering": 0, "description": "string", "color": "string", "created_by": 0, "updated_by": 0, "created_at": "string", "updated_at": "string" } }` ## [tag/Stages/paths/~1businessprocess~1stage~1list/get](https://www.flowlu.com/api/\#tag/Stages/paths/~1businessprocess~1stage~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/businessprocess/stage/list https://{company}.flowlu.com/api/v1/module/businessprocess/stage/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "process_id": 0,\ \ "status": 0,\ \ "ordering": 0,\ \ "description": "string",\ \ "color": "string",\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "created_at": "string",\ \ "updated_at": "string"\ \ }\ \ ] } }` ## [tag/Process-instances](https://www.flowlu.com/api/\#tag/Process-instances) Process instances ## [tag/Process-instances/paths/~1businessprocess~1instance~1create/post](https://www.flowlu.com/api/\#tag/Process-instances/paths/~1businessprocess~1instance~1create/post) Create Create ##### Authorizations: _ApiKeyAuth_ ##### Request Body schema: application/x-www-form-urlencoded | | | | --- | --- | | name | string
Name | | stage\_id | integer
Business process stage ID | | process\_id | integer
Business process ID | | ordering | number
Sorting index. The system sorts from less to more. For example, a record with a field value of 1 will be higher than a record with a field value of 2. | | created\_by | integer
User id | | updated\_by | integer
User id | | created\_at | string
Created date | | updated\_at | string
Updated date | ### Responses **200** Successfully create an item post/businessprocess/instance/create https://{company}.flowlu.com/api/v1/module/businessprocess/instance/create ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "stage_id": 0, "process_id": 0, "ordering": 0, "created_by": 0, "updated_by": 0, "created_at": "string", "updated_at": "string" } }` ## [tag/Process-instances/paths/~1businessprocess~1instance~1update~1{id}/post](https://www.flowlu.com/api/\#tag/Process-instances/paths/~1businessprocess~1instance~1update~1{id}/post) Update Update ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ##### Request Body schema: application/x-www-form-urlencoded ### Responses **200** Successfully update an item post/businessprocess/instance/update/{id} https://{company}.flowlu.com/api/v1/module/businessprocess/instance/update/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "stage_id": 0, "process_id": 0, "ordering": 0, "created_by": 0, "updated_by": 0, "created_at": "string", "updated_at": "string" } }` ## [tag/Process-instances/paths/~1businessprocess~1instance~1delete~1{id}/get](https://www.flowlu.com/api/\#tag/Process-instances/paths/~1businessprocess~1instance~1delete~1{id}/get) Delete Delete ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully deleted an item get/businessprocess/instance/delete/{id} https://{company}.flowlu.com/api/v1/module/businessprocess/instance/delete/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 2 } }` ## [tag/Process-instances/paths/~1businessprocess~1instance~1get~1{id}/get](https://www.flowlu.com/api/\#tag/Process-instances/paths/~1businessprocess~1instance~1get~1{id}/get) Get Get ##### Authorizations: _ApiKeyAuth_ ##### path Parameters | | | | --- | --- | | id
required | integer
Id | ### Responses **200** Successfully returned an item get/businessprocess/instance/get/{id} https://{company}.flowlu.com/api/v1/module/businessprocess/instance/get/{id} ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"id": 0, "name": "string", "stage_id": 0, "process_id": 0, "ordering": 0, "created_by": 0, "updated_by": 0, "created_at": "string", "updated_at": "string" } }` ## [tag/Process-instances/paths/~1businessprocess~1instance~1list/get](https://www.flowlu.com/api/\#tag/Process-instances/paths/~1businessprocess~1instance~1list/get) List List ##### Authorizations: _ApiKeyAuth_ ### Responses **200** Successfully returned a list get/businessprocess/instance/list https://{company}.flowlu.com/api/v1/module/businessprocess/instance/list ### Response samples - 200 Content type application/json Copy Expand all Collapse all `{"response": {"total": 0, "page": 0, "count": 0, "items": [{"id": 0,\ \ "name": "string",\ \ "stage_id": 0,\ \ "process_id": 0,\ \ "ordering": 0,\ \ "created_by": 0,\ \ "updated_by": 0,\ \ "created_at": "string",\ \ "updated_at": "string"\ \ }\ \ ] } }` ## [tag/Webhooks](https://www.flowlu.com/api/\#tag/Webhooks) Webhooks A webhook is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens, meaning you get data immediately. Unlike typical APIs where you would need to poll for data very frequently in order to get it real-time. ## [tag/Global-tags](https://www.flowlu.com/api/\#tag/Global-tags) Global tags #### Create or link a global tag to an entity ```shell curl --request POST \ --url 'https://{{your_company}}.flowlu.com/api/v1/module/{{module}}/{{model}}/{{model_id}}/global_tags/create?api_key={{api_key}}' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data 'name=new tag' ``` #### Unlink tag from entity ```shell curl --request POST \ --url 'https://{{your_company}}.flowlu.com/api/v1/module/{{module}}/{{model}}/{{model_id}}/global_tags/delete?api_key={{api_key}}' ``` #### Tag list ```shell curl --request GET \ --url 'https://{{your_company}}.flowlu.com/api/v1/module/{{module}}/{{model}}/{{model_id}}/global_tags/list?api_key={{api_key}}' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data 'name=new tag' ``` #### Entity list by tag ```shell curl --request GET \ --url 'https://{{your_company}}.flowlu.com/api/v1/module/{{module}}/{{model}}/{{model_id}}/global_tags/list?api_key={{api_key}}&filter[_tag_id]={{tag_id}}' ``` #### All tag list ```shell curl --request GET \ --url 'https://{{your_company}}.flowlu.com/api/v1/module/core/tag/list/?api_key={{api_key}}' ``` #### Update global tag ```shell curl --request POST \ --url 'https://{{your_company}}.flowlu.com/api/v1/module/core/tag/update/75?api_key={{api_key}}' \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data 'name=new tag2' ``` #### Delete global tag ```shell curl --request POST \ --url 'https://{{your_company}}.flowlu.com/api/v1/module/core/tag/delete/75?api_key={{api_key}}' ``` ## [tag/Journal](https://www.flowlu.com/api/\#tag/Journal) Journal | Method | URL | | --- | --- | | `foreign_list` | `GET /api/v1/module/{module}/{model}/{id}/global_journal/list` | | `foreign_get` | `GET /api/v1/module/{module}/{model}/{id}/global_journal/get/{entry_id}` | Journal entries are created only by the system — they cannot be added, edited, or deleted via the API. ## [tag/Journal/Permissions](https://www.flowlu.com/api/\#tag/Journal/Permissions) Permissions - Access to the journal inherits the read permissions of the parent entity. If a user cannot access the entity `{module}/{model}/{id}`, they will not see its journal either. - Module checks (e.g., restrictions for `company`, `im`) are applied to the parent entity in the standard way. ## [tag/Journal/Response-Fields](https://www.flowlu.com/api/\#tag/Journal/Response-Fields) Response Fields ### Raw Fields (from the `journal` table) | Field | Type | Description | | --- | --- | --- | | `id` | int | Journal entry ID | | `date` | string | Event date (`Y-m-d H:i:s`) | | `user_id` | int | ID of the user who made the change. `0` if the change was made by a robot | | `robot_id` | int\|null | Robot ID, if the event was triggered by automation | | `module` | string | Entity module code | | `model` | string | Entity model code | | `model_id` | int | Entity ID | | `field` | string\|null | Name of the changed field (column name) | | `event_type` | string | `orm_create`, `orm_update`, `orm_delete`, `orm_restore`, `custom` | | `action` | string\|null | Action for custom events: `create`, `update`, `delete` | | `custom_title` | string\|null | Raw key / event description from the database (as recorded by the initiator) | | `old_value` | string\|null | Previous field value (raw) | | `new_value` | string\|null | New field value (raw) | | `old_value_formatted` | string\|null | Formatted previous value, calculated at the time of writing | | `new_value_formatted` | string\|null | Formatted new value, calculated at the time of writing | ### `display` Block (Ready-to-Use Representation) An object containing data for rendering the event in the feed without additional client-side work. All strings are localized according to the current session locale. | Field | Type | Description | | --- | --- | --- | | `display.module_title` | string | Human-readable module name (e.g., "Tasks") | | `display.entity_title` | string | Entity name (e.g., "Task") | | `display.field_title` | string\|null | Name of the changed field (e.g., "Assignee"); `null` if the event is not tied to a field | | `display.event_title` | string\|null | Localized event type label: "Created", "Changed", "Deleted", "Restored" | | `display.snippet` | string\|null | UI snippet code for rendering (e.g., `journal-snippet-content-changes`, `journal-snippet-custom-content`). `null` — the default view is used | | `display.icon` | string\|null | Icon name (`attachment`, `subtask`, …), if a specialized view defines it | | `display.styles` | object\|null | A set of style modifiers (e.g., `{"text_line_through": true}`), if the view defines them | | `display.custom_title` | string\|null | Localized event title (already translated) | | `display.old_text` | string\|null | Human‑readable old value: entity references are resolved to their names (full name, file name, etc.). `null` for changes initiated by a robot | | `display.new_text` | string\|null | Human‑readable new value (same as `old_text`) | ### `user` Block | Field | Type | Description | | --- | --- | --- | | `user.id` | int | User ID | | `user.name` | string | Full name | `user` is `null` if the change was initiated by a robot or the system (`user_id = 0`). ### `robot` Block | Field | Type | Description | | --- | --- | --- | | `robot.id` | int | Robot (automation) ID | | `robot.name` | string | Robot name | `robot` is `null` for all normal (user‑initiated) changes. ## [tag/Additional-usage-examples](https://www.flowlu.com/api/\#tag/Additional-usage-examples) Additional usage examples ### Filtering by custom fields ``` curl -X GET https://{{your_company}}.flowlu.com/api/v1/module/*module_name*/*entity_name*/list?search=flowlu&page=1&api_key=*api_key*&filter[cf.field_*field_id*]=*filter_value* ``` ### Retrieving a list of items from a specific custom list ``` curl -X GET https://{{your_company}}.flowlu.com/api/v1/module/customlists/lists/*customlist_id*/items?api_key=*api_key* ``` ### Retrieving a list of comments for a specific entity ``` curl -X GET https://{{your_company}}.flowlu.com/api/v1/module/*module_name*/*entity_name*/*entity_id*/comments/list?api_key=*api_key* ``` ### Retrieving a specific comment ``` curl -X GET https://{{your_company}}.flowlu.com/api/v1/module/system/comments/*comment_id*/?api_key=*api_key* ``` ### Creating a comment for a specific entity ``` curl --request POST \ --url 'https://{{your_company}}.flowlu.com/api/v1/module/*module_name*/*entity_name*/*entity_id*/comments/create?api_key=*api_key*' \ --header 'content-type: application/x-www-form-urlencoded' \ --data 'text=*p*comment*/p*' ``` ## [tag/Files](https://www.flowlu.com/api/\#tag/Files) Files An API key with access to the system application is required to work with files. ### List Files ``` curl -X GET https://{{your_company}}.flowlu.com/api/v1/module/system/files/list/?api_key=*api_key* ``` ### Get Specific File Information ``` curl -X GET https://{{your_company}}.flowlu.com/api/v1/module/system/files/*file_id*/?api_key=*api_key* ``` ### List Files for Specific Entity ``` curl -X GET https://{{your_company}}.flowlu.com/api/v1/module/{module}/{model}/{id}/files/list/?api_key=*api_key* ``` ### Download Specific File ``` curl -X GET https://{{your_company}}.flowlu.com/api/v1/module/system/files/download/*file_id*/?api_key=*api_key* ```