{ "openapi": "3.0.0", "info": { "title": "(v1.0) Dynamics 365 Business Central", "description": "(v1.0) Business Central Standard APIs", "contact": {}, "version": "1.0.0" }, "servers": [ { "url": "https://api.businesscentral.dynamics.com/v2.0/sandbox/api/v1.0", "description": "(v1.0) \"Sandbox\"", "variables": {} }, { "url": "https://login.windows.net/common/oauth2/authorize?resource=https://api.businesscentral.dynamics.com", "description": "(v1.0) \"Sandbox\"", "variables": {} }, { "url": "https://api.businesscentral.dynamics.com/v2.0/production/api/v1.0", "description": "(v1.0) \"Production\"", "variables": {} }, { "url": "https://login.windows.net/common/oauth2/authorize?resource=https://api.businesscentral.dynamics.com", "description": "(v1.0) \"Production\"", "variables": {} } ], "paths": { "/companies": { "get": { "tags": [ "company" ], "summary": "listCompanies", "description": "Returns a list of companies", "operationId": "listCompanies", "parameters": [ { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of companies", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesResponse" } } } } }, "deprecated": false } }, "/companies({company_id})": { "get": { "tags": [ "company" ], "summary": "getCompany", "description": "Retrieve the properties and relationships of an object of type company for Dynamics 365 Business Central.", "operationId": "getCompany", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested company", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/company" } } } } }, "deprecated": false } }, "/companies({company_id})/items": { "get": { "tags": [ "item" ], "summary": "listItems", "description": "Returns a list of items", "operationId": "listItems", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select2" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of items", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIItemsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "item" ], "summary": "postItem", "description": "Creates an object of type item in Dynamics 365 Business Central", "operationId": "postItem", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new item has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item" } } } } }, "deprecated": false } }, "/companies({company_id})/items({item_id})": { "get": { "tags": [ "item" ], "summary": "getItem", "description": "Retrieve the properties and relationships of an object of type item for Dynamics 365 Business Central.", "operationId": "getItem", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "item_id", "in": "path", "description": "(v1.0) id for item", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select2" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested item", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item" } } } } }, "deprecated": false }, "delete": { "tags": [ "item" ], "summary": "deleteItem", "description": "Deletes an object of type item in Dynamics 365 Business Central", "operationId": "deleteItem", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "item_id", "in": "path", "description": "(v1.0) id for item", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified item", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "item" ], "summary": "patchItem", "description": "Updates an object of type item in Dynamics 365 Business Central", "operationId": "patchItem", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "item_id", "in": "path", "description": "(v1.0) id for item", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifieditem", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/item" } } } } }, "deprecated": false } }, "/companies({company_id})/items({item_id})/picture": { "get": { "tags": [ "picture" ], "summary": "listPictureForItem", "description": "Returns a list of picture", "operationId": "listPictureForItem", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "item_id", "in": "path", "description": "(v1.0) id for item", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select4" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of picture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIItemsAPIPictureResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/items({item_id})/picture({picture_id})": { "get": { "tags": [ "picture" ], "summary": "getPictureForItem", "description": "Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.", "operationId": "getPictureForItem", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "item_id", "in": "path", "description": "(v1.0) id for item", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select4" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested picture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture" } } } } }, "deprecated": false }, "delete": { "tags": [ "picture" ], "summary": "deletePictureForItem", "description": "Deletes an object of type picture in Dynamics 365 Business Central", "operationId": "deletePictureForItem", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "item_id", "in": "path", "description": "(v1.0) id for item", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified picture", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "picture" ], "summary": "patchPictureForItem", "description": "Updates an object of type picture in Dynamics 365 Business Central", "operationId": "patchPictureForItem", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "item_id", "in": "path", "description": "(v1.0) id for item", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedpicture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture" } } } } }, "deprecated": false } }, "/companies({company_id})/picture": { "get": { "tags": [ "picture" ], "summary": "listPicture", "description": "Returns a list of picture", "operationId": "listPicture", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select4" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of picture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIPictureResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/picture({picture_id})": { "get": { "tags": [ "picture" ], "summary": "getPicture", "description": "Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.", "operationId": "getPicture", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select4" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested picture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture" } } } } }, "deprecated": false }, "delete": { "tags": [ "picture" ], "summary": "deletePicture", "description": "Deletes an object of type picture in Dynamics 365 Business Central", "operationId": "deletePicture", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified picture", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "picture" ], "summary": "patchPicture", "description": "Updates an object of type picture in Dynamics 365 Business Central", "operationId": "patchPicture", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedpicture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture" } } } } }, "deprecated": false } }, "/companies({company_id})/customers({customer_id})/picture": { "get": { "tags": [ "picture" ], "summary": "listPictureForCustomer", "description": "Returns a list of picture", "operationId": "listPictureForCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select4" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of picture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPICustomersAPIPictureResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/customers({customer_id})/picture({picture_id})": { "get": { "tags": [ "picture" ], "summary": "getPictureForCustomer", "description": "Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.", "operationId": "getPictureForCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select4" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested picture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture" } } } } }, "deprecated": false }, "delete": { "tags": [ "picture" ], "summary": "deletePictureForCustomer", "description": "Deletes an object of type picture in Dynamics 365 Business Central", "operationId": "deletePictureForCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified picture", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "picture" ], "summary": "patchPictureForCustomer", "description": "Updates an object of type picture in Dynamics 365 Business Central", "operationId": "patchPictureForCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedpicture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture" } } } } }, "deprecated": false } }, "/companies({company_id})/vendors({vendor_id})/picture": { "get": { "tags": [ "picture" ], "summary": "listPictureForVendor", "description": "Returns a list of picture", "operationId": "listPictureForVendor", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendor_id", "in": "path", "description": "(v1.0) id for vendor", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select4" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of picture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIVendorsAPIPictureResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/vendors({vendor_id})/picture({picture_id})": { "get": { "tags": [ "picture" ], "summary": "getPictureForVendor", "description": "Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.", "operationId": "getPictureForVendor", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendor_id", "in": "path", "description": "(v1.0) id for vendor", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select4" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested picture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture" } } } } }, "deprecated": false }, "delete": { "tags": [ "picture" ], "summary": "deletePictureForVendor", "description": "Deletes an object of type picture in Dynamics 365 Business Central", "operationId": "deletePictureForVendor", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendor_id", "in": "path", "description": "(v1.0) id for vendor", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified picture", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "picture" ], "summary": "patchPictureForVendor", "description": "Updates an object of type picture in Dynamics 365 Business Central", "operationId": "patchPictureForVendor", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendor_id", "in": "path", "description": "(v1.0) id for vendor", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedpicture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture" } } } } }, "deprecated": false } }, "/companies({company_id})/employees({employee_id})/picture": { "get": { "tags": [ "picture" ], "summary": "listPictureForEmployee", "description": "Returns a list of picture", "operationId": "listPictureForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select4" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of picture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIEmployeesAPIPictureResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/employees({employee_id})/picture({picture_id})": { "get": { "tags": [ "picture" ], "summary": "getPictureForEmployee", "description": "Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.", "operationId": "getPictureForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select4" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested picture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture" } } } } }, "deprecated": false }, "delete": { "tags": [ "picture" ], "summary": "deletePictureForEmployee", "description": "Deletes an object of type picture in Dynamics 365 Business Central", "operationId": "deletePictureForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified picture", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "picture" ], "summary": "patchPictureForEmployee", "description": "Updates an object of type picture in Dynamics 365 Business Central", "operationId": "patchPictureForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "picture_id", "in": "path", "description": "(v1.0) id for picture", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedpicture", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/picture" } } } } }, "deprecated": false } }, "/companies({company_id})/items({item_id})/defaultDimensions": { "get": { "tags": [ "defaultDimensions" ], "summary": "listDefaultDimensionsForItem", "description": "Returns a list of defaultDimensions", "operationId": "listDefaultDimensionsForItem", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "item_id", "in": "path", "description": "(v1.0) id for item", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand2" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select6" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of defaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIItemsAPIDefaultDimensionsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "defaultDimensions" ], "summary": "postDefaultDimensionsForItem", "description": "Creates an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "postDefaultDimensionsForItem", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "item_id", "in": "path", "description": "(v1.0) id for item", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new defaultDimensions has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false } }, "/companies({company_id})/items({item_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})": { "get": { "tags": [ "defaultDimensions" ], "summary": "getDefaultDimensionsForItem", "description": "Retrieve the properties and relationships of an object of type defaultDimensions for Dynamics 365 Business Central.", "operationId": "getDefaultDimensionsForItem", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "item_id", "in": "path", "description": "(v1.0) id for item", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand2" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select6" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested defaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false }, "delete": { "tags": [ "defaultDimensions" ], "summary": "deleteDefaultDimensionsForItem", "description": "Deletes an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "deleteDefaultDimensionsForItem", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "item_id", "in": "path", "description": "(v1.0) id for item", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified defaultDimensions", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "defaultDimensions" ], "summary": "patchDefaultDimensionsForItem", "description": "Updates an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "patchDefaultDimensionsForItem", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "item_id", "in": "path", "description": "(v1.0) id for item", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifieddefaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false } }, "/companies({company_id})/defaultDimensions": { "get": { "tags": [ "defaultDimensions" ], "summary": "listDefaultDimensions", "description": "Returns a list of defaultDimensions", "operationId": "listDefaultDimensions", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand2" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select6" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of defaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIDefaultDimensionsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "defaultDimensions" ], "summary": "postDefaultDimensions", "description": "Creates an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "postDefaultDimensions", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new defaultDimensions has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false } }, "/companies({company_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})": { "get": { "tags": [ "defaultDimensions" ], "summary": "getDefaultDimensions", "description": "Retrieve the properties and relationships of an object of type defaultDimensions for Dynamics 365 Business Central.", "operationId": "getDefaultDimensions", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand2" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select6" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested defaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false }, "delete": { "tags": [ "defaultDimensions" ], "summary": "deleteDefaultDimensions", "description": "Deletes an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "deleteDefaultDimensions", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified defaultDimensions", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "defaultDimensions" ], "summary": "patchDefaultDimensions", "description": "Updates an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "patchDefaultDimensions", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifieddefaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false } }, "/companies({company_id})/customers({customer_id})/defaultDimensions": { "get": { "tags": [ "defaultDimensions" ], "summary": "listDefaultDimensionsForCustomer", "description": "Returns a list of defaultDimensions", "operationId": "listDefaultDimensionsForCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand2" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select6" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of defaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPICustomersAPIDefaultDimensionsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "defaultDimensions" ], "summary": "postDefaultDimensionsForCustomer", "description": "Creates an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "postDefaultDimensionsForCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new defaultDimensions has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false } }, "/companies({company_id})/customers({customer_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})": { "get": { "tags": [ "defaultDimensions" ], "summary": "getDefaultDimensionsForCustomer", "description": "Retrieve the properties and relationships of an object of type defaultDimensions for Dynamics 365 Business Central.", "operationId": "getDefaultDimensionsForCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand2" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select6" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested defaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false }, "delete": { "tags": [ "defaultDimensions" ], "summary": "deleteDefaultDimensionsForCustomer", "description": "Deletes an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "deleteDefaultDimensionsForCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified defaultDimensions", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "defaultDimensions" ], "summary": "patchDefaultDimensionsForCustomer", "description": "Updates an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "patchDefaultDimensionsForCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifieddefaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false } }, "/companies({company_id})/vendors({vendor_id})/defaultDimensions": { "get": { "tags": [ "defaultDimensions" ], "summary": "listDefaultDimensionsForVendor", "description": "Returns a list of defaultDimensions", "operationId": "listDefaultDimensionsForVendor", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendor_id", "in": "path", "description": "(v1.0) id for vendor", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand2" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select6" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of defaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIVendorsAPIDefaultDimensionsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "defaultDimensions" ], "summary": "postDefaultDimensionsForVendor", "description": "Creates an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "postDefaultDimensionsForVendor", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendor_id", "in": "path", "description": "(v1.0) id for vendor", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new defaultDimensions has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false } }, "/companies({company_id})/vendors({vendor_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})": { "get": { "tags": [ "defaultDimensions" ], "summary": "getDefaultDimensionsForVendor", "description": "Retrieve the properties and relationships of an object of type defaultDimensions for Dynamics 365 Business Central.", "operationId": "getDefaultDimensionsForVendor", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendor_id", "in": "path", "description": "(v1.0) id for vendor", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand2" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select6" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested defaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false }, "delete": { "tags": [ "defaultDimensions" ], "summary": "deleteDefaultDimensionsForVendor", "description": "Deletes an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "deleteDefaultDimensionsForVendor", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendor_id", "in": "path", "description": "(v1.0) id for vendor", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified defaultDimensions", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "defaultDimensions" ], "summary": "patchDefaultDimensionsForVendor", "description": "Updates an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "patchDefaultDimensionsForVendor", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendor_id", "in": "path", "description": "(v1.0) id for vendor", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifieddefaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false } }, "/companies({company_id})/employees({employee_id})/defaultDimensions": { "get": { "tags": [ "defaultDimensions" ], "summary": "listDefaultDimensionsForEmployee", "description": "Returns a list of defaultDimensions", "operationId": "listDefaultDimensionsForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand2" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select6" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of defaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIEmployeesAPIDefaultDimensionsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "defaultDimensions" ], "summary": "postDefaultDimensionsForEmployee", "description": "Creates an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "postDefaultDimensionsForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new defaultDimensions has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false } }, "/companies({company_id})/employees({employee_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId})": { "get": { "tags": [ "defaultDimensions" ], "summary": "getDefaultDimensionsForEmployee", "description": "Retrieve the properties and relationships of an object of type defaultDimensions for Dynamics 365 Business Central.", "operationId": "getDefaultDimensionsForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand2" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select6" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested defaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false }, "delete": { "tags": [ "defaultDimensions" ], "summary": "deleteDefaultDimensionsForEmployee", "description": "Deletes an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "deleteDefaultDimensionsForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified defaultDimensions", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "defaultDimensions" ], "summary": "patchDefaultDimensionsForEmployee", "description": "Updates an object of type defaultDimensions in Dynamics 365 Business Central", "operationId": "patchDefaultDimensionsForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_parentId", "in": "path", "description": "(v1.0) parentId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "defaultDimensions_dimensionId", "in": "path", "description": "(v1.0) dimensionId for defaultDimensions", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifieddefaultDimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/defaultDimensions" } } } } }, "deprecated": false } }, "/companies({company_id})/customers": { "get": { "tags": [ "customer" ], "summary": "listCustomers", "description": "Returns a list of customers", "operationId": "listCustomers", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand6" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select12" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of customers", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPICustomersResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "customer" ], "summary": "postCustomer", "description": "Creates an object of type customer in Dynamics 365 Business Central", "operationId": "postCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new customer has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } } }, "deprecated": false } }, "/companies({company_id})/customers({customer_id})": { "get": { "tags": [ "customer" ], "summary": "getCustomer", "description": "Retrieve the properties and relationships of an object of type customer for Dynamics 365 Business Central.", "operationId": "getCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand6" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select12" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested customer", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } } }, "deprecated": false }, "delete": { "tags": [ "customer" ], "summary": "deleteCustomer", "description": "Deletes an object of type customer in Dynamics 365 Business Central", "operationId": "deleteCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified customer", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "customer" ], "summary": "patchCustomer", "description": "Updates an object of type customer in Dynamics 365 Business Central", "operationId": "patchCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedcustomer", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customer" } } } } }, "deprecated": false } }, "/companies({company_id})/customers({customer_id})/customerFinancialDetails": { "get": { "tags": [ "customerFinancialDetail" ], "summary": "listCustomerFinancialDetailsForCustomer", "description": "Returns a list of customerFinancialDetails", "operationId": "listCustomerFinancialDetailsForCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select14" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of customerFinancialDetails", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPICustomersAPICustomerFinancialDetailsResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/customers({customer_id})/customerFinancialDetails({customerFinancialDetail_id})": { "get": { "tags": [ "customerFinancialDetail" ], "summary": "getCustomerFinancialDetailForCustomer", "description": "Retrieve the properties and relationships of an object of type customerFinancialDetail for Dynamics 365 Business Central.", "operationId": "getCustomerFinancialDetailForCustomer", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customer_id", "in": "path", "description": "(v1.0) id for customer", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerFinancialDetail_id", "in": "path", "description": "(v1.0) id for customerFinancialDetail", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select14" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested customerFinancialDetail", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerFinancialDetail" } } } } }, "deprecated": false } }, "/companies({company_id})/customerFinancialDetails": { "get": { "tags": [ "customerFinancialDetail" ], "summary": "listCustomerFinancialDetails", "description": "Returns a list of customerFinancialDetails", "operationId": "listCustomerFinancialDetails", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select14" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of customerFinancialDetails", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPICustomerFinancialDetailsResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/customerFinancialDetails({customerFinancialDetail_id})": { "get": { "tags": [ "customerFinancialDetail" ], "summary": "getCustomerFinancialDetail", "description": "Retrieve the properties and relationships of an object of type customerFinancialDetail for Dynamics 365 Business Central.", "operationId": "getCustomerFinancialDetail", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerFinancialDetail_id", "in": "path", "description": "(v1.0) id for customerFinancialDetail", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select14" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested customerFinancialDetail", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerFinancialDetail" } } } } }, "deprecated": false } }, "/companies({company_id})/vendors": { "get": { "tags": [ "vendor" ], "summary": "listVendors", "description": "Returns a list of vendors", "operationId": "listVendors", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand10" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select22" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of vendors", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIVendorsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "vendor" ], "summary": "postVendor", "description": "Creates an object of type vendor in Dynamics 365 Business Central", "operationId": "postVendor", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendor1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new vendor has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendor" } } } } }, "deprecated": false } }, "/companies({company_id})/vendors({vendor_id})": { "get": { "tags": [ "vendor" ], "summary": "getVendor", "description": "Retrieve the properties and relationships of an object of type vendor for Dynamics 365 Business Central.", "operationId": "getVendor", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendor_id", "in": "path", "description": "(v1.0) id for vendor", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand10" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select22" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested vendor", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendor" } } } } }, "deprecated": false }, "delete": { "tags": [ "vendor" ], "summary": "deleteVendor", "description": "Deletes an object of type vendor in Dynamics 365 Business Central", "operationId": "deleteVendor", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendor_id", "in": "path", "description": "(v1.0) id for vendor", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified vendor", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "vendor" ], "summary": "patchVendor", "description": "Updates an object of type vendor in Dynamics 365 Business Central", "operationId": "patchVendor", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendor_id", "in": "path", "description": "(v1.0) id for vendor", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendor1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedvendor", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendor" } } } } }, "deprecated": false } }, "/companies({company_id})/companyInformation": { "get": { "tags": [ "companyInformation" ], "summary": "listCompanyInformation", "description": "Returns a list of companyInformation", "operationId": "listCompanyInformation", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select28" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of companyInformation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPICompanyInformationResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/companyInformation({companyInformation_id})": { "get": { "tags": [ "companyInformation" ], "summary": "getCompanyInformation", "description": "Retrieve the properties and relationships of an object of type companyInformation for Dynamics 365 Business Central.", "operationId": "getCompanyInformation", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "companyInformation_id", "in": "path", "description": "(v1.0) id for companyInformation", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select28" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested companyInformation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/companyInformation" } } } } }, "deprecated": false }, "patch": { "tags": [ "companyInformation" ], "summary": "patchCompanyInformation", "description": "Updates an object of type companyInformation in Dynamics 365 Business Central", "operationId": "patchCompanyInformation", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "companyInformation_id", "in": "path", "description": "(v1.0) id for companyInformation", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/companyInformation" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedcompanyInformation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/companyInformation" } } } } }, "deprecated": false } }, "/companies({company_id})/salesInvoices": { "get": { "tags": [ "salesInvoice" ], "summary": "listSalesInvoices", "description": "Returns a list of salesInvoices", "operationId": "listSalesInvoices", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand14" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select30" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of salesInvoices", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesInvoicesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "salesInvoice" ], "summary": "postSalesInvoice", "description": "Creates an object of type salesInvoice in Dynamics 365 Business Central", "operationId": "postSalesInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoice1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new salesInvoice has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoice" } } } } }, "deprecated": false } }, "/companies({company_id})/salesInvoices({salesInvoice_id})": { "get": { "tags": [ "salesInvoice" ], "summary": "getSalesInvoice", "description": "Retrieve the properties and relationships of an object of type salesInvoice for Dynamics 365 Business Central.", "operationId": "getSalesInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand14" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select30" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested salesInvoice", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoice" } } } } }, "deprecated": false }, "delete": { "tags": [ "salesInvoice" ], "summary": "deleteSalesInvoice", "description": "Deletes an object of type salesInvoice in Dynamics 365 Business Central", "operationId": "deleteSalesInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified salesInvoice", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "salesInvoice" ], "summary": "patchSalesInvoice", "description": "Updates an object of type salesInvoice in Dynamics 365 Business Central", "operationId": "patchSalesInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoice1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedsalesInvoice", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoice" } } } } }, "deprecated": false } }, "/companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.cancelAndSend": { "post": { "tags": [ "salesInvoice" ], "summary": "cancelAndSendActionSalesInvoices", "description": "Performs the cancelAndSend action for salesInvoices entity", "operationId": "cancelAndSendActionSalesInvoices", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a cancelAndSend action on the Dynamic 365 Business Central salesInvoices entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.cancel": { "post": { "tags": [ "salesInvoice" ], "summary": "cancelActionSalesInvoices", "description": "Performs the cancel action for salesInvoices entity", "operationId": "cancelActionSalesInvoices", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a cancel action on the Dynamic 365 Business Central salesInvoices entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.makeCorrectiveCreditMemo": { "post": { "tags": [ "salesInvoice" ], "summary": "makeCorrectiveCreditMemoActionSalesInvoices", "description": "Performs the makeCorrectiveCreditMemo action for salesInvoices entity", "operationId": "makeCorrectiveCreditMemoActionSalesInvoices", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a makeCorrectiveCreditMemo action on the Dynamic 365 Business Central salesInvoices entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.postAndSend": { "post": { "tags": [ "salesInvoice" ], "summary": "postAndSendActionSalesInvoices", "description": "Performs the postAndSend action for salesInvoices entity", "operationId": "postAndSendActionSalesInvoices", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a postAndSend action on the Dynamic 365 Business Central salesInvoices entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.post": { "post": { "tags": [ "salesInvoice" ], "summary": "postActionSalesInvoices", "description": "Performs the post action for salesInvoices entity", "operationId": "postActionSalesInvoices", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a post action on the Dynamic 365 Business Central salesInvoices entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesInvoices({salesInvoice_id})/Microsoft.NAV.send": { "post": { "tags": [ "salesInvoice" ], "summary": "sendActionSalesInvoices", "description": "Performs the send action for salesInvoices entity", "operationId": "sendActionSalesInvoices", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a send action on the Dynamic 365 Business Central salesInvoices entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesInvoices({salesInvoice_id})/salesInvoiceLines": { "get": { "tags": [ "salesInvoiceLine" ], "summary": "listSalesInvoiceLinesForSalesInvoice", "description": "Returns a list of salesInvoiceLines", "operationId": "listSalesInvoiceLinesForSalesInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select32" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of salesInvoiceLines", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesInvoicesAPISalesInvoiceLinesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "salesInvoiceLine" ], "summary": "postSalesInvoiceLineForSalesInvoice", "description": "Creates an object of type salesInvoiceLine in Dynamics 365 Business Central", "operationId": "postSalesInvoiceLineForSalesInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoiceLine1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new salesInvoiceLine has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoiceLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesInvoices({salesInvoice_id})/salesInvoiceLines('{salesInvoiceLine_id}')": { "get": { "tags": [ "salesInvoiceLine" ], "summary": "getSalesInvoiceLineForSalesInvoice", "description": "Retrieve the properties and relationships of an object of type salesInvoiceLine for Dynamics 365 Business Central.", "operationId": "getSalesInvoiceLineForSalesInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoiceLine_id", "in": "path", "description": "(v1.0) id for salesInvoiceLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select32" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested salesInvoiceLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoiceLine" } } } } }, "deprecated": false }, "delete": { "tags": [ "salesInvoiceLine" ], "summary": "deleteSalesInvoiceLineForSalesInvoice", "description": "Deletes an object of type salesInvoiceLine in Dynamics 365 Business Central", "operationId": "deleteSalesInvoiceLineForSalesInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoiceLine_id", "in": "path", "description": "(v1.0) id for salesInvoiceLine", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified salesInvoiceLine", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "salesInvoiceLine" ], "summary": "patchSalesInvoiceLineForSalesInvoice", "description": "Updates an object of type salesInvoiceLine in Dynamics 365 Business Central", "operationId": "patchSalesInvoiceLineForSalesInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoiceLine_id", "in": "path", "description": "(v1.0) id for salesInvoiceLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoiceLine1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedsalesInvoiceLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoiceLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesInvoiceLines": { "get": { "tags": [ "salesInvoiceLine" ], "summary": "listSalesInvoiceLines", "description": "Returns a list of salesInvoiceLines", "operationId": "listSalesInvoiceLines", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select32" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of salesInvoiceLines", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesInvoiceLinesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "salesInvoiceLine" ], "summary": "postSalesInvoiceLine", "description": "Creates an object of type salesInvoiceLine in Dynamics 365 Business Central", "operationId": "postSalesInvoiceLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoiceLine1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new salesInvoiceLine has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoiceLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesInvoiceLines('{salesInvoiceLine_id}')": { "get": { "tags": [ "salesInvoiceLine" ], "summary": "getSalesInvoiceLine", "description": "Retrieve the properties and relationships of an object of type salesInvoiceLine for Dynamics 365 Business Central.", "operationId": "getSalesInvoiceLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoiceLine_id", "in": "path", "description": "(v1.0) id for salesInvoiceLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select32" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested salesInvoiceLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoiceLine" } } } } }, "deprecated": false }, "delete": { "tags": [ "salesInvoiceLine" ], "summary": "deleteSalesInvoiceLine", "description": "Deletes an object of type salesInvoiceLine in Dynamics 365 Business Central", "operationId": "deleteSalesInvoiceLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoiceLine_id", "in": "path", "description": "(v1.0) id for salesInvoiceLine", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified salesInvoiceLine", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "salesInvoiceLine" ], "summary": "patchSalesInvoiceLine", "description": "Updates an object of type salesInvoiceLine in Dynamics 365 Business Central", "operationId": "patchSalesInvoiceLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoiceLine_id", "in": "path", "description": "(v1.0) id for salesInvoiceLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoiceLine1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedsalesInvoiceLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesInvoiceLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesInvoices({salesInvoice_id})/pdfDocument": { "get": { "tags": [ "pdfDocument" ], "summary": "listPdfDocumentForSalesInvoice", "description": "Returns a list of pdfDocument", "operationId": "listPdfDocumentForSalesInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select34" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of pdfDocument", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesInvoicesAPIPdfDocumentResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/salesInvoices({salesInvoice_id})/pdfDocument({pdfDocument_id})": { "get": { "tags": [ "pdfDocument" ], "summary": "getPdfDocumentForSalesInvoice", "description": "Retrieve the properties and relationships of an object of type pdfDocument for Dynamics 365 Business Central.", "operationId": "getPdfDocumentForSalesInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesInvoice_id", "in": "path", "description": "(v1.0) id for salesInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "pdfDocument_id", "in": "path", "description": "(v1.0) id for pdfDocument", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select34" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested pdfDocument", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pdfDocument" } } } } }, "deprecated": false } }, "/companies({company_id})/pdfDocument": { "get": { "tags": [ "pdfDocument" ], "summary": "listPdfDocument", "description": "Returns a list of pdfDocument", "operationId": "listPdfDocument", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select34" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of pdfDocument", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIPdfDocumentResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/pdfDocument({pdfDocument_id})": { "get": { "tags": [ "pdfDocument" ], "summary": "getPdfDocument", "description": "Retrieve the properties and relationships of an object of type pdfDocument for Dynamics 365 Business Central.", "operationId": "getPdfDocument", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "pdfDocument_id", "in": "path", "description": "(v1.0) id for pdfDocument", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select34" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested pdfDocument", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pdfDocument" } } } } }, "deprecated": false } }, "/companies({company_id})/salesQuotes({salesQuote_id})/pdfDocument": { "get": { "tags": [ "pdfDocument" ], "summary": "listPdfDocumentForSalesQuote", "description": "Returns a list of pdfDocument", "operationId": "listPdfDocumentForSalesQuote", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuote_id", "in": "path", "description": "(v1.0) id for salesQuote", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select34" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of pdfDocument", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesQuotesAPIPdfDocumentResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/salesQuotes({salesQuote_id})/pdfDocument({pdfDocument_id})": { "get": { "tags": [ "pdfDocument" ], "summary": "getPdfDocumentForSalesQuote", "description": "Retrieve the properties and relationships of an object of type pdfDocument for Dynamics 365 Business Central.", "operationId": "getPdfDocumentForSalesQuote", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuote_id", "in": "path", "description": "(v1.0) id for salesQuote", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "pdfDocument_id", "in": "path", "description": "(v1.0) id for pdfDocument", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select34" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested pdfDocument", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pdfDocument" } } } } }, "deprecated": false } }, "/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/pdfDocument": { "get": { "tags": [ "pdfDocument" ], "summary": "listPdfDocumentForSalesCreditMemo", "description": "Returns a list of pdfDocument", "operationId": "listPdfDocumentForSalesCreditMemo", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select34" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of pdfDocument", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesCreditMemosAPIPdfDocumentResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/pdfDocument({pdfDocument_id})": { "get": { "tags": [ "pdfDocument" ], "summary": "getPdfDocumentForSalesCreditMemo", "description": "Retrieve the properties and relationships of an object of type pdfDocument for Dynamics 365 Business Central.", "operationId": "getPdfDocumentForSalesCreditMemo", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "pdfDocument_id", "in": "path", "description": "(v1.0) id for pdfDocument", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select34" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested pdfDocument", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pdfDocument" } } } } }, "deprecated": false } }, "/companies({company_id})/purchaseInvoices({purchaseInvoice_id})/pdfDocument": { "get": { "tags": [ "pdfDocument" ], "summary": "listPdfDocumentForPurchaseInvoice", "description": "Returns a list of pdfDocument", "operationId": "listPdfDocumentForPurchaseInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoice_id", "in": "path", "description": "(v1.0) id for purchaseInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select34" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of pdfDocument", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIPurchaseInvoicesAPIPdfDocumentResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/purchaseInvoices({purchaseInvoice_id})/pdfDocument({pdfDocument_id})": { "get": { "tags": [ "pdfDocument" ], "summary": "getPdfDocumentForPurchaseInvoice", "description": "Retrieve the properties and relationships of an object of type pdfDocument for Dynamics 365 Business Central.", "operationId": "getPdfDocumentForPurchaseInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoice_id", "in": "path", "description": "(v1.0) id for purchaseInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "pdfDocument_id", "in": "path", "description": "(v1.0) id for pdfDocument", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select34" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested pdfDocument", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/pdfDocument" } } } } }, "deprecated": false } }, "/companies({company_id})/customerPaymentJournals": { "get": { "tags": [ "customerPaymentJournal" ], "summary": "listCustomerPaymentJournals", "description": "Returns a list of customerPaymentJournals", "operationId": "listCustomerPaymentJournals", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand20" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select40" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of customerPaymentJournals", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPICustomerPaymentJournalsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "customerPaymentJournal" ], "summary": "postCustomerPaymentJournal", "description": "Creates an object of type customerPaymentJournal in Dynamics 365 Business Central", "operationId": "postCustomerPaymentJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPaymentJournal1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new customerPaymentJournal has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPaymentJournal" } } } } }, "deprecated": false } }, "/companies({company_id})/customerPaymentJournals({customerPaymentJournal_id})": { "get": { "tags": [ "customerPaymentJournal" ], "summary": "getCustomerPaymentJournal", "description": "Retrieve the properties and relationships of an object of type customerPaymentJournal for Dynamics 365 Business Central.", "operationId": "getCustomerPaymentJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPaymentJournal_id", "in": "path", "description": "(v1.0) id for customerPaymentJournal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand20" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select40" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested customerPaymentJournal", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPaymentJournal" } } } } }, "deprecated": false }, "delete": { "tags": [ "customerPaymentJournal" ], "summary": "deleteCustomerPaymentJournal", "description": "Deletes an object of type customerPaymentJournal in Dynamics 365 Business Central", "operationId": "deleteCustomerPaymentJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPaymentJournal_id", "in": "path", "description": "(v1.0) id for customerPaymentJournal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified customerPaymentJournal", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "customerPaymentJournal" ], "summary": "patchCustomerPaymentJournal", "description": "Updates an object of type customerPaymentJournal in Dynamics 365 Business Central", "operationId": "patchCustomerPaymentJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPaymentJournal_id", "in": "path", "description": "(v1.0) id for customerPaymentJournal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPaymentJournal1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedcustomerPaymentJournal", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPaymentJournal" } } } } }, "deprecated": false } }, "/companies({company_id})/customerPaymentJournals({customerPaymentJournal_id})/customerPayments": { "get": { "tags": [ "customerPayment" ], "summary": "listCustomerPaymentsForCustomerPaymentJournal", "description": "Returns a list of customerPayments", "operationId": "listCustomerPaymentsForCustomerPaymentJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPaymentJournal_id", "in": "path", "description": "(v1.0) id for customerPaymentJournal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand22" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select42" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of customerPayments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPICustomerPaymentJournalsAPICustomerPaymentsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "customerPayment" ], "summary": "postCustomerPaymentForCustomerPaymentJournal", "description": "Creates an object of type customerPayment in Dynamics 365 Business Central", "operationId": "postCustomerPaymentForCustomerPaymentJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPaymentJournal_id", "in": "path", "description": "(v1.0) id for customerPaymentJournal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPayment1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new customerPayment has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPayment" } } } } }, "deprecated": false } }, "/companies({company_id})/customerPaymentJournals({customerPaymentJournal_id})/customerPayments({customerPayment_id})": { "get": { "tags": [ "customerPayment" ], "summary": "getCustomerPaymentForCustomerPaymentJournal", "description": "Retrieve the properties and relationships of an object of type customerPayment for Dynamics 365 Business Central.", "operationId": "getCustomerPaymentForCustomerPaymentJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPaymentJournal_id", "in": "path", "description": "(v1.0) id for customerPaymentJournal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPayment_id", "in": "path", "description": "(v1.0) id for customerPayment", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand22" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select42" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested customerPayment", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPayment" } } } } }, "deprecated": false }, "delete": { "tags": [ "customerPayment" ], "summary": "deleteCustomerPaymentForCustomerPaymentJournal", "description": "Deletes an object of type customerPayment in Dynamics 365 Business Central", "operationId": "deleteCustomerPaymentForCustomerPaymentJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPaymentJournal_id", "in": "path", "description": "(v1.0) id for customerPaymentJournal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPayment_id", "in": "path", "description": "(v1.0) id for customerPayment", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified customerPayment", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "customerPayment" ], "summary": "patchCustomerPaymentForCustomerPaymentJournal", "description": "Updates an object of type customerPayment in Dynamics 365 Business Central", "operationId": "patchCustomerPaymentForCustomerPaymentJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPaymentJournal_id", "in": "path", "description": "(v1.0) id for customerPaymentJournal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPayment_id", "in": "path", "description": "(v1.0) id for customerPayment", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPayment1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedcustomerPayment", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPayment" } } } } }, "deprecated": false } }, "/companies({company_id})/customerPayments": { "get": { "tags": [ "customerPayment" ], "summary": "listCustomerPayments", "description": "Returns a list of customerPayments", "operationId": "listCustomerPayments", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand22" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select42" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of customerPayments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPICustomerPaymentsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "customerPayment" ], "summary": "postCustomerPayment", "description": "Creates an object of type customerPayment in Dynamics 365 Business Central", "operationId": "postCustomerPayment", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPayment1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new customerPayment has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPayment" } } } } }, "deprecated": false } }, "/companies({company_id})/customerPayments({customerPayment_id})": { "get": { "tags": [ "customerPayment" ], "summary": "getCustomerPayment", "description": "Retrieve the properties and relationships of an object of type customerPayment for Dynamics 365 Business Central.", "operationId": "getCustomerPayment", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPayment_id", "in": "path", "description": "(v1.0) id for customerPayment", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand22" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select42" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested customerPayment", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPayment" } } } } }, "deprecated": false }, "delete": { "tags": [ "customerPayment" ], "summary": "deleteCustomerPayment", "description": "Deletes an object of type customerPayment in Dynamics 365 Business Central", "operationId": "deleteCustomerPayment", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPayment_id", "in": "path", "description": "(v1.0) id for customerPayment", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified customerPayment", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "customerPayment" ], "summary": "patchCustomerPayment", "description": "Updates an object of type customerPayment in Dynamics 365 Business Central", "operationId": "patchCustomerPayment", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerPayment_id", "in": "path", "description": "(v1.0) id for customerPayment", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPayment1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedcustomerPayment", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerPayment" } } } } }, "deprecated": false } }, "/companies({company_id})/accounts": { "get": { "tags": [ "account" ], "summary": "listAccounts", "description": "Returns a list of accounts", "operationId": "listAccounts", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select46" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of accounts", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIAccountsResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/accounts({account_id})": { "get": { "tags": [ "account" ], "summary": "getAccount", "description": "Retrieve the properties and relationships of an object of type account for Dynamics 365 Business Central.", "operationId": "getAccount", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "account_id", "in": "path", "description": "(v1.0) id for account", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select46" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested account", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/account" } } } } }, "deprecated": false } }, "/companies({company_id})/taxGroups": { "get": { "tags": [ "taxGroup" ], "summary": "listTaxGroups", "description": "Returns a list of taxGroups", "operationId": "listTaxGroups", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select48" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of taxGroups", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPITaxGroupsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "taxGroup" ], "summary": "postTaxGroup", "description": "Creates an object of type taxGroup in Dynamics 365 Business Central", "operationId": "postTaxGroup", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxGroup" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new taxGroup has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxGroup" } } } } }, "deprecated": false } }, "/companies({company_id})/taxGroups({taxGroup_id})": { "get": { "tags": [ "taxGroup" ], "summary": "getTaxGroup", "description": "Retrieve the properties and relationships of an object of type taxGroup for Dynamics 365 Business Central.", "operationId": "getTaxGroup", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "taxGroup_id", "in": "path", "description": "(v1.0) id for taxGroup", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select48" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested taxGroup", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxGroup" } } } } }, "deprecated": false }, "delete": { "tags": [ "taxGroup" ], "summary": "deleteTaxGroup", "description": "Deletes an object of type taxGroup in Dynamics 365 Business Central", "operationId": "deleteTaxGroup", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "taxGroup_id", "in": "path", "description": "(v1.0) id for taxGroup", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified taxGroup", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "taxGroup" ], "summary": "patchTaxGroup", "description": "Updates an object of type taxGroup in Dynamics 365 Business Central", "operationId": "patchTaxGroup", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "taxGroup_id", "in": "path", "description": "(v1.0) id for taxGroup", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxGroup" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedtaxGroup", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxGroup" } } } } }, "deprecated": false } }, "/companies({company_id})/journals": { "get": { "tags": [ "journal" ], "summary": "listJournals", "description": "Returns a list of journals", "operationId": "listJournals", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand26" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select40" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of journals", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIJournalsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "journal" ], "summary": "postJournal", "description": "Creates an object of type journal in Dynamics 365 Business Central", "operationId": "postJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journal1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new journal has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journal" } } } } }, "deprecated": false } }, "/companies({company_id})/journals({journal_id})": { "get": { "tags": [ "journal" ], "summary": "getJournal", "description": "Retrieve the properties and relationships of an object of type journal for Dynamics 365 Business Central.", "operationId": "getJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand26" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select40" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested journal", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journal" } } } } }, "deprecated": false }, "delete": { "tags": [ "journal" ], "summary": "deleteJournal", "description": "Deletes an object of type journal in Dynamics 365 Business Central", "operationId": "deleteJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified journal", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "journal" ], "summary": "patchJournal", "description": "Updates an object of type journal in Dynamics 365 Business Central", "operationId": "patchJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journal1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedjournal", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journal" } } } } }, "deprecated": false } }, "/companies({company_id})/journals({journal_id})/Microsoft.NAV.post": { "post": { "tags": [ "journal" ], "summary": "postActionJournals", "description": "Performs the post action for journals entity", "operationId": "postActionJournals", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a post action on the Dynamic 365 Business Central journals entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/journals({journal_id})/journalLines": { "get": { "tags": [ "journalLine" ], "summary": "listJournalLinesForJournal", "description": "Returns a list of journalLines", "operationId": "listJournalLinesForJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand28" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select52" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of journalLines", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIJournalsAPIJournalLinesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "journalLine" ], "summary": "postJournalLineForJournal", "description": "Creates an object of type journalLine in Dynamics 365 Business Central", "operationId": "postJournalLineForJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journalLine1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new journalLine has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journalLine" } } } } }, "deprecated": false } }, "/companies({company_id})/journals({journal_id})/journalLines({journalLine_id})": { "get": { "tags": [ "journalLine" ], "summary": "getJournalLineForJournal", "description": "Retrieve the properties and relationships of an object of type journalLine for Dynamics 365 Business Central.", "operationId": "getJournalLineForJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand28" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select52" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested journalLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journalLine" } } } } }, "deprecated": false }, "delete": { "tags": [ "journalLine" ], "summary": "deleteJournalLineForJournal", "description": "Deletes an object of type journalLine in Dynamics 365 Business Central", "operationId": "deleteJournalLineForJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified journalLine", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "journalLine" ], "summary": "patchJournalLineForJournal", "description": "Updates an object of type journalLine in Dynamics 365 Business Central", "operationId": "patchJournalLineForJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journalLine1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedjournalLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journalLine" } } } } }, "deprecated": false } }, "/companies({company_id})/journalLines": { "get": { "tags": [ "journalLine" ], "summary": "listJournalLines", "description": "Returns a list of journalLines", "operationId": "listJournalLines", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand28" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select52" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of journalLines", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIJournalLinesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "journalLine" ], "summary": "postJournalLine", "description": "Creates an object of type journalLine in Dynamics 365 Business Central", "operationId": "postJournalLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journalLine1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new journalLine has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journalLine" } } } } }, "deprecated": false } }, "/companies({company_id})/journalLines({journalLine_id})": { "get": { "tags": [ "journalLine" ], "summary": "getJournalLine", "description": "Retrieve the properties and relationships of an object of type journalLine for Dynamics 365 Business Central.", "operationId": "getJournalLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand28" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select52" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested journalLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journalLine" } } } } }, "deprecated": false }, "delete": { "tags": [ "journalLine" ], "summary": "deleteJournalLine", "description": "Deletes an object of type journalLine in Dynamics 365 Business Central", "operationId": "deleteJournalLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified journalLine", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "journalLine" ], "summary": "patchJournalLine", "description": "Updates an object of type journalLine in Dynamics 365 Business Central", "operationId": "patchJournalLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journalLine1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedjournalLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journalLine" } } } } }, "deprecated": false } }, "/companies({company_id})/journals({journal_id})/journalLines({journalLine_id})/attachments": { "get": { "tags": [ "attachments" ], "summary": "listAttachmentsForJournalLineForJournal", "description": "Returns a list of attachments", "operationId": "listAttachmentsForJournalLineForJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select54" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of attachments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIJournalsAPIJournalLinesJournalLineIdAPIAttachmentsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "attachments" ], "summary": "postAttachmentsForJournalLineForJournal", "description": "Creates an object of type attachments in Dynamics 365 Business Central", "operationId": "postAttachmentsForJournalLineForJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new attachments has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } } } }, "deprecated": false } }, "/companies({company_id})/journals({journal_id})/journalLines({journalLine_id})/attachments({attachments_parentId},{attachments_id})": { "get": { "tags": [ "attachments" ], "summary": "getAttachmentsForJournalLineForJournal", "description": "Retrieve the properties and relationships of an object of type attachments for Dynamics 365 Business Central.", "operationId": "getAttachmentsForJournalLineForJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_parentId", "in": "path", "description": "(v1.0) parentId for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_id", "in": "path", "description": "(v1.0) id for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select54" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested attachments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } } } }, "deprecated": false }, "delete": { "tags": [ "attachments" ], "summary": "deleteAttachmentsForJournalLineForJournal", "description": "Deletes an object of type attachments in Dynamics 365 Business Central", "operationId": "deleteAttachmentsForJournalLineForJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_parentId", "in": "path", "description": "(v1.0) parentId for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_id", "in": "path", "description": "(v1.0) id for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified attachments", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "attachments" ], "summary": "patchAttachmentsForJournalLineForJournal", "description": "Updates an object of type attachments in Dynamics 365 Business Central", "operationId": "patchAttachmentsForJournalLineForJournal", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journal_id", "in": "path", "description": "(v1.0) id for journal", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_parentId", "in": "path", "description": "(v1.0) parentId for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_id", "in": "path", "description": "(v1.0) id for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedattachments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } } } }, "deprecated": false } }, "/companies({company_id})/journalLines({journalLine_id})/attachments": { "get": { "tags": [ "attachments" ], "summary": "listAttachmentsForJournalLine", "description": "Returns a list of attachments", "operationId": "listAttachmentsForJournalLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select54" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of attachments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIJournalLinesAPIAttachmentsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "attachments" ], "summary": "postAttachmentsForJournalLine", "description": "Creates an object of type attachments in Dynamics 365 Business Central", "operationId": "postAttachmentsForJournalLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new attachments has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } } } }, "deprecated": false } }, "/companies({company_id})/journalLines({journalLine_id})/attachments({attachments_parentId},{attachments_id})": { "get": { "tags": [ "attachments" ], "summary": "getAttachmentsForJournalLine", "description": "Retrieve the properties and relationships of an object of type attachments for Dynamics 365 Business Central.", "operationId": "getAttachmentsForJournalLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_parentId", "in": "path", "description": "(v1.0) parentId for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_id", "in": "path", "description": "(v1.0) id for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select54" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested attachments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } } } }, "deprecated": false }, "delete": { "tags": [ "attachments" ], "summary": "deleteAttachmentsForJournalLine", "description": "Deletes an object of type attachments in Dynamics 365 Business Central", "operationId": "deleteAttachmentsForJournalLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_parentId", "in": "path", "description": "(v1.0) parentId for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_id", "in": "path", "description": "(v1.0) id for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified attachments", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "attachments" ], "summary": "patchAttachmentsForJournalLine", "description": "Updates an object of type attachments in Dynamics 365 Business Central", "operationId": "patchAttachmentsForJournalLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "journalLine_id", "in": "path", "description": "(v1.0) id for journalLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_parentId", "in": "path", "description": "(v1.0) parentId for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_id", "in": "path", "description": "(v1.0) id for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedattachments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } } } }, "deprecated": false } }, "/companies({company_id})/attachments": { "get": { "tags": [ "attachments" ], "summary": "listAttachments", "description": "Returns a list of attachments", "operationId": "listAttachments", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select54" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of attachments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIAttachmentsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "attachments" ], "summary": "postAttachments", "description": "Creates an object of type attachments in Dynamics 365 Business Central", "operationId": "postAttachments", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new attachments has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } } } }, "deprecated": false } }, "/companies({company_id})/attachments({attachments_parentId},{attachments_id})": { "get": { "tags": [ "attachments" ], "summary": "getAttachments", "description": "Retrieve the properties and relationships of an object of type attachments for Dynamics 365 Business Central.", "operationId": "getAttachments", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_parentId", "in": "path", "description": "(v1.0) parentId for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_id", "in": "path", "description": "(v1.0) id for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select54" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested attachments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } } } }, "deprecated": false }, "delete": { "tags": [ "attachments" ], "summary": "deleteAttachments", "description": "Deletes an object of type attachments in Dynamics 365 Business Central", "operationId": "deleteAttachments", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_parentId", "in": "path", "description": "(v1.0) parentId for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_id", "in": "path", "description": "(v1.0) id for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified attachments", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "attachments" ], "summary": "patchAttachments", "description": "Updates an object of type attachments in Dynamics 365 Business Central", "operationId": "patchAttachments", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_parentId", "in": "path", "description": "(v1.0) parentId for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "attachments_id", "in": "path", "description": "(v1.0) id for attachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedattachments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/attachments" } } } } }, "deprecated": false } }, "/companies({company_id})/employees": { "get": { "tags": [ "employee" ], "summary": "listEmployees", "description": "Returns a list of employees", "operationId": "listEmployees", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand32" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select62" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of employees", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIEmployeesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "employee" ], "summary": "postEmployee", "description": "Creates an object of type employee in Dynamics 365 Business Central", "operationId": "postEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/employee1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new employee has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/employee" } } } } }, "deprecated": false } }, "/companies({company_id})/employees({employee_id})": { "get": { "tags": [ "employee" ], "summary": "getEmployee", "description": "Retrieve the properties and relationships of an object of type employee for Dynamics 365 Business Central.", "operationId": "getEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand32" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select62" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested employee", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/employee" } } } } }, "deprecated": false }, "delete": { "tags": [ "employee" ], "summary": "deleteEmployee", "description": "Deletes an object of type employee in Dynamics 365 Business Central", "operationId": "deleteEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified employee", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "employee" ], "summary": "patchEmployee", "description": "Updates an object of type employee in Dynamics 365 Business Central", "operationId": "patchEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/employee1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedemployee", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/employee" } } } } }, "deprecated": false } }, "/companies({company_id})/employees({employee_id})/timeRegistrationEntries": { "get": { "tags": [ "timeRegistrationEntry" ], "summary": "listTimeRegistrationEntriesForEmployee", "description": "Returns a list of timeRegistrationEntries", "operationId": "listTimeRegistrationEntriesForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand36" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select68" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of timeRegistrationEntries", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIEmployeesAPITimeRegistrationEntriesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "timeRegistrationEntry" ], "summary": "postTimeRegistrationEntryForEmployee", "description": "Creates an object of type timeRegistrationEntry in Dynamics 365 Business Central", "operationId": "postTimeRegistrationEntryForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timeRegistrationEntry1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new timeRegistrationEntry has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timeRegistrationEntry" } } } } }, "deprecated": false } }, "/companies({company_id})/employees({employee_id})/timeRegistrationEntries({timeRegistrationEntry_id})": { "get": { "tags": [ "timeRegistrationEntry" ], "summary": "getTimeRegistrationEntryForEmployee", "description": "Retrieve the properties and relationships of an object of type timeRegistrationEntry for Dynamics 365 Business Central.", "operationId": "getTimeRegistrationEntryForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "timeRegistrationEntry_id", "in": "path", "description": "(v1.0) id for timeRegistrationEntry", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand36" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select68" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested timeRegistrationEntry", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timeRegistrationEntry" } } } } }, "deprecated": false }, "delete": { "tags": [ "timeRegistrationEntry" ], "summary": "deleteTimeRegistrationEntryForEmployee", "description": "Deletes an object of type timeRegistrationEntry in Dynamics 365 Business Central", "operationId": "deleteTimeRegistrationEntryForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "timeRegistrationEntry_id", "in": "path", "description": "(v1.0) id for timeRegistrationEntry", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified timeRegistrationEntry", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "timeRegistrationEntry" ], "summary": "patchTimeRegistrationEntryForEmployee", "description": "Updates an object of type timeRegistrationEntry in Dynamics 365 Business Central", "operationId": "patchTimeRegistrationEntryForEmployee", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "employee_id", "in": "path", "description": "(v1.0) id for employee", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "timeRegistrationEntry_id", "in": "path", "description": "(v1.0) id for timeRegistrationEntry", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timeRegistrationEntry1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedtimeRegistrationEntry", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timeRegistrationEntry" } } } } }, "deprecated": false } }, "/companies({company_id})/timeRegistrationEntries": { "get": { "tags": [ "timeRegistrationEntry" ], "summary": "listTimeRegistrationEntries", "description": "Returns a list of timeRegistrationEntries", "operationId": "listTimeRegistrationEntries", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand36" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select68" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of timeRegistrationEntries", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPITimeRegistrationEntriesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "timeRegistrationEntry" ], "summary": "postTimeRegistrationEntry", "description": "Creates an object of type timeRegistrationEntry in Dynamics 365 Business Central", "operationId": "postTimeRegistrationEntry", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timeRegistrationEntry1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new timeRegistrationEntry has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timeRegistrationEntry" } } } } }, "deprecated": false } }, "/companies({company_id})/timeRegistrationEntries({timeRegistrationEntry_id})": { "get": { "tags": [ "timeRegistrationEntry" ], "summary": "getTimeRegistrationEntry", "description": "Retrieve the properties and relationships of an object of type timeRegistrationEntry for Dynamics 365 Business Central.", "operationId": "getTimeRegistrationEntry", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "timeRegistrationEntry_id", "in": "path", "description": "(v1.0) id for timeRegistrationEntry", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand36" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select68" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested timeRegistrationEntry", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timeRegistrationEntry" } } } } }, "deprecated": false }, "delete": { "tags": [ "timeRegistrationEntry" ], "summary": "deleteTimeRegistrationEntry", "description": "Deletes an object of type timeRegistrationEntry in Dynamics 365 Business Central", "operationId": "deleteTimeRegistrationEntry", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "timeRegistrationEntry_id", "in": "path", "description": "(v1.0) id for timeRegistrationEntry", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified timeRegistrationEntry", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "timeRegistrationEntry" ], "summary": "patchTimeRegistrationEntry", "description": "Updates an object of type timeRegistrationEntry in Dynamics 365 Business Central", "operationId": "patchTimeRegistrationEntry", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "timeRegistrationEntry_id", "in": "path", "description": "(v1.0) id for timeRegistrationEntry", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timeRegistrationEntry1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedtimeRegistrationEntry", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/timeRegistrationEntry" } } } } }, "deprecated": false } }, "/companies({company_id})/generalLedgerEntries": { "get": { "tags": [ "generalLedgerEntry" ], "summary": "listGeneralLedgerEntries", "description": "Returns a list of generalLedgerEntries", "operationId": "listGeneralLedgerEntries", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand40" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select72" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of generalLedgerEntries", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIGeneralLedgerEntriesResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/generalLedgerEntries({generalLedgerEntry_id})": { "get": { "tags": [ "generalLedgerEntry" ], "summary": "getGeneralLedgerEntry", "description": "Retrieve the properties and relationships of an object of type generalLedgerEntry for Dynamics 365 Business Central.", "operationId": "getGeneralLedgerEntry", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "generalLedgerEntry_id", "in": "path", "description": "(v1.0) id for generalLedgerEntry", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand40" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select72" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested generalLedgerEntry", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generalLedgerEntry" } } } } }, "deprecated": false } }, "/companies({company_id})/currencies": { "get": { "tags": [ "currency" ], "summary": "listCurrencies", "description": "Returns a list of currencies", "operationId": "listCurrencies", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select74" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of currencies", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPICurrenciesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "currency" ], "summary": "postCurrency", "description": "Creates an object of type currency in Dynamics 365 Business Central", "operationId": "postCurrency", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/currency" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new currency has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/currency" } } } } }, "deprecated": false } }, "/companies({company_id})/currencies({currency_id})": { "get": { "tags": [ "currency" ], "summary": "getCurrency", "description": "Retrieve the properties and relationships of an object of type currency for Dynamics 365 Business Central.", "operationId": "getCurrency", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "currency_id", "in": "path", "description": "(v1.0) id for currency", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select74" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested currency", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/currency" } } } } }, "deprecated": false }, "delete": { "tags": [ "currency" ], "summary": "deleteCurrency", "description": "Deletes an object of type currency in Dynamics 365 Business Central", "operationId": "deleteCurrency", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "currency_id", "in": "path", "description": "(v1.0) id for currency", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified currency", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "currency" ], "summary": "patchCurrency", "description": "Updates an object of type currency in Dynamics 365 Business Central", "operationId": "patchCurrency", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "currency_id", "in": "path", "description": "(v1.0) id for currency", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/currency" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedcurrency", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/currency" } } } } }, "deprecated": false } }, "/companies({company_id})/paymentMethods": { "get": { "tags": [ "paymentMethod" ], "summary": "listPaymentMethods", "description": "Returns a list of paymentMethods", "operationId": "listPaymentMethods", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select76" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of paymentMethods", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIPaymentMethodsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "paymentMethod" ], "summary": "postPaymentMethod", "description": "Creates an object of type paymentMethod in Dynamics 365 Business Central", "operationId": "postPaymentMethod", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentMethod" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new paymentMethod has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentMethod" } } } } }, "deprecated": false } }, "/companies({company_id})/paymentMethods({paymentMethod_id})": { "get": { "tags": [ "paymentMethod" ], "summary": "getPaymentMethod", "description": "Retrieve the properties and relationships of an object of type paymentMethod for Dynamics 365 Business Central.", "operationId": "getPaymentMethod", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "paymentMethod_id", "in": "path", "description": "(v1.0) id for paymentMethod", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select76" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested paymentMethod", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentMethod" } } } } }, "deprecated": false }, "delete": { "tags": [ "paymentMethod" ], "summary": "deletePaymentMethod", "description": "Deletes an object of type paymentMethod in Dynamics 365 Business Central", "operationId": "deletePaymentMethod", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "paymentMethod_id", "in": "path", "description": "(v1.0) id for paymentMethod", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified paymentMethod", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "paymentMethod" ], "summary": "patchPaymentMethod", "description": "Updates an object of type paymentMethod in Dynamics 365 Business Central", "operationId": "patchPaymentMethod", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "paymentMethod_id", "in": "path", "description": "(v1.0) id for paymentMethod", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentMethod" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedpaymentMethod", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentMethod" } } } } }, "deprecated": false } }, "/companies({company_id})/dimensions": { "get": { "tags": [ "dimension" ], "summary": "listDimensions", "description": "Returns a list of dimensions", "operationId": "listDimensions", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand42" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select76" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of dimensions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIDimensionsResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/dimensions({dimension_id})": { "get": { "tags": [ "dimension" ], "summary": "getDimension", "description": "Retrieve the properties and relationships of an object of type dimension for Dynamics 365 Business Central.", "operationId": "getDimension", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "dimension_id", "in": "path", "description": "(v1.0) id for dimension", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand42" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select76" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested dimension", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dimension" } } } } }, "deprecated": false } }, "/companies({company_id})/dimensions({dimension_id})/dimensionValues": { "get": { "tags": [ "dimensionValue" ], "summary": "listDimensionValuesForDimension", "description": "Returns a list of dimensionValues", "operationId": "listDimensionValuesForDimension", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "dimension_id", "in": "path", "description": "(v1.0) id for dimension", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select76" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of dimensionValues", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIDimensionsAPIDimensionValuesResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/dimensions({dimension_id})/dimensionValues({dimensionValue_id})": { "get": { "tags": [ "dimensionValue" ], "summary": "getDimensionValueForDimension", "description": "Retrieve the properties and relationships of an object of type dimensionValue for Dynamics 365 Business Central.", "operationId": "getDimensionValueForDimension", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "dimension_id", "in": "path", "description": "(v1.0) id for dimension", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "dimensionValue_id", "in": "path", "description": "(v1.0) id for dimensionValue", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select76" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested dimensionValue", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dimensionValue" } } } } }, "deprecated": false } }, "/companies({company_id})/dimensionValues": { "get": { "tags": [ "dimensionValue" ], "summary": "listDimensionValues", "description": "Returns a list of dimensionValues", "operationId": "listDimensionValues", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select76" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of dimensionValues", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIDimensionValuesResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/dimensionValues({dimensionValue_id})": { "get": { "tags": [ "dimensionValue" ], "summary": "getDimensionValue", "description": "Retrieve the properties and relationships of an object of type dimensionValue for Dynamics 365 Business Central.", "operationId": "getDimensionValue", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "dimensionValue_id", "in": "path", "description": "(v1.0) id for dimensionValue", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select76" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested dimensionValue", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dimensionValue" } } } } }, "deprecated": false } }, "/companies({company_id})/dimensionLines": { "get": { "tags": [ "dimensionLine" ], "summary": "listDimensionLines", "description": "Returns a list of dimensionLines", "operationId": "listDimensionLines", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand44" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select84" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of dimensionLines", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIDimensionLinesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "dimensionLine" ], "summary": "postDimensionLine", "description": "Creates an object of type dimensionLine in Dynamics 365 Business Central", "operationId": "postDimensionLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dimensionLine1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new dimensionLine has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dimensionLine" } } } } }, "deprecated": false } }, "/companies({company_id})/dimensionLines({dimensionLine_parentId},{dimensionLine_id})": { "get": { "tags": [ "dimensionLine" ], "summary": "getDimensionLine", "description": "Retrieve the properties and relationships of an object of type dimensionLine for Dynamics 365 Business Central.", "operationId": "getDimensionLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "dimensionLine_parentId", "in": "path", "description": "(v1.0) parentId for dimensionLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "dimensionLine_id", "in": "path", "description": "(v1.0) id for dimensionLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand44" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select84" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested dimensionLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dimensionLine" } } } } }, "deprecated": false }, "delete": { "tags": [ "dimensionLine" ], "summary": "deleteDimensionLine", "description": "Deletes an object of type dimensionLine in Dynamics 365 Business Central", "operationId": "deleteDimensionLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "dimensionLine_parentId", "in": "path", "description": "(v1.0) parentId for dimensionLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "dimensionLine_id", "in": "path", "description": "(v1.0) id for dimensionLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified dimensionLine", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "dimensionLine" ], "summary": "patchDimensionLine", "description": "Updates an object of type dimensionLine in Dynamics 365 Business Central", "operationId": "patchDimensionLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "dimensionLine_parentId", "in": "path", "description": "(v1.0) parentId for dimensionLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "dimensionLine_id", "in": "path", "description": "(v1.0) id for dimensionLine", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dimensionLine1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifieddimensionLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dimensionLine" } } } } }, "deprecated": false } }, "/companies({company_id})/paymentTerms": { "get": { "tags": [ "paymentTerm" ], "summary": "listPaymentTerms", "description": "Returns a list of paymentTerms", "operationId": "listPaymentTerms", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select86" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of paymentTerms", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIPaymentTermsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "paymentTerm" ], "summary": "postPaymentTerm", "description": "Creates an object of type paymentTerm in Dynamics 365 Business Central", "operationId": "postPaymentTerm", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentTerm" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new paymentTerm has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentTerm" } } } } }, "deprecated": false } }, "/companies({company_id})/paymentTerms({paymentTerm_id})": { "get": { "tags": [ "paymentTerm" ], "summary": "getPaymentTerm", "description": "Retrieve the properties and relationships of an object of type paymentTerm for Dynamics 365 Business Central.", "operationId": "getPaymentTerm", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "paymentTerm_id", "in": "path", "description": "(v1.0) id for paymentTerm", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select86" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested paymentTerm", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentTerm" } } } } }, "deprecated": false }, "delete": { "tags": [ "paymentTerm" ], "summary": "deletePaymentTerm", "description": "Deletes an object of type paymentTerm in Dynamics 365 Business Central", "operationId": "deletePaymentTerm", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "paymentTerm_id", "in": "path", "description": "(v1.0) id for paymentTerm", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified paymentTerm", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "paymentTerm" ], "summary": "patchPaymentTerm", "description": "Updates an object of type paymentTerm in Dynamics 365 Business Central", "operationId": "patchPaymentTerm", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "paymentTerm_id", "in": "path", "description": "(v1.0) id for paymentTerm", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentTerm" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedpaymentTerm", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentTerm" } } } } }, "deprecated": false } }, "/companies({company_id})/shipmentMethods": { "get": { "tags": [ "shipmentMethod" ], "summary": "listShipmentMethods", "description": "Returns a list of shipmentMethods", "operationId": "listShipmentMethods", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select76" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of shipmentMethods", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIShipmentMethodsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "shipmentMethod" ], "summary": "postShipmentMethod", "description": "Creates an object of type shipmentMethod in Dynamics 365 Business Central", "operationId": "postShipmentMethod", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipmentMethod" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new shipmentMethod has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipmentMethod" } } } } }, "deprecated": false } }, "/companies({company_id})/shipmentMethods({shipmentMethod_id})": { "get": { "tags": [ "shipmentMethod" ], "summary": "getShipmentMethod", "description": "Retrieve the properties and relationships of an object of type shipmentMethod for Dynamics 365 Business Central.", "operationId": "getShipmentMethod", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "shipmentMethod_id", "in": "path", "description": "(v1.0) id for shipmentMethod", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select76" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested shipmentMethod", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipmentMethod" } } } } }, "deprecated": false }, "delete": { "tags": [ "shipmentMethod" ], "summary": "deleteShipmentMethod", "description": "Deletes an object of type shipmentMethod in Dynamics 365 Business Central", "operationId": "deleteShipmentMethod", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "shipmentMethod_id", "in": "path", "description": "(v1.0) id for shipmentMethod", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified shipmentMethod", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "shipmentMethod" ], "summary": "patchShipmentMethod", "description": "Updates an object of type shipmentMethod in Dynamics 365 Business Central", "operationId": "patchShipmentMethod", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "shipmentMethod_id", "in": "path", "description": "(v1.0) id for shipmentMethod", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipmentMethod" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedshipmentMethod", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/shipmentMethod" } } } } }, "deprecated": false } }, "/companies({company_id})/itemCategories": { "get": { "tags": [ "itemCategory" ], "summary": "listItemCategories", "description": "Returns a list of itemCategories", "operationId": "listItemCategories", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select76" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of itemCategories", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIItemCategoriesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "itemCategory" ], "summary": "postItemCategory", "description": "Creates an object of type itemCategory in Dynamics 365 Business Central", "operationId": "postItemCategory", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/itemCategory" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new itemCategory has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/itemCategory" } } } } }, "deprecated": false } }, "/companies({company_id})/itemCategories({itemCategory_id})": { "get": { "tags": [ "itemCategory" ], "summary": "getItemCategory", "description": "Retrieve the properties and relationships of an object of type itemCategory for Dynamics 365 Business Central.", "operationId": "getItemCategory", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "itemCategory_id", "in": "path", "description": "(v1.0) id for itemCategory", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select76" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested itemCategory", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/itemCategory" } } } } }, "deprecated": false }, "delete": { "tags": [ "itemCategory" ], "summary": "deleteItemCategory", "description": "Deletes an object of type itemCategory in Dynamics 365 Business Central", "operationId": "deleteItemCategory", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "itemCategory_id", "in": "path", "description": "(v1.0) id for itemCategory", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified itemCategory", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "itemCategory" ], "summary": "patchItemCategory", "description": "Updates an object of type itemCategory in Dynamics 365 Business Central", "operationId": "patchItemCategory", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "itemCategory_id", "in": "path", "description": "(v1.0) id for itemCategory", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/itemCategory" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifieditemCategory", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/itemCategory" } } } } }, "deprecated": false } }, "/companies({company_id})/cashFlowStatement": { "get": { "tags": [ "cashFlowStatement" ], "summary": "listCashFlowStatement", "description": "Returns a list of cashFlowStatement", "operationId": "listCashFlowStatement", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select92" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of cashFlowStatement", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPICashFlowStatementResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/cashFlowStatement({cashFlowStatement_lineNumber})": { "get": { "tags": [ "cashFlowStatement" ], "summary": "getCashFlowStatement", "description": "Retrieve the properties and relationships of an object of type cashFlowStatement for Dynamics 365 Business Central.", "operationId": "getCashFlowStatement", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "cashFlowStatement_lineNumber", "in": "path", "description": "(v1.0) lineNumber for cashFlowStatement", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select92" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested cashFlowStatement", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cashFlowStatement" } } } } }, "deprecated": false } }, "/companies({company_id})/countriesRegions": { "get": { "tags": [ "countryRegion" ], "summary": "listCountriesRegions", "description": "Returns a list of countriesRegions", "operationId": "listCountriesRegions", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select94" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of countriesRegions", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPICountriesRegionsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "countryRegion" ], "summary": "postCountryRegion", "description": "Creates an object of type countryRegion in Dynamics 365 Business Central", "operationId": "postCountryRegion", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/countryRegion" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new countryRegion has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/countryRegion" } } } } }, "deprecated": false } }, "/companies({company_id})/countriesRegions({countryRegion_id})": { "get": { "tags": [ "countryRegion" ], "summary": "getCountryRegion", "description": "Retrieve the properties and relationships of an object of type countryRegion for Dynamics 365 Business Central.", "operationId": "getCountryRegion", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "countryRegion_id", "in": "path", "description": "(v1.0) id for countryRegion", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select94" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested countryRegion", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/countryRegion" } } } } }, "deprecated": false }, "delete": { "tags": [ "countryRegion" ], "summary": "deleteCountryRegion", "description": "Deletes an object of type countryRegion in Dynamics 365 Business Central", "operationId": "deleteCountryRegion", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "countryRegion_id", "in": "path", "description": "(v1.0) id for countryRegion", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified countryRegion", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "countryRegion" ], "summary": "patchCountryRegion", "description": "Updates an object of type countryRegion in Dynamics 365 Business Central", "operationId": "patchCountryRegion", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "countryRegion_id", "in": "path", "description": "(v1.0) id for countryRegion", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/countryRegion" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedcountryRegion", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/countryRegion" } } } } }, "deprecated": false } }, "/companies({company_id})/salesOrders": { "get": { "tags": [ "salesOrder" ], "summary": "listSalesOrders", "description": "Returns a list of salesOrders", "operationId": "listSalesOrders", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand46" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select96" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of salesOrders", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesOrdersResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "salesOrder" ], "summary": "postSalesOrder", "description": "Creates an object of type salesOrder in Dynamics 365 Business Central", "operationId": "postSalesOrder", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrder1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new salesOrder has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrder" } } } } }, "deprecated": false } }, "/companies({company_id})/salesOrders({salesOrder_id})": { "get": { "tags": [ "salesOrder" ], "summary": "getSalesOrder", "description": "Retrieve the properties and relationships of an object of type salesOrder for Dynamics 365 Business Central.", "operationId": "getSalesOrder", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrder_id", "in": "path", "description": "(v1.0) id for salesOrder", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand46" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select96" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested salesOrder", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrder" } } } } }, "deprecated": false }, "delete": { "tags": [ "salesOrder" ], "summary": "deleteSalesOrder", "description": "Deletes an object of type salesOrder in Dynamics 365 Business Central", "operationId": "deleteSalesOrder", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrder_id", "in": "path", "description": "(v1.0) id for salesOrder", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified salesOrder", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "salesOrder" ], "summary": "patchSalesOrder", "description": "Updates an object of type salesOrder in Dynamics 365 Business Central", "operationId": "patchSalesOrder", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrder_id", "in": "path", "description": "(v1.0) id for salesOrder", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrder1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedsalesOrder", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrder" } } } } }, "deprecated": false } }, "/companies({company_id})/salesOrders({salesOrder_id})/Microsoft.NAV.shipAndInvoice": { "post": { "tags": [ "salesOrder" ], "summary": "shipAndInvoiceActionSalesOrders", "description": "Performs the shipAndInvoice action for salesOrders entity", "operationId": "shipAndInvoiceActionSalesOrders", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrder_id", "in": "path", "description": "(v1.0) id for salesOrder", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a shipAndInvoice action on the Dynamic 365 Business Central salesOrders entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesOrders({salesOrder_id})/salesOrderLines": { "get": { "tags": [ "salesOrderLine" ], "summary": "listSalesOrderLinesForSalesOrder", "description": "Returns a list of salesOrderLines", "operationId": "listSalesOrderLinesForSalesOrder", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrder_id", "in": "path", "description": "(v1.0) id for salesOrder", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select98" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of salesOrderLines", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesOrdersAPISalesOrderLinesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "salesOrderLine" ], "summary": "postSalesOrderLineForSalesOrder", "description": "Creates an object of type salesOrderLine in Dynamics 365 Business Central", "operationId": "postSalesOrderLineForSalesOrder", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrder_id", "in": "path", "description": "(v1.0) id for salesOrder", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrderLine1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new salesOrderLine has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrderLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesOrders({salesOrder_id})/salesOrderLines('{salesOrderLine_id}')": { "get": { "tags": [ "salesOrderLine" ], "summary": "getSalesOrderLineForSalesOrder", "description": "Retrieve the properties and relationships of an object of type salesOrderLine for Dynamics 365 Business Central.", "operationId": "getSalesOrderLineForSalesOrder", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrder_id", "in": "path", "description": "(v1.0) id for salesOrder", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrderLine_id", "in": "path", "description": "(v1.0) id for salesOrderLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select98" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested salesOrderLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrderLine" } } } } }, "deprecated": false }, "delete": { "tags": [ "salesOrderLine" ], "summary": "deleteSalesOrderLineForSalesOrder", "description": "Deletes an object of type salesOrderLine in Dynamics 365 Business Central", "operationId": "deleteSalesOrderLineForSalesOrder", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrder_id", "in": "path", "description": "(v1.0) id for salesOrder", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrderLine_id", "in": "path", "description": "(v1.0) id for salesOrderLine", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified salesOrderLine", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "salesOrderLine" ], "summary": "patchSalesOrderLineForSalesOrder", "description": "Updates an object of type salesOrderLine in Dynamics 365 Business Central", "operationId": "patchSalesOrderLineForSalesOrder", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrder_id", "in": "path", "description": "(v1.0) id for salesOrder", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrderLine_id", "in": "path", "description": "(v1.0) id for salesOrderLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrderLine1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedsalesOrderLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrderLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesOrderLines": { "get": { "tags": [ "salesOrderLine" ], "summary": "listSalesOrderLines", "description": "Returns a list of salesOrderLines", "operationId": "listSalesOrderLines", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select98" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of salesOrderLines", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesOrderLinesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "salesOrderLine" ], "summary": "postSalesOrderLine", "description": "Creates an object of type salesOrderLine in Dynamics 365 Business Central", "operationId": "postSalesOrderLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrderLine1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new salesOrderLine has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrderLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesOrderLines('{salesOrderLine_id}')": { "get": { "tags": [ "salesOrderLine" ], "summary": "getSalesOrderLine", "description": "Retrieve the properties and relationships of an object of type salesOrderLine for Dynamics 365 Business Central.", "operationId": "getSalesOrderLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrderLine_id", "in": "path", "description": "(v1.0) id for salesOrderLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select98" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested salesOrderLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrderLine" } } } } }, "deprecated": false }, "delete": { "tags": [ "salesOrderLine" ], "summary": "deleteSalesOrderLine", "description": "Deletes an object of type salesOrderLine in Dynamics 365 Business Central", "operationId": "deleteSalesOrderLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrderLine_id", "in": "path", "description": "(v1.0) id for salesOrderLine", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified salesOrderLine", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "salesOrderLine" ], "summary": "patchSalesOrderLine", "description": "Updates an object of type salesOrderLine in Dynamics 365 Business Central", "operationId": "patchSalesOrderLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesOrderLine_id", "in": "path", "description": "(v1.0) id for salesOrderLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrderLine1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedsalesOrderLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesOrderLine" } } } } }, "deprecated": false } }, "/companies({company_id})/retainedEarningsStatement": { "get": { "tags": [ "retainedEarningsStatement" ], "summary": "listRetainedEarningsStatement", "description": "Returns a list of retainedEarningsStatement", "operationId": "listRetainedEarningsStatement", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select92" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of retainedEarningsStatement", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIRetainedEarningsStatementResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/retainedEarningsStatement({retainedEarningsStatement_lineNumber})": { "get": { "tags": [ "retainedEarningsStatement" ], "summary": "getRetainedEarningsStatement", "description": "Retrieve the properties and relationships of an object of type retainedEarningsStatement for Dynamics 365 Business Central.", "operationId": "getRetainedEarningsStatement", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "retainedEarningsStatement_lineNumber", "in": "path", "description": "(v1.0) lineNumber for retainedEarningsStatement", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select92" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested retainedEarningsStatement", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retainedEarningsStatement" } } } } }, "deprecated": false } }, "/companies({company_id})/unitsOfMeasure": { "get": { "tags": [ "unitOfMeasure" ], "summary": "listUnitsOfMeasure", "description": "Returns a list of unitsOfMeasure", "operationId": "listUnitsOfMeasure", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select104" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of unitsOfMeasure", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIUnitsOfMeasureResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "unitOfMeasure" ], "summary": "postUnitOfMeasure", "description": "Creates an object of type unitOfMeasure in Dynamics 365 Business Central", "operationId": "postUnitOfMeasure", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unitOfMeasure" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new unitOfMeasure has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unitOfMeasure" } } } } }, "deprecated": false } }, "/companies({company_id})/unitsOfMeasure({unitOfMeasure_id})": { "get": { "tags": [ "unitOfMeasure" ], "summary": "getUnitOfMeasure", "description": "Retrieve the properties and relationships of an object of type unitOfMeasure for Dynamics 365 Business Central.", "operationId": "getUnitOfMeasure", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "unitOfMeasure_id", "in": "path", "description": "(v1.0) id for unitOfMeasure", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select104" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested unitOfMeasure", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unitOfMeasure" } } } } }, "deprecated": false }, "delete": { "tags": [ "unitOfMeasure" ], "summary": "deleteUnitOfMeasure", "description": "Deletes an object of type unitOfMeasure in Dynamics 365 Business Central", "operationId": "deleteUnitOfMeasure", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "unitOfMeasure_id", "in": "path", "description": "(v1.0) id for unitOfMeasure", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified unitOfMeasure", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "unitOfMeasure" ], "summary": "patchUnitOfMeasure", "description": "Updates an object of type unitOfMeasure in Dynamics 365 Business Central", "operationId": "patchUnitOfMeasure", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "unitOfMeasure_id", "in": "path", "description": "(v1.0) id for unitOfMeasure", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unitOfMeasure" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedunitOfMeasure", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unitOfMeasure" } } } } }, "deprecated": false } }, "/companies({company_id})/agedAccountsReceivable": { "get": { "tags": [ "agedAccountsReceivable" ], "summary": "listAgedAccountsReceivable", "description": "Returns a list of agedAccountsReceivable", "operationId": "listAgedAccountsReceivable", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select106" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of agedAccountsReceivable", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIAgedAccountsReceivableResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/agedAccountsReceivable({agedAccountsReceivable_customerId})": { "get": { "tags": [ "agedAccountsReceivable" ], "summary": "getAgedAccountsReceivable", "description": "Retrieve the properties and relationships of an object of type agedAccountsReceivable for Dynamics 365 Business Central.", "operationId": "getAgedAccountsReceivable", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "agedAccountsReceivable_customerId", "in": "path", "description": "(v1.0) customerId for agedAccountsReceivable", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select106" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested agedAccountsReceivable", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agedAccountsReceivable" } } } } }, "deprecated": false } }, "/companies({company_id})/agedAccountsPayable": { "get": { "tags": [ "agedAccountsPayable" ], "summary": "listAgedAccountsPayable", "description": "Returns a list of agedAccountsPayable", "operationId": "listAgedAccountsPayable", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select108" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of agedAccountsPayable", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIAgedAccountsPayableResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/agedAccountsPayable({agedAccountsPayable_vendorId})": { "get": { "tags": [ "agedAccountsPayable" ], "summary": "getAgedAccountsPayable", "description": "Retrieve the properties and relationships of an object of type agedAccountsPayable for Dynamics 365 Business Central.", "operationId": "getAgedAccountsPayable", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "agedAccountsPayable_vendorId", "in": "path", "description": "(v1.0) vendorId for agedAccountsPayable", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select108" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested agedAccountsPayable", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/agedAccountsPayable" } } } } }, "deprecated": false } }, "/companies({company_id})/balanceSheet": { "get": { "tags": [ "balanceSheet" ], "summary": "listBalanceSheet", "description": "Returns a list of balanceSheet", "operationId": "listBalanceSheet", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select110" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of balanceSheet", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIBalanceSheetResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/balanceSheet({balanceSheet_lineNumber})": { "get": { "tags": [ "balanceSheet" ], "summary": "getBalanceSheet", "description": "Retrieve the properties and relationships of an object of type balanceSheet for Dynamics 365 Business Central.", "operationId": "getBalanceSheet", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "balanceSheet_lineNumber", "in": "path", "description": "(v1.0) lineNumber for balanceSheet", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select110" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested balanceSheet", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/balanceSheet" } } } } }, "deprecated": false } }, "/companies({company_id})/trialBalance": { "get": { "tags": [ "trialBalance" ], "summary": "listTrialBalance", "description": "Returns a list of trialBalance", "operationId": "listTrialBalance", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand40" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select112" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of trialBalance", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPITrialBalanceResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/trialBalance('{trialBalance_number}')": { "get": { "tags": [ "trialBalance" ], "summary": "getTrialBalance", "description": "Retrieve the properties and relationships of an object of type trialBalance for Dynamics 365 Business Central.", "operationId": "getTrialBalance", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "trialBalance_number", "in": "path", "description": "(v1.0) number for trialBalance", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand40" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select112" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested trialBalance", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialBalance" } } } } }, "deprecated": false } }, "/companies({company_id})/incomeStatement": { "get": { "tags": [ "incomeStatement" ], "summary": "listIncomeStatement", "description": "Returns a list of incomeStatement", "operationId": "listIncomeStatement", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select92" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of incomeStatement", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIIncomeStatementResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/incomeStatement({incomeStatement_lineNumber})": { "get": { "tags": [ "incomeStatement" ], "summary": "getIncomeStatement", "description": "Retrieve the properties and relationships of an object of type incomeStatement for Dynamics 365 Business Central.", "operationId": "getIncomeStatement", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "incomeStatement_lineNumber", "in": "path", "description": "(v1.0) lineNumber for incomeStatement", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select92" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested incomeStatement", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/incomeStatement" } } } } }, "deprecated": false } }, "/companies({company_id})/taxAreas": { "get": { "tags": [ "taxArea" ], "summary": "listTaxAreas", "description": "Returns a list of taxAreas", "operationId": "listTaxAreas", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select48" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of taxAreas", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPITaxAreasResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "taxArea" ], "summary": "postTaxArea", "description": "Creates an object of type taxArea in Dynamics 365 Business Central", "operationId": "postTaxArea", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxArea" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new taxArea has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxArea" } } } } }, "deprecated": false } }, "/companies({company_id})/taxAreas({taxArea_id})": { "get": { "tags": [ "taxArea" ], "summary": "getTaxArea", "description": "Retrieve the properties and relationships of an object of type taxArea for Dynamics 365 Business Central.", "operationId": "getTaxArea", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "taxArea_id", "in": "path", "description": "(v1.0) id for taxArea", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select48" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested taxArea", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxArea" } } } } }, "deprecated": false }, "delete": { "tags": [ "taxArea" ], "summary": "deleteTaxArea", "description": "Deletes an object of type taxArea in Dynamics 365 Business Central", "operationId": "deleteTaxArea", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "taxArea_id", "in": "path", "description": "(v1.0) id for taxArea", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified taxArea", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "taxArea" ], "summary": "patchTaxArea", "description": "Updates an object of type taxArea in Dynamics 365 Business Central", "operationId": "patchTaxArea", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "taxArea_id", "in": "path", "description": "(v1.0) id for taxArea", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxArea" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedtaxArea", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxArea" } } } } }, "deprecated": false } }, "/companies({company_id})/salesQuotes": { "get": { "tags": [ "salesQuote" ], "summary": "listSalesQuotes", "description": "Returns a list of salesQuotes", "operationId": "listSalesQuotes", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand54" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select118" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of salesQuotes", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesQuotesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "salesQuote" ], "summary": "postSalesQuote", "description": "Creates an object of type salesQuote in Dynamics 365 Business Central", "operationId": "postSalesQuote", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuote1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new salesQuote has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuote" } } } } }, "deprecated": false } }, "/companies({company_id})/salesQuotes({salesQuote_id})": { "get": { "tags": [ "salesQuote" ], "summary": "getSalesQuote", "description": "Retrieve the properties and relationships of an object of type salesQuote for Dynamics 365 Business Central.", "operationId": "getSalesQuote", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuote_id", "in": "path", "description": "(v1.0) id for salesQuote", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand54" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select118" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested salesQuote", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuote" } } } } }, "deprecated": false }, "delete": { "tags": [ "salesQuote" ], "summary": "deleteSalesQuote", "description": "Deletes an object of type salesQuote in Dynamics 365 Business Central", "operationId": "deleteSalesQuote", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuote_id", "in": "path", "description": "(v1.0) id for salesQuote", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified salesQuote", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "salesQuote" ], "summary": "patchSalesQuote", "description": "Updates an object of type salesQuote in Dynamics 365 Business Central", "operationId": "patchSalesQuote", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuote_id", "in": "path", "description": "(v1.0) id for salesQuote", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuote1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedsalesQuote", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuote" } } } } }, "deprecated": false } }, "/companies({company_id})/salesQuotes({salesQuote_id})/Microsoft.NAV.makeInvoice": { "post": { "tags": [ "salesQuote" ], "summary": "makeInvoiceActionSalesQuotes", "description": "Performs the makeInvoice action for salesQuotes entity", "operationId": "makeInvoiceActionSalesQuotes", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuote_id", "in": "path", "description": "(v1.0) id for salesQuote", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a makeInvoice action on the Dynamic 365 Business Central salesQuotes entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesQuotes({salesQuote_id})/Microsoft.NAV.makeOrder": { "post": { "tags": [ "salesQuote" ], "summary": "makeOrderActionSalesQuotes", "description": "Performs the makeOrder action for salesQuotes entity", "operationId": "makeOrderActionSalesQuotes", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuote_id", "in": "path", "description": "(v1.0) id for salesQuote", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a makeOrder action on the Dynamic 365 Business Central salesQuotes entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesQuotes({salesQuote_id})/Microsoft.NAV.send": { "post": { "tags": [ "salesQuote" ], "summary": "sendActionSalesQuotes", "description": "Performs the send action for salesQuotes entity", "operationId": "sendActionSalesQuotes", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuote_id", "in": "path", "description": "(v1.0) id for salesQuote", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a send action on the Dynamic 365 Business Central salesQuotes entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesQuotes({salesQuote_id})/salesQuoteLines": { "get": { "tags": [ "salesQuoteLine" ], "summary": "listSalesQuoteLinesForSalesQuote", "description": "Returns a list of salesQuoteLines", "operationId": "listSalesQuoteLinesForSalesQuote", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuote_id", "in": "path", "description": "(v1.0) id for salesQuote", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select120" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of salesQuoteLines", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesQuotesAPISalesQuoteLinesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "salesQuoteLine" ], "summary": "postSalesQuoteLineForSalesQuote", "description": "Creates an object of type salesQuoteLine in Dynamics 365 Business Central", "operationId": "postSalesQuoteLineForSalesQuote", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuote_id", "in": "path", "description": "(v1.0) id for salesQuote", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuoteLine1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new salesQuoteLine has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuoteLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesQuotes({salesQuote_id})/salesQuoteLines('{salesQuoteLine_id}')": { "get": { "tags": [ "salesQuoteLine" ], "summary": "getSalesQuoteLineForSalesQuote", "description": "Retrieve the properties and relationships of an object of type salesQuoteLine for Dynamics 365 Business Central.", "operationId": "getSalesQuoteLineForSalesQuote", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuote_id", "in": "path", "description": "(v1.0) id for salesQuote", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuoteLine_id", "in": "path", "description": "(v1.0) id for salesQuoteLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select120" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested salesQuoteLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuoteLine" } } } } }, "deprecated": false }, "delete": { "tags": [ "salesQuoteLine" ], "summary": "deleteSalesQuoteLineForSalesQuote", "description": "Deletes an object of type salesQuoteLine in Dynamics 365 Business Central", "operationId": "deleteSalesQuoteLineForSalesQuote", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuote_id", "in": "path", "description": "(v1.0) id for salesQuote", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuoteLine_id", "in": "path", "description": "(v1.0) id for salesQuoteLine", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified salesQuoteLine", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "salesQuoteLine" ], "summary": "patchSalesQuoteLineForSalesQuote", "description": "Updates an object of type salesQuoteLine in Dynamics 365 Business Central", "operationId": "patchSalesQuoteLineForSalesQuote", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuote_id", "in": "path", "description": "(v1.0) id for salesQuote", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuoteLine_id", "in": "path", "description": "(v1.0) id for salesQuoteLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuoteLine1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedsalesQuoteLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuoteLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesQuoteLines": { "get": { "tags": [ "salesQuoteLine" ], "summary": "listSalesQuoteLines", "description": "Returns a list of salesQuoteLines", "operationId": "listSalesQuoteLines", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select120" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of salesQuoteLines", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesQuoteLinesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "salesQuoteLine" ], "summary": "postSalesQuoteLine", "description": "Creates an object of type salesQuoteLine in Dynamics 365 Business Central", "operationId": "postSalesQuoteLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuoteLine1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new salesQuoteLine has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuoteLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesQuoteLines('{salesQuoteLine_id}')": { "get": { "tags": [ "salesQuoteLine" ], "summary": "getSalesQuoteLine", "description": "Retrieve the properties and relationships of an object of type salesQuoteLine for Dynamics 365 Business Central.", "operationId": "getSalesQuoteLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuoteLine_id", "in": "path", "description": "(v1.0) id for salesQuoteLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select120" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested salesQuoteLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuoteLine" } } } } }, "deprecated": false }, "delete": { "tags": [ "salesQuoteLine" ], "summary": "deleteSalesQuoteLine", "description": "Deletes an object of type salesQuoteLine in Dynamics 365 Business Central", "operationId": "deleteSalesQuoteLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuoteLine_id", "in": "path", "description": "(v1.0) id for salesQuoteLine", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified salesQuoteLine", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "salesQuoteLine" ], "summary": "patchSalesQuoteLine", "description": "Updates an object of type salesQuoteLine in Dynamics 365 Business Central", "operationId": "patchSalesQuoteLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesQuoteLine_id", "in": "path", "description": "(v1.0) id for salesQuoteLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuoteLine1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedsalesQuoteLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesQuoteLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesCreditMemos": { "get": { "tags": [ "salesCreditMemo" ], "summary": "listSalesCreditMemos", "description": "Returns a list of salesCreditMemos", "operationId": "listSalesCreditMemos", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand60" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select126" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of salesCreditMemos", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesCreditMemosResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "salesCreditMemo" ], "summary": "postSalesCreditMemo", "description": "Creates an object of type salesCreditMemo in Dynamics 365 Business Central", "operationId": "postSalesCreditMemo", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemo1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new salesCreditMemo has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemo" } } } } }, "deprecated": false } }, "/companies({company_id})/salesCreditMemos({salesCreditMemo_id})": { "get": { "tags": [ "salesCreditMemo" ], "summary": "getSalesCreditMemo", "description": "Retrieve the properties and relationships of an object of type salesCreditMemo for Dynamics 365 Business Central.", "operationId": "getSalesCreditMemo", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand60" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select126" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested salesCreditMemo", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemo" } } } } }, "deprecated": false }, "delete": { "tags": [ "salesCreditMemo" ], "summary": "deleteSalesCreditMemo", "description": "Deletes an object of type salesCreditMemo in Dynamics 365 Business Central", "operationId": "deleteSalesCreditMemo", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified salesCreditMemo", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "salesCreditMemo" ], "summary": "patchSalesCreditMemo", "description": "Updates an object of type salesCreditMemo in Dynamics 365 Business Central", "operationId": "patchSalesCreditMemo", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemo1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedsalesCreditMemo", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemo" } } } } }, "deprecated": false } }, "/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.cancelAndSend": { "post": { "tags": [ "salesCreditMemo" ], "summary": "cancelAndSendActionSalesCreditMemos", "description": "Performs the cancelAndSend action for salesCreditMemos entity", "operationId": "cancelAndSendActionSalesCreditMemos", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a cancelAndSend action on the Dynamic 365 Business Central salesCreditMemos entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.cancel": { "post": { "tags": [ "salesCreditMemo" ], "summary": "cancelActionSalesCreditMemos", "description": "Performs the cancel action for salesCreditMemos entity", "operationId": "cancelActionSalesCreditMemos", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a cancel action on the Dynamic 365 Business Central salesCreditMemos entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.postAndSend": { "post": { "tags": [ "salesCreditMemo" ], "summary": "postAndSendActionSalesCreditMemos", "description": "Performs the postAndSend action for salesCreditMemos entity", "operationId": "postAndSendActionSalesCreditMemos", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a postAndSend action on the Dynamic 365 Business Central salesCreditMemos entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.post": { "post": { "tags": [ "salesCreditMemo" ], "summary": "postActionSalesCreditMemos", "description": "Performs the post action for salesCreditMemos entity", "operationId": "postActionSalesCreditMemos", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a post action on the Dynamic 365 Business Central salesCreditMemos entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/Microsoft.NAV.send": { "post": { "tags": [ "salesCreditMemo" ], "summary": "sendActionSalesCreditMemos", "description": "Performs the send action for salesCreditMemos entity", "operationId": "sendActionSalesCreditMemos", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a send action on the Dynamic 365 Business Central salesCreditMemos entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/salesCreditMemoLines": { "get": { "tags": [ "salesCreditMemoLine" ], "summary": "listSalesCreditMemoLinesForSalesCreditMemo", "description": "Returns a list of salesCreditMemoLines", "operationId": "listSalesCreditMemoLinesForSalesCreditMemo", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select32" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of salesCreditMemoLines", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesCreditMemosAPISalesCreditMemoLinesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "salesCreditMemoLine" ], "summary": "postSalesCreditMemoLineForSalesCreditMemo", "description": "Creates an object of type salesCreditMemoLine in Dynamics 365 Business Central", "operationId": "postSalesCreditMemoLineForSalesCreditMemo", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemoLine1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new salesCreditMemoLine has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemoLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesCreditMemos({salesCreditMemo_id})/salesCreditMemoLines('{salesCreditMemoLine_id}')": { "get": { "tags": [ "salesCreditMemoLine" ], "summary": "getSalesCreditMemoLineForSalesCreditMemo", "description": "Retrieve the properties and relationships of an object of type salesCreditMemoLine for Dynamics 365 Business Central.", "operationId": "getSalesCreditMemoLineForSalesCreditMemo", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemoLine_id", "in": "path", "description": "(v1.0) id for salesCreditMemoLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select32" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested salesCreditMemoLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemoLine" } } } } }, "deprecated": false }, "delete": { "tags": [ "salesCreditMemoLine" ], "summary": "deleteSalesCreditMemoLineForSalesCreditMemo", "description": "Deletes an object of type salesCreditMemoLine in Dynamics 365 Business Central", "operationId": "deleteSalesCreditMemoLineForSalesCreditMemo", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemoLine_id", "in": "path", "description": "(v1.0) id for salesCreditMemoLine", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified salesCreditMemoLine", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "salesCreditMemoLine" ], "summary": "patchSalesCreditMemoLineForSalesCreditMemo", "description": "Updates an object of type salesCreditMemoLine in Dynamics 365 Business Central", "operationId": "patchSalesCreditMemoLineForSalesCreditMemo", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemo_id", "in": "path", "description": "(v1.0) id for salesCreditMemo", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemoLine_id", "in": "path", "description": "(v1.0) id for salesCreditMemoLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemoLine1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedsalesCreditMemoLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemoLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesCreditMemoLines": { "get": { "tags": [ "salesCreditMemoLine" ], "summary": "listSalesCreditMemoLines", "description": "Returns a list of salesCreditMemoLines", "operationId": "listSalesCreditMemoLines", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select32" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of salesCreditMemoLines", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPISalesCreditMemoLinesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "salesCreditMemoLine" ], "summary": "postSalesCreditMemoLine", "description": "Creates an object of type salesCreditMemoLine in Dynamics 365 Business Central", "operationId": "postSalesCreditMemoLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemoLine1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new salesCreditMemoLine has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemoLine" } } } } }, "deprecated": false } }, "/companies({company_id})/salesCreditMemoLines('{salesCreditMemoLine_id}')": { "get": { "tags": [ "salesCreditMemoLine" ], "summary": "getSalesCreditMemoLine", "description": "Retrieve the properties and relationships of an object of type salesCreditMemoLine for Dynamics 365 Business Central.", "operationId": "getSalesCreditMemoLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemoLine_id", "in": "path", "description": "(v1.0) id for salesCreditMemoLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select32" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested salesCreditMemoLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemoLine" } } } } }, "deprecated": false }, "delete": { "tags": [ "salesCreditMemoLine" ], "summary": "deleteSalesCreditMemoLine", "description": "Deletes an object of type salesCreditMemoLine in Dynamics 365 Business Central", "operationId": "deleteSalesCreditMemoLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemoLine_id", "in": "path", "description": "(v1.0) id for salesCreditMemoLine", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified salesCreditMemoLine", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "salesCreditMemoLine" ], "summary": "patchSalesCreditMemoLine", "description": "Updates an object of type salesCreditMemoLine in Dynamics 365 Business Central", "operationId": "patchSalesCreditMemoLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "salesCreditMemoLine_id", "in": "path", "description": "(v1.0) id for salesCreditMemoLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemoLine1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedsalesCreditMemoLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/salesCreditMemoLine" } } } } }, "deprecated": false } }, "/companies({company_id})/generalLedgerEntryAttachments": { "get": { "tags": [ "generalLedgerEntryAttachments" ], "summary": "listGeneralLedgerEntryAttachments", "description": "Returns a list of generalLedgerEntryAttachments", "operationId": "listGeneralLedgerEntryAttachments", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand66" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select134" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of generalLedgerEntryAttachments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIGeneralLedgerEntryAttachmentsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "generalLedgerEntryAttachments" ], "summary": "postGeneralLedgerEntryAttachments", "description": "Creates an object of type generalLedgerEntryAttachments in Dynamics 365 Business Central", "operationId": "postGeneralLedgerEntryAttachments", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generalLedgerEntryAttachments1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new generalLedgerEntryAttachments has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generalLedgerEntryAttachments" } } } } }, "deprecated": false } }, "/companies({company_id})/generalLedgerEntryAttachments({generalLedgerEntryAttachments_generalLedgerEntryNumber},{generalLedgerEntryAttachments_id})": { "get": { "tags": [ "generalLedgerEntryAttachments" ], "summary": "getGeneralLedgerEntryAttachments", "description": "Retrieve the properties and relationships of an object of type generalLedgerEntryAttachments for Dynamics 365 Business Central.", "operationId": "getGeneralLedgerEntryAttachments", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "generalLedgerEntryAttachments_generalLedgerEntryNumber", "in": "path", "description": "(v1.0) generalLedgerEntryNumber for generalLedgerEntryAttachments", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "generalLedgerEntryAttachments_id", "in": "path", "description": "(v1.0) id for generalLedgerEntryAttachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand66" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select134" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested generalLedgerEntryAttachments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generalLedgerEntryAttachments" } } } } }, "deprecated": false }, "delete": { "tags": [ "generalLedgerEntryAttachments" ], "summary": "deleteGeneralLedgerEntryAttachments", "description": "Deletes an object of type generalLedgerEntryAttachments in Dynamics 365 Business Central", "operationId": "deleteGeneralLedgerEntryAttachments", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "generalLedgerEntryAttachments_generalLedgerEntryNumber", "in": "path", "description": "(v1.0) generalLedgerEntryNumber for generalLedgerEntryAttachments", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "generalLedgerEntryAttachments_id", "in": "path", "description": "(v1.0) id for generalLedgerEntryAttachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified generalLedgerEntryAttachments", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "generalLedgerEntryAttachments" ], "summary": "patchGeneralLedgerEntryAttachments", "description": "Updates an object of type generalLedgerEntryAttachments in Dynamics 365 Business Central", "operationId": "patchGeneralLedgerEntryAttachments", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "generalLedgerEntryAttachments_generalLedgerEntryNumber", "in": "path", "description": "(v1.0) generalLedgerEntryNumber for generalLedgerEntryAttachments", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } }, { "name": "generalLedgerEntryAttachments_id", "in": "path", "description": "(v1.0) id for generalLedgerEntryAttachments", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generalLedgerEntryAttachments1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedgeneralLedgerEntryAttachments", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generalLedgerEntryAttachments" } } } } }, "deprecated": false } }, "/companies({company_id})/purchaseInvoices": { "get": { "tags": [ "purchaseInvoice" ], "summary": "listPurchaseInvoices", "description": "Returns a list of purchaseInvoices", "operationId": "listPurchaseInvoices", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand68" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select136" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of purchaseInvoices", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIPurchaseInvoicesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "purchaseInvoice" ], "summary": "postPurchaseInvoice", "description": "Creates an object of type purchaseInvoice in Dynamics 365 Business Central", "operationId": "postPurchaseInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoice1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new purchaseInvoice has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoice" } } } } }, "deprecated": false } }, "/companies({company_id})/purchaseInvoices({purchaseInvoice_id})": { "get": { "tags": [ "purchaseInvoice" ], "summary": "getPurchaseInvoice", "description": "Retrieve the properties and relationships of an object of type purchaseInvoice for Dynamics 365 Business Central.", "operationId": "getPurchaseInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoice_id", "in": "path", "description": "(v1.0) id for purchaseInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand68" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select136" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested purchaseInvoice", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoice" } } } } }, "deprecated": false }, "delete": { "tags": [ "purchaseInvoice" ], "summary": "deletePurchaseInvoice", "description": "Deletes an object of type purchaseInvoice in Dynamics 365 Business Central", "operationId": "deletePurchaseInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoice_id", "in": "path", "description": "(v1.0) id for purchaseInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified purchaseInvoice", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "purchaseInvoice" ], "summary": "patchPurchaseInvoice", "description": "Updates an object of type purchaseInvoice in Dynamics 365 Business Central", "operationId": "patchPurchaseInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoice_id", "in": "path", "description": "(v1.0) id for purchaseInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoice1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedpurchaseInvoice", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoice" } } } } }, "deprecated": false } }, "/companies({company_id})/purchaseInvoices({purchaseInvoice_id})/Microsoft.NAV.post": { "post": { "tags": [ "purchaseInvoice" ], "summary": "postActionPurchaseInvoices", "description": "Performs the post action for purchaseInvoices entity", "operationId": "postActionPurchaseInvoices", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoice_id", "in": "path", "description": "(v1.0) id for purchaseInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully performed a post action on the Dynamic 365 Business Central purchaseInvoices entity", "headers": {}, "content": {} } }, "deprecated": false } }, "/companies({company_id})/purchaseInvoices({purchaseInvoice_id})/purchaseInvoiceLines": { "get": { "tags": [ "purchaseInvoiceLine" ], "summary": "listPurchaseInvoiceLinesForPurchaseInvoice", "description": "Returns a list of purchaseInvoiceLines", "operationId": "listPurchaseInvoiceLinesForPurchaseInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoice_id", "in": "path", "description": "(v1.0) id for purchaseInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select138" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of purchaseInvoiceLines", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIPurchaseInvoicesAPIPurchaseInvoiceLinesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "purchaseInvoiceLine" ], "summary": "postPurchaseInvoiceLineForPurchaseInvoice", "description": "Creates an object of type purchaseInvoiceLine in Dynamics 365 Business Central", "operationId": "postPurchaseInvoiceLineForPurchaseInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoice_id", "in": "path", "description": "(v1.0) id for purchaseInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoiceLine1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new purchaseInvoiceLine has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoiceLine" } } } } }, "deprecated": false } }, "/companies({company_id})/purchaseInvoices({purchaseInvoice_id})/purchaseInvoiceLines('{purchaseInvoiceLine_id}')": { "get": { "tags": [ "purchaseInvoiceLine" ], "summary": "getPurchaseInvoiceLineForPurchaseInvoice", "description": "Retrieve the properties and relationships of an object of type purchaseInvoiceLine for Dynamics 365 Business Central.", "operationId": "getPurchaseInvoiceLineForPurchaseInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoice_id", "in": "path", "description": "(v1.0) id for purchaseInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoiceLine_id", "in": "path", "description": "(v1.0) id for purchaseInvoiceLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select138" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested purchaseInvoiceLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoiceLine" } } } } }, "deprecated": false }, "delete": { "tags": [ "purchaseInvoiceLine" ], "summary": "deletePurchaseInvoiceLineForPurchaseInvoice", "description": "Deletes an object of type purchaseInvoiceLine in Dynamics 365 Business Central", "operationId": "deletePurchaseInvoiceLineForPurchaseInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoice_id", "in": "path", "description": "(v1.0) id for purchaseInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoiceLine_id", "in": "path", "description": "(v1.0) id for purchaseInvoiceLine", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified purchaseInvoiceLine", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "purchaseInvoiceLine" ], "summary": "patchPurchaseInvoiceLineForPurchaseInvoice", "description": "Updates an object of type purchaseInvoiceLine in Dynamics 365 Business Central", "operationId": "patchPurchaseInvoiceLineForPurchaseInvoice", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoice_id", "in": "path", "description": "(v1.0) id for purchaseInvoice", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoiceLine_id", "in": "path", "description": "(v1.0) id for purchaseInvoiceLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoiceLine1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedpurchaseInvoiceLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoiceLine" } } } } }, "deprecated": false } }, "/companies({company_id})/purchaseInvoiceLines": { "get": { "tags": [ "purchaseInvoiceLine" ], "summary": "listPurchaseInvoiceLines", "description": "Returns a list of purchaseInvoiceLines", "operationId": "listPurchaseInvoiceLines", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select138" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of purchaseInvoiceLines", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIPurchaseInvoiceLinesResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "purchaseInvoiceLine" ], "summary": "postPurchaseInvoiceLine", "description": "Creates an object of type purchaseInvoiceLine in Dynamics 365 Business Central", "operationId": "postPurchaseInvoiceLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoiceLine1" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new purchaseInvoiceLine has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoiceLine" } } } } }, "deprecated": false } }, "/companies({company_id})/purchaseInvoiceLines('{purchaseInvoiceLine_id}')": { "get": { "tags": [ "purchaseInvoiceLine" ], "summary": "getPurchaseInvoiceLine", "description": "Retrieve the properties and relationships of an object of type purchaseInvoiceLine for Dynamics 365 Business Central.", "operationId": "getPurchaseInvoiceLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoiceLine_id", "in": "path", "description": "(v1.0) id for purchaseInvoiceLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "$expand", "in": "query", "description": "(v1.0) Entities to expand", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/expand16" } } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select138" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested purchaseInvoiceLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoiceLine" } } } } }, "deprecated": false }, "delete": { "tags": [ "purchaseInvoiceLine" ], "summary": "deletePurchaseInvoiceLine", "description": "Deletes an object of type purchaseInvoiceLine in Dynamics 365 Business Central", "operationId": "deletePurchaseInvoiceLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoiceLine_id", "in": "path", "description": "(v1.0) id for purchaseInvoiceLine", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified purchaseInvoiceLine", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "purchaseInvoiceLine" ], "summary": "patchPurchaseInvoiceLine", "description": "Updates an object of type purchaseInvoiceLine in Dynamics 365 Business Central", "operationId": "patchPurchaseInvoiceLine", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "purchaseInvoiceLine_id", "in": "path", "description": "(v1.0) id for purchaseInvoiceLine", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoiceLine1" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedpurchaseInvoiceLine", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/purchaseInvoiceLine" } } } } }, "deprecated": false } }, "/companies({company_id})/projects": { "get": { "tags": [ "project" ], "summary": "listProjects", "description": "Returns a list of projects", "operationId": "listProjects", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select144" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of projects", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIProjectsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "project" ], "summary": "postProject", "description": "Creates an object of type project in Dynamics 365 Business Central", "operationId": "postProject", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new project has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project" } } } } }, "deprecated": false } }, "/companies({company_id})/projects({project_id})": { "get": { "tags": [ "project" ], "summary": "getProject", "description": "Retrieve the properties and relationships of an object of type project for Dynamics 365 Business Central.", "operationId": "getProject", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "project_id", "in": "path", "description": "(v1.0) id for project", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select144" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested project", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project" } } } } }, "deprecated": false }, "delete": { "tags": [ "project" ], "summary": "deleteProject", "description": "Deletes an object of type project in Dynamics 365 Business Central", "operationId": "deleteProject", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "project_id", "in": "path", "description": "(v1.0) id for project", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified project", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "project" ], "summary": "patchProject", "description": "Updates an object of type project in Dynamics 365 Business Central", "operationId": "patchProject", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "project_id", "in": "path", "description": "(v1.0) id for project", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedproject", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/project" } } } } }, "deprecated": false } }, "/companies({company_id})/bankAccounts": { "get": { "tags": [ "bankAccount" ], "summary": "listBankAccounts", "description": "Returns a list of bankAccounts", "operationId": "listBankAccounts", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select144" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of bankAccounts", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIBankAccountsResponse" } } } } }, "deprecated": false }, "post": { "tags": [ "bankAccount" ], "summary": "postBankAccount", "description": "Creates an object of type bankAccount in Dynamics 365 Business Central", "operationId": "postBankAccount", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bankAccount" } } }, "required": true }, "responses": { "201": { "description": "(v1.0) A new bankAccount has been succesfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bankAccount" } } } } }, "deprecated": false } }, "/companies({company_id})/bankAccounts({bankAccount_id})": { "get": { "tags": [ "bankAccount" ], "summary": "getBankAccount", "description": "Retrieve the properties and relationships of an object of type bankAccount for Dynamics 365 Business Central.", "operationId": "getBankAccount", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "bankAccount_id", "in": "path", "description": "(v1.0) id for bankAccount", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select144" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested bankAccount", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bankAccount" } } } } }, "deprecated": false }, "delete": { "tags": [ "bankAccount" ], "summary": "deleteBankAccount", "description": "Deletes an object of type bankAccount in Dynamics 365 Business Central", "operationId": "deleteBankAccount", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "bankAccount_id", "in": "path", "description": "(v1.0) id for bankAccount", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "(v1.0) Succesfully deleted the specified bankAccount", "headers": {}, "content": {} } }, "deprecated": false }, "patch": { "tags": [ "bankAccount" ], "summary": "patchBankAccount", "description": "Updates an object of type bankAccount in Dynamics 365 Business Central", "operationId": "patchBankAccount", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "bankAccount_id", "in": "path", "description": "(v1.0) id for bankAccount", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "If-Match", "in": "header", "description": "(v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bankAccount" } } }, "required": true }, "responses": { "200": { "description": "(v1.0) Succesfully updated the specifiedbankAccount", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bankAccount" } } } } }, "deprecated": false } }, "/companies({company_id})/customerSales": { "get": { "tags": [ "customerSale" ], "summary": "listCustomerSales", "description": "Returns a list of customerSales", "operationId": "listCustomerSales", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select148" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of customerSales", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPICustomerSalesResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/customerSales({customerSale_customerId},'{customerSale_customerNumber}','{customerSale_name}')": { "get": { "tags": [ "customerSale" ], "summary": "getCustomerSale", "description": "Retrieve the properties and relationships of an object of type customerSale for Dynamics 365 Business Central.", "operationId": "getCustomerSale", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerSale_customerId", "in": "path", "description": "(v1.0) customerId for customerSale", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "customerSale_customerNumber", "in": "path", "description": "(v1.0) customerNumber for customerSale", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "customerSale_name", "in": "path", "description": "(v1.0) name for customerSale", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select148" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested customerSale", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/customerSale" } } } } }, "deprecated": false } }, "/companies({company_id})/vendorPurchases": { "get": { "tags": [ "vendorPurchase" ], "summary": "listVendorPurchases", "description": "Returns a list of vendorPurchases", "operationId": "listVendorPurchases", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "$top", "in": "query", "description": "(v1.0) Number of items to return from the top of the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$skip", "in": "query", "description": "(v1.0) Number of items to skip from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$limit", "in": "query", "description": "(v1.0) Number of items to return from the list", "style": "form", "explode": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "$filter", "in": "query", "description": "(v1.0) Filtering expression", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select150" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned a list of vendorPurchases", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesAPIVendorPurchasesResponse" } } } } }, "deprecated": false } }, "/companies({company_id})/vendorPurchases({vendorPurchase_vendorId},'{vendorPurchase_vendorNumber}','{vendorPurchase_name}')": { "get": { "tags": [ "vendorPurchase" ], "summary": "getVendorPurchase", "description": "Retrieve the properties and relationships of an object of type vendorPurchase for Dynamics 365 Business Central.", "operationId": "getVendorPurchase", "parameters": [ { "name": "company_id", "in": "path", "description": "(v1.0) id for company", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendorPurchase_vendorId", "in": "path", "description": "(v1.0) vendorId for vendorPurchase", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, { "name": "vendorPurchase_vendorNumber", "in": "path", "description": "(v1.0) vendorNumber for vendorPurchase", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "vendorPurchase_name", "in": "path", "description": "(v1.0) name for vendorPurchase", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "$select", "in": "query", "description": "(v1.0) Selected properties to be retrieved", "style": "form", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/select150" } } } ], "responses": { "200": { "description": "(v1.0) Succesfully returned the requested vendorPurchase", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/vendorPurchase" } } } } }, "deprecated": false } } }, "components": { "schemas": { "taxArea": { "title": "taxArea", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central taxArea entity", "format": "uuid" }, "code": { "maxLength": 20, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central taxArea entity", "nullable": true }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central taxArea entity", "nullable": true }, "taxType": { "type": "string", "description": "(v1.0) The taxType property for the Dynamics 365 Business Central taxArea entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central taxArea entity", "format": "date-time", "nullable": true } } }, "paymentMethod": { "title": "paymentMethod", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central paymentMethod entity", "format": "uuid" }, "code": { "maxLength": 10, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central paymentMethod entity" }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central paymentMethod entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central paymentMethod entity", "format": "date-time", "nullable": true } } }, "salesQuote": { "title": "salesQuote", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesQuote entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "externalDocumentNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "documentDate": { "type": "string", "description": "(v1.0) The documentDate property for the Dynamics 365 Business Central salesQuote entity", "format": "date-time", "nullable": true }, "dueDate": { "type": "string", "description": "(v1.0) The dueDate property for the Dynamics 365 Business Central salesQuote entity", "format": "date-time", "nullable": true }, "customerId": { "type": "string", "description": "(v1.0) The customerId property for the Dynamics 365 Business Central salesQuote entity", "format": "uuid", "nullable": true }, "contactId": { "maxLength": 250, "type": "string", "description": "(v1.0) The contactId property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "customerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The customerNumber property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "customerName": { "maxLength": 100, "type": "string", "description": "(v1.0) The customerName property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "billToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The billToName property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "billToCustomerId": { "type": "string", "description": "(v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesQuote entity", "format": "uuid", "nullable": true }, "billToCustomerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "shipToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToName property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "shipToContact": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToContact property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "sellingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "billingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "shippingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central salesQuote entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "paymentTermsId": { "type": "string", "description": "(v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesQuote entity", "format": "uuid", "nullable": true }, "shipmentMethodId": { "type": "string", "description": "(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesQuote entity", "format": "uuid", "nullable": true }, "salesperson": { "maxLength": 20, "type": "string", "description": "(v1.0) The salesperson property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "totalAmountExcludingTax": { "type": "number", "description": "(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "totalAmountIncludingTax": { "type": "number", "description": "(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "sentDate": { "type": "string", "description": "(v1.0) The sentDate property for the Dynamics 365 Business Central salesQuote entity", "format": "date-time", "nullable": true }, "validUntilDate": { "type": "string", "description": "(v1.0) The validUntilDate property for the Dynamics 365 Business Central salesQuote entity", "format": "date-time", "nullable": true }, "acceptedDate": { "type": "string", "description": "(v1.0) The acceptedDate property for the Dynamics 365 Business Central salesQuote entity", "format": "date-time", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central salesQuote entity", "format": "date-time", "nullable": true }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "salesQuoteLines": { "type": "array", "items": { "$ref": "#/components/schemas/salesQuoteLine" }, "description": "", "nullable": true }, "pdfDocument": { "type": "array", "items": { "$ref": "#/components/schemas/pdfDocument" }, "description": "", "nullable": true }, "customer": { "$ref": "#/components/schemas/customer" }, "currency": { "$ref": "#/components/schemas/currency" }, "paymentTerm": { "$ref": "#/components/schemas/paymentTerm" }, "shipmentMethod": { "$ref": "#/components/schemas/shipmentMethod" } } }, "bankAccount": { "title": "bankAccount", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central bankAccount entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central bankAccount entity", "nullable": true }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central bankAccount entity", "nullable": true } } }, "salesQuoteLine": { "title": "salesQuoteLine", "type": "object", "properties": { "id": { "maxLength": 50, "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesQuoteLine entity" }, "documentId": { "type": "string", "description": "(v1.0) The documentId property for the Dynamics 365 Business Central salesQuoteLine entity", "format": "uuid", "nullable": true }, "sequence": { "type": "integer", "description": "(v1.0) The sequence property for the Dynamics 365 Business Central salesQuoteLine entity", "format": "int32", "nullable": true }, "itemId": { "type": "string", "description": "(v1.0) The itemId property for the Dynamics 365 Business Central salesQuoteLine entity", "format": "uuid", "nullable": true }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central salesQuoteLine entity", "format": "uuid", "nullable": true }, "lineType": { "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "lineDetails": { "$ref": "#/components/schemas/documentlineobjectdetailstype" }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "unitOfMeasureId": { "type": "string", "description": "(v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesQuoteLine entity", "format": "uuid", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "unitPrice": { "type": "number", "description": "(v1.0) The unitPrice property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "quantity": { "type": "number", "description": "(v1.0) The quantity property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "discountPercent": { "type": "number", "description": "(v1.0) The discountPercent property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "amountExcludingTax": { "type": "number", "description": "(v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "taxCode": { "maxLength": 50, "type": "string", "description": "(v1.0) The taxCode property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "taxPercent": { "type": "number", "description": "(v1.0) The taxPercent property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "amountIncludingTax": { "type": "number", "description": "(v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "netAmount": { "type": "number", "description": "(v1.0) The netAmount property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "netTaxAmount": { "type": "number", "description": "(v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "netAmountIncludingTax": { "type": "number", "description": "(v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "item": { "$ref": "#/components/schemas/item" }, "account": { "$ref": "#/components/schemas/account" } } }, "cashFlowStatement": { "title": "cashFlowStatement", "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "(v1.0) The lineNumber property for the Dynamics 365 Business Central cashFlowStatement entity", "format": "int32" }, "display": { "maxLength": 250, "type": "string", "description": "(v1.0) The display property for the Dynamics 365 Business Central cashFlowStatement entity", "nullable": true }, "netChange": { "type": "number", "description": "(v1.0) The netChange property for the Dynamics 365 Business Central cashFlowStatement entity", "nullable": true }, "lineType": { "maxLength": 30, "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central cashFlowStatement entity", "nullable": true }, "indentation": { "type": "integer", "description": "(v1.0) The indentation property for the Dynamics 365 Business Central cashFlowStatement entity", "format": "int32", "nullable": true }, "dateFilter": { "type": "string", "description": "(v1.0) The dateFilter property for the Dynamics 365 Business Central cashFlowStatement entity", "format": "date-time", "nullable": true } } }, "unitofmeasuretype": { "title": "unitofmeasuretype", "type": "object", "properties": { "code": { "maxLength": 10, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central unitofmeasuretype entity", "nullable": true }, "displayName": { "maxLength": 50, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central unitofmeasuretype entity", "nullable": true }, "symbol": { "maxLength": 10, "type": "string", "description": "(v1.0) The symbol property for the Dynamics 365 Business Central unitofmeasuretype entity", "nullable": true }, "unitConversion": { "$ref": "#/components/schemas/itemunitofmeasureconversiontype" }, "picture": { "type": "array", "items": { "$ref": "#/components/schemas/picture" }, "description": "", "nullable": true }, "defaultDimensions": { "type": "array", "items": { "$ref": "#/components/schemas/defaultDimensions" }, "description": "", "nullable": true }, "itemCategory": { "$ref": "#/components/schemas/itemCategory" } } }, "salesOrder": { "title": "salesOrder", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesOrder entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "externalDocumentNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "orderDate": { "type": "string", "description": "(v1.0) The orderDate property for the Dynamics 365 Business Central salesOrder entity", "format": "date-time", "nullable": true }, "customerId": { "type": "string", "description": "(v1.0) The customerId property for the Dynamics 365 Business Central salesOrder entity", "format": "uuid", "nullable": true }, "contactId": { "maxLength": 250, "type": "string", "description": "(v1.0) The contactId property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "customerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The customerNumber property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "customerName": { "maxLength": 100, "type": "string", "description": "(v1.0) The customerName property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "billToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The billToName property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "billToCustomerId": { "type": "string", "description": "(v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesOrder entity", "format": "uuid", "nullable": true }, "billToCustomerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "shipToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToName property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "shipToContact": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "sellingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "billingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "shippingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central salesOrder entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "pricesIncludeTax": { "type": "boolean", "description": "(v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "paymentTermsId": { "type": "string", "description": "(v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesOrder entity", "format": "uuid", "nullable": true }, "shipmentMethodId": { "type": "string", "description": "(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesOrder entity", "format": "uuid", "nullable": true }, "salesperson": { "maxLength": 20, "type": "string", "description": "(v1.0) The salesperson property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "partialShipping": { "type": "boolean", "description": "(v1.0) The partialShipping property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "requestedDeliveryDate": { "type": "string", "description": "(v1.0) The requestedDeliveryDate property for the Dynamics 365 Business Central salesOrder entity", "format": "date-time", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "totalAmountExcludingTax": { "type": "number", "description": "(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "totalAmountIncludingTax": { "type": "number", "description": "(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "fullyShipped": { "type": "boolean", "description": "(v1.0) The fullyShipped property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central salesOrder entity", "format": "date-time", "nullable": true }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "salesOrderLines": { "type": "array", "items": { "$ref": "#/components/schemas/salesOrderLine" }, "description": "", "nullable": true }, "customer": { "$ref": "#/components/schemas/customer" }, "currency": { "$ref": "#/components/schemas/currency" }, "paymentTerm": { "$ref": "#/components/schemas/paymentTerm" }, "shipmentMethod": { "$ref": "#/components/schemas/shipmentMethod" } } }, "attachments": { "title": "attachments", "type": "object", "properties": { "parentId": { "type": "string", "description": "(v1.0) The parentId property for the Dynamics 365 Business Central attachments entity", "format": "uuid" }, "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central attachments entity", "format": "uuid" }, "fileName": { "maxLength": 250, "type": "string", "description": "(v1.0) The fileName property for the Dynamics 365 Business Central attachments entity", "nullable": true }, "byteSize": { "type": "integer", "description": "(v1.0) The byteSize property for the Dynamics 365 Business Central attachments entity", "format": "int32", "nullable": true }, "content": { "type": "string", "description": "(v1.0) The content property for the Dynamics 365 Business Central attachments entity", "format": "binary", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central attachments entity", "format": "date-time", "nullable": true } } }, "itemCategory": { "title": "itemCategory", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central itemCategory entity", "format": "uuid" }, "code": { "maxLength": 20, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central itemCategory entity" }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central itemCategory entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central itemCategory entity", "format": "date-time", "nullable": true } } }, "dimensionLine": { "title": "dimensionLine", "type": "object", "properties": { "parentId": { "type": "string", "description": "(v1.0) The parentId property for the Dynamics 365 Business Central dimensionLine entity", "format": "uuid" }, "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central dimensionLine entity", "format": "uuid" }, "code": { "maxLength": 20, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central dimensionLine entity", "nullable": true }, "displayName": { "maxLength": 30, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central dimensionLine entity", "nullable": true }, "valueId": { "type": "string", "description": "(v1.0) The valueId property for the Dynamics 365 Business Central dimensionLine entity", "format": "uuid", "nullable": true }, "valueCode": { "type": "string", "description": "(v1.0) The valueCode property for the Dynamics 365 Business Central dimensionLine entity", "nullable": true }, "valueDisplayName": { "maxLength": 50, "type": "string", "description": "(v1.0) The valueDisplayName property for the Dynamics 365 Business Central dimensionLine entity", "nullable": true }, "dimension": { "$ref": "#/components/schemas/dimension" } } }, "picture": { "title": "picture", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central picture entity", "format": "uuid" }, "width": { "type": "integer", "description": "(v1.0) The width property for the Dynamics 365 Business Central picture entity", "format": "int32", "nullable": true }, "height": { "type": "integer", "description": "(v1.0) The height property for the Dynamics 365 Business Central picture entity", "format": "int32", "nullable": true }, "contentType": { "maxLength": 100, "type": "string", "description": "(v1.0) The contentType property for the Dynamics 365 Business Central picture entity", "nullable": true }, "content@odata.mediaEditLink": { "type": "string", "description": "(v1.0) The content@odata.mediaEditLink property for the Dynamics 365 Business Central picture entity", "nullable": true }, "content@odata.mediaReadLink": { "type": "string", "description": "(v1.0) The content@odata.mediaReadLink property for the Dynamics 365 Business Central picture entity", "nullable": true } } }, "salesInvoiceLine": { "title": "salesInvoiceLine", "type": "object", "properties": { "id": { "maxLength": 50, "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesInvoiceLine entity" }, "documentId": { "type": "string", "description": "(v1.0) The documentId property for the Dynamics 365 Business Central salesInvoiceLine entity", "format": "uuid", "nullable": true }, "sequence": { "type": "integer", "description": "(v1.0) The sequence property for the Dynamics 365 Business Central salesInvoiceLine entity", "format": "int32", "nullable": true }, "itemId": { "type": "string", "description": "(v1.0) The itemId property for the Dynamics 365 Business Central salesInvoiceLine entity", "format": "uuid", "nullable": true }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central salesInvoiceLine entity", "format": "uuid", "nullable": true }, "lineType": { "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "lineDetails": { "$ref": "#/components/schemas/documentlineobjectdetailstype" }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "unitOfMeasureId": { "type": "string", "description": "(v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesInvoiceLine entity", "format": "uuid", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "unitPrice": { "type": "number", "description": "(v1.0) The unitPrice property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "quantity": { "type": "number", "description": "(v1.0) The quantity property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "discountPercent": { "type": "number", "description": "(v1.0) The discountPercent property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "amountExcludingTax": { "type": "number", "description": "(v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "taxCode": { "maxLength": 50, "type": "string", "description": "(v1.0) The taxCode property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "taxPercent": { "type": "number", "description": "(v1.0) The taxPercent property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "amountIncludingTax": { "type": "number", "description": "(v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "invoiceDiscountAllocation": { "type": "number", "description": "(v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "netAmount": { "type": "number", "description": "(v1.0) The netAmount property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "netTaxAmount": { "type": "number", "description": "(v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "netAmountIncludingTax": { "type": "number", "description": "(v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "shipmentDate": { "type": "string", "description": "(v1.0) The shipmentDate property for the Dynamics 365 Business Central salesInvoiceLine entity", "format": "date-time", "nullable": true }, "item": { "$ref": "#/components/schemas/item" }, "account": { "$ref": "#/components/schemas/account" } } }, "customerFinancialDetail": { "title": "customerFinancialDetail", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central customerFinancialDetail entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central customerFinancialDetail entity", "nullable": true }, "balance": { "type": "number", "description": "(v1.0) The balance property for the Dynamics 365 Business Central customerFinancialDetail entity", "nullable": true }, "totalSalesExcludingTax": { "type": "number", "description": "(v1.0) The totalSalesExcludingTax property for the Dynamics 365 Business Central customerFinancialDetail entity", "nullable": true }, "overdueAmount": { "type": "number", "description": "(v1.0) The overdueAmount property for the Dynamics 365 Business Central customerFinancialDetail entity", "nullable": true } } }, "salesCreditMemoLine": { "title": "salesCreditMemoLine", "type": "object", "properties": { "id": { "maxLength": 50, "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesCreditMemoLine entity" }, "documentId": { "type": "string", "description": "(v1.0) The documentId property for the Dynamics 365 Business Central salesCreditMemoLine entity", "format": "uuid", "nullable": true }, "sequence": { "type": "integer", "description": "(v1.0) The sequence property for the Dynamics 365 Business Central salesCreditMemoLine entity", "format": "int32", "nullable": true }, "itemId": { "type": "string", "description": "(v1.0) The itemId property for the Dynamics 365 Business Central salesCreditMemoLine entity", "format": "uuid", "nullable": true }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central salesCreditMemoLine entity", "format": "uuid", "nullable": true }, "lineType": { "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "lineDetails": { "$ref": "#/components/schemas/documentlineobjectdetailstype" }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "unitOfMeasureId": { "type": "string", "description": "(v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesCreditMemoLine entity", "format": "uuid", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "unitPrice": { "type": "number", "description": "(v1.0) The unitPrice property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "quantity": { "type": "number", "description": "(v1.0) The quantity property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "discountPercent": { "type": "number", "description": "(v1.0) The discountPercent property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "amountExcludingTax": { "type": "number", "description": "(v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "taxCode": { "maxLength": 50, "type": "string", "description": "(v1.0) The taxCode property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "taxPercent": { "type": "number", "description": "(v1.0) The taxPercent property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "amountIncludingTax": { "type": "number", "description": "(v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "invoiceDiscountAllocation": { "type": "number", "description": "(v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "netAmount": { "type": "number", "description": "(v1.0) The netAmount property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "netTaxAmount": { "type": "number", "description": "(v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "netAmountIncludingTax": { "type": "number", "description": "(v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "shipmentDate": { "type": "string", "description": "(v1.0) The shipmentDate property for the Dynamics 365 Business Central salesCreditMemoLine entity", "format": "date-time", "nullable": true }, "item": { "$ref": "#/components/schemas/item" }, "account": { "$ref": "#/components/schemas/account" } } }, "pdfDocument": { "title": "pdfDocument", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central pdfDocument entity", "format": "uuid" }, "content": { "type": "string", "description": "(v1.0) The content property for the Dynamics 365 Business Central pdfDocument entity", "format": "binary", "nullable": true } } }, "salesCreditMemo": { "title": "salesCreditMemo", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "externalDocumentNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "creditMemoDate": { "type": "string", "description": "(v1.0) The creditMemoDate property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "date-time", "nullable": true }, "dueDate": { "type": "string", "description": "(v1.0) The dueDate property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "date-time", "nullable": true }, "customerId": { "type": "string", "description": "(v1.0) The customerId property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid", "nullable": true }, "contactId": { "maxLength": 250, "type": "string", "description": "(v1.0) The contactId property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "customerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The customerNumber property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "customerName": { "maxLength": 100, "type": "string", "description": "(v1.0) The customerName property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "billToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The billToName property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "billToCustomerId": { "type": "string", "description": "(v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid", "nullable": true }, "billToCustomerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "sellingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "billingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "paymentTermsId": { "type": "string", "description": "(v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid", "nullable": true }, "shipmentMethodId": { "type": "string", "description": "(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid", "nullable": true }, "salesperson": { "maxLength": 20, "type": "string", "description": "(v1.0) The salesperson property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "pricesIncludeTax": { "type": "boolean", "description": "(v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "totalAmountExcludingTax": { "type": "number", "description": "(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "totalAmountIncludingTax": { "type": "number", "description": "(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "date-time", "nullable": true }, "invoiceId": { "type": "string", "description": "(v1.0) The invoiceId property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid", "nullable": true }, "invoiceNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The invoiceNumber property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "salesCreditMemoLines": { "type": "array", "items": { "$ref": "#/components/schemas/salesCreditMemoLine" }, "description": "", "nullable": true }, "pdfDocument": { "type": "array", "items": { "$ref": "#/components/schemas/pdfDocument" }, "description": "", "nullable": true }, "customer": { "$ref": "#/components/schemas/customer" }, "currency": { "$ref": "#/components/schemas/currency" }, "paymentTerm": { "$ref": "#/components/schemas/paymentTerm" }, "shipmentMethod": { "$ref": "#/components/schemas/shipmentMethod" } } }, "vendorPurchase": { "title": "vendorPurchase", "type": "object", "properties": { "vendorId": { "type": "string", "description": "(v1.0) The vendorId property for the Dynamics 365 Business Central vendorPurchase entity", "format": "uuid" }, "vendorNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The vendorNumber property for the Dynamics 365 Business Central vendorPurchase entity" }, "name": { "maxLength": 100, "type": "string", "description": "(v1.0) The name property for the Dynamics 365 Business Central vendorPurchase entity" }, "totalPurchaseAmount": { "type": "number", "description": "(v1.0) The totalPurchaseAmount property for the Dynamics 365 Business Central vendorPurchase entity", "nullable": true }, "dateFilter_FilterOnly": { "type": "string", "description": "(v1.0) The dateFilter_FilterOnly property for the Dynamics 365 Business Central vendorPurchase entity", "format": "date-time", "nullable": true } } }, "incomeStatement": { "title": "incomeStatement", "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "(v1.0) The lineNumber property for the Dynamics 365 Business Central incomeStatement entity", "format": "int32" }, "display": { "maxLength": 250, "type": "string", "description": "(v1.0) The display property for the Dynamics 365 Business Central incomeStatement entity", "nullable": true }, "netChange": { "type": "number", "description": "(v1.0) The netChange property for the Dynamics 365 Business Central incomeStatement entity", "nullable": true }, "lineType": { "maxLength": 30, "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central incomeStatement entity", "nullable": true }, "indentation": { "type": "integer", "description": "(v1.0) The indentation property for the Dynamics 365 Business Central incomeStatement entity", "format": "int32", "nullable": true }, "dateFilter": { "type": "string", "description": "(v1.0) The dateFilter property for the Dynamics 365 Business Central incomeStatement entity", "format": "date-time", "nullable": true } } }, "generalLedgerEntry": { "title": "generalLedgerEntry", "type": "object", "properties": { "id": { "type": "integer", "description": "(v1.0) The id property for the Dynamics 365 Business Central generalLedgerEntry entity", "format": "int32" }, "postingDate": { "type": "string", "description": "(v1.0) The postingDate property for the Dynamics 365 Business Central generalLedgerEntry entity", "format": "date-time", "nullable": true }, "documentNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The documentNumber property for the Dynamics 365 Business Central generalLedgerEntry entity", "nullable": true }, "documentType": { "type": "string", "description": "(v1.0) The documentType property for the Dynamics 365 Business Central generalLedgerEntry entity", "nullable": true }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central generalLedgerEntry entity", "format": "uuid", "nullable": true }, "accountNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The accountNumber property for the Dynamics 365 Business Central generalLedgerEntry entity", "nullable": true }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central generalLedgerEntry entity", "nullable": true }, "debitAmount": { "type": "number", "description": "(v1.0) The debitAmount property for the Dynamics 365 Business Central generalLedgerEntry entity", "nullable": true }, "creditAmount": { "type": "number", "description": "(v1.0) The creditAmount property for the Dynamics 365 Business Central generalLedgerEntry entity", "nullable": true }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/dimensiontype" }, "description": "" }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central generalLedgerEntry entity", "format": "date-time", "nullable": true }, "account": { "$ref": "#/components/schemas/account" } } }, "customerSale": { "title": "customerSale", "type": "object", "properties": { "customerId": { "type": "string", "description": "(v1.0) The customerId property for the Dynamics 365 Business Central customerSale entity", "format": "uuid" }, "customerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The customerNumber property for the Dynamics 365 Business Central customerSale entity" }, "name": { "maxLength": 100, "type": "string", "description": "(v1.0) The name property for the Dynamics 365 Business Central customerSale entity" }, "totalSalesAmount": { "type": "number", "description": "(v1.0) The totalSalesAmount property for the Dynamics 365 Business Central customerSale entity", "nullable": true }, "dateFilter_FilterOnly": { "type": "string", "description": "(v1.0) The dateFilter_FilterOnly property for the Dynamics 365 Business Central customerSale entity", "format": "date-time", "nullable": true } } }, "countryRegion": { "title": "countryRegion", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central countryRegion entity", "format": "uuid" }, "code": { "maxLength": 10, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central countryRegion entity" }, "displayName": { "maxLength": 50, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central countryRegion entity", "nullable": true }, "addressFormat": { "type": "string", "description": "(v1.0) The addressFormat property for the Dynamics 365 Business Central countryRegion entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central countryRegion entity", "format": "date-time", "nullable": true } } }, "purchaseInvoiceLine": { "title": "purchaseInvoiceLine", "type": "object", "properties": { "id": { "maxLength": 50, "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central purchaseInvoiceLine entity" }, "documentId": { "type": "string", "description": "(v1.0) The documentId property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "format": "uuid", "nullable": true }, "sequence": { "type": "integer", "description": "(v1.0) The sequence property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "format": "int32", "nullable": true }, "itemId": { "type": "string", "description": "(v1.0) The itemId property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "format": "uuid", "nullable": true }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "format": "uuid", "nullable": true }, "lineType": { "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "lineDetails": { "$ref": "#/components/schemas/documentlineobjectdetailstype" }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "unitCost": { "type": "number", "description": "(v1.0) The unitCost property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "quantity": { "type": "number", "description": "(v1.0) The quantity property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "discountPercent": { "type": "number", "description": "(v1.0) The discountPercent property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "amountExcludingTax": { "type": "number", "description": "(v1.0) The amountExcludingTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "taxCode": { "maxLength": 50, "type": "string", "description": "(v1.0) The taxCode property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "taxPercent": { "type": "number", "description": "(v1.0) The taxPercent property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "amountIncludingTax": { "type": "number", "description": "(v1.0) The amountIncludingTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "invoiceDiscountAllocation": { "type": "number", "description": "(v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "netAmount": { "type": "number", "description": "(v1.0) The netAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "netTaxAmount": { "type": "number", "description": "(v1.0) The netTaxAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "netAmountIncludingTax": { "type": "number", "description": "(v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "expectedReceiptDate": { "type": "string", "description": "(v1.0) The expectedReceiptDate property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "format": "date-time", "nullable": true }, "item": { "$ref": "#/components/schemas/item" }, "account": { "$ref": "#/components/schemas/account" } } }, "dimensionValue": { "title": "dimensionValue", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central dimensionValue entity", "format": "uuid" }, "code": { "maxLength": 20, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central dimensionValue entity", "nullable": true }, "displayName": { "maxLength": 50, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central dimensionValue entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central dimensionValue entity", "format": "date-time", "nullable": true } } }, "vendor": { "title": "vendor", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central vendor entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "address": { "$ref": "#/components/schemas/postaladdresstype" }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "website": { "maxLength": 80, "type": "string", "description": "(v1.0) The website property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "taxRegistrationNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central vendor entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "irs1099Code": { "type": "string", "description": "(v1.0) The irs1099Code property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "paymentTermsId": { "type": "string", "description": "(v1.0) The paymentTermsId property for the Dynamics 365 Business Central vendor entity", "format": "uuid", "nullable": true }, "paymentMethodId": { "type": "string", "description": "(v1.0) The paymentMethodId property for the Dynamics 365 Business Central vendor entity", "format": "uuid", "nullable": true }, "taxLiable": { "type": "boolean", "description": "(v1.0) The taxLiable property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "blocked": { "type": "string", "description": "(v1.0) The blocked property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "balance": { "type": "number", "description": "(v1.0) The balance property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central vendor entity", "format": "date-time", "nullable": true }, "picture": { "type": "array", "items": { "$ref": "#/components/schemas/picture" }, "description": "", "nullable": true }, "defaultDimensions": { "type": "array", "items": { "$ref": "#/components/schemas/defaultDimensions" }, "description": "", "nullable": true }, "currency": { "$ref": "#/components/schemas/currency" }, "paymentTerm": { "$ref": "#/components/schemas/paymentTerm" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethod" } } }, "customer": { "title": "customer", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central customer entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central customer entity", "nullable": true }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central customer entity" }, "type": { "type": "string", "description": "(v1.0) The type property for the Dynamics 365 Business Central customer entity", "nullable": true }, "address": { "$ref": "#/components/schemas/postaladdresstype" }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central customer entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central customer entity", "nullable": true }, "website": { "maxLength": 80, "type": "string", "description": "(v1.0) The website property for the Dynamics 365 Business Central customer entity", "nullable": true }, "taxLiable": { "type": "boolean", "description": "(v1.0) The taxLiable property for the Dynamics 365 Business Central customer entity", "nullable": true }, "taxAreaId": { "type": "string", "description": "(v1.0) The taxAreaId property for the Dynamics 365 Business Central customer entity", "format": "uuid", "nullable": true }, "taxAreaDisplayName": { "type": "string", "description": "(v1.0) The taxAreaDisplayName property for the Dynamics 365 Business Central customer entity", "nullable": true }, "taxRegistrationNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central customer entity", "nullable": true }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central customer entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central customer entity", "nullable": true }, "paymentTermsId": { "type": "string", "description": "(v1.0) The paymentTermsId property for the Dynamics 365 Business Central customer entity", "format": "uuid", "nullable": true }, "shipmentMethodId": { "type": "string", "description": "(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central customer entity", "format": "uuid", "nullable": true }, "paymentMethodId": { "type": "string", "description": "(v1.0) The paymentMethodId property for the Dynamics 365 Business Central customer entity", "format": "uuid", "nullable": true }, "blocked": { "type": "string", "description": "(v1.0) The blocked property for the Dynamics 365 Business Central customer entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customer entity", "format": "date-time", "nullable": true }, "customerFinancialDetails": { "type": "array", "items": { "$ref": "#/components/schemas/customerFinancialDetail" }, "description": "", "nullable": true }, "picture": { "type": "array", "items": { "$ref": "#/components/schemas/picture" }, "description": "", "nullable": true }, "defaultDimensions": { "type": "array", "items": { "$ref": "#/components/schemas/defaultDimensions" }, "description": "", "nullable": true }, "currency": { "$ref": "#/components/schemas/currency" }, "paymentTerm": { "$ref": "#/components/schemas/paymentTerm" }, "shipmentMethod": { "$ref": "#/components/schemas/shipmentMethod" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethod" } } }, "item": { "title": "item", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central item entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central item entity", "nullable": true }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central item entity", "nullable": true }, "type": { "type": "string", "description": "(v1.0) The type property for the Dynamics 365 Business Central item entity", "nullable": true }, "itemCategoryId": { "type": "string", "description": "(v1.0) The itemCategoryId property for the Dynamics 365 Business Central item entity", "format": "uuid", "nullable": true }, "itemCategoryCode": { "maxLength": 20, "type": "string", "description": "(v1.0) The itemCategoryCode property for the Dynamics 365 Business Central item entity", "nullable": true }, "blocked": { "type": "boolean", "description": "(v1.0) The blocked property for the Dynamics 365 Business Central item entity", "nullable": true }, "baseUnitOfMeasureId": { "type": "string", "description": "(v1.0) The baseUnitOfMeasureId property for the Dynamics 365 Business Central item entity", "format": "uuid", "nullable": true }, "baseUnitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "gtin": { "maxLength": 14, "type": "string", "description": "(v1.0) The gtin property for the Dynamics 365 Business Central item entity", "nullable": true }, "inventory": { "type": "number", "description": "(v1.0) The inventory property for the Dynamics 365 Business Central item entity", "nullable": true }, "unitPrice": { "type": "number", "description": "(v1.0) The unitPrice property for the Dynamics 365 Business Central item entity", "nullable": true }, "priceIncludesTax": { "type": "boolean", "description": "(v1.0) The priceIncludesTax property for the Dynamics 365 Business Central item entity", "nullable": true }, "unitCost": { "type": "number", "description": "(v1.0) The unitCost property for the Dynamics 365 Business Central item entity", "nullable": true }, "taxGroupId": { "type": "string", "description": "(v1.0) The taxGroupId property for the Dynamics 365 Business Central item entity", "format": "uuid", "nullable": true }, "taxGroupCode": { "maxLength": 20, "type": "string", "description": "(v1.0) The taxGroupCode property for the Dynamics 365 Business Central item entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central item entity", "format": "date-time", "nullable": true }, "picture": { "type": "array", "items": { "$ref": "#/components/schemas/picture" }, "description": "", "nullable": true }, "defaultDimensions": { "type": "array", "items": { "$ref": "#/components/schemas/defaultDimensions" }, "description": "", "nullable": true }, "itemCategory": { "$ref": "#/components/schemas/itemCategory" } } }, "journal": { "title": "journal", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central journal entity", "format": "uuid" }, "code": { "maxLength": 10, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central journal entity" }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central journal entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central journal entity", "format": "date-time", "nullable": true }, "balancingAccountId": { "type": "string", "description": "(v1.0) The balancingAccountId property for the Dynamics 365 Business Central journal entity", "format": "uuid", "nullable": true }, "balancingAccountNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The balancingAccountNumber property for the Dynamics 365 Business Central journal entity", "nullable": true }, "journalLines": { "type": "array", "items": { "$ref": "#/components/schemas/journalLine" }, "description": "", "nullable": true }, "account": { "$ref": "#/components/schemas/account" } } }, "account": { "title": "account", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central account entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central account entity", "nullable": true }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central account entity", "nullable": true }, "category": { "type": "string", "description": "(v1.0) The category property for the Dynamics 365 Business Central account entity", "nullable": true }, "subCategory": { "maxLength": 80, "type": "string", "description": "(v1.0) The subCategory property for the Dynamics 365 Business Central account entity", "nullable": true }, "blocked": { "type": "boolean", "description": "(v1.0) The blocked property for the Dynamics 365 Business Central account entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central account entity", "format": "date-time", "nullable": true } } }, "retainedEarningsStatement": { "title": "retainedEarningsStatement", "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "(v1.0) The lineNumber property for the Dynamics 365 Business Central retainedEarningsStatement entity", "format": "int32" }, "display": { "maxLength": 250, "type": "string", "description": "(v1.0) The display property for the Dynamics 365 Business Central retainedEarningsStatement entity", "nullable": true }, "netChange": { "type": "number", "description": "(v1.0) The netChange property for the Dynamics 365 Business Central retainedEarningsStatement entity", "nullable": true }, "lineType": { "maxLength": 30, "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central retainedEarningsStatement entity", "nullable": true }, "indentation": { "type": "integer", "description": "(v1.0) The indentation property for the Dynamics 365 Business Central retainedEarningsStatement entity", "format": "int32", "nullable": true }, "dateFilter": { "type": "string", "description": "(v1.0) The dateFilter property for the Dynamics 365 Business Central retainedEarningsStatement entity", "format": "date-time", "nullable": true } } }, "purchaseInvoice": { "title": "purchaseInvoice", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "invoiceDate": { "type": "string", "description": "(v1.0) The invoiceDate property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "date-time", "nullable": true }, "dueDate": { "type": "string", "description": "(v1.0) The dueDate property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "date-time", "nullable": true }, "vendorInvoiceNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The vendorInvoiceNumber property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "vendorId": { "type": "string", "description": "(v1.0) The vendorId property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "uuid", "nullable": true }, "vendorNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The vendorNumber property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "vendorName": { "maxLength": 100, "type": "string", "description": "(v1.0) The vendorName property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "payToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The payToName property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "payToContact": { "maxLength": 100, "type": "string", "description": "(v1.0) The payToContact property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "payToVendorId": { "type": "string", "description": "(v1.0) The payToVendorId property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "uuid", "nullable": true }, "payToVendorNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The payToVendorNumber property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "shipToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToName property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "shipToContact": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToContact property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "buyFromAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "payToAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "shipToAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "pricesIncludeTax": { "type": "boolean", "description": "(v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "totalAmountExcludingTax": { "type": "number", "description": "(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "totalAmountIncludingTax": { "type": "number", "description": "(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "date-time", "nullable": true }, "purchaseInvoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/purchaseInvoiceLine" }, "description": "", "nullable": true }, "pdfDocument": { "type": "array", "items": { "$ref": "#/components/schemas/pdfDocument" }, "description": "", "nullable": true }, "vendor": { "$ref": "#/components/schemas/vendor" }, "currency": { "$ref": "#/components/schemas/currency" } } }, "dimension": { "title": "dimension", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central dimension entity", "format": "uuid" }, "code": { "maxLength": 20, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central dimension entity", "nullable": true }, "displayName": { "maxLength": 30, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central dimension entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central dimension entity", "format": "date-time", "nullable": true }, "dimensionValues": { "type": "array", "items": { "$ref": "#/components/schemas/dimensionValue" }, "description": "", "nullable": true } } }, "salesOrderLine": { "title": "salesOrderLine", "type": "object", "properties": { "id": { "maxLength": 50, "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesOrderLine entity" }, "documentId": { "type": "string", "description": "(v1.0) The documentId property for the Dynamics 365 Business Central salesOrderLine entity", "format": "uuid", "nullable": true }, "sequence": { "type": "integer", "description": "(v1.0) The sequence property for the Dynamics 365 Business Central salesOrderLine entity", "format": "int32", "nullable": true }, "itemId": { "type": "string", "description": "(v1.0) The itemId property for the Dynamics 365 Business Central salesOrderLine entity", "format": "uuid", "nullable": true }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central salesOrderLine entity", "format": "uuid", "nullable": true }, "lineType": { "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "lineDetails": { "$ref": "#/components/schemas/documentlineobjectdetailstype" }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "unitOfMeasureId": { "type": "string", "description": "(v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesOrderLine entity", "format": "uuid", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "quantity": { "type": "number", "description": "(v1.0) The quantity property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "unitPrice": { "type": "number", "description": "(v1.0) The unitPrice property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "discountPercent": { "type": "number", "description": "(v1.0) The discountPercent property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "amountExcludingTax": { "type": "number", "description": "(v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "taxCode": { "maxLength": 50, "type": "string", "description": "(v1.0) The taxCode property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "taxPercent": { "type": "number", "description": "(v1.0) The taxPercent property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "amountIncludingTax": { "type": "number", "description": "(v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "invoiceDiscountAllocation": { "type": "number", "description": "(v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "netAmount": { "type": "number", "description": "(v1.0) The netAmount property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "netTaxAmount": { "type": "number", "description": "(v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "netAmountIncludingTax": { "type": "number", "description": "(v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "shipmentDate": { "type": "string", "description": "(v1.0) The shipmentDate property for the Dynamics 365 Business Central salesOrderLine entity", "format": "date-time", "nullable": true }, "shippedQuantity": { "type": "number", "description": "(v1.0) The shippedQuantity property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "invoicedQuantity": { "type": "number", "description": "(v1.0) The invoicedQuantity property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "invoiceQuantity": { "type": "number", "description": "(v1.0) The invoiceQuantity property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "shipQuantity": { "type": "number", "description": "(v1.0) The shipQuantity property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "item": { "$ref": "#/components/schemas/item" }, "account": { "$ref": "#/components/schemas/account" } } }, "timeRegistrationEntry": { "title": "timeRegistrationEntry", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "uuid" }, "employeeId": { "type": "string", "description": "(v1.0) The employeeId property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "uuid", "nullable": true }, "employeeNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The employeeNumber property for the Dynamics 365 Business Central timeRegistrationEntry entity", "nullable": true }, "jobId": { "type": "string", "description": "(v1.0) The jobId property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "uuid", "nullable": true }, "jobNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The jobNumber property for the Dynamics 365 Business Central timeRegistrationEntry entity", "nullable": true }, "absence": { "maxLength": 10, "type": "string", "description": "(v1.0) The absence property for the Dynamics 365 Business Central timeRegistrationEntry entity", "nullable": true }, "lineNumber": { "type": "integer", "description": "(v1.0) The lineNumber property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "int32", "nullable": true }, "date": { "type": "string", "description": "(v1.0) The date property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "date-time", "nullable": true }, "quantity": { "type": "number", "description": "(v1.0) The quantity property for the Dynamics 365 Business Central timeRegistrationEntry entity", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central timeRegistrationEntry entity", "nullable": true }, "unitOfMeasureId": { "type": "string", "description": "(v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "uuid", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/dimensiontype" }, "description": "" }, "lastModfiedDateTime": { "type": "string", "description": "(v1.0) The lastModfiedDateTime property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "date-time", "nullable": true }, "project": { "$ref": "#/components/schemas/project" } } }, "paymentTerm": { "title": "paymentTerm", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central paymentTerm entity", "format": "uuid" }, "code": { "maxLength": 10, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central paymentTerm entity" }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central paymentTerm entity", "nullable": true }, "dueDateCalculation": { "type": "string", "description": "(v1.0) The dueDateCalculation property for the Dynamics 365 Business Central paymentTerm entity", "nullable": true }, "discountDateCalculation": { "type": "string", "description": "(v1.0) The discountDateCalculation property for the Dynamics 365 Business Central paymentTerm entity", "nullable": true }, "discountPercent": { "type": "number", "description": "(v1.0) The discountPercent property for the Dynamics 365 Business Central paymentTerm entity", "nullable": true }, "calculateDiscountOnCreditMemos": { "type": "boolean", "description": "(v1.0) The calculateDiscountOnCreditMemos property for the Dynamics 365 Business Central paymentTerm entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central paymentTerm entity", "format": "date-time", "nullable": true } } }, "customerPayment": { "title": "customerPayment", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central customerPayment entity", "format": "uuid" }, "journalDisplayName": { "type": "string", "description": "(v1.0) The journalDisplayName property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "lineNumber": { "type": "integer", "description": "(v1.0) The lineNumber property for the Dynamics 365 Business Central customerPayment entity", "format": "int32", "nullable": true }, "customerId": { "type": "string", "description": "(v1.0) The customerId property for the Dynamics 365 Business Central customerPayment entity", "format": "uuid", "nullable": true }, "customerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The customerNumber property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "contactId": { "maxLength": 250, "type": "string", "description": "(v1.0) The contactId property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "postingDate": { "type": "string", "description": "(v1.0) The postingDate property for the Dynamics 365 Business Central customerPayment entity", "format": "date-time", "nullable": true }, "documentNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The documentNumber property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "externalDocumentNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "amount": { "type": "number", "description": "(v1.0) The amount property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "appliesToInvoiceId": { "type": "string", "description": "(v1.0) The appliesToInvoiceId property for the Dynamics 365 Business Central customerPayment entity", "format": "uuid", "nullable": true }, "appliesToInvoiceNumber": { "type": "string", "description": "(v1.0) The appliesToInvoiceNumber property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "comment": { "maxLength": 250, "type": "string", "description": "(v1.0) The comment property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/dimensiontype" }, "description": "" }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customerPayment entity", "format": "date-time", "nullable": true }, "customer": { "$ref": "#/components/schemas/customer" } } }, "trialBalance": { "title": "trialBalance", "type": "object", "properties": { "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central trialBalance entity" }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central trialBalance entity", "format": "uuid", "nullable": true }, "accountType": { "type": "string", "description": "(v1.0) The accountType property for the Dynamics 365 Business Central trialBalance entity", "nullable": true }, "display": { "maxLength": 100, "type": "string", "description": "(v1.0) The display property for the Dynamics 365 Business Central trialBalance entity", "nullable": true }, "totalDebit": { "maxLength": 30, "type": "string", "description": "(v1.0) The totalDebit property for the Dynamics 365 Business Central trialBalance entity", "nullable": true }, "totalCredit": { "maxLength": 30, "type": "string", "description": "(v1.0) The totalCredit property for the Dynamics 365 Business Central trialBalance entity", "nullable": true }, "balanceAtDateDebit": { "maxLength": 30, "type": "string", "description": "(v1.0) The balanceAtDateDebit property for the Dynamics 365 Business Central trialBalance entity", "nullable": true }, "balanceAtDateCredit": { "maxLength": 30, "type": "string", "description": "(v1.0) The balanceAtDateCredit property for the Dynamics 365 Business Central trialBalance entity", "nullable": true }, "dateFilter": { "type": "string", "description": "(v1.0) The dateFilter property for the Dynamics 365 Business Central trialBalance entity", "format": "date-time", "nullable": true }, "account": { "$ref": "#/components/schemas/account" } } }, "agedAccountsPayable": { "title": "agedAccountsPayable", "type": "object", "properties": { "vendorId": { "type": "string", "description": "(v1.0) The vendorId property for the Dynamics 365 Business Central agedAccountsPayable entity", "format": "uuid" }, "vendorNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The vendorNumber property for the Dynamics 365 Business Central agedAccountsPayable entity", "nullable": true }, "name": { "maxLength": 100, "type": "string", "description": "(v1.0) The name property for the Dynamics 365 Business Central agedAccountsPayable entity", "nullable": true }, "currencyCode": { "maxLength": 10, "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central agedAccountsPayable entity", "nullable": true }, "balanceDue": { "type": "number", "description": "(v1.0) The balanceDue property for the Dynamics 365 Business Central agedAccountsPayable entity", "nullable": true }, "currentAmount": { "type": "number", "description": "(v1.0) The currentAmount property for the Dynamics 365 Business Central agedAccountsPayable entity", "nullable": true }, "period1Amount": { "type": "number", "description": "(v1.0) The period1Amount property for the Dynamics 365 Business Central agedAccountsPayable entity", "nullable": true }, "period2Amount": { "type": "number", "description": "(v1.0) The period2Amount property for the Dynamics 365 Business Central agedAccountsPayable entity", "nullable": true }, "period3Amount": { "type": "number", "description": "(v1.0) The period3Amount property for the Dynamics 365 Business Central agedAccountsPayable entity", "nullable": true }, "agedAsOfDate": { "type": "string", "description": "(v1.0) The agedAsOfDate property for the Dynamics 365 Business Central agedAccountsPayable entity", "format": "date-time", "nullable": true }, "periodLengthFilter": { "maxLength": 10, "type": "string", "description": "(v1.0) The periodLengthFilter property for the Dynamics 365 Business Central agedAccountsPayable entity", "nullable": true } } }, "customerPaymentJournal": { "title": "customerPaymentJournal", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central customerPaymentJournal entity", "format": "uuid" }, "code": { "maxLength": 10, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central customerPaymentJournal entity" }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central customerPaymentJournal entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customerPaymentJournal entity", "format": "date-time", "nullable": true }, "balancingAccountId": { "type": "string", "description": "(v1.0) The balancingAccountId property for the Dynamics 365 Business Central customerPaymentJournal entity", "format": "uuid", "nullable": true }, "balancingAccountNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The balancingAccountNumber property for the Dynamics 365 Business Central customerPaymentJournal entity", "nullable": true }, "customerPayments": { "type": "array", "items": { "$ref": "#/components/schemas/customerPayment" }, "description": "", "nullable": true }, "account": { "$ref": "#/components/schemas/account" } } }, "journalLine": { "title": "journalLine", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central journalLine entity", "format": "uuid" }, "journalDisplayName": { "type": "string", "description": "(v1.0) The journalDisplayName property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "lineNumber": { "type": "integer", "description": "(v1.0) The lineNumber property for the Dynamics 365 Business Central journalLine entity", "format": "int32", "nullable": true }, "accountType": { "type": "string", "description": "(v1.0) The accountType property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central journalLine entity", "format": "uuid", "nullable": true }, "accountNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The accountNumber property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "postingDate": { "type": "string", "description": "(v1.0) The postingDate property for the Dynamics 365 Business Central journalLine entity", "format": "date-time", "nullable": true }, "documentNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The documentNumber property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "externalDocumentNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "amount": { "type": "number", "description": "(v1.0) The amount property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "comment": { "maxLength": 250, "type": "string", "description": "(v1.0) The comment property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/dimensiontype" }, "description": "" }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central journalLine entity", "format": "date-time", "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/attachments" }, "description": "", "nullable": true }, "account": { "$ref": "#/components/schemas/account" } } }, "documentlineobjectdetailstype": { "title": "documentlineobjectdetailstype", "type": "object", "properties": { "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central documentlineobjectdetailstype entity", "nullable": true }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central documentlineobjectdetailstype entity", "nullable": true }, "item": { "$ref": "#/components/schemas/item" }, "account": { "$ref": "#/components/schemas/account" } } }, "itemunitofmeasureconversiontype": { "title": "itemunitofmeasureconversiontype", "type": "object", "properties": { "toUnitOfMeasure": { "maxLength": 10, "type": "string", "description": "(v1.0) The toUnitOfMeasure property for the Dynamics 365 Business Central itemunitofmeasureconversiontype entity", "nullable": true }, "fromToConversionRate": { "type": "number", "description": "(v1.0) The fromToConversionRate property for the Dynamics 365 Business Central itemunitofmeasureconversiontype entity", "nullable": true }, "picture": { "type": "array", "items": { "$ref": "#/components/schemas/picture" }, "description": "", "nullable": true }, "defaultDimensions": { "type": "array", "items": { "$ref": "#/components/schemas/defaultDimensions" }, "description": "", "nullable": true }, "itemCategory": { "$ref": "#/components/schemas/itemCategory" } } }, "postaladdresstype": { "title": "postaladdresstype", "type": "object", "properties": { "street": { "maxLength": 152, "type": "string", "description": "(v1.0) The street property for the Dynamics 365 Business Central postaladdresstype entity", "nullable": true }, "city": { "maxLength": 30, "type": "string", "description": "(v1.0) The city property for the Dynamics 365 Business Central postaladdresstype entity", "nullable": true }, "state": { "maxLength": 30, "type": "string", "description": "(v1.0) The state property for the Dynamics 365 Business Central postaladdresstype entity", "nullable": true }, "countryLetterCode": { "maxLength": 10, "type": "string", "description": "(v1.0) The countryLetterCode property for the Dynamics 365 Business Central postaladdresstype entity", "nullable": true }, "postalCode": { "maxLength": 20, "type": "string", "description": "(v1.0) The postalCode property for the Dynamics 365 Business Central postaladdresstype entity", "nullable": true }, "customerFinancialDetails": { "type": "array", "items": { "$ref": "#/components/schemas/customerFinancialDetail" }, "description": "", "nullable": true }, "picture": { "type": "array", "items": { "$ref": "#/components/schemas/picture" }, "description": "", "nullable": true }, "defaultDimensions": { "type": "array", "items": { "$ref": "#/components/schemas/defaultDimensions" }, "description": "", "nullable": true }, "currency": { "$ref": "#/components/schemas/currency" }, "paymentTerm": { "$ref": "#/components/schemas/paymentTerm" }, "shipmentMethod": { "$ref": "#/components/schemas/shipmentMethod" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethod" } } }, "project": { "title": "project", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central project entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central project entity", "nullable": true }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central project entity", "nullable": true } } }, "salesInvoice": { "title": "salesInvoice", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "externalDocumentNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "invoiceDate": { "type": "string", "description": "(v1.0) The invoiceDate property for the Dynamics 365 Business Central salesInvoice entity", "format": "date-time", "nullable": true }, "dueDate": { "type": "string", "description": "(v1.0) The dueDate property for the Dynamics 365 Business Central salesInvoice entity", "format": "date-time", "nullable": true }, "customerPurchaseOrderReference": { "maxLength": 35, "type": "string", "description": "(v1.0) The customerPurchaseOrderReference property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "customerId": { "type": "string", "description": "(v1.0) The customerId property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid", "nullable": true }, "contactId": { "maxLength": 250, "type": "string", "description": "(v1.0) The contactId property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "customerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The customerNumber property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "customerName": { "maxLength": 100, "type": "string", "description": "(v1.0) The customerName property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "billToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The billToName property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "billToCustomerId": { "type": "string", "description": "(v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid", "nullable": true }, "billToCustomerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "shipToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToName property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "shipToContact": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToContact property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "sellingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "billingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "shippingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "orderId": { "type": "string", "description": "(v1.0) The orderId property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid", "nullable": true }, "orderNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The orderNumber property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "paymentTermsId": { "type": "string", "description": "(v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid", "nullable": true }, "shipmentMethodId": { "type": "string", "description": "(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid", "nullable": true }, "salesperson": { "maxLength": 20, "type": "string", "description": "(v1.0) The salesperson property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "pricesIncludeTax": { "type": "boolean", "description": "(v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "remainingAmount": { "type": "number", "description": "(v1.0) The remainingAmount property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "totalAmountExcludingTax": { "type": "number", "description": "(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "totalAmountIncludingTax": { "type": "number", "description": "(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central salesInvoice entity", "format": "date-time", "nullable": true }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "salesInvoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/salesInvoiceLine" }, "description": "", "nullable": true }, "pdfDocument": { "type": "array", "items": { "$ref": "#/components/schemas/pdfDocument" }, "description": "", "nullable": true }, "customer": { "$ref": "#/components/schemas/customer" }, "currency": { "$ref": "#/components/schemas/currency" }, "paymentTerm": { "$ref": "#/components/schemas/paymentTerm" }, "shipmentMethod": { "$ref": "#/components/schemas/shipmentMethod" } } }, "generalLedgerEntryAttachments": { "title": "generalLedgerEntryAttachments", "type": "object", "properties": { "generalLedgerEntryNumber": { "type": "integer", "description": "(v1.0) The generalLedgerEntryNumber property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity", "format": "int32" }, "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity", "format": "uuid" }, "fileName": { "maxLength": 250, "type": "string", "description": "(v1.0) The fileName property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity", "nullable": true }, "byteSize": { "type": "integer", "description": "(v1.0) The byteSize property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity", "format": "int32", "nullable": true }, "content": { "type": "string", "description": "(v1.0) The content property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity", "format": "binary", "nullable": true }, "createdDateTime": { "type": "string", "description": "(v1.0) The createdDateTime property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity", "format": "date-time", "nullable": true }, "generalLedgerEntry": { "$ref": "#/components/schemas/generalLedgerEntry" } } }, "unitOfMeasure": { "title": "unitOfMeasure", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central unitOfMeasure entity", "format": "uuid" }, "code": { "maxLength": 10, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central unitOfMeasure entity" }, "displayName": { "maxLength": 50, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central unitOfMeasure entity", "nullable": true }, "internationalStandardCode": { "maxLength": 10, "type": "string", "description": "(v1.0) The internationalStandardCode property for the Dynamics 365 Business Central unitOfMeasure entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central unitOfMeasure entity", "format": "date-time", "nullable": true } } }, "currency": { "title": "currency", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central currency entity", "format": "uuid" }, "code": { "maxLength": 10, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central currency entity" }, "displayName": { "maxLength": 30, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central currency entity", "nullable": true }, "symbol": { "maxLength": 10, "type": "string", "description": "(v1.0) The symbol property for the Dynamics 365 Business Central currency entity", "nullable": true }, "amountDecimalPlaces": { "maxLength": 5, "type": "string", "description": "(v1.0) The amountDecimalPlaces property for the Dynamics 365 Business Central currency entity", "nullable": true }, "amountRoundingPrecision": { "type": "number", "description": "(v1.0) The amountRoundingPrecision property for the Dynamics 365 Business Central currency entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central currency entity", "format": "date-time", "nullable": true } } }, "defaultDimensions": { "title": "defaultDimensions", "type": "object", "properties": { "parentId": { "type": "string", "description": "(v1.0) The parentId property for the Dynamics 365 Business Central defaultDimensions entity", "format": "uuid" }, "dimensionId": { "type": "string", "description": "(v1.0) The dimensionId property for the Dynamics 365 Business Central defaultDimensions entity", "format": "uuid" }, "dimensionCode": { "maxLength": 20, "type": "string", "description": "(v1.0) The dimensionCode property for the Dynamics 365 Business Central defaultDimensions entity", "nullable": true }, "dimensionValueId": { "type": "string", "description": "(v1.0) The dimensionValueId property for the Dynamics 365 Business Central defaultDimensions entity", "format": "uuid", "nullable": true }, "dimensionValueCode": { "maxLength": 20, "type": "string", "description": "(v1.0) The dimensionValueCode property for the Dynamics 365 Business Central defaultDimensions entity", "nullable": true }, "postingValidation": { "type": "string", "description": "(v1.0) The postingValidation property for the Dynamics 365 Business Central defaultDimensions entity", "nullable": true }, "account": { "$ref": "#/components/schemas/account" }, "dimension": { "$ref": "#/components/schemas/dimension" }, "dimensionValue": { "$ref": "#/components/schemas/dimensionValue" } } }, "company": { "title": "company", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central company entity", "format": "uuid" }, "systemVersion": { "type": "string", "description": "(v1.0) The systemVersion property for the Dynamics 365 Business Central company entity", "nullable": true }, "name": { "maxLength": 30, "type": "string", "description": "(v1.0) The name property for the Dynamics 365 Business Central company entity", "nullable": true }, "displayName": { "maxLength": 250, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central company entity", "nullable": true }, "businessProfileId": { "maxLength": 250, "type": "string", "description": "(v1.0) The businessProfileId property for the Dynamics 365 Business Central company entity", "nullable": true }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/item" }, "description": "", "nullable": true }, "picture": { "type": "array", "items": { "$ref": "#/components/schemas/picture" }, "description": "", "nullable": true }, "defaultDimensions": { "type": "array", "items": { "$ref": "#/components/schemas/defaultDimensions" }, "description": "", "nullable": true }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/customer" }, "description": "", "nullable": true }, "customerFinancialDetails": { "type": "array", "items": { "$ref": "#/components/schemas/customerFinancialDetail" }, "description": "", "nullable": true }, "vendors": { "type": "array", "items": { "$ref": "#/components/schemas/vendor" }, "description": "", "nullable": true }, "companyInformation": { "type": "array", "items": { "$ref": "#/components/schemas/companyInformation" }, "description": "", "nullable": true }, "salesInvoices": { "type": "array", "items": { "$ref": "#/components/schemas/salesInvoice" }, "description": "", "nullable": true }, "salesInvoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/salesInvoiceLine" }, "description": "", "nullable": true }, "pdfDocument": { "type": "array", "items": { "$ref": "#/components/schemas/pdfDocument" }, "description": "", "nullable": true }, "customerPaymentJournals": { "type": "array", "items": { "$ref": "#/components/schemas/customerPaymentJournal" }, "description": "", "nullable": true }, "customerPayments": { "type": "array", "items": { "$ref": "#/components/schemas/customerPayment" }, "description": "", "nullable": true }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/account" }, "description": "", "nullable": true }, "taxGroups": { "type": "array", "items": { "$ref": "#/components/schemas/taxGroup" }, "description": "", "nullable": true }, "journals": { "type": "array", "items": { "$ref": "#/components/schemas/journal" }, "description": "", "nullable": true }, "journalLines": { "type": "array", "items": { "$ref": "#/components/schemas/journalLine" }, "description": "", "nullable": true }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/attachments" }, "description": "", "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/employee" }, "description": "", "nullable": true }, "timeRegistrationEntries": { "type": "array", "items": { "$ref": "#/components/schemas/timeRegistrationEntry" }, "description": "", "nullable": true }, "generalLedgerEntries": { "type": "array", "items": { "$ref": "#/components/schemas/generalLedgerEntry" }, "description": "", "nullable": true }, "currencies": { "type": "array", "items": { "$ref": "#/components/schemas/currency" }, "description": "", "nullable": true }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/paymentMethod" }, "description": "", "nullable": true }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/dimension" }, "description": "", "nullable": true }, "dimensionValues": { "type": "array", "items": { "$ref": "#/components/schemas/dimensionValue" }, "description": "", "nullable": true }, "dimensionLines": { "type": "array", "items": { "$ref": "#/components/schemas/dimensionLine" }, "description": "", "nullable": true }, "paymentTerms": { "type": "array", "items": { "$ref": "#/components/schemas/paymentTerm" }, "description": "", "nullable": true }, "shipmentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/shipmentMethod" }, "description": "", "nullable": true }, "itemCategories": { "type": "array", "items": { "$ref": "#/components/schemas/itemCategory" }, "description": "", "nullable": true }, "cashFlowStatement": { "type": "array", "items": { "$ref": "#/components/schemas/cashFlowStatement" }, "description": "", "nullable": true }, "countriesRegions": { "type": "array", "items": { "$ref": "#/components/schemas/countryRegion" }, "description": "", "nullable": true }, "salesOrders": { "type": "array", "items": { "$ref": "#/components/schemas/salesOrder" }, "description": "", "nullable": true }, "salesOrderLines": { "type": "array", "items": { "$ref": "#/components/schemas/salesOrderLine" }, "description": "", "nullable": true }, "retainedEarningsStatement": { "type": "array", "items": { "$ref": "#/components/schemas/retainedEarningsStatement" }, "description": "", "nullable": true }, "unitsOfMeasure": { "type": "array", "items": { "$ref": "#/components/schemas/unitOfMeasure" }, "description": "", "nullable": true }, "agedAccountsReceivable": { "type": "array", "items": { "$ref": "#/components/schemas/agedAccountsReceivable" }, "description": "", "nullable": true }, "agedAccountsPayable": { "type": "array", "items": { "$ref": "#/components/schemas/agedAccountsPayable" }, "description": "", "nullable": true }, "balanceSheet": { "type": "array", "items": { "$ref": "#/components/schemas/balanceSheet" }, "description": "", "nullable": true }, "trialBalance": { "type": "array", "items": { "$ref": "#/components/schemas/trialBalance" }, "description": "", "nullable": true }, "incomeStatement": { "type": "array", "items": { "$ref": "#/components/schemas/incomeStatement" }, "description": "", "nullable": true }, "taxAreas": { "type": "array", "items": { "$ref": "#/components/schemas/taxArea" }, "description": "", "nullable": true }, "salesQuotes": { "type": "array", "items": { "$ref": "#/components/schemas/salesQuote" }, "description": "", "nullable": true }, "salesQuoteLines": { "type": "array", "items": { "$ref": "#/components/schemas/salesQuoteLine" }, "description": "", "nullable": true }, "salesCreditMemos": { "type": "array", "items": { "$ref": "#/components/schemas/salesCreditMemo" }, "description": "", "nullable": true }, "salesCreditMemoLines": { "type": "array", "items": { "$ref": "#/components/schemas/salesCreditMemoLine" }, "description": "", "nullable": true }, "generalLedgerEntryAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/generalLedgerEntryAttachments" }, "description": "", "nullable": true }, "purchaseInvoices": { "type": "array", "items": { "$ref": "#/components/schemas/purchaseInvoice" }, "description": "", "nullable": true }, "purchaseInvoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/purchaseInvoiceLine" }, "description": "", "nullable": true }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/project" }, "description": "", "nullable": true }, "bankAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/bankAccount" }, "description": "", "nullable": true }, "customerSales": { "type": "array", "items": { "$ref": "#/components/schemas/customerSale" }, "description": "", "nullable": true }, "vendorPurchases": { "type": "array", "items": { "$ref": "#/components/schemas/vendorPurchase" }, "description": "", "nullable": true } } }, "shipmentMethod": { "title": "shipmentMethod", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central shipmentMethod entity", "format": "uuid" }, "code": { "maxLength": 10, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central shipmentMethod entity" }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central shipmentMethod entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central shipmentMethod entity", "format": "date-time", "nullable": true } } }, "balanceSheet": { "title": "balanceSheet", "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "(v1.0) The lineNumber property for the Dynamics 365 Business Central balanceSheet entity", "format": "int32" }, "display": { "maxLength": 250, "type": "string", "description": "(v1.0) The display property for the Dynamics 365 Business Central balanceSheet entity", "nullable": true }, "balance": { "type": "number", "description": "(v1.0) The balance property for the Dynamics 365 Business Central balanceSheet entity", "nullable": true }, "lineType": { "maxLength": 30, "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central balanceSheet entity", "nullable": true }, "indentation": { "type": "integer", "description": "(v1.0) The indentation property for the Dynamics 365 Business Central balanceSheet entity", "format": "int32", "nullable": true }, "dateFilter": { "type": "string", "description": "(v1.0) The dateFilter property for the Dynamics 365 Business Central balanceSheet entity", "format": "date-time", "nullable": true } } }, "dimensiontype": { "title": "dimensiontype", "type": "object", "properties": { "code": { "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central dimensiontype entity" }, "displayName": { "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central dimensiontype entity", "nullable": true }, "valueCode": { "type": "string", "description": "(v1.0) The valueCode property for the Dynamics 365 Business Central dimensiontype entity" }, "valueDisplayName": { "type": "string", "description": "(v1.0) The valueDisplayName property for the Dynamics 365 Business Central dimensiontype entity", "nullable": true }, "customer": { "$ref": "#/components/schemas/customer" } } }, "taxGroup": { "title": "taxGroup", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central taxGroup entity", "format": "uuid" }, "code": { "maxLength": 20, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central taxGroup entity", "nullable": true }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central taxGroup entity", "nullable": true }, "taxType": { "type": "string", "description": "(v1.0) The taxType property for the Dynamics 365 Business Central taxGroup entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central taxGroup entity", "format": "date-time", "nullable": true } } }, "employee": { "title": "employee", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central employee entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central employee entity", "nullable": true }, "displayName": { "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central employee entity", "nullable": true }, "givenName": { "maxLength": 30, "type": "string", "description": "(v1.0) The givenName property for the Dynamics 365 Business Central employee entity", "nullable": true }, "middleName": { "maxLength": 30, "type": "string", "description": "(v1.0) The middleName property for the Dynamics 365 Business Central employee entity", "nullable": true }, "surname": { "maxLength": 30, "type": "string", "description": "(v1.0) The surname property for the Dynamics 365 Business Central employee entity", "nullable": true }, "jobTitle": { "maxLength": 30, "type": "string", "description": "(v1.0) The jobTitle property for the Dynamics 365 Business Central employee entity", "nullable": true }, "address": { "$ref": "#/components/schemas/postaladdresstype" }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central employee entity", "nullable": true }, "mobilePhone": { "maxLength": 30, "type": "string", "description": "(v1.0) The mobilePhone property for the Dynamics 365 Business Central employee entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central employee entity", "nullable": true }, "personalEmail": { "maxLength": 80, "type": "string", "description": "(v1.0) The personalEmail property for the Dynamics 365 Business Central employee entity", "nullable": true }, "employmentDate": { "type": "string", "description": "(v1.0) The employmentDate property for the Dynamics 365 Business Central employee entity", "format": "date-time", "nullable": true }, "terminationDate": { "type": "string", "description": "(v1.0) The terminationDate property for the Dynamics 365 Business Central employee entity", "format": "date-time", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central employee entity", "nullable": true }, "birthDate": { "type": "string", "description": "(v1.0) The birthDate property for the Dynamics 365 Business Central employee entity", "format": "date-time", "nullable": true }, "statisticsGroupCode": { "maxLength": 10, "type": "string", "description": "(v1.0) The statisticsGroupCode property for the Dynamics 365 Business Central employee entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central employee entity", "format": "date-time", "nullable": true }, "picture": { "type": "array", "items": { "$ref": "#/components/schemas/picture" }, "description": "", "nullable": true }, "defaultDimensions": { "type": "array", "items": { "$ref": "#/components/schemas/defaultDimensions" }, "description": "", "nullable": true }, "timeRegistrationEntries": { "type": "array", "items": { "$ref": "#/components/schemas/timeRegistrationEntry" }, "description": "", "nullable": true } } }, "agedAccountsReceivable": { "title": "agedAccountsReceivable", "type": "object", "properties": { "customerId": { "type": "string", "description": "(v1.0) The customerId property for the Dynamics 365 Business Central agedAccountsReceivable entity", "format": "uuid" }, "customerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The customerNumber property for the Dynamics 365 Business Central agedAccountsReceivable entity", "nullable": true }, "name": { "maxLength": 100, "type": "string", "description": "(v1.0) The name property for the Dynamics 365 Business Central agedAccountsReceivable entity", "nullable": true }, "currencyCode": { "maxLength": 10, "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central agedAccountsReceivable entity", "nullable": true }, "balanceDue": { "type": "number", "description": "(v1.0) The balanceDue property for the Dynamics 365 Business Central agedAccountsReceivable entity", "nullable": true }, "currentAmount": { "type": "number", "description": "(v1.0) The currentAmount property for the Dynamics 365 Business Central agedAccountsReceivable entity", "nullable": true }, "period1Amount": { "type": "number", "description": "(v1.0) The period1Amount property for the Dynamics 365 Business Central agedAccountsReceivable entity", "nullable": true }, "period2Amount": { "type": "number", "description": "(v1.0) The period2Amount property for the Dynamics 365 Business Central agedAccountsReceivable entity", "nullable": true }, "period3Amount": { "type": "number", "description": "(v1.0) The period3Amount property for the Dynamics 365 Business Central agedAccountsReceivable entity", "nullable": true }, "agedAsOfDate": { "type": "string", "description": "(v1.0) The agedAsOfDate property for the Dynamics 365 Business Central agedAccountsReceivable entity", "format": "date-time", "nullable": true }, "periodLengthFilter": { "maxLength": 10, "type": "string", "description": "(v1.0) The periodLengthFilter property for the Dynamics 365 Business Central agedAccountsReceivable entity", "nullable": true } } }, "companyInformation": { "title": "companyInformation", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central companyInformation entity", "format": "uuid" }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central companyInformation entity", "nullable": true }, "address": { "$ref": "#/components/schemas/postaladdresstype" }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central companyInformation entity", "nullable": true }, "faxNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The faxNumber property for the Dynamics 365 Business Central companyInformation entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central companyInformation entity", "nullable": true }, "website": { "maxLength": 80, "type": "string", "description": "(v1.0) The website property for the Dynamics 365 Business Central companyInformation entity", "nullable": true }, "taxRegistrationNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central companyInformation entity", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central companyInformation entity", "nullable": true }, "currentFiscalYearStartDate": { "type": "string", "description": "(v1.0) The currentFiscalYearStartDate property for the Dynamics 365 Business Central companyInformation entity", "format": "date-time", "nullable": true }, "industry": { "maxLength": 30, "type": "string", "description": "(v1.0) The industry property for the Dynamics 365 Business Central companyInformation entity", "nullable": true }, "picture": { "type": "string", "description": "(v1.0) The picture property for the Dynamics 365 Business Central companyInformation entity", "format": "binary", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central companyInformation entity", "format": "date-time", "nullable": true } } }, "expand": { "title": "expand", "enum": [ "picture", "defaultDimensions", "itemCategory" ], "type": "string" }, "expand2": { "title": "expand2", "enum": [ "account", "dimension", "dimensionValue" ], "type": "string" }, "expand6": { "title": "expand6", "enum": [ "customerFinancialDetails", "picture", "defaultDimensions", "currency", "paymentTerm", "shipmentMethod", "paymentMethod" ], "type": "string" }, "expand10": { "title": "expand10", "enum": [ "picture", "defaultDimensions", "currency", "paymentTerm", "paymentMethod" ], "type": "string" }, "expand14": { "title": "expand14", "enum": [ "salesInvoiceLines", "pdfDocument", "customer", "currency", "paymentTerm", "shipmentMethod" ], "type": "string" }, "expand16": { "title": "expand16", "enum": [ "item", "account" ], "type": "string" }, "expand20": { "title": "expand20", "enum": [ "customerPayments", "account" ], "type": "string" }, "expand22": { "title": "expand22", "enum": [ "customer" ], "type": "string" }, "expand26": { "title": "expand26", "enum": [ "journalLines", "account" ], "type": "string" }, "expand28": { "title": "expand28", "enum": [ "attachments", "account" ], "type": "string" }, "expand32": { "title": "expand32", "enum": [ "picture", "defaultDimensions", "timeRegistrationEntries" ], "type": "string" }, "expand36": { "title": "expand36", "enum": [ "project" ], "type": "string" }, "expand40": { "title": "expand40", "enum": [ "account" ], "type": "string" }, "expand42": { "title": "expand42", "enum": [ "dimensionValues" ], "type": "string" }, "expand44": { "title": "expand44", "enum": [ "dimension" ], "type": "string" }, "expand46": { "title": "expand46", "enum": [ "salesOrderLines", "customer", "currency", "paymentTerm", "shipmentMethod" ], "type": "string" }, "expand54": { "title": "expand54", "enum": [ "salesQuoteLines", "pdfDocument", "customer", "currency", "paymentTerm", "shipmentMethod" ], "type": "string" }, "expand60": { "title": "expand60", "enum": [ "salesCreditMemoLines", "pdfDocument", "customer", "currency", "paymentTerm", "shipmentMethod" ], "type": "string" }, "expand66": { "title": "expand66", "enum": [ "generalLedgerEntry" ], "type": "string" }, "expand68": { "title": "expand68", "enum": [ "purchaseInvoiceLines", "pdfDocument", "vendor", "currency" ], "type": "string" }, "select": { "title": "select", "enum": [ "id", "systemVersion", "name", "displayName", "businessProfileId" ], "type": "string" }, "select2": { "title": "select2", "enum": [ "id", "number", "displayName", "type", "itemCategoryId", "itemCategoryCode", "blocked", "baseUnitOfMeasureId", "baseUnitOfMeasure", "gtin", "inventory", "unitPrice", "priceIncludesTax", "unitCost", "taxGroupId", "taxGroupCode", "lastModifiedDateTime" ], "type": "string" }, "select4": { "title": "select4", "enum": [ "id", "width", "height", "contentType", "content" ], "type": "string" }, "select6": { "title": "select6", "enum": [ "parentId", "dimensionId", "dimensionCode", "dimensionValueId", "dimensionValueCode", "postingValidation" ], "type": "string" }, "select12": { "title": "select12", "enum": [ "id", "number", "displayName", "type", "address", "phoneNumber", "email", "website", "taxLiable", "taxAreaId", "taxAreaDisplayName", "taxRegistrationNumber", "currencyId", "currencyCode", "paymentTermsId", "shipmentMethodId", "paymentMethodId", "blocked", "lastModifiedDateTime" ], "type": "string" }, "select14": { "title": "select14", "enum": [ "id", "number", "balance", "totalSalesExcludingTax", "overdueAmount" ], "type": "string" }, "select22": { "title": "select22", "enum": [ "id", "number", "displayName", "address", "phoneNumber", "email", "website", "taxRegistrationNumber", "currencyId", "currencyCode", "irs1099Code", "paymentTermsId", "paymentMethodId", "taxLiable", "blocked", "balance", "lastModifiedDateTime" ], "type": "string" }, "select28": { "title": "select28", "enum": [ "id", "displayName", "address", "phoneNumber", "faxNumber", "email", "website", "taxRegistrationNumber", "currencyCode", "currentFiscalYearStartDate", "industry", "picture", "lastModifiedDateTime" ], "type": "string" }, "select30": { "title": "select30", "enum": [ "id", "number", "externalDocumentNumber", "invoiceDate", "dueDate", "customerPurchaseOrderReference", "customerId", "contactId", "customerNumber", "customerName", "billToName", "billToCustomerId", "billToCustomerNumber", "shipToName", "shipToContact", "sellingPostalAddress", "billingPostalAddress", "shippingPostalAddress", "currencyId", "currencyCode", "orderId", "orderNumber", "paymentTermsId", "shipmentMethodId", "salesperson", "pricesIncludeTax", "remainingAmount", "discountAmount", "discountAppliedBeforeTax", "totalAmountExcludingTax", "totalTaxAmount", "totalAmountIncludingTax", "status", "lastModifiedDateTime", "phoneNumber", "email" ], "type": "string" }, "select32": { "title": "select32", "enum": [ "id", "documentId", "sequence", "itemId", "accountId", "lineType", "lineDetails", "description", "unitOfMeasureId", "unitOfMeasure", "unitPrice", "quantity", "discountAmount", "discountPercent", "discountAppliedBeforeTax", "amountExcludingTax", "taxCode", "taxPercent", "totalTaxAmount", "amountIncludingTax", "invoiceDiscountAllocation", "netAmount", "netTaxAmount", "netAmountIncludingTax", "shipmentDate" ], "type": "string" }, "select34": { "title": "select34", "enum": [ "id", "content" ], "type": "string" }, "select40": { "title": "select40", "enum": [ "id", "code", "displayName", "lastModifiedDateTime", "balancingAccountId", "balancingAccountNumber" ], "type": "string" }, "select42": { "title": "select42", "enum": [ "id", "journalDisplayName", "lineNumber", "customerId", "customerNumber", "contactId", "postingDate", "documentNumber", "externalDocumentNumber", "amount", "appliesToInvoiceId", "appliesToInvoiceNumber", "description", "comment", "dimensions", "lastModifiedDateTime" ], "type": "string" }, "select46": { "title": "select46", "enum": [ "id", "number", "displayName", "category", "subCategory", "blocked", "lastModifiedDateTime" ], "type": "string" }, "select48": { "title": "select48", "enum": [ "id", "code", "displayName", "taxType", "lastModifiedDateTime" ], "type": "string" }, "select52": { "title": "select52", "enum": [ "id", "journalDisplayName", "lineNumber", "accountType", "accountId", "accountNumber", "postingDate", "documentNumber", "externalDocumentNumber", "amount", "description", "comment", "dimensions", "lastModifiedDateTime" ], "type": "string" }, "select54": { "title": "select54", "enum": [ "parentId", "id", "fileName", "byteSize", "content", "lastModifiedDateTime" ], "type": "string" }, "select62": { "title": "select62", "enum": [ "id", "number", "displayName", "givenName", "middleName", "surname", "jobTitle", "address", "phoneNumber", "mobilePhone", "email", "personalEmail", "employmentDate", "terminationDate", "status", "birthDate", "statisticsGroupCode", "lastModifiedDateTime" ], "type": "string" }, "select68": { "title": "select68", "enum": [ "id", "employeeId", "employeeNumber", "jobId", "jobNumber", "absence", "lineNumber", "date", "quantity", "status", "unitOfMeasureId", "unitOfMeasure", "dimensions", "lastModfiedDateTime" ], "type": "string" }, "select72": { "title": "select72", "enum": [ "id", "postingDate", "documentNumber", "documentType", "accountId", "accountNumber", "description", "debitAmount", "creditAmount", "dimensions", "lastModifiedDateTime" ], "type": "string" }, "select74": { "title": "select74", "enum": [ "id", "code", "displayName", "symbol", "amountDecimalPlaces", "amountRoundingPrecision", "lastModifiedDateTime" ], "type": "string" }, "select76": { "title": "select76", "enum": [ "id", "code", "displayName", "lastModifiedDateTime" ], "type": "string" }, "select84": { "title": "select84", "enum": [ "parentId", "id", "code", "displayName", "valueId", "valueCode", "valueDisplayName" ], "type": "string" }, "select86": { "title": "select86", "enum": [ "id", "code", "displayName", "dueDateCalculation", "discountDateCalculation", "discountPercent", "calculateDiscountOnCreditMemos", "lastModifiedDateTime" ], "type": "string" }, "select92": { "title": "select92", "enum": [ "lineNumber", "display", "netChange", "lineType", "indentation", "dateFilter" ], "type": "string" }, "select94": { "title": "select94", "enum": [ "id", "code", "displayName", "addressFormat", "lastModifiedDateTime" ], "type": "string" }, "select96": { "title": "select96", "enum": [ "id", "number", "externalDocumentNumber", "orderDate", "customerId", "contactId", "customerNumber", "customerName", "billToName", "billToCustomerId", "billToCustomerNumber", "shipToName", "shipToContact", "sellingPostalAddress", "billingPostalAddress", "shippingPostalAddress", "currencyId", "currencyCode", "pricesIncludeTax", "paymentTermsId", "shipmentMethodId", "salesperson", "partialShipping", "requestedDeliveryDate", "discountAmount", "discountAppliedBeforeTax", "totalAmountExcludingTax", "totalTaxAmount", "totalAmountIncludingTax", "fullyShipped", "status", "lastModifiedDateTime", "phoneNumber", "email" ], "type": "string" }, "select98": { "title": "select98", "enum": [ "id", "documentId", "sequence", "itemId", "accountId", "lineType", "lineDetails", "description", "unitOfMeasureId", "unitOfMeasure", "quantity", "unitPrice", "discountAmount", "discountPercent", "discountAppliedBeforeTax", "amountExcludingTax", "taxCode", "taxPercent", "totalTaxAmount", "amountIncludingTax", "invoiceDiscountAllocation", "netAmount", "netTaxAmount", "netAmountIncludingTax", "shipmentDate", "shippedQuantity", "invoicedQuantity", "invoiceQuantity", "shipQuantity" ], "type": "string" }, "select104": { "title": "select104", "enum": [ "id", "code", "displayName", "internationalStandardCode", "lastModifiedDateTime" ], "type": "string" }, "select106": { "title": "select106", "enum": [ "customerId", "customerNumber", "name", "currencyCode", "balanceDue", "currentAmount", "period1Amount", "period2Amount", "period3Amount", "agedAsOfDate", "periodLengthFilter" ], "type": "string" }, "select108": { "title": "select108", "enum": [ "vendorId", "vendorNumber", "name", "currencyCode", "balanceDue", "currentAmount", "period1Amount", "period2Amount", "period3Amount", "agedAsOfDate", "periodLengthFilter" ], "type": "string" }, "select110": { "title": "select110", "enum": [ "lineNumber", "display", "balance", "lineType", "indentation", "dateFilter" ], "type": "string" }, "select112": { "title": "select112", "enum": [ "number", "accountId", "accountType", "display", "totalDebit", "totalCredit", "balanceAtDateDebit", "balanceAtDateCredit", "dateFilter" ], "type": "string" }, "select118": { "title": "select118", "enum": [ "id", "number", "externalDocumentNumber", "documentDate", "dueDate", "customerId", "contactId", "customerNumber", "customerName", "billToName", "billToCustomerId", "billToCustomerNumber", "shipToName", "shipToContact", "sellingPostalAddress", "billingPostalAddress", "shippingPostalAddress", "currencyId", "currencyCode", "paymentTermsId", "shipmentMethodId", "salesperson", "discountAmount", "totalAmountExcludingTax", "totalTaxAmount", "totalAmountIncludingTax", "status", "sentDate", "validUntilDate", "acceptedDate", "lastModifiedDateTime", "phoneNumber", "email" ], "type": "string" }, "select120": { "title": "select120", "enum": [ "id", "documentId", "sequence", "itemId", "accountId", "lineType", "lineDetails", "description", "unitOfMeasureId", "unitOfMeasure", "unitPrice", "quantity", "discountAmount", "discountPercent", "discountAppliedBeforeTax", "amountExcludingTax", "taxCode", "taxPercent", "totalTaxAmount", "amountIncludingTax", "netAmount", "netTaxAmount", "netAmountIncludingTax" ], "type": "string" }, "select126": { "title": "select126", "enum": [ "id", "number", "externalDocumentNumber", "creditMemoDate", "dueDate", "customerId", "contactId", "customerNumber", "customerName", "billToName", "billToCustomerId", "billToCustomerNumber", "sellingPostalAddress", "billingPostalAddress", "currencyId", "currencyCode", "paymentTermsId", "shipmentMethodId", "salesperson", "pricesIncludeTax", "discountAmount", "discountAppliedBeforeTax", "totalAmountExcludingTax", "totalTaxAmount", "totalAmountIncludingTax", "status", "lastModifiedDateTime", "invoiceId", "invoiceNumber", "phoneNumber", "email" ], "type": "string" }, "select134": { "title": "select134", "enum": [ "generalLedgerEntryNumber", "id", "fileName", "byteSize", "content", "createdDateTime" ], "type": "string" }, "select136": { "title": "select136", "enum": [ "id", "number", "invoiceDate", "dueDate", "vendorInvoiceNumber", "vendorId", "vendorNumber", "vendorName", "payToName", "payToContact", "payToVendorId", "payToVendorNumber", "shipToName", "shipToContact", "buyFromAddress", "payToAddress", "shipToAddress", "currencyId", "currencyCode", "pricesIncludeTax", "discountAmount", "discountAppliedBeforeTax", "totalAmountExcludingTax", "totalTaxAmount", "totalAmountIncludingTax", "status", "lastModifiedDateTime" ], "type": "string" }, "select138": { "title": "select138", "enum": [ "id", "documentId", "sequence", "itemId", "accountId", "lineType", "lineDetails", "description", "unitOfMeasure", "unitCost", "quantity", "discountAmount", "discountPercent", "discountAppliedBeforeTax", "amountExcludingTax", "taxCode", "taxPercent", "totalTaxAmount", "amountIncludingTax", "invoiceDiscountAllocation", "netAmount", "netTaxAmount", "netAmountIncludingTax", "expectedReceiptDate" ], "type": "string" }, "select144": { "title": "select144", "enum": [ "id", "number", "displayName" ], "type": "string" }, "select148": { "title": "select148", "enum": [ "customerId", "customerNumber", "name", "totalSalesAmount", "dateFilter_FilterOnly" ], "type": "string" }, "select150": { "title": "select150", "enum": [ "vendorId", "vendorNumber", "name", "totalPurchaseAmount", "dateFilter_FilterOnly" ], "type": "string" }, "CompaniesAPIAccountsResponse": { "title": "CompaniesAPIAccountsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/account" }, "description": "" } } }, "CompaniesAPIAgedAccountsPayableResponse": { "title": "CompaniesAPIAgedAccountsPayableResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/agedAccountsPayable" }, "description": "" } } }, "CompaniesAPIAgedAccountsReceivableResponse": { "title": "CompaniesAPIAgedAccountsReceivableResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/agedAccountsReceivable" }, "description": "" } } }, "CompaniesAPIAttachmentsResponse": { "title": "CompaniesAPIAttachmentsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/attachments" }, "description": "" } } }, "CompaniesAPIBalanceSheetResponse": { "title": "CompaniesAPIBalanceSheetResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/balanceSheet" }, "description": "" } } }, "CompaniesAPIBankAccountsResponse": { "title": "CompaniesAPIBankAccountsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/bankAccount" }, "description": "" } } }, "CompaniesAPICashFlowStatementResponse": { "title": "CompaniesAPICashFlowStatementResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/cashFlowStatement" }, "description": "" } } }, "CompaniesAPICompanyInformationResponse": { "title": "CompaniesAPICompanyInformationResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/companyInformation" }, "description": "" } } }, "CompaniesAPICountriesRegionsResponse": { "title": "CompaniesAPICountriesRegionsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/countryRegion" }, "description": "" } } }, "CompaniesAPICurrenciesResponse": { "title": "CompaniesAPICurrenciesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/currency" }, "description": "" } } }, "CompaniesAPICustomerFinancialDetailsResponse": { "title": "CompaniesAPICustomerFinancialDetailsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/customerFinancialDetail" }, "description": "" } } }, "CompaniesAPICustomerPaymentJournalsAPICustomerPaymentsResponse": { "title": "CompaniesAPICustomerPaymentJournalsAPICustomerPaymentsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/customerPayment" }, "description": "" } } }, "CompaniesAPICustomerPaymentJournalsResponse": { "title": "CompaniesAPICustomerPaymentJournalsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/customerPaymentJournal" }, "description": "" } } }, "CompaniesAPICustomerPaymentsResponse": { "title": "CompaniesAPICustomerPaymentsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/customerPayment" }, "description": "" } } }, "CompaniesAPICustomersAPICustomerFinancialDetailsResponse": { "title": "CompaniesAPICustomersAPICustomerFinancialDetailsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/customerFinancialDetail" }, "description": "" } } }, "CompaniesAPICustomersAPIDefaultDimensionsResponse": { "title": "CompaniesAPICustomersAPIDefaultDimensionsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/defaultDimensions" }, "description": "" } } }, "CompaniesAPICustomersAPIPictureResponse": { "title": "CompaniesAPICustomersAPIPictureResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/picture" }, "description": "" } } }, "CompaniesAPICustomersResponse": { "title": "CompaniesAPICustomersResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/customer" }, "description": "" } } }, "CompaniesAPICustomerSalesResponse": { "title": "CompaniesAPICustomerSalesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/customerSale" }, "description": "" } } }, "CompaniesAPIDefaultDimensionsResponse": { "title": "CompaniesAPIDefaultDimensionsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/defaultDimensions" }, "description": "" } } }, "CompaniesAPIDimensionLinesResponse": { "title": "CompaniesAPIDimensionLinesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/dimensionLine" }, "description": "" } } }, "CompaniesAPIDimensionsAPIDimensionValuesResponse": { "title": "CompaniesAPIDimensionsAPIDimensionValuesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/dimensionValue" }, "description": "" } } }, "CompaniesAPIDimensionsResponse": { "title": "CompaniesAPIDimensionsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/dimension" }, "description": "" } } }, "CompaniesAPIDimensionValuesResponse": { "title": "CompaniesAPIDimensionValuesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/dimensionValue" }, "description": "" } } }, "CompaniesAPIEmployeesAPIDefaultDimensionsResponse": { "title": "CompaniesAPIEmployeesAPIDefaultDimensionsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/defaultDimensions" }, "description": "" } } }, "CompaniesAPIEmployeesAPIPictureResponse": { "title": "CompaniesAPIEmployeesAPIPictureResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/picture" }, "description": "" } } }, "CompaniesAPIEmployeesAPITimeRegistrationEntriesResponse": { "title": "CompaniesAPIEmployeesAPITimeRegistrationEntriesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/timeRegistrationEntry" }, "description": "" } } }, "CompaniesAPIEmployeesResponse": { "title": "CompaniesAPIEmployeesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/employee" }, "description": "" } } }, "CompaniesAPIGeneralLedgerEntriesResponse": { "title": "CompaniesAPIGeneralLedgerEntriesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/generalLedgerEntry" }, "description": "" } } }, "CompaniesAPIGeneralLedgerEntryAttachmentsResponse": { "title": "CompaniesAPIGeneralLedgerEntryAttachmentsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/generalLedgerEntryAttachments" }, "description": "" } } }, "CompaniesAPIIncomeStatementResponse": { "title": "CompaniesAPIIncomeStatementResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/incomeStatement" }, "description": "" } } }, "CompaniesAPIItemCategoriesResponse": { "title": "CompaniesAPIItemCategoriesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/itemCategory" }, "description": "" } } }, "CompaniesAPIItemsAPIDefaultDimensionsResponse": { "title": "CompaniesAPIItemsAPIDefaultDimensionsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/defaultDimensions" }, "description": "" } } }, "CompaniesAPIItemsAPIPictureResponse": { "title": "CompaniesAPIItemsAPIPictureResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/picture" }, "description": "" } } }, "CompaniesAPIItemsResponse": { "title": "CompaniesAPIItemsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/item" }, "description": "" } } }, "CompaniesAPIJournalLinesAPIAttachmentsResponse": { "title": "CompaniesAPIJournalLinesAPIAttachmentsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/attachments" }, "description": "" } } }, "CompaniesAPIJournalLinesResponse": { "title": "CompaniesAPIJournalLinesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/journalLine" }, "description": "" } } }, "CompaniesAPIJournalsAPIJournalLinesJournalLineIdAPIAttachmentsResponse": { "title": "CompaniesAPIJournalsAPIJournalLinesJournalLineIdAPIAttachmentsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/attachments" }, "description": "" } } }, "CompaniesAPIJournalsAPIJournalLinesResponse": { "title": "CompaniesAPIJournalsAPIJournalLinesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/journalLine" }, "description": "" } } }, "CompaniesAPIJournalsResponse": { "title": "CompaniesAPIJournalsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/journal" }, "description": "" } } }, "CompaniesAPIPaymentMethodsResponse": { "title": "CompaniesAPIPaymentMethodsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/paymentMethod" }, "description": "" } } }, "CompaniesAPIPaymentTermsResponse": { "title": "CompaniesAPIPaymentTermsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/paymentTerm" }, "description": "" } } }, "CompaniesAPIPdfDocumentResponse": { "title": "CompaniesAPIPdfDocumentResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/pdfDocument" }, "description": "" } } }, "CompaniesAPIPictureResponse": { "title": "CompaniesAPIPictureResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/picture" }, "description": "" } } }, "CompaniesAPIProjectsResponse": { "title": "CompaniesAPIProjectsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/project" }, "description": "" } } }, "CompaniesAPIPurchaseInvoiceLinesResponse": { "title": "CompaniesAPIPurchaseInvoiceLinesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/purchaseInvoiceLine" }, "description": "" } } }, "CompaniesAPIPurchaseInvoicesAPIPdfDocumentResponse": { "title": "CompaniesAPIPurchaseInvoicesAPIPdfDocumentResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/pdfDocument" }, "description": "" } } }, "CompaniesAPIPurchaseInvoicesAPIPurchaseInvoiceLinesResponse": { "title": "CompaniesAPIPurchaseInvoicesAPIPurchaseInvoiceLinesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/purchaseInvoiceLine" }, "description": "" } } }, "CompaniesAPIPurchaseInvoicesResponse": { "title": "CompaniesAPIPurchaseInvoicesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/purchaseInvoice" }, "description": "" } } }, "CompaniesAPIRetainedEarningsStatementResponse": { "title": "CompaniesAPIRetainedEarningsStatementResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/retainedEarningsStatement" }, "description": "" } } }, "CompaniesAPISalesCreditMemoLinesResponse": { "title": "CompaniesAPISalesCreditMemoLinesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/salesCreditMemoLine" }, "description": "" } } }, "CompaniesAPISalesCreditMemosAPIPdfDocumentResponse": { "title": "CompaniesAPISalesCreditMemosAPIPdfDocumentResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/pdfDocument" }, "description": "" } } }, "CompaniesAPISalesCreditMemosAPISalesCreditMemoLinesResponse": { "title": "CompaniesAPISalesCreditMemosAPISalesCreditMemoLinesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/salesCreditMemoLine" }, "description": "" } } }, "CompaniesAPISalesCreditMemosResponse": { "title": "CompaniesAPISalesCreditMemosResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/salesCreditMemo" }, "description": "" } } }, "CompaniesAPISalesInvoiceLinesResponse": { "title": "CompaniesAPISalesInvoiceLinesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/salesInvoiceLine" }, "description": "" } } }, "CompaniesAPISalesInvoicesAPIPdfDocumentResponse": { "title": "CompaniesAPISalesInvoicesAPIPdfDocumentResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/pdfDocument" }, "description": "" } } }, "CompaniesAPISalesInvoicesAPISalesInvoiceLinesResponse": { "title": "CompaniesAPISalesInvoicesAPISalesInvoiceLinesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/salesInvoiceLine" }, "description": "" } } }, "CompaniesAPISalesInvoicesResponse": { "title": "CompaniesAPISalesInvoicesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/salesInvoice" }, "description": "" } } }, "CompaniesAPISalesOrderLinesResponse": { "title": "CompaniesAPISalesOrderLinesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/salesOrderLine" }, "description": "" } } }, "CompaniesAPISalesOrdersAPISalesOrderLinesResponse": { "title": "CompaniesAPISalesOrdersAPISalesOrderLinesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/salesOrderLine" }, "description": "" } } }, "CompaniesAPISalesOrdersResponse": { "title": "CompaniesAPISalesOrdersResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/salesOrder" }, "description": "" } } }, "CompaniesAPISalesQuoteLinesResponse": { "title": "CompaniesAPISalesQuoteLinesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/salesQuoteLine" }, "description": "" } } }, "CompaniesAPISalesQuotesAPIPdfDocumentResponse": { "title": "CompaniesAPISalesQuotesAPIPdfDocumentResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/pdfDocument" }, "description": "" } } }, "CompaniesAPISalesQuotesAPISalesQuoteLinesResponse": { "title": "CompaniesAPISalesQuotesAPISalesQuoteLinesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/salesQuoteLine" }, "description": "" } } }, "CompaniesAPISalesQuotesResponse": { "title": "CompaniesAPISalesQuotesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/salesQuote" }, "description": "" } } }, "CompaniesAPIShipmentMethodsResponse": { "title": "CompaniesAPIShipmentMethodsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/shipmentMethod" }, "description": "" } } }, "CompaniesAPITaxAreasResponse": { "title": "CompaniesAPITaxAreasResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/taxArea" }, "description": "" } } }, "CompaniesAPITaxGroupsResponse": { "title": "CompaniesAPITaxGroupsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/taxGroup" }, "description": "" } } }, "CompaniesAPITimeRegistrationEntriesResponse": { "title": "CompaniesAPITimeRegistrationEntriesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/timeRegistrationEntry" }, "description": "" } } }, "CompaniesAPITrialBalanceResponse": { "title": "CompaniesAPITrialBalanceResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/trialBalance" }, "description": "" } } }, "CompaniesAPIUnitsOfMeasureResponse": { "title": "CompaniesAPIUnitsOfMeasureResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/unitOfMeasure" }, "description": "" } } }, "CompaniesAPIVendorPurchasesResponse": { "title": "CompaniesAPIVendorPurchasesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/vendorPurchase" }, "description": "" } } }, "CompaniesAPIVendorsAPIDefaultDimensionsResponse": { "title": "CompaniesAPIVendorsAPIDefaultDimensionsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/defaultDimensions" }, "description": "" } } }, "CompaniesAPIVendorsAPIPictureResponse": { "title": "CompaniesAPIVendorsAPIPictureResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/picture" }, "description": "" } } }, "CompaniesAPIVendorsResponse": { "title": "CompaniesAPIVendorsResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/vendor" }, "description": "" } } }, "CompaniesResponse": { "title": "CompaniesResponse", "type": "object", "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/company" }, "description": "" } } }, "customer1": { "title": "customer1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central customer entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central customer entity", "nullable": true }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central customer entity" }, "type": { "type": "string", "description": "(v1.0) The type property for the Dynamics 365 Business Central customer entity", "nullable": true }, "address": { "$ref": "#/components/schemas/postaladdresstype" }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central customer entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central customer entity", "nullable": true }, "website": { "maxLength": 80, "type": "string", "description": "(v1.0) The website property for the Dynamics 365 Business Central customer entity", "nullable": true }, "taxLiable": { "type": "boolean", "description": "(v1.0) The taxLiable property for the Dynamics 365 Business Central customer entity", "nullable": true }, "taxAreaId": { "type": "string", "description": "(v1.0) The taxAreaId property for the Dynamics 365 Business Central customer entity", "format": "uuid", "nullable": true }, "taxAreaDisplayName": { "type": "string", "description": "(v1.0) The taxAreaDisplayName property for the Dynamics 365 Business Central customer entity", "nullable": true }, "taxRegistrationNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central customer entity", "nullable": true }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central customer entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central customer entity", "nullable": true }, "paymentTermsId": { "type": "string", "description": "(v1.0) The paymentTermsId property for the Dynamics 365 Business Central customer entity", "format": "uuid", "nullable": true }, "shipmentMethodId": { "type": "string", "description": "(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central customer entity", "format": "uuid", "nullable": true }, "paymentMethodId": { "type": "string", "description": "(v1.0) The paymentMethodId property for the Dynamics 365 Business Central customer entity", "format": "uuid", "nullable": true }, "blocked": { "type": "string", "description": "(v1.0) The blocked property for the Dynamics 365 Business Central customer entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customer entity", "format": "date-time", "nullable": true } } }, "customerPayment1": { "title": "customerPayment1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central customerPayment entity", "format": "uuid" }, "journalDisplayName": { "type": "string", "description": "(v1.0) The journalDisplayName property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "lineNumber": { "type": "integer", "description": "(v1.0) The lineNumber property for the Dynamics 365 Business Central customerPayment entity", "format": "int32", "nullable": true }, "customerId": { "type": "string", "description": "(v1.0) The customerId property for the Dynamics 365 Business Central customerPayment entity", "format": "uuid", "nullable": true }, "customerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The customerNumber property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "contactId": { "maxLength": 250, "type": "string", "description": "(v1.0) The contactId property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "postingDate": { "type": "string", "description": "(v1.0) The postingDate property for the Dynamics 365 Business Central customerPayment entity", "format": "date-time", "nullable": true }, "documentNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The documentNumber property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "externalDocumentNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "amount": { "type": "number", "description": "(v1.0) The amount property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "appliesToInvoiceId": { "type": "string", "description": "(v1.0) The appliesToInvoiceId property for the Dynamics 365 Business Central customerPayment entity", "format": "uuid", "nullable": true }, "appliesToInvoiceNumber": { "type": "string", "description": "(v1.0) The appliesToInvoiceNumber property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "comment": { "maxLength": 250, "type": "string", "description": "(v1.0) The comment property for the Dynamics 365 Business Central customerPayment entity", "nullable": true }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/dimensiontype" }, "description": "" }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customerPayment entity", "format": "date-time", "nullable": true } } }, "customerPaymentJournal1": { "title": "customerPaymentJournal1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central customerPaymentJournal entity", "format": "uuid" }, "code": { "maxLength": 10, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central customerPaymentJournal entity" }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central customerPaymentJournal entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central customerPaymentJournal entity", "format": "date-time", "nullable": true }, "balancingAccountId": { "type": "string", "description": "(v1.0) The balancingAccountId property for the Dynamics 365 Business Central customerPaymentJournal entity", "format": "uuid", "nullable": true }, "balancingAccountNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The balancingAccountNumber property for the Dynamics 365 Business Central customerPaymentJournal entity", "nullable": true } } }, "defaultDimensions1": { "title": "defaultDimensions1", "type": "object", "properties": { "parentId": { "type": "string", "description": "(v1.0) The parentId property for the Dynamics 365 Business Central defaultDimensions entity", "format": "uuid" }, "dimensionId": { "type": "string", "description": "(v1.0) The dimensionId property for the Dynamics 365 Business Central defaultDimensions entity", "format": "uuid" }, "dimensionCode": { "maxLength": 20, "type": "string", "description": "(v1.0) The dimensionCode property for the Dynamics 365 Business Central defaultDimensions entity", "nullable": true }, "dimensionValueId": { "type": "string", "description": "(v1.0) The dimensionValueId property for the Dynamics 365 Business Central defaultDimensions entity", "format": "uuid", "nullable": true }, "dimensionValueCode": { "maxLength": 20, "type": "string", "description": "(v1.0) The dimensionValueCode property for the Dynamics 365 Business Central defaultDimensions entity", "nullable": true }, "postingValidation": { "type": "string", "description": "(v1.0) The postingValidation property for the Dynamics 365 Business Central defaultDimensions entity", "nullable": true } } }, "dimensionLine1": { "title": "dimensionLine1", "type": "object", "properties": { "parentId": { "type": "string", "description": "(v1.0) The parentId property for the Dynamics 365 Business Central dimensionLine entity", "format": "uuid" }, "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central dimensionLine entity", "format": "uuid" }, "code": { "maxLength": 20, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central dimensionLine entity", "nullable": true }, "displayName": { "maxLength": 30, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central dimensionLine entity", "nullable": true }, "valueId": { "type": "string", "description": "(v1.0) The valueId property for the Dynamics 365 Business Central dimensionLine entity", "format": "uuid", "nullable": true }, "valueCode": { "type": "string", "description": "(v1.0) The valueCode property for the Dynamics 365 Business Central dimensionLine entity", "nullable": true }, "valueDisplayName": { "maxLength": 50, "type": "string", "description": "(v1.0) The valueDisplayName property for the Dynamics 365 Business Central dimensionLine entity", "nullable": true } } }, "employee1": { "title": "employee1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central employee entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central employee entity", "nullable": true }, "displayName": { "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central employee entity", "nullable": true }, "givenName": { "maxLength": 30, "type": "string", "description": "(v1.0) The givenName property for the Dynamics 365 Business Central employee entity", "nullable": true }, "middleName": { "maxLength": 30, "type": "string", "description": "(v1.0) The middleName property for the Dynamics 365 Business Central employee entity", "nullable": true }, "surname": { "maxLength": 30, "type": "string", "description": "(v1.0) The surname property for the Dynamics 365 Business Central employee entity", "nullable": true }, "jobTitle": { "maxLength": 30, "type": "string", "description": "(v1.0) The jobTitle property for the Dynamics 365 Business Central employee entity", "nullable": true }, "address": { "$ref": "#/components/schemas/postaladdresstype" }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central employee entity", "nullable": true }, "mobilePhone": { "maxLength": 30, "type": "string", "description": "(v1.0) The mobilePhone property for the Dynamics 365 Business Central employee entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central employee entity", "nullable": true }, "personalEmail": { "maxLength": 80, "type": "string", "description": "(v1.0) The personalEmail property for the Dynamics 365 Business Central employee entity", "nullable": true }, "employmentDate": { "type": "string", "description": "(v1.0) The employmentDate property for the Dynamics 365 Business Central employee entity", "format": "date-time", "nullable": true }, "terminationDate": { "type": "string", "description": "(v1.0) The terminationDate property for the Dynamics 365 Business Central employee entity", "format": "date-time", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central employee entity", "nullable": true }, "birthDate": { "type": "string", "description": "(v1.0) The birthDate property for the Dynamics 365 Business Central employee entity", "format": "date-time", "nullable": true }, "statisticsGroupCode": { "maxLength": 10, "type": "string", "description": "(v1.0) The statisticsGroupCode property for the Dynamics 365 Business Central employee entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central employee entity", "format": "date-time", "nullable": true } } }, "generalLedgerEntryAttachments1": { "title": "generalLedgerEntryAttachments1", "type": "object", "properties": { "generalLedgerEntryNumber": { "type": "integer", "description": "(v1.0) The generalLedgerEntryNumber property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity", "format": "int32" }, "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity", "format": "uuid" }, "fileName": { "maxLength": 250, "type": "string", "description": "(v1.0) The fileName property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity", "nullable": true }, "byteSize": { "type": "integer", "description": "(v1.0) The byteSize property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity", "format": "int32", "nullable": true }, "content": { "type": "string", "description": "(v1.0) The content property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity", "format": "binary", "nullable": true }, "createdDateTime": { "type": "string", "description": "(v1.0) The createdDateTime property for the Dynamics 365 Business Central generalLedgerEntryAttachments entity", "format": "date-time", "nullable": true } } }, "item1": { "title": "item1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central item entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central item entity", "nullable": true }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central item entity", "nullable": true }, "type": { "type": "string", "description": "(v1.0) The type property for the Dynamics 365 Business Central item entity", "nullable": true }, "itemCategoryId": { "type": "string", "description": "(v1.0) The itemCategoryId property for the Dynamics 365 Business Central item entity", "format": "uuid", "nullable": true }, "itemCategoryCode": { "maxLength": 20, "type": "string", "description": "(v1.0) The itemCategoryCode property for the Dynamics 365 Business Central item entity", "nullable": true }, "blocked": { "type": "boolean", "description": "(v1.0) The blocked property for the Dynamics 365 Business Central item entity", "nullable": true }, "baseUnitOfMeasureId": { "type": "string", "description": "(v1.0) The baseUnitOfMeasureId property for the Dynamics 365 Business Central item entity", "format": "uuid", "nullable": true }, "baseUnitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "gtin": { "maxLength": 14, "type": "string", "description": "(v1.0) The gtin property for the Dynamics 365 Business Central item entity", "nullable": true }, "inventory": { "type": "number", "description": "(v1.0) The inventory property for the Dynamics 365 Business Central item entity", "nullable": true }, "unitPrice": { "type": "number", "description": "(v1.0) The unitPrice property for the Dynamics 365 Business Central item entity", "nullable": true }, "priceIncludesTax": { "type": "boolean", "description": "(v1.0) The priceIncludesTax property for the Dynamics 365 Business Central item entity", "nullable": true }, "unitCost": { "type": "number", "description": "(v1.0) The unitCost property for the Dynamics 365 Business Central item entity", "nullable": true }, "taxGroupId": { "type": "string", "description": "(v1.0) The taxGroupId property for the Dynamics 365 Business Central item entity", "format": "uuid", "nullable": true }, "taxGroupCode": { "maxLength": 20, "type": "string", "description": "(v1.0) The taxGroupCode property for the Dynamics 365 Business Central item entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central item entity", "format": "date-time", "nullable": true } } }, "journal1": { "title": "journal1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central journal entity", "format": "uuid" }, "code": { "maxLength": 10, "type": "string", "description": "(v1.0) The code property for the Dynamics 365 Business Central journal entity" }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central journal entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central journal entity", "format": "date-time", "nullable": true }, "balancingAccountId": { "type": "string", "description": "(v1.0) The balancingAccountId property for the Dynamics 365 Business Central journal entity", "format": "uuid", "nullable": true }, "balancingAccountNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The balancingAccountNumber property for the Dynamics 365 Business Central journal entity", "nullable": true } } }, "journalLine1": { "title": "journalLine1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central journalLine entity", "format": "uuid" }, "journalDisplayName": { "type": "string", "description": "(v1.0) The journalDisplayName property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "lineNumber": { "type": "integer", "description": "(v1.0) The lineNumber property for the Dynamics 365 Business Central journalLine entity", "format": "int32", "nullable": true }, "accountType": { "type": "string", "description": "(v1.0) The accountType property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central journalLine entity", "format": "uuid", "nullable": true }, "accountNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The accountNumber property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "postingDate": { "type": "string", "description": "(v1.0) The postingDate property for the Dynamics 365 Business Central journalLine entity", "format": "date-time", "nullable": true }, "documentNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The documentNumber property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "externalDocumentNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "amount": { "type": "number", "description": "(v1.0) The amount property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "comment": { "maxLength": 250, "type": "string", "description": "(v1.0) The comment property for the Dynamics 365 Business Central journalLine entity", "nullable": true }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/dimensiontype" }, "description": "" }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central journalLine entity", "format": "date-time", "nullable": true } } }, "picture1": { "title": "picture1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central picture entity", "format": "uuid" }, "width": { "type": "integer", "description": "(v1.0) The width property for the Dynamics 365 Business Central picture entity", "format": "int32", "nullable": true }, "height": { "type": "integer", "description": "(v1.0) The height property for the Dynamics 365 Business Central picture entity", "format": "int32", "nullable": true }, "contentType": { "maxLength": 100, "type": "string", "description": "(v1.0) The contentType property for the Dynamics 365 Business Central picture entity", "nullable": true }, "content": { "type": "string", "description": "(v1.0) The content property for the Dynamics 365 Business Central picture entity", "format": "binary", "nullable": true } } }, "purchaseInvoice1": { "title": "purchaseInvoice1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "invoiceDate": { "type": "string", "description": "(v1.0) The invoiceDate property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "date-time", "nullable": true }, "dueDate": { "type": "string", "description": "(v1.0) The dueDate property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "date-time", "nullable": true }, "vendorInvoiceNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The vendorInvoiceNumber property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "vendorId": { "type": "string", "description": "(v1.0) The vendorId property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "uuid", "nullable": true }, "vendorNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The vendorNumber property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "vendorName": { "maxLength": 100, "type": "string", "description": "(v1.0) The vendorName property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "payToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The payToName property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "payToContact": { "maxLength": 100, "type": "string", "description": "(v1.0) The payToContact property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "payToVendorId": { "type": "string", "description": "(v1.0) The payToVendorId property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "uuid", "nullable": true }, "payToVendorNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The payToVendorNumber property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "shipToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToName property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "shipToContact": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToContact property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "buyFromAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "payToAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "shipToAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "pricesIncludeTax": { "type": "boolean", "description": "(v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "totalAmountExcludingTax": { "type": "number", "description": "(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "totalAmountIncludingTax": { "type": "number", "description": "(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central purchaseInvoice entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central purchaseInvoice entity", "format": "date-time", "nullable": true } } }, "purchaseInvoiceLine1": { "title": "purchaseInvoiceLine1", "type": "object", "properties": { "id": { "maxLength": 50, "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central purchaseInvoiceLine entity" }, "documentId": { "type": "string", "description": "(v1.0) The documentId property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "format": "uuid", "nullable": true }, "sequence": { "type": "integer", "description": "(v1.0) The sequence property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "format": "int32", "nullable": true }, "itemId": { "type": "string", "description": "(v1.0) The itemId property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "format": "uuid", "nullable": true }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "format": "uuid", "nullable": true }, "lineType": { "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "lineDetails": { "$ref": "#/components/schemas/documentlineobjectdetailstype" }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "unitCost": { "type": "number", "description": "(v1.0) The unitCost property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "quantity": { "type": "number", "description": "(v1.0) The quantity property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "discountPercent": { "type": "number", "description": "(v1.0) The discountPercent property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "amountExcludingTax": { "type": "number", "description": "(v1.0) The amountExcludingTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "taxCode": { "maxLength": 50, "type": "string", "description": "(v1.0) The taxCode property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "taxPercent": { "type": "number", "description": "(v1.0) The taxPercent property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "amountIncludingTax": { "type": "number", "description": "(v1.0) The amountIncludingTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "invoiceDiscountAllocation": { "type": "number", "description": "(v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "netAmount": { "type": "number", "description": "(v1.0) The netAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "netTaxAmount": { "type": "number", "description": "(v1.0) The netTaxAmount property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "netAmountIncludingTax": { "type": "number", "description": "(v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "nullable": true }, "expectedReceiptDate": { "type": "string", "description": "(v1.0) The expectedReceiptDate property for the Dynamics 365 Business Central purchaseInvoiceLine entity", "format": "date-time", "nullable": true } } }, "salesCreditMemo1": { "title": "salesCreditMemo1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "externalDocumentNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "creditMemoDate": { "type": "string", "description": "(v1.0) The creditMemoDate property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "date-time", "nullable": true }, "dueDate": { "type": "string", "description": "(v1.0) The dueDate property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "date-time", "nullable": true }, "customerId": { "type": "string", "description": "(v1.0) The customerId property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid", "nullable": true }, "contactId": { "maxLength": 250, "type": "string", "description": "(v1.0) The contactId property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "customerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The customerNumber property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "customerName": { "maxLength": 100, "type": "string", "description": "(v1.0) The customerName property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "billToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The billToName property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "billToCustomerId": { "type": "string", "description": "(v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid", "nullable": true }, "billToCustomerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "sellingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "billingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "paymentTermsId": { "type": "string", "description": "(v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid", "nullable": true }, "shipmentMethodId": { "type": "string", "description": "(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid", "nullable": true }, "salesperson": { "maxLength": 20, "type": "string", "description": "(v1.0) The salesperson property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "pricesIncludeTax": { "type": "boolean", "description": "(v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "totalAmountExcludingTax": { "type": "number", "description": "(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "totalAmountIncludingTax": { "type": "number", "description": "(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "date-time", "nullable": true }, "invoiceId": { "type": "string", "description": "(v1.0) The invoiceId property for the Dynamics 365 Business Central salesCreditMemo entity", "format": "uuid", "nullable": true }, "invoiceNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The invoiceNumber property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central salesCreditMemo entity", "nullable": true } } }, "salesCreditMemoLine1": { "title": "salesCreditMemoLine1", "type": "object", "properties": { "id": { "maxLength": 50, "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesCreditMemoLine entity" }, "documentId": { "type": "string", "description": "(v1.0) The documentId property for the Dynamics 365 Business Central salesCreditMemoLine entity", "format": "uuid", "nullable": true }, "sequence": { "type": "integer", "description": "(v1.0) The sequence property for the Dynamics 365 Business Central salesCreditMemoLine entity", "format": "int32", "nullable": true }, "itemId": { "type": "string", "description": "(v1.0) The itemId property for the Dynamics 365 Business Central salesCreditMemoLine entity", "format": "uuid", "nullable": true }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central salesCreditMemoLine entity", "format": "uuid", "nullable": true }, "lineType": { "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "lineDetails": { "$ref": "#/components/schemas/documentlineobjectdetailstype" }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "unitOfMeasureId": { "type": "string", "description": "(v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesCreditMemoLine entity", "format": "uuid", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "unitPrice": { "type": "number", "description": "(v1.0) The unitPrice property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "quantity": { "type": "number", "description": "(v1.0) The quantity property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "discountPercent": { "type": "number", "description": "(v1.0) The discountPercent property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "amountExcludingTax": { "type": "number", "description": "(v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "taxCode": { "maxLength": 50, "type": "string", "description": "(v1.0) The taxCode property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "taxPercent": { "type": "number", "description": "(v1.0) The taxPercent property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "amountIncludingTax": { "type": "number", "description": "(v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "invoiceDiscountAllocation": { "type": "number", "description": "(v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "netAmount": { "type": "number", "description": "(v1.0) The netAmount property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "netTaxAmount": { "type": "number", "description": "(v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "netAmountIncludingTax": { "type": "number", "description": "(v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesCreditMemoLine entity", "nullable": true }, "shipmentDate": { "type": "string", "description": "(v1.0) The shipmentDate property for the Dynamics 365 Business Central salesCreditMemoLine entity", "format": "date-time", "nullable": true } } }, "salesInvoice1": { "title": "salesInvoice1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "externalDocumentNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "invoiceDate": { "type": "string", "description": "(v1.0) The invoiceDate property for the Dynamics 365 Business Central salesInvoice entity", "format": "date-time", "nullable": true }, "dueDate": { "type": "string", "description": "(v1.0) The dueDate property for the Dynamics 365 Business Central salesInvoice entity", "format": "date-time", "nullable": true }, "customerPurchaseOrderReference": { "maxLength": 35, "type": "string", "description": "(v1.0) The customerPurchaseOrderReference property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "customerId": { "type": "string", "description": "(v1.0) The customerId property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid", "nullable": true }, "contactId": { "maxLength": 250, "type": "string", "description": "(v1.0) The contactId property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "customerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The customerNumber property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "customerName": { "maxLength": 100, "type": "string", "description": "(v1.0) The customerName property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "billToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The billToName property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "billToCustomerId": { "type": "string", "description": "(v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid", "nullable": true }, "billToCustomerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "shipToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToName property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "shipToContact": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToContact property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "sellingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "billingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "shippingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "orderId": { "type": "string", "description": "(v1.0) The orderId property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid", "nullable": true }, "orderNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The orderNumber property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "paymentTermsId": { "type": "string", "description": "(v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid", "nullable": true }, "shipmentMethodId": { "type": "string", "description": "(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesInvoice entity", "format": "uuid", "nullable": true }, "salesperson": { "maxLength": 20, "type": "string", "description": "(v1.0) The salesperson property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "pricesIncludeTax": { "type": "boolean", "description": "(v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "remainingAmount": { "type": "number", "description": "(v1.0) The remainingAmount property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "totalAmountExcludingTax": { "type": "number", "description": "(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "totalAmountIncludingTax": { "type": "number", "description": "(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central salesInvoice entity", "format": "date-time", "nullable": true }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central salesInvoice entity", "nullable": true } } }, "salesInvoiceLine1": { "title": "salesInvoiceLine1", "type": "object", "properties": { "id": { "maxLength": 50, "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesInvoiceLine entity" }, "documentId": { "type": "string", "description": "(v1.0) The documentId property for the Dynamics 365 Business Central salesInvoiceLine entity", "format": "uuid", "nullable": true }, "sequence": { "type": "integer", "description": "(v1.0) The sequence property for the Dynamics 365 Business Central salesInvoiceLine entity", "format": "int32", "nullable": true }, "itemId": { "type": "string", "description": "(v1.0) The itemId property for the Dynamics 365 Business Central salesInvoiceLine entity", "format": "uuid", "nullable": true }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central salesInvoiceLine entity", "format": "uuid", "nullable": true }, "lineType": { "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "lineDetails": { "$ref": "#/components/schemas/documentlineobjectdetailstype" }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "unitOfMeasureId": { "type": "string", "description": "(v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesInvoiceLine entity", "format": "uuid", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "unitPrice": { "type": "number", "description": "(v1.0) The unitPrice property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "quantity": { "type": "number", "description": "(v1.0) The quantity property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "discountPercent": { "type": "number", "description": "(v1.0) The discountPercent property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "amountExcludingTax": { "type": "number", "description": "(v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "taxCode": { "maxLength": 50, "type": "string", "description": "(v1.0) The taxCode property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "taxPercent": { "type": "number", "description": "(v1.0) The taxPercent property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "amountIncludingTax": { "type": "number", "description": "(v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "invoiceDiscountAllocation": { "type": "number", "description": "(v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "netAmount": { "type": "number", "description": "(v1.0) The netAmount property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "netTaxAmount": { "type": "number", "description": "(v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "netAmountIncludingTax": { "type": "number", "description": "(v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesInvoiceLine entity", "nullable": true }, "shipmentDate": { "type": "string", "description": "(v1.0) The shipmentDate property for the Dynamics 365 Business Central salesInvoiceLine entity", "format": "date-time", "nullable": true } } }, "salesOrder1": { "title": "salesOrder1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesOrder entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "externalDocumentNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "orderDate": { "type": "string", "description": "(v1.0) The orderDate property for the Dynamics 365 Business Central salesOrder entity", "format": "date-time", "nullable": true }, "customerId": { "type": "string", "description": "(v1.0) The customerId property for the Dynamics 365 Business Central salesOrder entity", "format": "uuid", "nullable": true }, "contactId": { "maxLength": 250, "type": "string", "description": "(v1.0) The contactId property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "customerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The customerNumber property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "customerName": { "maxLength": 100, "type": "string", "description": "(v1.0) The customerName property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "billToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The billToName property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "billToCustomerId": { "type": "string", "description": "(v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesOrder entity", "format": "uuid", "nullable": true }, "billToCustomerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "shipToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToName property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "shipToContact": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToContact property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "sellingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "billingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "shippingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central salesOrder entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "pricesIncludeTax": { "type": "boolean", "description": "(v1.0) The pricesIncludeTax property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "paymentTermsId": { "type": "string", "description": "(v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesOrder entity", "format": "uuid", "nullable": true }, "shipmentMethodId": { "type": "string", "description": "(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesOrder entity", "format": "uuid", "nullable": true }, "salesperson": { "maxLength": 20, "type": "string", "description": "(v1.0) The salesperson property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "partialShipping": { "type": "boolean", "description": "(v1.0) The partialShipping property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "requestedDeliveryDate": { "type": "string", "description": "(v1.0) The requestedDeliveryDate property for the Dynamics 365 Business Central salesOrder entity", "format": "date-time", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "totalAmountExcludingTax": { "type": "number", "description": "(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "totalAmountIncludingTax": { "type": "number", "description": "(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "fullyShipped": { "type": "boolean", "description": "(v1.0) The fullyShipped property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central salesOrder entity", "format": "date-time", "nullable": true }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesOrder entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central salesOrder entity", "nullable": true } } }, "salesOrderLine1": { "title": "salesOrderLine1", "type": "object", "properties": { "id": { "maxLength": 50, "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesOrderLine entity" }, "documentId": { "type": "string", "description": "(v1.0) The documentId property for the Dynamics 365 Business Central salesOrderLine entity", "format": "uuid", "nullable": true }, "sequence": { "type": "integer", "description": "(v1.0) The sequence property for the Dynamics 365 Business Central salesOrderLine entity", "format": "int32", "nullable": true }, "itemId": { "type": "string", "description": "(v1.0) The itemId property for the Dynamics 365 Business Central salesOrderLine entity", "format": "uuid", "nullable": true }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central salesOrderLine entity", "format": "uuid", "nullable": true }, "lineType": { "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "lineDetails": { "$ref": "#/components/schemas/documentlineobjectdetailstype" }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "unitOfMeasureId": { "type": "string", "description": "(v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesOrderLine entity", "format": "uuid", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "quantity": { "type": "number", "description": "(v1.0) The quantity property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "unitPrice": { "type": "number", "description": "(v1.0) The unitPrice property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "discountPercent": { "type": "number", "description": "(v1.0) The discountPercent property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "amountExcludingTax": { "type": "number", "description": "(v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "taxCode": { "maxLength": 50, "type": "string", "description": "(v1.0) The taxCode property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "taxPercent": { "type": "number", "description": "(v1.0) The taxPercent property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "amountIncludingTax": { "type": "number", "description": "(v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "invoiceDiscountAllocation": { "type": "number", "description": "(v1.0) The invoiceDiscountAllocation property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "netAmount": { "type": "number", "description": "(v1.0) The netAmount property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "netTaxAmount": { "type": "number", "description": "(v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "netAmountIncludingTax": { "type": "number", "description": "(v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "shipmentDate": { "type": "string", "description": "(v1.0) The shipmentDate property for the Dynamics 365 Business Central salesOrderLine entity", "format": "date-time", "nullable": true }, "shippedQuantity": { "type": "number", "description": "(v1.0) The shippedQuantity property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "invoicedQuantity": { "type": "number", "description": "(v1.0) The invoicedQuantity property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "invoiceQuantity": { "type": "number", "description": "(v1.0) The invoiceQuantity property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true }, "shipQuantity": { "type": "number", "description": "(v1.0) The shipQuantity property for the Dynamics 365 Business Central salesOrderLine entity", "nullable": true } } }, "salesQuote1": { "title": "salesQuote1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesQuote entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "externalDocumentNumber": { "maxLength": 35, "type": "string", "description": "(v1.0) The externalDocumentNumber property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "documentDate": { "type": "string", "description": "(v1.0) The documentDate property for the Dynamics 365 Business Central salesQuote entity", "format": "date-time", "nullable": true }, "dueDate": { "type": "string", "description": "(v1.0) The dueDate property for the Dynamics 365 Business Central salesQuote entity", "format": "date-time", "nullable": true }, "customerId": { "type": "string", "description": "(v1.0) The customerId property for the Dynamics 365 Business Central salesQuote entity", "format": "uuid", "nullable": true }, "contactId": { "maxLength": 250, "type": "string", "description": "(v1.0) The contactId property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "customerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The customerNumber property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "customerName": { "maxLength": 100, "type": "string", "description": "(v1.0) The customerName property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "billToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The billToName property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "billToCustomerId": { "type": "string", "description": "(v1.0) The billToCustomerId property for the Dynamics 365 Business Central salesQuote entity", "format": "uuid", "nullable": true }, "billToCustomerNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The billToCustomerNumber property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "shipToName": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToName property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "shipToContact": { "maxLength": 100, "type": "string", "description": "(v1.0) The shipToContact property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "sellingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "billingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "shippingPostalAddress": { "$ref": "#/components/schemas/postaladdresstype" }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central salesQuote entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "paymentTermsId": { "type": "string", "description": "(v1.0) The paymentTermsId property for the Dynamics 365 Business Central salesQuote entity", "format": "uuid", "nullable": true }, "shipmentMethodId": { "type": "string", "description": "(v1.0) The shipmentMethodId property for the Dynamics 365 Business Central salesQuote entity", "format": "uuid", "nullable": true }, "salesperson": { "maxLength": 20, "type": "string", "description": "(v1.0) The salesperson property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "totalAmountExcludingTax": { "type": "number", "description": "(v1.0) The totalAmountExcludingTax property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "totalAmountIncludingTax": { "type": "number", "description": "(v1.0) The totalAmountIncludingTax property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "sentDate": { "type": "string", "description": "(v1.0) The sentDate property for the Dynamics 365 Business Central salesQuote entity", "format": "date-time", "nullable": true }, "validUntilDate": { "type": "string", "description": "(v1.0) The validUntilDate property for the Dynamics 365 Business Central salesQuote entity", "format": "date-time", "nullable": true }, "acceptedDate": { "type": "string", "description": "(v1.0) The acceptedDate property for the Dynamics 365 Business Central salesQuote entity", "format": "date-time", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central salesQuote entity", "format": "date-time", "nullable": true }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central salesQuote entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central salesQuote entity", "nullable": true } } }, "salesQuoteLine1": { "title": "salesQuoteLine1", "type": "object", "properties": { "id": { "maxLength": 50, "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central salesQuoteLine entity" }, "documentId": { "type": "string", "description": "(v1.0) The documentId property for the Dynamics 365 Business Central salesQuoteLine entity", "format": "uuid", "nullable": true }, "sequence": { "type": "integer", "description": "(v1.0) The sequence property for the Dynamics 365 Business Central salesQuoteLine entity", "format": "int32", "nullable": true }, "itemId": { "type": "string", "description": "(v1.0) The itemId property for the Dynamics 365 Business Central salesQuoteLine entity", "format": "uuid", "nullable": true }, "accountId": { "type": "string", "description": "(v1.0) The accountId property for the Dynamics 365 Business Central salesQuoteLine entity", "format": "uuid", "nullable": true }, "lineType": { "type": "string", "description": "(v1.0) The lineType property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "lineDetails": { "$ref": "#/components/schemas/documentlineobjectdetailstype" }, "description": { "maxLength": 100, "type": "string", "description": "(v1.0) The description property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "unitOfMeasureId": { "type": "string", "description": "(v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central salesQuoteLine entity", "format": "uuid", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "unitPrice": { "type": "number", "description": "(v1.0) The unitPrice property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "quantity": { "type": "number", "description": "(v1.0) The quantity property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "discountAmount": { "type": "number", "description": "(v1.0) The discountAmount property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "discountPercent": { "type": "number", "description": "(v1.0) The discountPercent property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "discountAppliedBeforeTax": { "type": "boolean", "description": "(v1.0) The discountAppliedBeforeTax property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "amountExcludingTax": { "type": "number", "description": "(v1.0) The amountExcludingTax property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "taxCode": { "maxLength": 50, "type": "string", "description": "(v1.0) The taxCode property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "taxPercent": { "type": "number", "description": "(v1.0) The taxPercent property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "totalTaxAmount": { "type": "number", "description": "(v1.0) The totalTaxAmount property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "amountIncludingTax": { "type": "number", "description": "(v1.0) The amountIncludingTax property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "netAmount": { "type": "number", "description": "(v1.0) The netAmount property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "netTaxAmount": { "type": "number", "description": "(v1.0) The netTaxAmount property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true }, "netAmountIncludingTax": { "type": "number", "description": "(v1.0) The netAmountIncludingTax property for the Dynamics 365 Business Central salesQuoteLine entity", "nullable": true } } }, "timeRegistrationEntry1": { "title": "timeRegistrationEntry1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "uuid" }, "employeeId": { "type": "string", "description": "(v1.0) The employeeId property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "uuid", "nullable": true }, "employeeNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The employeeNumber property for the Dynamics 365 Business Central timeRegistrationEntry entity", "nullable": true }, "jobId": { "type": "string", "description": "(v1.0) The jobId property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "uuid", "nullable": true }, "jobNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The jobNumber property for the Dynamics 365 Business Central timeRegistrationEntry entity", "nullable": true }, "absence": { "maxLength": 10, "type": "string", "description": "(v1.0) The absence property for the Dynamics 365 Business Central timeRegistrationEntry entity", "nullable": true }, "lineNumber": { "type": "integer", "description": "(v1.0) The lineNumber property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "int32", "nullable": true }, "date": { "type": "string", "description": "(v1.0) The date property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "date-time", "nullable": true }, "quantity": { "type": "number", "description": "(v1.0) The quantity property for the Dynamics 365 Business Central timeRegistrationEntry entity", "nullable": true }, "status": { "type": "string", "description": "(v1.0) The status property for the Dynamics 365 Business Central timeRegistrationEntry entity", "nullable": true }, "unitOfMeasureId": { "type": "string", "description": "(v1.0) The unitOfMeasureId property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "uuid", "nullable": true }, "unitOfMeasure": { "$ref": "#/components/schemas/unitofmeasuretype" }, "dimensions": { "type": "array", "items": { "$ref": "#/components/schemas/dimensiontype" }, "description": "" }, "lastModfiedDateTime": { "type": "string", "description": "(v1.0) The lastModfiedDateTime property for the Dynamics 365 Business Central timeRegistrationEntry entity", "format": "date-time", "nullable": true } } }, "vendor1": { "title": "vendor1", "type": "object", "properties": { "id": { "type": "string", "description": "(v1.0) The id property for the Dynamics 365 Business Central vendor entity", "format": "uuid" }, "number": { "maxLength": 20, "type": "string", "description": "(v1.0) The number property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "displayName": { "maxLength": 100, "type": "string", "description": "(v1.0) The displayName property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "address": { "$ref": "#/components/schemas/postaladdresstype" }, "phoneNumber": { "maxLength": 30, "type": "string", "description": "(v1.0) The phoneNumber property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "email": { "maxLength": 80, "type": "string", "description": "(v1.0) The email property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "website": { "maxLength": 80, "type": "string", "description": "(v1.0) The website property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "taxRegistrationNumber": { "maxLength": 20, "type": "string", "description": "(v1.0) The taxRegistrationNumber property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "currencyId": { "type": "string", "description": "(v1.0) The currencyId property for the Dynamics 365 Business Central vendor entity", "format": "uuid", "nullable": true }, "currencyCode": { "type": "string", "description": "(v1.0) The currencyCode property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "irs1099Code": { "type": "string", "description": "(v1.0) The irs1099Code property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "paymentTermsId": { "type": "string", "description": "(v1.0) The paymentTermsId property for the Dynamics 365 Business Central vendor entity", "format": "uuid", "nullable": true }, "paymentMethodId": { "type": "string", "description": "(v1.0) The paymentMethodId property for the Dynamics 365 Business Central vendor entity", "format": "uuid", "nullable": true }, "taxLiable": { "type": "boolean", "description": "(v1.0) The taxLiable property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "blocked": { "type": "string", "description": "(v1.0) The blocked property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "balance": { "type": "number", "description": "(v1.0) The balance property for the Dynamics 365 Business Central vendor entity", "nullable": true }, "lastModifiedDateTime": { "type": "string", "description": "(v1.0) The lastModifiedDateTime property for the Dynamics 365 Business Central vendor entity", "format": "date-time", "nullable": true } } } }, "securitySchemes": { "oAuth": { "type": "oauth2", "flows": { "implicit": { "authorizationUrl": "https://login.windows.net/common/oauth2/authorize?resource=https://api.businesscentral.dynamics.com/", "scopes": { "Financials.ReadWrite.All": "financials.read.write.all" } } } } } }, "security": [ { "oAuth": [ "Financials.ReadWrite.All" ] } ], "tags": [ { "name": "company", "description": "(v1.0) Represents an object of type company in Dynamics 365 Business Central" }, { "name": "item", "description": "(v1.0) Represents an object of type item in Dynamics 365 Business Central" }, { "name": "picture", "description": "(v1.0) Represents an object of type picture in Dynamics 365 Business Central" }, { "name": "defaultDimensions", "description": "(v1.0) Represents an object of type defaultDimensions in Dynamics 365 Business Central" }, { "name": "customer", "description": "(v1.0) Represents an object of type customer in Dynamics 365 Business Central" }, { "name": "customerFinancialDetail", "description": "(v1.0) Represents an object of type customerFinancialDetail in Dynamics 365 Business Central" }, { "name": "vendor", "description": "(v1.0) Represents an object of type vendor in Dynamics 365 Business Central" }, { "name": "companyInformation", "description": "(v1.0) Represents an object of type companyInformation in Dynamics 365 Business Central" }, { "name": "salesInvoice", "description": "(v1.0) Represents an object of type salesInvoice in Dynamics 365 Business Central" }, { "name": "salesInvoiceLine", "description": "(v1.0) Represents an object of type salesInvoiceLine in Dynamics 365 Business Central" }, { "name": "pdfDocument", "description": "(v1.0) Represents an object of type pdfDocument in Dynamics 365 Business Central" }, { "name": "customerPaymentJournal", "description": "(v1.0) Represents an object of type customerPaymentJournal in Dynamics 365 Business Central" }, { "name": "customerPayment", "description": "(v1.0) Represents an object of type customerPayment in Dynamics 365 Business Central" }, { "name": "account", "description": "(v1.0) Represents an object of type account in Dynamics 365 Business Central" }, { "name": "taxGroup", "description": "(v1.0) Represents an object of type taxGroup in Dynamics 365 Business Central" }, { "name": "journal", "description": "(v1.0) Represents an object of type journal in Dynamics 365 Business Central" }, { "name": "journalLine", "description": "(v1.0) Represents an object of type journalLine in Dynamics 365 Business Central" }, { "name": "attachments", "description": "(v1.0) Represents an object of type attachments in Dynamics 365 Business Central" }, { "name": "employee", "description": "(v1.0) Represents an object of type employee in Dynamics 365 Business Central" }, { "name": "timeRegistrationEntry", "description": "(v1.0) Represents an object of type timeRegistrationEntry in Dynamics 365 Business Central" }, { "name": "generalLedgerEntry", "description": "(v1.0) Represents an object of type generalLedgerEntry in Dynamics 365 Business Central" }, { "name": "currency", "description": "(v1.0) Represents an object of type currency in Dynamics 365 Business Central" }, { "name": "paymentMethod", "description": "(v1.0) Represents an object of type paymentMethod in Dynamics 365 Business Central" }, { "name": "dimension", "description": "(v1.0) Represents an object of type dimension in Dynamics 365 Business Central" }, { "name": "dimensionValue", "description": "(v1.0) Represents an object of type dimensionValue in Dynamics 365 Business Central" }, { "name": "dimensionLine", "description": "(v1.0) Represents an object of type dimensionLine in Dynamics 365 Business Central" }, { "name": "paymentTerm", "description": "(v1.0) Represents an object of type paymentTerm in Dynamics 365 Business Central" }, { "name": "shipmentMethod", "description": "(v1.0) Represents an object of type shipmentMethod in Dynamics 365 Business Central" }, { "name": "itemCategory", "description": "(v1.0) Represents an object of type itemCategory in Dynamics 365 Business Central" }, { "name": "cashFlowStatement", "description": "(v1.0) Represents an object of type cashFlowStatement in Dynamics 365 Business Central" }, { "name": "countryRegion", "description": "(v1.0) Represents an object of type countryRegion in Dynamics 365 Business Central" }, { "name": "salesOrder", "description": "(v1.0) Represents an object of type salesOrder in Dynamics 365 Business Central" }, { "name": "salesOrderLine", "description": "(v1.0) Represents an object of type salesOrderLine in Dynamics 365 Business Central" }, { "name": "retainedEarningsStatement", "description": "(v1.0) Represents an object of type retainedEarningsStatement in Dynamics 365 Business Central" }, { "name": "unitOfMeasure", "description": "(v1.0) Represents an object of type unitOfMeasure in Dynamics 365 Business Central" }, { "name": "agedAccountsReceivable", "description": "(v1.0) Represents an object of type agedAccountsReceivable in Dynamics 365 Business Central" }, { "name": "agedAccountsPayable", "description": "(v1.0) Represents an object of type agedAccountsPayable in Dynamics 365 Business Central" }, { "name": "balanceSheet", "description": "(v1.0) Represents an object of type balanceSheet in Dynamics 365 Business Central" }, { "name": "trialBalance", "description": "(v1.0) Represents an object of type trialBalance in Dynamics 365 Business Central" }, { "name": "incomeStatement", "description": "(v1.0) Represents an object of type incomeStatement in Dynamics 365 Business Central" }, { "name": "taxArea", "description": "(v1.0) Represents an object of type taxArea in Dynamics 365 Business Central" }, { "name": "salesQuote", "description": "(v1.0) Represents an object of type salesQuote in Dynamics 365 Business Central" }, { "name": "salesQuoteLine", "description": "(v1.0) Represents an object of type salesQuoteLine in Dynamics 365 Business Central" }, { "name": "salesCreditMemo", "description": "(v1.0) Represents an object of type salesCreditMemo in Dynamics 365 Business Central" }, { "name": "salesCreditMemoLine", "description": "(v1.0) Represents an object of type salesCreditMemoLine in Dynamics 365 Business Central" }, { "name": "generalLedgerEntryAttachments", "description": "(v1.0) Represents an object of type generalLedgerEntryAttachments in Dynamics 365 Business Central" }, { "name": "purchaseInvoice", "description": "(v1.0) Represents an object of type purchaseInvoice in Dynamics 365 Business Central" }, { "name": "purchaseInvoiceLine", "description": "(v1.0) Represents an object of type purchaseInvoiceLine in Dynamics 365 Business Central" }, { "name": "project", "description": "(v1.0) Represents an object of type project in Dynamics 365 Business Central" }, { "name": "bankAccount", "description": "(v1.0) Represents an object of type bankAccount in Dynamics 365 Business Central" }, { "name": "customerSale", "description": "(v1.0) Represents an object of type customerSale in Dynamics 365 Business Central" }, { "name": "vendorPurchase", "description": "(v1.0) Represents an object of type vendorPurchase in Dynamics 365 Business Central" } ] }