This document contains the necessary data and requirements for integration with the supplyAPI conector, a passive API to connect Purchase and/or Supply Chain systems with ERP systems, as SAP Business One or TOTVS Protheus.
\n__supplyAPI conector currently has the following HTTP REST Plain services - version 2 (v2.2):
\nContent Type: all supplyAPI services use the “content-type” application/json for Parameters (body request) and Responses.
\nAuthentication: supplyAPI uses Basic Authentication (user/password)
\nCharacteristics: pagination, incremental query, default fields, objects and processes, use of custom fields (limited use), API usage and ERP transactions monitoring
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8243187","collectionId":"4c83bf58-1218-42d8-aa44-7924700e9149","publishedId":"TVKA5Khm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-09-17T19:30:44.000Z"},"item":[{"name":"Base Objects","item":[{"name":"Buyers","id":"d301566b-12c9-4714-b7ff-721590951bdb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/buyers?erpKey=1","description":"(sapBusinessOne=53/OSLP, totvsProtheus=SY1)
\nThe search of buyers allows you to filter the ERP by:
\nerpKeyIf no field for unitary query (erpKey) is informed in the request, the search returns as a list.
The buyer service will consider as valid buyer:
\nThe response will inform:
\ncount fieldThis service does not have pagination or incremental treatment.
\nThis service does not have user field (UDF) treatment.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}},"urlObject":{"path":["buyers"],"host":["{{endpoint}}"],"query":[{"description":{"content":"Buyer Primary Key in ERP (optional)
\n","type":"text/plain"},"key":"erpKey","value":"1"}],"variable":[]}},"response":[{"id":"5442d99e-3c00-4f67-8190-1d0f4a5a2834","name":"Buyers - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/buyers","host":["{{endpoint}}"],"path":["buyers"],"query":[{"key":"erpKey","value":"1","description":"Buyer Primary Key in ERP (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"JSESSIONID=308E5DB9432CF3906BE8B611D9EB0117; Path=/B1iXcellerator; HttpOnly"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 05 Nov 2020 18:54:16 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"Buyers\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"buyers\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-05T16:54:11\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"count\": 1,\n \"values\": [\n {\n \"erpKey\": \"1\",\n \"fullName\": \"Helen Roche\",\n \"email\": \"\",\n \"phone\": \"\",\n \"phoneSecondary\": \"\",\n \"cellular\": \"\",\n \"commissionRate\": 0,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"},{"id":"adf214e8-8f18-4745-8b70-00967b7112e2","name":"Buyers - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/buyers","host":["{{endpoint}}"],"path":["buyers"],"query":[{"key":"erpKey","value":"1","description":"Buyer Primary Key in ERP (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Version","value":"1.1"},{"key":"FWRESTBUILD","value":"1.15.0717"},{"key":"Content-Type","value":"application/json"},{"key":"Status","value":"200 OK"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"Buyers\",\n \"system\": \"totvsProtheus\",\n \"target\": \"buyers\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-09T16:57:45\",\n \"code\": \"200\",\n \"success\": true,\n \"count\": 1,\n \"values\": [\n {\n \"erpKey\": \"001\",\n \"erpId\": \"1\",\n \"fullName\": \"API - Intergate\",\n \"email\": \"rafael.ogeda@intergate.net.br\",\n \"phone\": \"+5547988493101\",\n \"phoneSecondary\": \"\",\n \"cellular\": null,\n \"commissionRate\": 0,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"d301566b-12c9-4714-b7ff-721590951bdb"}],"id":"f9b0b73f-5ab8-4e60-9248-4651e03356c8","_postman_id":"f9b0b73f-5ab8-4e60-9248-4651e03356c8","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}}},{"name":"Purchase Contracts NEW","item":[{"name":"Purchase Contracts","id":"f9c6f34a-eadf-4c48-9975-b7a7fb3afcdb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/purchaseContracts?createdFrom=2011-01-01&createdTo=2021-12-31&partnerKey=C001&docStatus=O/A&erpKey=149231&docNum=122608&pageNum=1&updatedAt=2021-05-01T00:00:00","description":"(sapBusinessOne=1250000025/OOAT, totvsProtheus=<>)
\nThis service will allow you to pruchase contracts on the ERP.
\nSearching sales contracts allows you to filter the ERP by:
\ncreatedFrom + createdTo {required}, by partnerKey or docStatus {optional}erpKey or docNumIf no field for unitary query is provided in the request (erpKey or docNum), the query for pruchase contracts is done by creation date from/to (which become mandatory).
The contracts service will consider pruchase contracts with:
\nComments:
\nbranch: SAP Business One (x), TOTVS Protheus (x)partnerKey: SAP Business One (OOAT.CardCode), TOTVS Protheus (x)sellerKey: SAP Business One (x)salesAgentKey: SAP Business One (x)erpKey: SAP Business One (OOAT.AbsID), TOTVS Protheus (x)docNum: SAP Business One (OOAT.Number), TOTVS Protheus (x)orderNum: SAP Business One (x), TOTVS Protheus (x)docStatus: O = open/draft, X = cancelled, A = approvedData returned in response: Purchase Contract data, Partner data, Items (+ taxes), Totals
\nThe response will inform:
\ncount fieldFor list search, the pagination feature in the response will be used, where the following fields are used to control the pagination:
\npageSize = maximum number of records on each page (eg: 100), defined in the API configuration, and informed in the responsepageNum = desired page, provided in the request, and informed in the response. If “pageNum” not informed = 1, If “pageNum” <=0 = 1, If “pageNum”> ”pageTotal” = last pagepageTotal = total pages, reported in the responsehasNext = if there are more pages (true / false), informed in the responseThis service will allow you to search the pruchase contracts list in two situations:
\nupdatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which sales orders should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Document Update Date fields in SAP Business One (OOAT.CreateDate, OOAT.UpdateDate, OOAT.UpdtTime), [2] TOTVS Protheus: fields xFor the use of user fields (UDF) created in the sales order table (SAPB1: OOAT, TOTVS: x), the respective registration must be performed in the Custom Table.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}},"urlObject":{"path":["purchaseContracts"],"host":["{{endpoint}}"],"query":[{"description":{"content":"Initial create date to filter purchase contracts (required if not unitary search)
\n","type":"text/plain"},"key":"createdFrom","value":"2011-01-01"},{"description":{"content":"Final create date to filter purchase contracts (required if not unitary search)
\n","type":"text/plain"},"key":"createdTo","value":"2021-12-31"},{"description":{"content":"Partner Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"partnerKey","value":"C001"},{"description":{"content":"Contract Status to filter sales quotations (optional in list search)
\n","type":"text/plain"},"key":"docStatus","value":"O/A"},{"description":{"content":"Contract Primary Key in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"erpKey","value":"149231"},{"description":{"content":"Contract Document Number in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"docNum","value":"122608"},{"description":{"content":"Number of page - pagination (optional)
\n","type":"text/plain"},"key":"pageNum","value":"1"},{"description":{"content":"Date do filter modified registers - incremental search (optional)
\n","type":"text/plain"},"key":"updatedAt","value":"2021-05-01T00:00:00"}],"variable":[]}},"response":[{"id":"3d11458f-d52a-46e2-9b61-23cd3ed07416","name":"Purchase Contracts - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/purchaseContracts?createdFrom=2011-01-01&createdTo=2021-12-31","host":["{{endpoint}}"],"path":["purchaseContracts"],"query":[{"key":"createdFrom","value":"2011-01-01","description":"Initial create date to filter purchase contracts (required if not unitary search)"},{"key":"createdTo","value":"2021-12-31","description":"Final create date to filter purchase contracts (required if not unitary search)"},{"key":"partnerKey","value":"C001","description":"Partner Primary Key in ERP (optional in list search)","disabled":true},{"key":"docStatus","value":"O/A","description":"Contract Status to filter sales quotations (optional in list search)","disabled":true},{"key":"erpKey","value":"149231","description":"Contract Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"122608","description":"Contract Document Number in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"1","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2021-05-01T00:00:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 May 2021 22:37:16 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"PurchaseContracts\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"purchaseContracts\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.102\",\n \"effectiveTimestamp\": \"2021-05-13T19:37:13\",\n \"createdFrom\": \"2011-01-01\",\n \"createdTo\": \"2021-12-31\",\n \"code\": \"200\",\n \"success\": true,\n \"useCustom\": \"true\",\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 1,\n \"values\": [\n {\n \"erpKey\": \"2\",\n \"docNum\": \"1\",\n \"description\": \"Fornecimento de Material Esportivo\",\n \"docStatus\": \"A\",\n \"startDate\": \"2015-06-01\",\n \"endDate\": \"2016-12-31\",\n \"signDate\": \"2015-06-01\",\n \"docValue\": 91000,\n \"partnerKey\": \"F001\",\n \"partnerName\": \"Adidas\",\n \"type\": \"G\",\n \"method\": \"I\",\n \"payConditionKey\": \"\",\n \"payMethodKey\": \"\",\n \"pricelistKey\": \"\",\n \"comments\": \"\",\n \"createdAt\": \"2015-06-18T13:40:42\",\n \"updatedAt\": \"2016-05-19T13:40:42\",\n \"canceledAt\": null,\n \"items\": [\n {\n \"lineNum\": \"1\",\n \"productKey\": \"I005\",\n \"productName\": \"Bola Adidas TG 2 Olympics\",\n \"quantity\": 1000,\n \"confirmedQuantity\": 10,\n \"unit\": \"Un\",\n \"unitPrice\": 70,\n \"taxBasis\": 70000,\n \"lineStatus\": \"O\",\n \"comments\": \"\"\n },\n {\n \"lineNum\": \"2\",\n \"productKey\": \"I004\",\n \"productName\": \"Bola Adidas Finale Sportivo\",\n \"quantity\": 300,\n \"confirmedQuantity\": 0,\n \"unit\": \"Un\",\n \"unitPrice\": 70,\n \"taxBasis\": 21000,\n \"lineStatus\": \"O\",\n \"comments\": \"\"\n }\n ],\n \"totals\": {\n \"orderTotal\": {\n \"netValue\": 91000,\n \"grossValue\": 91000,\n \"baseValue\": 91000,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 91000,\n \"grossValue\": 91000,\n \"baseValue\": 91000,\n \"taxValue\": 0\n },\n \"shippingTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0\n }\n }\n }\n ]\n}"}],"_postman_id":"f9c6f34a-eadf-4c48-9975-b7a7fb3afcdb"}],"id":"ea3f4e55-45c7-4167-b22e-d348cc8de2e4","_postman_id":"ea3f4e55-45c7-4167-b22e-d348cc8de2e4","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}}},{"name":"Purchase Requests NEW","item":[{"name":"Purchase Requests","id":"1c6f684a-e6cb-4d48-ac15-6fea458f829b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/purchaseRequests?createdFrom=2017-04-07&createdTo=2017-04-07&branch=1&docStatus&erpKey=53929&docNum=121313&orderNum=1050321450678-01&pageNum=2&updatedAt=2020-08-26T00:00:00","description":"(sapBusinessOne=1470000113/OPRQ, totvsProtheus=x)
\nThis service will allow you to search purchase requests on the ERP.
\nSearching purchase orders allows you to filter the ERP by:
\ncreatedFrom + createdTo {required}, by branch or docStatus {optional}erpKey or docNum or \norderNum\nIf no field for unitary query is provided in the request (erpKey or docNum or orderNum), the query for purchase orders is carried out by creation date from/to (which become mandatory).The purchaseRequests service will consider purchase requests with:
\nComments:
\nbranch: SAP Business One (OPRQ.BPLId), TOTVS Protheus (x)erpKey: SAP Business One (OPRQ.DocEntry), TOTVS Protheus (x)docNum: SAP Business One (OPRQ.DocNum), TOTVS Protheus (x)orderNum: SAP Business One (OPRQ.NumAtCard), TOTVS Protheus (x)docStatus: O = open, C = canceled, A = approvedData returned in response: Purchase Eequest data, Partner data, Items (+ taxes), Totals
\nThe response will inform:
\ncount fieldFor list search, the pagination feature in the response will be used, where the following fields are used to control the pagination:
\npageSize = maximum number of records on each page (eg: 100), defined in the API configuration, and informed in the responsepageNum = desired page, provided in the request, and informed in the response. If pageNum not informed = 1, If pageNum <=0 = 1, If pageNum> pageTotal = last pagepageTotal = total pages, reported in the responsehasNext = if there are more pages (true / false), informed in the responseThis service will allow you to search the purchase requests list in two situations:
\nupdatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which sales orders should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Document Update Date fields in SAP Business One (OPRQ.CreateDate, OPRQ.UpdateDate, OPRQ.CreateTS, OPRQ.UpdateTS), [2] TOTVS Protheus: fields xFor the use of user fields (UDF) created in the purchase orders table (SAPB1: OPRQ, TOTVS: x), the respective registration must be performed in the Custom Table.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}},"urlObject":{"path":["purchaseRequests"],"host":["{{endpoint}}"],"query":[{"description":{"content":"Initial create date to filter purchase requests (required if not unitary search)
\n","type":"text/plain"},"key":"createdFrom","value":"2017-04-07"},{"description":{"content":"Final create date to filter purchase requests (required if not unitary search)
\n","type":"text/plain"},"key":"createdTo","value":"2017-04-07"},{"description":{"content":"Branch (optional in list search)
\n","type":"text/plain"},"key":"branch","value":"1"},{"description":{"content":"Purchase Request Status in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"docStatus","value":null},{"description":{"content":"Purchase Request Primary Key in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"erpKey","value":"53929"},{"description":{"content":"Purchase Request Document Number in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"docNum","value":"121313"},{"description":{"content":"Partner Purchase Request Number in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"orderNum","value":"1050321450678-01"},{"description":{"content":"Number of page - pagination (optional)
\n","type":"text/plain"},"key":"pageNum","value":"2"},{"description":{"content":"Date do filter modified registers - incremental search (optional)
\n","type":"text/plain"},"key":"updatedAt","value":"2020-08-26T00:00:00"}],"variable":[]}},"response":[{"id":"6b92a180-507f-4026-8444-d404d9993e8a","name":"Purchase Requests - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/purchaseRequests?createdFrom=2017-04-07&createdTo=2017-04-07","host":["{{endpoint}}"],"path":["purchaseRequests"],"query":[{"key":"createdFrom","value":"2017-04-07","description":"Initial create date to filter purchase requests (required if not unitary search)"},{"key":"createdTo","value":"2017-04-07","description":"Final create date to filter purchase requests (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional in list search)","disabled":true},{"key":"docStatus","value":null,"description":"Purchase Request Status in ERP (optional - unitary search)","disabled":true},{"key":"erpKey","value":"53929","description":"Purchase Request Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"121313","description":"Purchase Request Document Number in ERP (optional - unitary search)","disabled":true},{"key":"orderNum","value":"1050321450678-01","description":"Partner Purchase Request Number in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-08-26T00:00:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 May 2021 22:04:52 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"PurchaseRequests\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"purchaseRequests\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.102\",\n \"effectiveTimestamp\": \"2021-05-13T19:04:48\",\n \"createdFrom\": \"2017-04-07\",\n \"createdTo\": \"2017-04-07\",\n \"code\": \"200\",\n \"success\": true,\n \"useCustom\": \"true\",\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 1,\n \"values\": [\n {\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"erpKey\": \"19\",\n \"orderNum\": \"\",\n \"docNum\": \"19\",\n \"docStatus\": \"P\",\n \"docDate\": \"2017-04-07\",\n \"docDueDate\": \"2017-05-07\",\n \"taxDate\": \"2017-04-07\",\n \"requestDate\": \"2017-04-10\",\n \"docValue\": 0,\n \"comments\": \"Será necessário um assistente técnico para instalar os equipamentos do escritório\",\n \"customOrderKey\": \"\",\n \"customStatus\": \"\",\n \"customStatusNotify\": \"\",\n \"createdAt\": \"2017-04-07T18:11:44\",\n \"updatedAt\": \"2017-04-07T18:11:44\",\n \"canceledAt\": null,\n \"items\": [\n {\n \"lineNum\": \"0\",\n \"productKey\": \"ASV0121\",\n \"codeBars\": \"\",\n \"productName\": \"Pino Roscado Din 976 8 m16 x 80 cl. 8.8. Zincado\",\n \"quantity\": 1,\n \"unit\": \"pc\",\n \"unitPrice\": 0,\n \"taxBasis\": 0,\n \"usage\": \"\",\n \"cfop\": \"\",\n \"whsCode\": \"01\",\n \"taxValue\": 0,\n \"itemDueDate\": \"2017-04-10\",\n \"costCenter\": \"\",\n \"accountCode\": \"1.1.3.1.1\",\n \"financialProject\": \"\",\n \"comments\": \"\"\n },\n {\n \"lineNum\": \"1\",\n \"productKey\": \"ASV0122\",\n \"codeBars\": \"\",\n \"productName\": \"Porca M16 Din934 Zincado\",\n \"quantity\": 1,\n \"unit\": \"pc\",\n \"unitPrice\": 0,\n \"taxBasis\": 0,\n \"usage\": \"\",\n \"cfop\": \"\",\n \"whsCode\": \"01\",\n \"taxValue\": 0,\n \"itemDueDate\": \"2017-04-10\",\n \"costCenter\": \"\",\n \"accountCode\": \"1.1.3.1.1\",\n \"financialProject\": \"\",\n \"comments\": \"\"\n },\n {\n \"lineNum\": \"2\",\n \"productKey\": \"ASV0123\",\n \"codeBars\": \"\",\n \"productName\": \"Pino Rosca Din 976 8 M20 x 125 CL 8.8 Zincado\",\n \"quantity\": 1,\n \"unit\": \"pc\",\n \"unitPrice\": 0,\n \"taxBasis\": 0,\n \"usage\": \"\",\n \"cfop\": \"\",\n \"whsCode\": \"01\",\n \"taxValue\": 0,\n \"itemDueDate\": \"2017-04-10\",\n \"costCenter\": \"\",\n \"accountCode\": \"1.1.3.1.1\",\n \"financialProject\": \"\",\n \"comments\": \"\"\n }\n ],\n \"totals\": {\n \"orderTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0\n },\n \"shippingTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0\n }\n }\n }\n ]\n}"}],"_postman_id":"1c6f684a-e6cb-4d48-ac15-6fea458f829b"},{"name":"Purchase Requests","id":"1addfffc-2fc7-40f7-be1b-e6c30822be51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"branch\": \"1\",\n \"orderNum\": \"1013\",\n \"dueDate\": \"2021-05-31\",\n \"comments\": \"Teste\",\n \"items\": [\n {\n \"productKey\": \"I004\",\n \"productName\": \"Camisa Nike Flamengo I 09/10\",\n \"quantity\": 1,\n \"unit\": \"PAR\",\n \"unitPrice\": 49.9,\n \"taxBasis\": 49.9\n }\n ],\n \"totals\": {\n \"orderTotal\": {\n \"netValue\": 49.9,\n \"grossValue\": 49.9,\n \"baseValue\": 49.9,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 49.9,\n \"grossValue\": 49.9,\n \"baseValue\": 49.9,\n \"taxValue\": 0\n },\n \"shippingTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/purchaseRequests","description":"(sapBusinessOne=1470000113/OPRQ, totvsProtheus=x)
\nThis service allows to insert a new purchase request in the ERP.
\nThe scenario will validate the data received, making selects in the ERP database.
\nA new purchase request will be added if the purchase request is not found on the ERP by branch + orderNum:
The products sent for the service will be identified in the ERP:
\nproductKey or OITM.CodeBars = codeBarsproductKey or B1_CODBAR = codeBarsComments:
\npriceAdjustValue), in total freight (shipAdjustValue). shipAdjustType = minus or plusitems: basePrice: base/gross price, taxBasis: total value of the item (quantity * price), calculation date for taxtotals: netValue: net value with discounts applied, grossValue: gross value with discounts and taxes applied, baseValue: base value for tax calculation, taxValue: taxes that increase order value (IPI, ICMS-ST, ...)For the use of user fields (UDF) created in the purchase orders table (SAPB1: OPRQ, TOTVS: x), the respective registration must be performed in the Custom Table.
\n(sapBusinessOne=22/OPOR, totvsProtheus=SC7)
\nThis service will allow you to search purchase orders on the ERP.
\nSearching purchase orders allows you to filter the ERP by:
\ncreatedFrom + createdTo {required}, by branch, partnerKey {optional}erpKey or docNumIf no field for unitary query is provided in the request (erpKey or docNum), the query for purchase orders is carried out by creation date from/to (which become mandatory).
The orders service will consider purchase orders with:
\nComments:
\nbranch: SAP Business One (OPOR.BPLId), TOTVS Protheus (C7_FILIAL)partnerKey: SAP Business One (OPOR.CardCode), TOTVS Protheus (C7_FORNECE+'_'+C7_LOJA)buyerKey: SAP Business One (OPOR.SlpCode), TOTVS Protheus (C7_COMPRA)erpKey: SAP Business One (OPOR.DocEntry), TOTVS Protheus (C7_NUM)docNum: SAP Business One (OPOR.DocNum), TOTVS Protheus (C7_NUMSC)orderNum: SAP Business One (OPOR.NumAtCard), TOTVS Protheus (C7_NUMIMP)docStatus: O = open, C = canceled, B = billed, P = paid, R = returnedData returned in response: Purchase orders data, Partner data, Items (+ taxes), Totals
\nThe response will inform:
\ncount fieldFor list search, the pagination feature in the response will be used, where the following fields are used to control the pagination:
\npageSize = maximum number of records on each page (eg: 100), defined in the API configuration, and informed in the responsepageNum = desired page, provided in the request, and informed in the response. If pageNum not informed = 1, If pageNum <=0 = 1, If pageNum> pageTotal = last pagepageTotal = total pages, reported in the responsehasNext = if there are more pages (true / false), informed in the responseThis service will allow you to search the purchase orders list in two situations:
\nupdatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which sales orders should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Document Update Date fields in SAP Business One (OPOR.CreateDate, OPOR.UpdateDate, OPOR.CreateTS, OPOR.UpdateTS), [2] TOTVS Protheus: fields C7_USERLGI and C7_USERLGAFor the use of user fields (UDF) created in the purchase orders table (SAPB1: OPOR, TOTVS: SC7), the respective registration must be performed in the Custom Table.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}},"urlObject":{"path":["purchaseOrders"],"host":["{{endpoint}}"],"query":[{"description":{"content":"Initial create date to filter purchase orders (required if not unitary search)
\n","type":"text/plain"},"key":"createdFrom","value":"2018-09-17"},{"description":{"content":"Final create date to filter purchase orders (required if not unitary search)
\n","type":"text/plain"},"key":"createdTo","value":"2020-12-31"},{"description":{"content":"Branch (optional in list search)
\n","type":"text/plain"},"key":"branch","value":"1"},{"description":{"content":"Partner Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"partnerKey","value":"00003801"},{"description":{"content":"Buyer Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"buyerKey","value":"22"},{"description":{"content":"Purchase Order Primary Key in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"erpKey","value":"53929"},{"description":{"content":"Purchase Order Document Number in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"docNum","value":"121313"},{"description":{"content":"Partner Purchase Order Number in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"orderNum","value":"1050321450678-01"},{"description":{"content":"Number of page - pagination (optional)
\n","type":"text/plain"},"key":"pageNum","value":"2"},{"description":{"content":"Date do filter modified registers - incremental search (optional)
\n","type":"text/plain"},"key":"updatedAt","value":"2020-08-26T00:00:00"}],"variable":[]}},"response":[{"id":"d4d14d0c-d04a-467a-a56f-ceadceca2874","name":"Purchase Orders - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/purchaseOrders?createdFrom=2018-09-17&createdTo=2020-12-31","host":["{{endpoint}}"],"path":["purchaseOrders"],"query":[{"key":"createdFrom","value":"2018-09-17","description":"Initial create date to filter purchase orders (required if not unitary search)"},{"key":"createdTo","value":"2020-12-31","description":"Final create date to filter purchase orders (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional in list search)","disabled":true},{"key":"partnerKey","value":"00003801","description":"Partner Primary Key in ERP (optional in list search)","disabled":true},{"key":"buyerKey","value":"22","description":"Buyer Primary Key in ERP (optional in list search)","disabled":true},{"key":"erpKey","value":"53929","description":"Purchase Order Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"121313","description":"Purchase Order Document Number in ERP (optional - unitary search)","disabled":true},{"key":"orderNum","value":"1050321450678-01","description":"Partner Purchase Order Number in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-08-26T00:00:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Version","value":"1.1"},{"key":"FWRESTBUILD","value":"1.15.0717"},{"key":"Content-Type","value":"application/json"},{"key":"Status","value":"200 OK"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"PurchaseOrders\",\n \"system\": \"totvsProtheus\",\n \"target\": \"purchaseOrders\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-15T15:50:21\",\n \"createdFrom\": \"2018-09-17\",\n \"createdTo\": \"2020-12-31\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"count\": 2,\n \"values\": [\n {\n \"branch\": \"01\",\n \"branchName\": \"TESTE\",\n \"branchTaxNumber\": \" . . / - \",\n \"buyerKey\": \"\",\n \"erpKey\": \"000001\",\n \"docNum\": \" \",\n \"orderNum\": \"\",\n \"docStatus\": \"\",\n \"docDate\": \"2020-11-10\",\n \"docDueDate\": \"2020-11-10\",\n \"taxDate\": \"1900-01-01\",\n \"docValue\": 240,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null,\n \"supplier\": {\n \"type\": \"S\",\n \"taxType\": \"C\",\n \"partnerKey\": \"000001_01\",\n \"fullName\": \"PIXEL INFORMATICA EIRELI - ME\",\n \"aliasName\": \"PIXEL INFO\",\n \"email\": \"\",\n \"phone\": \"47 33696269\",\n \"phoneSecundary\": \"\",\n \"cellular\": null,\n \"taxNumber\": \"11061994000172\",\n \"stateTaxNumber\": \"255.920.350\",\n \"cityTaxNumber\": \"\",\n \"contactPerson\": \"\",\n \"billingAddress\": {\n \"address1\": \"RUA JOSE GUERREIRO FILHO 89\",\n \"exteriorNumber\": null,\n \"address2\": \"SALA 01\",\n \"community\": \"CENTRO\",\n \"city\": \"PORTO BELO\",\n \"county\": \"\",\n \"stateCode\": \"SC\",\n \"countryCode\": \"\",\n \"postalCode\": \"\",\n \"streetType\": null\n },\n \"shippingAddress\": {\n \"address1\": \"RUA JOSE GUERREIRO FILHO 89\",\n \"exteriorNumber\": null,\n \"address2\": \"SALA 01\",\n \"community\": \"CENTRO\",\n \"city\": \"PORTO BELO\",\n \"county\": \"\",\n \"stateCode\": \"SC\",\n \"countryCode\": \"\",\n \"postalCode\": \"\",\n \"streetType\": null\n }\n },\n \"items\": [\n {\n \"lineNum\": \"0001\",\n \"productKey\": \"MC000003\",\n \"codeBars\": \"\",\n \"productName\": \"CARTUCHO HP 662 PRETO\",\n \"quantity\": 2,\n \"unit\": \"UN\",\n \"unitPrice\": 120,\n \"taxBasis\": 240,\n \"usage\": \"\",\n \"cfop\": null,\n \"discountRate\": 0,\n \"taxValue\": 0,\n \"freightValue\": 0,\n \"grossValue\": 240,\n \"unitCost\": 105.6\n }\n ],\n \"totals\": {\n \"orderTotal\": {\n \"netValue\": 240,\n \"grossValue\": 240,\n \"baseValue\": 240,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 240,\n \"grossValue\": 240,\n \"baseValue\": 240,\n \"taxValue\": 0,\n \"priceAdjustValue\": 0,\n \"priceAdjustType\": \"\",\n \"priceAdjustPromotionId\": \"\",\n \"priceAdjustCouponId\": \"\"\n },\n \"shippingTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n }\n },\n {\n \"branch\": \"01\",\n \"branchName\": \"TESTE\",\n \"branchTaxNumber\": \" . . / - \",\n \"buyerKey\": \"\",\n \"erpKey\": \"000002\",\n \"docNum\": \" \",\n \"orderNum\": \"\",\n \"docStatus\": \"\",\n \"docDate\": \"2020-11-15\",\n \"docDueDate\": \"2020-11-20\",\n \"taxDate\": \"1900-01-01\",\n \"docValue\": 510,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null,\n \"supplier\": {\n \"type\": \"S\",\n \"taxType\": \"C\",\n \"partnerKey\": \"000031_01\",\n \"fullName\": \"TUPY S/A\",\n \"aliasName\": \"TUPY S/A\",\n \"email\": \"recebe.nfe@tupy.com.br\",\n \"phone\": \"47 40098181\",\n \"phoneSecundary\": \"\",\n \"cellular\": null,\n \"taxNumber\": \"84683374000300\",\n \"stateTaxNumber\": \"255505256\",\n \"cityTaxNumber\": \"\",\n \"contactPerson\": \"\",\n \"billingAddress\": {\n \"address1\": \"R ALBANO SCHMIDT, 3400\",\n \"exteriorNumber\": null,\n \"address2\": \"\",\n \"community\": \"BOA VISTA\",\n \"city\": \"JOINVILLE\",\n \"county\": \"\",\n \"stateCode\": \"SC\",\n \"countryCode\": \"01058\",\n \"postalCode\": \"89227-901\",\n \"streetType\": null\n },\n \"shippingAddress\": {\n \"address1\": \"R ALBANO SCHMIDT, 3400\",\n \"exteriorNumber\": null,\n \"address2\": \"\",\n \"community\": \"BOA VISTA\",\n \"city\": \"JOINVILLE\",\n \"county\": \"\",\n \"stateCode\": \"SC\",\n \"countryCode\": \"01058\",\n \"postalCode\": \"89227-901\",\n \"streetType\": null\n }\n },\n \"items\": [\n {\n \"lineNum\": \"0001\",\n \"productKey\": \"MC000001\",\n \"codeBars\": \"\",\n \"productName\": \"ADAPTADOR SATA DVD->HD\",\n \"quantity\": 1,\n \"unit\": \"UN\",\n \"unitPrice\": 350,\n \"taxBasis\": 350,\n \"usage\": \"\",\n \"cfop\": null,\n \"discountRate\": 0,\n \"taxValue\": 0,\n \"freightValue\": 20.59,\n \"grossValue\": 350,\n \"unitCost\": 0\n },\n {\n \"lineNum\": \"0002\",\n \"productKey\": \"MC000002\",\n \"codeBars\": \"\",\n \"productName\": \"SSD 120GB\",\n \"quantity\": 2,\n \"unit\": \"UN\",\n \"unitPrice\": 80,\n \"taxBasis\": 160,\n \"usage\": \"\",\n \"cfop\": null,\n \"discountRate\": 0,\n \"taxValue\": 0,\n \"freightValue\": 9.41,\n \"grossValue\": 160,\n \"unitCost\": 0\n }\n ],\n \"totals\": {\n \"orderTotal\": {\n \"netValue\": 510,\n \"grossValue\": 510,\n \"baseValue\": 510,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 510,\n \"grossValue\": 510,\n \"baseValue\": 510,\n \"taxValue\": 0,\n \"priceAdjustValue\": 0,\n \"priceAdjustType\": \"\",\n \"priceAdjustPromotionId\": \"\",\n \"priceAdjustCouponId\": \"\"\n },\n \"shippingTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n }\n }\n ]\n}"},{"id":"2928648b-dc17-4112-bf24-780eba383d61","name":"Purchase Orders - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/purchaseOrders?createdFrom=2018-09-17&createdTo=2020-12-31","host":["{{endpoint}}"],"path":["purchaseOrders"],"query":[{"key":"createdFrom","value":"2018-09-17","description":"Initial create date to filter purchase orders (required if not unitary search)"},{"key":"createdTo","value":"2020-12-31","description":"Final create date to filter purchase orders (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional in list search)","disabled":true},{"key":"partnerKey","value":"00003801","description":"Partner Primary Key in ERP (optional in list search)","disabled":true},{"key":"buyerKey","value":"22","description":"Buyer Primary Key in ERP (optional in list search)","disabled":true},{"key":"erpKey","value":"53929","description":"Purchase Order Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"121313","description":"Purchase Order Document Number in ERP (optional - unitary search)","disabled":true},{"key":"orderNum","value":"1050321450678-01","description":"Partner Purchase Order Number in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-08-26T00:00:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 May 2021 22:10:02 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"PurchaseOrders\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"purchaseOrders\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.102\",\n \"effectiveTimestamp\": \"2021-05-13T19:09:57\",\n \"createdFrom\": \"2018-09-17\",\n \"createdTo\": \"2020-12-31\",\n \"code\": \"200\",\n \"success\": true,\n \"useCustom\": \"true\",\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 1,\n \"values\": [\n {\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"buyerKey\": \"-1\",\n \"erpKey\": \"115\",\n \"orderNum\": \"\",\n \"docNum\": \"109\",\n \"docStatus\": \"P\",\n \"docDate\": \"2018-09-17\",\n \"docDueDate\": \"2018-09-18\",\n \"taxDate\": \"2018-09-17\",\n \"docValue\": 0,\n \"taxValue\": 0,\n \"paymentCondition\": \"-1\",\n \"paymentMethod\": \"Pgto em Cheque\",\n \"comments\": \"Baseado em Pedidos de venda 245.\",\n \"customOrderKey\": \"\",\n \"customStatus\": \"\",\n \"customStatusNotify\": \"\",\n \"createdAt\": \"2018-09-17T22:43:08\",\n \"updatedAt\": \"2018-09-17T22:43:08\",\n \"canceledAt\": null,\n \"supplier\": {\n \"type\": \"S\",\n \"taxType\": \"\",\n \"partnerKey\": \"V22222\",\n \"fullName\": \"OEC 2\",\n \"aliasName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"phoneSecondary\": \"\",\n \"cellular\": \"\",\n \"taxNumber\": \"\",\n \"stateTaxNumber\": \"\",\n \"cityTaxNumber\": \"\",\n \"billingAddress\": {\n \"address1\": \"\",\n \"address2\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"postalCode\": \"\",\n \"stateCode\": \"\",\n \"countryCode\": \"\",\n \"community\": \"\",\n \"exteriorNumber\": \"\",\n \"streetType\": \"\"\n },\n \"shippingAddress\": {\n \"address1\": \"das Nações Unidas\",\n \"address2\": \"6° andar\",\n \"city\": \"São Paulo\",\n \"county\": \"5344\",\n \"postalCode\": \"04795-100\",\n \"stateCode\": \"SP\",\n \"countryCode\": \"BR\",\n \"community\": \"Brooklin\",\n \"exteriorNumber\": \"14.171\",\n \"streetType\": \"Av.\"\n }\n },\n \"items\": [\n {\n \"lineNum\": \"0\",\n \"productKey\": \"A00001\",\n \"codeBars\": \"\",\n \"productName\": \"Impressora 1\",\n \"quantity\": 5,\n \"unit\": \"\",\n \"unitPrice\": 0,\n \"taxBasis\": 0,\n \"usage\": \"\",\n \"cfop\": \"\",\n \"whsCode\": \"01\",\n \"discountRate\": 0,\n \"taxValue\": 0,\n \"freightValue\": 0,\n \"grossValue\": 0,\n \"unitCost\": 0,\n \"costCenter\": \"\",\n \"accountCode\": \"1.1.3.1.1\",\n \"financialProject\": \"\",\n \"comments\": \"200.00\"\n },\n {\n \"lineNum\": \"1\",\n \"productKey\": \"A00004\",\n \"codeBars\": \"\",\n \"productName\": \"Impressora 4\",\n \"quantity\": 4,\n \"unit\": \"\",\n \"unitPrice\": 0,\n \"taxBasis\": 0,\n \"usage\": \"\",\n \"cfop\": \"\",\n \"whsCode\": \"01\",\n \"discountRate\": 0,\n \"taxValue\": 0,\n \"freightValue\": 0,\n \"grossValue\": 0,\n \"unitCost\": 0,\n \"costCenter\": \"\",\n \"accountCode\": \"1.1.3.1.1\",\n \"financialProject\": \"\",\n \"comments\": \"250.00\"\n }\n ],\n \"totals\": {\n \"orderTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0\n },\n \"shippingTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0\n }\n }\n }\n ]\n}"}],"_postman_id":"bba25fb6-d88b-4269-b29e-bfe5a2f7ecfa"},{"name":"Purchase Orders*","id":"1dfb437f-62e4-48e1-b8d4-19c08d507bf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"branch\": \"1\",\n \"orderNum\": \"1013\",\n \"buyerKey\": \"3\",\n \"dueDate\": \"2021-05-31\",\n \"mainUsage\": \"22\",\n \"paymentCondition\": \"\",\n \"paymentMethod\": \"\",\n \"comments\": \"Teste\",\n \"supplier\": {\n\t\t\"type\": \"S\",\n\t\t\"taxType\": \"C\",\n\t\t\"fullName\": \"Sport Club Corinthians Paulista\",\n\t\t\"aliasName\": \"Timão\",\n\t\t\"email\": \"campeão@corinthians.com.br\",\n\t\t\"phone\": \"2095-3000\",\n\t\t\"phoneSecondary\": \"11\",\n\t \"cellular\": \"11-9595-2000\",\n\t\t\"taxNumber\": \"61.902.722/0001-26\",\n\t\t\"stateTaxNumber\": \"113.440.120.113\",\n\t\t\"cityTaxNumber\": \"\",\n\t\t\"billingAddress\": {\n\t\t\t\"address1\": \"São Jorge\",\n\t\t\t\"address2\": \"\",\n\t\t\t\"city\": \"São Paulo\",\n\t\t\t\"postalCode\": \"03087-000\",\n\t\t\t\"stateCode\": \"SP\",\n\t\t\t\"community\": \"Tatuapé\",\n\t\t\t\"exteriorNumber\": \"777\",\n\t\t\t\"streetType\": \"Rua\",\n\t\t\t\"countryCode\": \"BR\"\n\t\t}\n },\n \"items\": [\n {\n \"productKey\": \"I004\",\n \"productName\": \"Camisa Nike Flamengo I 09/10\",\n \"quantity\": 1,\n \"unit\": \"PAR\",\n \"unitPrice\": 49.9,\n \"taxBasis\": 49.9,\n \"usage\": \"\",\n \"costCenter\": \"\",\n \"accountCode\": \"\",\n \"fincancialProject\": \"\"\n\n }\n ],\n \"shipment\": {\n \"shippingAddress\": {\n\t\t\t\t\"address1\": \"São Jorge 2\",\n\t\t\t\t\"address2\": \"\",\n\t\t\t\t\"city\": \"São Paulo\",\n\t\t\t\t\"postalCode\": \"03087-000\",\n\t\t\t\t\"stateCode\": \"SP\",\n\t\t\t\t\"community\": \"Tatuapé\",\n\t\t\t\t\"exteriorNumber\": \"777\",\n\t\t\t\t\"streetType\": \"Rua\",\n\t\t\t\t\"countryCode\": \"BR\"\n }\n },\n \"totals\": {\n \"orderTotal\": {\n \"netValue\": 59.71,\n \"grossValue\": 59.71,\n \"baseValue\": 59.71,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 49.9,\n \"grossValue\": 49.9,\n \"baseValue\": 49.9,\n \"taxValue\": 0\n },\n \"shippingTotal\": {\n \"netValue\": 9.81,\n \"grossValue\": 9.81,\n \"baseValue\": 9.81,\n \"taxValue\": 0\n }\n },\n \"payments\": [\n {\n \"paymentMethod\": \"cash\",\n \"installments\": 1,\n \"amount\": 49.71\n },\n {\n \"paymentMethod\": \"transfer\",\n \"installments\": 1,\n \"amount\": 10.00\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/purchaseOrders","description":"(sapBusinessOne=22/OPOR, totvsProtheus=SC7)
\nThis service allows to insert a new purchase order in the ERP, with treatment for new and existing partner.
\nThe scenario will validate the data received, making selects in the ERP database.
\nA new purchase order will be added if the purchase orders is not found on the ERP by branch + orderNum:
The key to finding the partner is through taxNumber. If the partner is located by taxNumber, the data is updated, otherwise the new partner is added in the ERP.
The products sent for the service will be identified in the ERP:
\nproductKey or OITM.CodeBars = codeBarsproductKey or B1_CODBAR = codeBarsComments:
\nsupplier/type: C = supplier, S = supplier, L = lead, [2] supplier/taxType: P = person, C = company, G = government, E = employee. Each supplier in SAP Business One will have 2 registered addresses (CRD1, CRD7), namely: ShipToCode (S) = /supplier/fullName OR /shipment/shippingAddress/firstName + \"\" + /shipment/shippingAddress/lastName, BillToCode (B) = /supplier/fullName OR /supplier/billingAddress/firstName + \"\" + /supplier/billingAddress/lastName. Each supplier in SAP Business One will have 3 tax identification numbers (CRD12), namely: ShipToCode, BillToCode, empty.buyerKeypriceAdjustValue), in total freight (shipAdjustValue). shipAdjustType = minus or plusitems: basePrice: base/gross price, taxBasis: total value of the item (quantity * price), calculation date for taxtotals: netValue: net value with discounts applied, grossValue: gross value with discounts and taxes applied, baseValue: base value for tax calculation, taxValue: taxes that increase order value (IPI, ICMS-ST, ...)payments: 5 paymentMethods are accepted: transfer, boe, creditCard (mandatory fields: cardName and authid), cash, checkpaymentMethodKey fieldFor the use of user fields (UDF) created in the purchase orders table (SAPB1: OPOR, TOTVS: SC7), the respective registration must be performed in the Custom Table.
\n* = Required field
\n(sapBusinessOne=17/ORDR)
\nThis service will allow you to search sales orders status on the ERP.
\nSearching sales orders status allows you to filter the ERP by:
\ncreatedFrom + createdTo {required}, by branch, partnerKey, sellerKey, salesAgentKey, carrierKey, docStatus or any of four custom fields definied in this service {optional}erpKey or orderNum or docNum or customOrderKeyIf no field for unitary query is provided in the request (erpKey or orderNum or docNum or customOrderKey), the query for sales orders is carried out by creation date from/to (which become mandatory) and any other filter applied.
The orders service will consider sales orders with:
\nComments:
\nbranch: SAP Business One (ORDR.BPLId), TOTVS Protheus (C5_FILIAL)partnerKey: SAP Business One (ORDR.CardCode), TOTVS Protheus (C5_CLIENTE+'_'+C5_LOJACLI)sellerKey: SAP Business One (ORDR.SlpCode), TOTVS Protheus (C5_VEND1)salesAgentKey: SAP Business One (ORDR.AgentCode), TOTVS Protheus (A3_UNIDAD)erpKey: SAP Business One (ORDR.DocEntry), TOTVS Protheus (C5_NUM)orderNum: SAP Business One (ORDR.NumAtCard), TOTVS Protheus (C5_PEDECOM)docNum: SAP Business One (ORDR.DocNum), TOTVS Protheus (R_E_C_N_O_)docStatus: O=open, C=closed, X=canceled, B=billed, P=paid, R=returnedcustomOrderKey: sales order custom field definied in API Setup, and present in filter and responsecustomStatus: sales order custom field definied in API Setup, and present in filter and responsecustomStatusNotify: sales order custom field definied in API Setup, and present in filter and responsecustomShipMethod: sales order custom field definied in API Setup, and present in filter and responsecustomShipType: sales order custom field definied in API Setup, and present in filter and responsecustomTrackingKey: sales order custom field definied in API Setup, and present in responsecustomTrackingUrl: sales order custom field definied in API Setup, and present in responseThis service will allow you to search the sales order status list in two situations:
\nupdatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which records should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Creation Time fields of the transaction table in SAP Business One (OIVL.CreateDate and OIVL.CreateTime), [2] TOTVS Protheus: not implementedThe response will inform:
\ncount fieldFor list search the pagination feature in the response will be used, where the following fields are used to control the pagination:
\npageSize = maximum number of records on each page (eg: 100), defined in the API configuration, and informed in the responsepageNum = desired page, provided in the request, and informed in the response. If pageNum not informed = 1, If pageNum <=0 = 1, If pageNum> pageTotal = last pagepageTotal = total pages, informed in the responsehasNext = if there are more pages (true / false), informed in the responseThis service does not have user field (UDF) treatment.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}},"urlObject":{"path":["purchaseOrderStatus"],"host":["{{endpoint}}"],"query":[{"description":{"content":"Initial create date to filter change sales orders (required if not unitary search)
\n","type":"text/plain"},"key":"createdFrom","value":"2018-09-17"},{"description":{"content":"Final create date to filter sales orders (required if not unitary search)
\n","type":"text/plain"},"key":"createdTo","value":"2018-09-17"},{"description":{"content":"Branch (optional in list search)
\n","type":"text/plain"},"key":"branch","value":"1"},{"description":{"content":"Partner Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"partnerKey","value":"NEW"},{"description":{"content":"Buyer Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"buyerKey","value":"NEW"},{"description":{"content":"Default Purchase Order Status to filter sales order (optional in list search - NEW)
\n","type":"text/plain"},"key":"docStatus","value":"NEW"},{"description":{"content":"Custom Purchase Order Status to filter sales order (optional in list search - depends on UDF in API setup - NEW)
\n","type":"text/plain"},"key":"customStatus","value":"2"},{"description":{"content":"Custom Purchase Order Status Notify to filter sales order (optional in list search - depends on UDF in API setup - NEW)
\n","type":"text/plain"},"key":"customStatusNotify","value":"NEW"},{"description":{"content":"Custom Shipping Method to filter purchase orders (optional in list search - depends on UDF in API setup - NEW)
\n","type":"text/plain"},"key":"customShipMethod","value":"NEW"},{"description":{"content":"Custom Shipping Type to filter purchase orders (optional in list search - depends on UDF in API setup - NEW)
\n","type":"text/plain"},"key":"customShipType","value":"NEW"},{"description":{"content":"Purchase Order Primary Key in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"erpKey","value":"NEW"},{"description":{"content":"Purchase Order Document Number in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"docNum","value":"NEW"},{"description":{"content":"Partner Purchase Order Number in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"orderNum","value":"NEW"},{"description":{"content":"Custom Purchase Order Key to filter purchase order (optional in list search - depends on UDF in API setup - NEW)
\n","type":"text/plain"},"key":"customOrderKey","value":"NEW"},{"description":{"content":"Number of page - pagination (optional)
\n","type":"text/plain"},"key":"pageNum","value":"1"},{"description":{"content":"Date do filter modified registers - incremental search (optional)
\n","type":"text/plain"},"key":"updatedAt","value":"2020-01-13T10:00:00"}],"variable":[]}},"response":[{"id":"5abccda2-efd0-4310-9c16-0ba5f7065787","name":"Purchase Order Status - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/purchaseOrderStatus?createdFrom=2018-09-17&createdTo=2018-09-17","host":["{{endpoint}}"],"path":["purchaseOrderStatus"],"query":[{"key":"createdFrom","value":"2018-09-17","description":"Initial create date to filter change sales orders (required if not unitary search)"},{"key":"createdTo","value":"2018-09-17","description":"Final create date to filter sales orders (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional in list search)","disabled":true},{"key":"partnerKey","value":"NEW","description":"Partner Primary Key in ERP (optional in list search)","disabled":true},{"key":"buyerKey","value":"NEW","description":"Buyer Primary Key in ERP (optional in list search)","disabled":true},{"key":"docStatus","value":"NEW","description":"Default Purchase Order Status to filter sales order (optional in list search - NEW)","disabled":true},{"key":"customStatus","value":"2","description":"Custom Purchase Order Status to filter sales order (optional in list search - depends on UDF in API setup - NEW)","disabled":true},{"key":"customStatusNotify","value":"NEW","description":"Custom Purchase Order Status Notify to filter sales order (optional in list search - depends on UDF in API setup - NEW)","disabled":true},{"key":"customShipMethod","value":"NEW","description":"Custom Shipping Method to filter purchase orders (optional in list search - depends on UDF in API setup - NEW)","disabled":true},{"key":"customShipType","value":"NEW","description":"Custom Shipping Type to filter purchase orders (optional in list search - depends on UDF in API setup - NEW)","disabled":true},{"key":"erpKey","value":"NEW","description":"Purchase Order Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"NEW","description":"Purchase Order Document Number in ERP (optional - unitary search)","disabled":true},{"key":"orderNum","value":"NEW","description":"Partner Purchase Order Number in ERP (optional - unitary search)","disabled":true},{"key":"customOrderKey","value":"NEW","description":"Custom Purchase Order Key to filter purchase order (optional in list search - depends on UDF in API setup - NEW)","disabled":true},{"key":"pageNum","value":"1","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-13T10:00:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 12 May 2021 21:13:24 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"PurchaseOrderStatus\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"purchaseOrderStatus\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.102\",\n \"effectiveTimestamp\": \"2021-05-12T18:13:21\",\n \"createdFrom\": \"2018-09-17\",\n \"createdTo\": \"2018-09-17\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 1,\n \"values\": [\n {\n \"branch\": \"1\",\n \"partnerKey\": \"V22222\",\n \"buyerKey\": \"-1\",\n \"erpKey\": \"115\",\n \"orderNum\": \"\",\n \"docNum\": \"109\",\n \"docStatus\": \"O\",\n \"docDate\": \"2018-09-17\",\n \"docDueDate\": \"2018-09-18\",\n \"createdAt\": \"2018-09-17T22:43:08\",\n \"updatedAt\": \"2018-09-17T22:43:08\",\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"c0a5cefd-bf2b-4917-ac73-a20187bafef1"},{"name":"Purchase Order Status - Options","id":"cb440b37-f42e-45b8-8be5-5bbd014d6b2c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/purchaseOrderStatus/options","description":"(sapBusinessOne=UFD1)
\nThis service will allow you to search custom purchase order status options on the ERP.
\nThe response will inform:
\ncount fieldThis service does not have user field (UDF) treatment.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}},"urlObject":{"path":["purchaseOrderStatus","options"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb440b37-f42e-45b8-8be5-5bbd014d6b2c"},{"name":"Purchase Order Status","id":"7ec8e666-8cd1-4bb6-8e46-7be570049efb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"erpKey\": \"115\",\n \"customOrderKey\": \"10100121-01\"\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/purchaseOrderStatus","description":"(sapBusinessOne=22/OPOR, totvsProtheus=SC7)
\nThis service allows to update a purchase order status in ERP.
\nThe scenario will validate the data received, making selects in the ERP database.
\nPurchase order status will be updated if the purchase order is found on the ERP by the key informed: erpKey or docNum or orderNum.
\nIn this service you can:
\ndocStatus=\"C\")custosOrderKey, custosStatus, customStatusNotify, customShipMethod, customShipType, customTrackingKey, customTrackingUrlComments:
\nerpKey: SAP Business One (OPOR.DocEntry), TOTVS Protheus (x)orderNum: SAP Business One (OPOR.NumAtCard), TOTVS Protheus (x)docNum: SAP Business One (OPOR.DocNum), TOTVS Protheus (x)docStatus: C=closedcustomOrderKey: custom field in order definied in API Setup, and present in bodycustomStatus: custom field in order definied in API Setup, and present in bodycustomStatusNotify: custom field in order definied in API Setup, and present bodycustomShipMethod: custom field in order definied in API Setup, and present in bodycustomShipType: custom field in order definied in API Setup, and present in bodycustomTrackingKey: custom field in order definied in API Setup, and present in bodycustomTrackingUrl: custom field in order definied in API Setup, and present in bodyThis service does not have user field (UDF) treatment.
\n* = Required field
\n(sapBusinessOne=18/OPCH, totvsProtheus=SF1)
\nThis service will allow to search purchase invoices in the ERP.
\nThe search of purchase invoices allows filtering the ERP by:
\nList Search: by createdFrom + createdTo {required}, by branch, partnerKey {optional}
Unitary Search: erpKey or orderNum or docNum
If no field for unitary search (erpKey or orderNum or docNum) is informed in the request, the search for purchase invoices is carried out by date of creation from/to (which become mandatory.
The purchaseInvoices service will consider purchase invoices with:
\nSAP Business One: OPCH.ObjType = 18
\nTOTVS Protheus: F1_TIPO IN 'N', 'C', 'I', 'P'
\nComments:
\nbranch: SAP Business One (OPCH.BPLId), TOTVS Protheus (F1_FILIAL)
partnerKey: SAP Business One (OPCH.CardCode), TOTVS Protheus (F1_FORNECE+'_'+F1_LOJA)
erpKey: SAP Business One (OPCH.DocEntry), TOTVS Protheus (F1_SERIE+'_'+F1_NUM)
orderNum: SAP Business One (OPCH.NumAtCard), TOTVS Protheus (D1_PEDIDO)
docNum: SAP Business One (OPCH.DocNum), TOTVS Protheus (R_E_C_N_O_)
docStatus: O = open, C = canceled, B = billed, P = paid, R = returned, D = draft (*new)
Data returned in response: purchase invoice data, partner data, items (+ taxes), totals, payments, taxes
\nThe response will inform:
\ncount fieldFor list search the pagination feature in the response will be used, where the following fields are used to control the pagination:
\npageSize = maximum number of records on each page (eg: 100), defined in the API configuration, and informed in the response
pageNum = desired page, provided in the request, and informed in the response. If pageNum not informed = 1, If pageNum <=0 = 1, If pageNum > pageTotal = last page
pageTotal = total pages, informed in the response
hasNext = if there are more pages (true / false), informed in the response
This service will allow you to search the purchase invoices list in two situations:
\nFull Search: will result in all purchase invoices, according to filters.
\nIncremental Search: will result in all purchase invoices, according to filters, which have been included and/or changed in the main register after a certain date/time provided in the request. In the Incremental Search, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which exit notes should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields for the Document record in SAP Business One (OPCH.CreateDate, OPCH.UpdateDate, OPCH.CreateTS, OPCH.UpdateTS), [2] TOTVS Protheus: the F1_USERLGI and F1_USERLGA fields
For the use of user fields (UDF) created in the table of purchase invoices (SAPB1: OPCH, TOTVS: SF1), the respective registration must be performed in the Custom Table.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}},"urlObject":{"path":["purchaseInvoices"],"host":["{{endpoint}}"],"query":[{"description":{"content":"Initial create date to filter invoices (required if not unitary search)
\n","type":"text/plain"},"key":"createdFrom","value":"2018-09-17"},{"description":{"content":"Final create date to filter invoices (required if not unitary search)
\n","type":"text/plain"},"key":"createdTo","value":"2020-09-30"},{"description":{"content":"Branch (optional in list search)
\n","type":"text/plain"},"key":"branch","value":"1"},{"description":{"content":"Partner Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"partnerKey","value":"C001"},{"description":{"content":"Buyer Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"buyerKey","value":"22"},{"description":{"content":"Purchase Invoice Primary Key in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"erpKey","value":"120"},{"description":{"content":"Purchase Invoice Document Number in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"docNum","value":"49084"},{"description":{"content":"Partner Purchase Order Number in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"orderNum","value":"1049210322364-01"},{"description":{"content":"NFe key (optional - unitary search)
\n","type":"text/plain"},"key":"nfeKey","value":null},{"description":{"content":"Authorization NFe code (optional)
\n","type":"text/plain"},"key":"nfeAuthCode","value":"100"},{"description":{"content":"Number of page - pagination (optional)
\n","type":"text/plain"},"key":"pageNum","value":"2"},{"description":{"content":"Date to filter purchase invoices changes - incremental search (optional)
\n","type":"text/plain"},"key":"updatedAt","value":"2020-01-24T15:34:00"}],"variable":[]}},"response":[{"id":"4febe9fa-fd08-4efe-8426-b5e80d14fe1b","name":"Purchase Invoices - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/purchaseInvoices?createdFrom=2018-09-17&createdTo=2020-09-30","host":["{{endpoint}}"],"path":["purchaseInvoices"],"query":[{"key":"createdFrom","value":"2018-09-17","description":"Initial create date to filter invoices (required if not unitary search)"},{"key":"createdTo","value":"2020-09-30","description":"Final create date to filter invoices (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional in list search)","disabled":true},{"key":"partnerKey","value":"C001","description":"Partner Primary Key in ERP (optional in list search)","disabled":true},{"key":"buyerKey","value":"22","description":"Buyer Primary Key in ERP (optional in list search)","disabled":true},{"key":"erpKey","value":"120","description":"Purchase Invoice Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"49084","description":"Purchase Invoice Document Number in ERP (optional - unitary search)","disabled":true},{"key":"orderNum","value":"1049210322364-01","description":"Partner Purchase Order Number in ERP (optional - unitary search)","disabled":true},{"key":"nfeKey","value":null,"description":"NFe key (optional - unitary search)","type":"text","disabled":true},{"key":"nfeAuthCode","value":"100","description":"Authorization NFe code (optional)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-24T15:34:00","description":"Date to filter purchase invoices changes - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Version","value":"1.1"},{"key":"FWRESTBUILD","value":"1.15.0717"},{"key":"Content-Type","value":"application/json"},{"key":"Status","value":"200 OK"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"PurchaseInvoices\",\n \"system\": \"totvsProtheus\",\n \"target\": \"purchaseInvoices\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-09T15:04:01\",\n \"createdFrom\": \"2018-09-17\",\n \"createdTo\": \"2020-09-30\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"count\": 1,\n \"values\": [\n {\n \"branch\": \"01\",\n \"branchName\": \"TESTE\",\n \"branchTaxNumber\": \" . . / - \",\n \"buyerKey\": \"\",\n \"erpKey\": \"1/000102345\",\n \"docNum\": \"000102345\",\n \"docSeries\": \"1\",\n \"orderNum\": \"\",\n \"docStatus\": \"D\",\n \"docDate\": \"2020-09-01\",\n \"docDueDate\": \"2020-09-01\",\n \"taxDate\": \"2020-09-17\",\n \"docValue\": 0,\n \"nfeNum\": \"000102345\",\n \"nfeSeries\": \"1\",\n \"nfeType\": \"SPED\",\n \"nfeModel\": \"55\",\n \"nfeKeyAccess\": \"\",\n \"nfeValue\": 0,\n \"nfeAuthCode\": \"\",\n \"nfeAuthProtocol\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null,\n \"supplier\": {\n \"type\": \"S\",\n \"taxType\": \"C\",\n \"partnerKey\": \"00000101\",\n \"fullName\": \"PIXEL INFORMATICA EIRELI - ME\",\n \"aliasName\": \"PIXEL INFO\",\n \"email\": \"\",\n \"phone\": \"47 33696269\",\n \"phoneSecundary\": \"\",\n \"cellular\": null,\n \"taxNumber\": \"11061994000172\",\n \"stateTaxNumber\": \"255.920.350\",\n \"cityTaxNumber\": \"\",\n \"contactPerson\": \"\",\n \"billingAddress\": {\n \"address1\": \"RUA JOSE GUERREIRO FILHO 89\",\n \"exteriorNumber\": null,\n \"address2\": \"SALA 01\",\n \"community\": \"CENTRO\",\n \"city\": \"PORTO BELO\",\n \"county\": \"\",\n \"stateCode\": \"SC\",\n \"countryCode\": \"\",\n \"postalCode\": \"\",\n \"streetType\": null\n },\n \"shippingAddress\": {\n \"address1\": \"RUA JOSE GUERREIRO FILHO 89\",\n \"exteriorNumber\": null,\n \"address2\": \"SALA 01\",\n \"community\": \"CENTRO\",\n \"city\": \"PORTO BELO\",\n \"county\": \"\",\n \"stateCode\": \"SC\",\n \"countryCode\": \"\",\n \"postalCode\": \"\",\n \"streetType\": null\n }\n },\n \"items\": [\n {\n \"lineNum\": \"0001\",\n \"productKey\": \"MC000001\",\n \"codeBars\": \"\",\n \"productName\": \"ADAPTADOR SATA DVD->HD\",\n \"quantity\": 1,\n \"unit\": \"UN\",\n \"unitPrice\": 99,\n \"taxBasis\": 99,\n \"usage\": \"\",\n \"cfop\": \"1556\",\n \"discountRate\": 0,\n \"taxValue\": 0,\n \"freightValue\": 0,\n \"grossValue\": 99,\n \"unitCost\": 0\n },\n {\n \"lineNum\": \"0002\",\n \"productKey\": \"MC000002\",\n \"codeBars\": \"\",\n \"productName\": \"SSD 120GB\",\n \"quantity\": 1,\n \"unit\": \"UN\",\n \"unitPrice\": 329,\n \"taxBasis\": 329,\n \"usage\": \"\",\n \"cfop\": \"1556\",\n \"discountRate\": 0,\n \"taxValue\": 0,\n \"freightValue\": 0,\n \"grossValue\": 329,\n \"unitCost\": 0\n }\n ],\n \"totals\": {\n \"invoiceTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0,\n \"priceAdjustValue\": 0,\n \"priceAdjustType\": \"\",\n \"priceAdjustPromotionId\": \"\",\n \"priceAdjustCouponId\": \"\"\n },\n \"shippingTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n },\n \"payments\": null,\n \"taxes\": null\n }\n ]\n}"},{"id":"f8f8f624-45f8-45f5-a39b-e297669cd7a9","name":"Purchase Invoices - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/purchaseInvoices?createdFrom=2018-09-17&createdTo=2020-09-30","host":["{{endpoint}}"],"path":["purchaseInvoices"],"query":[{"key":"createdFrom","value":"2018-09-17","description":"Initial create date to filter invoices (required if not unitary search)"},{"key":"createdTo","value":"2020-09-30","description":"Final create date to filter invoices (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional in list search)","disabled":true},{"key":"partnerKey","value":"C001","description":"Partner Primary Key in ERP (optional in list search)","disabled":true},{"key":"buyerKey","value":"22","description":"Buyer Primary Key in ERP (optional in list search)","disabled":true},{"key":"erpKey","value":"120","description":"Purchase Invoice Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"49084","description":"Purchase Invoice Document Number in ERP (optional - unitary search)","disabled":true},{"key":"orderNum","value":"1049210322364-01","description":"Partner Purchase Order Number in ERP (optional - unitary search)","disabled":true},{"key":"nfeKey","value":null,"description":"NFe key (optional - unitary search)","disabled":true},{"key":"nfeAuthCode","value":"100","description":"Authorization NFe code (optional)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-24T15:34:00","description":"Date to filter purchase invoices changes - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 13 May 2021 22:11:35 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"PurchaseInvoices\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"purchaseInvoices\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.102\",\n \"effectiveTimestamp\": \"2021-05-13T19:11:32\",\n \"createdFrom\": \"2018-09-17\",\n \"createdTo\": \"2020-09-30\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 1,\n \"values\": [\n {\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"buyerKey\": \"2\",\n \"erpKey\": \"69\",\n \"docNum\": \"69\",\n \"orderNum\": \"\",\n \"docStatus\": \"O\",\n \"docDate\": \"2018-09-17\",\n \"docDueDate\": \"2018-12-31\",\n \"taxDate\": \"2018-09-17\",\n \"docValue\": 24877.5,\n \"taxValue\": 3109.69,\n \"paymentCondition\": \"2\",\n \"paymentMethod\": \"Pgto. Transf.\",\n \"nfeSeries\": \"2\",\n \"nfeNum\": \"1023\",\n \"nfeType\": \"NFe\",\n \"nfeModel\": \"55\",\n \"nfeKey\": \"\",\n \"nfeValue\": 24877.5,\n \"baseObject\": \"-1\",\n \"baseKey\": \"\",\n \"comments\": \"\",\n \"customOrderKey\": \"\",\n \"customStatus\": \"\",\n \"customStatusNotify\": \"\",\n \"createdAt\": \"2018-09-17T22:09:03\",\n \"updatedAt\": \"2018-09-17T22:09:05\",\n \"canceledAt\": null,\n \"supplier\": {\n \"type\": \"S\",\n \"taxType\": \"C\",\n \"partnerKey\": \"F003\",\n \"docEntry\": \"3\",\n \"fullName\": \"Oakley\",\n \"aliasName\": \"\",\n \"email\": \"oakley@oakley.com\",\n \"phone\": \"7698-9832\",\n \"phoneSecondary\": \"51\",\n \"cellular\": \"51-9873-3248\",\n \"taxNumber\": \"04.692.027/0002-24\",\n \"stateTaxNumber\": \"206.198.106.117\",\n \"cityTaxNumber\": \"\",\n \"billingAddress\": {\n \"address1\": \"Farroupilha\",\n \"address2\": \"10° andar\",\n \"city\": \"Porto Alegre\",\n \"county\": \"4240\",\n \"postalCode\": \"32498\",\n \"stateCode\": \"RS\",\n \"countryCode\": \"BR\",\n \"community\": \"Jardins\",\n \"exteriorNumber\": \"2312\",\n \"streetType\": \"Av.\"\n },\n \"shippingAddress\": {\n \"address1\": \"das Nações Unidas\",\n \"address2\": \"6° andar\",\n \"city\": \"São Paulo\",\n \"county\": \"5344\",\n \"postalCode\": \"04795-100\",\n \"stateCode\": \"SP\",\n \"countryCode\": \"BR\",\n \"community\": \"Brooklin\",\n \"exteriorNumber\": \"14.171\",\n \"streetType\": \"Av.\"\n }\n },\n \"items\": [\n {\n \"lineNum\": \"0\",\n \"productKey\": \"I014\",\n \"codeBars\": \"\",\n \"productName\": \"Óculos LIMITED EDITION RADAR® PATH™\",\n \"quantity\": 10,\n \"unit\": \"Un\",\n \"unitPrice\": 2125,\n \"taxBasis\": 21250,\n \"usage\": \"5\",\n \"cfop\": \"1101\",\n \"whsCode\": \"05\",\n \"discountRate\": 0,\n \"taxValue\": 1487.5,\n \"freightValue\": 0,\n \"grossValue\": 26562.5,\n \"unitCost\": 0,\n \"costCenter\": \"\",\n \"accountCode\": \"1.1.3.1.1\",\n \"financialProject\": \"\",\n \"comments\": \"\",\n \"itemTaxes\": [\n {\n \"taxRelate\": \"product\",\n \"taxCode\": \"ICMSBI00\",\n \"taxBasis\": 21250,\n \"taxRate\": 18,\n \"taxValue\": 3825\n },\n {\n \"taxRelate\": \"product\",\n \"taxCode\": \"IPIBI000\",\n \"taxBasis\": 21250,\n \"taxRate\": 7,\n \"taxValue\": 1487.5\n }\n ]\n },\n {\n \"lineNum\": \"1\",\n \"productKey\": \"I015\",\n \"codeBars\": \"\",\n \"productName\": \"Lentes de Reposição\",\n \"quantity\": 20,\n \"unit\": \"Un\",\n \"unitPrice\": 100,\n \"taxBasis\": 2000,\n \"usage\": \"5\",\n \"cfop\": \"1101\",\n \"whsCode\": \"05\",\n \"discountRate\": 0,\n \"taxValue\": 140,\n \"freightValue\": 0,\n \"grossValue\": 2500,\n \"unitCost\": 0,\n \"costCenter\": \"\",\n \"accountCode\": \"1.1.3.1.1\",\n \"financialProject\": \"\",\n \"comments\": \"\",\n \"itemTaxes\": [\n {\n \"taxRelate\": \"product\",\n \"taxCode\": \"ICMSBI00\",\n \"taxBasis\": 2000,\n \"taxRate\": 18,\n \"taxValue\": 360\n },\n {\n \"taxRelate\": \"product\",\n \"taxCode\": \"IPIBI000\",\n \"taxBasis\": 2000,\n \"taxRate\": 7,\n \"taxValue\": 140\n }\n ]\n }\n ],\n \"totals\": {\n \"invoiceTotal\": {\n \"netValue\": 21767.81,\n \"grossValue\": 24877.5,\n \"baseValue\": 24877.5,\n \"taxValue\": 3109.69\n },\n \"merchandizeTotal\": {\n \"netValue\": 23250,\n \"grossValue\": 23250,\n \"baseValue\": 23250,\n \"taxValue\": 0\n },\n \"shippingTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n },\n \"payments\": [\n {\n \"erpKey\": \"1300\",\n \"lineNum\": \"0\",\n \"docDueDate\": \"2018-10-30\",\n \"status\": \"O\",\n \"docValue\": 7255.21,\n \"docBalance\": 7255.21\n },\n {\n \"erpKey\": \"1300\",\n \"lineNum\": \"1\",\n \"docDueDate\": \"2018-11-30\",\n \"status\": \"O\",\n \"docValue\": 7255.21,\n \"docBalance\": 7255.21\n },\n {\n \"erpKey\": \"1300\",\n \"lineNum\": \"2\",\n \"docDueDate\": \"2018-12-31\",\n \"status\": \"O\",\n \"docValue\": 7257.39,\n \"docBalance\": 7257.39\n }\n ]\n }\n ]\n}"}],"_postman_id":"805760e7-74c1-4398-b7be-3eb3862dd5b6"},{"name":"Purchase Invoices*","id":"262eeebc-f276-48c0-afd9-e7118d29d4e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"branch\": \"1\",\r\n \"docStatus\": \"D\",\r\n \"docDate\": \"2020-09-14\",\r\n\r\n \"nfeFinality\": 1,\r\n\r\n \"nfeNum\": \"36871\",\r\n \"nfeSeries\": \"2\",\r\n \"nfeModel\": \"55\",\r\n \"nfeKeyAccess\": \"42200905343620000147550020000368711001058821\",\r\n \"nfeAuthCode\": 100,\r\n \"nfeAuthProtocol\": \"135200844436206\",\r\n \"nfeValue\": 14075.19,\r\n\r\n \"baseKey *\": \"\",\r\n \"whsCode *\": \"\",\r\n \"mainUsage *\": \"\",\r\n \"orderNum *\": \"\",\r\n\r\n\t\"totalWeight\": 2040.000,\r\n \"totalGrossWeight\": 2110.000,\r\n\t\"totalVolume\": 5,\r\n \"volumeName\": \"VOLUMES\",\r\n \"comments\": \"IPI SUSP. CFE. ART. 29 PAR 1 ITEM 1 LETRA A DA LEI 10637 DE 31/12/02 ICMS Dif. Pro-emprego decr N105 de 14/03/2007 Res. 113/2008-055 Vig. 31/12/2007 Conv. Pela lei 13992 de 15/02/2004 Art. 18 Par\",\r\n \"supplierComments\": \"DADOS PARA DEPOSITO: Banco do Brasil | Ag 95-7 | CC 3535-1 PEDIDO: 5500003375 ORDEM DE COMPRA: 5500003375\",\r\n\r\n \"supplier\": {\r\n\t\t\"type\": \"S\",\r\n\t\t\"taxType\": \"C\",\r\n\t\t\"partnerId\": \"\",\r\n\t\t\"fullName\": \"TUPY S/A\",\r\n\t\t\"aliasName\": \"TUPY S/A\",\r\n\t\t\"email\": \"recebe.nfe@tupy.com.br\",\r\n\t\t\"phone\": \"4740098181\",\r\n\t\t\"phoneSecondary\": \"\",\r\n\t \"cellular\": \"\",\r\n\t\t\"taxNumber\": \"84683374000300\",\r\n\t\t\"stateTaxNumber\": \"255505256\",\r\n\t\t\"cityTaxNumber\": \"\",\r\n\t\t\"billingAddress\": {\r\n \"address1\": \"R ALBANO SCHMIDT\",\r\n \"address2\": \"\",\r\n \"city\": \"JOINVILLE\",\r\n \"postalCode\": \"89227901\",\r\n \"stateCode\": \"SC\",\r\n \"*county\": \"4209102\",\r\n \"community\": \"BOA VISTA\",\r\n \"exteriorNumber\": \"3400\",\r\n \"streetType\": \"Rua\",\r\n \"countryCode\": \"BR\"\r\n\t\t}\r\n },\r\n\r\n\t\"items\": [\r\n\t\t{\r\n\t\t\t\"lineNum\": \"1\",\r\n\t\t\t\"productKey\": \"PA12800003\",\r\n \"productName\": \"PC.REFRAT. NOZZLE RETO VALVULA 24MM EZ 96 AL P - EZP 471.24 (5500003375-170)\",\r\n \"ncm\": \"69029090\",\r\n\r\n \"orderNum\": \"5500003375\",\r\n \"orderLineNum\": 170,\r\n \"baseKey*\": \"\",\r\n \"baseLineNum*\": 0,\r\n\r\n\t\t\t\"quantity\": 5.0000,\r\n \"unit\": \"UN\",\r\n \"unitPrice\": 27.15000000,\r\n \"taxBasis\": 135.75,\r\n\r\n \"cfop\": \"5101\",\r\n \"discountRate\": 0,\r\n \"taxValue\": 0.00,\r\n \"freightValue\": 0.00,\r\n \"grossValue\": 135.75,\r\n\r\n \"itemTaxes\": [\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"ICMS51\",\r\n \"taxSituationCode\": \"51\",\r\n \"taxBasis\": 0.00,\r\n \"taxRate\": 0,\r\n \"taxValue\": 0.00\r\n },\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"IPI\",\r\n \"taxSituationCode\": \"55\",\r\n \"framingCode\": \"122\",\r\n \"taxBasis\": 0.00,\r\n \"taxRate\": 0,\r\n \"taxValue\": 0.00\r\n },\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"PIS\",\r\n \"taxSituationCode\": \"01\",\r\n \"taxBasis\": 135.75,\r\n \"taxRate\": 1.6500,\r\n \"taxValue\": 2.23\r\n },\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"COFINS\",\r\n \"taxSituationCode\": \"01\",\r\n \"taxBasis\": 135.75,\r\n \"taxRate\": 7.6000,\r\n \"taxValue\": 10.31\r\n }\r\n ]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"lineNum\": \"2\",\r\n\t\t\t\"productKey\": \"PA11340064\",\r\n \"productName\": \"TIJ.REFRAT. AE 229X114-106X40-37 EZ 810 CR (5500003375-190)\",\r\n \"ncm\": \"69029090\",\r\n\r\n \"orderNum\": \"5500003375\",\r\n \"orderLineNum\": 190,\r\n\r\n\t\t\t\"quantity\": 440.0000,\r\n \"unit\": \"PC\",\r\n \"unitPrice\": 22.73000000,\r\n \"taxBasis\": 10001.20,\r\n\r\n \"cfop\": \"5101\",\r\n \"discountRate\": 0,\r\n \"taxValue\": 0.00,\r\n \"freightValue\": 0.00,\r\n \"grossValue\": 10001.20,\r\n\r\n \"itemTaxes\": [\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"ICMS51\",\r\n \"taxSituationCode\": \"51\",\r\n \"taxBasis\": 0.00,\r\n \"taxRate\": 0,\r\n \"taxValue\": 0.00\r\n },\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"IPI\",\r\n \"taxSituationCode\": \"55\",\r\n \"framingCode\": \"122\",\r\n \"taxBasis\": 0.00,\r\n \"taxRate\": 0,\r\n \"taxValue\": 0.00\r\n },\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"PIS\",\r\n \"taxSituationCode\": \"01\",\r\n \"taxBasis\": 10001.20,\r\n \"taxRate\": 1.6500,\r\n \"taxValue\": 165.01\r\n },\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"COFINS\",\r\n \"taxSituationCode\": \"01\",\r\n \"taxBasis\": 10001.20,\r\n \"taxRate\": 7.6000,\r\n \"taxValue\": 760.09\r\n }\r\n ]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"lineNum\": \"3\",\r\n\t\t\t\"productKey\": \"PA11100283\",\r\n \"productName\": \"TIJ.REFRAT. P 229X114X76 EZ 810 CR (5500003375-30)\",\r\n \"ncm\": \"69029090\",\r\n\r\n \"orderNum\": \"5500003375\",\r\n \"orderLineNum\": 30,\r\n\r\n\t\t\t\"quantity\": 100.0000,\r\n \"unit\": \"PC\",\r\n \"unitPrice\": 29.87000000,\r\n \"taxBasis\": 2987.00,\r\n\r\n \"cfop\": \"5101\",\r\n \"discountRate\": 0,\r\n \"taxValue\": 0.00,\r\n \"freightValue\": 0.00,\r\n \"grossValue\": 2987.00,\r\n\r\n \"itemTaxes\": [\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"ICMS51\",\r\n \"taxSituationCode\": \"51\",\r\n \"taxBasis\": 0.00,\r\n \"taxRate\": 0,\r\n \"taxValue\": 0.00\r\n },\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"IPI\",\r\n \"taxSituationCode\": \"55\",\r\n \"framingCode\": \"122\",\r\n \"taxBasis\": 0.00,\r\n \"taxRate\": 0,\r\n \"taxValue\": 0.00\r\n },\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"PIS\",\r\n \"taxSituationCode\": \"01\",\r\n \"taxBasis\": 2987.00,\r\n \"taxRate\": 1.6500,\r\n \"taxValue\": 49.28\r\n },\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"COFINS\",\r\n \"taxSituationCode\": \"01\",\r\n \"taxBasis\": 2987.00,\r\n \"taxRate\": 7.6000,\r\n \"taxValue\": 227.01\r\n }\r\n ]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"lineNum\": \"4\",\r\n\t\t\t\"productKey\": \"PA12930057\",\r\n \"productName\": \"CONJ. BICA MECANA DFP 1889 FLOW 31/7 (20000490) - SECADA (5500003375-460)\",\r\n \"ncm\": \"69029090\",\r\n\r\n \"orderNum\": \"5500003375\",\r\n \"orderLineNum\": 460,\r\n\r\n\t\t\t\"quantity\": 6.0000,\r\n \"unit\": \"PC\",\r\n \"unitPrice\": 158.54000000,\r\n \"taxBasis\": 951.24,\r\n\r\n \"cfop\": \"5101\",\r\n \"discountRate\": 0,\r\n \"taxValue\": 0.00,\r\n \"freightValue\": 0.00,\r\n \"grossValue\": 951.24,\r\n\r\n \"itemTaxes\": [\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"ICMS51\",\r\n \"taxSituationCode\": \"51\",\r\n \"taxBasis\": 0.00,\r\n \"taxRate\": 0,\r\n \"taxValue\": 0.00\r\n },\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"IPI\",\r\n \"taxSituationCode\": \"55\",\r\n \"framingCode\": \"122\",\r\n \"taxBasis\": 0.00,\r\n \"taxRate\": 0,\r\n \"taxValue\": 0.00\r\n },\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"PIS\",\r\n \"taxSituationCode\": \"01\",\r\n \"taxBasis\": 951.24,\r\n \"taxRate\": 1.6500,\r\n \"taxValue\": 15.69\r\n },\r\n {\r\n \"taxRelate\": \"product\",\r\n \"taxCode\": \"COFINS\",\r\n \"taxSituationCode\": \"01\",\r\n \"taxBasis\": 951.24,\r\n \"taxRate\": 7.6000,\r\n \"taxValue\": 72.29\r\n }\r\n ]\r\n\t\t}\r\n\t],\r\n\r\n \"shipment\": {\r\n \"shippingMethod\": \"0\",\r\n \"carrierName\": \"EKW DO BRASIL - PRODUTOS REFRATARIOS LTD\",\r\n \"carrierTaxNumber\": \"05343620000147\",\r\n \"carrierStateTaxNumber\": \"254480942\",\r\n \"carrierAddress\": \"RUA VICTOR KONELL\",\r\n \"carrierCity\": \"POMERODE\",\r\n \"carrierState\": \"SC\",\r\n \"carrierPlate\": \"\",\r\n\r\n \"shippingAddress\": {\r\n\t\t\t\t\"address1\": \"R ALBANO SCHMIDT\",\r\n\t\t\t\t\"address2\": \"\",\r\n\t\t\t\t\"city\": \"JOINVILLE\",\r\n\t\t\t\t\"postalCode\": \"89227901\",\r\n\t\t\t\t\"stateCode\": \"SC\",\r\n \"*county\": \"4209102\",\r\n\t\t\t\t\"community\": \"BOA VISTA\",\r\n\t\t\t\t\"exteriorNumber\": \"3400\",\r\n\t\t\t\t\"streetType\": \"Rua\",\r\n\t\t\t\t\"countryCode\": \"BR\"\r\n }\r\n },\r\n\r\n \"totals\": {\r\n \"invoiceTotal\": {\r\n \"netValue\": 14075.19,\r\n \"grossValue\": 14075.19,\r\n \"baseValue\": 14075.19,\r\n \"taxValue\": 0\r\n },\r\n \"merchandizeTotal\": {\r\n \"netValue\": 14075.19,\r\n \"grossValue\": 14075.19,\r\n \"baseValue\": 14075.19,\r\n \"taxValue\": 0,\r\n \"priceAdjustValue\": 0,\r\n \"priceAdjustType\": \"\",\r\n \"priceAdjustPromotionId\": \"\",\r\n \"priceAdjustCouponId\": \"\"\r\n },\r\n \"shippingTotal\": {\r\n \"netValue\": 0.00,\r\n \"grossValue\": 0.00,\r\n \"baseValue\": 0.00,\r\n \"taxValue\": 0,\r\n \"shipAdjustValue\": 0,\r\n \"shipAdjustType\": \"\",\r\n \"shipAdjustPromotionId\": \"\",\r\n \"shipAdjustCouponId\": \"\"\r\n }\r\n },\r\n\r\n\t\"payments\": [\r\n\t\t{\r\n\t\t\t\"paymentMethod\": \"boe\",\r\n\t\t\t\"amount\": 14075.19,\r\n\t\t\t\"installments\": 1,\r\n\t\t\t\"details\": {\r\n \"boeNum\": \"001\",\r\n \"boeDueDate\": \"2020-10-14\",\r\n \"boeOurNum\": \"\",\r\n \"boeCodeBars\": \"\"\r\n\t\t\t}\r\n\t\t}\r\n\t],\r\n\r\n \"taxes\": [\r\n {\r\n \"taxCode\": \"ICMS\",\r\n \"taxBasis\": 0.00,\r\n \"taxValue\": 0.00\r\n },\r\n {\r\n \"taxCode\": \"IPI\",\r\n \"taxBasis\": 0.00,\r\n \"taxValue\": 0.00\r\n },\r\n {\r\n \"taxCode\": \"PIS\",\r\n \"taxBasis\": 14075.19,\r\n \"taxValue\": 232.21\r\n },\r\n {\r\n \"taxCode\": \"COFINS\",\r\n \"taxBasis\": 14075.19,\r\n \"taxValue\": 1069.70\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/purchaseInvoices","description":"(sapBusinessOne=18/OPCH, totvsProtheus=SF1)
\nThis service will allow to insert a new purchase invoice in the ERP. To insert a draft purchase invoice send the filed docStatus as \"D\" in request.
The scenario will validate the data received, making selects in the ERP database.
\nA new purchase invoice will be insert with or without a purchase order. If you informe a purchase order in request, it is located and validated on the ERP. The key for locating the purchase order on the ERP can be:
\nbaseKey or OPOR.DocNum = baseNum or OPOR.NumAtCard = orderNumbaseKey or R_E_C_N_O_ = baseNum or C7_NUMIMP = orderNumProducts: [1] productKey or codeBars, [2] purchaseOrder + lineNum, [3] table product x supplier (TOTVS Protheus only), [4] generic product (GP PurInvGenericProduct).
Products sent to the service will be validated for the search key, purchase order line number (if informed) and quantity. Products can be identified in the ERP in 2 ways:
\ncodeBars or OITM.ItemCode = productKey, [2] purchaseOrder + lineNum, [3] generic product (GP PurInvGenericProduct).codeBars or B1_COD = productKey, [2] purchaseOrder + lineNum, [3] table product x supplier (SA5), [4] generic product (GP PurInvGenericProduct).In addition to the purchase invoice, the service may or may not include outcoming payments. Outcoming Paymnets has origin from the data received in the request in the payments block.
For the use of user fields (UDF) created in the table of purchase invoices (SAPB1: OPCH, TOTVS: SF1), the respective registration must be performed in the Custom Table.
\n* = Required field
\n(sapBusinessOne=30/OJDT, totvsProtheus=SE2)
\nThe search of payables allows you to filter the ERP by:
\ncreatedFrom + createdTo {required}, by dueFrom + dueTo, branch, partnerKey, buyerKey {optional}erpKeyIf no field for unitary query (erpKey) is informed in the request, the search for payables is performed as a list.
The payables service will consider payables:
\nComments:
\nbranch: SAP Business One (JDT1.BPLId), TOTVS Protheus (E2_FILIAL)createdFrom and createdTo: SAP Business One (JDT1.RefDate), TOTVS Protheus (E2_EMISSAO)dueFrom and dueTo: SAP Business One (JDT1.DueDate, TOTVS Protheus (E2_VENCREA)erpKey: SAP Business One (JDT1.TransIf), TOTVS Protheus (E2_PREFIXO+”_”+E2_NUM)This service will allow you to search the payables list in two situations:
\ncreatedFrom / createdTo period. createdFrom / createdTo period and after a given date / time provided in the request. In Incremental search, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which records should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Creation Time fields of the transaction table in SAP Business One (OJDT.CreateDate, OJDT.UpdateDate), [2] TOTVS Protheus: E2_USERLGI and E2_USERLGAThe response will inform:
\ncount fieldFor list search the pagination feature in the response will be used, where the following fields are used to control the pagination:
\npageSize = number of records on each page (eg 100), defined in the B1If configuration (Scenarios> Setup) and informed in the responsepageNum = desired page, provided in the request and informed in the response. If pageNum not informed = 1, If pageNum <=0 = 1, If pageNum > pageTotal = last pagepageTotal = total pages, reported in the responsehasNext = if there are more pages (true / false), informed in the responseThis service does not have user field (UDF) treatment.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}},"urlObject":{"path":["payables"],"host":["{{endpoint}}"],"query":[{"description":{"content":"Initial create date to filter payables (required if not unitary search)
\n","type":"text/plain"},"key":"createdFrom","value":"2020-01-24"},{"description":{"content":"Final create date to filter payables (required if not unitary search)
\n","type":"text/plain"},"key":"createdTo","value":"2020-12-24"},{"description":{"content":"Branch (optional in list search)
\n","type":"text/plain"},"key":"branch","value":"1"},{"description":{"content":"Initial due date to filter payables (optional in list search)
\n","type":"text/plain"},"key":"dueFrom","value":"2020-01-24"},{"description":{"content":"Final due date to filter payables (optional in list search)
\n","type":"text/plain"},"key":"dueTo","value":"2020-01-24"},{"description":{"content":"Partner Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"partnerKey","value":"C000004"},{"disabled":true,"description":{"content":"Buyer Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"buyerKey","value":"120"},{"description":{"content":"Payable Primary Key in ERP (optional for unitary search)
\n","type":"text/plain"},"key":"erpKey","value":"120"},{"description":{"content":"Number of page - pagination (optional)
\n","type":"text/plain"},"key":"pageNum","value":"1"},{"description":{"content":"Date do filter modified registers - incremental search (optional)
\n","type":"text/plain"},"key":"updatedAt","value":"2020-01-24T15:34:00"}],"variable":[]}},"response":[{"id":"407e6658-71de-4f21-9366-4e78d650e7c1","name":"Payables - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/payables?createdFrom=2018-01-24&createdTo=2020-01-24","host":["{{endpoint}}"],"path":["payables"],"query":[{"key":"createdFrom","value":"2018-01-24","description":"Initial create date to filter payables (required if not unitary search)"},{"key":"createdTo","value":"2020-01-24","description":"Final create date to filter payables (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional in list search)","disabled":true},{"key":"dueFrom","value":"2020-01-24","description":"Initial due date to filter payables (optional in list search)","disabled":true},{"key":"dueTo","value":"2020-01-24","description":"Final due date to filter payables (optional in list search)","disabled":true},{"key":"partnerKey","value":"C000004","description":"Partner Primary Key in ERP (optional in list search)","disabled":true},{"key":"buyerKey","value":"120","description":"Buyer Primary Key in ERP (optional in list search)","disabled":true},{"key":"erpKey","value":"120","description":"Payable Primary Key in ERP (optional for unitary search)","disabled":true},{"key":"pageNum","value":"1","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-24T15:34:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"JSESSIONID=6EAED0F577B8A311A37B0D26BD48A780; Path=/B1iXcellerator; HttpOnly"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Fri, 16 Oct 2020 19:55:53 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"Payables\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"payables\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-10-16T16:55:44\",\n \"createdFrom\": \"2018-01-24\",\n \"createdTo\": \"2020-01-24\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 1,\n \"values\": [\n {\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"erpKey\": \"685\",\n \"lineNum\": \"0\",\n \"docDate\": \"2018-03-05\",\n \"docDueDate\": \"2018-03-05\",\n \"docValue\": 2.14,\n \"partnerKey\": \"F012\",\n \"paymentMethod\": \"Pgto em Cheque\",\n \"baseObject\": \"18\",\n \"baseKey\": \"61\",\n \"nfeSeries\": \"6\",\n \"nfeNum\": \"10101\",\n \"remarks\": \"Notas fiscais de Entrada - F012\",\n \"createdAt\": \"2018-03-05T22:37:00\",\n \"updatedAt\": \"2018-03-05T00:00:00\",\n \"canceledAt\": null\n }\n ]\n}"},{"id":"bea4e597-b973-434d-a9dd-50f6f7d64ae2","name":"Payables - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/payables?createdFrom=2020-01-24&createdTo=2020-12-24","host":["{{endpoint}}"],"path":["payables"],"query":[{"key":"createdFrom","value":"2020-01-24","description":"Initial create date to filter payables (required if not unitary search)"},{"key":"createdTo","value":"2020-12-24","description":"Final create date to filter payables (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional in list search)","disabled":true},{"key":"dueFrom","value":"2020-01-24","description":"Initial due date to filter payables (optional in list search)","disabled":true},{"key":"dueTo","value":"2020-01-24","description":"Final due date to filter payables (optional in list search)","disabled":true},{"key":"partnerKey","value":"C000004","description":"Partner Primary Key in ERP (optional in list search)","disabled":true},{"key":"buyerKey","value":"120","description":"Buyer Primary Key in ERP (optional in list search)","disabled":true},{"key":"erpKey","value":"120","description":"Payable Primary Key in ERP (optional for unitary search)","disabled":true},{"key":"pageNum","value":"1","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-24T15:34:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Version","value":"1.1"},{"key":"FWRESTBUILD","value":"1.15.0717"},{"key":"Content-Type","value":"application/json"},{"key":"Status","value":"200 OK"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"Payables\",\n \"system\": \"totvsProtheus\",\n \"target\": \"payables\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-09T18:35:12\",\n \"createdFrom\": \"2020-01-24\",\n \"createdTo\": \"2020-12-24\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"values\": [\n {\n \"branch\": \"01\",\n \"branchName\": \"TESTE\",\n \"branchTaxNumber\": \" . . / - \",\n \"erpKey\": \"1_100000002\",\n \"lineNum\": \"\",\n \"docDate\": \"2020-11-09\",\n \"docDueDate\": \"2020-11-09\",\n \"docValue\": 70,\n \"partnerKey\": \"00000101\",\n \"baseObject\": \"18\",\n \"baseKey\": \"100000002\",\n \"nfeSeries\": \"\",\n \"nfeNum\": \"100000002\",\n \"paymentMethod\": \"NF\",\n \"remarks\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ],\n \"count\": 1\n}"}],"_postman_id":"940b6267-d194-410f-a4ab-ea12d267e6ec"}],"id":"d6d651a1-a3e8-4e40-a6bb-9432671406c9","_postman_id":"d6d651a1-a3e8-4e40-a6bb-9432671406c9","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}}},{"name":"Outcoming Payments*","item":[{"name":"Outcoming Payments","id":"a788b12a-017e-438b-b7c5-22e8a4785f46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/outPayments?paidFrom=2018-01-01&paidTo=2020-12-31&branch=1&dueFrom=2018-01-01&dueTo=2020-12-31&partnerKey=C001&erpKey=120&pageNum=1&updatedAt=2020-01-24T15:34:00","description":"(sapBusinessOne=46/OVPM, totvsProtheus=FK2)
\nThe search of outcoming payments allows filtering the ERP by:
\npaidFrom + paidTo {required}, by dueFrom + dueTo, branch, partnerKey, buyerKey {optional}erpKeyIf no field for unitary query (erpKey) is informed in the request, the query for outcoming payments is performed as a list.
The outcoming payments service will consider valid receipts for payables:
\nComments:
\nbranch: SAP Business One (OVPM.BPLId), TOTVS Protheus (FK1_FILIAL)paidFrom and paidTo: SAP Business One (OVPM.DocDate, ORCT.TrsfrDate, OBOE.PmntDate or BOT1.TranDate *), TOTVS Protheus (FK2_DATA)dueFrom and dueTo: SAP Business One (OVPM.DocDueDate, INV6.DueDate or OBOE.DueDate), TOTVS Protheus (FK2_VENCTO)erpKey: SAP Business One (OVPM.DocEntry), TOTVS Protheus (FK2_IDFK2)baseObject: 18 (purchaseInvoice), 30 (journalEntry), 19 (purchaseCreditNote), 204 (purDownPayment)baseKey: SAP Business One (OINV.DocEntry, JDT1.AbsEntry, ORIN.DocEntry), TOTVS Protheus (E2_PREFIXO+'_'+E2_NUM)lineNum: installmentpaymentMethod: cash, transfer, boe, check, creditCardThis service will allow you to search the outcoming payments list in two situations:
\nupdatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which exit notes should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields for the Document record in SAP Business One (OVPM.CreateDate, OVPM.UpdateDate, OVPM.CreateTS, OVPM.UpdateTS), [2] TOTVS Protheus: the E5_USERLGI and E5_USERLGA fieldsThe response will inform:
\ncount fieldFor outcoming payments list the pagination feature in the response will be used, where the following fields are used to control the pagination:
\npageSize = number of records on each page (eg 100), defined in the API configuration and informed in the responsepageNum = desired page, provided in the request and informed in the response. If pageNum not informed = 1, If pageNum <=0 = 1, If pageNum > pageTotal = last pagepageTotal = total pages, reported in the responsehasNext = if there are more pages (true / false), informed in the responseThis service does not have user field (UDF) treatment.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}},"urlObject":{"path":["outPayments"],"host":["{{endpoint}}"],"query":[{"description":{"content":"Initial payment date to filter outcoming payments (required if not unitary search)
\n","type":"text/plain"},"key":"paidFrom","value":"2018-01-01"},{"description":{"content":"Final payment date to filter outcoming payments (required if not unitary search)
\n","type":"text/plain"},"key":"paidTo","value":"2020-12-31"},{"description":{"content":"Branch (optional in list search)
\n","type":"text/plain"},"key":"branch","value":"1"},{"description":{"content":"Initial due date to filter incoming payments (optional in list search)
\n","type":"text/plain"},"key":"dueFrom","value":"2018-01-01"},{"description":{"content":"Final due date to filter incoming payments (optional in list search)
\n","type":"text/plain"},"key":"dueTo","value":"2020-12-31"},{"description":{"content":"Partner Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"partnerKey","value":"C001"},{"disabled":true,"description":{"content":"Buyer Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"buyerKey","value":null},{"description":{"content":"Outcoming Payment Primary Key in ERP (optional for unitary search)
\n","type":"text/plain"},"key":"erpKey","value":"120"},{"description":{"content":"Number of page - pagination (optional)
\n","type":"text/plain"},"key":"pageNum","value":"1"},{"description":{"content":"Date do filter modified registers - incremental search (optional)
\n","type":"text/plain"},"key":"updatedAt","value":"2020-01-24T15:34:00"}],"variable":[]}},"response":[{"id":"060f8abf-cc2f-470e-808b-aacc05107a72","name":"Outcoming Payments - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/outPayments?paidFrom=2018-01-01&paidTo=2020-12-31&branch=1&dueFrom=2018-01-01&dueTo=2020-12-31&partnerKey=C001&erpKey=120&pageNum=1&updatedAt=2020-01-24T15:34:00","host":["{{endpoint}}"],"path":["outPayments"],"query":[{"key":"paidFrom","value":"2018-01-01","description":"Initial payment date to filter outcoming payments (required if not unitary search)"},{"key":"paidTo","value":"2020-12-31","description":"Final payment date to filter outcoming payments (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional in list search)"},{"key":"dueFrom","value":"2018-01-01","description":"Initial due date to filter incoming payments (optional in list search)"},{"key":"dueTo","value":"2020-12-31","description":"Final due date to filter incoming payments (optional in list search)"},{"key":"partnerKey","value":"C001","description":"Partner Primary Key in ERP (optional in list search)"},{"key":"buyerKey","value":null,"description":"Buyer Primary Key in ERP (optional in list search)","type":"text","disabled":true},{"key":"erpKey","value":"120","description":"Outcoming Payment Primary Key in ERP (optional for unitary search)"},{"key":"pageNum","value":"1","description":"Number of page - pagination (optional)"},{"key":"updatedAt","value":"2020-01-24T15:34:00","description":"Date do filter modified registers - incremental search (optional)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Version","value":"1.1"},{"key":"FWRESTBUILD","value":"1.15.0717"},{"key":"Content-Type","value":"application/json"},{"key":"Status","value":"200 OK"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"OutPayments\",\n \"system\": \"totvsProtheus\",\n \"target\": \"outPayments\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-09T18:37:19\",\n \"paidFrom\": \"2018-01-01\",\n \"paidTo\": \"2020-12-31\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"countTotal\": 1,\n \"values\": [\n {\n \"branch\": \"01\",\n \"branchName\": \"TESTE\",\n \"branchTaxNumber\": \" . . / - \",\n \"erpKey\": \"63b428788a2b47639643c4405e2bf590\",\n \"paymentDate\": \"2020-11-09\",\n \"docDate\": \"2020-11-09\",\n \"docDueDate\": \"2020-11-09\",\n \"paidValue\": 50,\n \"partnerKey\": \"00000101\",\n \"baseObject\": \"18\",\n \"baseKey\": \"1/100000002\",\n \"baseNum\": \"100000002\",\n \"lineNum\": \"\",\n \"nfeNum\": \"100000002\",\n \"paymentMethod\": \"NOR\",\n \"remarks\": \"Valor pago s/ Titulo\",\n \"details\": {},\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ],\n \"count\": 1\n}"},{"id":"7b538a77-415f-442c-bfed-2d399669d4c2","name":"Outcoming Payments - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/outPayments?paidFrom=2018-01-01&paidTo=2020-12-31","host":["{{endpoint}}"],"path":["outPayments"],"query":[{"key":"paidFrom","value":"2018-01-01","description":"Initial payment date to filter outcoming payments (required if not unitary search)"},{"key":"paidTo","value":"2020-12-31","description":"Final payment date to filter outcoming payments (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional in list search)","disabled":true},{"key":"dueFrom","value":"2018-01-01","description":"Initial due date to filter incoming payments (optional in list search)","disabled":true},{"key":"dueTo","value":"2020-12-31","description":"Final due date to filter incoming payments (optional in list search)","disabled":true},{"key":"partnerKey","value":"C001","description":"Partner Primary Key in ERP (optional in list search)","disabled":true},{"key":"buyerKey","value":"120","description":"Buyer Primary Key in ERP (optional in list search)","disabled":true},{"key":"erpKey","value":"120","description":"Outcoming Payment Primary Key in ERP (optional for unitary search)","disabled":true},{"key":"pageNum","value":"1","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-24T15:34:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"JSESSIONID=2DF2F1C20C7559589FFF40B8AD33B58C; Path=/B1iXcellerator; HttpOnly"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Fri, 16 Oct 2020 17:46:26 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"OutPayments\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"outPayments\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-10-16T14:46:22\",\n \"paidFrom\": \"2018-01-01\",\n \"paidTo\": \"2020-12-31\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 1,\n \"values\": [\n {\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"\",\n \"erpKey\": \"25\",\n \"lineNum\": \"1\",\n \"paymentDate\": \"2018-05-14\",\n \"docDate\": \"2018-05-14\",\n \"docDueDate\": \"2018-05-14\",\n \"paidValue\": 675,\n \"partnerKey\": \"F001\",\n \"baseObject\": \"18\",\n \"baseKey\": \"62\",\n \"baseNum\": \"62\",\n \"nfeNum\": \"60\",\n \"paymentMethod\": \"cash\",\n \"remarks\": \"Outgoing Payments - F001\",\n \"details\": {},\n \"createdAt\": \"2018-05-14T00:00:00\",\n \"updatedAt\": \"2018-05-14T00:00:00\",\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"a788b12a-017e-438b-b7c5-22e8a4785f46"},{"name":"Outcoming Payment*","id":"bbf17d02-80d6-416e-a4fd-c26a957a996b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"baseObject\": \"13\",\r\n\t\"baseKey\": \"168\",\r\n\t\"paymentMethod\": \"creditCard\",\r\n\t\"amount\": 63.89,\r\n\t\"installments\": 1,\r\n\t\"paymentDate\": \"2020-03-31\",\r\n\t\"details\": {\r\n\t\t\"transferAccount\": \"1.1.1.2.2\",\r\n\t\t\"boeAccount\": \"1.1.1.2.2\",\r\n\t\t\"cardName\": \"Visa\",\r\n\t\t\"acquirer\": \"\",\r\n\t\t\"tid\": \"12125\",\r\n\t\t\"authid\": \"12121872612918721\",\r\n\t\t\"nsu\": \"023567\"\r\n\t}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/outPayments","description":"(sapBusinessOne=46/OVPM, totvsProtheus=FK2)
\nThis service will allow to insert a new outcoming payments in the ERP.
\nThe scenario will validate the data received, making selects in the ERP database.
\nA new outcoming payments will be insert if the informed purchase invoice is located and validated on the ERP. The key for locating the purchase invoice on the ERP can be:
\nbaseKey or OVPM.DocNum = baseNum or OVPM.NumAtCard = orderNumbaseKey or R_E_C_N_O_ = baseNum or D1_PEDIDO = orderNumFor the use of user fields (UDF) created in the table of outcoming payments (SAPB1: OVPM, TOTVS: FK2, the respective registration must be performed in the Custom Table.
\n* = Required field
\n(sapBusinessOne=19/ORPC, totvsProtheus=SF2)
\nThis service will allow to search purchase credit notes in the ERP.
\nThe search of purchase credit notes allows filtering the ERP by:
\ncreatedFrom + createdTo {required}, by branch, partnerKey {optional}erpKey or orderNum or docNumIf no field for unitary search (erpKey or orderNum or docNum) is informed in the request, the search for purchase credit notes is carried out by date of creation from/to (which become mandatory).
The invoices service will consider purchase credit notes with:
\nComments:
\nbranch: SAP Business One (ODPO.BPLId), TOTVS Protheus (F2_FILIAL)partnerKey: SAP Business One (ODPO.CardCode), TOTVS Protheus (F2_CLIENTE+'_'+F2_LOJA)erpKey: SAP Business One (ODPO.DocEntry), TOTVS Protheus (F2_NUM)orderNum: SAP Business One (ODPO.NumAtCard), TOTVS Protheus (C5_PEDECOM)docNum: SAP Business One (ODPO.DocNum), TOTVS Protheus (R_E_C_N_O_)docStatus: O = open, C = canceled, B = billed, P = paid, R = returnedData returned in response: purchase credit notes data, partner data, items (+ taxes), totals, payments, taxes
\nThe response will inform:
\ncount fieldFor list search the pagination feature in the response will be used, where the following fields are used to control the pagination:
\npageSize = maximum number of records on each page (eg: 100), defined in the API configuration, and informed in the responsepageNum = desired page, provided in the request, and informed in the response. If pageNum not informed = 1, If pageNum <=0 = 1, If pageNum > pageTotal = last pagepageTotal = total pages, informed in the responsehasNext = if there are more pages (true / false), informed in the responseThis service will allow you to search the purchase credit notes list in two situations:
\nupdatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which exit notes should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields for the Document record in SAP Business One (OINV.CreateDate, OINV.UpdateDate, OINV.CreateTS, OINV.UpdateTS), [2] TOTVS Protheus: the F2_USERLGI and F2_USERLGA fieldsFor the use of user fields (UDF) created in the table of purchase credit notes (SAPB1: ODPO, TOTVS: SF2), the respective registration must be performed in the Custom Table.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}},"urlObject":{"path":["purCreditNotes"],"host":["{{endpoint}}"],"query":[{"description":{"content":"Initial create date to filter purchase credit notes (required if not unitary search)
\n","type":"text/plain"},"key":"createdFrom","value":"2010-08-27"},{"description":{"content":"Final create date to filter purchase credit notes (required if not unitary search)
\n","type":"text/plain"},"key":"createdTo","value":"2020-12-31"},{"description":{"content":"Branch (optional in list search)
\n","type":"text/plain"},"key":"branch","value":"1"},{"description":{"content":"Partner Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"partnerKey","value":"C001"},{"disabled":true,"description":{"content":"Buyer Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"buyerKey","value":"22"},{"description":{"content":"Purchase Credit Note Primary Key in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"erpKey","value":"120"},{"description":{"content":"Purchase Credit NoteDocument Number in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"docNum","value":"49084"},{"description":{"content":"Number of page - pagination (optional)
\n","type":"text/plain"},"key":"pageNum","value":"2"},{"description":{"content":"Date do filter modified registers - incremental search (optional)
\n","type":"text/plain"},"key":"updatedAt","value":"2020-01-24T15:34:00"}],"variable":[]}},"response":[{"id":"93d6cdc6-89fb-45cc-b2b7-bde30a90138a","name":"Purchase Credit Notes - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/purCreditNotes?createdFrom=2010-08-27&createdTo=2020-08-27","host":["{{endpoint}}"],"path":["purCreditNotes"],"query":[{"key":"createdFrom","value":"2010-08-27","description":"Initial create date to filter purchase credit notes (required if not unitary search)"},{"key":"createdTo","value":"2020-08-27","description":"Final create date to filter purchase credit notes (required if not unitary search)"},{"description":"Branch (optional in list search)","key":"branch","value":"1","disabled":true},{"description":"Partner Primary Key in ERP (optional in list search)","key":"partnerKey","value":"C001","disabled":true},{"description":"Buyer Primary Key in ERP (optional in list search)","key":"buyerKey","value":"22","disabled":true},{"description":"Purchase Credit Note Primary Key in ERP (optional - unitary search)","key":"erpKey","value":"120","disabled":true},{"description":"Purchase Credit NoteDocument Number in ERP (optional - unitary search)","key":"docNum","value":"49084","disabled":true},{"description":"Number of page - pagination (optional)","key":"pageNum","value":"2","disabled":true},{"description":"Date do filter modified registers - incremental search (optional)","key":"updatedAt","value":"2020-01-24T15:34:00","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 05 Nov 2020 18:32:05 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"PurCreditNotes\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"purCreditNotes\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-05T16:32:02\",\n \"createdFrom\": \"2010-08-27\",\n \"createdTo\": \"2020-08-27\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 1,\n \"values\": [\n {\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"buyerKey\": \"2\",\n \"erpKey\": \"2\",\n \"docNum\": \"2\",\n \"orderNum\": \"\",\n \"docStatus\": \"C\",\n \"docDate\": \"2017-04-04\",\n \"docDueDate\": \"2017-04-04\",\n \"taxDate\": \"2017-04-04\",\n \"docValue\": 3042.81,\n \"nfeSeries\": \"\",\n \"nfeNum\": \"3\",\n \"nfeType\": \"\",\n \"nfeModel\": \"\",\n \"nfeKey\": \"\",\n \"nfeValue\": 3477.5,\n \"baseObject\": \"18\",\n \"baseKey\": \"56\",\n \"comments\": \"Baseado em Pedidos de compra 3. Baseado em Recebimento de mercadorias 28. Baseado em Notas fiscais de Entrada 56.\",\n \"createdAt\": \"2017-04-04T12:22:38\",\n \"updatedAt\": \"2017-04-04T12:22:39\",\n \"canceledAt\": null,\n \"supplier\": {\n \"type\": \"S\",\n \"taxType\": \"C\",\n \"partnerKey\": \"F003\",\n \"docEntry\": \"3\",\n \"fullName\": \"Oakley\",\n \"aliasName\": \"\",\n \"email\": \"oakley@oakley.com\",\n \"phone\": \"7698-9832\",\n \"phoneSecondary\": \"51\",\n \"cellular\": \"51-9873-3248\",\n \"taxNumber\": \"04.692.027/0002-24\",\n \"stateTaxNumber\": \"206.198.106.117\",\n \"cityTaxNumber\": \"\",\n \"billingAddress\": {\n \"address1\": \"Farroupilha\",\n \"address2\": \"10° andar\",\n \"city\": \"Porto Alegre\",\n \"county\": \"4240\",\n \"postalCode\": \"32498\",\n \"stateCode\": \"RS\",\n \"countryCode\": \"BR\",\n \"community\": \"Jardins\",\n \"exteriorNumber\": \"2312\",\n \"streetType\": \"Av.\"\n },\n \"shippingAddress\": {\n \"address1\": \"das Nações Unidas\",\n \"address2\": \"6° andar\",\n \"city\": \"São Paulo\",\n \"county\": \"5344\",\n \"postalCode\": \"04795-100\",\n \"stateCode\": \"SP\",\n \"countryCode\": \"BR\",\n \"community\": \"Brooklin\",\n \"exteriorNumber\": \"14.171\",\n \"streetType\": \"Av.\"\n }\n },\n \"items\": [\n {\n \"lineNum\": \"0\",\n \"productKey\": \"I016\",\n \"codeBars\": \"\",\n \"productName\": \"Relógio Oakley Minute Machine™\",\n \"quantity\": 1,\n \"unit\": \"Un\",\n \"unitPrice\": 3250,\n \"taxBasis\": 3250,\n \"usage\": \"3\",\n \"cfop\": \"5102\",\n \"discountRate\": 0,\n \"taxValue\": 227.5,\n \"freightValue\": 0,\n \"grossValue\": 4062.5,\n \"unitCost\": 0,\n \"comments\": \"\",\n \"itemTaxes\": [\n {\n \"taxRelate\": \"product\",\n \"taxCode\": \"ICMSBI00\",\n \"taxBasis\": 3477.5,\n \"taxRate\": 18,\n \"taxValue\": 625.95\n },\n {\n \"taxRelate\": \"product\",\n \"taxCode\": \"IPIBI000\",\n \"taxBasis\": 3250,\n \"taxRate\": 7,\n \"taxValue\": 227.5\n }\n ]\n }\n ],\n \"totals\": {\n \"invoiceTotal\": {\n \"netValue\": 3250,\n \"grossValue\": 3042.81,\n \"baseValue\": 3250,\n \"taxValue\": 227.5\n },\n \"merchandizeTotal\": {\n \"netValue\": 3250,\n \"grossValue\": 3477.5,\n \"baseValue\": 3250,\n \"taxValue\": 227.5,\n \"priceAdjustValue\": 0,\n \"priceAdjustType\": \"\",\n \"priceAdjustPromotionId\": \"\",\n \"priceAdjustCouponId\": \"\"\n },\n \"shippingTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n }\n }\n ]\n}"},{"id":"9d78fc40-cd91-4dd7-aee9-59b3e1334ec9","name":"Purchase Credit Notes - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/purCreditNotes?createdFrom=2010-08-27&createdTo=2020-12-31","host":["{{endpoint}}"],"path":["purCreditNotes"],"query":[{"key":"createdFrom","value":"2010-08-27","description":"Initial create date to filter purchase credit notes (required if not unitary search)"},{"key":"createdTo","value":"2020-12-31","description":"Final create date to filter purchase credit notes (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional in list search)","disabled":true},{"key":"partnerKey","value":"C001","description":"Partner Primary Key in ERP (optional in list search)","disabled":true},{"key":"buyerKey","value":"22","description":"Buyer Primary Key in ERP (optional in list search)","disabled":true},{"key":"erpKey","value":"120","description":"Purchase Credit Note Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"49084","description":"Purchase Credit NoteDocument Number in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-24T15:34:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Version","value":"1.1"},{"key":"FWRESTBUILD","value":"1.15.0717"},{"key":"Content-Type","value":"application/json"},{"key":"Status","value":"200 OK"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"PurCreditNotes\",\n \"system\": \"totvsProtheus\",\n \"target\": \"purCreditNotes\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-10T10:34:13\",\n \"createdFrom\": \"2010-08-27\",\n \"createdTo\": \"2020-12-31\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"countTotal\": 1,\n \"values\": [\n {\n \"branch\": \"01\",\n \"branchName\": \"TESTE\",\n \"branchTaxNumber\": \" . . / - \",\n \"erpKey\": \"1/000000002\",\n \"erpId\": \"2\",\n \"orderNum\": \"\",\n \"docNum\": \"000000002\",\n \"docStatus\": \"O\",\n \"docDate\": \"2020-11-10\",\n \"docDueDate\": \"2020-11-10\",\n \"taxDate\": \"2020-11-10\",\n \"docValue\": 120,\n \"nfeSeries\": \"1\",\n \"nfeNum\": \"000000002\",\n \"nfeType\": \"\",\n \"nfeModel\": \"01\",\n \"nfeKey\": \"\",\n \"nfeValue\": 0,\n \"nfeAuthCode\": \"\",\n \"nfeAuthDesc\": \"\",\n \"nfeProtocol\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null,\n \"supplier\": {\n \"type\": \"S\",\n \"taxType\": \"C\",\n \"partnerKey\": \"00000101\",\n \"fullName\": \"PIXEL INFORMATICA EIRELI - ME\",\n \"aliasName\": \"PIXEL INFO\",\n \"email\": \"\",\n \"phone\": \"47 33696269\",\n \"phoneSecundary\": \"\",\n \"cellular\": null,\n \"taxNumber\": \"11061994000172\",\n \"stateTaxNumber\": \"255.920.350\",\n \"cityTaxNumber\": \"\",\n \"contactPerson\": \"\",\n \"billingAddress\": {\n \"address1\": \"RUA JOSE GUERREIRO FILHO 89\",\n \"exteriorNumber\": null,\n \"address2\": \"SALA 01\",\n \"community\": \"CENTRO\",\n \"city\": \"PORTO BELO\",\n \"county\": \"\",\n \"stateCode\": \"SC\",\n \"countryCode\": \"\",\n \"postalCode\": \"\",\n \"streetType\": null\n },\n \"shippingAddress\": {\n \"address1\": \"RUA JOSE GUERREIRO FILHO 89\",\n \"exteriorNumber\": null,\n \"address2\": \"SALA 01\",\n \"community\": \"CENTRO\",\n \"city\": \"PORTO BELO\",\n \"county\": \"\",\n \"stateCode\": \"SC\",\n \"countryCode\": \"\",\n \"postalCode\": \"\",\n \"streetType\": null\n }\n },\n \"items\": [\n {\n \"lineNum\": \"01\",\n \"productKey\": \"MC000003\",\n \"codeBars\": \"\",\n \"productName\": \"CARTUCHO HP 662 PRETO\",\n \"quantity\": 1,\n \"unit\": \"UN\",\n \"unitPrice\": 120,\n \"taxBasis\": 120,\n \"usage\": \"601\",\n \"cfop\": \"6202\",\n \"discountRate\": 0,\n \"taxValue\": 0,\n \"freightValue\": 0,\n \"grossValue\": 120,\n \"unitCost\": 105.6\n }\n ],\n \"totals\": {\n \"invoiceTotal\": {\n \"netValue\": 120,\n \"grossValue\": 120,\n \"baseValue\": 120,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 120,\n \"grossValue\": 120,\n \"baseValue\": 120,\n \"taxValue\": 0,\n \"priceAdjustValue\": 0,\n \"priceAdjustType\": \"\",\n \"priceAdjustPromotionId\": \"\",\n \"priceAdjustCouponId\": \"\"\n },\n \"shippingTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n },\n \"payments\": null,\n \"taxes\": null\n }\n ],\n \"count\": 1\n}"}],"_postman_id":"90cb93c7-1996-4847-8685-cb88f66caca4"}],"id":"1c7ab636-74ec-41b1-b702-3f11a581225c","_postman_id":"1c7ab636-74ec-41b1-b702-3f11a581225c","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}}},{"name":"Purchase Down Payments","item":[{"name":"Purchase Down Payments","id":"e3c0cf2b-2e02-4aed-874f-18d634db4067","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/purDownPayments?createdFrom=2016-09-19&createdTo=2016-09-19&branch=1&partnerKey=C001&buyerKey=22&erpKey=120&docNum=49084&pageNum=2&updatedAt=2020-01-24T15:34:00","description":"(sapBusinessOne=204/ODPO)
\nThis service will allow to search purchase down payments in the ERP.
\nThe search of purchase down payments allows filtering the ERP by:
\ncreatedFrom + createdTo {required}, by branch, partnerKey {optional}erpKey or orderNum or docNumIf no field for unitary search (erpKey or orderNum or docNum) is informed in the request, the search for purchase down payments is carried out by date of creation from/to (which become mandatory).
The purchase down payments service will consider purchase down payments with:
\nComments:
\nbranch: SAP Business One (ORPD.BPLId)partnerKey: SAP Business One (ORPD.CardCode)erpKey: SAP Business One (ORPD.DocEntry)orderNum: SAP Business One (ORPD.NumAtCard)docNum: SAP Business One (ORPD.DocNum)docStatus: O = open, C = canceled, B = billed, P = paid, R = returnedData returned in response: purchase down payments data, partner data, items (+ taxes), totals
\nThe response will inform:
\ncount fieldFor list search the pagination feature in the response will be used, where the following fields are used to control the pagination:
\npageSize = maximum number of records on each page (eg: 100), defined in the API configuration, and informed in the responsepageNum = desired page, provided in the request, and informed in the response. If pageNum not informed = 1, If pageNum <=0 = 1, If pageNum > pageTotal = last pagepageTotal = total pages, informed in the responsehasNext = if there are more pages (true / false), informed in the responseThis service will allow you to search the purchase down payments list in two situations:
\nupdatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which exit notes should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields for the Document record in SAP Business One (ORPD.CreateDate, ORPD.UpdateDate, ORPD.CreateTS, ORPD.UpdateTS)For the use of user fields (UDF) created in the table of purchase down payments (SAPB1: ORPD, TOTVS: SE2), the respective registration must be performed in the Custom Table.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}},"urlObject":{"path":["purDownPayments"],"host":["{{endpoint}}"],"query":[{"description":{"content":"Initial create date to filter purchase down payments (required if not unitary search)
\n","type":"text/plain"},"key":"createdFrom","value":"2016-09-19"},{"description":{"content":"Final create date to filter purchase down payments (required if not unitary search)
\n","type":"text/plain"},"key":"createdTo","value":"2016-09-19"},{"description":{"content":"Branch (optional in list search)
\n","type":"text/plain"},"key":"branch","value":"1"},{"description":{"content":"Partner Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"partnerKey","value":"C001"},{"description":{"content":"Buyer Primary Key in ERP (optional in list search)
\n","type":"text/plain"},"key":"buyerKey","value":"22"},{"description":{"content":"Purchase Down Payment Primary Key in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"erpKey","value":"120"},{"description":{"content":"Purchase Down Payment Document Number in ERP (optional - unitary search)
\n","type":"text/plain"},"key":"docNum","value":"49084"},{"description":{"content":"Number of page - pagination (optional)
\n","type":"text/plain"},"key":"pageNum","value":"2"},{"description":{"content":"Date do filter modified registers - incremental search (optional)
\n","type":"text/plain"},"key":"updatedAt","value":"2020-01-24T15:34:00"}],"variable":[]}},"response":[{"id":"40a3fe01-c6ea-43cf-ba0f-8dacf295bd3f","name":"Purchase Down Payments - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/purDownPayments?createdFrom=2016-09-19&createdTo=2016-09-19","host":["{{endpoint}}"],"path":["purDownPayments"],"query":[{"key":"createdFrom","value":"2016-09-19","description":"Initial create date to filter purchase down payments (required if not unitary search)"},{"key":"createdTo","value":"2016-09-19","description":"Final create date to filter purchase down payments (required if not unitary search)"},{"description":"Branch (optional in list search)","key":"branch","value":"1","disabled":true},{"description":"Partner Primary Key in ERP (optional in list search)","key":"partnerKey","value":"C001","disabled":true},{"description":"Buyer Primary Key in ERP (optional in list search)","key":"buyerKey","value":"22","disabled":true},{"description":"Purchase Down Payment Primary Key in ERP (optional - unitary search)","key":"erpKey","value":"120","disabled":true},{"description":"Purchase Down Payment Document Number in ERP (optional - unitary search)","key":"docNum","value":"49084","disabled":true},{"description":"Number of page - pagination (optional)","key":"pageNum","value":"2","disabled":true},{"description":"Date do filter modified registers - incremental search (optional)","key":"updatedAt","value":"2020-01-24T15:34:00","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Content-Encoding","value":"gzip"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Thu, 05 Nov 2020 18:33:40 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"supplyAPI\",\n \"process\": \"PurDownPayments\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"purDownPayments\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-05T16:33:37\",\n \"createdFrom\": \"2016-09-19\",\n \"createdTo\": \"2016-09-19\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 1,\n \"values\": [\n {\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"buyerKey\": \"2\",\n \"erpKey\": \"10\",\n \"docNum\": \"10\",\n \"orderNum\": \"\",\n \"docStatus\": \"P\",\n \"docDate\": \"2016-09-19\",\n \"docDueDate\": \"2016-09-19\",\n \"taxDate\": \"2016-09-19\",\n \"docValue\": 100,\n \"nfeSeries\": \"\",\n \"nfeNum\": \"\",\n \"nfeType\": \"\",\n \"nfeModel\": \"\",\n \"nfeKey\": \"\",\n \"nfeValue\": 0,\n \"baseObject\": \"17\",\n \"baseKey\": \"95\",\n \"comments\": \"\",\n \"createdAt\": \"2016-09-19T16:00:58\",\n \"updatedAt\": \"2016-09-19T16:00:58\",\n \"canceledAt\": null,\n \"supplier\": {\n \"type\": \"S\",\n \"taxType\": \"C\",\n \"partnerKey\": \"F001\",\n \"docEntry\": \"1\",\n \"fullName\": \"Adidas\",\n \"aliasName\": \"\",\n \"email\": \"contato@adidas.com.br\",\n \"phone\": \"5501-3409\",\n \"phoneSecondary\": \"11\",\n \"cellular\": \"11-9834-3249\",\n \"taxNumber\": \"42.274.696/0001-94\",\n \"stateTaxNumber\": \"206.274.902.114\",\n \"cityTaxNumber\": \"\",\n \"billingAddress\": {\n \"address1\": \"Rio Negro\",\n \"address2\": \"5° andar\",\n \"city\": \"São Paulo\",\n \"county\": \"5344\",\n \"postalCode\": \"23129-908\",\n \"stateCode\": \"SP\",\n \"countryCode\": \"BR\",\n \"community\": \"Itaim\",\n \"exteriorNumber\": \"123\",\n \"streetType\": \"Av.\"\n },\n \"shippingAddress\": {\n \"address1\": \"das Nações Unidas\",\n \"address2\": \"6° andar\",\n \"city\": \"São Paulo\",\n \"county\": \"5344\",\n \"postalCode\": \"04795-100\",\n \"stateCode\": \"SP\",\n \"countryCode\": \"BR\",\n \"community\": \"Brooklin\",\n \"exteriorNumber\": \"14.171\",\n \"streetType\": \"Av.\"\n }\n },\n \"items\": [\n {\n \"lineNum\": \"0\",\n \"productKey\": \"I002\",\n \"codeBars\": \"\",\n \"productName\": \"Bola Nike Cup Strike UEFA\",\n \"quantity\": 1,\n \"unit\": \"Un\",\n \"unitPrice\": 100,\n \"taxBasis\": 100,\n \"usage\": \"10\",\n \"cfop\": \"1101\",\n \"discountRate\": 0,\n \"taxValue\": 0,\n \"freightValue\": 0,\n \"grossValue\": 100,\n \"unitCost\": 0,\n \"comments\": \"\",\n \"itemTaxes\": [\n {\n \"taxRelate\": \"product\",\n \"taxCode\": \"COFINS\",\n \"taxBasis\": 100,\n \"taxRate\": 3,\n \"taxValue\": 0\n },\n {\n \"taxRelate\": \"product\",\n \"taxCode\": \"ICMSBx00\",\n \"taxBasis\": 100,\n \"taxRate\": 18,\n \"taxValue\": 0\n },\n {\n \"taxRelate\": \"product\",\n \"taxCode\": \"IPIBI000\",\n \"taxBasis\": 100,\n \"taxRate\": 7,\n \"taxValue\": 0\n },\n {\n \"taxRelate\": \"product\",\n \"taxCode\": \"PIS\",\n \"taxBasis\": 100,\n \"taxRate\": 0.65,\n \"taxValue\": 0\n }\n ]\n }\n ],\n \"totals\": {\n \"invoiceTotal\": {\n \"netValue\": 100,\n \"grossValue\": 100,\n \"baseValue\": 100,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 100,\n \"grossValue\": 100,\n \"baseValue\": 100,\n \"taxValue\": 0,\n \"priceAdjustValue\": 0,\n \"priceAdjustType\": \"\",\n \"priceAdjustPromotionId\": \"\",\n \"priceAdjustCouponId\": \"\"\n },\n \"shippingTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n }\n }\n ]\n}"}],"_postman_id":"e3c0cf2b-2e02-4aed-874f-18d634db4067"}],"id":"c7d19d49-4aca-4ebc-bdfd-1d937a35c2e3","_postman_id":"c7d19d49-4aca-4ebc-bdfd-1d937a35c2e3","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"4c83bf58-1218-42d8-aa44-7924700e9149","id":"4c83bf58-1218-42d8-aa44-7924700e9149","name":"supplyAPI - Supply Chain API for ERP (v2)","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]}},"event":[{"listen":"prerequest","script":{"id":"c0a7dbcb-428d-4b8b-8891-b1135a335903","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4557efe4-0eac-4677-ad67-9c16c38e541d","type":"text/javascript","exec":[""]}}]}