- Created by Henrik Bjerregaard , last modified on Sept 25, 2023
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 16 Next »
AddRegistration
Add a time registration to Microbizz.
Input
| registrationentry | registrationentry | The time registration to add. |
Output
| id | number | The ID of the newly saved registration, or 0 if MB failed to save the registration |
| registrationentry | registrationentry | The newly saved registration |
ApproveRegistration
Approve an existing time registration in Microbizz.
Input
| registrationid | number | The Microbizz ID of the registration. |
| userid | number | The Microbizz ID of the user who approved the registration. |
Output
| none | - | - |
UpdateRegistration
Update an existing registration. Only works for registrations that already belong to the current user. Only updates minutes, start time, workarea, note and stars.
The internalid (the ID of an internal post) can only be updated if the registration already refers to an internal post.
Input
| registrationentry | registrationentry | The time registration to update. |
| version | int | version 2 or above has admin features. like setting approvedby, locked and gpslock |
| ignorepatches | bool | 0 or 1 if 1 then patches will not overwrite the registrations if the contract has active patches. |
Output
| id | number | The ID of the registration |
DeleteRegistrationByID
Delete a registration by ID.
Input
| registrationentryid | number | The ID of the registration to delete |
Output
| none | - | - |
ClearRegistrationByDate
Clear all registrations from Microbizz, on a given date (and for a given user).
Input
| date | date | The date on which to clear the work. |
| userid | number | Optional user id. If provided, then only clear registrations for the user with this id. |
Output
| none | - | - |
GetRegistrationByDate
Get all registrations in Microbizz, registered on a given date (and for a given user).
Input
| date | date | The date on which to get registrations. |
| userid | number | The ID of a user to get registrations from. This is optional, and if not provided the API login user is assumed. |
Output
| registrationentries | collection[ registrationentry ] | A collection of the relevant registrations, or an empty collection if no products were found. |
| state | number | Shows the state on the registration. 1: OPEN, 2: CLOSED, 3: CLOSED AND ACCEPTED |
| isopen | boolean | Indicates if this date is open for registrations. |
| regtypeid | int | The ID of the workplan registration for the date |
| atwork | boolean | If the user is supposed to be at work on the date |
| color | string | The color of the workplan registration for the date |
| title | string | The name of the workplan registration for the date |
| holiday | boolean | If the date is a holiday |
GetRegistrations
Get all registrations for a given object.
Input
| objecttype | string | The type of object to read registrations for, either 'todo', 'customers' or 'tools'. |
| objectid | number | The ID of an object. |
Output
| registrationentries | collection[ registrationentry ] | A collection of the relevant registrations, or an empty collection if no products were found. |
GetRegistrationsByLastChange
Get a collection of registrations changed since a given date and time. Please note that this refers to when the registration was changed, and not on what time it was made.
Input
| changedate | date | Return all registration changed on or after the provided date. |
| changetime | time | If this is provided only return registrations changed after the provided date and time. |
| resumekey | string | If a partial result is returned, provide the resumekey received along with the partial result, to get the rest of the entries |
| onlyapproved | boolean | If true then only return approved registrations |
Output
| registrations | collection[registrationentry] | A collection of the relevant registrations, or an empty collection if no registration was found. |
| resumekey | string | Sometimes the entire result cannot be returned because it's to large. In that case a resumekey is returned along with the results. Execute the command again with this resumekey to get the remaining results. |
OpenRegistrationsByDate
Reopens a registration day / daily time sheet.
Input
| date | date | The date to reopen. |
Output
| state | number | Shows the state of the registration day. 1: OPEN, 2: CLOSED, 3: CLOSED AND ACCEPTED |
CloseRegistrationsByDate
Closes all registrations by date.
Input
| date | date | The date on which to close registrations. |
| note | string | The note for the day |
Output
| state | number | Shows the state of the registration day. 1: OPEN, 2: CLOSED, 3: CLOSED AND ACCEPTED |
GetRegistrationsPendingInvoicing
Get all registrations which is pending invoicing.
Input
| getall | boolean | If this is set, then all pending registrations are returned, with no assumptions whether they are invoicable or not. |
Output
| registrationentries | collection [registrationentry] | A collection of the relevant registrations, or an empty collection if no products were found. |
MarkRegistrationsAsInvoiced
Mark the given registrations as invoiced.
Input
| registrationids | collection [number] | A collection of all registration entry ids to mark as invoiced. |
Output
| None | - | - |
GetInternalRegistrations
Get all possible internal registrations in Microbizz.
Input
| None | - | - |
Output
| internals | collection[ registration_internal ] | A collection of all the possible internal registrations |
GetAllRegistrationsByDateRange
Get all registrations for a period.
Input
| startdate | date | The first valid registrationdate |
| enddate | date | The last valid registrationdate |
| resumekey | string | If a partial result is returned, provide the resumekey received along with the partial result, to get the rest of the entries |
Output
| registrations | collection[registrationentry] | A collection of the relevant registrations, or an empty collection if no registration was found. |
| resumekey | string | Sometimes the entire result cannot be returned because it's to large. In that case a resumekey is returned along with the results. Execute the command again with this resumekey to get the remaining results. |
GetCustomRegistrationDefinitions
Get the definitions of all custom registrations.
Input
| None | - | - |
Output
| customregistrations | collection[customregistration] | A collection of custom registrations, or an empty collection if no custom registrations were found. |
GetWeekOverview
Get additional summarizing lines for describing the time usage in a given period. This is primary used by the app.
Input
| startdate | date | Start of period |
| enddate | date | End of period |
Output
| lines | collection[lines] | The lines element is described below |
Lines
| left_text | string | The text leading the line. The subject of the line. |
| right_text | string | The text at the end of the line. The value of the line. |
| style | string | normal - show as normal bold - show as bold |
- No labels