### Get Integration Sales Information (JSON Example) Source: https://api.fortnox.se/apidocs/index This snippet shows the expected JSON response for retrieving sales information for a specific integration. It includes fields like amount, date, orderId, tenantId, and type. ```json [ { "amount": 0, "date": "2019-08-24T14:15:22Z", "orderId": "string", "tenantId": "string", "type": "string" } ] ``` -------------------------------- ### Fortnox API: Retrieve Supplier Invoice (Curl Example) Source: https://api.fortnox.se/apidocs/index This snippet demonstrates how to retrieve a single supplier invoice using the Fortnox API via a cURL command. It specifies the HTTP GET method, the endpoint URL including a placeholder for the invoice's given number, and includes example headers for authentication (API-Key and Access-Token). This is a practical example for integrating API calls into scripts or other applications. ```bash curl -X GET \ 'https://api.fortnox.se/3/supplierinvoices/{GivenNumber}' \ -H 'Accept: application/json' \ -H 'Access-Token: YOUR_ACCESS_TOKEN' \ -H 'API-Key: YOUR_API_KEY' ``` -------------------------------- ### Retrieve a Fortnox Finans Invoice - cURL Example Source: https://api.fortnox.se/apidocs/index This example demonstrates how to retrieve a specific Fortnox Finans invoice using a GET request. It includes the necessary headers for authentication and content negotiation. ```bash curl -X "GET" "https://api.fortnox.se/3/noxfinansinvoices/7201" \ -H "Access-Token: **my_access_token** " \ -H "Client-Secret: **my_client_secret** " \ -H "Content-Type: application/json" \ -H "Accept: application/json" ``` -------------------------------- ### Create Fortnox Employee POST Request Example Source: https://api.fortnox.se/apidocs/index This example demonstrates how to create a new employee in Fortnox via the API. It outlines the request body structure, specifying required and optional fields, and highlights constraints such as the optional nature of EmployeeId and rules for providing schedule and wage information. The endpoint used is POST /3/employees. ```http POST https://api.fortnox.se/3/employees Content-Type: application/json { "FirstName": "John", "LastName": "Doe", "EmploymentDate": "2023-01-01", "SalaryForm": "MAN", "MonthlySalary": "50000" } ``` -------------------------------- ### GET /3/prices Source: https://api.fortnox.se/apidocs/index Retrieve a list of all prices. ```APIDOC ## Retrieve a list of prices ### Description Retrieves a list of all prices. ### Method GET ### Endpoint https://api.fortnox.se/3/prices ### Response #### Success Response (200) - **Price** (object) - A price object. - **@url** (string) - The URL of the price. - **ArticleNumber** (string) - The article number associated with the price. - **Date** (string) - The date the price is effective from. - **FromQuantity** (number) - The minimum quantity for this price. - **Percent** (number) - The discount percentage. - **Price** (number) - The price of the item. - **PriceList** (string) - The price list this price belongs to. #### Response Example ```json { "Price": { "@url": "string", "ArticleNumber": "string", "Date": "2019-08-24T14:15:22Z", "FromQuantity": 0.1, "Percent": 0.1, "Price": 0.1, "PriceList": "string" } } ``` ``` -------------------------------- ### Fortnox Outbound Delivery Payload Example (JSON) Source: https://api.fortnox.se/apidocs/index Example JSON payload for creating or updating an outbound delivery in Fortnox. Includes details about items, stock points, and delivery dates. ```json { "date": "2019-08-24", "id": 0, "note": "string", "released": true, "rows": [ { "costCenterCode": "string", "deliveredQuantity": 0, "forcedQuantity": 0, "itemDescription": "string", "itemId": "string", "itemUnit": "string", "projectId": "string", "quantity": 0.01, "stockLocationCode": "string", "stockLocationId": "c039ed46-ada4-4486-8700-89747e000395", "stockLocationName": "string", "stockPointCode": "string", "stockPointId": "7dcf5601-6c82-49ce-8b36-2dd2c353c71c", "stockPointName": "string" } ], "stockPointCode": "string", "stockPointId": "7dcf5601-6c82-49ce-8b36-2dd2c353c71c", "stockPointName": "string", "voided": true } ``` -------------------------------- ### POST /3/customers Source: https://api.fortnox.se/apidocs/index Create a customer. The created customer will be returned if everything succeeded, if there was any problems an error will be returned. ```APIDOC ## POST /3/customers ### Description Create a customer. The created customer will be returned if everything succeeded, if there was any problems an error will be returned. ### Method POST ### Endpoint https://api.fortnox.se/3/customers ### Parameters #### Request Body - **Customer** (object) - Required - The customer object to create. - **@url** (string) - Optional - URL to the customer resource. - **Active** (boolean) - Optional - Indicates if the customer is active. - **Address1** (string) - Optional - The first line of the customer's address. - **Address2** (string) - Optional - The second line of the customer's address. - **City** (string) - Optional - The city of the customer's address. - **Comments** (string) - Optional - Any comments related to the customer. - **CostCenter** (string) - Optional - The cost center associated with the customer. - **Country** (string) - Optional - The country of the customer's address. - **CountryCode** (string) - Optional - The country code (e.g., 'SE'). - **Currency** (string) - Optional - The currency used for the customer. - **CustomerNumber** (string) - Optional - The unique number identifying the customer. - **DefaultDeliveryTypes** (object) - Optional - Default delivery types for the customer. - **Invoice** (string) - Optional - Default delivery type for invoices. - **Offer** (string) - Optional - Default delivery type for offers. - **Order** (string) - Optional - Default delivery type for orders. - **DefaultTemplates** (object) - Optional - Default templates for customer documents. - **CashInvoice** (string) - Optional - Default template for cash invoices. - **Invoice** (string) - Optional - Default template for invoices. - **Offer** (string) - Optional - Default template for offers. - **Order** (string) - Optional - Default template for orders. - **DeliveryAddress1** (string) - Optional - The first line of the customer's delivery address. - **DeliveryAddress2** (string) - Optional - The second line of the customer's delivery address. - **DeliveryCity** (string) - Optional - The city of the customer's delivery address. - **DeliveryCountry** (string) - Optional - The country of the customer's delivery address. - **DeliveryCountryCode** (string) - Optional - The country code for the delivery address. - **DeliveryFax** (string) - Optional - The fax number for the delivery address. - **DeliveryName** (string) - Optional - The name for the delivery address. - **DeliveryPhone1** (string) - Optional - The first phone number for the delivery address. - **DeliveryPhone2** (string) - Optional - The second phone number for the delivery address. - **DeliveryZipCode** (string) - Optional - The zip code for the delivery address. - **Email** (string) - Optional - The primary email address of the customer. - **EmailInvoice** (string) - Optional - Email address for invoice delivery. - **EmailInvoiceBCC** (string) - Optional - BCC email address for invoice delivery. - **EmailInvoiceCC** (string) - Optional - CC email address for invoice delivery. - **EmailOffer** (string) - Optional - Email address for offer delivery. - **EmailOfferBCC** (string) - Optional - BCC email address for offer delivery. - **EmailOfferCC** (string) - Optional - CC email address for offer delivery. - **EmailOrder** (string) - Optional - Email address for order delivery. - **EmailOrderBCC** (string) - Optional - BCC email address for order delivery. - **EmailOrderCC** (string) - Optional - CC email address for order delivery. - **ExternalReference** (string) - Optional - An external reference for the customer. - **Fax** (string) - Optional - The fax number of the customer. - **GLN** (string) - Optional - The GLN number of the customer. - **GLNDelivery** (string) - Optional - The GLN number for delivery. - **InvoiceAdministrationFee** (string) - Optional - Administration fee for invoices. - **InvoiceDiscount** (number) - Optional - Discount percentage for invoices. - **InvoiceFreight** (string) - Optional - Freight charges for invoices. - **InvoiceRemark** (string) - Optional - Remark for invoices. - **Name** (string) - Optional - The name of the customer. - **OrganisationNumber** (string) - Optional - The organization number of the customer. - **OurReference** (string) - Optional - Our reference for the customer. - **Phone1** (string) - Optional - The primary phone number of the customer. - **Phone2** (string) - Optional - The secondary phone number of the customer. - **PriceList** (string) - Optional - The price list associated with the customer. - **Project** (string) - Optional - The project associated with the customer. - **SalesAccount** (string) - Optional - The sales account for the customer. - **ShowPriceVATIncluded** (boolean) - Optional - Whether prices should be shown VAT included. - **TermsOfDelivery** (string) - Optional - Terms of delivery for the customer. - **TermsOfPayment** (string) - Optional - Terms of payment for the customer. - **Type** (string) - Optional - The type of customer (e.g., 'PRIVATE'). - **VATNumber** (string) - Optional - The VAT number of the customer. - **VATType** (string) - Optional - The VAT type of the customer (e.g., 'SEVAT'). - **VisitingAddress** (string) - Optional - The visiting address of the customer. - **VisitingCity** (string) - Optional - The city of the visiting address. - **VisitingCountry** (string) - Optional - The country of the visiting address. - **VisitingCountryCode** (string) - Optional - The country code for the visiting address. - **VisitingZipCode** (string) - Optional - The zip code for the visiting address. - **WWW** (string) - Optional - The website URL of the customer. - **WayOfDelivery** (string) - Optional - The way of delivery for the customer. - **YourReference** (string) - Optional - Your reference for the customer. - **ZipCode** (string) - Optional - The zip code of the customer's address. ### Response #### Success Response (201) - **Customer** (object) - The created customer object. #### Response Example ```json { "Customer": { "@url": "string", "Active": true, "Address1": "string", "Address2": "string", "City": "string", "Comments": "string", "CostCenter": "string", "Country": "string", "CountryCode": "st", "Currency": "str", "CustomerNumber": "string", "DefaultDeliveryTypes": { "Invoice": "PRINT", "Offer": "PRINT", "Order": "PRINT" }, "DefaultTemplates": { "CashInvoice": "string", "Invoice": "string", "Offer": "string", "Order": "string" }, "DeliveryAddress1": "string", "DeliveryAddress2": "string", "DeliveryCity": "string", "DeliveryCountry": "string", "DeliveryCountryCode": "st", "DeliveryFax": "string", "DeliveryName": "string", "DeliveryPhone1": "string", "DeliveryPhone2": "string", "DeliveryZipCode": "string", "Email": "string", "EmailInvoice": "string", "EmailInvoiceBCC": "string", "EmailInvoiceCC": "string", "EmailOffer": "string", "EmailOfferBCC": "string", "EmailOfferCC": "string", "EmailOrder": "string", "EmailOrderBCC": "string", "EmailOrderCC": "string", "ExternalReference": "string", "Fax": "string", "GLN": "stringstrings", "GLNDelivery": "stringstrings", "InvoiceAdministrationFee": "string", "InvoiceDiscount": 0.1, "InvoiceFreight": "string", "InvoiceRemark": "string", "Name": "string", "OrganisationNumber": "string", "OurReference": "string", "Phone1": "string", "Phone2": "string", "PriceList": "string", "Project": "string", "SalesAccount": "stri", "ShowPriceVATIncluded": true, "TermsOfDelivery": "string", "TermsOfPayment": "string", "Type": "PRIVATE", "VATNumber": "string", "VATType": "SEVAT", "VisitingAddress": "string", "VisitingCity": "string", "VisitingCountry": "string", "VisitingCountryCode": "st", "VisitingZipCode": "string", "WWW": "string", "WayOfDelivery": "string", "YourReference": "string", "ZipCode": "string" } } ``` ``` -------------------------------- ### Create Project (JSON) Source: https://api.fortnox.se/apidocs/index Creates a new project in Fortnox. Requires a JSON request body with project details. ```json { "Project": { "@url": "string", "Comments": "string", "ContactPerson": "string", "Description": "string", "EndDate": "2019-08-24", "ProjectLeader": "string", "ProjectNumber": "string", "StartDate": "2019-08-24", "Status": "NOTSTARTED" } } ``` -------------------------------- ### Response Sample for Created Voucher Series Source: https://api.fortnox.se/apidocs/index This JSON structure illustrates a sample response after successfully creating a voucher series. It returns the details of the newly created voucher series, including its assigned URL, code, and other properties. ```json { "VoucherSeries": { "@url": "string", "Approver": { "Id": 0, "Name": "string" }, "Code": "string", "Description": "string", "Manual": true, "NextVoucherNumber": 0, "Year": 0 } } ``` -------------------------------- ### Retrieve Invoices - Fortnox API Request Source: https://api.fortnox.se/apidocs/index This example shows how to retrieve a list of invoices from the Fortnox API. It includes the GET endpoint and highlights the various query parameters available for filtering and sorting the results. ```http GET /3/invoices Host: api.fortnox.se Query Parameters: filter: cancelled | fullypaid | unpaid | unpaidoverdue | unbooked costcenter: string customername: string customernumber: string label: string documentnumber: string fromdate: string todate: string fromfinalpaydate: string tofinalpaydate: string lastmodified: string notcompleted: string ocr: string ourreference: string project: string sent: string externalinvoicereference1: string externalinvoicereference2: string yourreference: string invoicetype: string articlenumber: string articledescription: string currency: string accountnumberfrom: string accountnumberto: string yourordernumber: string credit: string sortby: customername | customernumber | documentnumber | invoicedate | ocr | total ``` -------------------------------- ### POST /3/projects Source: https://api.fortnox.se/apidocs/index Creates a new project in Fortnox. Requires project details in the request body. ```APIDOC ## POST /3/projects ### Description Creates a new project in Fortnox. Requires project details in the request body. ### Method POST ### Endpoint https://api.fortnox.se/3/projects ### Parameters #### Request Body - **Project** (object) - Required - Project details - **@url** (string) - URL of the project - **Comments** (string) - Optional - Comments for the project - **ContactPerson** (string) - Optional - Contact person for the project - **Description** (string) - Optional - Description of the project - **EndDate** (string) - Optional - End date of the project (YYYY-MM-DD) - **ProjectLeader** (string) - Optional - Project leader - **ProjectNumber** (string) - Optional - Project number - **StartDate** (string) - Optional - Start date of the project (YYYY-MM-DD) - **Status** (string) - Optional - Status of the project (e.g., NOTSTARTED) ### Request Example ```json { "Project": { "Comments": "Initial project setup", "Description": "New client onboarding project", "EndDate": "2024-12-31", "ProjectLeader": "emp123", "StartDate": "2024-01-01", "Status": "ONGOING" } } ``` ### Response #### Success Response (201) - **Project** (object) - The created project details - **@url** (string) - URL of the created project - **Comments** (string) - Comments for the project - **ContactPerson** (string) - Contact person for the project - **Description** (string) - Description of the project - **EndDate** (string) - End date of the project (YYYY-MM-DD) - **ProjectLeader** (string) - Project leader - **ProjectNumber** (string) - Project number - **StartDate** (string) - Start date of the project (YYYY-MM-DD) - **Status** (string) - Status of the project #### Response Example ```json { "Project": { "@url": "https://api.fortnox.se/3/projects/1", "Comments": "Initial project setup", "Description": "New client onboarding project", "EndDate": "2024-12-31", "ProjectLeader": "emp123", "ProjectNumber": "1", "StartDate": "2024-01-01", "Status": "ONGOING" } } ``` ``` -------------------------------- ### Fortnox Get Full Article Registrations Query Parameters Source: https://api.fortnox.se/apidocs/index This example demonstrates how to construct a query to the Fortnox API to retrieve article registrations. It includes common filtering parameters such as date ranges, customer IDs, project IDs, and item IDs. ```http GET /api/time/articles-v1?fromDate=2022-11-01&toDate=2022-11-30&customerIds=100,101,102&projectIds=p1,p2,p3&itemIds=s1,s2,s3&invoiced=true ``` -------------------------------- ### Get Production Order BOM (Example) Source: https://api.fortnox.se/apidocs/index Retrieves the Bill of Materials (BOM) for a given production article. Optionally accepts a quantity to calculate total required quantity or an order ID to fetch BOM from a specific production order. If no parameters are provided, it returns the BOM for producing one unit. ```json { "itemDescription": "string", "itemId": "string", "itemUnit": "string", "quantityRequired": 0, "quantityReserved": 0, "totalQuantityRequired": 0 } ``` -------------------------------- ### Create a Fortnox Offer Source: https://api.fortnox.se/apidocs/index This documentation outlines the process for creating a new offer in Fortnox. It specifies the request body schema and potential error codes, including those related to EasyVat. ```json { "Offer": { "@url": "string", "Cancelled": true, "Currency": "string", "CustomerName": "string", "CustomerNumber": "string", "DocumentNumber": "string", "OfferDate": "2019-08-24", "Project": "string", "Sent": true, "Total": 0.1 } } ``` -------------------------------- ### GET /api/warehouse/stocktaking-v1/{id}/rows Source: https://api.fortnox.se/apidocs/index Retrieves a list of Stock Taking Rows for a given Stock Taking document ID. Supports various query parameters for filtering and sorting, including item IDs, supplier numbers, stock point IDs, stock location IDs, transaction date, item ID/description search, zero balance exclusion, secondary sorting, state filtering, and starting row/item ID for pagination. ```APIDOC ## GET /api/warehouse/stocktaking-v1/{id}/rows ### Description Retrieves a list of Stock Taking Rows for a given Stock Taking document ID. Supports various query parameters for filtering and sorting, including item IDs, supplier numbers, stock point IDs, stock location IDs, transaction date, item ID/description search, zero balance exclusion, secondary sorting, state filtering, and starting row/item ID for pagination. ### Method GET ### Endpoint https://api.fortnox.se/api/warehouse/stocktaking-v1/{id}/rows ### Parameters #### Path Parameters - **id** (integer) - Required - Stock Taking document id. #### Query Parameters - **itemIds** (Array of strings) - Optional - Filter by item IDs. - **supplierNumbers** (Array of strings) - Optional - Filter by supplier numbers. - **stockPointIds** (Array of strings) - Optional - Filter by stock point IDs. - **stockLocationIds** (Array of strings) - Optional - Filter by stock location IDs. - **transactionDate** (string ) - Optional - Filter by transaction date. - **itemIdSearch** (string) - Optional - Search by item ID. - **itemDescriptionSearch** (string) - Optional - Search by item description. - **excludeZeroBalanceItems** (boolean) - Optional - Exclude items with zero balance. - **secondarysortby** (string) - Optional - Secondary sorting column. - **secondaryorder** (string) - Optional - Secondary sorting order. - **stateFilter** (string) - Optional - Enum: "all" "notStockTaken" "stockTakenNoDeviation" "stockTakenWithDeviation". Filters the rows based on their stock taking state. - **startingRowNo** (integer) - Optional - The row number to start the search from, used with startingItemId to jump to specific rows, can be empty. - **startingItemId** (string) - Optional - The itemId that should be on top of the rows list (used to jump to specific row), can be empty. ### Response #### Success Response (200) A list of `StockTakingRows`. #### Response Example ```json { "countedBy": "string", "currentRowNo": 0, "hasPostReleaseStockChanges": true, "id": "string", "itemId": "string", "stockLocationId": "c039ed46-ada4-4486-8700-89747e000395", "stockPointId": "7dcf5601-6c82-49ce-8b36-2dd2c353c71c", "stockTakenQuantity": 0, "stockTakingId": 0, "stockTakingRowId": "string", "totalQuantityInStock": 0 } ``` ``` -------------------------------- ### Sample Response: Created Supplier Invoice File Connection Source: https://api.fortnox.se/apidocs/index This JSON sample illustrates the structure of a response after successfully creating a supplier invoice file connection. ```json { "SupplierInvoiceFileConnection": { "@url": "string", "FileId": "string", "Name": "string", "SupplierInvoiceNumber": "string", "SupplierName": "string" } } ``` -------------------------------- ### Update Invoice - PUT Request Example Source: https://api.fortnox.se/apidocs/index This example shows how to make a PUT request to update an invoice using its document number. It includes a sample payload for the invoice data. ```HTTP PUT https://api.fortnox.se/3/invoices/{DocumentNumber} Content-Type: application/json { "Invoice": { "DocumentNumber": "1234", "CustomerNumber": "CUST001", "InvoiceRows": [ { "ArticleNumber": "ART001", "Description": "Sample Item 1", "Quantity": 2, "Price": 1000 }, { "RowId": 1, "ArticleNumber": "ART002", "Description": "Sample Item 2", "Quantity": 1, "Price": 500 } ] } } ``` -------------------------------- ### Tenant and User Information Response Source: https://api.fortnox.se/apidocs/index Provides a sample response structure for retrieving tenant and user information, including purchase and termination details. ```APIDOC ## GET /websites/api_fortnox_se_apidocs ### Description This endpoint returns detailed information about tenants and their associated users, purchases, and terminations. ### Method GET ### Endpoint /websites/api_fortnox_se_apidocs ### Response #### Success Response (200) - **appId** (string) - The unique identifier for the application. - **tenants** (array) - A list of tenant objects. - **purchases** (array) - A list of purchase objects for the tenant. - **amount** (number) - The amount of the purchase. - **identifier** (string) - A unique identifier for the purchase. - **purchaseTime** (object) - The timestamp of the purchase. - **tenantId** (string) - The unique identifier for the tenant. - **terminations** (array) - A list of termination objects for the tenant. - **amount** (number) - The amount associated with the termination. - **identifier** (string) - A unique identifier for the termination. - **onCancellationTime** (object) - The timestamp of the cancellation. - **users** (array) - A list of user objects associated with the tenant. - **activationTime** (object) - The activation timestamp for the user. - **email** (string) - The email address of the user. - **externalSourceId** (string) - The external ID of the user. - **name** (string) - The name of the user. - **userType** (string) - The type of the user. #### Response Example ```json { "appId": "string", "tenants": [ { "purchases": [ { "amount": 0, "identifier": "string", "purchaseTime": {} } ], "tenantId": "string", "terminations": [ { "amount": 0, "identifier": "string", "onCancellationTime": {} } ], "users": [ { "activationTime": {}, "email": "string", "externalSourceId": "string", "name": "string", "userType": "string" } ] } ] } ``` ``` -------------------------------- ### Create Voucher File Connection Source: https://api.fortnox.se/apidocs/index Creates a new voucher file connection. ```APIDOC ## Create a voucher file connection Creates a new voucher file connection. ### Method POST ### Endpoint /3/voucherfileconnections ### Request Body - **VoucherFileConnection** (object) - Required - The voucher file connection object. - **@url** (string) - Optional - **FileId** (string) - Required - **VoucherDescription** (string) - Required - **VoucherNumber** (string) - Required - **VoucherSeries** (string) - Required - **VoucherYear** (integer) - Required ### Response Example ```json { "VoucherFileConnection": { "@url": "string", "FileId": "string", "VoucherDescription": "string", "VoucherNumber": "string", "VoucherSeries": "string", "VoucherYear": 0 } } ``` ``` -------------------------------- ### List Invoice Payments (GET /3/invoicepayments) Source: https://api.fortnox.se/apidocs/index Retrieves a list of invoice payments from the Fortnox system. This endpoint returns a JSON object containing an array of invoice payment details. No specific dependencies are mentioned for this GET request. ```json { "InvoicePayments": [ { "@url": "string", "Amount": 0.1, "Booked": true, "Currency": "str", "CurrencyRate": 0.1, "CurrencyUnit": 0.1, "InvoiceNumber": 0, "Number": "string", "PaymentDate": "2019-08-24", "Source": "string", "WriteOffExist": true } ] } ``` -------------------------------- ### List all ways of delivery Source: https://api.fortnox.se/apidocs/index Retrieves a list of all ways of delivery. Includes details such as code and descriptions in multiple languages. ```APIDOC ## List all ways of delivery ### Description Retrieves a list of all ways of delivery. Includes details such as code and descriptions in multiple languages. ### Method GET ### Endpoint /3/wayofdeliveries ### Request Example ```json { "WayOfDeliveries": [ { "@url": "string", "Code": "string", "Description": "string", "DescriptionEnglish": "string" } ] } ``` ### Response #### Success Response (200) - **WayOfDeliveries** (array) - An array of way of delivery objects. - **@url** (string) - The URL of the way of delivery. - **Code** (string) - The code identifying the way of delivery. - **Description** (string) - The description of the way of delivery in the default language. - **DescriptionEnglish** (string) - The description of the way of delivery in English. #### Response Example ```json { "WayOfDeliveries": [ { "@url": "string", "Code": "string", "Description": "string", "DescriptionEnglish": "string" } ] } ``` ``` -------------------------------- ### GET /api/warehouse/productionorders-v1/billofmaterials/{itemId} Source: https://api.fortnox.se/apidocs/index Retrieves the package items (Bill of Materials) for a given production article. Optionally, you can provide a quantity to calculate the total required quantity or an order ID to get quantities from a specific production order. ```APIDOC ## GET /api/warehouse/productionorders-v1/billofmaterials/{itemId} ### Description Retrieves the package items (Bill of Materials) for a given production article. Optionally, you can provide a quantity to calculate the total required quantity or an order ID to get quantities from a specific production order. ### Method GET ### Endpoint /api/warehouse/productionorders-v1/billofmaterials/{itemId} ### Parameters #### Path Parameters - **itemId** (string) - Required - The Production Article ID. #### Query Parameters - **id** (integer) - Optional - The ID of the production order. - **quantity** (string) - Optional - The quantity of the production order (assumed 1 if empty). ### Response #### Success Response (200) - **itemDescription** (string) - Description of the package item. - **itemId** (string) - The ID of the package item. - **itemUnit** (string) - The unit of the package item. - **quantityRequired** (number) - The required quantity of the package item. - **quantityReserved** (number) - The reserved quantity of the package item. - **totalQuantityRequired** (number) - The total required quantity of the package item. #### Response Example ```json { "itemDescription": "string", "itemId": "string", "itemUnit": "string", "quantityRequired": 0, "quantityReserved": 0, "totalQuantityRequired": 0 } ``` ``` -------------------------------- ### Fortnox API: Get Manual Outbound Document Endpoint Source: https://api.fortnox.se/apidocs/index This describes the GET request to retrieve a specific manual outbound document by its ID. It specifies the URL path and the expected response codes (200 for success, default for errors). ```http GET /api/warehouse/deliveries-v1/outbounddeliveries/{id} ``` -------------------------------- ### Customer API Source: https://api.fortnox.se/apidocs/index Provides details and examples for customer-related data within the Fortnox API. This includes various attributes of a customer. ```APIDOC ## Customer Resource ### Description This section details the structure of customer data as returned by the Fortnox API. It includes fields for addresses, contact information, financial settings, and more. ### Response Example (Success Response - 200) ```json { "Customer": { "@url": "string", "Active": true, "Address1": "string", "Address2": "string", "City": "string", "Comments": "string", "CostCenter": "string", "Country": "string", "CountryCode": "st", "Currency": "str", "CustomerNumber": "string", "DefaultDeliveryTypes": { "Invoice": "PRINT", "Offer": "PRINT", "Order": "PRINT" }, "DefaultTemplates": { "CashInvoice": "string", "Invoice": "string", "Offer": "string", "Order": "string" }, "DeliveryAddress1": "string", "DeliveryAddress2": "string", "DeliveryCity": "string", "DeliveryCountry": "string", "DeliveryCountryCode": "st", "DeliveryFax": "string", "DeliveryName": "string", "DeliveryPhone1": "string", "DeliveryPhone2": "string", "DeliveryZipCode": "string", "Email": "string", "EmailInvoice": "string", "EmailInvoiceBCC": "string", "EmailInvoiceCC": "string", "EmailOffer": "string", "EmailOfferBCC": "string", "EmailOfferCC": "string", "EmailOrder": "string", "EmailOrderBCC": "string", "EmailOrderCC": "string", "ExternalReference": "string", "Fax": "string", "GLN": "stringstrings", "GLNDelivery": "stringstrings", "InvoiceAdministrationFee": "string", "InvoiceDiscount": 0.1, "InvoiceFreight": "string", "InvoiceRemark": "string", "Name": "string", "OrganisationNumber": "string", "OurReference": "string", "Phone1": "string", "Phone2": "string", "PriceList": "string", "Project": "string", "SalesAccount": "stri", "ShowPriceVATIncluded": true, "TermsOfDelivery": "string", "TermsOfPayment": "string", "Type": "PRIVATE", "VATNumber": "string", "VATType": "SEVAT", "VisitingAddress": "string", "VisitingCity": "string", "VisitingCountry": "string", "VisitingCountryCode": "st", "VisitingZipCode": "string", "WWW": "string", "WayOfDelivery": "string", "YourReference": "string", "ZipCode": "string" } } ``` ``` -------------------------------- ### Retrieve List of Employees - API Endpoint (GET) Source: https://api.fortnox.se/apidocs/index This outlines the API endpoint for fetching a list of employees. It uses the HTTP GET method and specifies the base URL. The response structure for a successful request (200) and an error (default) are also indicated. ```http GET https://api.fortnox.se/3/employees ``` -------------------------------- ### Fortnox API: Create Unit Response Source: https://api.fortnox.se/apidocs/index Details the structure for a newly created unit in Fortnox, including its code, English code, description, and a unique URL. ```json { "Unit": { "@url": "string", "Code": "string", "CodeEnglish": "string", "Description": "string" } } ``` -------------------------------- ### Fortnox API - Retrieve User Information Response Sample Source: https://api.fortnox.se/apidocs/index Shows a sample response for retrieving user information, including 'Email', 'Id', 'Locale', 'Name', and 'SysAdmin' status. ```json { "MeInformation": { "Email": "string", "Id": "string", "Locale": "string", "Name": "string", "SysAdmin": true } } ``` -------------------------------- ### Fortnox API v3 Orders GET Request Parameters Source: https://api.fortnox.se/apidocs/index Defines the query parameters available for filtering and sorting orders via the Fortnox API v3 GET endpoint. These include filters for order status, customer details, dates, and sorting options. ```text filter: string Enum: "cancelled" "expired" "invoicecreated" "invoicenotcreated" possibility to filter orders customername: string filter by customer name customernumber: string filter by customer number label: string filter by label documentnumber: string filter by document number externalinvoicereference1: string filter by external invoice reference 1 externalinvoicereference2: string filter by external invoice reference 2 fromdate: string filter by from date todate: string filter by to date costcenter: string filter by cost center project: string filter by project sent: boolean filter by sent notcompleted: boolean filter by not completed ourreference: string filter by ourreference yourreference: string filter by your reference lastmodified: string filter by lastmodified ordertype: string filter by order type sortby: string Enum: "customername" "customernumber" "orderdate" "documentnumber" "total" field to sort returned list ``` -------------------------------- ### POST /3/pricelists Source: https://api.fortnox.se/apidocs/index Create a new price list. Requires a request body containing the price list details. ```APIDOC ## Create a price list ### Description Creates a new price list. ### Method POST ### Endpoint https://api.fortnox.se/3/pricelists ### Parameters #### Request Body - **PriceList** (object) - Required - The price list object to create. - **@url** (string) - The URL of the price list. - **Code** (string) - Required - The code of the price list. - **Comments** (string) - Comments associated with the price list. - **Description** (string) - The description of the price list. - **PreSelected** (boolean) - Indicates if the price list is pre-selected. ### Response #### Success Response (201) - **PriceList** (object) - The created price list object. - **@url** (string) - The URL of the price list. - **Code** (string) - The code of the price list. - **Comments** (string) - Comments associated with the price list. - **Description** (string) - The description of the price list. - **PreSelected** (boolean) - Indicates if the price list is pre-selected. #### Response Example ```json { "PriceList": { "@url": "string", "Code": "string", "Comments": "string", "Description": "string", "PreSelected": true } } ``` ``` -------------------------------- ### Fortnox List Customers API Endpoint (GET /customers) Source: https://api.fortnox.se/apidocs/index Demonstrates how to retrieve a list of customers from the Fortnox API using a GET request. Supports filtering by various parameters like name, city, email, and sorting by customer number or name. ```http GET /3/customers Host: api.fortnox.se Connection: keep-alive Authorization: Basic YWxhZGRpbjpvcGVuc2VzYW1l ```