{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a9e743ef-a81a-49d2-b798-b3867915bcad","name":"Breeze Interface - Order Confirmation","description":"# Introduction\n\nThe API is an interface between input data and standard documents in Microsoft Dynamics 365 Business Central. It enables, for example, an update of a purchase order from metadata (with a pre-defined schema).\n\n## JSON Schema for a Purchase Order Update (order confirmation)\n\nStartFragment\n\n``` json\n{\n   \"$schema\":\"http://json-schema.org/draft-04/schema#\",\n   \"type\":\"object\",\n   \"properties\":{\n      \"orderNo\":{\n         \"type\":\"string\"\n      },\n      \"vendorNo\":{\n         \"type\":\"string\"\n      },\n      \"vendorOrderNo\":{\n         \"type\":\"string\"\n      },\n      \"customFields\":{\n         \"type\":\"object\",\n         \"properties\":{\n            \"namesAndValues\":{\n               \"type\":\"array\",\n               \"items\":[\n                  {\n                     \"type\":\"object\",\n                     \"properties\":{\n                        \"name\":{\n                           \"type\":\"string\"\n                        },\n                        \"value\":{\n                           \"type\":\"string\"\n                        }\n                     },\n                     \"required\":[\n                        \"name\",\n                        \"value\"\n                     ]\n                  }\n               ]\n            },\n            \"docClass\":{\n               \"type\":\"string\"\n            }\n         },\n         \"required\":[\n            \"namesAndValues\"\n         ]\n      },\n      \"additionalFields\":{\n         \"type\":\"array\",\n         \"items\":[\n            {\n               \"type\":\"object\",\n               \"properties\":{\n                  \"name\":{\n                     \"type\":\"string\"\n                  },\n                  \"value\":{\n                     \"type\":\"string\"\n                  }\n               },\n               \"required\":[\n                  \"name\",\n                  \"value\"\n               ]\n            }\n         ]\n      },\n      \"dimensions\":{\n         \"type\":\"object\",\n         \"properties\":{\n            \"DIMENSIONCODE1\":{\n               \"type\":\"string\"\n            },\n            \"DIMENSIONCODE2\":{\n               \"type\":\"string\"\n            },\n            \"DIMENSIONCODE3\":{\n               \"type\":\"string\"\n            },\n            \"DIMENSIONCODE4\":{\n               \"type\":\"string\"\n            },\n            \"DIMENSIONCODE5\":{\n               \"type\":\"string\"\n            },\n            \"DIMENSIONCODE6\":{\n               \"type\":\"string\"\n            },\n            \"DIMENSIONCODE7\":{\n               \"type\":\"string\"\n            },\n            \"DIMENSIONCODE8\":{\n               \"type\":\"string\"\n            }\n         }\n      },\n      \"errors\":{\n         \"type\":\"array\",\n         \"items\":[\n            {\n               \"type\":\"string\"\n            }\n         ]\n      },\n      \"lines\":{\n         \"type\":\"array\",\n         \"items\":[\n            {\n               \"type\":\"object\",\n               \"properties\":{\n                  \"lineNo\":{\n                     \"type\":\"integer\"\n                  },\n                  \"type\":{\n                     \"type\":\"string\"\n                  },\n                  \"vendorItemNo\":{\n                     \"type\":\"string\"\n                  },\n                  \"no\":{\n                     \"type\":\"string\"\n                  },\n                  \"description\":{\n                     \"type\":\"string\"\n                  },\n                  \"qty\":{\n                     \"type\":\"integer\"\n                  },\n                  \"uom\":{\n                     \"type\":\"string\"\n                  },\n                  \"unitPrice\":{\n                     \"type\":\"integer\"\n                  },\n                  \"lineDisc\":{\n                     \"type\":\"integer\"\n                  },\n                  \"locationCode\":{\n                     \"type\":\"string\"\n                  },\n                  \"binCode\":{\n                     \"type\":\"string\"\n                  },\n                  \"jobNo\":{\n                     \"type\":\"string\"\n                  },\n                  \"netAmount\":{\n                     \"type\":\"integer\"\n                  },\n                  \"totalAmount\":{\n                     \"type\":\"number\"\n                  },\n                  \"taxRate\":{\n                     \"type\":\"integer\"\n                  },\n                  \"vatBusPostingGroup\":{\n                     \"type\":\"string\"\n                  },\n                  \"vatProdPostingGroup\":{\n                     \"type\":\"string\"\n                  },\n                  \"genProdPostingGroup\":{\n                     \"type\":\"string\"\n                  },\n                  \"genBusPostingGroup\":{\n                     \"type\":\"string\"\n                  },\n                  \"promisedReceiptDate\":{\n                     \"type\":\"string\"\n                  },\n                  \"customFields\":{\n                     \"type\":\"object\",\n                     \"properties\":{\n                        \"namesAndValues\":{\n                           \"type\":\"array\",\n                           \"items\":[\n                              {\n                                 \"type\":\"object\",\n                                 \"properties\":{\n                                    \"name\":{\n                                       \"type\":\"string\"\n                                    },\n                                    \"value\":{\n                                       \"type\":\"string\"\n                                    }\n                                 },\n                                 \"required\":[\n                                    \"name\",\n                                    \"value\"\n                                 ]\n                              }\n                           ]\n                        },\n                        \"docClass\":{\n                           \"type\":\"string\"\n                        }\n                     },\n                     \"required\":[\n                        \"namesAndValues\"\n                     ]\n                  },\n                  \"additionalFields\":{\n                     \"type\":\"array\",\n                     \"items\":[\n                        {\n                           \"type\":\"object\",\n                           \"properties\":{\n                              \"name\":{\n                                 \"type\":\"string\"\n                              },\n                              \"value\":{\n                                 \"type\":\"string\"\n                              }\n                           },\n                           \"required\":[\n                              \"name\",\n                              \"value\"\n                           ]\n                        }\n                     ]\n                  },\n                  \"dimensions\":{\n                     \"type\":\"object\",\n                     \"properties\":{\n                        \"DIMENSIONCODE1\":{\n                           \"type\":\"string\"\n                        },\n                        \"DIMENSIONCODE2\":{\n                           \"type\":\"string\"\n                        },\n                        \"DIMENSIONCODE3\":{\n                           \"type\":\"string\"\n                        },\n                        \"DIMENSIONCODE4\":{\n                           \"type\":\"string\"\n                        },\n                        \"DIMENSIONCODE5\":{\n                           \"type\":\"string\"\n                        },\n                        \"DIMENSIONCODE6\":{\n                           \"type\":\"string\"\n                        },\n                        \"DIMENSIONCODE7\":{\n                           \"type\":\"string\"\n                        },\n                        \"DIMENSIONCODE8\":{\n                           \"type\":\"string\"\n                        }\n                     }\n                  },\n                  \"errors\":{\n                     \"type\":\"array\",\n                     \"items\":[\n                        {\n                           \"type\":\"string\"\n                        }\n                     ]\n                  }\n               },\n               \"required\":[\n                  \"type\",\n                  \"no\",\n                  \"qty\",\n                  \"unitPrice\",\n                  \"uom\",\n                  \"promisedReceiptDate\",\n                  \"vatBusPostingGroup\",\n                  \"vatProdPostingGroup\"\n               ]\n            }\n         ]\n      }\n   },\n   \"required\":[\n      \"orderNo\",\n      \"vendorNo\",\n      \"lines\"\n   ]\n}\n\n ```\n\nEndFragment\n\n# Overview\n\nYou can get, create (post) or edit (patch) BREEZE Documents. Check out the examples for more information.\n\nThe following scenarios are possible:\n\n1. You do not specify a single \"lineNo\" -> All lines in an order are replaced.\n    \n2. You specify at least one \"lineNo\" -> The matching line in an order is updated and \"line\" objects without \"lineNo\" are created in the order\n    \n\n# Authentication\n\nOAuth 2.0\n\n# Rate limit\n\nThe limit is defined by the Microsoft Dynamics 365 Business Central environment.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"23495599","team":4075377,"collectionId":"a9e743ef-a81a-49d2-b798-b3867915bcad","publishedId":"2s93z9b2r4","public":true,"publicUrl":"https://documenter-api.postman.tech/view/23495599/2s93z9b2r4","privateUrl":"https://go.postman.co/documentation/23495599-a9e743ef-a81a-49d2-b798-b3867915bcad","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-06-28T07:42:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/6afce46b244e5fd364d07116aa5716a0542fdb9ba1ef6ffd6efef3e5d7970b7e","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2s93z9b2r4"}