diff --git a/independent-publisher-connectors/Fortnox/README.md b/independent-publisher-connectors/Fortnox/README.md new file mode 100644 index 0000000000..0553bc0535 --- /dev/null +++ b/independent-publisher-connectors/Fortnox/README.md @@ -0,0 +1,79 @@ +# Fortnox + +Fortnox offers a cloud-based platform that enables businesses and accounting firms to manage their finances and administration efficiently. The platform is a market leader in Sweden. It also provides customers with access to financial services and business insurance. + +## Publisher: Mathias Törnblom + +## Prerequisites + +- Active Fortnox license +- Fortnox Developer Account +- API client credentials (Client ID, Client Secret) +- A company in Fortnox with API access enabled + +## Supported Operations + +### Accounts +- **Get Account**: Retrieve details of a specific account by account number. + +### Customers +- **List Customers**: Retrieve a paginated list of customers. Supports filtering (e.g., active/inactive). +- **Get Customer**: Get details of a customer by customer number. +- **Update Customer**: Update specific fields for a customer. +- **Delete Customer**: Permanently delete a customer by customer number. + +### Orders +- **Create Order**: Create a new order with support for multiple rows and delivery settings. + +### Invoices +- **Create Invoice**: Generate a new invoice. +- **List Invoices**: Get a list of existing invoices. +- **Preview Invoice**: Fetch a PDF preview of an invoice. +- **Cancel Invoice**: Cancel an invoice using its document number. + +## Obtaining Credentials + +Fortnox uses **OAuth 2.0** for authentication. + +1. Go to [developer.fortnox.se](https://developer.fortnox.se). +2. Register your integration to get a **Client ID** and **Client Secret**. +3. Use the authorization code flow to obtain an **access token**. +4. Ensure the user has granted access to the application during authentication. + +Tokens must be included in the `Authorization: Bearer ` header. + +## Getting Started + +1. Export the Swagger file provided for this connector. +2. In **Power Apps** or **Power Automate**, go to **Data > Custom Connectors**. +3. Select **+ New custom connector > Import an OpenAPI file**. +4. Upload the Swagger (OpenAPI) file and follow the wizard. +5. Configure OAuth 2.0 settings under the **Security** tab. +6. Test the connection using your Fortnox credentials and start building flows or apps. + +## Known Issues and Limitations + +- Pagination is required for large datasets (e.g., customers, invoices). +- Rate limits apply based on your Fortnox subscription plan. +- Some advanced fields are only visible when editing the connector in expert mode. +- You must handle token refresh manually unless using a premium connector setup. + +## Frequently Asked Questions + +### How do I test the connector? + +Use Power Automate’s **Test** tab inside the custom connector to run operations like "List Customers" or "Get Account". + +### Can I use this connector in Power BI? + +Not directly. Use Power Automate to fetch data and push it to a dataset in Power BI. + +## Deployment Instructions + +1. Open **Power Apps** or **Power Automate**. +2. Go to **Custom Connectors > New Custom Connector**. +3. Select **Import an OpenAPI file**, upload the Fortnox Swagger file. +4. Set up OAuth 2.0 with your Client ID and Secret. +5. Define the **authorization URL**, **token URL**, and **refresh URL** from Fortnox. +6. Save and test the connector. +7. Add it to your flows or apps like any built-in connector. diff --git a/independent-publisher-connectors/Fortnox/apiDefinition.swagger.json b/independent-publisher-connectors/Fortnox/apiDefinition.swagger.json new file mode 100644 index 0000000000..2d8e5f4efd --- /dev/null +++ b/independent-publisher-connectors/Fortnox/apiDefinition.swagger.json @@ -0,0 +1,7375 @@ +{ + "swagger": "2.0", + "info": { + "title": "Fortnox Integration", + "version": "1.0.12", + "description": "Creates a Custom Connection to Fortnox", + "contact": { + "name": "Mathias Törnblom", + "email": "mathias@tornbloms.net" + } + }, + "host": "api.fortnox.se", + "basePath": "/3/", + "schemes": ["https"], + "consumes": ["application/json"], + "produces": ["application/json"], + "paths": { + "/accounts/{Number}": { + "get": { + "tags": ["Accounts"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "Account": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url", + "title": "", + "x-ms-visibility": "internal" + }, + "Active": { + "type": "boolean", + "description": "Active", + "title": "", + "x-ms-visibility": "advanced", + "enum": [true, false] + }, + "BalanceBroughtForward": { + "type": "number", + "description": "BalanceBroughtForward", + "title": "", + "x-ms-visibility": "advanced" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter", + "title": "", + "x-ms-visibility": "advanced" + }, + "CostCenterSettings": { + "type": "string", + "description": "CostCenterSettings", + "title": "", + "x-ms-visibility": "advanced" + }, + "Description": { + "type": "string", + "description": "Description", + "title": "", + "x-ms-visibility": "important" + }, + "Number": { + "type": "integer", + "format": "int32", + "description": "Number", + "title": "", + "x-ms-visibility": "important" + }, + "Project": { + "type": "string", + "description": "Project", + "title": "", + "x-ms-visibility": "advanced" + }, + "ProjectSettings": { + "type": "string", + "description": "ProjectSettings", + "title": "", + "x-ms-visibility": "advanced" + }, + "SRU": { + "type": "integer", + "format": "int32", + "description": "SRU", + "title": "", + "x-ms-visibility": "advanced" + }, + "Year": { + "type": "integer", + "format": "int32", + "description": "Year", + "title": "", + "x-ms-visibility": "advanced" + }, + "VATCode": { + "type": "string", + "description": "VATCode", + "title": "", + "x-ms-visibility": "advanced" + }, + "BalanceCarriedForward": { + "type": "number", + "description": "BalanceCarriedForward", + "title": "", + "x-ms-visibility": "advanced" + }, + "TransactionInformation": { + "type": "string", + "description": "TransactionInformation", + "title": "", + "x-ms-visibility": "advanced" + }, + "TransactionInformationSettings": { + "type": "string", + "description": "TransactionInformationSettings", + "title": "", + "x-ms-visibility": "advanced" + }, + "QuantitySettings": { + "type": "string", + "description": "QuantitySettings", + "title": "", + "x-ms-visibility": "advanced" + }, + "QuantityUnit": { + "type": "string", + "description": "QuantityUnit", + "title": "", + "x-ms-visibility": "advanced" + }, + "OpeningQuantities": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Project": { + "type": "string", + "description": "Project", + "title": "", + "x-ms-visibility": "advanced" + }, + "Balance": { + "type": "number", + "description": "Balance", + "title": "", + "x-ms-visibility": "advanced" + } + } + }, + "description": "OpeningQuantities" + } + }, + "description": "Account" + } + } + } + } + }, + "summary": "Retrieve an account", + "description": "Retrieves the details of an account. You need to supply the unique account number that was returned when the account was created or retrieved from the list of accounts.", + "operationId": "GetAccount", + "x-ms-visibility": "advanced", + "x-ms-url-encoding": "single", + "parameters": [ + { + "name": "Number", + "in": "path", + "required": true, + "type": "integer", + "x-ms-visibility": "important", + "description": "Identifies the account", + "format": "int32", + "x-ms-summary": "Account number", + "x-ms-url-encoding": "single" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "x-ms-summary": "Content-Type", + "description": "Content-Type" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "x-ms-summary": "Accept", + "description": "Accept" + } + ] + } + }, + "/customers": { + "get": { + "tags": ["Customers"], + "summary": "List Customers", + "description": "Customers", + "operationId": "GetAllCustomers", + "parameters": [ + { + "name": "limit", + "default": 500, + "in": "query", + "type": "integer", + "required": false, + "x-ms-visibility": "advanced", + "x-ms-summary": "Limit", + "description": "Optional limit of responces per page" + }, + { + "name": "filter", + "in": "query", + "type": "string", + "required": false, + "x-ms-visibility": "advanced", + "enum": ["active", "inactive"], + "x-ms-summary": "Filter", + "description": "Optional filter of active or inactive customers" + }, + { + "name": "page", + "in": "query", + "type": "integer", + "required": false, + "x-ms-visibility": "advanced", + "format": "int32", + "x-ms-summary": "Page", + "description": "Optional set the page number to be returned" + }, + { + "name": "lastmodified", + "in": "query", + "required": false, + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Last modified since", + "description": "Optional filter to get all records since the provided timestamp" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "x-ms-summary": "Content-Type", + "description": "Content-Type" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "x-ms-summary": "Accept", + "description": "Accept" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "MetaInformation": { + "type": "object", + "properties": { + "@TotalResources": { + "type": "integer", + "format": "int32", + "description": "@TotalResources", + "title": "", + "x-ms-visibility": "advanced" + }, + "@TotalPages": { + "type": "integer", + "format": "int32", + "description": "@TotalPages", + "title": "", + "x-ms-visibility": "advanced" + }, + "@CurrentPage": { + "type": "integer", + "format": "int32", + "description": "@CurrentPage", + "title": "", + "x-ms-visibility": "advanced" + } + }, + "description": "MetaInformation" + }, + "Customers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url", + "title": "", + "x-ms-visibility": "internal" + }, + "Address1": { + "type": "string", + "description": "Address1", + "title": "", + "x-ms-visibility": "important" + }, + "Address2": { + "type": "string", + "description": "Address2", + "title": "", + "x-ms-visibility": "important" + }, + "City": { + "type": "string", + "description": "City", + "title": "", + "x-ms-visibility": "important" + }, + "CustomerNumber": { + "type": "string", + "description": "CustomerNumber", + "title": "", + "x-ms-visibility": "important" + }, + "Email": { + "type": "string", + "description": "Email", + "title": "", + "x-ms-visibility": "important" + }, + "Name": { + "type": "string", + "description": "Name", + "title": "", + "x-ms-visibility": "important" + }, + "OrganisationNumber": { + "type": "string", + "description": "OrganisationNumber", + "title": "", + "x-ms-visibility": "important" + }, + "Phone": { + "type": "string", + "description": "Phone", + "title": "", + "x-ms-visibility": "important" + }, + "ZipCode": { + "type": "string", + "description": "ZipCode", + "title": "", + "x-ms-visibility": "important" + } + } + }, + "description": "Customers" + } + } + } + } + }, + "x-ms-visibility": "important" + } + }, + "/customers/{CustomerNumber}": { + "get": { + "tags": ["Customers"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "Customer": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url" + }, + "Address1": { + "type": "string", + "description": "Address1" + }, + "Address2": { + "type": "string", + "description": "Address2" + }, + "City": { + "type": "string", + "description": "City" + }, + "Country": { + "type": "string", + "description": "Country" + }, + "Comments": { + "type": "string", + "description": "Comments" + }, + "Currency": { + "type": "string", + "description": "Currency" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter" + }, + "CountryCode": { + "type": "string", + "description": "CountryCode" + }, + "Active": { + "type": "boolean", + "description": "Active" + }, + "CustomerNumber": { + "type": "string", + "description": "CustomerNumber" + }, + "DefaultDeliveryTypes": { + "type": "object", + "properties": { + "Invoice": { + "type": "string", + "description": "Invoice" + }, + "Order": { + "type": "string", + "description": "Order" + }, + "Offer": { + "type": "string", + "description": "Offer" + } + }, + "description": "DefaultDeliveryTypes" + }, + "DefaultTemplates": { + "type": "object", + "properties": { + "CashInvoice": { + "type": "string", + "description": "CashInvoice" + }, + "Invoice": { + "type": "string", + "description": "Invoice" + }, + "Offer": { + "type": "string", + "description": "Offer" + }, + "Order": { + "type": "string", + "description": "Order" + } + }, + "description": "DefaultTemplates" + }, + "DeliveryAddress1": { + "type": "string", + "description": "DeliveryAddress1" + }, + "DeliveryAddress2": { + "type": "string", + "description": "DeliveryAddress2" + }, + "DeliveryCity": { + "type": "string", + "description": "DeliveryCity" + }, + "DeliveryCountry": { + "type": "string", + "description": "DeliveryCountry" + }, + "DeliveryCountryCode": { + "type": "string", + "description": "DeliveryCountryCode" + }, + "DeliveryFax": { + "type": "string", + "description": "DeliveryFax" + }, + "DeliveryName": { + "type": "string", + "description": "DeliveryName" + }, + "DeliveryPhone1": { + "type": "string", + "description": "DeliveryPhone1" + }, + "DeliveryPhone2": { + "type": "string", + "description": "DeliveryPhone2" + }, + "DeliveryZipCode": { + "type": "string", + "description": "DeliveryZipCode" + }, + "Email": { + "type": "string", + "description": "Email" + }, + "EmailInvoice": { + "type": "string", + "description": "EmailInvoice" + }, + "EmailInvoiceBCC": { + "type": "string", + "description": "EmailInvoiceBCC" + }, + "EmailInvoiceCC": { + "type": "string", + "description": "EmailInvoiceCC" + }, + "EmailOffer": { + "type": "string", + "description": "EmailOffer" + }, + "EmailOfferBCC": { + "type": "string", + "description": "EmailOfferBCC" + }, + "EmailOfferCC": { + "type": "string", + "description": "EmailOfferCC" + }, + "EmailOrder": { + "type": "string", + "description": "EmailOrder" + }, + "EmailOrderBCC": { + "type": "string", + "description": "EmailOrderBCC" + }, + "EmailOrderCC": { + "type": "string", + "description": "EmailOrderCC" + }, + "ExternalReference": { + "type": "string", + "description": "ExternalReference" + }, + "Fax": { + "type": "string", + "description": "Fax" + }, + "GLN": { + "type": "string", + "description": "GLN" + }, + "GLNDelivery": { + "type": "string", + "description": "GLNDelivery" + }, + "InvoiceAdministrationFee": { + "type": "string", + "description": "InvoiceAdministrationFee" + }, + "InvoiceDiscount": { + "type": "string", + "description": "InvoiceDiscount" + }, + "InvoiceFreight": { + "type": "string", + "description": "InvoiceFreight" + }, + "InvoiceRemark": { + "type": "string", + "description": "InvoiceRemark" + }, + "Name": { + "type": "string", + "description": "Name" + }, + "OrganisationNumber": { + "type": "string", + "description": "OrganisationNumber" + }, + "OurReference": { + "type": "string", + "description": "OurReference" + }, + "Phone1": { + "type": "string", + "description": "Phone1" + }, + "Phone2": { + "type": "string", + "description": "Phone2" + }, + "PriceList": { + "type": "string", + "description": "PriceList" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "SalesAccount": { + "type": "string", + "description": "SalesAccount" + }, + "ShowPriceVATIncluded": { + "type": "boolean", + "description": "ShowPriceVATIncluded" + }, + "TermsOfDelivery": { + "type": "string", + "description": "TermsOfDelivery" + }, + "TermsOfPayment": { + "type": "string", + "description": "TermsOfPayment" + }, + "Type": { + "type": "string", + "description": "Type" + }, + "VATNumber": { + "type": "string", + "description": "VATNumber" + }, + "VATType": { + "type": "string", + "description": "VATType" + }, + "VisitingAddress": { + "type": "string", + "description": "VisitingAddress" + }, + "VisitingCity": { + "type": "string", + "description": "VisitingCity" + }, + "VisitingCountry": { + "type": "string", + "description": "VisitingCountry" + }, + "VisitingCountryCode": { + "type": "string", + "description": "VisitingCountryCode" + }, + "VisitingZipCode": { + "type": "string", + "description": "VisitingZipCode" + }, + "WayOfDelivery": { + "type": "string", + "description": "WayOfDelivery" + }, + "WWW": { + "type": "string", + "description": "WWW" + }, + "YourReference": { + "type": "string", + "description": "YourReference" + }, + "ZipCode": { + "type": "string", + "description": "ZipCode" + } + }, + "description": "Customer" + } + } + } + } + }, + "summary": "Get Customer", + "description": "Get a customer by id", + "operationId": "GetCustomer", + "x-ms-visibility": "important", + "parameters": [ + { + "name": "CustomerNumber", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "Customer number", + "description": "Unique identifier for the customer to be retrieved", + "x-ms-visibility": "important", + "x-ms-url-encoding": "single" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "x-ms-summary": "Content-Type", + "description": "Content-Type" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "x-ms-summary": "Accept", + "description": "Accept" + } + ] + }, + "delete": { + "tags": ["Customers"], + "responses": { + "200": { + "description": "Successfully deleted", + "schema": { + "type": "object" + } + } + }, + "summary": "Delete a customer", + "description": "Deletes the customer permanently. If everything succeeded the response will be of the type 204 \\u2013 No content and the response body will be empty. If there was any problems an error will be returned. You need to supply the unique customer number of the customer that you want to delete.", + "operationId": "DeleteCustomer", + "x-ms-visibility": "advanced", + "parameters": [ + { + "name": "CustomerNumber", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "Customer number", + "description": "Unique identifier for the customer to be deleted", + "x-ms-url-encoding": "single" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "x-ms-summary": "Content-Type", + "description": "Content-Type" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "x-ms-summary": "Accept", + "description": "Accept" + } + ] + }, + "put": { + "tags": ["Customers"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "Customer": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url" + }, + "Address1": { + "type": "string", + "description": "Address1" + }, + "Address2": { + "type": "string", + "description": "Address2" + }, + "City": { + "type": "string", + "description": "City" + }, + "Country": { + "type": "string", + "description": "Country" + }, + "Comments": { + "type": "string", + "description": "Comments" + }, + "Currency": { + "type": "string", + "description": "Currency" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter" + }, + "CountryCode": { + "type": "string", + "description": "CountryCode" + }, + "Active": { + "type": "boolean", + "description": "Active" + }, + "CustomerNumber": { + "type": "string", + "description": "CustomerNumber" + }, + "DefaultDeliveryTypes": { + "type": "object", + "properties": { + "Invoice": { + "type": "string", + "description": "Invoice" + }, + "Order": { + "type": "string", + "description": "Order" + }, + "Offer": { + "type": "string", + "description": "Offer" + } + }, + "description": "DefaultDeliveryTypes" + }, + "DefaultTemplates": { + "type": "object", + "properties": { + "CashInvoice": { + "type": "string", + "description": "CashInvoice" + }, + "Invoice": { + "type": "string", + "description": "Invoice" + }, + "Offer": { + "type": "string", + "description": "Offer" + }, + "Order": { + "type": "string", + "description": "Order" + } + }, + "description": "DefaultTemplates" + }, + "DeliveryAddress1": { + "type": "string", + "description": "DeliveryAddress1" + }, + "DeliveryAddress2": { + "type": "string", + "description": "DeliveryAddress2" + }, + "DeliveryCity": { + "type": "string", + "description": "DeliveryCity" + }, + "DeliveryCountry": { + "type": "string", + "description": "DeliveryCountry" + }, + "DeliveryCountryCode": { + "type": "string", + "description": "DeliveryCountryCode" + }, + "DeliveryFax": { + "type": "string", + "description": "DeliveryFax" + }, + "DeliveryName": { + "type": "string", + "description": "DeliveryName" + }, + "DeliveryPhone1": { + "type": "string", + "description": "DeliveryPhone1" + }, + "DeliveryPhone2": { + "type": "string", + "description": "DeliveryPhone2" + }, + "DeliveryZipCode": { + "type": "string", + "description": "DeliveryZipCode" + }, + "Email": { + "type": "string", + "description": "Email" + }, + "EmailInvoice": { + "type": "string", + "description": "EmailInvoice" + }, + "EmailInvoiceBCC": { + "type": "string", + "description": "EmailInvoiceBCC" + }, + "EmailInvoiceCC": { + "type": "string", + "description": "EmailInvoiceCC" + }, + "EmailOffer": { + "type": "string", + "description": "EmailOffer" + }, + "EmailOfferBCC": { + "type": "string", + "description": "EmailOfferBCC" + }, + "EmailOfferCC": { + "type": "string", + "description": "EmailOfferCC" + }, + "EmailOrder": { + "type": "string", + "description": "EmailOrder" + }, + "EmailOrderBCC": { + "type": "string", + "description": "EmailOrderBCC" + }, + "EmailOrderCC": { + "type": "string", + "description": "EmailOrderCC" + }, + "ExternalReference": { + "type": "string", + "description": "ExternalReference" + }, + "Fax": { + "type": "string", + "description": "Fax" + }, + "GLN": { + "type": "string", + "description": "GLN" + }, + "GLNDelivery": { + "type": "string", + "description": "GLNDelivery" + }, + "InvoiceAdministrationFee": { + "type": "string", + "description": "InvoiceAdministrationFee" + }, + "InvoiceDiscount": { + "type": "string", + "description": "InvoiceDiscount" + }, + "InvoiceFreight": { + "type": "string", + "description": "InvoiceFreight" + }, + "InvoiceRemark": { + "type": "string", + "description": "InvoiceRemark" + }, + "Name": { + "type": "string", + "description": "Name" + }, + "OrganisationNumber": { + "type": "string", + "description": "OrganisationNumber" + }, + "OurReference": { + "type": "string", + "description": "OurReference" + }, + "Phone1": { + "type": "string", + "description": "Phone1" + }, + "Phone2": { + "type": "string", + "description": "Phone2" + }, + "PriceList": { + "type": "string", + "description": "PriceList" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "SalesAccount": { + "type": "string", + "description": "SalesAccount" + }, + "ShowPriceVATIncluded": { + "type": "boolean", + "description": "ShowPriceVATIncluded" + }, + "TermsOfDelivery": { + "type": "string", + "description": "TermsOfDelivery" + }, + "TermsOfPayment": { + "type": "string", + "description": "TermsOfPayment" + }, + "Type": { + "type": "string", + "description": "Type" + }, + "VATNumber": { + "type": "string", + "description": "VATNumber" + }, + "VATType": { + "type": "string", + "description": "VATType" + }, + "VisitingAddress": { + "type": "string", + "description": "VisitingAddress" + }, + "VisitingCity": { + "type": "string", + "description": "VisitingCity" + }, + "VisitingCountry": { + "type": "string", + "description": "VisitingCountry" + }, + "VisitingCountryCode": { + "type": "string", + "description": "VisitingCountryCode" + }, + "VisitingZipCode": { + "type": "string", + "description": "VisitingZipCode" + }, + "WayOfDelivery": { + "type": "string", + "description": "WayOfDelivery" + }, + "WWW": { + "type": "string", + "description": "WWW" + }, + "YourReference": { + "type": "string", + "description": "YourReference" + }, + "ZipCode": { + "type": "string", + "description": "ZipCode" + } + }, + "description": "Customer" + } + } + } + } + }, + "summary": "Update a customer", + "description": "The updated customer will be returned if everything succeeded, if there was any problems an error will be returned. You need to supply the unique customer number of the customer that you want to update. Only the properties provided in the request body will be updated, properties not provided will left unchanged.", + "operationId": "UpdateCustomer", + "x-ms-visibility": "advanced", + "parameters": [ + { + "name": "CustomerNumber", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "Customer number", + "description": "Unique identifier for the customer to be updated", + "x-ms-visibility": "important", + "x-ms-url-encoding": "single" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal" + }, + { + "name": "body", + "in": "body", + "required": false, + "schema": { + "type": "object", + "properties": { + "Customer": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url" + }, + "Address1": { + "type": "string", + "description": "Address1" + }, + "Address2": { + "type": "string", + "description": "Address2" + }, + "City": { + "type": "string", + "description": "City" + }, + "Country": { + "type": "string", + "description": "Country" + }, + "Comments": { + "type": "string", + "description": "Comments" + }, + "Currency": { + "type": "string", + "description": "Currency" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter" + }, + "CountryCode": { + "type": "string", + "description": "CountryCode" + }, + "Active": { + "type": "boolean", + "description": "Active" + }, + "CustomerNumber": { + "type": "string", + "description": "CustomerNumber" + }, + "DefaultDeliveryTypes": { + "type": "object", + "properties": { + "Invoice": { + "type": "string", + "description": "Invoice" + }, + "Order": { + "type": "string", + "description": "Order" + }, + "Offer": { + "type": "string", + "description": "Offer" + } + }, + "description": "DefaultDeliveryTypes" + }, + "DefaultTemplates": { + "type": "object", + "properties": { + "CashInvoice": { + "type": "string", + "description": "CashInvoice" + }, + "Invoice": { + "type": "string", + "description": "Invoice" + }, + "Offer": { + "type": "string", + "description": "Offer" + }, + "Order": { + "type": "string", + "description": "Order" + } + }, + "description": "DefaultTemplates" + }, + "DeliveryAddress1": { + "type": "string", + "description": "DeliveryAddress1" + }, + "DeliveryAddress2": { + "type": "string", + "description": "DeliveryAddress2" + }, + "DeliveryCity": { + "type": "string", + "description": "DeliveryCity" + }, + "DeliveryCountry": { + "type": "string", + "description": "DeliveryCountry" + }, + "DeliveryCountryCode": { + "type": "string", + "description": "DeliveryCountryCode" + }, + "DeliveryFax": { + "type": "string", + "description": "DeliveryFax" + }, + "DeliveryName": { + "type": "string", + "description": "DeliveryName" + }, + "DeliveryPhone1": { + "type": "string", + "description": "DeliveryPhone1" + }, + "DeliveryPhone2": { + "type": "string", + "description": "DeliveryPhone2" + }, + "DeliveryZipCode": { + "type": "string", + "description": "DeliveryZipCode" + }, + "Email": { + "type": "string", + "description": "Email" + }, + "EmailInvoice": { + "type": "string", + "description": "EmailInvoice" + }, + "EmailInvoiceBCC": { + "type": "string", + "description": "EmailInvoiceBCC" + }, + "EmailInvoiceCC": { + "type": "string", + "description": "EmailInvoiceCC" + }, + "EmailOffer": { + "type": "string", + "description": "EmailOffer" + }, + "EmailOfferBCC": { + "type": "string", + "description": "EmailOfferBCC" + }, + "EmailOfferCC": { + "type": "string", + "description": "EmailOfferCC" + }, + "EmailOrder": { + "type": "string", + "description": "EmailOrder" + }, + "EmailOrderBCC": { + "type": "string", + "description": "EmailOrderBCC" + }, + "EmailOrderCC": { + "type": "string", + "description": "EmailOrderCC" + }, + "ExternalReference": { + "type": "string", + "description": "ExternalReference" + }, + "Fax": { + "type": "string", + "description": "Fax" + }, + "GLN": { + "type": "string", + "description": "GLN" + }, + "GLNDelivery": { + "type": "string", + "description": "GLNDelivery" + }, + "InvoiceAdministrationFee": { + "type": "string", + "description": "InvoiceAdministrationFee" + }, + "InvoiceDiscount": { + "type": "string", + "description": "InvoiceDiscount" + }, + "InvoiceFreight": { + "type": "string", + "description": "InvoiceFreight" + }, + "InvoiceRemark": { + "type": "string", + "description": "InvoiceRemark" + }, + "Name": { + "type": "string", + "description": "Name" + }, + "OrganisationNumber": { + "type": "string", + "description": "OrganisationNumber" + }, + "OurReference": { + "type": "string", + "description": "OurReference" + }, + "Phone1": { + "type": "string", + "description": "Phone1" + }, + "Phone2": { + "type": "string", + "description": "Phone2" + }, + "PriceList": { + "type": "string", + "description": "PriceList" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "SalesAccount": { + "type": "string", + "description": "SalesAccount" + }, + "ShowPriceVATIncluded": { + "type": "boolean", + "description": "ShowPriceVATIncluded" + }, + "TermsOfDelivery": { + "type": "string", + "description": "TermsOfDelivery" + }, + "TermsOfPayment": { + "type": "string", + "description": "TermsOfPayment" + }, + "Type": { + "type": "string", + "description": "Type" + }, + "VATNumber": { + "type": "string", + "description": "VATNumber" + }, + "VATType": { + "type": "string", + "description": "VATType" + }, + "VisitingAddress": { + "type": "string", + "description": "VisitingAddress" + }, + "VisitingCity": { + "type": "string", + "description": "VisitingCity" + }, + "VisitingCountry": { + "type": "string", + "description": "VisitingCountry" + }, + "VisitingCountryCode": { + "type": "string", + "description": "VisitingCountryCode" + }, + "VisitingZipCode": { + "type": "string", + "description": "VisitingZipCode" + }, + "WayOfDelivery": { + "type": "string", + "description": "WayOfDelivery" + }, + "WWW": { + "type": "string", + "description": "WWW" + }, + "YourReference": { + "type": "string", + "description": "YourReference" + }, + "ZipCode": { + "type": "string", + "description": "ZipCode" + } + } + } + } + } + } + ] + } + }, + "/orders": { + "post": { + "tags": ["Orders"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "Order": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url" + }, + "@urlTaxReductionList": { + "type": "string", + "description": "@urlTaxReductionList" + }, + "AdministrationFee": { + "type": "integer", + "format": "int32", + "description": "AdministrationFee" + }, + "AdministrationFeeVAT": { + "type": "integer", + "format": "int32", + "description": "AdministrationFeeVAT" + }, + "Address1": { + "type": "string", + "description": "Address1" + }, + "Address2": { + "type": "string", + "description": "Address2" + }, + "BasisTaxReduction": { + "type": "integer", + "format": "int32", + "description": "BasisTaxReduction" + }, + "Cancelled": { + "type": "boolean", + "description": "Cancelled" + }, + "City": { + "type": "string", + "description": "City" + }, + "Comments": { + "type": "string", + "description": "Comments" + }, + "ContributionPercent": { + "type": "integer", + "format": "int32", + "description": "ContributionPercent" + }, + "ContributionValue": { + "type": "integer", + "format": "int32", + "description": "ContributionValue" + }, + "CopyRemarks": { + "type": "boolean", + "description": "CopyRemarks" + }, + "Country": { + "type": "string", + "description": "Country" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter" + }, + "Currency": { + "type": "string", + "description": "Currency" + }, + "CurrencyRate": { + "type": "integer", + "format": "int32", + "description": "CurrencyRate" + }, + "CurrencyUnit": { + "type": "integer", + "format": "int32", + "description": "CurrencyUnit" + }, + "CustomerName": { + "type": "string", + "description": "CustomerName" + }, + "CustomerNumber": { + "type": "string", + "description": "CustomerNumber" + }, + "DeliveryState": { + "type": "string", + "description": "DeliveryState" + }, + "DeliveryAddress1": { + "type": "string", + "description": "DeliveryAddress1" + }, + "DeliveryAddress2": { + "type": "string", + "description": "DeliveryAddress2" + }, + "DeliveryCity": { + "type": "string", + "description": "DeliveryCity" + }, + "DeliveryCountry": { + "type": "string", + "description": "DeliveryCountry" + }, + "DeliveryDate": { + "type": "string", + "description": "DeliveryDate" + }, + "DeliveryName": { + "type": "string", + "description": "DeliveryName" + }, + "DeliveryZipCode": { + "type": "string", + "description": "DeliveryZipCode" + }, + "DocumentNumber": { + "type": "string", + "description": "DocumentNumber" + }, + "EmailInformation": { + "type": "object", + "properties": { + "EmailAddressFrom": { + "type": "string", + "description": "EmailAddressFrom" + }, + "EmailAddressTo": { + "type": "string", + "description": "EmailAddressTo" + }, + "EmailAddressCC": { + "type": "string", + "description": "EmailAddressCC" + }, + "EmailAddressBCC": { + "type": "string", + "description": "EmailAddressBCC" + }, + "EmailSubject": { + "type": "string", + "description": "EmailSubject" + }, + "EmailBody": { + "type": "string", + "description": "EmailBody" + } + }, + "description": "EmailInformation" + }, + "ExternalInvoiceReference1": { + "type": "string", + "description": "ExternalInvoiceReference1" + }, + "ExternalInvoiceReference2": { + "type": "string", + "description": "ExternalInvoiceReference2" + }, + "Freight": { + "type": "integer", + "format": "int32", + "description": "Freight" + }, + "FreightVAT": { + "type": "integer", + "format": "int32", + "description": "FreightVAT" + }, + "Gross": { + "type": "integer", + "format": "int32", + "description": "Gross" + }, + "HouseWork": { + "type": "boolean", + "description": "HouseWork" + }, + "InvoiceReference": { + "type": "string", + "description": "InvoiceReference" + }, + "Labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "integer", + "format": "int32", + "description": "Id" + } + } + }, + "description": "Labels" + }, + "Language": { + "type": "string", + "description": "Language" + }, + "Net": { + "type": "integer", + "format": "int32", + "description": "Net" + }, + "NotCompleted": { + "type": "boolean", + "description": "NotCompleted" + }, + "OfferReference": { + "type": "string", + "description": "OfferReference" + }, + "OrderDate": { + "type": "string", + "description": "OrderDate" + }, + "OrderRows": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AccountNumber": { + "type": "integer", + "format": "int32", + "description": "AccountNumber" + }, + "ArticleNumber": { + "type": "string", + "description": "ArticleNumber" + }, + "ContributionPercent": { + "type": "string", + "description": "ContributionPercent" + }, + "ContributionValue": { + "type": "string", + "description": "ContributionValue" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter" + }, + "DeliveredQuantity": { + "type": "string", + "description": "DeliveredQuantity" + }, + "Description": { + "type": "string", + "description": "Description" + }, + "Discount": { + "type": "integer", + "format": "int32", + "description": "Discount" + }, + "DiscountType": { + "type": "string", + "description": "DiscountType" + }, + "HouseWork": { + "type": "boolean", + "description": "HouseWork" + }, + "HouseWorkHoursToReport": { + "type": "integer", + "format": "int32", + "description": "HouseWorkHoursToReport" + }, + "HouseWorkType": { + "type": "string", + "description": "HouseWorkType" + }, + "OrderedQuantity": { + "type": "string", + "description": "OrderedQuantity" + }, + "Price": { + "type": "integer", + "format": "int32", + "description": "Price" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "ReservedQuantity": { + "type": "string", + "description": "ReservedQuantity" + }, + "RowId": { + "type": "integer", + "format": "int32", + "description": "RowId" + }, + "StockPointCode": { + "type": "string", + "description": "StockPointCode" + }, + "StockPointId": { + "type": "string", + "description": "StockPointId" + }, + "Total": { + "type": "integer", + "format": "int32", + "description": "Total" + }, + "Unit": { + "type": "string", + "description": "Unit" + }, + "VAT": { + "type": "integer", + "format": "int32", + "description": "VAT" + } + } + }, + "description": "OrderRows" + }, + "OrderType": { + "type": "string", + "description": "OrderType" + }, + "OrganisationNumber": { + "type": "string", + "description": "OrganisationNumber" + }, + "OurReference": { + "type": "string", + "description": "OurReference" + }, + "Phone1": { + "type": "string", + "description": "Phone1" + }, + "Phone2": { + "type": "string", + "description": "Phone2" + }, + "PriceList": { + "type": "string", + "description": "PriceList" + }, + "PrintTemplate": { + "type": "string", + "description": "PrintTemplate" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "WarehouseReady": { + "type": "boolean", + "description": "WarehouseReady" + }, + "OutboundDate": { + "type": "string", + "description": "OutboundDate" + }, + "Remarks": { + "type": "string", + "description": "Remarks" + }, + "RoundOff": { + "type": "integer", + "format": "int32", + "description": "RoundOff" + }, + "Sent": { + "type": "boolean", + "description": "Sent" + }, + "TaxReduction": { + "type": "integer", + "format": "int32", + "description": "TaxReduction" + }, + "TermsOfDelivery": { + "type": "string", + "description": "TermsOfDelivery" + }, + "TermsOfPayment": { + "type": "string", + "description": "TermsOfPayment" + }, + "TimeBasisReference": { + "type": "integer", + "format": "int32", + "description": "TimeBasisReference" + }, + "Total": { + "type": "integer", + "format": "int32", + "description": "Total" + }, + "TotalToPay": { + "type": "integer", + "format": "int32", + "description": "TotalToPay" + }, + "TotalVAT": { + "type": "integer", + "format": "int32", + "description": "TotalVAT" + }, + "VATIncluded": { + "type": "boolean", + "description": "VATIncluded" + }, + "WayOfDelivery": { + "type": "string", + "description": "WayOfDelivery" + }, + "YourReference": { + "type": "string", + "description": "YourReference" + }, + "YourOrderNumber": { + "type": "string", + "description": "YourOrderNumber" + }, + "ZipCode": { + "type": "string", + "description": "ZipCode" + }, + "StockPointCode": { + "type": "string", + "description": "StockPointCode" + }, + "StockPointId": { + "type": "string", + "description": "StockPointId" + }, + "TaxReductionType": { + "type": "string", + "description": "TaxReductionType" + } + }, + "description": "Order" + } + } + } + } + }, + "summary": "Create order", + "description": "Creates an order", + "operationId": "CreateOrder", + "x-ms-visibility": "important", + "parameters": [ + { + "name": "Order", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "Order": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url", + "title": "@url" + }, + "@urlTaxReductionList": { + "type": "string", + "description": "@urlTaxReductionList", + "title": "@urlTaxReductionList" + }, + "AdministrationFee": { + "type": "integer", + "format": "int32", + "description": "AdministrationFee", + "title": "Administration Fee", + "x-ms-visibility": "advanced" + }, + "AdministrationFeeVAT": { + "type": "integer", + "format": "int32", + "description": "AdministrationFeeVAT", + "title": "Administration Fee VAT", + "x-ms-visibility": "advanced" + }, + "Address1": { + "type": "string", + "description": "Address1", + "title": "Address1", + "x-ms-visibility": "advanced" + }, + "Address2": { + "type": "string", + "description": "Address2", + "title": "Address2", + "x-ms-visibility": "advanced" + }, + "BasisTaxReduction": { + "type": "integer", + "format": "int32", + "description": "BasisTaxReduction", + "x-ms-visibility": "advanced", + "title": "Basis Tax Reduction" + }, + "Cancelled": { + "type": "boolean", + "description": "Cancelled", + "x-ms-visibility": "advanced" + }, + "City": { + "type": "string", + "description": "City", + "x-ms-visibility": "advanced" + }, + "Comments": { + "type": "string", + "description": "Comments", + "x-ms-visibility": "advanced" + }, + "ContributionPercent": { + "type": "integer", + "format": "int32", + "description": "ContributionPercent", + "x-ms-visibility": "advanced" + }, + "ContributionValue": { + "type": "integer", + "format": "int32", + "description": "ContributionValue", + "x-ms-visibility": "advanced" + }, + "CopyRemarks": { + "type": "boolean", + "description": "CopyRemarks", + "x-ms-visibility": "advanced" + }, + "Country": { + "type": "string", + "description": "Country", + "x-ms-visibility": "advanced" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter", + "x-ms-visibility": "advanced" + }, + "Currency": { + "type": "string", + "description": "Currency", + "x-ms-visibility": "advanced" + }, + "CurrencyRate": { + "type": "integer", + "format": "int32", + "description": "CurrencyRate", + "x-ms-visibility": "advanced" + }, + "CurrencyUnit": { + "type": "integer", + "format": "int32", + "description": "CurrencyUnit", + "x-ms-visibility": "advanced" + }, + "CustomerName": { + "type": "string", + "description": "CustomerName", + "x-ms-visibility": "advanced" + }, + "CustomerNumber": { + "type": "string", + "description": "CustomerNumber", + "title": "Customer Number", + "x-ms-visibility": "important" + }, + "DeliveryState": { + "type": "string", + "description": "DeliveryState", + "title": "Delivery State", + "x-ms-visibility": "advanced", + "enum": ["registration", "reservation", "delivery"] + }, + "DeliveryAddress1": { + "type": "string", + "description": "DeliveryAddress1", + "x-ms-visibility": "advanced" + }, + "DeliveryAddress2": { + "type": "string", + "description": "DeliveryAddress2", + "x-ms-visibility": "advanced" + }, + "DeliveryCity": { + "type": "string", + "description": "DeliveryCity", + "x-ms-visibility": "advanced" + }, + "DeliveryCountry": { + "type": "string", + "description": "DeliveryCountry", + "x-ms-visibility": "advanced" + }, + "DeliveryDate": { + "type": "string", + "description": "DeliveryDate", + "x-ms-visibility": "advanced" + }, + "DeliveryName": { + "type": "string", + "description": "DeliveryName", + "x-ms-visibility": "advanced" + }, + "DeliveryZipCode": { + "type": "string", + "description": "DeliveryZipCode", + "x-ms-visibility": "advanced" + }, + "DocumentNumber": { + "type": "string", + "description": "DocumentNumber", + "x-ms-visibility": "advanced" + }, + "ExternalInvoiceReference1": { + "type": "string", + "description": "ExternalInvoiceReference1", + "x-ms-visibility": "advanced" + }, + "ExternalInvoiceReference2": { + "type": "string", + "description": "ExternalInvoiceReference2", + "x-ms-visibility": "advanced" + }, + "Freight": { + "type": "integer", + "format": "int32", + "description": "Freight", + "x-ms-visibility": "advanced" + }, + "FreightVAT": { + "type": "integer", + "format": "int32", + "description": "FreightVAT", + "x-ms-visibility": "advanced" + }, + "Gross": { + "type": "integer", + "format": "int32", + "description": "Gross", + "x-ms-visibility": "advanced" + }, + "HouseWork": { + "type": "boolean", + "description": "HouseWork", + "x-ms-visibility": "advanced" + }, + "InvoiceReference": { + "type": "string", + "description": "InvoiceReference", + "x-ms-visibility": "advanced" + }, + "Language": { + "type": "string", + "description": "Language", + "x-ms-visibility": "advanced" + }, + "Net": { + "type": "integer", + "format": "int32", + "description": "Net", + "x-ms-visibility": "advanced" + }, + "NotCompleted": { + "type": "boolean", + "description": "NotCompleted", + "x-ms-visibility": "advanced" + }, + "OfferReference": { + "type": "string", + "description": "OfferReference", + "x-ms-visibility": "advanced" + }, + "OrderDate": { + "type": "string", + "description": "OrderDate", + "x-ms-visibility": "advanced" + }, + "OrderRows": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AccountNumber": { + "type": "integer", + "format": "int32", + "description": "AccountNumber", + "x-ms-visibility": "advanced" + }, + "ArticleNumber": { + "type": "string", + "description": "ArticleNumber", + "x-ms-visibility": "advanced" + }, + "ContributionPercent": { + "type": "string", + "description": "ContributionPercent", + "x-ms-visibility": "advanced" + }, + "ContributionValue": { + "type": "string", + "description": "ContributionValue", + "x-ms-visibility": "advanced" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter", + "x-ms-visibility": "advanced" + }, + "DeliveredQuantity": { + "type": "string", + "description": "DeliveredQuantity", + "x-ms-visibility": "advanced" + }, + "Description": { + "type": "string", + "description": "Description", + "x-ms-visibility": "advanced" + }, + "Discount": { + "type": "integer", + "format": "int32", + "description": "Discount", + "x-ms-visibility": "advanced" + }, + "DiscountType": { + "type": "string", + "description": "DiscountType", + "x-ms-visibility": "advanced" + }, + "HouseWork": { + "type": "boolean", + "description": "HouseWork", + "x-ms-visibility": "advanced" + }, + "HouseWorkHoursToReport": { + "type": "integer", + "format": "int32", + "description": "HouseWorkHoursToReport", + "x-ms-visibility": "advanced" + }, + "HouseWorkType": { + "type": "string", + "description": "HouseWorkType", + "x-ms-visibility": "advanced" + }, + "OrderedQuantity": { + "type": "string", + "description": "OrderedQuantity", + "x-ms-visibility": "advanced" + }, + "Price": { + "type": "integer", + "format": "int32", + "description": "Price", + "x-ms-visibility": "advanced" + }, + "Project": { + "type": "string", + "description": "Project", + "x-ms-visibility": "advanced" + }, + "ReservedQuantity": { + "type": "string", + "description": "ReservedQuantity", + "x-ms-visibility": "advanced" + }, + "RowId": { + "type": "integer", + "format": "int32", + "description": "RowId", + "x-ms-visibility": "advanced" + }, + "StockPointCode": { + "type": "string", + "description": "StockPointCode", + "x-ms-visibility": "advanced" + }, + "StockPointId": { + "type": "string", + "description": "StockPointId", + "x-ms-visibility": "advanced" + }, + "Total": { + "type": "integer", + "format": "int32", + "description": "Total", + "x-ms-visibility": "advanced" + }, + "Unit": { + "type": "string", + "description": "Unit", + "x-ms-visibility": "advanced" + }, + "VAT": { + "type": "integer", + "format": "int32", + "description": "VAT", + "x-ms-visibility": "advanced" + } + } + }, + "description": "OrderRows" + }, + "OrderType": { + "type": "string", + "description": "OrderType", + "x-ms-visibility": "advanced" + }, + "OrganisationNumber": { + "type": "string", + "description": "OrganisationNumber", + "x-ms-visibility": "advanced" + }, + "OurReference": { + "type": "string", + "description": "OurReference", + "x-ms-visibility": "advanced" + }, + "Phone1": { + "type": "string", + "description": "Phone1", + "x-ms-visibility": "advanced" + }, + "Phone2": { + "type": "string", + "description": "Phone2", + "x-ms-visibility": "advanced" + }, + "PriceList": { + "type": "string", + "description": "PriceList", + "x-ms-visibility": "advanced" + }, + "PrintTemplate": { + "type": "string", + "description": "PrintTemplate", + "x-ms-visibility": "advanced" + }, + "Project": { + "type": "string", + "description": "Project", + "x-ms-visibility": "advanced" + }, + "WarehouseReady": { + "type": "boolean", + "description": "WarehouseReady", + "x-ms-visibility": "advanced" + }, + "OutboundDate": { + "type": "string", + "description": "OutboundDate", + "x-ms-visibility": "advanced" + }, + "Remarks": { + "type": "string", + "description": "Remarks", + "x-ms-visibility": "advanced" + }, + "RoundOff": { + "type": "integer", + "format": "int32", + "description": "RoundOff", + "x-ms-visibility": "advanced" + }, + "Sent": { + "type": "boolean", + "description": "Sent", + "x-ms-visibility": "advanced" + }, + "TaxReduction": { + "type": "integer", + "format": "int32", + "description": "TaxReduction", + "x-ms-visibility": "advanced" + }, + "TermsOfDelivery": { + "type": "string", + "description": "TermsOfDelivery", + "x-ms-visibility": "advanced" + }, + "TermsOfPayment": { + "type": "string", + "description": "TermsOfPayment", + "x-ms-visibility": "advanced" + }, + "TimeBasisReference": { + "type": "integer", + "format": "int32", + "description": "TimeBasisReference", + "x-ms-visibility": "advanced" + }, + "Total": { + "type": "integer", + "format": "int32", + "description": "Total", + "x-ms-visibility": "advanced" + }, + "TotalToPay": { + "type": "integer", + "format": "int32", + "description": "TotalToPay", + "x-ms-visibility": "advanced" + }, + "TotalVAT": { + "type": "integer", + "format": "int32", + "description": "TotalVAT", + "x-ms-visibility": "advanced" + }, + "VATIncluded": { + "type": "boolean", + "description": "VATIncluded", + "x-ms-visibility": "advanced" + }, + "WayOfDelivery": { + "type": "string", + "description": "WayOfDelivery", + "x-ms-visibility": "advanced" + }, + "YourReference": { + "type": "string", + "description": "YourReference", + "x-ms-visibility": "advanced" + }, + "YourOrderNumber": { + "type": "string", + "description": "YourOrderNumber", + "x-ms-visibility": "advanced" + }, + "ZipCode": { + "type": "string", + "description": "ZipCode", + "x-ms-visibility": "advanced" + }, + "StockPointCode": { + "type": "string", + "description": "StockPointCode", + "x-ms-visibility": "advanced" + }, + "StockPointId": { + "type": "string", + "description": "StockPointId", + "x-ms-visibility": "advanced" + }, + "TaxReductionType": { + "type": "string", + "description": "TaxReductionType", + "x-ms-visibility": "advanced" + } + }, + "description": "Order", + "required": ["CustomerNumber"] + } + }, + "x-ms-visibility": "important", + "required": ["Order"] + }, + "x-ms-visibility": "important" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal" + } + ] + } + }, + "/invoices": { + "post": { + "tags": ["Invoices"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "Invoice": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url" + }, + "@urlTaxReductionList": { + "type": "string", + "description": "@urlTaxReductionList" + }, + "AdministrationFee": { + "type": "integer", + "format": "int32", + "description": "AdministrationFee" + }, + "AdministrationFeeVAT": { + "type": "integer", + "format": "int32", + "description": "AdministrationFeeVAT" + }, + "Address1": { + "type": "string", + "description": "Address1" + }, + "Address2": { + "type": "string", + "description": "Address2" + }, + "Balance": { + "type": "integer", + "format": "int32", + "description": "Balance" + }, + "BasisTaxReduction": { + "type": "integer", + "format": "int32", + "description": "BasisTaxReduction" + }, + "Booked": { + "type": "boolean", + "description": "Booked" + }, + "Cancelled": { + "type": "boolean", + "description": "Cancelled" + }, + "City": { + "type": "string", + "description": "City" + }, + "Comments": { + "type": "string", + "description": "Comments" + }, + "ContractReference": { + "type": "integer", + "format": "int32", + "description": "ContractReference" + }, + "ContributionPercent": { + "type": "integer", + "format": "int32", + "description": "ContributionPercent" + }, + "ContributionValue": { + "type": "integer", + "format": "int32", + "description": "ContributionValue" + }, + "Country": { + "type": "string", + "description": "Country" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter" + }, + "Credit": { + "type": "string", + "description": "Credit" + }, + "CreditInvoiceReference": { + "type": "string", + "description": "CreditInvoiceReference" + }, + "Currency": { + "type": "string", + "description": "Currency" + }, + "CurrencyRate": { + "type": "integer", + "format": "int32", + "description": "CurrencyRate" + }, + "CurrencyUnit": { + "type": "integer", + "format": "int32", + "description": "CurrencyUnit" + }, + "CustomerName": { + "type": "string", + "description": "CustomerName" + }, + "CustomerNumber": { + "type": "string", + "description": "CustomerNumber" + }, + "DeliveryAddress1": { + "type": "string", + "description": "DeliveryAddress1" + }, + "DeliveryAddress2": { + "type": "string", + "description": "DeliveryAddress2" + }, + "DeliveryCity": { + "type": "string", + "description": "DeliveryCity" + }, + "DeliveryCountry": { + "type": "string", + "description": "DeliveryCountry" + }, + "DeliveryDate": { + "type": "string", + "description": "DeliveryDate" + }, + "DeliveryName": { + "type": "string", + "description": "DeliveryName" + }, + "DeliveryZipCode": { + "type": "string", + "description": "DeliveryZipCode" + }, + "DocumentNumber": { + "type": "string", + "description": "DocumentNumber" + }, + "DueDate": { + "type": "string", + "description": "DueDate" + }, + "EDIInformation": { + "type": "object", + "properties": { + "EDIGlobalLocationNumber": { + "type": "string", + "description": "EDIGlobalLocationNumber" + }, + "EDIGlobalLocationNumberDelivery": { + "type": "string", + "description": "EDIGlobalLocationNumberDelivery" + }, + "EDIInvoiceExtra1": { + "type": "string", + "description": "EDIInvoiceExtra1" + }, + "EDIInvoiceExtra2": { + "type": "string", + "description": "EDIInvoiceExtra2" + }, + "EDIOurElectronicReference": { + "type": "string", + "description": "EDIOurElectronicReference" + }, + "EDIYourElectronicReference": { + "type": "string", + "description": "EDIYourElectronicReference" + }, + "EDIStatus": { + "type": "string", + "description": "EDIStatus" + } + }, + "description": "EDIInformation" + }, + "EmailInformation": { + "type": "object", + "properties": { + "EmailAddressFrom": { + "type": "string", + "description": "EmailAddressFrom" + }, + "EmailAddressTo": { + "type": "string", + "description": "EmailAddressTo" + }, + "EmailAddressCC": { + "type": "string", + "description": "EmailAddressCC" + }, + "EmailAddressBCC": { + "type": "string", + "description": "EmailAddressBCC" + }, + "EmailSubject": { + "type": "string", + "description": "EmailSubject" + }, + "EmailBody": { + "type": "string", + "description": "EmailBody" + } + }, + "description": "EmailInformation" + }, + "EUQuarterlyReport": { + "type": "boolean", + "description": "EUQuarterlyReport" + }, + "ExternalInvoiceReference1": { + "type": "string", + "description": "ExternalInvoiceReference1" + }, + "ExternalInvoiceReference2": { + "type": "string", + "description": "ExternalInvoiceReference2" + }, + "Freight": { + "type": "integer", + "format": "int32", + "description": "Freight" + }, + "FreightVAT": { + "type": "integer", + "format": "int32", + "description": "FreightVAT" + }, + "Gross": { + "type": "integer", + "format": "int32", + "description": "Gross" + }, + "HouseWork": { + "type": "boolean", + "description": "HouseWork" + }, + "InvoiceDate": { + "type": "string", + "description": "InvoiceDate" + }, + "InvoicePeriodStart": { + "type": "string", + "description": "InvoicePeriodStart" + }, + "InvoicePeriodEnd": { + "type": "string", + "description": "InvoicePeriodEnd" + }, + "InvoicePeriodReference": { + "type": "string", + "description": "InvoicePeriodReference" + }, + "InvoiceRows": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AccountNumber": { + "type": "integer", + "format": "int32", + "description": "AccountNumber" + }, + "ArticleNumber": { + "type": "string", + "description": "ArticleNumber" + }, + "ContributionPercent": { + "type": "string", + "description": "ContributionPercent" + }, + "ContributionValue": { + "type": "string", + "description": "ContributionValue" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter" + }, + "DeliveredQuantity": { + "type": "string", + "description": "DeliveredQuantity" + }, + "Description": { + "type": "string", + "description": "Description" + }, + "Discount": { + "type": "integer", + "format": "int32", + "description": "Discount" + }, + "DiscountType": { + "type": "string", + "description": "DiscountType" + }, + "HouseWork": { + "type": "boolean", + "description": "HouseWork" + }, + "HouseWorkHoursToReport": { + "type": "integer", + "format": "int32", + "description": "HouseWorkHoursToReport" + }, + "HouseWorkType": { + "type": "string", + "description": "HouseWorkType" + }, + "Price": { + "type": "integer", + "format": "int32", + "description": "Price" + }, + "PriceExcludingVAT": { + "type": "integer", + "format": "int32", + "description": "PriceExcludingVAT" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "RowId": { + "type": "integer", + "format": "int32", + "description": "RowId" + }, + "StockPointCode": { + "type": "string", + "description": "StockPointCode" + }, + "Total": { + "type": "integer", + "format": "int32", + "description": "Total" + }, + "TotalExcludingVAT": { + "type": "integer", + "format": "int32", + "description": "TotalExcludingVAT" + }, + "Unit": { + "type": "string", + "description": "Unit" + }, + "VAT": { + "type": "integer", + "format": "int32", + "description": "VAT" + } + } + }, + "description": "InvoiceRows" + }, + "InvoiceType": { + "type": "string", + "description": "InvoiceType" + }, + "Labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "integer", + "format": "int32", + "description": "Id" + } + } + }, + "description": "Labels" + }, + "Language": { + "type": "string", + "description": "Language" + }, + "LastRemindDate": { + "type": "string", + "description": "LastRemindDate" + }, + "Net": { + "type": "integer", + "format": "int32", + "description": "Net" + }, + "NotCompleted": { + "type": "boolean", + "description": "NotCompleted" + }, + "NoxFinans": { + "type": "boolean", + "description": "NoxFinans" + }, + "OCR": { + "type": "string", + "description": "OCR" + }, + "OfferReference": { + "type": "string", + "description": "OfferReference" + }, + "OrderReference": { + "type": "string", + "description": "OrderReference" + }, + "OrganisationNumber": { + "type": "string", + "description": "OrganisationNumber" + }, + "OurReference": { + "type": "string", + "description": "OurReference" + }, + "PaymentWay": { + "type": "string", + "description": "PaymentWay" + }, + "Phone1": { + "type": "string", + "description": "Phone1" + }, + "Phone2": { + "type": "string", + "description": "Phone2" + }, + "PriceList": { + "type": "string", + "description": "PriceList" + }, + "PrintTemplate": { + "type": "string", + "description": "PrintTemplate" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "WarehouseReady": { + "type": "boolean", + "description": "WarehouseReady" + }, + "OutboundDate": { + "type": "string", + "description": "OutboundDate" + }, + "Remarks": { + "type": "string", + "description": "Remarks" + }, + "Reminders": { + "type": "integer", + "format": "int32", + "description": "Reminders" + }, + "RoundOff": { + "type": "integer", + "format": "int32", + "description": "RoundOff" + }, + "Sent": { + "type": "boolean", + "description": "Sent" + }, + "TaxReduction": { + "type": "integer", + "format": "int32", + "description": "TaxReduction" + }, + "TermsOfDelivery": { + "type": "string", + "description": "TermsOfDelivery" + }, + "TermsOfPayment": { + "type": "string", + "description": "TermsOfPayment" + }, + "TimeBasisReference": { + "type": "integer", + "format": "int32", + "description": "TimeBasisReference" + }, + "Total": { + "type": "integer", + "format": "int32", + "description": "Total" + }, + "TotalToPay": { + "type": "integer", + "format": "int32", + "description": "TotalToPay" + }, + "TotalVAT": { + "type": "integer", + "format": "int32", + "description": "TotalVAT" + }, + "VATIncluded": { + "type": "boolean", + "description": "VATIncluded" + }, + "VoucherNumber": { + "type": "integer", + "format": "int32", + "description": "VoucherNumber" + }, + "VoucherSeries": { + "type": "string", + "description": "VoucherSeries" + }, + "VoucherYear": { + "type": "integer", + "format": "int32", + "description": "VoucherYear" + }, + "WayOfDelivery": { + "type": "string", + "description": "WayOfDelivery" + }, + "YourOrderNumber": { + "type": "string", + "description": "YourOrderNumber" + }, + "YourReference": { + "type": "string", + "description": "YourReference" + }, + "ZipCode": { + "type": "string", + "description": "ZipCode" + }, + "AccountingMethod": { + "type": "string", + "description": "Accounting Method", + "title": "AccountingMethod", + "x-ms-visibility": "advanced" + }, + "TaxReductionType": { + "type": "string", + "description": "TaxReductionType" + }, + "FinalPayDate": { + "type": "string", + "description": "FinalPayDate" + } + }, + "description": "Invoice" + } + } + }, + "headers": { + "Content-Type": { + "description": "Content-Type", + "type": "string" + }, + "Accept": { + "description": "Accept", + "type": "string" + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "properties": { + "ErrorInformation": { + "type": "object", + "properties": { + "Code": { + "type": "integer", + "format": "int32", + "description": "Code", + "title": "Code", + "x-ms-visibility": "important" + }, + "Error": { + "type": "integer", + "format": "int32", + "description": "Error", + "title": "Code", + "x-ms-visibility": "important" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "Message", + "x-ms-visibility": "important" + } + }, + "description": "ErrorInformation" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Create an invoice", + "description": "An endpoint for creating an invoice. While it is possible to create an\n invoice without rows, we encourage you to add them if you can.", + "operationId": "CreateInvoice", + "x-ms-visibility": "important", + "parameters": [ + { + "name": "Invoice", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "Invoice": { + "type": "object", + "properties": { + "AdministrationFee": { + "type": "integer", + "format": "int32", + "title": "Administration Fee", + "x-ms-visibility": "advanced" + }, + "Address1": { + "type": "string", + "title": "Address1", + "x-ms-visibility": "advanced", + "description": "" + }, + "Address2": { + "type": "string", + "title": "Address2", + "x-ms-visibility": "advanced" + }, + "City": { + "type": "string", + "title": "City", + "x-ms-visibility": "advanced" + }, + "Comments": { + "type": "string", + "title": "Comments", + "x-ms-visibility": "advanced" + }, + "Country": { + "type": "string", + "title": "Country", + "x-ms-visibility": "advanced" + }, + "CostCenter": { + "type": "string", + "title": "CostCenter", + "x-ms-visibility": "advanced" + }, + "CreditInvoiceReference": { + "type": "string", + "title": "Credit Invoice Reference", + "x-ms-visibility": "advanced" + }, + "Currency": { + "type": "string", + "title": "Currency", + "x-ms-visibility": "advanced" + }, + "CurrencyRate": { + "type": "integer", + "format": "int32", + "title": "Currency Rate", + "x-ms-visibility": "advanced" + }, + "CurrencyUnit": { + "type": "integer", + "format": "int32", + "title": "Currency Unit", + "x-ms-visibility": "advanced" + }, + "CustomerName": { + "type": "string", + "title": "Customer Name", + "x-ms-visibility": "advanced" + }, + "CustomerNumber": { + "type": "string", + "title": "Customer Number", + "x-ms-visibility": "important" + }, + "DeliveryAddress1": { + "type": "string", + "title": "Delivery Address1", + "x-ms-visibility": "advanced" + }, + "DeliveryAddress2": { + "type": "string", + "title": "Delivery Address2", + "x-ms-visibility": "advanced" + }, + "DeliveryCity": { + "type": "string", + "title": "Delivery City", + "x-ms-visibility": "advanced" + }, + "DeliveryCountry": { + "type": "string", + "title": "Delivery Country", + "x-ms-visibility": "advanced" + }, + "DeliveryDate": { + "type": "string", + "title": "Delivery Date", + "x-ms-visibility": "advanced" + }, + "DeliveryName": { + "type": "string", + "title": "Delivery Name", + "x-ms-visibility": "advanced" + }, + "DeliveryZipCode": { + "type": "string", + "title": "Delivery Zip Code", + "x-ms-visibility": "advanced" + }, + "DocumentNumber": { + "type": "string", + "title": "Document Number", + "x-ms-visibility": "advanced" + }, + "DueDate": { + "type": "string", + "title": "DueDate", + "x-ms-visibility": "advanced" + }, + "EDIInformation": { + "type": "object", + "properties": { + "EDIGlobalLocationNumber": { + "type": "string", + "title": "EDI Global Location Number", + "x-ms-visibility": "advanced" + }, + "EDIGlobalLocationNumberDelivery": { + "type": "string", + "title": "EDI Global Location Number Delivery", + "x-ms-visibility": "advanced" + }, + "EDIInvoiceExtra1": { + "type": "string", + "title": "EDI Invoice Extra1", + "x-ms-visibility": "advanced" + }, + "EDIInvoiceExtra2": { + "type": "string", + "title": "EDI Invoice Extra2", + "x-ms-visibility": "advanced" + }, + "EDIOurElectronicReference": { + "type": "string", + "title": "EDI Our Electronic Reference", + "x-ms-visibility": "advanced" + }, + "EDIYourElectronicReference": { + "type": "string", + "title": "EDI Your Electronic Reference", + "x-ms-visibility": "advanced" + } + }, + "title": "EDI Information", + "x-ms-visibility": "advanced" + }, + "EmailInformation": { + "type": "object", + "properties": { + "EmailAddressFrom": { + "type": "string", + "title": "Email Address From", + "x-ms-visibility": "advanced" + }, + "EmailAddressTo": { + "type": "string", + "title": "Email Address To" + }, + "EmailAddressCC": { + "type": "string", + "title": "Email Address CC", + "x-ms-visibility": "advanced" + }, + "EmailAddressBCC": { + "type": "string", + "title": "Email Address BCC", + "x-ms-visibility": "advanced" + }, + "EmailSubject": { + "type": "string", + "title": "Email Subject", + "x-ms-visibility": "advanced" + }, + "EmailBody": { + "type": "string", + "title": "Email Body", + "x-ms-visibility": "advanced" + } + }, + "title": "Email Information", + "x-ms-visibility": "advanced" + }, + "EUQuarterlyReport": { + "type": "boolean", + "title": "EU Quarterly Report", + "x-ms-visibility": "advanced" + }, + "ExternalInvoiceReference1": { + "type": "string", + "title": "External Invoice Reference1", + "x-ms-visibility": "advanced" + }, + "ExternalInvoiceReference2": { + "type": "string", + "title": "External Invoice Reference2", + "x-ms-visibility": "advanced" + }, + "Freight": { + "type": "integer", + "format": "int32", + "title": "Freight", + "x-ms-visibility": "advanced" + }, + "InvoiceDate": { + "type": "string", + "title": "Invoice Date", + "x-ms-visibility": "advanced" + }, + "InvoiceRows": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AccountNumber": { + "type": "integer", + "format": "int32", + "title": "Account Number", + "x-ms-visibility": "advanced" + }, + "ArticleNumber": { + "type": "string", + "title": "Article Number", + "x-ms-visibility": "advanced" + }, + "CostCenter": { + "type": "string", + "title": "Cost Center", + "x-ms-visibility": "advanced" + }, + "DeliveredQuantity": { + "type": "string", + "title": "Delivered Quantity" + }, + "Description": { + "type": "string", + "title": "Description", + "x-ms-visibility": "important" + }, + "Discount": { + "type": "integer", + "format": "int32", + "title": "Discount", + "x-ms-visibility": "advanced" + }, + "DiscountType": { + "type": "string", + "title": "Discount Type" + }, + "HouseWork": { + "type": "boolean", + "title": "HouseWork", + "x-ms-visibility": "advanced" + }, + "HouseWorkHoursToReport": { + "type": "integer", + "format": "int32", + "title": "House Work Hours To Report", + "x-ms-visibility": "advanced" + }, + "HouseWorkType": { + "type": "string", + "title": "House Work Type", + "x-ms-visibility": "advanced" + }, + "Price": { + "type": "integer", + "format": "int32", + "title": "Price", + "x-ms-visibility": "important" + }, + "Project": { + "type": "string", + "title": "Project", + "x-ms-visibility": "advanced" + }, + "RowId": { + "type": "integer", + "format": "int32", + "title": "RowId", + "x-ms-visibility": "advanced" + }, + "StockPointCode": { + "type": "string", + "title": "Stock Point Code" + }, + "Unit": { + "type": "string", + "title": "Unit", + "x-ms-visibility": "advanced" + }, + "VAT": { + "type": "integer", + "format": "int32", + "title": "VAT", + "x-ms-visibility": "advanced" + } + } + }, + "title": "Invoice Rows" + }, + "InvoiceType": { + "type": "string", + "title": "Invoice Type", + "x-ms-visibility": "advanced" + }, + "Labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "integer", + "format": "int32", + "title": "Id", + "x-ms-visibility": "advanced" + } + } + }, + "title": "Labels", + "x-ms-visibility": "advanced" + }, + "Language": { + "type": "string", + "title": "Language", + "x-ms-visibility": "advanced" + }, + "NotCompleted": { + "type": "boolean", + "title": "Not Completed", + "x-ms-visibility": "advanced" + }, + "OCR": { + "type": "string", + "title": "OCR", + "x-ms-visibility": "advanced" + }, + "OurReference": { + "type": "string", + "title": "Our Reference", + "x-ms-visibility": "advanced" + }, + "PaymentWay": { + "type": "string", + "title": "Payment Way", + "x-ms-visibility": "advanced" + }, + "Phone1": { + "type": "string", + "title": "Phone1", + "x-ms-visibility": "advanced" + }, + "Phone2": { + "type": "string", + "title": "Phone2", + "x-ms-visibility": "advanced" + }, + "PriceList": { + "type": "string", + "title": "Price List", + "x-ms-visibility": "advanced" + }, + "PrintTemplate": { + "type": "string", + "title": "Print Template", + "x-ms-visibility": "advanced" + }, + "Project": { + "type": "string", + "title": "Project", + "x-ms-visibility": "advanced" + }, + "OutboundDate": { + "type": "string", + "title": "Outbound Date", + "x-ms-visibility": "advanced" + }, + "Remarks": { + "type": "string", + "title": "Remarks", + "x-ms-visibility": "advanced" + }, + "TermsOfDelivery": { + "type": "string", + "title": "Terms Of Delivery", + "x-ms-visibility": "advanced" + }, + "TermsOfPayment": { + "type": "string", + "title": "Terms Of Payment", + "x-ms-visibility": "advanced" + }, + "VATIncluded": { + "type": "boolean", + "title": "VAT Included", + "x-ms-visibility": "advanced" + }, + "WayOfDelivery": { + "type": "string", + "title": "Way Of Delivery", + "x-ms-visibility": "advanced" + }, + "YourOrderNumber": { + "type": "string", + "title": "Your Order Number", + "x-ms-visibility": "advanced" + }, + "YourReference": { + "type": "string", + "title": "Your Reference", + "x-ms-visibility": "advanced" + }, + "ZipCode": { + "type": "string", + "title": "Zip Code", + "x-ms-visibility": "advanced" + }, + "TaxReductionType": { + "type": "string", + "title": "Tax Reduction Type", + "x-ms-visibility": "advanced" + } + }, + "title": "Invoice", + "required": ["CustomerNumber"] + } + }, + "x-ms-visibility": "important", + "required": ["Invoice"] + }, + "x-ms-visibility": "important" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal" + } + ] + } + }, + "/invoices/": { + "get": { + "tags": ["Invoices"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "MetaInformation": { + "type": "object", + "properties": { + "@TotalResources": { + "type": "integer", + "format": "int32", + "description": "@TotalResources", + "title": "", + "x-ms-visibility": "advanced" + }, + "@TotalPages": { + "type": "integer", + "format": "int32", + "description": "@TotalPages", + "title": "", + "x-ms-visibility": "advanced" + }, + "@CurrentPage": { + "type": "integer", + "format": "int32", + "description": "@CurrentPage", + "title": "", + "x-ms-visibility": "advanced" + } + }, + "description": "MetaInformation" + }, + "Invoices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url", + "title": "", + "x-ms-visibility": "important" + }, + "Balance": { + "type": "integer", + "format": "int32", + "description": "Balance", + "x-ms-visibility": "important" + }, + "Booked": { + "type": "boolean", + "description": "Booked", + "x-ms-visibility": "important" + }, + "Cancelled": { + "type": "boolean", + "description": "Cancelled", + "x-ms-visibility": "important" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter", + "x-ms-visibility": "advanced" + }, + "Currency": { + "type": "string", + "description": "Currency", + "x-ms-visibility": "advanced" + }, + "CurrencyRate": { + "type": "string", + "description": "CurrencyRate", + "x-ms-visibility": "advanced" + }, + "CurrencyUnit": { + "type": "integer", + "format": "int32", + "description": "CurrencyUnit", + "x-ms-visibility": "advanced" + }, + "CustomerName": { + "type": "string", + "description": "CustomerName", + "x-ms-visibility": "important" + }, + "CustomerNumber": { + "type": "string", + "description": "CustomerNumber", + "x-ms-visibility": "important" + }, + "DocumentNumber": { + "type": "string", + "description": "DocumentNumber", + "x-ms-visibility": "important" + }, + "DueDate": { + "type": "string", + "description": "DueDate", + "x-ms-visibility": "important" + }, + "ExternalInvoiceReference1": { + "type": "string", + "description": "ExternalInvoiceReference1", + "x-ms-visibility": "advanced" + }, + "ExternalInvoiceReference2": { + "type": "string", + "description": "ExternalInvoiceReference2", + "x-ms-visibility": "advanced" + }, + "InvoiceDate": { + "type": "string", + "description": "InvoiceDate", + "x-ms-visibility": "important" + }, + "InvoiceType": { + "type": "string", + "description": "InvoiceType", + "x-ms-visibility": "advanced" + }, + "NoxFinans": { + "type": "boolean", + "description": "NoxFinans", + "x-ms-visibility": "advanced" + }, + "OCR": { + "type": "string", + "description": "OCR", + "x-ms-visibility": "advanced" + }, + "VoucherNumber": { + "type": "integer", + "format": "int32", + "description": "VoucherNumber", + "x-ms-visibility": "advanced", + "title": "" + }, + "VoucherSeries": { + "type": "string", + "description": "VoucherSeries", + "x-ms-visibility": "advanced" + }, + "VoucherYear": { + "type": "integer", + "format": "int32", + "description": "VoucherYear", + "x-ms-visibility": "advanced", + "title": "" + }, + "WayOfDelivery": { + "type": "string", + "description": "WayOfDelivery", + "x-ms-visibility": "advanced" + }, + "TermsOfPayment": { + "type": "string", + "description": "TermsOfPayment", + "x-ms-visibility": "advanced" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "Sent": { + "type": "boolean", + "description": "Sent", + "x-ms-visibility": "important" + }, + "Total": { + "type": "integer", + "format": "int32", + "description": "Total", + "x-ms-visibility": "important" + }, + "FinalPayDate": { + "type": "string", + "description": "FinalPayDate", + "x-ms-visibility": "advanced" + } + } + }, + "description": "Invoices" + } + } + } + } + }, + "summary": "Retrieve a list of invoices", + "description": "Retrieve a list of invoices", + "operationId": "GetAllInvoices", + "x-ms-visibility": "important", + "parameters": [ + { + "name": "filter", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "cancelled", + "fullypaid", + "unpaid", + "unpaidoverdue", + "unbooked" + ], + "x-ms-visibility": "advanced", + "description": "Filter the invoices by status. Possible values are: cancelled, fullypaid, unpaid, unpaidoverdue, unbooked.", + "x-ms-summary": "Filter" + }, + { + "name": "sortby", + "in": "query", + "required": false, + "type": "string", + "x-ms-visibility": "advanced", + "description": "Sort the invoices by a specific field. Possible values are: DocumentNumber, InvoiceDate, DueDate, CustomerName, Balance, Total.", + "x-ms-summary": "Sort" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "x-ms-visibility": "advanced", + "format": "int32", + "default": 500, + "x-ms-summary": "Limit", + "description": "Limit the number of invoices returned. Default is 500." + }, + { + "name": "offset", + "in": "query", + "required": false, + "type": "integer", + "x-ms-visibility": "advanced", + "format": "int32", + "x-ms-summary": "Offset", + "description": "Offset the invoices returned. Default is 0." + }, + { + "name": "page", + "in": "query", + "required": false, + "type": "integer", + "x-ms-visibility": "advanced", + "x-ms-summary": "Page", + "description": "Page number to retrieve. Default is 1." + }, + { + "name": "customernumber", + "in": "query", + "required": false, + "type": "string", + "x-ms-visibility": "important", + "x-ms-summary": "Customer number", + "description": "Unique identifier for the customer associated with the invoice." + }, + { + "name": "lastmodified", + "in": "query", + "required": false, + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Last modified", + "description": "Retrieves all records since the provided timestamp." + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Content-Type", + "x-ms-summary": "Content-Type" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Accept", + "x-ms-summary": "Accept" + } + ] + } + }, + "/invoices/{DocumentNumber}/preview": { + "get": { + "tags": ["Invoices"], + "responses": { + "200": { + "description": "OK", + "schema": { + "description": "Returns an invoice in PDF format", + "title": "PDF", + "type": "file" + }, + "headers": { + "Content-Type": { + "type": "string", + "default": "application/pdf", + "x-ms-visibility": "internal", + "description": "Content-Type", + "x-ms-summary": "Content-Type" + } + } + } + }, + "summary": "Preview an invoice", + "description": "Preview an invoice", + "operationId": "PreviewInvoice", + "x-ms-visibility": "advanced", + "parameters": [ + { + "name": "DocumentNumber", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "Invoice document number", + "description": "Specifies the document number of the invoice to preview", + "x-ms-url-encoding": "single" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal" + } + ] + } + }, + "/invoices/{DocumentNumber}/cancel": { + "put": { + "tags": ["Invoices"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "Invoice": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url" + }, + "@urlTaxReductionList": { + "type": "string", + "description": "@urlTaxReductionList" + }, + "AdministrationFee": { + "type": "integer", + "format": "int32", + "description": "AdministrationFee" + }, + "AdministrationFeeVAT": { + "type": "integer", + "format": "int32", + "description": "AdministrationFeeVAT" + }, + "Address1": { + "type": "string", + "description": "Address1" + }, + "Address2": { + "type": "string", + "description": "Address2" + }, + "Balance": { + "type": "integer", + "format": "int32", + "description": "Balance" + }, + "BasisTaxReduction": { + "type": "integer", + "format": "int32", + "description": "BasisTaxReduction" + }, + "Booked": { + "type": "boolean", + "description": "Booked" + }, + "Cancelled": { + "type": "boolean", + "description": "Cancelled" + }, + "City": { + "type": "string", + "description": "City" + }, + "Comments": { + "type": "string", + "description": "Comments" + }, + "ContractReference": { + "type": "integer", + "format": "int32", + "description": "ContractReference" + }, + "ContributionPercent": { + "type": "integer", + "format": "int32", + "description": "ContributionPercent" + }, + "ContributionValue": { + "type": "integer", + "format": "int32", + "description": "ContributionValue" + }, + "Country": { + "type": "string", + "description": "Country" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter" + }, + "Credit": { + "type": "string", + "description": "Credit" + }, + "CreditInvoiceReference": { + "type": "string", + "description": "CreditInvoiceReference" + }, + "Currency": { + "type": "string", + "description": "Currency" + }, + "CurrencyRate": { + "type": "integer", + "format": "int32", + "description": "CurrencyRate" + }, + "CurrencyUnit": { + "type": "integer", + "format": "int32", + "description": "CurrencyUnit" + }, + "CustomerName": { + "type": "string", + "description": "CustomerName" + }, + "CustomerNumber": { + "type": "string", + "description": "CustomerNumber" + }, + "DeliveryAddress1": { + "type": "string", + "description": "DeliveryAddress1" + }, + "DeliveryAddress2": { + "type": "string", + "description": "DeliveryAddress2" + }, + "DeliveryCity": { + "type": "string", + "description": "DeliveryCity" + }, + "DeliveryCountry": { + "type": "string", + "description": "DeliveryCountry" + }, + "DeliveryDate": { + "type": "string", + "description": "DeliveryDate" + }, + "DeliveryName": { + "type": "string", + "description": "DeliveryName" + }, + "DeliveryZipCode": { + "type": "string", + "description": "DeliveryZipCode" + }, + "DocumentNumber": { + "type": "string", + "description": "DocumentNumber" + }, + "DueDate": { + "type": "string", + "description": "DueDate" + }, + "EDIInformation": { + "type": "object", + "properties": { + "EDIGlobalLocationNumber": { + "type": "string", + "description": "EDIGlobalLocationNumber" + }, + "EDIGlobalLocationNumberDelivery": { + "type": "string", + "description": "EDIGlobalLocationNumberDelivery" + }, + "EDIInvoiceExtra1": { + "type": "string", + "description": "EDIInvoiceExtra1" + }, + "EDIInvoiceExtra2": { + "type": "string", + "description": "EDIInvoiceExtra2" + }, + "EDIOurElectronicReference": { + "type": "string", + "description": "EDIOurElectronicReference" + }, + "EDIYourElectronicReference": { + "type": "string", + "description": "EDIYourElectronicReference" + }, + "EDIStatus": { + "type": "string", + "description": "EDIStatus" + } + }, + "description": "EDIInformation" + }, + "EmailInformation": { + "type": "object", + "properties": { + "EmailAddressFrom": { + "type": "string", + "description": "EmailAddressFrom" + }, + "EmailAddressTo": { + "type": "string", + "description": "EmailAddressTo" + }, + "EmailAddressCC": { + "type": "string", + "description": "EmailAddressCC" + }, + "EmailAddressBCC": { + "type": "string", + "description": "EmailAddressBCC" + }, + "EmailSubject": { + "type": "string", + "description": "EmailSubject" + }, + "EmailBody": { + "type": "string", + "description": "EmailBody" + } + }, + "description": "EmailInformation" + }, + "EUQuarterlyReport": { + "type": "boolean", + "description": "EUQuarterlyReport" + }, + "ExternalInvoiceReference1": { + "type": "string", + "description": "ExternalInvoiceReference1" + }, + "ExternalInvoiceReference2": { + "type": "string", + "description": "ExternalInvoiceReference2" + }, + "Freight": { + "type": "integer", + "format": "int32", + "description": "Freight" + }, + "FreightVAT": { + "type": "integer", + "format": "int32", + "description": "FreightVAT" + }, + "Gross": { + "type": "integer", + "format": "int32", + "description": "Gross" + }, + "HouseWork": { + "type": "boolean", + "description": "HouseWork" + }, + "InvoiceDate": { + "type": "string", + "description": "InvoiceDate" + }, + "InvoicePeriodStart": { + "type": "string", + "description": "InvoicePeriodStart" + }, + "InvoicePeriodEnd": { + "type": "string", + "description": "InvoicePeriodEnd" + }, + "InvoicePeriodReference": { + "type": "string", + "description": "InvoicePeriodReference" + }, + "InvoiceRows": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AccountNumber": { + "type": "integer", + "format": "int32", + "description": "AccountNumber" + }, + "ArticleNumber": { + "type": "string", + "description": "ArticleNumber" + }, + "ContributionPercent": { + "type": "string", + "description": "ContributionPercent" + }, + "ContributionValue": { + "type": "string", + "description": "ContributionValue" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter" + }, + "DeliveredQuantity": { + "type": "string", + "description": "DeliveredQuantity" + }, + "Description": { + "type": "string", + "description": "Description" + }, + "Discount": { + "type": "integer", + "format": "int32", + "description": "Discount" + }, + "DiscountType": { + "type": "string", + "description": "DiscountType" + }, + "HouseWork": { + "type": "boolean", + "description": "HouseWork" + }, + "HouseWorkHoursToReport": { + "type": "integer", + "format": "int32", + "description": "HouseWorkHoursToReport" + }, + "HouseWorkType": { + "type": "string", + "description": "HouseWorkType" + }, + "Price": { + "type": "integer", + "format": "int32", + "description": "Price" + }, + "PriceExcludingVAT": { + "type": "integer", + "format": "int32", + "description": "PriceExcludingVAT" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "RowId": { + "type": "integer", + "format": "int32", + "description": "RowId" + }, + "StockPointCode": { + "type": "string", + "description": "StockPointCode" + }, + "Total": { + "type": "integer", + "format": "int32", + "description": "Total" + }, + "TotalExcludingVAT": { + "type": "integer", + "format": "int32", + "description": "TotalExcludingVAT" + }, + "Unit": { + "type": "string", + "description": "Unit" + }, + "VAT": { + "type": "integer", + "format": "int32", + "description": "VAT" + } + } + }, + "description": "InvoiceRows" + }, + "InvoiceType": { + "type": "string", + "description": "InvoiceType" + }, + "Labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "integer", + "format": "int32", + "description": "Id" + } + } + }, + "description": "Labels" + }, + "Language": { + "type": "string", + "description": "Language" + }, + "LastRemindDate": { + "type": "string", + "description": "LastRemindDate" + }, + "Net": { + "type": "integer", + "format": "int32", + "description": "Net" + }, + "NotCompleted": { + "type": "boolean", + "description": "NotCompleted" + }, + "NoxFinans": { + "type": "boolean", + "description": "NoxFinans" + }, + "OCR": { + "type": "string", + "description": "OCR" + }, + "OfferReference": { + "type": "string", + "description": "OfferReference" + }, + "OrderReference": { + "type": "string", + "description": "OrderReference" + }, + "OrganisationNumber": { + "type": "string", + "description": "OrganisationNumber" + }, + "OurReference": { + "type": "string", + "description": "OurReference" + }, + "PaymentWay": { + "type": "string", + "description": "PaymentWay" + }, + "Phone1": { + "type": "string", + "description": "Phone1" + }, + "Phone2": { + "type": "string", + "description": "Phone2" + }, + "PriceList": { + "type": "string", + "description": "PriceList" + }, + "PrintTemplate": { + "type": "string", + "description": "PrintTemplate" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "WarehouseReady": { + "type": "boolean", + "description": "WarehouseReady" + }, + "OutboundDate": { + "type": "string", + "description": "OutboundDate" + }, + "Remarks": { + "type": "string", + "description": "Remarks" + }, + "Reminders": { + "type": "integer", + "format": "int32", + "description": "Reminders" + }, + "RoundOff": { + "type": "integer", + "format": "int32", + "description": "RoundOff" + }, + "Sent": { + "type": "boolean", + "description": "Sent" + }, + "TaxReduction": { + "type": "integer", + "format": "int32", + "description": "TaxReduction" + }, + "TermsOfDelivery": { + "type": "string", + "description": "TermsOfDelivery" + }, + "TermsOfPayment": { + "type": "string", + "description": "TermsOfPayment" + }, + "TimeBasisReference": { + "type": "integer", + "format": "int32", + "description": "TimeBasisReference" + }, + "Total": { + "type": "integer", + "format": "int32", + "description": "Total" + }, + "TotalToPay": { + "type": "integer", + "format": "int32", + "description": "TotalToPay" + }, + "TotalVAT": { + "type": "integer", + "format": "int32", + "description": "TotalVAT" + }, + "VATIncluded": { + "type": "boolean", + "description": "VATIncluded" + }, + "VoucherNumber": { + "type": "integer", + "format": "int32", + "description": "VoucherNumber" + }, + "VoucherSeries": { + "type": "string", + "description": "VoucherSeries" + }, + "VoucherYear": { + "type": "integer", + "format": "int32", + "description": "VoucherYear" + }, + "WayOfDelivery": { + "type": "string", + "description": "WayOfDelivery" + }, + "YourOrderNumber": { + "type": "string", + "description": "YourOrderNumber" + }, + "YourReference": { + "type": "string", + "description": "YourReference" + }, + "ZipCode": { + "type": "string", + "description": "ZipCode" + }, + "AccountingMethod": { + "type": "string", + "description": "AccountingMethod" + }, + "TaxReductionType": { + "type": "string", + "description": "TaxReductionType" + }, + "FinalPayDate": { + "type": "string", + "description": "FinalPayDate" + } + } + } + } + } + } + }, + "summary": "Cancel an invoice", + "description": "Cancel an invoice", + "operationId": "CancelInvoice", + "x-ms-visibility": "advanced", + "parameters": [ + { + "name": "DocumentNumber", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "Invoice document number", + "description": "Specifies the document number of the invoice to be cancelled", + "x-ms-visibility": "important", + "x-ms-url-encoding": "single" + }, + { + "name": "Invoice", + "in": "body", + "required": false, + "schema": { + "type": "object", + "properties": { + "Invoice": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url" + }, + "@urlTaxReductionList": { + "type": "string", + "description": "@urlTaxReductionList" + }, + "AdministrationFee": { + "type": "integer", + "format": "int32", + "description": "AdministrationFee" + }, + "AdministrationFeeVAT": { + "type": "integer", + "format": "int32", + "description": "AdministrationFeeVAT" + }, + "Address1": { + "type": "string", + "description": "Address1" + }, + "Address2": { + "type": "string", + "description": "Address2" + }, + "Balance": { + "type": "integer", + "format": "int32", + "description": "Balance" + }, + "BasisTaxReduction": { + "type": "integer", + "format": "int32", + "description": "BasisTaxReduction" + }, + "Booked": { + "type": "boolean", + "description": "Booked" + }, + "Cancelled": { + "type": "boolean", + "description": "Cancelled" + }, + "City": { + "type": "string", + "description": "City" + }, + "Comments": { + "type": "string", + "description": "Comments" + }, + "ContractReference": { + "type": "integer", + "format": "int32", + "description": "ContractReference" + }, + "ContributionPercent": { + "type": "integer", + "format": "int32", + "description": "ContributionPercent" + }, + "ContributionValue": { + "type": "integer", + "format": "int32", + "description": "ContributionValue" + }, + "Country": { + "type": "string", + "description": "Country" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter" + }, + "Credit": { + "type": "string", + "description": "Credit" + }, + "CreditInvoiceReference": { + "type": "string", + "description": "CreditInvoiceReference" + }, + "Currency": { + "type": "string", + "description": "Currency" + }, + "CurrencyRate": { + "type": "integer", + "format": "int32", + "description": "CurrencyRate" + }, + "CurrencyUnit": { + "type": "integer", + "format": "int32", + "description": "CurrencyUnit" + }, + "CustomerName": { + "type": "string", + "description": "CustomerName" + }, + "CustomerNumber": { + "type": "string", + "description": "CustomerNumber" + }, + "DeliveryAddress1": { + "type": "string", + "description": "DeliveryAddress1" + }, + "DeliveryAddress2": { + "type": "string", + "description": "DeliveryAddress2" + }, + "DeliveryCity": { + "type": "string", + "description": "DeliveryCity" + }, + "DeliveryCountry": { + "type": "string", + "description": "DeliveryCountry" + }, + "DeliveryDate": { + "type": "string", + "description": "DeliveryDate" + }, + "DeliveryName": { + "type": "string", + "description": "DeliveryName" + }, + "DeliveryZipCode": { + "type": "string", + "description": "DeliveryZipCode" + }, + "DocumentNumber": { + "type": "string", + "description": "DocumentNumber" + }, + "DueDate": { + "type": "string", + "description": "DueDate" + }, + "EDIInformation": { + "type": "object", + "properties": { + "EDIGlobalLocationNumber": { + "type": "string", + "description": "EDIGlobalLocationNumber" + }, + "EDIGlobalLocationNumberDelivery": { + "type": "string", + "description": "EDIGlobalLocationNumberDelivery" + }, + "EDIInvoiceExtra1": { + "type": "string", + "description": "EDIInvoiceExtra1" + }, + "EDIInvoiceExtra2": { + "type": "string", + "description": "EDIInvoiceExtra2" + }, + "EDIOurElectronicReference": { + "type": "string", + "description": "EDIOurElectronicReference" + }, + "EDIYourElectronicReference": { + "type": "string", + "description": "EDIYourElectronicReference" + }, + "EDIStatus": { + "type": "string", + "description": "EDIStatus" + } + }, + "description": "EDIInformation" + }, + "EmailInformation": { + "type": "object", + "properties": { + "EmailAddressFrom": { + "type": "string", + "description": "EmailAddressFrom" + }, + "EmailAddressTo": { + "type": "string", + "description": "EmailAddressTo" + }, + "EmailAddressCC": { + "type": "string", + "description": "EmailAddressCC" + }, + "EmailAddressBCC": { + "type": "string", + "description": "EmailAddressBCC" + }, + "EmailSubject": { + "type": "string", + "description": "EmailSubject" + }, + "EmailBody": { + "type": "string", + "description": "EmailBody" + } + }, + "description": "EmailInformation" + }, + "EUQuarterlyReport": { + "type": "boolean", + "description": "EUQuarterlyReport" + }, + "ExternalInvoiceReference1": { + "type": "string", + "description": "ExternalInvoiceReference1" + }, + "ExternalInvoiceReference2": { + "type": "string", + "description": "ExternalInvoiceReference2" + }, + "Freight": { + "type": "integer", + "format": "int32", + "description": "Freight" + }, + "FreightVAT": { + "type": "integer", + "format": "int32", + "description": "FreightVAT" + }, + "Gross": { + "type": "integer", + "format": "int32", + "description": "Gross" + }, + "HouseWork": { + "type": "boolean", + "description": "HouseWork" + }, + "InvoiceDate": { + "type": "string", + "description": "InvoiceDate" + }, + "InvoicePeriodStart": { + "type": "string", + "description": "InvoicePeriodStart" + }, + "InvoicePeriodEnd": { + "type": "string", + "description": "InvoicePeriodEnd" + }, + "InvoicePeriodReference": { + "type": "string", + "description": "InvoicePeriodReference" + }, + "InvoiceRows": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AccountNumber": { + "type": "integer", + "format": "int32", + "description": "AccountNumber" + }, + "ArticleNumber": { + "type": "string", + "description": "ArticleNumber" + }, + "ContributionPercent": { + "type": "string", + "description": "ContributionPercent" + }, + "ContributionValue": { + "type": "string", + "description": "ContributionValue" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter" + }, + "DeliveredQuantity": { + "type": "string", + "description": "DeliveredQuantity" + }, + "Description": { + "type": "string", + "description": "Description" + }, + "Discount": { + "type": "integer", + "format": "int32", + "description": "Discount" + }, + "DiscountType": { + "type": "string", + "description": "DiscountType" + }, + "HouseWork": { + "type": "boolean", + "description": "HouseWork" + }, + "HouseWorkHoursToReport": { + "type": "integer", + "format": "int32", + "description": "HouseWorkHoursToReport" + }, + "HouseWorkType": { + "type": "string", + "description": "HouseWorkType" + }, + "Price": { + "type": "integer", + "format": "int32", + "description": "Price" + }, + "PriceExcludingVAT": { + "type": "integer", + "format": "int32", + "description": "PriceExcludingVAT" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "RowId": { + "type": "integer", + "format": "int32", + "description": "RowId" + }, + "StockPointCode": { + "type": "string", + "description": "StockPointCode" + }, + "Total": { + "type": "integer", + "format": "int32", + "description": "Total" + }, + "TotalExcludingVAT": { + "type": "integer", + "format": "int32", + "description": "TotalExcludingVAT" + }, + "Unit": { + "type": "string", + "description": "Unit" + }, + "VAT": { + "type": "integer", + "format": "int32", + "description": "VAT" + } + } + }, + "description": "InvoiceRows" + }, + "InvoiceType": { + "type": "string", + "description": "InvoiceType" + }, + "Labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "integer", + "format": "int32", + "description": "Id" + } + } + }, + "description": "Labels" + }, + "Language": { + "type": "string", + "description": "Language" + }, + "LastRemindDate": { + "type": "string", + "description": "LastRemindDate" + }, + "Net": { + "type": "integer", + "format": "int32", + "description": "Net" + }, + "NotCompleted": { + "type": "boolean", + "description": "NotCompleted" + }, + "NoxFinans": { + "type": "boolean", + "description": "NoxFinans" + }, + "OCR": { + "type": "string", + "description": "OCR" + }, + "OfferReference": { + "type": "string", + "description": "OfferReference" + }, + "OrderReference": { + "type": "string", + "description": "OrderReference" + }, + "OrganisationNumber": { + "type": "string", + "description": "OrganisationNumber" + }, + "OurReference": { + "type": "string", + "description": "OurReference" + }, + "PaymentWay": { + "type": "string", + "description": "PaymentWay" + }, + "Phone1": { + "type": "string", + "description": "Phone1" + }, + "Phone2": { + "type": "string", + "description": "Phone2" + }, + "PriceList": { + "type": "string", + "description": "PriceList" + }, + "PrintTemplate": { + "type": "string", + "description": "PrintTemplate" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "WarehouseReady": { + "type": "boolean", + "description": "WarehouseReady" + }, + "OutboundDate": { + "type": "string", + "description": "OutboundDate" + }, + "Remarks": { + "type": "string", + "description": "Remarks" + }, + "Reminders": { + "type": "integer", + "format": "int32", + "description": "Reminders" + }, + "RoundOff": { + "type": "integer", + "format": "int32", + "description": "RoundOff" + }, + "Sent": { + "type": "boolean", + "description": "Sent" + }, + "TaxReduction": { + "type": "integer", + "format": "int32", + "description": "TaxReduction" + }, + "TermsOfDelivery": { + "type": "string", + "description": "TermsOfDelivery" + }, + "TermsOfPayment": { + "type": "string", + "description": "TermsOfPayment" + }, + "TimeBasisReference": { + "type": "integer", + "format": "int32", + "description": "TimeBasisReference" + }, + "Total": { + "type": "integer", + "format": "int32", + "description": "Total" + }, + "TotalToPay": { + "type": "integer", + "format": "int32", + "description": "TotalToPay" + }, + "TotalVAT": { + "type": "integer", + "format": "int32", + "description": "TotalVAT" + }, + "VATIncluded": { + "type": "boolean", + "description": "VATIncluded" + }, + "VoucherNumber": { + "type": "integer", + "format": "int32", + "description": "VoucherNumber" + }, + "VoucherSeries": { + "type": "string", + "description": "VoucherSeries" + }, + "VoucherYear": { + "type": "integer", + "format": "int32", + "description": "VoucherYear" + }, + "WayOfDelivery": { + "type": "string", + "description": "WayOfDelivery" + }, + "YourOrderNumber": { + "type": "string", + "description": "YourOrderNumber" + }, + "YourReference": { + "type": "string", + "description": "YourReference" + }, + "ZipCode": { + "type": "string", + "description": "ZipCode" + }, + "AccountingMethod": { + "type": "string", + "description": "AccountingMethod" + }, + "TaxReductionType": { + "type": "string", + "description": "TaxReductionType" + }, + "FinalPayDate": { + "type": "string", + "description": "FinalPayDate" + } + } + } + } + } + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal" + } + ] + } + }, + "/companyinformation": { + "get": { + "tags": ["Company Information"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "CompanyInformation": { + "type": "object", + "properties": { + "Address": { + "type": "string", + "description": "Address" + }, + "City": { + "type": "string", + "description": "City" + }, + "CountryCode": { + "type": "string", + "description": "CountryCode" + }, + "DatabaseNumber": { + "type": "integer", + "format": "int32", + "description": "DatabaseNumber" + }, + "CompanyName": { + "type": "string", + "description": "CompanyName" + }, + "OrganizationNumber": { + "type": "string", + "description": "OrganizationNumber" + }, + "VisitAddress": { + "type": "string", + "description": "VisitAddress" + }, + "VisitCity": { + "type": "string", + "description": "VisitCity" + }, + "VisitCountryCode": { + "type": "string", + "description": "VisitCountryCode" + }, + "VisitZipCode": { + "type": "string", + "description": "VisitZipCode" + }, + "ZipCode": { + "type": "string", + "description": "ZipCode" + } + }, + "description": "CompanyInformation" + } + } + }, + "headers": { + "Content-Type": { + "description": "Content-Type", + "type": "string" + } + } + } + }, + "summary": "Company Information", + "description": "Company Information", + "operationId": "GetCompanyInformation", + "x-ms-visibility": "advanced", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-summary": "Content-Type", + "description": "Content-Type", + "x-ms-visibility": "internal" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Accept", + "x-ms-summary": "Accept" + } + ] + } + }, + "/invoices/{DocumentNumber}": { + "get": { + "tags": ["Invoices"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "Invoice": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url", + "title": "", + "x-ms-visibility": "internal" + }, + "@urlTaxReductionList": { + "type": "string", + "description": "@urlTaxReductionList" + }, + "AdministrationFee": { + "type": "integer", + "format": "int32", + "description": "AdministrationFee" + }, + "AdministrationFeeVAT": { + "type": "integer", + "format": "int32", + "description": "AdministrationFeeVAT" + }, + "Address1": { + "type": "string", + "description": "Address1" + }, + "Address2": { + "type": "string", + "description": "Address2" + }, + "Balance": { + "type": "integer", + "format": "int32", + "description": "Balance" + }, + "BasisTaxReduction": { + "type": "integer", + "format": "int32", + "description": "BasisTaxReduction" + }, + "Booked": { + "type": "boolean", + "description": "Booked" + }, + "Cancelled": { + "type": "boolean", + "description": "Cancelled" + }, + "City": { + "type": "string", + "description": "City" + }, + "Comments": { + "type": "string", + "description": "Comments" + }, + "ContractReference": { + "type": "integer", + "format": "int32", + "description": "ContractReference" + }, + "ContributionPercent": { + "type": "integer", + "format": "int32", + "description": "ContributionPercent" + }, + "ContributionValue": { + "type": "integer", + "format": "int32", + "description": "ContributionValue" + }, + "Country": { + "type": "string", + "description": "Country" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter" + }, + "Credit": { + "type": "string", + "description": "Credit" + }, + "CreditInvoiceReference": { + "type": "string", + "description": "CreditInvoiceReference" + }, + "Currency": { + "type": "string", + "description": "Currency" + }, + "CurrencyRate": { + "type": "integer", + "format": "int32", + "description": "CurrencyRate" + }, + "CurrencyUnit": { + "type": "integer", + "format": "int32", + "description": "CurrencyUnit" + }, + "CustomerName": { + "type": "string", + "description": "CustomerName" + }, + "CustomerNumber": { + "type": "string", + "description": "CustomerNumber" + }, + "DeliveryAddress1": { + "type": "string", + "description": "DeliveryAddress1" + }, + "DeliveryAddress2": { + "type": "string", + "description": "DeliveryAddress2" + }, + "DeliveryCity": { + "type": "string", + "description": "DeliveryCity" + }, + "DeliveryCountry": { + "type": "string", + "description": "DeliveryCountry" + }, + "DeliveryDate": { + "type": "string", + "description": "DeliveryDate" + }, + "DeliveryName": { + "type": "string", + "description": "DeliveryName" + }, + "DeliveryZipCode": { + "type": "string", + "description": "DeliveryZipCode" + }, + "DocumentNumber": { + "type": "string", + "description": "DocumentNumber" + }, + "DueDate": { + "type": "string", + "description": "DueDate" + }, + "EDIInformation": { + "type": "object", + "properties": { + "EDIGlobalLocationNumber": { + "type": "string", + "description": "EDIGlobalLocationNumber" + }, + "EDIGlobalLocationNumberDelivery": { + "type": "string", + "description": "EDIGlobalLocationNumberDelivery" + }, + "EDIInvoiceExtra1": { + "type": "string", + "description": "EDIInvoiceExtra1" + }, + "EDIInvoiceExtra2": { + "type": "string", + "description": "EDIInvoiceExtra2" + }, + "EDIOurElectronicReference": { + "type": "string", + "description": "EDIOurElectronicReference" + }, + "EDIYourElectronicReference": { + "type": "string", + "description": "EDIYourElectronicReference" + }, + "EDIStatus": { + "type": "string", + "description": "EDIStatus" + } + }, + "description": "EDIInformation" + }, + "EmailInformation": { + "type": "object", + "properties": { + "EmailAddressFrom": { + "type": "string", + "description": "EmailAddressFrom" + }, + "EmailAddressTo": { + "type": "string", + "description": "EmailAddressTo" + }, + "EmailAddressCC": { + "type": "string", + "description": "EmailAddressCC" + }, + "EmailAddressBCC": { + "type": "string", + "description": "EmailAddressBCC" + }, + "EmailSubject": { + "type": "string", + "description": "EmailSubject" + }, + "EmailBody": { + "type": "string", + "description": "EmailBody" + } + }, + "description": "EmailInformation" + }, + "EUQuarterlyReport": { + "type": "boolean", + "description": "EUQuarterlyReport" + }, + "ExternalInvoiceReference1": { + "type": "string", + "description": "ExternalInvoiceReference1" + }, + "ExternalInvoiceReference2": { + "type": "string", + "description": "ExternalInvoiceReference2" + }, + "Freight": { + "type": "integer", + "format": "int32", + "description": "Freight" + }, + "FreightVAT": { + "type": "integer", + "format": "int32", + "description": "FreightVAT" + }, + "Gross": { + "type": "integer", + "format": "int32", + "description": "Gross" + }, + "HouseWork": { + "type": "boolean", + "description": "HouseWork" + }, + "InvoiceDate": { + "type": "string", + "description": "InvoiceDate" + }, + "InvoicePeriodStart": { + "type": "string", + "description": "InvoicePeriodStart" + }, + "InvoicePeriodEnd": { + "type": "string", + "description": "InvoicePeriodEnd" + }, + "InvoicePeriodReference": { + "type": "string", + "description": "InvoicePeriodReference" + }, + "InvoiceRows": { + "type": "array", + "items": { + "type": "object", + "properties": { + "AccountNumber": { + "type": "integer", + "format": "int32", + "description": "AccountNumber" + }, + "ArticleNumber": { + "type": "string", + "description": "ArticleNumber" + }, + "ContributionPercent": { + "type": "string", + "description": "ContributionPercent" + }, + "ContributionValue": { + "type": "string", + "description": "ContributionValue" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter" + }, + "DeliveredQuantity": { + "type": "string", + "description": "DeliveredQuantity" + }, + "Description": { + "type": "string", + "description": "Description" + }, + "Discount": { + "type": "integer", + "format": "int32", + "description": "Discount" + }, + "DiscountType": { + "type": "string", + "description": "DiscountType" + }, + "HouseWork": { + "type": "boolean", + "description": "HouseWork" + }, + "HouseWorkHoursToReport": { + "type": "integer", + "format": "int32", + "description": "HouseWorkHoursToReport" + }, + "HouseWorkType": { + "type": "string", + "description": "HouseWorkType" + }, + "Price": { + "type": "integer", + "format": "int32", + "description": "Price" + }, + "PriceExcludingVAT": { + "type": "integer", + "format": "int32", + "description": "PriceExcludingVAT" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "RowId": { + "type": "integer", + "format": "int32", + "description": "RowId" + }, + "StockPointCode": { + "type": "string", + "description": "StockPointCode" + }, + "Total": { + "type": "integer", + "format": "int32", + "description": "Total" + }, + "TotalExcludingVAT": { + "type": "integer", + "format": "int32", + "description": "TotalExcludingVAT" + }, + "Unit": { + "type": "string", + "description": "Unit" + }, + "VAT": { + "type": "integer", + "format": "int32", + "description": "VAT" + } + } + }, + "description": "InvoiceRows" + }, + "InvoiceType": { + "type": "string", + "description": "InvoiceType" + }, + "Labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Id": { + "type": "integer", + "format": "int32", + "description": "Id" + } + } + }, + "description": "Labels" + }, + "Language": { + "type": "string", + "description": "Language" + }, + "LastRemindDate": { + "type": "string", + "description": "LastRemindDate" + }, + "Net": { + "type": "integer", + "format": "int32", + "description": "Net" + }, + "NotCompleted": { + "type": "boolean", + "description": "NotCompleted" + }, + "NoxFinans": { + "type": "boolean", + "description": "NoxFinans" + }, + "OCR": { + "type": "string", + "description": "OCR" + }, + "OfferReference": { + "type": "string", + "description": "OfferReference" + }, + "OrderReference": { + "type": "string", + "description": "OrderReference" + }, + "OrganisationNumber": { + "type": "string", + "description": "OrganisationNumber" + }, + "OurReference": { + "type": "string", + "description": "OurReference" + }, + "PaymentWay": { + "type": "string", + "description": "PaymentWay" + }, + "Phone1": { + "type": "string", + "description": "Phone1" + }, + "Phone2": { + "type": "string", + "description": "Phone2" + }, + "PriceList": { + "type": "string", + "description": "PriceList" + }, + "PrintTemplate": { + "type": "string", + "description": "PrintTemplate" + }, + "Project": { + "type": "string", + "description": "Project" + }, + "WarehouseReady": { + "type": "boolean", + "description": "WarehouseReady" + }, + "OutboundDate": { + "type": "string", + "description": "OutboundDate" + }, + "Remarks": { + "type": "string", + "description": "Remarks" + }, + "Reminders": { + "type": "integer", + "format": "int32", + "description": "Reminders" + }, + "RoundOff": { + "type": "integer", + "format": "int32", + "description": "RoundOff" + }, + "Sent": { + "type": "boolean", + "description": "Sent" + }, + "TaxReduction": { + "type": "integer", + "format": "int32", + "description": "TaxReduction" + }, + "TermsOfDelivery": { + "type": "string", + "description": "TermsOfDelivery" + }, + "TermsOfPayment": { + "type": "string", + "description": "TermsOfPayment" + }, + "TimeBasisReference": { + "type": "integer", + "format": "int32", + "description": "TimeBasisReference" + }, + "Total": { + "type": "integer", + "format": "int32", + "description": "Total" + }, + "TotalToPay": { + "type": "integer", + "format": "int32", + "description": "TotalToPay" + }, + "TotalVAT": { + "type": "integer", + "format": "int32", + "description": "TotalVAT" + }, + "VATIncluded": { + "type": "boolean", + "description": "VATIncluded" + }, + "VoucherNumber": { + "type": "integer", + "format": "int32", + "description": "VoucherNumber" + }, + "VoucherSeries": { + "type": "string", + "description": "VoucherSeries" + }, + "VoucherYear": { + "type": "integer", + "format": "int32", + "description": "VoucherYear" + }, + "WayOfDelivery": { + "type": "string", + "description": "WayOfDelivery" + }, + "YourOrderNumber": { + "type": "string", + "description": "YourOrderNumber" + }, + "YourReference": { + "type": "string", + "description": "YourReference" + }, + "ZipCode": { + "type": "string", + "description": "ZipCode" + }, + "AccountingMethod": { + "type": "string", + "description": "AccountingMethod" + }, + "TaxReductionType": { + "type": "string", + "description": "TaxReductionType" + }, + "FinalPayDate": { + "type": "string", + "description": "FinalPayDate" + } + }, + "description": "Invoice" + } + } + } + } + }, + "summary": "Retrieve a single invoice", + "description": "Retrieve a single invoice", + "operationId": "GetInvoice", + "x-ms-visibility": "important", + "parameters": [ + { + "name": "DocumentNumber", + "in": "path", + "required": true, + "type": "string", + "x-ms-summary": "Invoice document number", + "description": "Specifies the document number of the invoice to be retrieved.", + "x-ms-url-encoding": "single" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Content-Type", + "x-ms-summary": "Content-Type" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Accept", + "x-ms-summary": "Accept" + } + ] + } + }, + "/currencies": { + "get": { + "tags": ["Currencies"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "MetaInformation": { + "type": "object", + "properties": { + "@TotalResources": { + "type": "integer", + "format": "int32", + "description": "@TotalResources", + "title": "Total Resources", + "x-ms-visibility": "advanced" + }, + "@TotalPages": { + "type": "integer", + "format": "int32", + "description": "@TotalPages", + "title": "Total Pages", + "x-ms-visibility": "advanced" + }, + "@CurrentPage": { + "type": "integer", + "format": "int32", + "description": "@CurrentPage", + "title": "Current Page", + "x-ms-visibility": "advanced" + } + }, + "description": "MetaInformation" + }, + "Currencies": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url" + }, + "BuyRate": { + "type": "number", + "format": "float", + "description": "Buy Rate", + "title": "Buy Rate", + "x-ms-visibility": "internal" + }, + "Code": { + "type": "string", + "description": "Code", + "title": "Code", + "x-ms-visibility": "important" + }, + "Date": { + "type": "string", + "description": "Date", + "title": "Date", + "x-ms-visibility": "advanced" + }, + "Description": { + "type": "string", + "description": "Description", + "title": "Description", + "x-ms-visibility": "advanced" + }, + "SellRate": { + "type": "number", + "format": "float", + "description": "Sell Rate", + "title": "Sell Rate", + "x-ms-visibility": "important" + }, + "Unit": { + "type": "number", + "format": "float", + "description": "Unit", + "title": "Unit", + "x-ms-visibility": "advanced" + }, + "IsAutomatic": { + "type": "boolean", + "description": "Is Automatic", + "title": "Is Automatic", + "enum": [true, false], + "x-ms-visibility": "advanced" + } + } + }, + "description": "Currencies" + } + } + } + } + }, + "summary": "Retrieve a list of currencies", + "description": "The currency register can return a list of records or a single record. By specifying a Code in the URL, a single record will be returned. Not specifying a Code will return a list of records.", + "operationId": "GetCurrencies", + "x-ms-visibility": "advanced", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Content-Type", + "x-ms-summary": "Content-Type" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Accept", + "x-ms-summary": "Accept" + } + ] + } + }, + "/currencies/{Code}": { + "get": { + "tags": ["Currencies"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "Currency": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url", + "title": "", + "x-ms-visibility": "internal" + }, + "BuyRate": { + "type": "number", + "description": "Buy Rate", + "title": "Buy Rate", + "format": "float" + }, + "Code": { + "type": "string", + "description": "Code", + "title": "Code", + "x-ms-visibility": "important" + }, + "Date": { + "type": "string", + "description": "Date", + "title": "Date", + "x-ms-visibility": "advanced" + }, + "Description": { + "type": "string", + "description": "Description", + "title": "Description", + "x-ms-visibility": "advanced" + }, + "SellRate": { + "type": "number", + "description": "Sell Rate", + "title": "Sell Rate", + "x-ms-visibility": "important", + "format": "float" + }, + "Unit": { + "type": "integer", + "format": "int32", + "description": "Unit", + "title": "Unit", + "x-ms-visibility": "important" + }, + "IsAutomatic": { + "type": "boolean", + "description": "Is Automatic", + "title": "Is Automatic", + "enum": [true, false], + "x-ms-visibility": "advanced" + } + }, + "description": "Currency" + } + } + } + } + }, + "summary": "Retrieve a single currency", + "description": "Retrieve a single currency", + "operationId": "GetCurrency", + "x-ms-visibility": "important", + "parameters": [ + { + "name": "Code", + "in": "path", + "required": true, + "type": "string", + "default": "SEK", + "description": "identifies currency", + "x-ms-summary": "Code", + "x-ms-visibility": "important", + "x-ms-url-encoding": "single" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Content-Type", + "x-ms-summary": "Content-Type" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Accept", + "x-ms-summary": "Accept" + } + ] + } + }, + "/vouchers": { + "get": { + "tags": ["Vouchers"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "MetaInformation": { + "type": "object", + "properties": { + "@TotalResources": { + "type": "integer", + "format": "int32", + "description": "Total resources", + "title": "@TotalResources", + "x-ms-visibility": "advanced" + }, + "@TotalPages": { + "type": "integer", + "format": "int32", + "description": "Total pages", + "title": "@TotalPages", + "x-ms-visibility": "advanced" + }, + "@CurrentPage": { + "type": "integer", + "format": "int32", + "description": "Current page", + "title": "@CurrentPage", + "x-ms-visibility": "advanced" + } + }, + "description": "MetaInformation" + }, + "Vouchers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "URL", + "title": "@url", + "x-ms-visibility": "advanced" + }, + "Comments": { + "type": "string", + "description": "Comments", + "title": "Comments", + "x-ms-visibility": "advanced" + }, + "Description": { + "type": "string", + "description": "Description", + "title": "Description" + }, + "ReferenceNumber": { + "type": "string", + "description": "Reference number", + "title": "ReferenceNumber" + }, + "ReferenceType": { + "type": "string", + "description": "Reference type", + "title": "ReferenceType" + }, + "TransactionDate": { + "type": "string", + "description": "Transaction date", + "title": "TransactionDate" + }, + "VoucherNumber": { + "type": "integer", + "format": "int32", + "description": "Voucher number", + "title": "VoucherNumber" + }, + "VoucherSeries": { + "type": "string", + "description": "Voucher series", + "title": "VoucherSeries" + }, + "Year": { + "type": "integer", + "format": "int32", + "description": "Year", + "title": "Year" + }, + "ApprovalState": { + "type": "integer", + "format": "int32", + "description": "Approval state", + "title": "ApprovalState" + } + } + }, + "description": "Vouchers" + } + } + } + } + }, + "summary": "Retrieve all vouchers", + "operationId": "RetrieveAllVouchers", + "description": "Note that vouchers have two keys, one for voucher series and one for voucher number. The financial year is also specified for each voucher, this is due to the same voucher series and number is used each year. To get a unique voucher you need the voucher series, the voucher number and the financial year. These properties will always be returned where ever vouchers is used.", + "x-ms-visibility": "advanced", + "parameters": [ + { + "name": "financialyear", + "in": "query", + "required": false, + "type": "integer", + "description": "Filter on financial year", + "x-ms-summary": "Financial year", + "x-ms-visibility": "advanced", + "format": "int32" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Content-Type", + "x-ms-summary": "Content-Type" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Accept", + "x-ms-summary": "Accept" + }, + { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "x-ms-visibility": "advanced", + "format": "int32", + "default": 500, + "description": "Limit the number of records returned", + "x-ms-summary": "Limit" + }, + { + "name": "offset", + "in": "query", + "required": false, + "type": "integer", + "x-ms-visibility": "advanced", + "format": "int32", + "description": "Offset the number of records returned", + "x-ms-summary": "Offset" + }, + { + "name": "page", + "in": "query", + "required": false, + "type": "integer", + "x-ms-visibility": "advanced", + "description": "Page", + "x-ms-summary": "Page" + }, + { + "name": "lastmodified", + "in": "query", + "required": false, + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Last modified", + "description": "Retrieves all records since the provided timestamp." + } + ] + } + }, + "/vouchers/A/1": {}, + "/vouchers/{VoucherSeries}/{VoucherNumber}": { + "get": { + "tags": ["Vouchers"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "Voucher": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url", + "title": "", + "x-ms-visibility": "internal" + }, + "Comments": { + "type": "string", + "description": "Comments", + "title": "Comments", + "x-ms-visibility": "advanced" + }, + "CostCenter": { + "type": "string", + "description": "Cost Center", + "title": "CostCenter" + }, + "Description": { + "type": "string", + "description": "Description", + "title": "Description", + "x-ms-visibility": "advanced" + }, + "Project": { + "type": "string", + "description": "Project", + "title": "Project" + }, + "ReferenceNumber": { + "type": "string", + "description": "Reference number", + "title": "ReferenceNumber" + }, + "ReferenceType": { + "type": "string", + "description": "Reference type", + "title": "ReferenceType" + }, + "TransactionDate": { + "type": "string", + "description": "Transaction date", + "title": "TransactionDate" + }, + "VoucherNumber": { + "type": "integer", + "format": "int32", + "description": "Voucher number", + "title": "VoucherNumber", + "x-ms-visibility": "important" + }, + "VoucherRows": { + "type": "array", + "items": { + "type": "object", + "properties": { + "Account": { + "type": "integer", + "format": "int32", + "description": "Account", + "title": "Account", + "x-ms-visibility": "important" + }, + "CostCenter": { + "type": "string", + "description": "Cost center", + "title": "CostCenter" + }, + "Credit": { + "type": "number", + "format": "float", + "description": "Credit", + "title": "Credit", + "x-ms-visibility": "important" + }, + "Description": { + "type": "string", + "description": "Description", + "title": "Description", + "x-ms-visibility": "advanced" + }, + "Debit": { + "type": "number", + "format": "float", + "description": "Debit", + "title": "Debit", + "x-ms-visibility": "important" + }, + "Project": { + "type": "string", + "description": "Project", + "title": "Project" + }, + "Removed": { + "type": "boolean", + "description": "Removed", + "title": "Removed", + "enum": [true, false], + "x-ms-visibility": "advanced" + }, + "TransactionInformation": { + "type": "string", + "description": "Transaction information", + "title": "TransactionInformation", + "x-ms-visibility": "advanced" + }, + "Quantity": { + "type": "number", + "format": "float", + "description": "Quantity", + "title": "Quantity" + } + } + }, + "description": "VoucherRows" + }, + "VoucherSeries": { + "type": "string", + "description": "Voucher series", + "title": "VoucherSeries", + "x-ms-visibility": "important" + }, + "Year": { + "type": "integer", + "format": "int32", + "description": "Year", + "title": "Year" + }, + "ApprovalState": { + "type": "integer", + "format": "int32", + "description": "ApprovalState", + "title": "ApprovalState" + } + }, + "description": "Voucher" + } + } + } + } + }, + "summary": "Retrieve a specific voucher", + "description": "Retrieve a specific voucher", + "operationId": "RetrieveVoucher", + "parameters": [ + { + "name": "VoucherSeries", + "in": "path", + "required": true, + "type": "string", + "description": "Identifies the voucher series", + "x-ms-summary": "Voucher Series", + "x-ms-visibility": "important", + "x-ms-url-encoding": "single" + }, + { + "name": "VoucherNumber", + "in": "path", + "required": true, + "type": "integer", + "description": "Identifies the voucher number", + "x-ms-summary": "Voucher Number", + "format": "int32", + "x-ms-visibility": "important", + "x-ms-url-encoding": "single" + }, + { + "name": "financialyear", + "in": "query", + "required": false, + "type": "integer", + "description": "Filter on financial year", + "x-ms-summary": "Financial year", + "x-ms-visibility": "advanced", + "format": "int32" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Content-Type", + "x-ms-summary": "Content-Type" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Accept", + "x-ms-summary": "Accept" + } + ] + } + }, + "/absencetransactions": { + "get": { + "tags": ["Absence transactions"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "MetaInformation": { + "type": "object", + "properties": { + "@TotalResources": { + "type": "integer", + "format": "int32", + "description": "@TotalResources", + "title": "", + "x-ms-visibility": "advanced" + }, + "@TotalPages": { + "type": "integer", + "format": "int32", + "description": "@TotalPages", + "title": "", + "x-ms-visibility": "advanced" + }, + "@CurrentPage": { + "type": "integer", + "format": "int32", + "description": "@CurrentPage", + "title": "", + "x-ms-visibility": "advanced" + } + }, + "description": "MetaInformation" + }, + "AbsenceTransactions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url", + "title": "", + "x-ms-visibility": "internal" + }, + "CauseCode": { + "type": "string", + "description": "CauseCode", + "title": "Cause Code", + "x-ms-visibility": "important" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter", + "title": "Cost Center", + "x-ms-visibility": "advanced" + }, + "Date": { + "type": "string", + "description": "Date", + "title": "Date", + "x-ms-visibility": "important" + }, + "EmployeeId": { + "type": "string", + "description": "EmployeeId", + "title": "EmployeeId", + "x-ms-visibility": "important" + }, + "Extent": { + "type": "number", + "format": "float", + "description": "Extent", + "title": "Extent", + "x-ms-visibility": "important" + }, + "HolidayEntitling": { + "type": "boolean", + "description": "HolidayEntitling", + "title": "Holiday Entitling", + "x-ms-visibility": "advanced", + "enum": [true, false] + }, + "Hours": { + "type": "number", + "format": "float", + "description": "Hours", + "title": "Hours", + "x-ms-visibility": "important" + }, + "Project": { + "type": "string", + "description": "Project", + "title": "Project", + "x-ms-visibility": "advanced" + }, + "id": { + "type": "string", + "description": "id", + "title": "id", + "x-ms-visibility": "advanced" + } + } + }, + "description": "AbsenceTransactions" + } + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "properties": { + "ErrorInformation": { + "type": "object", + "properties": { + "Code": { + "type": "integer", + "format": "int32", + "description": "Code", + "title": "Code", + "x-ms-visibility": "important" + }, + "Error": { + "type": "integer", + "format": "int32", + "description": "Error", + "title": "Code", + "x-ms-visibility": "important" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "Message", + "x-ms-visibility": "important" + } + }, + "description": "ErrorInformation" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Lists all absence transactions", + "description": "Lists all absence transactions: Supports query-string parameters employeeid and date for filtering the result.", + "operationId": "GetAllAbsenceTransactions", + "x-ms-visibility": "advanced", + "parameters": [ + { + "name": "limit", + "default": 500, + "in": "query", + "type": "integer", + "required": false, + "x-ms-visibility": "advanced", + "x-ms-summary": "Limit", + "description": "Limits the number of records returned. The default value is 500." + }, + { + "name": "filter", + "in": "query", + "type": "string", + "required": false, + "x-ms-visibility": "advanced", + "enum": ["active", "inactive"], + "x-ms-summary": "Filter", + "description": "Filter the result set. The default value is active." + }, + { + "name": "page", + "in": "query", + "type": "integer", + "required": false, + "x-ms-visibility": "advanced", + "format": "int32", + "x-ms-summary": "Page", + "description": "The page number to return. The default value is 1." + }, + { + "name": "lastmodified", + "in": "query", + "required": false, + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "Last Modified", + "description": "Retrieves all records since the provided timestamp." + }, + { + "name": "employeeid", + "in": "query", + "required": false, + "type": "string", + "x-ms-visibility": "advanced", + "x-ms-summary": "EmployeeId", + "description": "filter by employee id" + }, + { + "name": "date", + "in": "query", + "required": false, + "type": "string", + "x-ms-summary": "Date", + "x-ms-visibility": "advanced", + "description": "filter by date", + "format": "date" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "x-ms-summary": "Content-Type", + "description": "Content-Type header" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "x-ms-summary": "Accept", + "description": "Accept header" + } + ] + }, + "post": { + "tags": ["Absence transactions"], + "responses": { + "201": { + "description": "Created", + "schema": { + "type": "object", + "properties": { + "AbsenceTransaction": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url", + "title": "", + "x-ms-visibility": "internal" + }, + "CauseCode": { + "type": "string", + "description": "CauseCode", + "title": "Cause Code", + "x-ms-visibility": "important" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter", + "title": "Cost Center", + "x-ms-visibility": "advanced" + }, + "Date": { + "type": "string", + "description": "Date", + "title": "Date", + "x-ms-visibility": "important" + }, + "EmployeeId": { + "type": "string", + "description": "EmployeeId", + "title": "EmployeeId", + "x-ms-visibility": "important" + }, + "Extent": { + "type": "number", + "format": "float", + "description": "Extent", + "title": "Extent", + "x-ms-visibility": "advanced" + }, + "HolidayEntitling": { + "type": "boolean", + "description": "HolidayEntitling", + "title": "Holiday Entitling", + "enum": [true, false], + "x-ms-visibility": "advanced" + }, + "Hours": { + "type": "number", + "format": "float", + "description": "Hours", + "title": "Hours", + "x-ms-visibility": "advanced" + }, + "Project": { + "type": "string", + "description": "Project", + "title": "Project", + "x-ms-visibility": "advanced" + }, + "id": { + "type": "string", + "description": "id", + "title": "id", + "x-ms-visibility": "advanced" + } + }, + "description": "AbsenceTransaction" + } + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "properties": { + "ErrorInformation": { + "type": "object", + "properties": { + "Code": { + "type": "integer", + "format": "int32", + "description": "Code", + "title": "Code", + "x-ms-visibility": "important" + }, + "Error": { + "type": "integer", + "format": "int32", + "description": "Error", + "title": "Code", + "x-ms-visibility": "important" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "Message", + "x-ms-visibility": "important" + } + }, + "description": "ErrorInformation" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Create a new absence transaction", + "description": "Create a new absence transaction", + "operationId": "CreateAbsenceTransaction", + "x-ms-visibility": "advanced", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "x-ms-summary": "Content-Type", + "description": "Content-Type header" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "x-ms-summary": "Accept", + "description": "Accept header" + }, + { + "name": "Absence Transactions", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "AbsenceTransaction": { + "type": "object", + "properties": { + "CauseCode": { + "type": "string", + "description": "CauseCode", + "title": "Cause Code", + "enum": [ + "ASK", + "FPE", + "FRA", + "HAV", + "KOM", + "MIL", + "NAR", + "OS1", + "OS2", + "OS3", + "OS4", + "OS5", + "PAP", + "PEM", + "PER", + "SEM", + "SJK", + "SMB", + "SVE", + "TJL", + "UTB", + "VAB" + ] + }, + "CostCenter": { + "type": "string", + "description": "CostCenter", + "title": "Cost Center", + "x-ms-visibility": "advanced", + "x-ms-summary": "Cost Center" + }, + "Date": { + "type": "string", + "description": "Date", + "title": "Date", + "x-ms-visibility": "important", + "x-ms-summary": "Date" + }, + "EmployeeId": { + "type": "string", + "description": "EmployeeId", + "x-ms-summary": "EmployeeId", + "title": "EmployeeId", + "x-ms-visibility": "important" + }, + "Extent": { + "type": "number", + "format": "float", + "description": "Extent", + "x-ms-summary": "Extent", + "title": "Extent", + "x-ms-visibility": "advanced" + }, + "HolidayEntitling": { + "type": "boolean", + "description": "HolidayEntitling", + "x-ms-summary": "HolidayEntitling", + "title": "Holiday Entitling", + "x-ms-visibility": "advanced", + "enum": [true, false] + }, + "Hours": { + "type": "number", + "format": "float", + "description": "Hours", + "x-ms-summary": "Hours", + "title": "Hours", + "x-ms-visibility": "advanced" + }, + "Project": { + "type": "string", + "description": "Project", + "x-ms-summary": "Project", + "title": "Project", + "x-ms-visibility": "advanced" + } + }, + "description": "AbsenceTransaction", + "required": ["CauseCode", "Date", "EmployeeId"] + } + }, + "x-ms-visibility": "important", + "required": ["AbsenceTransaction"] + }, + "x-ms-visibility": "important" + } + ] + } + }, + "/absencetransactions/{id}": { + "get": { + "tags": ["Absence transactions"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "AbsenceTransaction": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url", + "title": "", + "x-ms-visibility": "internal" + }, + "CauseCode": { + "type": "string", + "description": "CauseCode", + "title": "Cause Code", + "x-ms-visibility": "important" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter", + "title": "Cost Center", + "x-ms-visibility": "advanced" + }, + "Date": { + "type": "string", + "description": "Date", + "title": "Date", + "x-ms-visibility": "important" + }, + "EmployeeId": { + "type": "string", + "description": "EmployeeId", + "title": "EmployeeId", + "x-ms-visibility": "important" + }, + "Extent": { + "type": "number", + "format": "float", + "description": "Extent", + "title": "Extent", + "x-ms-visibility": "advanced" + }, + "HolidayEntitling": { + "type": "boolean", + "description": "HolidayEntitling", + "title": "Holiday Entitling", + "enum": [true, false], + "x-ms-visibility": "advanced" + }, + "Hours": { + "type": "number", + "format": "float", + "description": "Hours", + "title": "Hours", + "x-ms-visibility": "advanced" + }, + "Project": { + "type": "string", + "description": "Project", + "title": "Project", + "x-ms-visibility": "advanced" + }, + "id": { + "type": "string", + "description": "id", + "title": "id", + "x-ms-visibility": "important" + } + }, + "description": "AbsenceTransaction" + } + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "properties": { + "ErrorInformation": { + "type": "object", + "properties": { + "Code": { + "type": "integer", + "format": "int32", + "description": "Code", + "title": "Code", + "x-ms-visibility": "important" + }, + "Error": { + "type": "integer", + "format": "int32", + "description": "Error", + "title": "Code", + "x-ms-visibility": "important" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "Message", + "x-ms-visibility": "important" + } + }, + "description": "ErrorInformation" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Retrieve a specific absence transaction", + "description": "Retrieves a specific transaction", + "operationId": "GetAbsenceTransaction", + "x-ms-visibility": "important", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "string identifies the transaction", + "x-ms-summary": "Id", + "x-ms-visibility": "important", + "x-ms-url-encoding": "single" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Content-Type", + "x-ms-summary": "Content-Type" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Accept", + "x-ms-summary": "Accept" + } + ] + }, + "delete": { + "tags": ["Absence transactions"], + "responses": { + "200": { + "description": "Successfully deleted", + "schema": { + "type": "object" + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "properties": { + "ErrorInformation": { + "type": "object", + "properties": { + "Code": { + "type": "integer", + "format": "int32", + "description": "Code", + "title": "Code", + "x-ms-visibility": "important" + }, + "Error": { + "type": "integer", + "format": "int32", + "description": "Error", + "title": "Code", + "x-ms-visibility": "important" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "Message", + "x-ms-visibility": "important" + } + }, + "description": "ErrorInformation" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Delete an absence transaction", + "description": "Delete an absence transaction", + "operationId": "DeleteAbsenceTransaction", + "x-ms-visibility": "advanced", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "string identifies the transaction", + "x-ms-summary": "id", + "x-ms-visibility": "important", + "x-ms-url-encoding": "single" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Content-Type", + "x-ms-summary": "Content-Type" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Accept", + "x-ms-summary": "Accept" + } + ] + }, + "put": { + "tags": ["Absence transactions"], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "AbsenceTransaction": { + "type": "object", + "properties": { + "@url": { + "type": "string", + "description": "@url", + "title": "", + "x-ms-visibility": "internal" + }, + "CauseCode": { + "type": "string", + "description": "CauseCode", + "title": "Cause Code", + "x-ms-visibility": "important" + }, + "CostCenter": { + "type": "string", + "description": "CostCenter", + "title": "Cost Center", + "x-ms-visibility": "advanced" + }, + "Date": { + "type": "string", + "description": "Date", + "title": "Date", + "x-ms-visibility": "important" + }, + "EmployeeId": { + "type": "string", + "description": "EmployeeId", + "title": "EmployeeId", + "x-ms-visibility": "important" + }, + "Extent": { + "type": "number", + "format": "float", + "description": "Extent", + "title": "Extent", + "x-ms-visibility": "advanced" + }, + "HolidayEntitling": { + "type": "boolean", + "description": "HolidayEntitling", + "title": "Holiday Entitling", + "enum": [true, false], + "x-ms-visibility": "advanced" + }, + "Hours": { + "type": "number", + "format": "float", + "description": "Hours", + "title": "Hours", + "x-ms-visibility": "advanced" + }, + "Project": { + "type": "string", + "description": "Project", + "title": "Project", + "x-ms-visibility": "advanced" + }, + "id": { + "type": "string", + "description": "id", + "title": "id", + "x-ms-visibility": "advanced" + } + }, + "description": "AbsenceTransaction" + } + } + } + }, + "400": { + "description": "Bad Request", + "schema": { + "type": "object", + "properties": { + "ErrorInformation": { + "type": "object", + "properties": { + "Code": { + "type": "integer", + "format": "int32", + "description": "Code", + "title": "Code", + "x-ms-visibility": "important" + }, + "Error": { + "type": "integer", + "format": "int32", + "description": "Error", + "title": "Code", + "x-ms-visibility": "important" + }, + "Message": { + "type": "string", + "description": "Message", + "title": "Message", + "x-ms-visibility": "important" + } + }, + "description": "ErrorInformation" + } + } + } + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not Found" + }, + "500": { + "description": "Internal Server Error" + } + }, + "summary": "Update a single absence transaction", + "description": "Update a single absence transaction", + "operationId": "UpdateAbsenceTransaction", + "x-ms-visibility": "advanced", + "parameters": [ + { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "string identifies the transaction", + "x-ms-summary": "Id", + "x-ms-visibility": "important", + "x-ms-url-encoding": "single" + }, + { + "name": "Content-Type", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Content-Type", + "x-ms-summary": "Content-Type" + }, + { + "name": "Accept", + "in": "header", + "required": true, + "type": "string", + "default": "application/json", + "x-ms-visibility": "internal", + "description": "Accept", + "x-ms-summary": "Accept" + }, + { + "name": "Absence Transactions", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "AbsenceTransaction": { + "type": "object", + "properties": { + "CauseCode": { + "type": "string", + "description": "CauseCode", + "title": "Cause Code", + "enum": [ + "ASK", + "FPE", + "FRA", + "HAV", + "KOM", + "MIL", + "NAR", + "OS1", + "OS2", + "OS3", + "OS4", + "OS5", + "PAP", + "PEM", + "PER", + "SEM", + "SJK", + "SMB", + "SVE", + "TJL", + "UTB", + "VAB" + ] + }, + "CostCenter": { + "type": "string", + "description": "CostCenter", + "x-ms-summary": "CostCenter", + "title": "Cost Center", + "x-ms-visibility": "advanced" + }, + "Date": { + "type": "string", + "description": "Date", + "x-ms-summary": "Date", + "title": "Date", + "x-ms-visibility": "important" + }, + "EmployeeId": { + "type": "string", + "description": "EmployeeId", + "x-ms-summary": "EmployeeId", + "title": "EmployeeId", + "x-ms-visibility": "important" + }, + "Extent": { + "type": "number", + "format": "float", + "description": "Extent", + "x-ms-summary": "Extent", + "title": "Extent", + "x-ms-visibility": "advanced" + }, + "HolidayEntitling": { + "type": "boolean", + "description": "HolidayEntitling", + "x-ms-summary": "HolidayEntitling", + "title": "Holiday Entitling", + "x-ms-visibility": "advanced", + "enum": [true, false] + }, + "Hours": { + "type": "number", + "format": "float", + "description": "Hours", + "x-ms-summary": "Hours", + "title": "Hours", + "x-ms-visibility": "advanced" + }, + "Project": { + "type": "string", + "description": "Project", + "x-ms-summary": "Project", + "title": "Project", + "x-ms-visibility": "advanced" + } + }, + "description": "AbsenceTransaction", + "x-ms-summary": "AbsenceTransaction", + "required": ["CauseCode", "Date", "EmployeeId"] + } + }, + "x-ms-visibility": "important", + "required": ["AbsenceTransaction"] + }, + "x-ms-visibility": "important" + } + ] + } + } + }, + "definitions": {}, + "parameters": {}, + "responses": {}, + "securityDefinitions": { + "oauth2-auth": { + "type": "oauth2", + "flow": "accessCode", + "authorizationUrl": "https://apps.fortnox.se/oauth-v1/auth", + "tokenUrl": "https://apps.fortnox.se/oauth-v1/token", + "scopes": { + "salary bookkeeping archive article companyinformation settings invoice costcenter currency customer inbox payment offer order price print project profile supplierinvoice supplier": "salary bookkeeping archive article companyinformation settings invoice costcenter currency customer inbox payment offer order price print project profile supplierinvoice supplier" + } + } + }, + "security": [ + { + "oauth2-auth": [ + "salary bookkeeping archive article companyinformation settings invoice costcenter currency customer inbox payment offer order price print project profile supplierinvoice supplier" + ] + } + ], + "tags": [], + "x-ms-throttling": { + "rate": { + "limit": 5, + "window": 1 + } + }, + "x-ms-connector-metadata": [ + { + "propertyName": "Website", + "propertyValue": "https://mathiastornblom.github.io/fortnox-powerautomate-connector/" + }, + { + "propertyName": "Privacy Policy", + "propertyValue": "https://mathiastornblom.github.io/fortnox-powerautomate-connector/" + }, + { + "propertyName": "Categories", + "propertyValue": "Productivity" + } + ] +} diff --git a/independent-publisher-connectors/Fortnox/apiProperties.json b/independent-publisher-connectors/Fortnox/apiProperties.json new file mode 100644 index 0000000000..22dcc57143 --- /dev/null +++ b/independent-publisher-connectors/Fortnox/apiProperties.json @@ -0,0 +1,69 @@ +{ + "properties": { + "connectionParameters": { + "token": { + "type": "oauthSetting", + "oAuthSettings": { + "identityProvider": "oauth2", + "clientId": "{{ client id }}", + "clientSecret": "{{ Client Secret }}", + "scopes": [ "salary", "bookkeeping", "archive", "article", "companyinformation", "settings", "invoice", "costcenter", "currency", "customer", "inbox", "payment", "offer", "order", "price", "print", "project", "profile", "supplierinvoice", "supplier" ], + "redirectMode": "Global", + "redirectUrl": "{{ Redirect Url }}", + "properties": { + "IsFirstParty": "False", + "IsOnbehalfofLoginSupported": false + }, + "customParameters": { + "authorizationUrl": { + "value": "https://apps.fortnox.se/oauth-v1/auth" + }, + "tokenUrl": { + "value": "https://apps.fortnox.se/oauth-v1/token" + }, + "refreshUrl": { + "value": "https://apps.fortnox.se/oauth-v1/token" + } + } + } + } + }, + "iconBrandColor": "#da3b01", + "policyTemplateInstances": [ + { + "parameters": { + "x-ms-apimTemplateParameter.name": "Content-Type", + "x-ms-apimTemplateParameter.value": "application/json", + "x-ms-apimTemplate-policySection": "Request", + "x-ms-apimTemplateParameter.existsAction": "override" + }, + "templateId": "setHeader", + "title": "Set Content-Type HTTP header" + }, + { + "parameters": { + "x-ms-apimTemplateParameter.name": "Accept", + "x-ms-apimTemplateParameter.value": "application/json", + "x-ms-apimTemplate-policySection": "Request", + "x-ms-apimTemplateParameter.existsAction": "override" + }, + "templateId": "setHeader", + "title": "Set Accept HTTP header" + }, + { + "parameters": { + "x-ms-apimTemplate-operationName": ["PreviewInvoice"], + "x-ms-apimTemplateParameter.name": "Content-Type", + "x-ms-apimTemplateParameter.value": "application/pfd", + "x-ms-apimTemplate-policySection": "Response", + "x-ms-apimTemplateParameter.existsAction": "override" + }, + "templateId": "setHeader", + "title": "Set Content-Type PDF HTTP header" + } + ], + "capabilities": ["actions"], + "publisher": "Mathias Törnblom", + "stackOwner": "Mathias Törnblom" + } +}