# MakeLeaps API Documentation - Other Section ## Navigation - [Back to index](/api/llms.txt) - [Current section](/api/llms/other.md) ## Topics in this Section - History - Task - Task Progress - Approval Request - Virtual Accounts - Visible Document Data ## History ### Endpoints - `/api/partner//history/` - Name: History Entry List - Methods: GET, POST, OPTIONS - `/api/partner//history//` - Name: History Entry Instance - Methods: GET, OPTIONS History ------- History entries record past actions within our system. They are automatically created when certain actions are taken by users, such as creating, editing or deleting a document. Filtering by Date ----------------- History entries can be filtered by date in two ways; by an exact date, or by a range defined between two dates. By a single date: https://api.makeleaps.com/api/partner/{ mid }/history/?date={ datetime } By a range of dates: https://api.makeleaps.com/api/partner/{ mid }/history/?date_start={ datetime }&date_end={ datetime } Datetimes are in the format: yyyy-mm-ddThh:mm:ss.00Z ### Fields - **`mid`** `Read-Only` - **Type**: `MakeLeaps ID` - **Description**: MakeLeaps ID - **`web_url`** `Read-Only` - **Type**: `URL` - **Description**: URL - **`action_time`** `Read-Only` - **Type**: `Timestamp` - **Description**: action time - **`created_by`** `Read-Only` - **Type**: `Employee` - **Description**: Created By - **`event_name`** - **Type**: `String` - **Description**: Event - **`metadata`** `Read-Only` - **Type**: `String` - **Description**: Data - **`action_flag`** `Required` - **Type**: `Integer` - **Description**: action flag - **`object_repr`** `Required` - **Type**: `String` - **Description**: object repr - **`user_display_name`** `Read-Only` - **Type**: `String` ## Task ### Endpoints - `/api/partner//task//` - Name: Task Instance - Methods: GET, OPTIONS - `/api/partner//task//results/` - Name: (No Name) - Methods: options, get Task is the background task mechanism used by the MakeLeaps API. Handling Background Task ------------------------------------ Some API endpoints use a background task to process something time consuming. In that case, the API will respond with a `Task` instance. { "meta": { "status": 202 }, "response": { "mid": "", "uilongtask": { "url": "https://api.makeleaps.com/api/taskprogress//", "mid": "", "current_progress": 0, "max_progress": 100, "time_done": null, "finished": false, "errors": [] }, "action": "", "employee": "https://api.makeleaps.com/api/partner//employee//", "url": "https://api.makeleaps.com/api/partner//task//", "result_url": "https://api.makeleaps.com/api/partner//task//results/", "completion": 0, "failed_chunks": [], "requested": "2024-05-27T02:48:09.628582Z", "finished": null } } `completion` shows the progress of the task. Starting from `0` and finishing at `100` . You can check the latest status by visiting `url`. The result of a task can be obtained via a GET request to `result_url` . GET https:///api/partner//task//results/ The fields in the response will vary for each task. The following is an example of the document pickup link generation background task. { "meta": { "status": 200 }, "response": [ { "mid": "", "created": "2021-02-03T05:28:43.271956Z", "link": "https://example.com/secureinbox/p//", "email": "", "date_clicked": null, "source": "Shareable Link Panel", "expiration_date": "2021-04-04T14:30:38", "is_cancelled": false, "created_by": "Somebody", "supersend": null } ] } ### Fields - **`mid`** `Read-Only` - **Type**: `MakeLeaps ID` - **Description**: MakeLeaps ID - **`uilongtask`** - **Type**: `Task Progress` - **Description**: Task Progress - **`action`** `Read-Only` - **Type**: `String` - **`employee`** `Read-Only` `Expandable` - **Type**: `URL` - **Description**: Employee URL - **`url`** `Read-Only` - **Type**: `URL` - **`result_url`** `Read-Only` - **Type**: `URL` - **`completion`** `Read-Only` - **Type**: `Integer` - **Description**: Task Progress - **`failed_chunks`** `Read-Only` - **Type**: `Array of String` - **Description**: Failed - **`requested`** `Read-Only` - **Type**: `Timestamp` - **Description**: Task created timestamp - **`finished`** `Read-Only` - **Type**: `Timestamp` - **Description**: Completed timestamp ## Task Progress ### Fields - **`url`** `Read-Only` - **Type**: `URL` - **`mid`** `Read-Only` - **Type**: `MakeLeaps ID` - **Description**: MakeLeaps ID - **`current_progress`** - **Type**: `Integer` - **Description**: Current Progress - **`max_progress`** - **Type**: `Integer` - **Description**: Max Progress - **`time_done`** - **Type**: `Timestamp` - **Description**: Time done - **`finished`** `Read-Only` - **Type**: `Boolean` - **Description**: Completed - **`errors`** `Read-Only` - **Type**: `String` - **Description**: Errors ## Approval Request ### Endpoints - `/api/partner//approval/request/` - Name: Approval Request List - Methods: GET, OPTIONS Approval Requests ----------------- Approval Requests are how MakeLeaps stores Approval records of Documents. This can be either via * Requesting Approval to a Member (Employee) or Group via "Assign to" * Requesting Approval using an Approval Flow * A Document being approved ad hoc by a Member with the correct permissions (possible when "Disable Direct (Non-Flow) Approval of Documents" setting is Off). In this case, the `requester` field will be blank. Documents once approved can be Unapproved, but this is not recorded in Request Approvals. The final Approval status of the Document should be confirmed by referencing the `approval_status` field on the Document itself. Approval Request Status ----------------------- Approval Requests can have one of the following statuses. * `pending` - Approval has been requested, but approval is not yet complete. * `rejected` - An approver has Rejected the Document. * `approved` - Request is Approved, either ad hoc or as part of the corresponding Request. * `cancelled` - Request was Deleted by a User before Approval was completed. ### Fields - **`requester`** `Read-Only` `Expandable` - **Type**: `URL` - **Description**: Team Member Requesting Approval - **`document`** `Read-Only` `Expandable` - **Type**: `URL` - **Description**: Document subject to Approval - **`status`** `Read-Only` - **Type**: `One of ['pending', 'rejected', 'approved', 'cancelled']` - **Description**: Request Status - **`date_completed`** `Read-Only` - **Type**: `Timestamp` - **Description**: Datetime the Request was closed (either Approved or Rejected) ## Virtual Accounts ### Endpoints - `/api/partner//virtual-account/destination-account/` - Name: Destination Bank Account List - Methods: GET, OPTIONS - `/api/partner//virtual-account/destination-account//` - Name: Destination Bank Account Instance - Methods: GET, OPTIONS What is Virtual Accounts ----------------- "Virtual Accounts" is a feature that assigns unique virtual bank accounts to Clients. Sets of Virtual Accounts redirect their deposits into a single real collection account, called a "Destination Account" in MakeLeaps. This endpoint returns the status of the Virtual Accounts associated with your Destination Account(s). To use this feature, the "Virtual Accounts" option must be enabled in your subscription. If the option is not enabled, this endpoint will return a 404 error. ### Fields - **`mid`** `Read-Only` - **Type**: `MakeLeaps ID` - **Description**: mid - **`url`** `Read-Only` - **Type**: `URL` - **`virtual_account_provider`** `Read-Only` - **Type**: `String` - **Description**: Virtual account provider - **`purchased_virtual_account_count`** `Read-Only` - **Type**: `Integer` - **Description**: Total virtual accounts purchased in current plan - **`used_virtual_account_count`** `Read-Only` - **Type**: `Integer` - **Description**: Virtual accounts already assigned to Clients - **`available_virtual_account_count`** `Read-Only` - **Type**: `Integer` - **Description**: Virtual accounts available for assignment to Clients ## Visible Document Data ### Fields - **`document_number`** `Required` - **Type**: `String` - **Description**: Document Number - **`document_type`** `Required` - **Type**: `Document Type` - **Description**: Document Type - **`title`** - **Type**: `String` - **Description**: Title - **`project_name`** - **Type**: `String` - **Description**: Project - **`bank_details_header`** - **Type**: `String` - **Description**: Bank Details Header - **`bank_details`** - **Type**: `String` - **Description**: Bank Details - **`message`** - **Type**: `String` - **Description**: Message - **`proviso`** - **Type**: `String` - **Description**: Proviso - **`group_lineitem_by_tax_rate`** - **Type**: `Boolean` - **Description**: Group line items by tax rate - **`has_hanko`** - **Type**: `Boolean` - **Description**: Display Hanko on this document - **`has_prices`** - **Type**: `Boolean` - **Description**: Display prices on this document - **`has_totals`** - **Type**: `Boolean` - **Description**: Display totals on this document - **`has_currency_code`** - **Type**: `Boolean` - **Description**: Display the currency code on this document - **`has_lineitem_tax_state`** - **Type**: `Boolean` - **Description**: Show the tax state for each line item on this document - **`show_lineitem_tax_rate`** - **Type**: `Boolean` - **Description**: Display tax rate on each line item - **`show_lineitem_tax_state`** - **Type**: `Boolean` - **Description**: Display tax exclusive/inclusive on each line item - **`show_lineitem_tax_type`** - **Type**: `Boolean` - **Description**: Display tax type on each line item - **`signature`** - **Type**: `Boolean` - **Description**: Show signature field - **`display_tax_rate`** `Required` - **Type**: `Boolean` - **Description**: Display document tax rate - **`hide_tax_description`** - **Type**: `Boolean` - **Description**: Hide alternate tax description - **`has_tax_stamp`** - **Type**: `Boolean` - **Description**: Show tax stamp - **`jp_withholding_tax_type`** - **Type**: `One of ['original_reconstruction_tax', 'original']` - **Description**: Withholding Tax Type - **`currency`** `Required` - **Type**: `Currency` - **Description**: Currency - **`subtotal`** - **Type**: `Money` - **Description**: Subtotal - **`tax`** - **Type**: `Money` - **Description**: Tax - **`jp_withholding_tax`** - **Type**: `Money` - **Description**: Withholding Tax - **`tax_rate`** - **Type**: `Number` - **Description**: Tax Rate - **`tax_type`** - **Type**: `One of ['standard', 'reduced', 'non_taxable', 'untaxable', 'duty_free', 'legacy_tax', 'legacy_no_tax']` - **Description**: Tax Type - **`subtotal_sales_tax`** - **Type**: `Money` - **Description**: Subtotal of the items Sales Tax is Applied - **`subtotal_withholding_tax`** - **Type**: `Money` - **Description**: Subtotal of the items Witholding Tax is Applied - **`total`** - **Type**: `Money` - **Description**: Total - **`mixed_tax_rate_totals`** - **Type**: `JSON Object` - **Description**: Totals by Tax Rate - **`tax_group_totals`** - **Type**: `Array of Totals by Tax Type and Rate` - **`extended_data`** - **Type**: `JSON Object` - **Description**: Extended Data - **`date`** `Required` - **Type**: `Date` - **Description**: Issue Date - **`date_due`** - **Type**: `Date` - **Description**: Date Due - **`date_valid`** - **Type**: `Date` - **Description**: Valid Until - **`date_shipped`** - **Type**: `Date` - **Description**: Shipment Date - **`payment_date`** - **Type**: `Date` - **Description**: Payment Date - **`invoicing_period_start_date`** - **Type**: `Date` - **Description**: Invoice Period Start - **`invoicing_period_end_date`** - **Type**: `Date` - **Description**: Invoice Period End - **`sender_name`** - **Type**: `String` - **Description**: Sender Name - **`sender_contact_department`** - **Type**: `String` - **Description**: Company Contact Department - **`sender_contact_title`** - **Type**: `String` - **Description**: Company Contact Title - **`sender_contact_name`** - **Type**: `String` - **Description**: Company Contact Name - **`sender_address_format`** - **Type**: `String` - **Description**: Company Address Format - **`sender_country`** - **Type**: `String` - **Description**: Company Country Name - **`sender_postal_code`** - **Type**: `String` - **Description**: Company Postal Code - **`sender_region`** - **Type**: `String` - **Description**: Company State - **`sender_locality`** - **Type**: `String` - **Description**: Company City - **`sender_street_address`** - **Type**: `String` - **Description**: Company Street Address - **`sender_extended_address`** - **Type**: `String` - **Description**: Company Extended Address - **`sender_phone_number`** - **Type**: `String` - **Description**: Company Phone Number - **`sender_fax_number`** - **Type**: `String` - **Description**: Company Fax Number - **`recipient_name`** - **Type**: `String` - **Description**: Client Name - **`recipient_contact_department`** - **Type**: `String` - **Description**: Client Contact Department - **`recipient_contact_title`** - **Type**: `String` - **Description**: Client Contact Title - **`recipient_contact_name`** - **Type**: `String` - **Description**: Client Contact - **`recipient_honorific`** - **Type**: `String` - **Description**: Recipient Honorific - **`recipient_address_format`** - **Type**: `String` - **Description**: Client Address Format - **`recipient_country`** - **Type**: `String` - **Description**: Client City - **`recipient_postal_code`** - **Type**: `String` - **Description**: Client Postal Code - **`recipient_region`** - **Type**: `String` - **Description**: Client State - **`recipient_locality`** - **Type**: `String` - **Description**: Client City - **`recipient_street_address`** - **Type**: `String` - **Description**: Client Street Address - **`recipient_extended_address`** - **Type**: `String` - **Description**: Client Extended Address - **`recipient_phone_number`** - **Type**: `String` - **Description**: Client Phone Number - **`recipient_fax_number`** - **Type**: `String` - **Description**: Client Fax Number - **`lineitems`** `Required` - **Type**: `Array of Visible Line Item Data` - **Description**: Line Items - **`purchase_order_ids`** - **Type**: `Array of String` - **Description**: PO Numbers - **`partner_tax_registration_number`** - **Type**: `String` - **Description**: Partner Tax Registration Number - **`peppol_details`** - **Type**: `Peppol Send` - **Description**: peppol details