Skip to content

mailmojo/tripletex-php

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
.swagger-codegen
.swagger-codegen
 
 
docs
docs
 
 
lib
lib
 
 
test
test
 
 
.php_cs
.php_cs
 
 
.swagger-codegen-ignore
.swagger-codegen-ignore
 
 
.travis.yml
.travis.yml
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 
git_push.sh
git_push.sh
 
 
phpunit.xml.dist
phpunit.xml.dist
 
 

Repository files navigation

SwaggerClient-php

The Tripletex API is a RESTful API, which does not implement PATCH, but uses a PUT with optional fields. Actions or commands are represented in our RESTful path with a prefixed :. Example: /v2/hours/123/:approve. Summaries or aggregated results are represented in our RESTful path with a prefixed >. Example: /v2/hours/>thisWeeksBillables. "requestID" is a key found in all validation and error responses. If additional log information is absolutely necessary, our support division can locate the key value. Download the swagger.json file OpenAPI Specification to generate code. This document was generated from the Swagger JSON file. version: This is a versioning number found on all DB records. If included, it will prevent your PUT/POST from overriding any updates to the record since your GET. Date & DateTime follows the ISO 8601 standard. Date: YYYY-MM-DD. DateTime: YYYY-MM-DDThh:mm:ssZ Sorting is done by specifying a comma separated list, where a - prefix denotes descending. You can sort by sub object with the following format: project.name, -date. Searching: is done by entering values in the optional fields for each API call. The values fall into the following categories: range, in, exact and like. Missing fields or even no response data can occur because result objects and fields are filtered on authorization. See FAQ for more additional information. ## Authentication: - Tokens: The Tripletex API uses 3 different tokens - consumerToken, employeeToken and sessionToken. - consumerToken is a token provided to the consumer by Tripletex after the API 2.0 registration is completed. - employeeToken is a token created by an administrator in your Tripletex account via the user settings and the tab "API access". Each employee token must be given a set of entitlements. Read more here. - sessionToken is the token from /token/session/:create which requires a consumerToken and an employeeToken created with the same consumer token, but not an authentication header. See how to create a sessionToken here. - The session token is used as the password in "Basic Authentication Header" for API calls. - Use blank or 0 as username for accessing the account with regular employee token, or if a company owned employee token accesses /company/>withLoginAccess or /token/session/>whoAmI. - For company owned employee tokens (accounting offices) the ID from /company/>withLoginAccess can be used as username for accessing client accounts. - If you need to create the header yourself use Authorization: Basic <base64encode('0:sessionToken')>. ## Tags: - <div class="tag-icon-beta"> [BETA] This is a beta endpoint and can be subject to change. - <div class="tag-icon-deprecated"> [DEPRECATED] Deprecated means that we intend to remove/change this feature or capability in a future "major" API release. We therefore discourage all use of this feature/capability. ## Fields: Use the fields parameter to specify which fields should be returned. This also supports fields from sub elements. Example values: - project,activity,hours returns {project:..., activity:...., hours:...}. - just project returns \"project\" : { \"id\": 12345, \"url\": \"tripletex.no/v2/projects/12345\" }. - project(*) returns \"project\" : { \"id\": 12345 \"name\":\"ProjectName\" \"number.....startDate\": \"2013-01-07\" }. - project(name) returns \"project\" : { \"name\":\"ProjectName\" }. - All elements and some subElements : *,activity(name),employee(*). ## Changes: To get the changes for a resource, changes have to be explicitly specified as part of the fields parameter, e.g. *,changes. There are currently two types of change available: - CREATE for when the resource was created - UPDATE for when the resource was updated NOTE: For objects created prior to October 24th 2018 the list may be incomplete, but will always contain the CREATE and the last change (if the object has been changed after creation). ## Rate limiting in each response header: Rate limiting is performed on the API calls for an employee for each API consumer. Status regarding the rate limit is returned as headers: - X-Rate-Limit-Limit - The number of allowed requests in the current period. - X-Rate-Limit-Remaining - The number of remaining requests. - X-Rate-Limit-Reset - The number of seconds left in the current period. Once the rate limit is hit, all requests will return HTTP status code 429 for the remainder of the current period. ## Response envelope: { \"fullResultSize\": ###, \"from\": ###, // Paging starting from \"count\": ###, // Paging count \"versionDigest\": \"Hash of full result\", \"values\": [...list of objects...] } { \"value\": {...single object...} } ## WebHook envelope: { \"subscriptionId\": ###, \"event\": \"object.verb\", // As listed from /v2/event/ \"id\": ###, // Object id \"value\": {... single object, null if object.deleted ...} } ## Error/warning envelope: { \"status\": ###, // HTTP status code \"code\": #####, // internal status code of event \"message\": \"Basic feedback message in your language\", \"link\": \"Link to doc\", \"developerMessage\": \"More technical message\", \"validationMessages\": [ // Will be null if Error { \"field\": \"Name of field\", \"message\": \"Validation failure information\" } ], \"requestId\": \"UUID used in any logs\" } ## Status codes / Error codes: - 200 OK - 201 Created - From POSTs that create something new. - 204 No Content - When there is no answer, ex: "/:anAction" or DELETE. - 400 Bad request - - 4000 Bad Request Exception - 11000 Illegal Filter Exception - 12000 Path Param Exception - 24000 Cryptography Exception - 401 Unauthorized - When authentication is required and has failed or has not yet been provided - 3000 Authentication Exception - 9000 Security Exception - 403 Forbidden - When AuthorisationManager says no. - 404 Not Found - For content/IDs that does not exist. - 6000 Not Found Exception - 409 Conflict - Such as an edit conflict between multiple simultaneous updates - 7000 Object Exists Exception - 8000 Revision Exception - 10000 Locked Exception - 14000 Duplicate entry - 422 Bad Request - For Required fields or things like malformed payload. - 15000 Value Validation Exception - 16000 Mapping Exception - 17000 Sorting Exception - 18000 Validation Exception - 21000 Param Exception - 22000 Invalid JSON Exception - 23000 Result Set Too Large Exception - 429 Too Many Requests - Request rate limit hit - 500 Internal Error - Unexpected condition was encountered and no more specific message is suitable - 1000 Exception

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 2.33.2
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/eliksir/tripletex-php.git"
    }
  ],
  "require": {
    "eliksir/tripletex-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: tokenAuthScheme
$config = Tripletex\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new Tripletex\Api\ActivityApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | Element ID
$fields = "fields_example"; // string | Fields filter pattern

try {
    $result = $apiInstance->get($id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActivityApi->get: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://tripletex.no/v2

Class Method HTTP request Description
ActivityApi get GET /activity/{id} Find activity by ID.
ActivityApi getForTimeSheet GET /activity/>forTimeSheet Find applicable time sheet activities for an employee on a specific day.
ActivityApi search GET /activity Find activities corresponding with sent data.
AddressApi get GET /address/{id} Get address by ID.
AddressApi put PUT /address/{id} Update address.
AddressApi search GET /address Find addresses corresponding with sent data.
BankApi search GET /bank [BETA] Find bank corresponding with sent data.
BankreconciliationApi adjustment PUT /bank/reconciliation/{id}/:adjustment [BETA] Add an adjustment to reconciliation by ID.
BankreconciliationApi delete DELETE /bank/reconciliation/{id} [BETA] Delete bank reconciliation by ID.
BankreconciliationApi fetchFromBank PUT /bank/reconciliation/:fetchFromBank [BETA] Create a bank reconciliation by fetching bank statement from the bank.
BankreconciliationApi get GET /bank/reconciliation/{id} [BETA] Get bank reconciliation.
BankreconciliationApi lastClosed GET /bank/reconciliation/>lastClosed [BETA] Get last closed reconciliation by account ID.
BankreconciliationApi post POST /bank/reconciliation [BETA] Post a bank reconciliation.
BankreconciliationApi put PUT /bank/reconciliation/{id} [BETA] Update a bank reconciliation.
BankreconciliationApi search GET /bank/reconciliation [BETA] Find bank reconciliation corresponding with sent data.
BankreconciliationmatchApi delete DELETE /bank/reconciliation/match/{id} [BETA] Delete a bank reconciliation match by ID.
BankreconciliationmatchApi get GET /bank/reconciliation/match/{id} [BETA] Get bank reconciliation match by ID.
BankreconciliationmatchApi post POST /bank/reconciliation/match [BETA] Create a bank reconciliation match.
BankreconciliationmatchApi put PUT /bank/reconciliation/match/{id} [BETA] Update a bank reconciliation match by ID.
BankreconciliationmatchApi search GET /bank/reconciliation/match [BETA] Find bank reconciliation match corresponding with sent data.
BankreconciliationmatchApi suggest PUT /bank/reconciliation/match/:suggest [BETA] Suggest matches for a bank reconciliation by ID.
BankreconciliationpaymentTypeApi get GET /bank/reconciliation/paymentType/{id} [BETA] Get payment type by ID.
BankreconciliationpaymentTypeApi search GET /bank/reconciliation/paymentType [BETA] Find payment type corresponding with sent data.
BankstatementApi delete DELETE /bank/statement/{id} [BETA] Delete bank statement by ID.
BankstatementApi get GET /bank/statement/{id} [BETA] Get bank statement.
BankstatementApi importBankStatement POST /bank/statement/import [BETA] Upload bank statement file.
BankstatementApi search GET /bank/statement [BETA] Find bank statement corresponding with sent data.
BankstatementtransactionApi get GET /bank/statement/transaction/{id} [BETA] Get bank transaction by ID.
BankstatementtransactionApi getDetails GET /bank/statement/transaction/{id}/details [BETA] Get additional details about transaction by ID.
BankstatementtransactionApi search GET /bank/statement/transaction [BETA] Find bank transaction corresponding with sent data.
CompanyApi get GET /company/{id} Find company by ID.
CompanyApi getDivisions GET /company/divisions [DEPRECATED] Find divisions.
CompanyApi getWithLoginAccess GET /company/>withLoginAccess Returns client customers (with accountant/auditor relation) where the current user has login access (proxy login).
CompanyApi put PUT /company Update company information.
CompanyaltinnApi put PUT /company/settings/altinn [BETA] Update AltInn id and password.
CompanyaltinnApi search GET /company/settings/altinn [BETA] Find Altinn id for login in company.
ContactApi get GET /contact/{id} Get contact by ID.
ContactApi post POST /contact Create contact.
ContactApi put PUT /contact/{id} [BETA] Update contact.
ContactApi search GET /contact Find contacts corresponding with sent data.
CountryApi get GET /country/{id} Get country by ID.
CountryApi search GET /country Find countries corresponding with sent data.
CrmprospectApi get GET /crm/prospect/{id} Get prospect by ID.
CrmprospectApi search GET /crm/prospect Find prospects corresponding with sent data.
CurrencyApi get GET /currency/{id} Get currency by ID.
CurrencyApi search GET /currency Find currencies corresponding with sent data.
CustomerApi get GET /customer/{id} Get customer by ID.
CustomerApi post POST /customer Create customer. Related customer addresses may also be created.
CustomerApi postList POST /customer/list [BETA] Create multiple customers. Related supplier addresses may also be created.
CustomerApi put PUT /customer/{id} Update customer.
CustomerApi putList PUT /customer/list [BETA] Update multiple customers. Addresses can also be updated.
CustomerApi search GET /customer Find customers corresponding with sent data.
CustomercategoryApi get GET /customer/category/{id} Find customer/supplier category by ID.
CustomercategoryApi post POST /customer/category Add new customer/supplier category.
CustomercategoryApi put PUT /customer/category/{id} Update customer/supplier category.
CustomercategoryApi search GET /customer/category Find customer/supplier categories corresponding with sent data.
DepartmentApi delete DELETE /department/{id} Delete department by ID
DepartmentApi get GET /department/{id} Get department by ID.
DepartmentApi post POST /department [BETA] Add new department.
DepartmentApi postList POST /department/list [BETA] Register new departments.
DepartmentApi put PUT /department/{id} [BETA] Update department.
DepartmentApi putList PUT /department/list [BETA] Update multiple departments.
DepartmentApi search GET /department Find department corresponding with sent data.
DivisionApi post POST /division [BETA] Create division.
DivisionApi postList POST /division/list [BETA] Create divisions.
DivisionApi put PUT /division/{id} [BETA] Update division information.
DivisionApi putList PUT /division/list [BETA] Update multiple divisions.
DivisionApi search GET /division [BETA] Get divisions.
DocumentApi downloadContent GET /document/{id}/content [BETA] Get content of document given by ID.
DocumentApi get GET /document/{id} [BETA] Get document by ID.
EmployeeApi get GET /employee/{id} Get employee by ID.
EmployeeApi post POST /employee [BETA] Create one employee.
EmployeeApi postList POST /employee/list [BETA] Create several employees.
EmployeeApi put PUT /employee/{id} Update employee.
EmployeeApi search GET /employee Find employees corresponding with sent data.
EmployeeemploymentApi get GET /employee/employment/{id} Find employment by ID.
EmployeeemploymentApi post POST /employee/employment [BETA] Create employment.
EmployeeemploymentApi put PUT /employee/employment/{id} [BETA] Update employemnt.
EmployeeemploymentApi search GET /employee/employment Find all employments for employee.
EmployeeemploymentdetailsApi get GET /employee/employment/details/{id} [BETA] Find employment details by ID.
EmployeeemploymentdetailsApi post POST /employee/employment/details [BETA] Create employment details.
EmployeeemploymentdetailsApi put PUT /employee/employment/details/{id} [BETA] Update employment details.
EmployeeemploymentdetailsApi search GET /employee/employment/details [BETA] Find all employmentdetails for employment.
EmployeeemploymentemploymentTypeApi getMaritimeEmploymentType GET /employee/employment/employmentType/maritimeEmploymentType [BETA] Find all maritime employment type IDs.
EmployeeemploymentemploymentTypeApi getSalaryType GET /employee/employment/employmentType/salaryType [BETA] Find all salary type IDs.
EmployeeemploymentemploymentTypeApi getScheduleType GET /employee/employment/employmentType/scheduleType [BETA] Find all schedule type IDs.
EmployeeemploymentemploymentTypeApi search GET /employee/employment/employmentType [BETA] Find all employment type IDs.
EmployeeemploymentleaveOfAbsenceApi get GET /employee/employment/leaveOfAbsence/{id} [BETA] Find leave of absence by ID.
EmployeeemploymentleaveOfAbsenceApi post POST /employee/employment/leaveOfAbsence [BETA] Create leave of absence.
EmployeeemploymentleaveOfAbsenceApi postList POST /employee/employment/leaveOfAbsence/list [BETA] Create multiple leave of absences.
EmployeeemploymentleaveOfAbsenceApi put PUT /employee/employment/leaveOfAbsence/{id} [BETA] Update leave of absence.
EmployeeemploymentleaveOfAbsenceTypeApi search GET /employee/employment/leaveOfAbsenceType [BETA] Find all leave of absence type IDs.
EmployeeemploymentoccupationCodeApi search GET /employee/employment/occupationCode [BETA] Find all profession codes.
EmployeeemploymentremunerationTypeApi search GET /employee/employment/remunerationType [BETA] Find all remuneration type IDs.
EmployeeemploymentworkingHoursSchemeApi search GET /employee/employment/workingHoursScheme [BETA] Find working hours scheme ID.
EmployeeentitlementApi client GET /employee/entitlement/client [BETA] Find all entitlements at client for user.
EmployeeentitlementApi get GET /employee/entitlement/{id} Get entitlement by ID.
EmployeeentitlementApi grantClientEntitlementsByTemplate PUT /employee/entitlement/:grantClientEntitlementsByTemplate [BETA] Update employee entitlements in client account.
EmployeeentitlementApi grantEntitlementsByTemplate PUT /employee/entitlement/:grantEntitlementsByTemplate [BETA] Update employee entitlements.
EmployeeentitlementApi search GET /employee/entitlement Find all entitlements for user.
EmployeehourlyCostAndRateApi get GET /employee/hourlyCostAndRate/{id} [BETA] Find hourly cost and rate by ID.
EmployeehourlyCostAndRateApi post POST /employee/hourlyCostAndRate [BETA] Create hourly cost and rate.
EmployeehourlyCostAndRateApi put PUT /employee/hourlyCostAndRate/{id} [BETA] Update hourly cost and rate.
EmployeehourlyCostAndRateApi search GET /employee/hourlyCostAndRate Find all hourly cost and rates for employee.
EmployeenextOfKinApi get GET /employee/nextOfKin/{id} [BETA] Find next of kin by ID.
EmployeenextOfKinApi post POST /employee/nextOfKin [BETA] Create next of kin.
EmployeenextOfKinApi put PUT /employee/nextOfKin/{id} [BETA] Update next of kin.
EmployeenextOfKinApi search GET /employee/nextOfKin Find all next of kin for employee.
EmployeestandardTimeApi get GET /employee/standardTime/{id} [BETA] Find standard time by ID.
EmployeestandardTimeApi post POST /employee/standardTime [BETA] Create standard time.
EmployeestandardTimeApi put PUT /employee/standardTime/{id} [BETA] Update standard time.
EmployeestandardTimeApi search GET /employee/standardTime [BETA] Find all standard times for employee.
EventApi get GET /event [BETA] Get all (WebHook) event keys.
EventsubscriptionApi delete DELETE /event/subscription/{id} [BETA] Delete the given subscription.
EventsubscriptionApi get GET /event/subscription/{id} [BETA] Get subscription by ID.
EventsubscriptionApi post POST /event/subscription [BETA] Create a new subscription for current EmployeeToken.
EventsubscriptionApi put PUT /event/subscription/{id} [BETA] Change a current subscription, based on id.
EventsubscriptionApi search GET /event/subscription [BETA] Find all ongoing subscriptions.
InventoryApi delete DELETE /inventory/{id} [BETA] Delete inventory. Only available for some consumers.
InventoryApi get GET /inventory/{id} Get inventory by ID.
InventoryApi post POST /inventory [BETA] Create new inventory. Only available for some consumers.
InventoryApi put PUT /inventory/{id} [BETA] Update inventory. Only available for some consumers.
InventoryApi search GET /inventory Find inventory corresponding with sent data.
InventoryinventoriesApi search GET /inventory/inventories [BETA] Find inventories corresponding with sent data. Only available for some consumers.
InventorystocktakingApi delete DELETE /inventory/stocktaking/{id} [BETA] Delete stocktaking. Only available for some consumers.
InventorystocktakingApi get GET /inventory/stocktaking/{id} [BETA] Get stocktaking by ID. Only available for some consumers.
InventorystocktakingApi post POST /inventory/stocktaking [BETA] Create new stocktaking. Only available for some consumers.
InventorystocktakingApi put PUT /inventory/stocktaking/{id} [BETA] Update stocktaking. Only available for some consumers.
InventorystocktakingApi search GET /inventory/stocktaking [BETA] Find stocktaking corresponding with sent data. Only available for some consumers.
InventorystocktakingproductlineApi delete DELETE /inventory/stocktaking/productline/{id} [BETA] Delete product line. Only available for some consumers.
InventorystocktakingproductlineApi get GET /inventory/stocktaking/productline/{id} [BETA] Get product line by ID. Only available for some consumers.
InventorystocktakingproductlineApi post POST /inventory/stocktaking/productline [BETA] Create product line. When creating several product lines, use /list for better performance. Only available for some consumers.
InventorystocktakingproductlineApi put PUT /inventory/stocktaking/productline/{id} [BETA] Update product line. Only available for some consumers.
InventorystocktakingproductlineApi search GET /inventory/stocktaking/productline [BETA] Find all product lines by stocktaking ID. Only available for some consumers.
InvoiceApi createCreditNote PUT /invoice/{id}/:createCreditNote [BETA] Creates a new Invoice representing a credit memo that nullifies the given invoice. Updates this invoice and any pre-existing inverse invoice.
InvoiceApi createReminder PUT /invoice/{id}/:createReminder [BETA] Create invoice reminder and sends it by the given dispatch type. Supports the reminder types SOFT_REMINDER, REMINDER and NOTICE_OF_DEBT_COLLECTION. DispatchType NETS_PRINT must have type NOTICE_OF_DEBT_COLLECTION. SMS and NETS_PRINT must be activated prior to usage in the API.
InvoiceApi downloadPdf GET /invoice/{invoiceId}/pdf Get invoice document by invoice ID.
InvoiceApi get GET /invoice/{id} Get invoice by ID.
InvoiceApi payment PUT /invoice/{id}/:payment Update invoice. The invoice is updated with payment information. The amount is in the invoice’s currency.
InvoiceApi post POST /invoice Create invoice.
InvoiceApi search GET /invoice Find invoices corresponding with sent data. Includes charged outgoing invoices only.
InvoiceApi send PUT /invoice/{id}/:send [BETA] Send invoice by ID and sendType. Optionally override email recipient.
InvoicedetailsApi get GET /invoice/details/{id} [BETA] Get ProjectInvoiceDetails by ID.
InvoicedetailsApi search GET /invoice/details Find ProjectInvoiceDetails corresponding with sent data.
InvoicepaymentTypeApi get GET /invoice/paymentType/{id} Get payment type by ID.
InvoicepaymentTypeApi search GET /invoice/paymentType Find payment type corresponding with sent data.
LedgerApi openPost GET /ledger/openPost Find open posts corresponding with sent data.
LedgerApi search GET /ledger Get ledger (hovedbok).
LedgeraccountApi delete DELETE /ledger/account/{id} [BETA] Delete account.
LedgeraccountApi deleteByIds DELETE /ledger/account/list [BETA] Delete multiple accounts.
LedgeraccountApi get GET /ledger/account/{id} Get account by ID.
LedgeraccountApi post POST /ledger/account [BETA] Create a new account.
LedgeraccountApi postList POST /ledger/account/list [BETA] Create several accounts.
LedgeraccountApi put PUT /ledger/account/{id} [BETA] Update account.
LedgeraccountApi putList PUT /ledger/account/list [BETA] Update multiple accounts.
LedgeraccountApi search GET /ledger/account Find accounts corresponding with sent data.
LedgeraccountingPeriodApi get GET /ledger/accountingPeriod/{id} Get accounting period by ID.
LedgeraccountingPeriodApi search GET /ledger/accountingPeriod Find accounting periods corresponding with sent data.
LedgerannualAccountApi get GET /ledger/annualAccount/{id} Get annual account by ID.
LedgerannualAccountApi search GET /ledger/annualAccount Find annual accounts corresponding with sent data.
LedgercloseGroupApi get GET /ledger/closeGroup/{id} Get close group by ID.
LedgercloseGroupApi search GET /ledger/closeGroup Find close groups corresponding with sent data.
LedgerpaymentTypeOutApi delete DELETE /ledger/paymentTypeOut/{id} [BETA] Delete payment type for outgoing payments by ID.
LedgerpaymentTypeOutApi get GET /ledger/paymentTypeOut/{id} [BETA] Get payment type for outgoing payments by ID.
LedgerpaymentTypeOutApi post POST /ledger/paymentTypeOut [BETA] Create new payment type for outgoing payments
LedgerpaymentTypeOutApi postList POST /ledger/paymentTypeOut/list [BETA] Create multiple payment types for outgoing payments at once
LedgerpaymentTypeOutApi put PUT /ledger/paymentTypeOut/{id} [BETA] Update existing payment type for outgoing payments
LedgerpaymentTypeOutApi putList PUT /ledger/paymentTypeOut/list [BETA] Update multiple payment types for outgoing payments at once
LedgerpaymentTypeOutApi search GET /ledger/paymentTypeOut [BETA] Gets payment types for outgoing payments
LedgerpostingApi get GET /ledger/posting/{id} Find postings by ID.
LedgerpostingApi openPost GET /ledger/posting/openPost Find open posts corresponding with sent data.
LedgerpostingApi search GET /ledger/posting Find postings corresponding with sent data.
LedgervatTypeApi get GET /ledger/vatType/{id} Get vat type by ID.
LedgervatTypeApi search GET /ledger/vatType Find vat types corresponding with sent data.
LedgervoucherApi delete DELETE /ledger/voucher/{id} [BETA] Delete voucher by ID.
LedgervoucherApi deleteAttachment DELETE /ledger/voucher/{id}/attachment [BETA] Delete attachment.
LedgervoucherApi downloadPdf GET /ledger/voucher/{voucherId}/pdf Get PDF representation of voucher by ID.
LedgervoucherApi get GET /ledger/voucher/{id} Get voucher by ID.
LedgervoucherApi importDocument POST /ledger/voucher/importDocument [BETA] Upload a document to create one or more vouchers. Valid document formats are PDF, PNG, JPEG, TIFF and EHF. Send as multipart form.
LedgervoucherApi importGbat10 POST /ledger/voucher/importGbat10 Import GBAT10. Send as multipart form.
LedgervoucherApi nonPosted GET /ledger/voucher/>nonPosted [BETA] Find non-posted vouchers.
LedgervoucherApi post POST /ledger/voucher Add new voucher. IMPORTANT: Also creates postings. Only the gross amounts will be used
LedgervoucherApi put PUT /ledger/voucher/{id} [BETA] Update voucher. Postings with guiRow==0 will be deleted and regenerated.
LedgervoucherApi putList PUT /ledger/voucher/list [BETA] Update multiple vouchers. Postings with guiRow==0 will be deleted and regenerated.
LedgervoucherApi reverse PUT /ledger/voucher/{id}/:reverse Reverses the voucher, and returns the reversed voucher. Supports reversing most voucher types, except salary transactions.
LedgervoucherApi search GET /ledger/voucher Find vouchers corresponding with sent data.
LedgervoucherApi sendToInbox PUT /ledger/voucher/{id}/:sendToInbox [BETA] Send voucher to inbox.
LedgervoucherApi sendToLedger PUT /ledger/voucher/{id}/:sendToLedger [BETA] Send voucher to ledger.
LedgervoucherApi uploadAttachment POST /ledger/voucher/{voucherId}/attachment Upload attachment to voucher. If the voucher already has an attachment the content will be appended to the existing attachment as new PDF page(s). Valid document formats are PDF, PNG, JPEG and TIFF. Non PDF formats will be converted to PDF. Send as multipart form.
LedgervoucherApi uploadPdf POST /ledger/voucher/{voucherId}/pdf/{fileName} [DEPRECATED] Use POST ledger/voucher/{voucherId}/attachment instead.
LedgervoucherTypeApi get GET /ledger/voucherType/{id} Get voucher type by ID.
LedgervoucherTypeApi search GET /ledger/voucherType Find voucher types corresponding with sent data.
MunicipalityApi search GET /municipality [BETA] Get municipalities.
OrderApi get GET /order/{id} Get order by ID.
OrderApi invoice PUT /order/{id}/:invoice Create new invoice from order.
OrderApi post POST /order Create order.
OrderApi put PUT /order/{id} Update order.
OrderApi search GET /order Find orders corresponding with sent data.
OrderorderlineApi delete DELETE /order/orderline/{id} [BETA] Delete order line by ID.
OrderorderlineApi get GET /order/orderline/{id} Get order line by ID.
OrderorderlineApi post POST /order/orderline Create order line. When creating several order lines, use /list for better performance.
OrderorderlineApi postList POST /order/orderline/list Create multiple order lines.
ProductApi get GET /product/{id} Get product by ID.
ProductApi post POST /product Create new product.
ProductApi put PUT /product/{id} Update product.
ProductApi search GET /product Find products corresponding with sent data.
ProductexternalApi get GET /product/external/{id} [BETA] Get external product by ID.
ProductexternalApi search GET /product/external [BETA] Find external products corresponding with sent data.
ProductunitApi get GET /product/unit/{id} Get product unit by ID.
ProductunitApi search GET /product/unit Find product units corresponding with sent data.
ProjectApi delete DELETE /project/{id} [BETA] Delete project.
ProjectApi deleteByIds DELETE /project/list [BETA] Delete projects.
ProjectApi deleteList DELETE /project [BETA] Delete multiple projects.
ProjectApi get GET /project/{id} Find project by ID.
ProjectApi getForTimeSheet GET /project/>forTimeSheet Find projects applicable for time sheet registration on a specific day.
ProjectApi post POST /project [BETA] Add new project.
ProjectApi postList POST /project/list [BETA] Register new projects. Multiple projects for different users can be sent in the same request.
ProjectApi put PUT /project/{id} [BETA] Update project.
ProjectApi putList PUT /project/list [BETA] Update multiple projects.
ProjectApi search GET /project Find projects corresponding with sent data.
ProjectcategoryApi get GET /project/category/{id} Find project category by ID.
ProjectcategoryApi post POST /project/category Add new project category.
ProjectcategoryApi put PUT /project/category/{id} Update project category.
ProjectcategoryApi search GET /project/category Find project categories corresponding with sent data.
ProjectorderlineApi delete DELETE /project/orderline/{id} [BETA] Delete order line by ID.
ProjectorderlineApi get GET /project/orderline/{id} [BETA] Get order line by ID.
ProjectorderlineApi post POST /project/orderline [BETA] Create order line. When creating several order lines, use /list for better performance.
ProjectorderlineApi postList POST /project/orderline/list [BETA] Create multiple order lines.
ProjectorderlineApi put PUT /project/orderline/{id} [BETA] Update project orderline.
ProjectparticipantApi deleteByIds DELETE /project/participant/list [BETA] Delete project participants.
ProjectparticipantApi get GET /project/participant/{id} [BETA] Find project participant by ID.
ProjectparticipantApi post POST /project/participant [BETA] Add new project participant.
ProjectparticipantApi postList POST /project/participant/list [BETA] Register new projects. Multiple projects for different users can be sent in the same request.
ProjectparticipantApi put PUT /project/participant/{id} [BETA] Update project participant.
ReminderApi get GET /reminder/{id} Get reminder by ID.
ReminderApi search GET /reminder Find reminders corresponding with sent data.
SalarypayslipApi downloadPdf GET /salary/payslip/{id}/pdf [BETA] Find payslip (PDF document) by ID.
SalarypayslipApi get GET /salary/payslip/{id} [BETA] Find payslip by ID.
SalarypayslipApi search GET /salary/payslip [BETA] Find payslips corresponding with sent data.
SalarysettingsApi get GET /salary/settings [BETA] Get salary settings of logged in company.
SalarysettingsApi put PUT /salary/settings [BETA] Update settings of logged in company.
SalarysettingsholidayApi deleteByIds DELETE /salary/settings/holiday/list [BETA] delete multiple holiday settings of current logged in company.
SalarysettingsholidayApi post POST /salary/settings/holiday [BETA] Create a holiday setting of current logged in company.
SalarysettingsholidayApi postList POST /salary/settings/holiday/list [BETA] Create multiple holiday settings of current logged in company.
SalarysettingsholidayApi put PUT /salary/settings/holiday/{id} [BETA] update a holiday setting of current logged in company.
SalarysettingsholidayApi putList PUT /salary/settings/holiday/list [BETA] update multiple holiday settings of current logged in company.
SalarysettingsholidayApi search GET /salary/settings/holiday [BETA] Find holiday settings of current logged in company.
SalarytransactionApi delete DELETE /salary/transaction/{id} [BETA] Delete salary transaction by ID.
SalarytransactionApi get GET /salary/transaction/{id} [BETA] Find salary transaction by ID.
SalarytransactionApi post POST /salary/transaction [BETA] Create a new salary transaction.
SalarytypeApi get GET /salary/type/{id} [BETA] Find salary type by ID.
SalarytypeApi search GET /salary/type [BETA] Find salary type corresponding with sent data.
SupplierApi get GET /supplier/{id} Get supplier by ID.
SupplierApi post POST /supplier Create supplier. Related supplier addresses may also be created.
SupplierApi postList POST /supplier/list [BETA] Create multiple suppliers. Related supplier addresses may also be created.
SupplierApi put PUT /supplier/{id} Update supplier.
SupplierApi putList PUT /supplier/list [BETA] Update multiple suppliers. Addresses can also be updated.
SupplierApi search GET /supplier Find suppliers corresponding with sent data.
TimesheetentryApi delete DELETE /timesheet/entry/{id} Delete timesheet entry by ID.
TimesheetentryApi get GET /timesheet/entry/{id} Find timesheet entry by ID.
TimesheetentryApi getRecentActivities GET /timesheet/entry/>recentActivities Find recently used timesheet activities.
TimesheetentryApi getRecentProjects GET /timesheet/entry/>recentProjects Find projects with recent activities (timesheet entry registered).
TimesheetentryApi getTotalHours GET /timesheet/entry/>totalHours Find total hours registered on an employee in a specific period.
TimesheetentryApi post POST /timesheet/entry Add new timesheet entry. Only one entry per employee/date/activity/project combination is supported.
TimesheetentryApi postList POST /timesheet/entry/list Add new timesheet entry. Multiple objects for several users can be sent in the same request.
TimesheetentryApi put PUT /timesheet/entry/{id} Update timesheet entry by ID. Note: Timesheet entry object fields which are present but not set, or set to 0, will be nulled.
TimesheetentryApi putList PUT /timesheet/entry/list Update timesheet entry. Multiple objects for different users can be sent in the same request.
TimesheetentryApi search GET /timesheet/entry Find timesheet entry corresponding with sent data.
TimesheetsettingsApi get GET /timesheet/settings [BETA] Get timesheet settings of logged in company.
TimesheettimeClockApi get GET /timesheet/timeClock/{id} Find time clock entry by ID.
TimesheettimeClockApi getPresent GET /timesheet/timeClock/present Find a user’s present running time clock.
TimesheettimeClockApi put PUT /timesheet/timeClock/{id} Update time clock by ID.
TimesheettimeClockApi search GET /timesheet/timeClock Find time clock entries corresponding with sent data.
TimesheettimeClockApi start PUT /timesheet/timeClock/:start Start time clock.
TimesheettimeClockApi stop PUT /timesheet/timeClock/{id}/:stop Stop time clock.
TimesheetweekApi approve PUT /timesheet/week/:approve Approve week. By ID or (ISO-8601 week and employeeId combination).
TimesheetweekApi complete PUT /timesheet/week/:complete Complete week. By ID or (ISO-8601 week and employeeId combination).
TimesheetweekApi reopen PUT /timesheet/week/:reopen Reopen week. By ID or (ISO-8601 week and employeeId combination).
TimesheetweekApi search GET /timesheet/week Find weekly status By ID, week/year combination, employeeId. or an approver
TimesheetweekApi unapprove PUT /timesheet/week/:unapprove Unapprove week. By ID or (ISO-8601 week and employeeId combination).
TokenconsumerApi getByToken GET /token/consumer/byToken Get consumer token by token string.
TokenemployeeApi create PUT /token/employee/:create Create an employee token. Only selected consumers are allowed
TokensessionApi create PUT /token/session/:create Create session token.
TokensessionApi delete DELETE /token/session/{token} Delete session token.
TokensessionApi whoAmI GET /token/session/>whoAmI Find information about the current user.
TravelExpenseApi approve PUT /travelExpense/:approve [BETA] Approve travel expenses.
TravelExpenseApi copy PUT /travelExpense/:copy [BETA] Copy travel expense.
TravelExpenseApi createVouchers PUT /travelExpense/:createVouchers [BETA] Create vouchers
TravelExpenseApi delete DELETE /travelExpense/{id} [BETA] Delete travel expense.
TravelExpenseApi deliver PUT /travelExpense/:deliver [BETA] Deliver travel expenses.
TravelExpenseApi downloadAttachment GET /travelExpense/{travelExpenseId}/attachment Get attachment by travel expense ID.
TravelExpenseApi get GET /travelExpense/{id} [BETA] Get travel expense by ID.
TravelExpenseApi post POST /travelExpense [BETA] Create travel expense.
TravelExpenseApi put PUT /travelExpense/{id} [BETA] Update travel expense.
TravelExpenseApi search GET /travelExpense [BETA] Find travel expenses corresponding with sent data.
TravelExpenseApi unapprove PUT /travelExpense/:unapprove [BETA] Unapprove travel expenses.
TravelExpenseApi undeliver PUT /travelExpense/:undeliver [BETA] Undeliver travel expenses.
TravelExpenseApi uploadAttachment POST /travelExpense/{travelExpenseId}/attachment Upload attachment to travel expense.
TravelExpenseaccommodationAllowanceApi delete DELETE /travelExpense/accommodationAllowance/{id} [BETA] Delete accommodation allowance.
TravelExpenseaccommodationAllowanceApi get GET /travelExpense/accommodationAllowance/{id} [BETA] Get travel accommodation allowance by ID.
TravelExpenseaccommodationAllowanceApi post POST /travelExpense/accommodationAllowance [BETA] Create accommodation allowance.
TravelExpenseaccommodationAllowanceApi put PUT /travelExpense/accommodationAllowance/{id} [BETA] Update accommodation allowance.
TravelExpenseaccommodationAllowanceApi search GET /travelExpense/accommodationAllowance [BETA] Find accommodation allowances corresponding with sent data.
TravelExpensecostApi delete DELETE /travelExpense/cost/{id} [BETA] Delete cost.
TravelExpensecostApi get GET /travelExpense/cost/{id} [BETA] Get cost by ID.
TravelExpensecostApi post POST /travelExpense/cost [BETA] Create cost.
TravelExpensecostApi put PUT /travelExpense/cost/{id} [BETA] Update cost.
TravelExpensecostApi search GET /travelExpense/cost [BETA] Find costs corresponding with sent data.
TravelExpensecostCategoryApi get GET /travelExpense/costCategory/{id} [BETA] Get cost category by ID.
TravelExpensecostCategoryApi search GET /travelExpense/costCategory [BETA] Find cost category corresponding with sent data.
TravelExpensemileageAllowanceApi delete DELETE /travelExpense/mileageAllowance/{id} [BETA] Delete mileage allowance.
TravelExpensemileageAllowanceApi get GET /travelExpense/mileageAllowance/{id} [BETA] Get mileage allowance by ID.
TravelExpensemileageAllowanceApi post POST /travelExpense/mileageAllowance [BETA] Create mileage allowance.
TravelExpensemileageAllowanceApi put PUT /travelExpense/mileageAllowance/{id} [BETA] Update mileage allowance.
TravelExpensemileageAllowanceApi search GET /travelExpense/mileageAllowance [BETA] Find mileage allowances corresponding with sent data.
TravelExpensepassengerApi delete DELETE /travelExpense/passenger/{id} [BETA] Delete passenger.
TravelExpensepassengerApi get GET /travelExpense/passenger/{id} [BETA] Get passenger by ID.
TravelExpensepassengerApi post POST /travelExpense/passenger [BETA] Create passenger.
TravelExpensepassengerApi put PUT /travelExpense/passenger/{id} [BETA] Update passenger.
TravelExpensepassengerApi search GET /travelExpense/passenger [BETA] Find passengers corresponding with sent data.
TravelExpensepaymentTypeApi get GET /travelExpense/paymentType/{id} [BETA] Get payment type by ID.
TravelExpensepaymentTypeApi search GET /travelExpense/paymentType [BETA] Find payment type corresponding with sent data.
TravelExpenseperDiemCompensationApi delete DELETE /travelExpense/perDiemCompensation/{id} [BETA] Delete per diem compensation.
TravelExpenseperDiemCompensationApi get GET /travelExpense/perDiemCompensation/{id} [BETA] Get per diem compensation by ID.
TravelExpenseperDiemCompensationApi post POST /travelExpense/perDiemCompensation [BETA] Create per diem compensation.
TravelExpenseperDiemCompensationApi put PUT /travelExpense/perDiemCompensation/{id} [BETA] Update per diem compensation.
TravelExpenseperDiemCompensationApi search GET /travelExpense/perDiemCompensation [BETA] Find per diem compensations corresponding with sent data.
TravelExpenserateApi get GET /travelExpense/rate/{id} [BETA] Get travel expense rate by ID.
TravelExpenserateApi search GET /travelExpense/rate [BETA] Find rates corresponding with sent data.
TravelExpenserateCategoryApi get GET /travelExpense/rateCategory/{id} [BETA] Get travel expense rate category by ID.
TravelExpenserateCategoryApi search GET /travelExpense/rateCategory [BETA] Find rate categories corresponding with sent data.
TravelExpenserateCategoryGroupApi get GET /travelExpense/rateCategoryGroup/{id} [BETA] Get travel report rate category group by ID.
TravelExpenserateCategoryGroupApi search GET /travelExpense/rateCategoryGroup [BETA] Find rate categoriy groups corresponding with sent data.

Documentation For Models

Documentation For Authorization

tokenAuthScheme

  • Type: HTTP basic authentication

Author

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

4 watching

Forks

2 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages