{"info":{"_postman_id":"11834bc6-bff3-4272-b68a-24430df885aa","name":"salesAPI - Sales API for ERP (v2)","description":"

This document contains the necessary data and requirements for integration with the salesAPI conector, a passive API to connect Sales systems (E-commerce B2C, B2B, CRM, POS and WMS systems) with ERP systems, as SAP Business One or TOTVS Protheus.

__salesAPI conector currently has the following HTTP REST Plain services - version 2 (v2.3):

branches: search branches in ERP
warehouses: search warehouses in ERP
binLocations: search bin locations in ERP
usages: search usages in ERP
carriers: search carriers in ERP
itemGroups: search product groups in ERP
products: search products (with or without Partnumber) and prices in ERP
stocks: search inventory in ERP
pricelists: search pricelists in ERP
prices: search prices in ERP
partners: search and insert business partners in ERP
contacts: search and insert partner contacts in ERP
saleContracts: search sale contracts in ERP
quotations: search and insert sale quotations in ERP
orders: search and insert sale orders in ERP
orderStatus: seach for changes in the status of sale orders in ERP (only SAP Business One)
picklists: insert sale picklists in ERP
invoices: search and insert sale invoices in ERP
deliveries: search and insert sale deliveries in ERP (only SAP Business One)
creditNotes: search sale credit notes in ERP
downPayments: search sale down payments in ERP (only SAP Business One)
receivables: search receivables in ERP
incPayments: search incoming payments in ERP

Content Type: all salesAPI services use the “content-type” application/json for Parameters (body request) and Responses.

Authentication: salesAPI uses Basic Authentication (user/password)

Characteristics: 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":"11834bc6-bff3-4272-b68a-24430df885aa","publishedId":"SWE3dfdQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-09-19T17:08:46.000Z"},"item":[{"name":"Attachments","item":[{"name":"Attachments","id":"75aaac2b-41cb-4c9e-9378-43efbcb5def2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/attachments?erpKey=30180&linkedObject=23&linkedErpKey=22&pageNum&updatedAt=NOT IMPLEMENTED","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"11834bc6-bff3-4272-b68a-24430df885aa","id":"11834bc6-bff3-4272-b68a-24430df885aa","name":"salesAPI - Sales API for ERP (v2)","type":"collection"}},"urlObject":{"path":["attachments"],"host":["{{endpoint}}"],"query":[{"key":"erpKey","value":"30180"},{"key":"linkedObject","value":"23"},{"key":"linkedErpKey","value":"22"},{"key":"pageNum","value":null},{"key":"updatedAt","value":"NOT IMPLEMENTED"}],"variable":[]}},"response":[],"_postman_id":"75aaac2b-41cb-4c9e-9378-43efbcb5def2"},{"name":"Attachments","id":"c5a348b9-ae06-4ae2-8813-81806141993f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"erpKey\": \"21813\",\r\n \"linkedObject\": \"2\",\r\n \"linkedErpKey\": \"C002082\",\r\n \"lines\": [\r\n {\r\n \"fileSource\": \"\\\\\\\\129.151.36.143\\\\GPImportsChatBot\\\\\",\r\n \"fileName\": \"logo_vale.gif\"\r\n },\r\n {\r\n \"fileSource\": \"\\\\\\\\129.151.36.143\\\\GPImportsChatBot\\\\\",\r\n \"fileName\": \"DrayTek-logo.png\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/attachments","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"11834bc6-bff3-4272-b68a-24430df885aa","id":"11834bc6-bff3-4272-b68a-24430df885aa","name":"salesAPI - Sales API for ERP (v2)","type":"collection"}},"urlObject":{"path":["attachments"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c5a348b9-ae06-4ae2-8813-81806141993f"},{"name":"Attachments","id":"ad4214c2-364f-4ef4-8755-7321ecb2b005","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"erpKey\": \"\",\r\n \"_linkedObject\": \"\",\r\n \"_linkedErpKey\": \"\",\r\n \"lines\": [\r\n {\r\n \"lineNum\": \"\",\r\n \"fileSource\": \"\",\r\n \"_sourcePath\": \"\",\r\n \"_subPath\": \"\",\r\n \"_targetPath\": \"\",\r\n \"_fileName\": \"\",\r\n \"_fileExtension\": \"\",\r\n \"_fileDate\": \"\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/attachments","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"11834bc6-bff3-4272-b68a-24430df885aa","id":"11834bc6-bff3-4272-b68a-24430df885aa","name":"salesAPI - Sales API for ERP (v2)","type":"collection"}},"urlObject":{"path":["attachments"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad4214c2-364f-4ef4-8755-7321ecb2b005"},{"name":"Attachments","id":"e3610ce2-18c2-49ea-9ff6-dfada5ff34ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"erpKey\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/attachments?erpKey=22937","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"11834bc6-bff3-4272-b68a-24430df885aa","id":"11834bc6-bff3-4272-b68a-24430df885aa","name":"salesAPI - Sales API for ERP (v2)","type":"collection"}},"urlObject":{"path":["attachments"],"host":["{{endpoint}}"],"query":[{"key":"erpKey","value":"22937"}],"variable":[]}},"response":[],"_postman_id":"e3610ce2-18c2-49ea-9ff6-dfada5ff34ad"}],"id":"335060ba-a001-4ded-ade2-1feed01bdb6e","_postman_id":"335060ba-a001-4ded-ade2-1feed01bdb6e","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"11834bc6-bff3-4272-b68a-24430df885aa","id":"11834bc6-bff3-4272-b68a-24430df885aa","name":"salesAPI - Sales API for ERP (v2)","type":"collection"}}},{"name":"Base Objects","item":[{"name":"Branches","id":"87cde781-8729-42aa-b1b5-52a58d30a884","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/branches?erpKey=1","description":"

Search branches in ERP

(sapBusinessOne=247/OBPL, totvsProtheus=SM0)

ATENTION: for TOTVS Protheus use /igt_branches (conflict with TOTVS standard API)

The search of branches allows you to filter the ERP by:

List Search
Unitary Search: by erpKey

If no field for unitary query (erpKey) is informed in the request, the search returns as a list.

The branches service will consider as valid branch:

SAP Business One: [1] Enabled: OBPL.Disabled=N
TOTVS Protheus: [1]

The response will inform:

The number of returned objects in the count field

This service does not have pagination or incremental treatment.

This service does not have user field (UDF) treatment.

Branch Primary Key in ERP (optional)

\n","type":"text/plain"},"key":"erpKey","value":"1"}],"variable":[]}},"response":[{"id":"e35fc434-63d5-4492-9c63-9b2ee36a7374","name":"Branches - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/branches","host":["{{endpoint}}"],"path":["branches"],"query":[{"key":"erpKey","value":"1","description":"Branch Primary Key in ERP (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, 28 May 2020 23:28:50 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"Branches\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"branches\",\n \"user\": \"intergate\",\n \"host\": \"192.168.210.1\",\n \"effectiveTimestamp\": \"2020-05-28T20:28:45\",\n \"code\": \"200\",\n \"success\": true,\n \"count\": 3,\n \"values\": [\n {\n \"erpKey\": \"1\",\n \"name\": \"MATRIZ\",\n \"mainBranch\": true,\n \"defaultWhsCode\": \"01\",\n \"taxNumber\": \"98.899.922/0001-87\",\n \"stateTaxNumber\": \"116.141.588.110\",\n \"cityTaxNumber\": \"\",\n \"address\": {\n \"streetType\": \"Av.\",\n \"address1\": \"das Nações Unidas\",\n \"exteriorNumber\": \"14.171\",\n \"address2\": \"6° andar\",\n \"community\": \"Brooklin\",\n \"city\": \"São Paulo\",\n \"county\": \"5344\",\n \"stateCode\": \"\",\n \"countryCode\": \"BR\",\n \"postalCode\": \"04795-100\"\n },\n \"createdAt\": null,\n \"updatedAt\": \"2017-01-10T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"3\",\n \"fullName\": \"FILIAL SP\",\n \"mainBranch\": false,\n \"defaultWhsCode\": \"SP\",\n \"taxNumber\": \"98.899.922/0001-87\",\n \"stateTaxNumber\": \"\",\n \"cityTaxNumber\": \"\",\n \"address\": {\n \"streetType\": \"\",\n \"address1\": \"\",\n \"exteriorNumber\": \"\",\n \"address2\": \"\",\n \"community\": \"\",\n \"city\": \"\",\n \"county\": \"5344\",\n \"stateCode\": \"\",\n \"countryCode\": \"BR\",\n \"postalCode\": \"\"\n },\n \"createdAt\": null,\n \"updatedAt\": \"2017-01-10T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"4\",\n \"fullName\": \"FILIAL RJ\",\n \"mainBranch\": false,\n \"defaultWhsCode\": \"RJ\",\n \"taxNumber\": \"98.899.922/0001-87\",\n \"stateTaxNumber\": \"\",\n \"cityTaxNumber\": \"\",\n \"address\": {\n \"streetType\": \"\",\n \"address1\": \"\",\n \"exteriorNumber\": \"\",\n \"address2\": \"\",\n \"community\": \"\",\n \"city\": \"\",\n \"county\": \"5344\",\n \"stateCode\": \"\",\n \"countryCode\": \"BR\",\n \"postalCode\": \"\"\n },\n \"createdAt\": null,\n \"updatedAt\": \"2017-01-10T00:00:00\",\n \"canceledAt\": null\n }\n ]\n}"},{"id":"db13fd2a-de59-4c90-9065-537dab27cf33","name":"Branches - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/igt_branches","host":["{{endpoint}}"],"path":["igt_branches"],"query":[{"key":"erpKey","value":"1","description":"Branch 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\": \"salesAPI\",\n \"process\": \"Branches\",\n \"system\": \"totvsProtheus\",\n \"target\": \"branches\",\n \"user\": \"intergate\",\n \"host\": \"192.168.30.4\",\n \"effectiveTimestamp\": \"2021-09-03T17:05:57\",\n \"code\": \"200\",\n \"success\": true,\n \"values\": [\n {\n \"erpKey\": \"01\",\n \"erpId\": \"1\",\n \"name\": \"TESTE\",\n \"mainBranch\": \"true\",\n \"defaultWhsCode\": \"01\",\n \"taxNumber\": \"\",\n \"stateTaxNumber\": \"\",\n \"cityTaxNumber\": \"\",\n \"address\": {\n \"streetType\": null,\n \"address1\": \"\",\n \"exteriorNumber\": null,\n \"address2\": \"\",\n \"community\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"stateCode\": \"\",\n \"countryCode\": \"BR\",\n \"postalCode\": \"\"\n },\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"02\",\n \"erpId\": \"2\",\n \"name\": \"FILIAL BNU\",\n \"mainBranch\": \"false\",\n \"defaultWhsCode\": \"01\",\n \"taxNumber\": \"\",\n \"stateTaxNumber\": \"\",\n \"cityTaxNumber\": \"\",\n \"address\": {\n \"streetType\": null,\n \"address1\": \"\",\n \"exteriorNumber\": null,\n \"address2\": \"\",\n \"community\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"stateCode\": \"\",\n \"countryCode\": \"BR\",\n \"postalCode\": \"\"\n },\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ],\n \"count\": 2\n}"}],"_postman_id":"87cde781-8729-42aa-b1b5-52a58d30a884"},{"name":"Warehouses","id":"f0933670-4e8c-4fbc-bb02-5c273c4c5be7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/warehouses?branch=1&erpKey=01","description":"

Search warehouses in ERP

(sapBusinessOne=64/OWHS, totvsProtheus=NNR)

The search of warehouses allows you to filter the ERP by:

List Search: by branch
Unitary Search: by erpKey

If no field for unitary query (erpKey) is informed in the request, the search is performed as a list.

The warehouses service will consider as valid warehouse:

SAP Business One: [1] Not blocked: OWHS.Locked NOT Y
TOTVS Protheus:

The response will inform:

The number of returned objects in the count field

This service does not have pagination or incremental treatment.

This service does not have user field (UDF) treatment.

Branch Primary Key in ERP (optional for list search)

\n","type":"text/plain"},"key":"branch","value":"1"},{"description":{"content":"

Wharehouse Primary Key in ERP (optional for unitary search)

\n","type":"text/plain"},"key":"erpKey","value":"01"}],"variable":[]}},"response":[{"id":"f3d683d7-d1d0-412b-aa83-1a7e2e3f9aa3","name":"Warehouses - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/warehouses","host":["{{endpoint}}"],"path":["warehouses"],"query":[{"key":"erpKey","value":"12","description":"SalesAgent Primary Key in ERP (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":"Sat, 30 May 2020 13:55:32 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"Warehouses\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"warehouses\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.104\",\n \"effectiveTimestamp\": \"2020-05-30T10:55:21\",\n \"code\": \"200\",\n \"success\": true,\n \"count\": 8,\n \"values\": [\n {\n \"erpKey\": \"01\",\n \"name\": \"Depósito geral\",\n \"branch\": \"1\",\n \"dropShip\": false,\n \"createdAt\": null,\n \"updatedAt\": \"2014-10-24T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"02\",\n \"name\": \"Terceiros em meu poder\",\n \"branchKey\": \"1\",\n \"dropShip\": false,\n \"createdAt\": \"2009-06-24T00:00:00\",\n \"updatedAt\": \"2009-06-24T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"03\",\n \"name\": \"Em poder de terceiros\",\n \"branchKey\": \"1\",\n \"dropShip\": true,\n \"createdAt\": \"2009-06-24T00:00:00\",\n \"updatedAt\": \"2009-06-24T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"05\",\n \"name\": \"Depósito 05\",\n \"branchKey\": \"1\",\n \"dropShip\": false,\n \"createdAt\": \"2017-05-10T00:00:00\",\n \"updatedAt\": \"2017-06-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"08\",\n \"name\": \"Expedicao Direta\",\n \"branchKey\": \"1\",\n \"dropShip\": true,\n \"createdAt\": \"2017-05-10T00:00:00\",\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"NO\",\n \"name\": \"Regiao Norte\",\n \"branchKey\": \"1\",\n \"dropShip\": false,\n \"createdAt\": \"2017-05-10T00:00:00\",\n \"updatedAt\": \"2017-05-10T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"RJ\",\n \"name\": \"Filial RJ\",\n \"branchKey\": \"4\",\n \"dropShip\": false,\n \"createdAt\": \"2014-02-05T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"SP\",\n \"name\": \"Filial SP\",\n \"branchKey\": \"3\",\n \"dropShip\": false,\n \"createdAt\": \"2014-02-05T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n }\n ]\n}"},{"id":"75a3210c-a146-46b4-a154-9610e2013b23","name":"Warehouses - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/warehouses","host":["{{endpoint}}"],"path":["warehouses"],"query":[{"key":"branch","value":"1","description":"Branch Primary Key in ERP (optional for list search)","disabled":true},{"key":"erpKey","value":"01","description":"Wharehouse Primary Key in ERP (optional for unitary search)","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\": \"salesAPI\",\n \"process\": \"Warehouses\",\n \"system\": \"totvsProtheus\",\n \"target\": \"warehouses\",\n \"user\": \"intergate\",\n \"host\": \"192.168.30.4\",\n \"effectiveTimestamp\": \"2021-09-03T17:06:37\",\n \"code\": \"200\",\n \"success\": true,\n \"count\": 1,\n \"useCustom\": true,\n \"values\": [\n {\n \"erpKey\": \"01\",\n \"erpId\": \"1\",\n \"name\": \"DEPOSITO GERAL\",\n \"branch\": \"01\",\n \"dropShip\": false,\n \"customExternalId\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"f0933670-4e8c-4fbc-bb02-5c273c4c5be7"},{"name":"Bin Locations","id":"ee238e84-a0cd-4bc4-9087-465afb8b54ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/binLocations?erpKey=1","description":"

Search bin locations in ERP

(sapBusinessOne=10000206/OBIN, totvsProtheus=SBE)

The search of bin locations allows you to filter the ERP by:

List Search
Unitary Search: by erpKey

If no field for unitary query (erpKey) is informed in the request, the search returns as a list.

The bin locations service will consider as valid bin location:

SAP Business One: [1]
TOTVS Protheus: [1]

The response will inform:

The number of returned objects in the count field

This service does not have pagination or incremental treatment.

This service does not have user field (UDF) treatment.

Bin Location Primary Key in ERP (optional)

\n","type":"text/plain"},"key":"erpKey","value":"1"}],"variable":[]}},"response":[{"id":"2a2a44e0-8ab6-454e-9460-466f2f934d98","name":"Bin Locations - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/binLocations","host":["{{endpoint}}"],"path":["binLocations"],"query":[{"key":"erpKey","value":"1","description":"Bin Location 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\": \"salesAPI\",\n \"process\": \"BinLocations\",\n \"system\": \"totvsProtheus\",\n \"target\": \"binLocations\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-09T15:50:12\",\n \"code\": \"200\",\n \"success\": true,\n \"count\": 1,\n \"values\": [\n {\n \"erpKey\": \"01-01-01-01\",\n \"erpId\": \"1\",\n \"binLocation\": \"01-01-01-01\",\n \"isDisabled\": false,\n \"whsCode\": \"01\",\n \"minLevel\": 0,\n \"maxLevel\": 10,\n \"maxWeight\": 0,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"},{"id":"a8ee0543-d990-43c7-8fe4-a42fecf262fb","name":"Bin Locations - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/binLocations","host":["{{endpoint}}"],"path":["binLocations"],"query":[{"key":"erpKey","value":"1","description":"Bin Location Primary Key in ERP (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, 05 Nov 2020 19:25:36 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"BinLocations\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"binLocations\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-05T17:25:29\",\n \"code\": \"200\",\n \"success\": true,\n \"count\": 1,\n \"values\": [\n {\n \"erpKey\": \"2\",\n \"binLocation\": \"01-Z001-A001-C001-P001\",\n \"isDisabled\": false,\n \"whsCode\": \"01\",\n \"minLevel\": 0,\n \"maxLevel\": 0,\n \"maxWeight\": 50,\n \"createdAt\": null,\n \"updatedAt\": \"2014-10-12T00:00:00\",\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"ee238e84-a0cd-4bc4-9087-465afb8b54ce"},{"name":"Usages","id":"36d1187e-a5dc-4de2-a89e-a10e75c6e843","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/usages?erpKey=9","description":"

Search usages in ERP

(sapBusinessOne=260/OUSG, totvsProtheus=SF4)

The search of usages allows you to filter the ERP by:

List Search
Unitary Search: by erpKey

If no field for unitary query (erpKey) is informed in the request, the search returns as a list.

The usages service will consider as valid usage:

SAP Business One: [1]
TOTVS Protheus: [1]

The response will inform:

The number of returned objects in the count field

This service does not have pagination or incremental treatment.

This service does not have user field (UDF) treatment.

Usage Primary Key in ERP (optional)

\n","type":"text/plain"},"key":"erpKey","value":"9"}],"variable":[]}},"response":[{"id":"ab4b45fd-bbb3-41fd-befd-8e440cabbf37","name":"Usages - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/usages","host":["{{endpoint}}"],"path":["usages"],"query":[{"key":"erpKey","value":"1","description":"Branch 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=AA6D033044F2A81D3B633A0E245A9875; 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":"Wed, 04 Nov 2020 19:35:52 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"Usages\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"usages\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-04T17:35:47\",\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 \"erpKey\": \"1\",\n \"fullName\": \"Industrialização\",\n \"isLocked\": false,\n \"freeCharge\": false,\n \"thirdParty\": false,\n \"taxOnly\": false,\n \"taxInStock\": true,\n \"cfopInc\": \"\",\n \"cfopOut\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"},{"id":"f6b16f25-ac3a-4f4f-a410-d3c089edb92e","name":"Usages - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/usages","host":["{{endpoint}}"],"path":["usages"],"query":[{"key":"erpKey","value":"9","description":"Usage 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\": \"salesAPI\",\n \"process\": \"Usages\",\n \"system\": \"totvsProtheus\",\n \"target\": \"usages\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-09T15:01:46\",\n \"code\": \"200\",\n \"success\": true,\n \"count\": 2,\n \"values\": [\n {\n \"erpKey\": \"001\",\n \"erpId\": \"1\",\n \"fullName\": \"COMPRA\",\n \"branch\": \"01\",\n \"type\": \"I\",\n \"isLocked\": false,\n \"freeCharge\": false,\n \"thirdParty\": false,\n \"taxOnly\": false,\n \"taxInStock\": true,\n \"cfopInc\": \"1101\",\n \"cfopOut\": \"5101\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"501\",\n \"erpId\": \"2\",\n \"fullName\": \"VENDA\",\n \"branch\": \"01\",\n \"type\": \"O\",\n \"isLocked\": false,\n \"freeCharge\": false,\n \"thirdParty\": false,\n \"taxOnly\": false,\n \"taxInStock\": true,\n \"cfopInc\": \"1101\",\n \"cfopOut\": \"5101\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"36d1187e-a5dc-4de2-a89e-a10e75c6e843"},{"name":"Carriers","id":"93a150ae-e856-4fe8-b0e7-24ef0d9eb8cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/carriers?taxType=C&erpKey=ASV1000&taxNumber=59.546.515/0001-34&pageNum=2","description":"

Search carriers in ERP

#(sapBusinessOne=2/OCRD, totvsProtheus=SA4)

The search of carriers allows you to filter the ERP by:

List Search: by taxType (C = company, P = person) {optional}
Unitary Search: by erpKey or taxNumber (with or without punctuation)

If no fields for unitary search (erpKey or taxNumber) are informed in the request, the search returns as a list (it's possible to filter by taxType).

The carriers service will consider as valid objects:

SAP Business One: Valid and not canceled (OCRD.validFor = Y AND OCRD.Canceled = N) + OCRD.GroupCode=GP CarrierGroup (if definied)
TOTVS Protheus:

Comments:

taxType: SAP Business One (according to CRD7.TaxId0 or CRD7.TaxId4), TOTVS Protheus (A1_PESSOA + A1_TPESSOA = 'EP')
erpKey: SAP Business One (OCRD.CardCode), TOTVS Protheus (A4_COD)
taxNumber: SAP Business One (CRD7.TaxId0 or CRD7.TaxId4), TOTVS Protheus (A4_CGC)

The response will inform:

The number of returned objects in the “count” field

For carriers list the pagination feature in the response will be used, where the following fields are used to control the pagination:

“pageSize” = 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, reported in the response
“hasNext” = if there are more pages (true / false), informed in the response

This service does not have incremental treatment.

This service does not have user field treatment (UDF).

Carrier Tax Type: P=person, C=company, G=government, E=employer (optional in list search)

\n","type":"text/plain"},"key":"taxType","value":"C"},{"description":{"content":"

Carrier Primary Key in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"erpKey","value":"ASV1000"},{"description":{"content":"

Carrier Tax Number (optional - unitary search)

\n","type":"text/plain"},"key":"taxNumber","value":"59.546.515/0001-34"},{"description":{"content":"

Number of page - pagination (optional)

\n","type":"text/plain"},"key":"pageNum","value":"2"}],"variable":[]}},"response":[{"id":"fa61d14a-dc55-405a-8817-faa556d74a08","name":"Carriers - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/carriers","host":["{{endpoint}}"],"path":["carriers"],"query":[{"key":"taxType","value":"P","description":"Carrier Tax Type: P=person, C=company, G=government, E=employer (optional in list search)","disabled":true},{"key":"erpKey","value":"C001","description":"Carrier Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"taxNumber","value":"89175174987","description":"Carrier Tax Number (optional - unitary search)","disabled":true},{"key":"pageNum","value":"1","description":"Number of page - pagination (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":"Sat, 30 May 2020 18:14:23 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"Carriers\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"carriers\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.104\",\n \"effectiveTimestamp\": \"2020-05-30T15:13:51\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 10,\n \"pageNum\": 1,\n \"pageTotal\": 2,\n \"hasNext\": true,\n \"useCustom\": true,\n \"count\": 1,\n \"values\": [\n {\n \"erpKey\": \"ASV1000\",\n \"taxType\": \"C\",\n \"fullName\": \"Grupo Alves de Medeiros\",\n \"aliasName\": \"\",\n \"email\": \"\",\n \"phone\": \"\",\n \"phoneSecondary\": \"\",\n \"cellular\": \"\",\n \"taxNumber\": \"\",\n \"stateTaxNumber\": \"\",\n \"cityTaxNumber\": \"\",\n \"contactPerson\": \"Paulo Souza\",\n \"createdAt\": \"2016-05-10T00:00:00\",\n \"updatedAt\": \"2016-05-10T00:00:00\",\n \"canceledAt\": null,\n \"address\": {\n \"streetType\": \"\",\n \"address1\": \"\",\n \"exteriorNumber\": \"\",\n \"address2\": \"\",\n \"community\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"stateCode\": \"\",\n \"countryCode\": \"BR\",\n \"postalCode\": \"\"\n }\n }\n ]\n}"},{"id":"20b3fd8b-0e05-496f-8dc8-2eb9feab2c5e","name":"Carriers - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/carriers","host":["{{endpoint}}"],"path":["carriers"],"query":[{"key":"taxType","value":"C","description":"Carrier Tax Type: P=person, C=company, G=government, E=employer (optional in list search)","disabled":true},{"key":"erpKey","value":"ASV1000","description":"Carrier Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"taxNumber","value":"59.546.515/0001-34","description":"Carrier Tax Number (optional - unitary search)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (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\": \"salesAPI\",\n \"process\": \"Carriers\",\n \"system\": \"totvsProtheus\",\n \"target\": \"carriers\",\n \"user\": \"intergate\",\n \"host\": \"192.168.30.4\",\n \"effectiveTimestamp\": \"2021-09-03T17:07:18\",\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 \"erpKey\": \"000001\",\n \"erpId\": \"1\",\n \"taxType\": \"C\",\n \"fullName\": \"MANDAE\",\n \"aliasName\": \"MANDAE\",\n \"email\": \"\",\n \"phone\": \"\",\n \"phoneSecundary\": \"\",\n \"cellular\": null,\n \"taxNumber\": \"\",\n \"stateTaxNumber\": \"\",\n \"cityTaxNumber\": null,\n \"contactPerson\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null,\n \"address\": {\n \"streetType\": null,\n \"address1\": \"\",\n \"exteriorNumber\": null,\n \"address2\": null,\n \"community\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"stateCode\": \"\",\n \"countryCode\": \"BR\",\n \"postalCode\": \"\"\n }\n }\n ],\n \"count\": 1\n}"}],"_postman_id":"93a150ae-e856-4fe8-b0e7-24ef0d9eb8cc"},{"name":"Cost Centres","id":"b98369b3-b5dd-4fd0-8daf-e2208326aa0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/costCentres?erpKey=1&pageNum","description":"

Search Cost Centres in ERP

(sapBusinessOne=61/OPRC, totvsProtheus=CTT)

The search Cost Centres allows you to filter the ERP by:

List Search
Unitary Search: by erpKey

If no field for unitary query (erpKey) is informed in the request, the search returns as a list.

The Cost Centres service will consider as valid cost center:

SAP Business One: [1] OPRC.Active=Y
TOTVS Protheus: [1]

Comments:

type:SAP Business One (OCCT.CctCode), TOTVS Protheus (R=revenue, E=expense)
dimension: SAP Business One (ODIM.DimCode), TOTVS Protheus (1)

The response will inform:

The number of returned objects in the count field

For list search the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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 does not have incremental treatment.

This service does not have user field (UDF) treatment.

Cost Centre Primary Key in ERP (optional)

\n","type":"text/plain"},"key":"erpKey","value":"1"},{"description":{"content":"

Number of page - pagination (optional)

\n","type":"text/plain"},"key":"pageNum","value":null}],"variable":[]}},"response":[{"id":"84533332-fad3-4d01-b184-1fa223721af3","name":"Cost Centres - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/costCentres","host":["{{endpoint}}"],"path":["costCentres"],"query":[{"key":"erpKey","value":"1","description":"Cost Center Primary Key in ERP (optional)","disabled":true},{"key":"pageNum","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"JSESSIONID=3B395AEA3A9CDBB4D59E4EA4F2142432; 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":"Tue, 13 Oct 2020 18:39:32 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"CostCentres\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"costCentres\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-10-13T15:39:29\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 500,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 1,\n \"values\": [\n {\n \"erpKey\": \"0100\",\n \"fullName\": \"RDD\",\n \"type\": \"\",\n \"dimension\": \"2\",\n \"isLocked\": false,\n \"createdAt\": \"2014-11-05T00:00:00\",\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"},{"id":"9155e818-d142-4d85-9e51-12e8c087ead4","name":"Cost Centres - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/costCentres","host":["{{endpoint}}"],"path":["costCentres"],"query":[{"key":"erpKey","value":"1","description":"Cost Centre Primary Key in ERP (optional)","disabled":true},{"key":"pageNum","value":null,"description":"Number of page - pagination (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\": \"salesAPI\",\n \"process\": \"CostCentres\",\n \"system\": \"totvsProtheus\",\n \"target\": \"costCentres\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-12T15:24:17\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"values\": [\n {\n \"erpKey\": \"000000001\",\n \"fullName\": \"ADM\",\n \"isTitle\": false,\n \"type\": \"E\",\n \"dimension\": \"1\",\n \"isLocked\": false,\n \"createdAt\": null,\n \"updatedAt\": \"2020-11-12\",\n \"canceledAt\": null\n }\n ],\n \"count\": 1\n}"}],"_postman_id":"b98369b3-b5dd-4fd0-8daf-e2208326aa0f"},{"name":"Financial Projects","id":"057716b9-d7f3-47b4-bd40-74c1ca5a4996","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/financialProjects?erpKey=FX&pageNum","description":"

Search Financial Projects in ERP

(sapBusinessOne=63/OPRJ, totvsProtheus=CTD)

The search Financial Projects allows you to filter the ERP by:

List Search
Unitary Search: by erpKey

If no field for unitary query (erpKey) is informed in the request, the search returns as a list.

The projects service will consider as valid financial projects:

SAP Business One: [1] OPRJ.Active=Y
TOTVS Protheus:

Comments:

type: TOTVS Protheus (R=revenue, E=expense)
dimension: TOTVS Protheus (2)

The response will inform:

The number of returned objects in the count field

For list search the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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 does not have incremental treatment.

This service does not have user field (UDF) treatment.

Project Primary Key in ERP (optional)

\n","type":"text/plain"},"key":"erpKey","value":"FX"},{"description":{"content":"

Number of page - pagination (optional)

\n","type":"text/plain"},"key":"pageNum","value":null}],"variable":[]}},"response":[{"id":"f3720939-9cb1-4408-840f-03ed77cfd8da","name":"Financial Projects - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/financialProjects","host":["{{endpoint}}"],"path":["financialProjects"],"query":[{"key":"erpKey","value":"FX","description":"Project Primary Key in ERP (optional)","disabled":true},{"key":"pageNum","value":null,"description":"Number of page - pagination (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":"Fri, 30 Oct 2020 22:22:14 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"FinancialProjects\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"financialProjects\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-10-30T20:22:11\",\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 \"erpKey\": \"Amadeus\",\n \"fullName\": \"Amadeus\",\n \"isLocked\": false,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"},{"id":"6219be6d-9add-4e18-a525-57f31d8101fb","name":"Financial Projects - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/financialProjects","host":["{{endpoint}}"],"path":["financialProjects"],"query":[{"key":"erpKey","value":"FX","description":"Project Primary Key in ERP (optional)","disabled":true},{"key":"pageNum","value":null,"description":"Number of page - pagination (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\": \"salesAPI\",\n \"process\": \"FinancialProjects\",\n \"system\": \"totvsProtheus\",\n \"target\": \"financialProjects\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-12T15:28:39\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"values\": [\n {\n \"erpKey\": \"000000001\",\n \"fullName\": \"PROJETO DENGO\",\n \"isTitle\": false,\n \"type\": \"\",\n \"dimension\": \"2\",\n \"isLocked\": false,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ],\n \"count\": 1\n}"}],"_postman_id":"057716b9-d7f3-47b4-bd40-74c1ca5a4996"},{"name":"Payment Conditions","id":"34fbabac-532b-4460-a05b-77715c902e03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/payConditions?erpKey=1&pageNum","description":"

Search payment conditions in ERP

(sapBusinessOne=40/OCTG, totvsProtheus=SE4)

The search of payment conditions allows you to filter the ERP by:

List Search
Unitary Search: by erpKey

If no field for unitary query (erpKey) is informed in the request, the search returns as a list.

The payment conditions service will consider as valid payment conditions:

SAP Business One:
TOTVS Protheus: E4_MSQLBL not 1

The response will inform:

The number of returned objects in the count field

For list search the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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 does not have incremental treatment.

This service does not have user field (UDF) treatment.

Payment Condition Primary Key in ERP (optional)

\n","type":"text/plain"},"key":"erpKey","value":"1"},{"description":{"content":"

Number of page - pagination (optional)

\n","type":"text/plain"},"key":"pageNum","value":null}],"variable":[]}},"response":[{"id":"053d7174-a2b4-4bb3-984d-6e6316846cd5","name":"Payment Conditions - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/payConditions","host":["{{endpoint}}"],"path":["payConditions"],"query":[{"key":"erpKey","value":"1","description":"Payment Condition Primary Key in ERP (optional)","disabled":true},{"key":"pageNum","value":null,"description":"Number of page - pagination (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":"Fri, 30 Oct 2020 22:31:38 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"PayConditions\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"payConditions\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-10-30T20:31:35\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 2,\n \"values\": [\n {\n \"erpKey\": \"-2\",\n \"fullName\": \"30 Dias\",\n \"extraDays\": 30,\n \"installments\": 0,\n \"openIncPayment\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"2\",\n \"fullName\": \"30, 60, 90 x\",\n \"extraDays\": 0,\n \"installments\": 3,\n \"openIncPayment\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"},{"id":"d89ee4e9-b420-4917-bee7-3d0951f9b45f","name":"Payment Conditions - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/payConditions","host":["{{endpoint}}"],"path":["payConditions"],"query":[{"key":"erpKey","value":"1","description":"Payment Condition Primary Key in ERP (optional)","disabled":true},{"key":"pageNum","value":null,"description":"Number of page - pagination (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\": \"salesAPI\",\n \"process\": \"PayConditions\",\n \"system\": \"totvsProtheus\",\n \"target\": \"payConditions\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-12T17:36:19\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"values\": [\n {\n \"erpKey\": \"001\",\n \"fullName\": \"A VISTA\",\n \"extraDays\": 0,\n \"installments\": 1,\n \"openIncPayment\": null,\n \"type\": \"1\",\n \"payDetails\": \"0\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"002\",\n \"fullName\": \"30/60 DD\",\n \"extraDays\": 44,\n \"installments\": 2,\n \"openIncPayment\": null,\n \"type\": \"1\",\n \"payDetails\": \"30,60\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ],\n \"count\": 2\n}"}],"_postman_id":"34fbabac-532b-4460-a05b-77715c902e03"},{"name":"Payment Methods","id":"96a330dd-d1da-4e7e-afe1-4068fed996b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/payMethods?erpKey=Transf Bancária&pageNum","description":"

Search payment methods in ERP

(sapBusinessOne=147/OPYM, totvsProtheus=SX5)

The search of payment methods allows you to filter the ERP by:

List Search
Unitary Search: by erpKey

If no field for unitary query (erpKey) is informed in the request, the search returns as a list.

The payment methods service will consider as valid payment methods:

SAP Business One: [1] OPYM.Active=Y
TOTVS Protheus: [1] X5_TABELA=24

The response will inform:

The number of returned objects in the count field

For list search the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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 does not have incremental treatment.

This service does not have user field (UDF) treatment.

Payment Method Primary Key in ERP (optional)

\n","type":"text/plain"},"key":"erpKey","value":"Transf Bancária"},{"description":{"content":"

Number of page - pagination (optional)

\n","type":"text/plain"},"key":"pageNum","value":null}],"variable":[]}},"response":[{"id":"a9e355bc-d45f-4881-97db-f8644ff5cd61","name":"Payment Methods - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/payMethods","host":["{{endpoint}}"],"path":["payMethods"],"query":[{"key":"erpKey","value":"1","description":"Payment Method Primary Key in ERP (optional)","disabled":true},{"key":"pageNum","value":null,"description":"Number of page - pagination (optional)","type":"text","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":"Fri, 30 Oct 2020 22:23:21 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"PayMethods\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"payMethods\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-10-30T20:23:18\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 6,\n \"values\": [\n {\n \"erpKey\": \"Boleto receber\",\n \"fullName\": \"Boleto a Receber\",\n \"type\": \"I\",\n \"paymentType\": \"boe\",\n \"accountCode\": \"1.1.1.2.2\",\n \"createdAt\": \"2009-06-23T00:00:00\",\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"Transf Bancaria\",\n \"fullName\": \"Transferência Bancária - Recebimento\",\n \"type\": \"I\",\n \"paymentType\": \"transfer\",\n \"accountCode\": \"1.1.1.2.2\",\n \"createdAt\": \"2018-05-14T00:00:00\",\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"Boleto Pagar BB\",\n \"fullName\": \"Boleto a pagar Banco do Brasil\",\n \"type\": \"O\",\n \"paymentType\": \"boe\",\n \"accountCode\": \"1.1.1.2.2\",\n \"createdAt\": \"2009-06-23T00:00:00\",\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"},{"id":"2cdd1688-6074-4717-83b1-f0fd0c7fae99","name":"Payment Methods - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/payMethods","host":["{{endpoint}}"],"path":["payMethods"],"query":[{"key":"erpKey","value":"Transf Bancária","description":"Payment Method Primary Key in ERP (optional)","disabled":true},{"key":"pageNum","value":null,"description":"Number of page - pagination (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\": \"salesAPI\",\n \"process\": \"PayMethods\",\n \"system\": \"totvsProtheus\",\n \"target\": \"payMethods\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-12T17:04:43\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"values\": [\n {\n \"erpKey\": \"BOL\",\n \"fullName\": \"BOLETO BANCARIO\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"CC\",\n \"fullName\": \"CARTAO DE CREDITO\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"CD\",\n \"fullName\": \"CARTAO DE DEBITO AUTOMATICO\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"CH\",\n \"fullName\": \"CHEQUE\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"CI\",\n \"fullName\": \"CONSUMO INTERNO\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"CO\",\n \"fullName\": \"CONVENIO\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"CQ\",\n \"fullName\": \"CREDITO AO QUARTO\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"CR\",\n \"fullName\": \"CREDITO\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"DC\",\n \"fullName\": \"DEBITO EM CONTA CORRENTE\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"FA\",\n \"fullName\": \"A FATURAR\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"FI\",\n \"fullName\": \"FINANCIADO\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"FID\",\n \"fullName\": \"FIDELIDADE\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"R$\",\n \"fullName\": \"DINHEIRO\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"RA\",\n \"fullName\": \"RECEBIMENTO ANTECIPADO\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"VA\",\n \"fullName\": \"VALES\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"VP\",\n \"fullName\": \"VALE PRESENTE\",\n \"type\": \"A\",\n \"paymentType\": null,\n \"accountCode\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ],\n \"count\": 16\n}"}],"_postman_id":"96a330dd-d1da-4e7e-afe1-4068fed996b3"},{"name":"Credit Cards","id":"b03d21a9-265a-4c82-add2-5c9ee69282fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/creditCards?erpKey=1&pageNum","description":"

Search credit cards in ERP

(sapBusinessOne=36/OCRC, totvsProtheus=SAE)

The search of credit cards allows you to filter the ERP by:

List Search
Unitary Search: by erpKey

If no field for unitary query (erpKey) is informed in the request, the search returns as a list.

The credit cards service will consider as valid credit cards:

SAP Business One: [1]
TOTVS Protheus: [1] AE_TIPO=CC

The response will inform:

The number of returned objects in the count field

For list search the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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 does not have incremental treatment.

This service does not have user field (UDF) treatment.

Credit Card Primary Key in ERP (optional)

\n","type":"text/plain"},"key":"erpKey","value":"1"},{"description":{"content":"

Number of page - pagination (optional)

\n","type":"text/plain"},"key":"pageNum","value":null}],"variable":[]}},"response":[{"id":"c5401131-1895-439c-b856-0e33d14a6193","name":"Credit Cards - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/creditCards","host":["{{endpoint}}"],"path":["creditCards"],"query":[{"key":"erpKey","value":"1","description":"Credit Card Primary Key in ERP (optional)","disabled":true},{"key":"pageNum","value":null,"description":"Number of page - pagination (optional)","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"JSESSIONID=1D85D6A03D92F61136BDE8762646C651; 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, 30 Oct 2020 22:38:05 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"CreditCards\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"creditCards\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-10-30T20:38:03\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 3,\n \"values\": [\n {\n \"erpKey\": \"1\",\n \"fullName\": \"Visa\",\n \"accountCode\": \"1.1.2.10.2\",\n \"phone\": \"0800-213-3129\",\n \"isLocked\": false,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"2\",\n \"fullName\": \"Mastercard\",\n \"accountCode\": \"1.1.2.10.3\",\n \"phone\": \"0300-1239-321\",\n \"isLocked\": false,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"3\",\n \"fullName\": \"Amex\",\n \"accountCode\": \"1.1.2.10.4\",\n \"phone\": \"5503-3292\",\n \"isLocked\": false,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"},{"id":"6542ee30-f28b-48fc-8e65-b2854af7e8b9","name":"Credit Cards - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/creditCards","host":["{{endpoint}}"],"path":["creditCards"],"query":[{"key":"erpKey","value":"1","description":"Credit Card Primary Key in ERP (optional)","disabled":true},{"key":"pageNum","value":null,"description":"Number of page - pagination (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\": \"salesAPI\",\n \"process\": \"CreditCards\",\n \"system\": \"totvsProtheus\",\n \"target\": \"creditCards\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-12T17:03:00\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"values\": [\n {\n \"erpKey\": \"001\",\n \"fullName\": \"VISA\",\n \"accountCode\": \"\",\n \"phone\": \"\",\n \"isLocked\": \"false\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ],\n \"count\": 1\n}"}],"_postman_id":"b03d21a9-265a-4c82-add2-5c9ee69282fd"},{"name":"Numering Series","id":"5043248b-81b6-4d82-ac5b-8b9f10ccad06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/numeringSeries?object=2","description":"

Search numering series in ERP

(sapBusinessOne=35/ONNM)

The search of numering series allows you to filter the ERP by:

List Search
Unitary Search: by erpKey

If no field for unitary query (erpKey) is informed in the request, the search returns as a list.

The numering series service will consider all numering series as valid.

The response will inform:

The number of returned objects in the count field

This service does not have incremental treatment.

This service does not have user field (UDF) treatment.

Object Code in ERP (required if not unitary search)

\n","type":"text/plain"},"key":"object","value":"2"},{"disabled":true,"description":{"content":"

Subtype Numering Series in ERP (optional in list search)

\n","type":"text/plain"},"key":"subtype","value":"C"},{"disabled":true,"description":{"content":"

Numering Serie Primary Key in ERP (optional)

\n","type":"text/plain"},"key":"erpKey","value":"1"}],"variable":[]}},"response":[{"id":"b30ddbdb-c9e5-40e2-9a50-8720ff9f2037","name":"Numering Series - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/numeringSeries?object=2","host":["{{endpoint}}"],"path":["numeringSeries"],"query":[{"key":"object","value":"2","description":"Object Code in ERP (required if not unitary search)"},{"key":"subtype","value":"C","description":"Subtype Numering Series in ERP (optional in list search)","type":"text","disabled":true},{"key":"erpKey","value":"1","description":"Numering Serie Primary Key in ERP (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, 24 Jun 2021 16:23:51 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"NumeringSeries\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"numeringSeries\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.103\",\n \"effectiveTimestamp\": \"2021-06-24T13:23:48\",\n \"object\": \"2\",\n \"code\": \"200\",\n \"success\": true,\n \"useCustom\": \"true\",\n \"count\": 1,\n \"values\": [\n {\n \"object\": \"2\",\n \"items\": [\n {\n \"subtype\": \"C\",\n \"erpKey\": \"37\",\n \"name\": \"Manual\",\n \"beginString\": \"\",\n \"default\": true,\n \"manual\": true,\n \"locked\": false\n },\n {\n \"subtype\": \"C\",\n \"erpKey\": \"70\",\n \"name\": \"Primário\",\n \"beginString\": \"C\",\n \"default\": false,\n \"manual\": false,\n \"locked\": false\n },\n {\n \"subtype\": \"S\",\n \"erpKey\": \"38\",\n \"name\": \"Manual\",\n \"beginString\": \"\",\n \"default\": false,\n \"manual\": true,\n \"locked\": false\n },\n {\n \"subtype\": \"S\",\n \"erpKey\": \"71\",\n \"name\": \"Primário\",\n \"beginString\": \"F\",\n \"default\": true,\n \"manual\": false,\n \"locked\": false\n }\n ]\n }\n ]\n}"}],"_postman_id":"5043248b-81b6-4d82-ac5b-8b9f10ccad06"}],"id":"d1e1c250-77dd-4ac8-a9af-31331af65d3f","description":"

Branches, Warehouses, Carriers

\n","event":[{"listen":"prerequest","script":{"id":"158b4fb3-b2c5-44b9-bc73-4ab304a74443","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ce1e940c-ddf2-4f8d-a5e0-116fadb1026f","type":"text/javascript","exec":[""]}}],"_postman_id":"d1e1c250-77dd-4ac8-a9af-31331af65d3f","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"11834bc6-bff3-4272-b68a-24430df885aa","id":"11834bc6-bff3-4272-b68a-24430df885aa","name":"salesAPI - Sales API for ERP (v2)","type":"collection"}}},{"name":"Products","item":[{"name":"Item Groups","id":"d30ebcb2-166f-4c1d-a1e1-76502b633e1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/itemGroups?erpKey=100","description":"

Search product groups in ERP

(sapBusinessOne=52/OITB, totvsProtheus=SBM)

The service will search the ERP database and return the product groups, linked with valid products.

The search can also be unitary, informing the desired erpKey in the request.

SAP Business One: OITB.ItmsGrpCod
TOTVS Protheus: BM_GRUPO

The itemGroups service will consider as valid products:

SAP Business One: [1] Sale Item (OITM.SellItem = Y), [2] Valid and not canceled (OITM.validFor = Y AND OITM.Canceled = N)
TOTVS Protheus: [1] “Finished Product” Type (B1_TIPO = PA), [2] active product (B1_MSBLQL other than 1), [3] E-commerce field active (B5_ECFLAG = 1)

The response will inform:

The number of returned objects in the count field

This service does not have pagination or incremental treatment.

This service does not have user field (UDF) treatment.

Item Group Primary Key in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"erpKey","value":"100"}],"variable":[]}},"response":[{"id":"eccb344f-045e-4502-a79b-0c8675415df8","name":"Item Groups - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/itemGroups","host":["{{endpoint}}"],"path":["itemGroups"],"query":[{"key":"erpKey","value":"100","description":"Item Group Primary Key in ERP (optional - unitary search)","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":"Sat, 18 Apr 2020 18:06:22 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"ItemGroups\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"itemGroups\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.105\",\n \"effectiveTimestamp\": \"2020-04-18T15:06:19\",\n \"code\": \"200\",\n \"success\": true,\n \"count\": 1,\n \"values\": [\n {\n \"erpKey\": \"100\",\n \"itemGroup\": \"100-Suplementos\",\n \"materialType\": \"4-Produtos acabados\",\n \"materialGroup\": \"3-Suplementos\",\n \"createdAt\": null,\n \"updatedAt\": \"2009-06-24T00:00:00\",\n \"canceledAt\": null\n }\n ]\n}"},{"id":"02badba3-6691-4ea0-a244-d07f13fca29b","name":"Item Groups - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/itemGroups","host":["{{endpoint}}"],"path":["itemGroups"],"query":[{"key":"erpKey","value":"100","description":"Item Group Primary Key in ERP (optional - unitary search)","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\": \"salesAPI\",\n \"process\": \"ItemGroups\",\n \"system\": \"totvsProtheus\",\n \"target\": \"itemGroups\",\n \"user\": \"intergate\",\n \"host\": \"192.168.30.4\",\n \"effectiveTimestamp\": \"2021-09-03T17:09:58\",\n \"code\": \"200\",\n \"success\": true,\n \"count\": 2,\n \"values\": [\n {\n \"erpKey\": \"1001\",\n \"itemGroup\": \"1001-MATERIA PRIMA\",\n \"materialType\": \"1-Outros\",\n \"materialGroup\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"5001\",\n \"itemGroup\": \"5001-PRODUTO ACABADO\",\n \"materialType\": \"1-Outros\",\n \"materialGroup\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"d30ebcb2-166f-4c1d-a1e1-76502b633e1a"},{"name":"Products","id":"92a1d6f8-afd0-4230-ba4c-37a31a4470c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/products?itemType=4&itemGroup=103&brand=2&erpKey=PA00244&codeBars=I004&pageNum=1&updatedAt=2020-08-20T00:00:00&usePartnumber=false&showComplement=false","description":"

Search products in ERP

(sapBusinessOne=4/OITM, totvsProtheus=SB1)

The service will search the ERP database and return the items located (skus), grouped or not by partnumber (Configurable Product).

The search of products allows filtering the ERP by:

List Search: by itemType, by itemGroup and/or by brand {optional}
Unitary Search: by erpKey or codeBars

If no field for unitary search (erpKey or codeBars) is informed in the request, the search returns all valid products. The list search can be optionally filtered by itemType, by itemGroup and/or by brand.

Comments:

Item Type: [1] SAP Business One: OITM.MatType (table OMTP), [2] TOTVS Protheus: B1_TIPO (table SX5/02)
Item Group: [1] SAP Business One: OITM.ItmsGrpCod (table OITB), [2] TOTVS Protheus: B1_GRUPO (table SBM)
Brand (or Manufacturer): [1] SAP Business One: OITM.FirmCode (table OMRC), [2] TOTVS Protheus: B1_FABRIC
treeType: S=sales (kit), P=production, N=no. [1] SAP Business One: OITM.TreeType, [2] TOTVS Protheus: B1_TIPO=KT, with valid component in SG1

The products service will consider as valid products:

SAP Business One: [1] Valid and not canceled (OITM.validFor = Y AND OITM.Canceled = N)
TOTVS Protheus: [1] active product (B1_MSBLQL other than 1)
optionally you can define in Setup API to return only products with valid codeBars

By default, the products service consider all items/products as the SKU (Simple Product), that is, without the concept of a grouping Partnumber (Configurable Product). To implement the Partnumber concept: create UDF field and define the field created in the API configuration and in the Custom Table. Search response will modify with or without Partnumber concept.

The service will return two prices for each product: price (normal price) and pricePromo (promotional price). The table price used for normal and promotional prices are definied in API Setup.

Price list:

SAP Business One: OITM.PriceList
TOTVS Protheus: [1] If the price tables are not definied in the API Setup (IG_PRICEL+IG_PRICELP): fields B1_PRV1 and B5_PRV2 will be used, [2] If the price tables are definied in the API Setup: tables DA0/DA1 will be used

For list search, the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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, reported in the response
hasNext = if there are more pages (true/false), informed in the response

This service will allow you search the products list in two situations:

Full Search: will result in all partnumber/SKU (optionally by brand).
Incremental Search: will result in all partnumber/SKU (optionally by brand) that have been included and/or changed in 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 products (partnumber/skus) should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields of the product in SAP Business One (OITM.CreateDate, OITM.UpdateDate, OITM.CreateTS*, OITM.UpdateTS*), [2] TOTVS Protheus: fields B1_USERLGI and B1_USERLGA. Time treatment: available from SAP B1 9.2 PL8, and not available for TOTVS Protheus.

The response will inform:

The total number of skus or partnumbers in the count field
The total number of SKUs per partnumber in the countSKU field

For use of user fields (UDF) created in the product table (SAPB1: OITM, TOTVS: SB1) the respective registration must be performed in the Custom Table.

Type of products (optional in list search)

\n","type":"text/plain"},"key":"itemType","value":"4"},{"description":{"content":"

Group of products (optional in list search)

\n","type":"text/plain"},"key":"itemGroup","value":"103"},{"description":{"content":"

Brand of products (optional in list search)

\n","type":"text/plain"},"key":"brand","value":"2"},{"description":{"content":"

Product Primary Key in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"erpKey","value":"PA00244"},{"description":{"content":"

Product Code Bars in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"codeBars","value":"I004"},{"description":{"content":"

Number of page - pagination (optional)

\n","type":"text/plain"},"key":"pageNum","value":"1"},{"description":{"content":"

Date do filter modified register - incremental search (optional)

\n","type":"text/plain"},"key":"updatedAt","value":"2020-08-20T00:00:00"},{"description":{"content":"

Define if show response in partnumber format to sellItems

\n","type":"text/plain"},"key":"usePartnumber","value":"false"},{"description":{"content":"

Define if show response with complement object (PROTHEUS only=SB5)

\n","type":"text/plain"},"key":"showComplement","value":"false"}],"variable":[]}},"response":[{"id":"f5f252a2-236c-4b0f-8b27-3058f09e9af0","name":"Products","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/products","host":["{{endpoint}}"],"path":["products"],"query":[{"key":"brand","value":"01","description":"Brand of products (optional in list search)","disabled":true},{"key":"erpKey","value":"I004","description":"Product Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"codeBars","value":"I004","description":"Product Code Bars in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"1","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-28T17:00:00","description":"Date do filter modified register - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"JSESSIONID=273149D3D786E905CFAAED807D3C2707; 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, 23 Apr 2020 12:19:21 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"b2cAPI\",\n \"process\": \"Products\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"products\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.100\",\n \"effectiveTimestamp\": \"2020-04-23T09:18:36\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 10,\n \"pageNum\": 1,\n \"pageTotal\": 11,\n \"hasNext\": true,\n \"useCustom\": true,\n \"usePartnumber\": false,\n \"dimensionUnit\": \"cm\",\n \"weightUnit\": \"kg\",\n \"priceList\": \"3\",\n \"priceListPromo\": \"1\",\n \"count\": 6,\n \"values\": [\n {\n \"erpKey\": \"A00001\",\n \"codeBars\": \"\",\n \"brand\": \"-1-- Nenhum fabricante -\",\n \"itemGroup\": \"107-Impressoras\",\n \"itemType\": \"1-Matéria-prima\",\n \"materialGroup\": \"\",\n \"description\": \"Impressora 1\",\n \"longDescription\": \"\",\n \"measureUnit\": \"UN\",\n \"swidth\": 0,\n \"slength\": 0,\n \"sheight\": 0,\n \"sweight\": 1,\n \"price\": 69,\n \"pricePromo\": 60,\n \"availableStock\": 79,\n \"itemtypeproj\": \"110-01\",\n \"partnumber\": \"\",\n \"createdAt\": \"2017-04-24T18:24:57\",\n \"updatedAt\": \"2017-11-30T23:28:33\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"A00002\",\n \"codeBars\": \"\",\n \"brand\": \"-1-- Nenhum fabricante -\",\n \"itemGroup\": \"107-Impressoras\",\n \"itemType\": \"1-Matéria-prima\",\n \"materialGroup\": \"\",\n \"description\": \"Impressora 2\",\n \"longDescription\": \"\",\n \"measureUnit\": \"UN\",\n \"swidth\": 0,\n \"slength\": 0,\n \"sheight\": 0,\n \"sweight\": 0,\n \"price\": 103.5,\n \"pricePromo\": 100,\n \"availableStock\": 88,\n \"itemtypeproj\": \"110-01\",\n \"partnumber\": \"\",\n \"createdAt\": \"2017-04-24T18:25:22\",\n \"updatedAt\": \"2017-04-24T18:37:32\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"A00003\",\n \"codeBars\": \"\",\n \"brand\": \"-1-- Nenhum fabricante -\",\n \"itemGroup\": \"107-Impressoras\",\n \"itemType\": \"1-Matéria-prima\",\n \"materialGroup\": \"\",\n \"description\": \"Impressora 3\",\n \"longDescription\": \"\",\n \"measureUnit\": \"UN\",\n \"swidth\": 0,\n \"slength\": 0,\n \"sheight\": 0,\n \"sweight\": 0,\n \"price\": 0,\n \"pricePromo\": 0,\n \"availableStock\": 20,\n \"itemtypeproj\": \"110-01\",\n \"partnumber\": \"\",\n \"createdAt\": \"2017-04-24T18:25:38\",\n \"updatedAt\": \"2017-04-24T18:37:39\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"ASV0121\",\n \"codeBars\": \"\",\n \"brand\": \"-1-- Nenhum fabricante -\",\n \"itemGroup\": \"101-Produto Nacional\",\n \"itemType\": \"4-Produtos acabados\",\n \"materialGroup\": \"1-Material Esportivo Terrestre\",\n \"description\": \"Pino Roscado Din 976 8 m16 x 80 cl. 8.8. Zincado\",\n \"longDescription\": \"\",\n \"measureUnit\": \"UN\",\n \"swidth\": 0,\n \"slength\": 0,\n \"sheight\": 0,\n \"sweight\": 0,\n \"price\": 4.14,\n \"pricePromo\": 4,\n \"availableStock\": 260,\n \"itemtypeproj\": \"110-01\",\n \"partnumber\": \"\",\n \"createdAt\": \"2016-05-10T10:41:20\",\n \"updatedAt\": \"2017-04-07T17:46:53\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"ASV0122\",\n \"codeBars\": \"\",\n \"brand\": \"-1-- Nenhum fabricante -\",\n \"itemGroup\": \"101-Produto Nacional\",\n \"itemType\": \"4-Produtos acabados\",\n \"materialGroup\": \"1-Material Esportivo Terrestre\",\n \"description\": \"Porca M16 Din934 Zincado\",\n \"longDescription\": \"\",\n \"measureUnit\": \"pc\",\n \"swidth\": 0,\n \"slength\": 0,\n \"sheight\": 0,\n \"sweight\": 0,\n \"price\": 5.52,\n \"pricePromo\": 5,\n \"availableStock\": 398,\n \"itemtypeproj\": \"110-01\",\n \"partnumber\": \"\",\n \"createdAt\": \"2016-05-10T10:42:47\",\n \"updatedAt\": \"2017-04-07T17:47:30\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"ASV0123\",\n \"codeBars\": \"\",\n \"brand\": \"-1-- Nenhum fabricante -\",\n \"itemGroup\": \"101-Produto Nacional\",\n \"itemType\": \"4-Produtos acabados\",\n \"materialGroup\": \"1-Material Esportivo Terrestre\",\n \"description\": \"Pino Rosca Din 976 8 M20 x 125 CL 8.8 Zincado\",\n \"longDescription\": \"\",\n \"measureUnit\": \"pc\",\n \"swidth\": 0,\n \"slength\": 0,\n \"sheight\": 0,\n \"sweight\": 0,\n \"price\": 6.9,\n \"pricePromo\": 6,\n \"availableStock\": 510,\n \"itemtypeproj\": \"110-01\",\n \"partnumber\": \"\",\n \"createdAt\": \"2016-05-10T10:48:44\",\n \"updatedAt\": \"2017-04-07T17:47:39\",\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"92a1d6f8-afd0-4230-ba4c-37a31a4470c1"},{"name":"Bill of Materials","id":"da6677e0-2e29-48fb-b258-ab480565e7a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/billOfMaterials?itemType=4&itemGroup=&brand=&treeType=&productKey=&codeBars=&pageNum=&updatedAt=","description":"

Search bill of materials in ERP

(sapBusinessOne=66/OITT, totvsProtheus=SG1)

This service will allow you to search bill of materials on the ERP.

Products with treeType not equals N=No have bill of components for sale (S=sales - kit or bundle) or bill of components for production (P=production).

The search of bill of materials allows filtering the ERP by:

List Search: by itemType, by itemGroup and/or by brand {optional}
Unitary Search: by erpKey or codeBars

If no field for unitary search (erpKey or codeBars) is informed in the request, the search returns all valid bill of materials. The list search can be optionally filtered by itemType, by itemGroup and/or by brand.

Comments:

itemType: [1] SAP Business One: OITM.MatType (table OMTP), [2] TOTVS Protheus: B1_TIPO (table SX5/02)
item Group: [1] SAP Business One: OITM.ItmsGrpCod (table OITB), [2] TOTVS Protheus: B1_GRUPO (table SBM)
brand (or Manufacturer): [1] SAP Business One: OITM.FirmCode (table OMRC), [2] TOTVS Protheus: B1_FABRIC

The bill of materiais service will consider as valid bill of materials:

SAP Business One:
TOTVS Protheus:

The bill of materiais service will consider as valid products:

SAP Business One: [1] Sale Item (OITM.SellItem = Y), [2] Valid and not canceled (OITM.validFor = Y AND OITM.Canceled = N)
TOTVS Protheus: [1] active product (B1_MSBLQL other than 1)
optionally you can define in Setup API to return only products with valid codeBars

The response will inform:

The number of returned objects in the count field

For list search, the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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, reported in the response
hasNext = if there are more pages (true / false), informed in the response

This service will allow you to search the bill of materials list in two situations:

Full Search: will result in all bill of materials, according to filters.
Incremental Search: will result in all bill of materials, 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 Consultation, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which bill of materials 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 (OITT.CreateDate, OITT.UpdateDate, OITT.CreateTS, OITT.UpdateTS), [2] TOTVS Protheus: fields G1_USERLGI and G1_USERLGA

For the use of user fields (UDF) created in the bill of materials table (SAPB1: OITT, TOTVS: SG1), the respective registration must be performed in the Custom Table.

Type of products (optional in list search)

\n","type":"text/plain"},"key":"itemType","value":"4"},{"description":{"content":"

Group of products (optional in list search)

\n","type":"text/plain"},"key":"itemGroup","value":""},{"description":{"content":"

Brand of products (optional in list search)

\n","type":"text/plain"},"key":"brand","value":""},{"description":{"content":"

Type of Tree: P=production, S=sales, T=template, A=assembly (optional - list search)

\n","type":"text/plain"},"key":"treeType","value":""},{"description":{"content":"

Product Primary Key in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"productKey","value":""},{"description":{"content":"

Product Code Bars in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"codeBars","value":""},{"description":{"content":"

Number of page - pagination (optional)

\n","type":"text/plain"},"key":"pageNum","value":""},{"description":{"content":"

Date to filter bill of materials changes - incremental search (optional)

\n","type":"text/plain"},"key":"updatedAt","value":""}],"variable":[]}},"response":[{"id":"3aa4446c-ebfe-4346-8194-f53ab90597fb","name":"Bill of Materials - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/billOfMaterials","host":["{{endpoint}}"],"path":["billOfMaterials"],"query":[{"key":"itemType","value":"4","description":"Type of products (optional in list search)","disabled":true},{"key":"itemGroup","value":"","description":"Group of products (optional in list search)","disabled":true},{"key":"treeType","value":"","description":"Type of Tree: P=production, S=sales, T=template, A=assembly (optional - list search)","disabled":true},{"key":"brand","value":"","description":"Brand of products (optional in list search)","disabled":true},{"key":"productKey","value":"NESKIT","description":"Product Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"codeBars","value":"","description":"Product Code Bars in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"","description":"Date to filter bill of materials 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":"Wed, 04 Nov 2020 22:11:37 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"mesAPI\",\n \"process\": \"BillOfMaterials\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"billOfMaterials\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-04T20:11:32\",\n \"code\": \"200\",\n \"success\": true,\n \"useCustom\": \"\",\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 1,\n \"values\": [\n {\n \"productKey\": \"ASV28500\",\n \"codeBars\": \"\",\n \"treeType\": \"P\",\n \"measureUnit\": \"\",\n \"baseQuantity\": 1,\n \"productionWhsCode\": \"01\",\n \"priceListKey\": \"8\",\n \"financialProjectKey\": \"\",\n \"createdAt\": \"2016-05-10T00:00:00\",\n \"updatedAt\": \"2016-05-10T00:00:00\",\n \"canceledAt\": null,\n \"lines\": [\n {\n \"lineNum\": \"0\",\n \"componentType\": \"T\",\n \"componentKey\": \"\",\n \"description\": \"1o Passo\",\n \"measureUnit\": \"\",\n \"quantity\": 0,\n \"issueMethod\": \"M\",\n \"whsCode\": \"\",\n \"priceListKey\": \"\",\n \"currency\": \"\",\n \"price\": 0\n },\n {\n \"lineNum\": \"1\",\n \"componentType\": \"R\",\n \"componentKey\": \"MAQ015\",\n \"description\": \"\",\n \"measureUnit\": \"\",\n \"quantity\": 1,\n \"issueMethod\": \"A\",\n \"whsCode\": \"01\",\n \"priceListKey\": \"\",\n \"currency\": \"R$\",\n \"price\": 25\n },\n {\n \"lineNum\": \"2\",\n \"componentType\": \"P\",\n \"componentKey\": \"ASV0121\",\n \"description\": \"VALVULA CONDUIT DISCO DUPLO DN 20\",\n \"measureUnit\": \"\",\n \"quantity\": 1,\n \"issueMethod\": \"A\",\n \"whsCode\": \"01\",\n \"priceListKey\": \"3\",\n \"currency\": \"R$\",\n \"price\": 1.61\n },\n {\n \"lineNum\": \"3\",\n \"componentType\": \"P\",\n \"componentKey\": \"ASV0122\",\n \"description\": \"VALVULA CONDUIT DISCO DUPLO DN 20\",\n \"measureUnit\": \"\",\n \"quantity\": 1,\n \"issueMethod\": \"A\",\n \"whsCode\": \"01\",\n \"priceListKey\": \"-2\",\n \"currency\": \"R$\",\n \"price\": 2.2\n },\n {\n \"lineNum\": \"4\",\n \"componentType\": \"P\",\n \"componentKey\": \"ASV0123\",\n \"description\": \"VALVULA CONDUIT DISCO DUPLO DN 20\",\n \"measureUnit\": \"\",\n \"quantity\": 1,\n \"issueMethod\": \"A\",\n \"whsCode\": \"01\",\n \"priceListKey\": \"-2\",\n \"currency\": \"R$\",\n \"price\": 1.61\n },\n {\n \"lineNum\": \"5\",\n \"componentType\": \"P\",\n \"componentKey\": \"ASV0124\",\n \"description\": \"VALVULA CONDUIT DISCO DUPLO DN 20\",\n \"measureUnit\": \"\",\n \"quantity\": 1,\n \"issueMethod\": \"A\",\n \"whsCode\": \"01\",\n \"priceListKey\": \"-2\",\n \"currency\": \"R$\",\n \"price\": 3.23\n },\n {\n \"lineNum\": \"6\",\n \"componentType\": \"P\",\n \"componentKey\": \"ASV0125\",\n \"description\": \"VALVULA CONDUIT DISCO DUPLO DN 20\",\n \"measureUnit\": \"\",\n \"quantity\": 1,\n \"issueMethod\": \"A\",\n \"whsCode\": \"01\",\n \"priceListKey\": \"-2\",\n \"currency\": \"R$\",\n \"price\": 3\n },\n {\n \"lineNum\": \"7\",\n \"componentType\": \"P\",\n \"componentKey\": \"ASV0126\",\n \"description\": \"VALVULA CONDUIT DISCO DUPLO DN 20\",\n \"measureUnit\": \"\",\n \"quantity\": 1,\n \"issueMethod\": \"A\",\n \"whsCode\": \"01\",\n \"priceListKey\": \"-2\",\n \"currency\": \"R$\",\n \"price\": 45.21\n },\n {\n \"lineNum\": \"8\",\n \"componentType\": \"P\",\n \"componentKey\": \"ASV0129\",\n \"description\": \"VALVULA CONDUIT DISCO DUPLO DN 20\",\n \"measureUnit\": \"\",\n \"quantity\": 1,\n \"issueMethod\": \"A\",\n \"whsCode\": \"01\",\n \"priceListKey\": \"-2\",\n \"currency\": \"R$\",\n \"price\": 4.04\n },\n {\n \"lineNum\": \"9\",\n \"componentType\": \"P\",\n \"componentKey\": \"ASV0134\",\n \"description\": \"VALVULA CONDUIT DISCO DUPLO DN 20\",\n \"measureUnit\": \"\",\n \"quantity\": 1,\n \"issueMethod\": \"A\",\n \"whsCode\": \"01\",\n \"priceListKey\": \"-2\",\n \"currency\": \"R$\",\n \"price\": 37.14\n }\n ]\n }\n ]\n}"},{"id":"3f920045-c5f8-4552-a65e-e53b694a52a2","name":"Bill of Materials - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/billOfMaterials","host":["{{endpoint}}"],"path":["billOfMaterials"],"query":[{"key":"itemType","value":"4","description":"Type of products (optional in list search)","disabled":true},{"key":"itemGroup","value":"","description":"Group of products (optional in list search)","disabled":true},{"key":"treeType","value":"","description":"Type of Tree: P=production, S=sales, T=template, A=assembly (optional - list search)","disabled":true},{"key":"brand","value":"","description":"Brand of products (optional in list search)","disabled":true},{"key":"productKey","value":"","description":"Product Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"codeBars","value":"","description":"Product Code Bars in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"","description":"Date to filter bill of materials 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\": \"mesAPI\",\n \"process\": \"BillOfMaterials\",\n \"system\": \"totvsProtheus\",\n \"target\": \"billOfMaterials\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-10T12:26:30\",\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 \"productKey\": \"PA000001\",\n \"codeBars\": \"\",\n \"treeType\": \"P\",\n \"measureUnit\": \"UN\",\n \"baseQuantity\": 1,\n \"productionWhsCode\": \"01\",\n \"priceListKey\": null,\n \"financialProjectKey\": null,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null,\n \"lines\": [\n {\n \"lineNum\": \"1\",\n \"componentType\": \"P\",\n \"componentKey\": \"MP000001\",\n \"description\": \"MATERIA PRIMA\",\n \"measureUnit\": \"KG\",\n \"quantity\": 1,\n \"issueMethod\": \"A\",\n \"whsCode\": \"01\",\n \"priceListKey\": null,\n \"currency\": null,\n \"price\": null,\n \"comments\": \"\"\n },\n {\n \"lineNum\": \"2\",\n \"componentType\": \"P\",\n \"componentKey\": \"MP000002\",\n \"description\": \"MATERIA PRIMA 2\",\n \"measureUnit\": \"UN\",\n \"quantity\": 1,\n \"issueMethod\": \"A\",\n \"whsCode\": \"01\",\n \"priceListKey\": null,\n \"currency\": null,\n \"price\": null,\n \"comments\": \"\"\n }\n ]\n }\n ],\n \"count\": 1\n}"}],"_postman_id":"da6677e0-2e29-48fb-b258-ab480565e7a7"}],"id":"29aa9251-f5a2-4e1a-8bd4-046a8dfb0390","_postman_id":"29aa9251-f5a2-4e1a-8bd4-046a8dfb0390","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"11834bc6-bff3-4272-b68a-24430df885aa","id":"11834bc6-bff3-4272-b68a-24430df885aa","name":"salesAPI - Sales API for ERP (v2)","type":"collection"}}},{"name":"Stocks & Prices","item":[{"name":"PriceLists","id":"442173c5-a469-43b6-8ade-3a0d0370b995","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/priceLists?erpKey=1","description":"

Search priceLists in ERP

(sapBusinessOne=6/OPLN, totvsProtheus=DA0)

The priceList search allows you to filter the ERP by:

List Search
Unitary Search: by erpKey

If no field for unitary search (erpKey) is informed in the request, the search will return all valid priceLists.

The priceLists service will consider as valid priceList:

SAP Business One: [1] Valid (OPLN.validFor = Y)
TOTVS Protheus: [1] active (DA0_ATIVO=1), [2] initial validity (DA0_DATDE<=dDataBase)

The response will inform:

The number of returned objects in the count field

This service does not have pagination or incremental treatment.

This service does not have user field (UDF) treatment.

PriceList Primary Key in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"erpKey","value":"1"}],"variable":[]}},"response":[{"id":"77ce138c-33b0-4800-97aa-6d2cb3524f22","name":"PriceLists - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/priceLists","host":["{{endpoint}}"],"path":["priceLists"],"query":[{"key":"erpKey","value":"1","description":"PriceList Primary Key in ERP (optional - unitary search)","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":"Sat, 30 May 2020 14:51:57 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"PriceLists\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"priceLists\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.104\",\n \"effectiveTimestamp\": \"2020-05-30T11:51:54\",\n \"code\": \"200\",\n \"success\": true,\n \"count\": 10,\n \"values\": [\n {\n \"erpKey\": \"1\",\n \"name\": \"Lista de Preço Principal\",\n \"currency\": \"R$\",\n \"basePriceList\": \"1\",\n \"baseFactor\": 1,\n \"grossPrice\": false,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"2\",\n \"name\": \"Lista de Preço Varejo\",\n \"currency\": \"R$\",\n \"basePriceList\": \"1\",\n \"baseFactor\": 2.5,\n \"grossPrice\": false,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"3\",\n \"name\": \"Lista de Preço Corporativo\",\n \"currency\": \"R$\",\n \"basePriceList\": \"-1\",\n \"baseFactor\": 1.38,\n \"grossPrice\": false,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"4\",\n \"name\": \"Lista de Preço Sudeste\",\n \"currency\": \"R$\",\n \"basePriceList\": \"4\",\n \"baseFactor\": 1,\n \"grossPrice\": false,\n \"createdAt\": null,\n \"updatedAt\": \"2015-06-09T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"5\",\n \"name\": \"Lista de Preço Nordeste\",\n \"currency\": \"R$\",\n \"basePriceList\": \"4\",\n \"baseFactor\": 0.65,\n \"grossPrice\": false,\n \"createdAt\": null,\n \"updatedAt\": \"2015-06-09T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"6\",\n \"name\": \"Lista de Preço Sul\",\n \"currency\": \"R$\",\n \"basePriceList\": \"4\",\n \"baseFactor\": 0.85,\n \"grossPrice\": false,\n \"createdAt\": null,\n \"updatedAt\": \"2015-06-09T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"7\",\n \"name\": \"Lista de Preço Norte\",\n \"currency\": \"R$\",\n \"basePriceList\": \"4\",\n \"baseFactor\": 0.5,\n \"grossPrice\": false,\n \"createdAt\": null,\n \"updatedAt\": \"2015-06-09T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"8\",\n \"name\": \"Lista de Preço Centro-Oeste\",\n \"currency\": \"R$\",\n \"basePriceList\": \"4\",\n \"baseFactor\": 0.7,\n \"grossPrice\": false,\n \"createdAt\": null,\n \"updatedAt\": \"2015-06-09T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"9\",\n \"name\": \"Lista de preços 09\",\n \"currency\": \"R$\",\n \"basePriceList\": \"9\",\n \"baseFactor\": 1,\n \"grossPrice\": false,\n \"createdAt\": null,\n \"updatedAt\": \"2015-06-09T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"10\",\n \"name\": \"Lista de preços 10\",\n \"currency\": \"R$\",\n \"basePriceList\": \"10\",\n \"baseFactor\": 1,\n \"grossPrice\": false,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"},{"id":"9635a914-3111-4c10-96de-35386c1a562a","name":"PriceLists - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/priceLists","host":["{{endpoint}}"],"path":["priceLists"],"query":[{"key":"erpKey","value":"1","description":"PriceList Primary Key in ERP (optional - unitary search)","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\": \"salesAPI\",\n \"process\": \"PriceLists\",\n \"system\": \"totvsProtheus\",\n \"target\": \"priceLists\",\n \"user\": \"intergate\",\n \"host\": \"192.168.30.4\",\n \"effectiveTimestamp\": \"2021-09-03T17:12:17\",\n \"code\": \"200\",\n \"success\": true,\n \"count\": 1,\n \"values\": [\n {\n \"erpKey\": \"001\",\n \"erpId\": \"1\",\n \"name\": \"TABELA GERAL\",\n \"currency\": \"R$\",\n \"basePriceList\": null,\n \"baseFactor\": null,\n \"grossPrice\": false,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"442173c5-a469-43b6-8ade-3a0d0370b995"},{"name":"Prices","id":"e84cecaf-a084-4f3e-8664-5af86699055a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/prices","description":"

Search prices in ERP

(sapBusinessOne=ITM1, totvsProtheus=DA1)

The prices search allows you to filter the ERP by:

List Search: by priceListKey or brand or itemType or itemGroup {optional}
Unitary Search: by productKey or codeBars

If no field for unitary search (productKey or codeBars) is informed in the request, the search will return the price of all valid products. The list search can be filtered by priceListKey or by brand or by itemType or by itemGroup.

PriceList:

SAP Business One: ITM1.PriceList=OPLN.LineNum. The service does not treat Special Prices (OSPP), Special Prices for Groups (OSPG), Interest Prices (OIRT).
TOTVS Protheus: DA1_CODTAB=DA0_CODTAB

Comments:

Item Type: [1] SAP Business One: OITM.MatType (table OMTP), [2] TOTVS Protheus: B1_TIPO (table SX5/02 - ToDo)
Item Group: [1] SAP Business One: OITM.ItmsGrpCod (table OITB), [2] TOTVS Protheus: B1_GRUPO (table SBM - ToDo)
Brand (or Manufacturer): [1] SAP Business One: OITM.FirmCode (table OMRC), [2] TOTVS Protheus: B1_FABRIC

The prices service will consider as valid price:

SAP Business One:
TOTVS Protheus: [1] active (DA1_ATIVO=1), [2] initial validity (DA1_DATVIG<=dDataBase)

The prices service will consider as valid priceList:

SAP Business One: [1] Valid (OPLN.validFor = Y)
TOTVS Protheus: [1] active (DA0_ATIVO=1), [2] initial validity (DA0_DATDE<=dDataBase)

The prices service will consider as valid products:

SAP Business One: [1] Sale Item (OITM.SellItem = Y), [2] Valid and not canceled (OITM.validFor = Y AND OITM.Canceled = N)
TOTVS Protheus: [1] active product (B1_MSBLQL other than 1)

If priceListKey is not informed, the price in all priceLists will be searched.

For list search, the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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

The response will inform:

The number of returned objects in the count field

This service will allow you to search the list in two situations:

Full Search: will result in all items with the price, optionally by priceList.
Incremental Search: will result in all objects with changes after a certain date / time provided in the request, with a balance greater than or equal to zero. In the Incremental Consultation, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which stocks should be returned. This information will be used in conjunction with: [1] SAP Business One: the fields Creation Date and Creation Time of the transaction table in SAP Business One (OITM.CreateDate+OITM.CreateTS and OITM.UpdateDate+OITM.UpdateTS), [2] TOTVS Protheus: not implemented

This service does not have user field (UDF) treatment.

Observation: products/GET service can consider two prices in response:

price = normal price (API Setup > GP PriceList or IGT_PRICEL)
pricePromo = promotional price (API Setup > GP PriceListPromo or IGT_PRICELP)

PriceList Primary Key in ERP (optional - list search)

\n","type":"text/plain"},"key":"priceListKey","value":"2"},{"disabled":true,"description":{"content":"

Type of products (optional in list search)

\n","type":"text/plain"},"key":"itemType","value":"4"},{"disabled":true,"description":{"content":"

Group of products (optional in list search)

\n","type":"text/plain"},"key":"itemGroup","value":"103"},{"disabled":true,"description":{"content":"

Brand of products (optional in list search)

\n","type":"text/plain"},"key":"brand","value":"1"},{"disabled":true,"description":{"content":"

Product Primary Key in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"erpKey","value":"PA00773"},{"disabled":true,"description":{"content":"

Product Code Bars in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"codeBars","value":"I004"},{"disabled":true,"description":{"content":"

Number of page - pagination (optional)

\n","type":"text/plain"},"key":"pageNum","value":"2"},{"disabled":true,"description":{"content":"

Date do filter modified registers - incremental search (optional)

\n","type":"text/plain"},"key":"updatedAt","value":"2020-08-04T00:00:00"}],"variable":[]}},"response":[{"id":"fb440841-4a06-4b77-a4bb-7c8d82efd403","name":"Prices - SAP Business One (v2.0.7)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/prices?itemType=4&itemGroup=103","host":["{{endpoint}}"],"path":["prices"],"query":[{"key":"priceListKey","value":"2","description":"PriceList Primary Key in ERP (optional - list search)","disabled":true},{"key":"itemType","value":"4","description":"Type of products (optional in list search)"},{"key":"itemGroup","value":"103","description":"Group of products (optional in list search)"},{"key":"brand","value":"1","description":"Brand of products (optional in list search)","disabled":true},{"key":"productKey","value":"I005","description":"Product Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"codeBars","value":"I004","description":"Product Code Bars in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-08-04T00: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":"Sat, 20 Feb 2021 01:43:31 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"Prices\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"prices\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.104\",\n \"effectiveTimestamp\": \"2021-02-19T23:43:28\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 21,\n \"values\": [\n {\n \"productKey\": \"I014\",\n \"codeBars\": \"I014\",\n \"partnumber\": \"\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"1\",\n \"priceListName\": \"Lista de Preço Principal\",\n \"currency\": \"R$\",\n \"price\": 850,\n \"createdAt\": \"2009-06-26T00:00:00\",\n \"updatedAt\": \"2018-09-17T22:07:33\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I014\",\n \"codeBars\": \"I014\",\n \"partnumber\": \"\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"2\",\n \"priceListName\": \"Lista de Preço Varejo\",\n \"currency\": \"R$\",\n \"price\": 2125,\n \"createdAt\": \"2009-06-26T00:00:00\",\n \"updatedAt\": \"2018-09-17T22:07:33\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I014\",\n \"codeBars\": \"I014\",\n \"partnumber\": \"\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"3\",\n \"priceListName\": \"Lista de Preço Corporativo\",\n \"currency\": \"R$\",\n \"price\": 2932.5,\n \"createdAt\": \"2009-06-26T00:00:00\",\n \"updatedAt\": \"2018-09-17T22:07:33\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I015\",\n \"codeBars\": \"I015\",\n \"partnumber\": \"\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"1\",\n \"priceListName\": \"Lista de Preço Principal\",\n \"currency\": \"R$\",\n \"price\": 40,\n \"createdAt\": \"2009-06-26T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I015\",\n \"codeBars\": \"I015\",\n \"partnumber\": \"\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"2\",\n \"priceListName\": \"Lista de Preço Varejo\",\n \"currency\": \"R$\",\n \"price\": 100,\n \"createdAt\": \"2009-06-26T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I015\",\n \"codeBars\": \"I015\",\n \"partnumber\": \"\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"3\",\n \"priceListName\": \"Lista de Preço Corporativo\",\n \"currency\": \"R$\",\n \"price\": 138,\n \"createdAt\": \"2009-06-26T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I017\",\n \"codeBars\": \"I017\",\n \"partnumber\": \"I014\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"1\",\n \"priceListName\": \"Lista de Preço Principal\",\n \"currency\": \"R$\",\n \"price\": 149.9,\n \"createdAt\": \"2009-06-26T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I017\",\n \"codeBars\": \"I017\",\n \"partnumber\": \"I014\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"2\",\n \"priceListName\": \"Lista de Preço Varejo\",\n \"currency\": \"R$\",\n \"price\": 374.75,\n \"createdAt\": \"2009-06-26T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I017\",\n \"codeBars\": \"I017\",\n \"partnumber\": \"I014\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"3\",\n \"priceListName\": \"Lista de Preço Corporativo\",\n \"currency\": \"R$\",\n \"price\": 151.99,\n \"createdAt\": \"2009-06-26T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I018\",\n \"codeBars\": \"I018\",\n \"partnumber\": \"I014\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"1\",\n \"priceListName\": \"Lista de Preço Principal\",\n \"currency\": \"R$\",\n \"price\": 149.9,\n \"createdAt\": \"2009-06-26T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I018\",\n \"codeBars\": \"I018\",\n \"partnumber\": \"I014\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"2\",\n \"priceListName\": \"Lista de Preço Varejo\",\n \"currency\": \"R$\",\n \"price\": 374.75,\n \"createdAt\": \"2009-06-26T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I018\",\n \"codeBars\": \"I018\",\n \"partnumber\": \"I014\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"3\",\n \"priceListName\": \"Lista de Preço Corporativo\",\n \"currency\": \"R$\",\n \"price\": 179.59,\n \"createdAt\": \"2009-06-26T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I019\",\n \"codeBars\": \"I019\",\n \"partnumber\": \"I015\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"1\",\n \"priceListName\": \"Lista de Preço Principal\",\n \"currency\": \"R$\",\n \"price\": 189.9,\n \"createdAt\": \"2009-06-27T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I019\",\n \"codeBars\": \"I019\",\n \"partnumber\": \"I015\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"2\",\n \"priceListName\": \"Lista de Preço Varejo\",\n \"currency\": \"R$\",\n \"price\": 474.75,\n \"createdAt\": \"2009-06-27T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I019\",\n \"codeBars\": \"I019\",\n \"partnumber\": \"I015\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"3\",\n \"priceListName\": \"Lista de Preço Corporativo\",\n \"currency\": \"R$\",\n \"price\": 262.06,\n \"createdAt\": \"2009-06-27T00:00:00\",\n \"updatedAt\": \"2014-02-05T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I020\",\n \"codeBars\": \"78934354335453\",\n \"partnumber\": \"I014\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"1\",\n \"priceListName\": \"Lista de Preço Principal\",\n \"currency\": \"R$\",\n \"price\": 219.9,\n \"createdAt\": \"2009-06-27T00:00:00\",\n \"updatedAt\": \"2020-01-13T17:45:30\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I020\",\n \"codeBars\": \"78934354335453\",\n \"partnumber\": \"I014\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"2\",\n \"priceListName\": \"Lista de Preço Varejo\",\n \"currency\": \"R$\",\n \"price\": 549.75,\n \"createdAt\": \"2009-06-27T00:00:00\",\n \"updatedAt\": \"2020-01-13T17:45:30\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I020\",\n \"codeBars\": \"78934354335453\",\n \"partnumber\": \"I014\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"3\",\n \"priceListName\": \"Lista de Preço Corporativo\",\n \"currency\": \"R$\",\n \"price\": 185.17,\n \"createdAt\": \"2009-06-27T00:00:00\",\n \"updatedAt\": \"2020-01-13T17:45:30\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I021\",\n \"codeBars\": \"I021\",\n \"partnumber\": \"I015\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"1\",\n \"priceListName\": \"Lista de Preço Principal\",\n \"currency\": \"R$\",\n \"price\": 189.9,\n \"createdAt\": \"2009-06-27T00:00:00\",\n \"updatedAt\": \"2020-01-13T17:46:25\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I021\",\n \"codeBars\": \"I021\",\n \"partnumber\": \"I015\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"2\",\n \"priceListName\": \"Lista de Preço Varejo\",\n \"currency\": \"R$\",\n \"price\": 474.75,\n \"createdAt\": \"2009-06-27T00:00:00\",\n \"updatedAt\": \"2020-01-13T17:46:25\",\n \"canceledAt\": null\n },\n {\n \"productKey\": \"I021\",\n \"codeBars\": \"I021\",\n \"partnumber\": \"I015\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"priceListKey\": \"3\",\n \"priceListName\": \"Lista de Preço Corporativo\",\n \"currency\": \"R$\",\n \"price\": 262.06,\n \"createdAt\": \"2009-06-27T00:00:00\",\n \"updatedAt\": \"2020-01-13T17:46:25\",\n \"canceledAt\": null\n }\n ]\n}"},{"id":"4c47f494-15f7-4415-9071-57f1d7842c5e","name":"Prices - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/prices","host":["{{endpoint}}"],"path":["prices"],"query":[{"key":"priceListKey","value":"2","description":"PriceList Primary Key in ERP (optional - list search)","disabled":true},{"key":"itemType","value":"4","description":"Type of products (optional in list search)","disabled":true},{"key":"itemGroup","value":"103","description":"Group of products (optional in list search)","disabled":true},{"key":"brand","value":"1","description":"Brand of products (optional in list search)","disabled":true},{"key":"productKey","value":"PA00773","description":"Product Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"codeBars","value":"I004","description":"Product Code Bars in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-08-04T00: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\": \"salesAPI\",\n \"process\": \"Prices\",\n \"system\": \"totvsProtheus\",\n \"target\": \"prices\",\n \"user\": \"intergate\",\n \"host\": \"192.168.30.4\",\n \"effectiveTimestamp\": \"2021-09-03T17:13:26\",\n \"code\": \"200\",\n \"success\": true,\n \"useCustom\": true,\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"values\": [\n {\n \"erpKey\": \"PA000001\",\n \"codeBars\": \"\",\n \"itemType\": \"PA-PRODUTO ACABADO\",\n \"itemGroup\": \"5001-PRODUTO ACABADO\",\n \"brand\": \"INTERGATE\",\n \"priceListKey\": \"001\",\n \"priceListName\": \"TABELA GERAL\",\n \"priceType\": \"1\",\n \"currency\": \"R$\",\n \"price\": 60,\n \"createdAt\": \"2020-09-03\",\n \"updatedAt\": \"2021-08-13\",\n \"canceledAt\": null\n }\n ],\n \"count\": 1\n}"}],"_postman_id":"e84cecaf-a084-4f3e-8664-5af86699055a"},{"name":"Stocks","id":"1d70a1df-00c1-4374-ab9d-7bd38444a4dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/stocks?whsCode=01&binCode=001-07&itemType=4&itemGroup=103&brand=2&erpKey=PA00244&codeBars=78968064001054&pageNum=1&updatedAt=2020-01-01T00:00:00&showBatchNumbers=true&showPositiveOnly=true","description":"

Search stocks in ERP

(sapBusinessOne=OITW-OIBQ, totvsProtheus=SB2-x)

The inventory search allows you to filter the ERP by:

List Search: by itemType or itemGroup or brand or whsCode or binCode {optional only for sapBusinessOne}
Unitary Search: by erpKey or codeBars

If no field for unitary search (erpKey or codeBars) is informed in the request, the search will return the stock of all valid products. The list search can be filtered by itemType or itemGroup or brand or whsCode or binCode (only sapBusinessOne).

Fields in response:

erpKey, codeBars, partNumber (if UdfPartNumber is enabled in API Setup)
whsCode, binCode (if UseBin is enabled in API Setup - only sapBusinessOne)
stock (quantity), stockValue (currency), availableStock
batchNumbers: array of batch numbers with stock (if showBatchNumbers=true and product has batch stock control)

Comments:

Item Type: [1] SAP Business One: OITM.MatType (table OMTP), [2] TOTVS Protheus: B1_TIPO (table SX5/02 - ToDo)
Item Group: [1] SAP Business One: OITM.ItmsGrpCod (table OITB), [2] TOTVS Protheus: B1_GRUPO (table SBM - ToDo)
brand (or Manufacturer): [1] SAP Business One: OITM.FirmCode (table OMRC), [2] TOTVS Protheus: B1_FABRIC
showPositiveOnly: if true the response will show only positive stocks (default=false)
showBatchNumbers: if true the response will show the batchNumbers array for each stock register (default=false)

The stocks service will consider as valid products:

SAP Business One: [1] Sale Item (OITM.SellItem = Y), [2] Valid and not canceled (OITM.validFor = Y AND OITM.Canceled = N)
TOTVS Protheus: [1] active product (B1_MSBLQL other than 1)

If whsCode is not informed, the stock in all warehouses will be searched. If binCode is not informed, the stock in all bin locations will be searched (if UseBin=true in API Setup).

Treatment for batchNumbers {only SAP Business One}:

If showBatchNumbers is not informed or not true, only total stock is returned.
To show batch numbers details, do the request with showBatchNumbers=true.

Treatment for availableStock:

SAP Business One: [1] OITW.OnHand - SUM (PKL1.RelQtty + PKL1.PickQtty linked with RDR1 and WTQ1). [2] OIBQ.OnHandQty - SUM (PKL1.RelQtty + PKL1.PickQtty linked with RDR1 and WTQ1), [3] Batch Numbers: OIBT.Quantity-OIBT.IsCommited
TOTVS Protheus: According to parameter MV_TPSALDO, TOTVS documentation at https://centraldeatendimento.totvs.com/hc/pt-br/articles/360013215531-MP-SIGAEST-Utilização-do-parâmetro-SX6-MV-TPSALDO

For list search, the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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

The response will inform:

The number of returned objects in the count field

This service will allow you to search the stocks list in two situations:

Full Search: will result in all items with an inventory balance greater than zero, optionally by brand and by warehouse.
Incremental Search: will result in all items that had inventory movements after a certain date / time provided in the request, with a balance greater than or equal to zero. In the Incremental Consultation, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which stocks should be returned. This information will be used in conjunction with: [1] SAP Business One: the fields Creation Date and Creation Time of the transaction table in SAP Business One (OIVL.CreateDate and OIVL.CreateTime), [2] TOTVS Protheus: not implemented

For use of user fields (UDF) created in the product table (SAPB1: -, TOTVS: SB2) the respective registration must be performed in the Custom Table.

Wharehouse code (optional in list and unitary search)

\n","type":"text/plain"},"key":"whsCode","value":"01"},{"description":{"content":"

Bin Location code (optional in list and unitary search)

\n","type":"text/plain"},"key":"binCode","value":"001-07"},{"description":{"content":"

Type of products (optional in list search)

\n","type":"text/plain"},"key":"itemType","value":"4"},{"description":{"content":"

Group of products (optional in list search)

\n","type":"text/plain"},"key":"itemGroup","value":"103"},{"description":{"content":"

Brand of products (optional in list search)

\n","type":"text/plain"},"key":"brand","value":"2"},{"description":{"content":"

Product Primary Key in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"erpKey","value":"PA00244"},{"description":{"content":"

Product Code Bars in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"codeBars","value":"78968064001054"},{"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-01T00:00:00"},{"description":{"content":"

Show details by batch numbers? true to show (optional)

\n","type":"text/plain"},"key":"showBatchNumbers","value":"true"},{"description":{"content":"

Show only positive stocks? true to show only positive (optional)

\n","type":"text/plain"},"key":"showPositiveOnly","value":"true"}],"variable":[]}},"response":[{"id":"471edfaf-110f-4dcc-b1a9-bbf33821a92a","name":"Stocks - SAP Business One (v2.0.7)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/stocks?itemType=4&itemGroup=103","host":["{{endpoint}}"],"path":["stocks"],"query":[{"key":"whsCode","value":"01","description":"Wharehouse code (optional in list and unitary search)","disabled":true},{"key":"binCode","value":"001-07","description":"Bin Location code (optional in list and unitary search)","disabled":true},{"key":"itemType","value":"4","description":"Type of products (optional in list search)"},{"key":"itemGroup","value":"103","description":"Group of products (optional in list search)"},{"key":"brand","value":"2","description":"Brand of products (optional in list search)","disabled":true},{"key":"erpKey","value":"PA00244","description":"Product Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"codeBars","value":"78968064001054","description":"Product Code Bars in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"1","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-01T00:00:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true},{"key":"showBatchNumbers","value":"true","description":"Show details by batch numbers? true to show (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":"Sat, 20 Feb 2021 18:18:18 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"Stocks\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"stocks\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.104\",\n \"effectiveTimestamp\": \"2021-02-20T16:18:13\",\n \"useBin\": \"false\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 8,\n \"values\": [\n {\n \"erpKey\": \"I014\",\n \"codeBars\": \"I014\",\n \"partnumber\": \"\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"whsCode\": \"05\",\n \"stock\": 10,\n \"stockValue\": 21250,\n \"availableStock\": 10,\n \"createdAt\": \"2018-09-17T22:09:00\",\n \"updatedAt\": \"2018-09-17T22:09:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"I015\",\n \"codeBars\": \"I015\",\n \"partnumber\": \"\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"whsCode\": \"02\",\n \"stock\": 81,\n \"stockValue\": 4330.69,\n \"availableStock\": 81,\n \"createdAt\": \"2009-06-27T05:33:00\",\n \"updatedAt\": \"2015-03-26T15:19:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"I015\",\n \"codeBars\": \"I015\",\n \"partnumber\": \"\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"whsCode\": \"05\",\n \"stock\": 20,\n \"stockValue\": 2000,\n \"availableStock\": 20,\n \"createdAt\": \"2018-09-17T22:09:00\",\n \"updatedAt\": \"2018-09-17T22:09:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"I017\",\n \"codeBars\": \"I017\",\n \"partnumber\": \"I014\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"whsCode\": \"01\",\n \"stock\": 491,\n \"stockValue\": 70415.33,\n \"availableStock\": 489,\n \"createdAt\": \"2009-06-27T05:30:00\",\n \"updatedAt\": \"2018-06-13T15:28:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"I018\",\n \"codeBars\": \"I018\",\n \"partnumber\": \"I014\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"whsCode\": \"01\",\n \"stock\": 117,\n \"stockValue\": 16663.15,\n \"availableStock\": 115,\n \"createdAt\": \"2009-06-27T05:30:00\",\n \"updatedAt\": \"2018-06-13T15:28:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"I019\",\n \"codeBars\": \"I019\",\n \"partnumber\": \"I015\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"whsCode\": \"01\",\n \"stock\": 189,\n \"stockValue\": 36827.69,\n \"availableStock\": 189,\n \"createdAt\": \"2009-06-27T05:30:00\",\n \"updatedAt\": \"2020-01-24T15:33:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"I020\",\n \"codeBars\": \"78934354335453\",\n \"partnumber\": \"I014\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"whsCode\": \"01\",\n \"stock\": 1739,\n \"stockValue\": 373644.41,\n \"availableStock\": 1739,\n \"createdAt\": \"2009-06-27T05:30:00\",\n \"updatedAt\": \"2014-06-11T07:48:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"I021\",\n \"codeBars\": \"I021\",\n \"partnumber\": \"I015\",\n \"itemType\": \"4-Produtos acabados\",\n \"itemGroup\": \"103-Serviços\",\n \"whsCode\": \"01\",\n \"stock\": 265,\n \"stockValue\": 49477.7,\n \"availableStock\": 265,\n \"createdAt\": \"2009-06-27T05:35:00\",\n \"updatedAt\": \"2020-02-05T12:39:00\",\n \"canceledAt\": null\n }\n ]\n}"},{"id":"98a6ac2b-d675-4876-9ab1-c476870d0b44","name":"Stocks - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/stocks","host":["{{endpoint}}"],"path":["stocks"],"query":[{"key":"whsCode","value":"01","description":"Wharehouse code (optional in list and unitary search)","disabled":true},{"key":"binCode","value":"001-07","description":"Bin Location code (optional in list and unitary search)","disabled":true},{"key":"itemType","value":"4","description":"Type of products (optional in list search)","disabled":true},{"key":"itemGroup","value":"103","description":"Group of products (optional in list search)","disabled":true},{"key":"brand","value":"2","description":"Brand of products (optional in list search)","disabled":true},{"key":"erpKey","value":"PA00244","description":"Product Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"codeBars","value":"78968064001054","description":"Product Code Bars in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"1","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-01T00:00:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true},{"key":"showBatchNumbers","value":"true","description":"Show details by batch numbers? true to show (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\": \"salesAPI\",\n \"process\": \"Stocks\",\n \"system\": \"totvsProtheus\",\n \"target\": \"stocks\",\n \"user\": \"intergate\",\n \"host\": \"192.168.30.4\",\n \"effectiveTimestamp\": \"2021-09-03T17:11:04\",\n \"code\": \"200\",\n \"success\": true,\n \"useCustom\": true,\n \"usePartnumber\": false,\n \"useBin\": false,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"values\": [\n {\n \"erpKey\": \"MC000001\",\n \"codeBars\": \"\",\n \"itemType\": \"MC-MATERIAL DE CONSUMO\",\n \"itemGroup\": \"-\",\n \"brand\": \"\",\n \"branch\": \"01\",\n \"whsCode\": \"01\",\n \"stock\": 0,\n \"stockValue\": 0,\n \"availableStock\": 0,\n \"createdAt\": null,\n \"updatedAt\": \"2021-08-18\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"MC000002\",\n \"codeBars\": \"\",\n \"itemType\": \"MC-MATERIAL DE CONSUMO\",\n \"itemGroup\": \"-\",\n \"brand\": \"\",\n \"branch\": \"01\",\n \"whsCode\": \"01\",\n \"stock\": 0,\n \"stockValue\": 0,\n \"availableStock\": 0,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"MC000003\",\n \"codeBars\": \"\",\n \"itemType\": \"MC-MATERIAL DE CONSUMO\",\n \"itemGroup\": \"-\",\n \"brand\": \"\",\n \"branch\": \"01\",\n \"whsCode\": \"01\",\n \"stock\": 601,\n \"stockValue\": 52905.6,\n \"availableStock\": 601,\n \"createdAt\": null,\n \"updatedAt\": \"2021-08-18\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"MP000001\",\n \"codeBars\": \"\",\n \"itemType\": \"MP-MATERIA PRIMA\",\n \"itemGroup\": \"1001-MATERIA PRIMA\",\n \"brand\": \"\",\n \"branch\": \"01\",\n \"whsCode\": \"01\",\n \"stock\": 890,\n \"stockValue\": 89,\n \"availableStock\": 890,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"MP000002\",\n \"codeBars\": \"\",\n \"itemType\": \"MP-MATERIA PRIMA\",\n \"itemGroup\": \"-\",\n \"brand\": \"\",\n \"branch\": \"01\",\n \"whsCode\": \"01\",\n \"stock\": -90,\n \"stockValue\": 1,\n \"availableStock\": 0,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"PA000001\",\n \"codeBars\": \"\",\n \"itemType\": \"PA-PRODUTO ACABADO\",\n \"itemGroup\": \"5001-PRODUTO ACABADO\",\n \"brand\": \"INTERGATE\",\n \"branch\": \"01\",\n \"whsCode\": \"01\",\n \"stock\": 198,\n \"stockValue\": 999.9,\n \"availableStock\": 198,\n \"createdAt\": null,\n \"updatedAt\": \"2021-08-13\",\n \"canceledAt\": null\n }\n ],\n \"count\": 6\n}"}],"_postman_id":"1d70a1df-00c1-4374-ab9d-7bd38444a4dc"}],"id":"e2aa7972-1831-4028-a265-4e0aa871448a","_postman_id":"e2aa7972-1831-4028-a265-4e0aa871448a","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"11834bc6-bff3-4272-b68a-24430df885aa","id":"11834bc6-bff3-4272-b68a-24430df885aa","name":"salesAPI - Sales API for ERP (v2)","type":"collection"}}},{"name":"Partners","item":[{"name":"Partners","id":"2dfe5b34-599b-4f29-aff5-29839ef3a853","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/partners?type=S&taxType=P&sellerKey=000001&erpKey=C001&taxNumber=89175174987&pageNum=1&updatedAt=2020-01-30T15:00:00","description":"

Search partners in ERP

(sapBusinessOne=2/OCRD, totvsProtheus=SA1|SA2|SUS)

The search of partners allows filtering the ERP by:

List Search: by type (C = customer, S = supplier, L = lead) {required}, by taxType (C = company, P = person, G = government, E = employee) or sellerKey {optional}
Unitary Search: by erpKey or taxNumber (with or without punctuation)

If no fields for unitary search (erpKey or taxNumber) are informed in the request, the partner search is performed by type (which becomes required), and it is also possible to filter partners by taxType and/or sellerKey.

The partners service will consider partners:

SAP Business One: Valid and not canceled (OCRD.validFor = Y AND OCRD.Canceled = N)
TOTVS Protheus: Active (A1_MSBLQL other than 1)

Comments:

type: SAP Business One (OCRD.CardType), TOTVS Protheus (tables SA1, SA2 and SUS)
taxType: SAP Business One (CRD7.TaxId0 or CRD7.TaxId4), TOTVS Protheus (A1_PESSOA + A1_TPESSOA=EP)
sellerKey: SAP Business One (OCRD.SlpCode), TOTVS Protheus (A1_VEND)
erpKey: SAP Business One (OCRD.CardCode), TOTVS Protheus (A1_COD+'_'+A1_LOJA)
taxNumber: SAP Business One (CRD7.TaxId0 or CRD7.TaxId4), TOTVS Protheus (A1_CGC)
balanceValue and openOrdersValue: for TOTVS Protheus refer https://tdn.totvs.com/pages/releaseview.action?pageId=253989073

For list search, the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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

The response will inform:

The number of returned objects in the count field

This service will allow you to search partners list in two situations:

Full Search: will result in all partners, according to filters.
Incremental Search: will result in all partners, according to filters, that have been included and/or changed in the main register after a certain date / time provided in the request. In the Incremental Consultation, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which partners should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields of the Business Partner record in SAP Business One (OCRD.CreateDate, OCRD.UpdateDate, OCRD.CreateTS, OCRD.UpdateTS), [2] TOTVS Protheus: the fields A1_USERLGI and A1_USERLGA, A2_USERLGI and A2_USERLGA, US_USERLGI and US_USERLGA

For the use of user fields (UDF) created in the partner table (SAPB1: OCRD, TOTVS: SA1, SA2, SUS), the respective registration must be performed in the Custom Table.

Partner Type: C=customer, S=supplier, L=lead (required if not unitary search)

\n","type":"text/plain"},"key":"type","value":"S"},{"description":{"content":"

Partner Tax Type: P=person, C=company, G=government, E=employer (optional in list search)

\n","type":"text/plain"},"key":"taxType","value":"P"},{"description":{"content":"

Seller Primary Key in ERP (optional in list search)

\n","type":"text/plain"},"key":"sellerKey","value":"000001"},{"description":{"content":"

Partner Primary Key in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"erpKey","value":"C001"},{"description":{"content":"

Partner Tax Number (optional - unitary search)

\n","type":"text/plain"},"key":"taxNumber","value":"89175174987"},{"description":{"content":"

Number of page - pagination (optional)

\n","type":"text/plain"},"key":"pageNum","value":"1"},{"description":{"content":"

Date do filter modified register - incremental search (optional)

\n","type":"text/plain"},"key":"updatedAt","value":"2020-01-30T15:00:00"}],"variable":[]}},"response":[{"id":"87366df2-acad-4f25-b34c-2e41fa12dc8f","name":"partners","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/partners?erpKey=C001","host":["{{endpoint}}"],"path":["partners"],"query":[{"key":"erpKey","value":"C001","description":"Primary Key in ERP (optional)"},{"description":"Tax number (optional)","key":"taxNumber","value":"89175174987","disabled":true},{"key":"type","value":"C","description":"Partner type: C=customer, S=supplier, L=lead","disabled":true},{"key":"taxType","value":"P","description":"Partner tax type: P=person, C=company, G=government, E=employer","disabled":true},{"description":"Number of page - pagination (optional)","key":"pageNum","value":"1","disabled":true},{"key":"updatedAt","value":"2020-01-30T15:00:00","description":"Date do filter modified register - incremental query (optional)","disabled":true},{"key":"action","value":"partners","disabled":true},{"key":"sellerKey","value":null,"description":"Seller Primary Key in ERP (optional in list search)","type":"text","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, 30 Jan 2020 18:15:21 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"b2cAPI\",\n \"process\": \"Partners\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"partners\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.104\",\n \"effectiveTimestamp\": \"2020-01-30T15:15:20\",\n \"erpKey\": \"C001\",\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 \"erpKey\": \"C001\",\n \"type\": \"C\",\n \"taxType\": \"C\",\n \"fullName\": \"Sport Club Corinthians Paulista\",\n \"aliasName\": \"Timão\",\n \"email\": \"campeão@corinthians.com.br\",\n \"phone\": \"2095-3000\",\n \"phoneSecondary\": \"11\",\n \"cellular\": \"11-9595-2001\",\n \"taxNumber\": \"61.902.722/0001-26\",\n \"stateTaxNumber\": \"113.440.120.113\",\n \"cityTaxNumber\": \"\",\n \"contactPerson\": \"Andrés Navarro Sanchez\",\n \"sellerKey\": \"\",\n \"createdAt\": \"2009-06-27T00:00:00\",\n \"updatedAt\": \"2020-01-16T18:53:19\",\n \"canceledAt\": null,\n \"billingAddress\": {\n \"streetType\": \"Rua\",\n \"address1\": \"São Jorge\",\n \"exteriorNumber\": \"777\",\n \"address2\": \"\",\n \"community\": \"Tatuapé\",\n \"city\": \"São Paulo\",\n \"county\": \"5344\",\n \"stateCode\": \"SP\",\n \"countryCode\": \"BR\",\n \"postalCode\": \"03087-000\"\n },\n \"shippingAddress\": {\n \"streetType\": \"Rua\",\n \"address1\": \"São Jorge 2\",\n \"exteriorNumber\": \"777\",\n \"address2\": \"\",\n \"community\": \"Tatuapé\",\n \"city\": \"São Paulo\",\n \"county\": \"5344\",\n \"stateCode\": \"SP\",\n \"countryCode\": \"BR\",\n \"postalCode\": \"03087-000\"\n }\n }\n ]\n}"}],"_postman_id":"2dfe5b34-599b-4f29-aff5-29839ef3a853"},{"name":"Partner","id":"4b2e166a-f44e-4981-8270-dc92aea05db7","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\"type\": \"C\",\r\n\t\"taxType\": \"C\",\r\n\t\"partnerId\": \"C001\",\r\n\t\"fullName\": \"Sport Club Corinthians Paulista\",\r\n\t\"aliasName\": \"Timão\",\r\n\t\"email\": \"campeão@corinthians.com.br\",\r\n\t\"phone\": \"2095-3000\",\r\n\t\"phoneSecondary\": \"11\",\r\n \"cellular\": \"11-9595-2001\",\r\n\t\"taxNumber\": \"61.902.722/0001-26\",\r\n\t\"stateTaxNumber\": \"113.440.120.113\",\r\n\t\"cityTaxNumber\": \"\",\r\n \"inssTaxNumber\": \"0000\",\r\n \"paymentCondition\": \"46\",\r\n\t\"billingAddress\": {\r\n\t\t\"address1\": \"São Jorge\",\r\n\t\t\"address2\": \"\",\r\n\t\t\"city\": \"São Paulo\",\r\n\t\t\"postalCode\": \"03087-000\",\r\n\t\t\"stateCode\": \"SP\",\r\n\t\t\"community\": \"Tatuapé\",\r\n\t\t\"exteriorNumber\": \"777\",\r\n\t\t\"streetType\": \"Rua\",\r\n\t\t\"countryCode\": \"BR\"\r\n\t},\r\n\t\"shippingAddress\": {\r\n\t\t\"address1\": \"São Jorge 2\",\r\n\t\t\"address2\": \"\",\r\n\t\t\"city\": \"São Paulo\",\r\n\t\t\"postalCode\": \"03087-000\",\r\n\t\t\"stateCode\": \"SP\",\r\n\t\t\"community\": \"Tatuapé\",\r\n\t\t\"exteriorNumber\": \"777\",\r\n\t\t\"streetType\": \"Rua\",\r\n\t\t\"countryCode\": \"BR\"\r\n\t},\r\n \"bankData\": {\r\n \"bankCountry\": \"BR\",\r\n \"bankName\": \"Itau\",\r\n \"bankCode\": \"341\",\r\n \"bankBranch\": \"0134\",\r\n \"bankAccount\": \"08254\",\r\n \"bankBranchKey\": \"\",\r\n \"bankAccountKey\": \"1\"\r\n }\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/partners","description":"

Insert/update partner in ERP

(sapBusinessOne=2/OCRD, totvsProtheus=SA1|SA2|SUS)

This service will allow to insert a new partner in the ERP, or to update an existing partner.

Partners are classified in the ERP as:

type: C = customer, S = supplier, L = lead
taxType: P = person, C = company, G = government, E = employee

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 included in the ERP.

SAP Business One: CRD7.TaxId0 (company/government) or CRD7.TaxId4 (person/employee)
TOTVS Protheus: A1_CGC (customer) or A2_CGC (supplier) or US_CGC (lead)

sellerKey:

SAP BusinessOne: sellerKey=OCRD.SlpCode (OSLP)
TOTVS Protheus: sellerKey=A1_VEND (SA3)

phone/phoneSecundary/cellular (format recommended: +XXYYNNNNNNNNN):

SAP BusinessOne: OCRD.Phone1/OCRD.Phone2/OCRD.Cellular
TOTVS Protheus: A1_FONE/A1_FAX/not used (note.: the value informed in field phoneis splitted in fields A1_DDI/A1_DDD/A1_FONE)

Adresses:

shippingAddress and billingAddress: shipping and billing address are required blocks
SAP Business One: Each PN will have 2 registered addresses (CRD1, CRD7), namely: [1] ShipToCode (S) = /fullName, [2] BillToCode (B) = /fullName. Each PN will have 3 tax identification numbers (CRD12), namely: ShipToCode, BillToCode, empty
TOTVS Protheus: Standard address fields and delivery address fields will be used. The Billing fields (only on recording) and Delivery Client will not be used.

bankData:

partner bank data is optional

Request object has the following properties

Field	Type	Description
type *	string	Type of partner (C=customer, S=supplier, L=lead)
taxType *	string	Tax Type of partner (P=person, C=company, G=government, E=employee)
partnerId	string	ID Partner
fullName *	string	Partner full name
aliasName	string	Partner alias name
email	string	Email
phone	string	Phone number (try to use in format +XXYYPPPPPPPP)
phoneSecondary	string	Secondary phone number (try to use in format +XXYYPPPPPPPP)
cellular	string	Cellular number (try to use in format +XXYYPPPPPPPP - SAPB1 only)
taxNumber *	string	Partner Tax Number
stateTaxNumber	string	State Tax Number
cityTaxNumber	string	City Tax Number
inssTaxNumber	string	INSS Tax Number {new}
sellerKey	string	Seller Primary Key in ERP
paymentCondition	string	Payment Condition Key {new}
paymentMethod	string	Payment Method Key {new}
billingAddress *	object	Billing Address
billingAddress.fullName	string	Full address name (example: BILLING or COBRANCA)
billingAddress.adress1 *	string	First address
billingAddress.adress2	string	Second address
billingAddress.city *	string	City
billingAddress.postalCode *	string	Postal Code
billingAddress.stateCode *	string	State Code
billingAddress.countryCode	string	Country Code (example: BR)
billingAddress.community	string	Community
billingAddress.county	string	City County
billingAddress.exteriorNumber	string	Exterior number
billingAddress.streetType	string	Street type
shippingAddress	object	Shipping Address
shippingAddress.fullName	string	Full address name (example: SHIPPING or ENTREGA)
shippingAddress.adress1 *	string	First address
shippingAddress.adress2	string	Second address
shippingAddress.city *	string	City
shippingAddress.postalCode *	string	Postal Code
shippingAddress.stateCode *	string	State Code
shippingAddress.countryCode	string	Country Code
shippingAddress.community	string	Community
shippingAddress.county	string	County
shippingAddress.exteriorNumber	string	Exterior Number
shippingAddress.streetType	string	Street type
bankData.bankCountry	string	Bank Country (ex: BR) {new}
bankData.bankName	string	Bank Name {new}
bankData.bankCode	string	Bank Code {new}
bankData.bankBranch	string	Bank Branch {new}
bankData.bankAccount	string	Bank Account {new}
bankData.bankBranchKey	string	Bank Branch Key {new}
bankData.bankAccountKey	string	Bank Account Key {new}
* = Required field

Response object has the following properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
package	string	API Package
process	string	API Process
system	string	ERP System
target	string	API Target
user	string	User of request
host	string	Host of request
effectiveTimestamp	string	Effective Timestamp of processing
code	string	Return Code (200, 400, 401, 403, 404, 500, ...)
success	booleano	Success in processing? (true/false)
values	array	Values resulting of processing
values.Object	string	Object in ERP
values.Table	string	Table in ERP
values.Action	string	Action (insert, update, ...)
values.DocEntry	string	Primary Key in ERP

Search contacts in ERP

(sapBusinessOne=11/OCPR, totvsProtheus=SU5)

The search of contacts allows filtering the ERP by:

List Search: by partnerKey or partnerType (C = customer, S = supplier, L = lead) {optional}
Unitary Search: by erpKey

If no fields for unitary search (erpKey) are informed in the request, the partner search is performed by partnerKey or partnerType.

The contacts service will consider contacts:

SAP Business One: Active (OCPR.Active=Y)
TOTVS Protheus: Active (SU5.U5_MSBLQL!='1')

Comments:

partnerKey: SAP Business One (OCPR.CardCode), TOTVS Protheus (AC8.AC8_CODENT)
partnerType: SAP Business One (OCRD.CardType), TOTVS Protheus (AC8.AC8_ENTIDA)
erpKey: SAP Business One (OCPR.CntctCode), TOTVS Protheus (SU5.U5_CODCONT)

For list search, the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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

The response will inform:

The number of returned objects in the count field

This service will allow you to search partners list in two situations:

Full Search: will result in all partners, according to filters.
Incremental Search: will result in all partners, according to filters, that have been included and/or changed in the main register after a certain date / time provided in the request. In the Incremental Consultation, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which partners should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields of the Business Partner record in SAP Business One (OCRD.CreateDate, OCRD.UpdateDate, OCRD.CreateTS, OCRD.UpdateTS), [2] TOTVS Protheus: the fields _USERLGI and _USERLGA in table SU5

For the use of user fields (UDF) created in the partner table (SAPB1: OCPR, TOTVS: SU5), the respective registration must be performed in the Custom Table.

Partner Type: C=customer, S=supplier, L=lead (optional in list search)

\n","type":"text/plain"},"key":"partnerType","value":"C"},{"description":{"content":"

Partner Primary Key in ERP (optional in list search)

\n","type":"text/plain"},"key":"partnerKey","value":"C001"},{"description":{"content":"

Contact Primary Key in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"erpKey","value":"1"},{"description":{"content":"

Number of page - pagination (optional)

\n","type":"text/plain"},"key":"pageNum","value":"1"},{"description":{"content":"

Date do filter modified register - incremental search (optional)

\n","type":"text/plain"},"key":"updatedAt","value":"2010-01-30T15:00:00"}],"variable":[]}},"response":[{"id":"c07753f6-2295-4cb7-b9c4-97bfc0fb7686","name":"Contacts - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/contacts","host":["{{endpoint}}"],"path":["contacts"],"query":[{"key":"partnerKey","value":"C001","description":"Partner Primary Key in ERP (optional in list search)","disabled":true},{"key":"partnerType","value":"C","description":"Partner Type: C=customer, S=supplier, L=lead (optional in list search)","disabled":true},{"key":"erpKey","value":"1","description":"Contact Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"1","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-30T15:00:00","description":"Date do filter modified register - 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":"Sat, 27 Mar 2021 14:21:27 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"Contacts\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"contacts\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.104\",\n \"effectiveTimestamp\": \"2021-03-27T11:21:24\",\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 \"erpKey\": \"1\",\n \"fullName\": \"Roseli Gouvêa\",\n \"email\": \"roseli@adidas.com.br\",\n \"phone\": \"5503-1234\",\n \"phoneSecondary\": \"11\",\n \"cellular\": \"8972-3218\",\n \"partnerKey\": \"F001\",\n \"partnerType\": \"S\",\n \"blockComm\": \"N\",\n \"createdAt\": null,\n \"updatedAt\": \"2009-06-27T00:40:00\",\n \"canceledAt\": null\n }\n ]\n}"},{"id":"ac533efd-d376-4f8d-a721-863da0cf46ff","name":"Contacts - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/contacts","host":["{{endpoint}}"],"path":["contacts"],"query":[{"key":"partnerType","value":"C","description":"Partner Type: C=customer, S=supplier, L=lead (optional in list search)","disabled":true},{"key":"partnerKey","value":"C001","description":"Partner Primary Key in ERP (optional in list search)","disabled":true},{"key":"erpKey","value":"1","description":"Contact Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"1","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2010-01-30T15:00:00","description":"Date do filter modified register - 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\": \"salesAPI\",\n \"process\": \"Contacts\",\n \"system\": \"totvsProtheus\",\n \"target\": \"contacts\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.104\",\n \"effectiveTimestamp\": \"2021-04-23T19:29:50\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"values\": [\n {\n \"erpKey\": \"000001\",\n \"fullName\": \"RAFAEL OGEDA\",\n \"email\": \"rafael.ogeda@intergate.net.br\",\n \"phone\": \"\",\n \"phoneSecundary\": \"\",\n \"cellular\": \"\",\n \"partnerKey\": \"000015_01\",\n \"partnerType\": \"C\",\n \"blockComm\": \"N\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ],\n \"count\": 1\n}"}],"_postman_id":"eaa6b28e-6394-4c2c-97e0-701a5724c588"}],"id":"2134e516-8bc3-4684-977c-9df590466659","_postman_id":"2134e516-8bc3-4684-977c-9df590466659","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"11834bc6-bff3-4272-b68a-24430df885aa","id":"11834bc6-bff3-4272-b68a-24430df885aa","name":"salesAPI - Sales API for ERP (v2)","type":"collection"}}},{"name":"Sellers","item":[{"name":"Sale Agents","id":"aa47a6ca-4572-4692-a305-47c55de05e2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/saleAgents?erpKey=Intergate","description":"

Search salesAgents in ERP

(sapBusinessOne=177/OAGP, totvsProtheus=ADK)

The search of salesAgents (PROTHEUS=Business Units) allows you to filter the ERP by:

List Search
Unitary Search: by erpKey

If no field for unitary query (erpKey) is informed in the request, the search returns as a list.

The salesAgents service will consider as valid salesAgent:

SAP Business One: [1] Not blocked: OAGP.Locked NOT Y
TOTVS Protheus: [1] Not blocked: ADK_MSBLQL NOT 1

The response will inform:

The number of returned objects in the count field

This service does not have pagination or incremental treatment.

This service does not have user field (UDF) treatment.

SalesAgent Primary Key in ERP (optional)

\n","type":"text/plain"},"key":"erpKey","value":"Intergate"}],"variable":[]}},"response":[{"id":"4ebe8d28-8e89-4c8a-b79d-8a7b96710674","name":"Sale Agents - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/saleAgents","host":["{{endpoint}}"],"path":["saleAgents"],"query":[{"key":"erpKey","value":"12","description":"SalesAgent 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=E4B4597094789A6EDAEF22988C02AF40; 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":"Sat, 30 May 2020 14:40:13 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"SaleAgents\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"saleAgents\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.104\",\n \"effectiveTimestamp\": \"2020-05-30T11:40:07\",\n \"code\": \"200\",\n \"success\": true,\n \"count\": 1,\n \"values\": [\n {\n \"erpKey\": \"Intergate\",\n \"name\": \"Intergate\",\n \"memo\": \"Intergate\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"aa47a6ca-4572-4692-a305-47c55de05e2a"},{"name":"Sellers","id":"0f8a8363-6f53-446a-8ed8-d8ddf58c5510","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/sellers?erpKey=12&pageNum=1","description":"

Search sellers in ERP

(sapBusinessOne=53/OSLP, totvsProtheus=SA3)

ATENTION: for TOTVS Protheus use /igt_sellers (conflict with TOTVS standard API)

The search of sellers allows you to filter the ERP by:

List Search
Unitary Search: by erpKey

If no field for unitary query (erpKey) is informed in the request, the seller search is performed as a list.

The sellers service will consider as valid sellers:

SAP Business One: [1] Active and not blocked: OSLP.Active = Y AND OSLP.Locked = N
TOTVS Protheus: [1] Active: A3_MSBLQL other than 1

For list search, the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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

The response will inform:

The number of returned objects in the count field

For the use of user fields (UDF) created in the seller table (SAPB1: OSLP, TOTVS: SA3), the respective registration must be performed in the Custom Table.

Seller Primary Key in ERP (optional)

\n","type":"text/plain"},"key":"erpKey","value":"12"},{"description":{"content":"

Number of page - pagination (optional)

\n","type":"text/plain"},"key":"pageNum","value":"1"}],"variable":[]}},"response":[{"id":"47d6de8f-d55e-4292-9cf0-f8ebe6a4c399","name":"sellers - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/sellers?erpKey=2","host":["{{endpoint}}"],"path":["sellers"],"query":[{"key":"erpKey","value":"2","description":"Seller Primary Key in ERP (optional)"},{"key":"pageNum","value":"1","description":"Number of page - pagination (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":"Mon, 02 Mar 2020 21:42:25 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"Sellers\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"sellers\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.104\",\n \"effectiveTimestamp\": \"2020-03-02T18:42:22\",\n \"erpKey\": \"2\",\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\": \"2\",\n \"fullName\": \"Sócrates Gouvêa\",\n \"email\": \"\",\n \"phone\": \"\",\n \"phoneSecondary\": \"\",\n \"cellular\": \"\",\n \"commissionRate\": 0,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"0f8a8363-6f53-446a-8ed8-d8ddf58c5510"},{"name":"Sellers","id":"cedfa780-ae1b-40a8-bf9a-a83a2f8bd573","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\"erpKey\": \"5\",\r\n\t\"fullName\": \"Rafael Hernandes Ogeda\",\r\n\t\"email\": \"teste@teste.com.br\",\r\n\t\"phone\": \"\",\r\n\t\"phoneSecondary\": \"\",\r\n \"cellular\": \"\",\r\n\t\"commissionRate\": 3.0\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/sellers","description":"

Insert/update seller in ERP

(sapBusinessOne=53/OSLP, totvsProtheus=SA3)

This service will allow to insert a new seller in the ERP.

The key to finding the seller is via erpKey (optional). If erpKey is informed and the seller is located by erpKey, the data is updated, otherwise the new seller is inserted in the ERP.

SAP Business One: OSLP.SlpCode
TOTVS Protheus: A3_CODE

Note: TOTVS Protheus does not allow 2 sellers with the same fullName.

Request object has the following properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
erpKey	string	Erp key
fullName	string	Full name
email	string	email
phone	string	Number phone
phoneSecondary	string	Number phone Secondary
cellular	string	Number cellular
commissionRate	number	Comission rate

* = Required field

Response object has the following properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
package	string	package
process	string	process
system	string	System
target	string	target
user	string	user
host	string	host
effectiveTimestamp	string	Effective Time stamp
code	string	code
success	booleano	Success
useCustom	booleano	Use Custom
values	array	Values

Search sale contracts in ERP

(sapBusinessOne=1250000025/OOAT, totvsProtheus=<>)

This service will allow you to search sale contracts on the ERP.

Searching sales contracts allows you to filter the ERP by:

List search: by createdFrom + createdTo {required}, by partnerKey or docStatus {optional}
Unitary search: by erpKey or orderNum or docNum

If no field for unitary query is provided in the request (erpKey or orderNum or docNum), the query for sale contracts is done by creation date from/to (which become mandatory).

The contracts service will consider sale contracts with:

SAP Business One: OOAT.ObjType = 1250000025 + OOAT.BpType=C
TOTVS Protheus:

Comments:

branch: 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)
orderNum: SAP Business One (OOAT.NumAtCard), TOTVS Protheus (x)
docNum: SAP Business One (OOAT.Number), TOTVS Protheus (x)
docStatus: O = open/draft, X = cancelled, A = approved

Data returned in response: Sale Contract data, Partner data, Items (+ taxes), Totals (Payments, Taxes, Sales Orders = roadmap)

The response will inform:

The number of returned objects in the count field

For list search, the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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, reported in the response
hasNext = if there are more pages (true / false), informed in the response

This service will allow you to search the sale contracts list in two situations:

Full Search: will result in all sales contracts, according to filters.
Incremental Search: will result in all sales contracts, 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 Consultation, the updatedAt 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 x

For 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.

Initial create date to filter sales quotations (required if not unitary search)

\n","type":"text/plain"},"key":"createdFrom","value":"2011-01-01"},{"description":{"content":"

Final create date to filter sales quotations (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":"

Partner Contract Number in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"orderNum","value":"1074052740415-01"},{"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":"5dfd1f23-b228-46e5-985b-044916a8757d","name":"Sale Contracts - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/saleContracts?createdFrom=2011-01-01&createdTo=2021-12-31","host":["{{endpoint}}"],"path":["saleContracts"],"query":[{"key":"createdFrom","value":"2011-01-01","description":"Initial create date to filter sales quotations (required if not unitary search)"},{"key":"createdTo","value":"2021-12-31","description":"Final create date to filter sales quotations (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":"orderNum","value":"1074052740415-01","description":"Partner Contract 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:37 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"SaleContracts\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"saleContracts\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.102\",\n \"effectiveTimestamp\": \"2021-05-13T19:37:34\",\n \"createdFrom\": \"2011-01-01\",\n \"createdTo\": \"2021-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\": 2,\n \"values\": [\n {\n \"description\": \"\",\n \"erpKey\": \"1\",\n \"docNum\": \"1\",\n \"docStatus\": \"A\",\n \"startDate\": \"2015-01-01\",\n \"endDate\": \"2017-12-31\",\n \"signDate\": \"2015-01-01\",\n \"docValue\": 17400,\n \"partnerKey\": \"C001\",\n \"partnerName\": \"Sport Club Corinthians Paulista\",\n \"type\": \"G\",\n \"method\": \"I\",\n \"payConditionKey\": \"\",\n \"payMethodKey\": \"\",\n \"pricelistKey\": \"\",\n \"comments\": \"\",\n \"createdAt\": \"2015-01-30T15:11:51\",\n \"updatedAt\": \"2015-11-25T15:11:51\",\n \"canceledAt\": null,\n \"items\": [\n {\n \"lineNum\": \"1\",\n \"productKey\": \"I001\",\n \"productName\": \"Bola Nike Total 90 Pitch CBF\",\n \"quantity\": 40,\n \"confirmedQuantity\": 0,\n \"unit\": \"UN\",\n \"unitPrice\": 60,\n \"taxBasis\": 2400,\n \"lineStatus\": \"O\",\n \"comments\": \"\"\n },\n {\n \"lineNum\": \"2\",\n \"productKey\": \"I003\",\n \"productName\": \"Bola Nike Corinthians II nd Club\",\n \"quantity\": 200,\n \"confirmedQuantity\": 4,\n \"unit\": \"Un\",\n \"unitPrice\": 75,\n \"taxBasis\": 15000,\n \"lineStatus\": \"O\",\n \"comments\": \"\"\n }\n ],\n \"totals\": {\n \"orderTotal\": {\n \"netValue\": 17400,\n \"grossValue\": 17400,\n \"baseValue\": 17400,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 17400,\n \"grossValue\": 17400,\n \"baseValue\": 17400,\n \"taxValue\": 0\n },\n \"shippingTotal\": {\n \"netValue\": 0,\n \"grossValue\": 0,\n \"baseValue\": 0,\n \"taxValue\": 0\n }\n }\n },\n {\n \"description\": \"\",\n \"erpKey\": \"3\",\n \"docNum\": \"2\",\n \"docStatus\": \"A\",\n \"startDate\": \"2018-07-26\",\n \"endDate\": \"2019-12-31\",\n \"signDate\": \"2018-07-26\",\n \"docValue\": 100000,\n \"partnerKey\": \"C001\",\n \"partnerName\": \"Sport Club Corinthians Paulista\",\n \"type\": \"G\",\n \"method\": \"M\",\n \"payConditionKey\": \"\",\n \"payMethodKey\": \"\",\n \"pricelistKey\": \"1\",\n \"comments\": \"\",\n \"createdAt\": \"2018-07-26T00:28:38\",\n \"updatedAt\": \"2018-07-26T00:28:38\",\n \"canceledAt\": null,\n \"items\": [\n {\n \"lineNum\": \"1\",\n \"taxBasis\": 100000,\n \"confirmedTaxBasis\": 4000,\n \"lineStatus\": \"O\",\n \"comments\": \"\"\n }\n ],\n \"totals\": {\n \"orderTotal\": {\n \"netValue\": 100000,\n \"grossValue\": 100000,\n \"baseValue\": 100000,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 100000,\n \"grossValue\": 100000,\n \"baseValue\": 100000,\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":"0975c384-cbae-40f4-86e5-b843124f6ab5"}],"id":"d5591cb4-0b9c-4bff-a844-bfa8fecc4ae3","_postman_id":"d5591cb4-0b9c-4bff-a844-bfa8fecc4ae3","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"11834bc6-bff3-4272-b68a-24430df885aa","id":"11834bc6-bff3-4272-b68a-24430df885aa","name":"salesAPI - Sales API for ERP (v2)","type":"collection"}}},{"name":"Sale Quotations","item":[{"name":"Sale Quotations","id":"7da6881d-9b7c-4031-acfc-f0f9e4d860f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/quotations?createdFrom=2021-01-01&createdTo=2021-01-31&branch=01&partnerKey=C001&sellerKey=22&salesAgentKey=Intergate&docStatus=&erpKey=149231&docNum=122608&orderNum=1074052740415-01&pageNum=3&updatedAt=2020-11-03T18:00:00","description":"

Search sales quotations in ERP

(sapBusinessOne=23/OQUT, totvsProtheus=SCJ)

This service will allow you to search sales quotations on the ERP.

Searching sales quotations allows you to filter the ERP by:

List search: by createdFrom + createdTo {required}, by branch, partnerKey, sellerKey (SAPB1 only), salesAgentKey (SAPB1 only) or docStatus \n {optional}
Unitary search: by erpKey or orderNum or docNum

If no field for unitary query is provided in the request (erpKey or orderNum or docNum), the query for sales quotations is done by creation date from/to (which become mandatory).

The quotations service will consider sales quotations with:

SAP Business One: ORDR.ObjType = 23
TOTVS Protheus:

Comments:

branch: SAP Business One (OQUT.BPLId), TOTVS Protheus (CJ_FILIAL)
partnerKey: SAP Business One (OQUT.CardCode), TOTVS Protheus (CJ_CLIENTE+''+CJ_LOJA ou CJ_PROSPE+''+CJ_LOJPRO)
sellerKey: SAP Business One (OQUT.SlpCode)
salesAgentKey: SAP Business One (OQUT.AgentCode)
erpKey: SAP Business One (OQUT.DocEntry), TOTVS Protheus (CJ_NUM)
orderNum: SAP Business One (OQUT.NumAtCard), TOTVS Protheus (CJ_COTCLI)
docNum: SAP Business One (OQUT.DocNum), TOTVS Protheus (R_E_C_N_O_)
docStatus: O = open, X = cancelled, A = approved (only PROTHEUS), N = not budgeted (only PROTHEUS), P = paid (only SAPB1)

Data returned in response: Quotation data, Partner data, Items (+ taxes), Totals (Payments, Taxes, Sales Orders = roadmap)

The response will inform:

The number of returned objects in the count field

For list search, the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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, reported in the response
hasNext = if there are more pages (true / false), informed in the response

This service will allow you to search the sales quotation list in two situations:

Full Search: will result in all sales quotations, according to filters.
Incremental Search: will result in all sales quotations, 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 Consultation, the updatedAt 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 (OQUT.CreateDate, OQUT.UpdateDate, OQUT.CreateTS, OQUT.UpdateTS), [2] TOTVS Protheus: fields CJ_USERLGI and CJ_USERLGA

For the use of user fields (UDF) created in the sales order table (SAPB1: OQUT, TOTVS: SCJ), the respective registration must be performed in the Custom Table.

Initial create date to filter sales quotations (required if not unitary search)

\n","type":"text/plain"},"key":"createdFrom","value":"2021-01-01"},{"description":{"content":"

Final create date to filter sales quotations (required if not unitary search)

\n","type":"text/plain"},"key":"createdTo","value":"2021-01-31"},{"description":{"content":"

Branch (optional in list search)

\n","type":"text/plain"},"key":"branch","value":"01"},{"description":{"content":"

Partner Primary Key in ERP (optional in list search)

\n","type":"text/plain"},"key":"partnerKey","value":"C001"},{"description":{"content":"

Seller Primary Key in ERP (optional in list search - SAPB1 only)

\n","type":"text/plain"},"key":"sellerKey","value":"22"},{"description":{"content":"

Sales Agent Primary Key in ERP (optional in list search - SAPB1 only)

\n","type":"text/plain"},"key":"salesAgentKey","value":"Intergate"},{"description":{"content":"

Quotation Status to filter sales quotations (optional in list search - depends on UDF in GP API setup)

\n","type":"text/plain"},"key":"docStatus","value":""},{"description":{"content":"

Quotation Primary Key in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"erpKey","value":"149231"},{"description":{"content":"

Quotation Document Number in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"docNum","value":"122608"},{"description":{"content":"

Partner Quotation Number in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"orderNum","value":"1074052740415-01"},{"description":{"content":"

Number of page - pagination (optional)

\n","type":"text/plain"},"key":"pageNum","value":"3"},{"description":{"content":"

Date do filter modified registers - incremental search (optional)

\n","type":"text/plain"},"key":"updatedAt","value":"2020-11-03T18:00:00"}],"variable":[]}},"response":[{"id":"70dd0c5c-7601-41a5-83bd-7271f5164d05","name":"Sale Quotations - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/quotations?createdFrom=2018-06-19&createdTo=2018-06-19","host":["{{endpoint}}"],"path":["quotations"],"query":[{"key":"createdFrom","value":"2018-06-19","description":"Initial create date to filter sales quotations (required if not unitary search)"},{"key":"createdTo","value":"2018-06-19","description":"Final create date to filter sales quotations (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":"sellerKey","value":"22","description":"Seller Primary Key in ERP (optional in list search)","disabled":true},{"key":"salesAgentKey","value":"Intergate","description":"Sales Agent Primary Key in ERP (optional in list search)","disabled":true},{"key":"status","value":null,"description":"Quotation Status to filter sales quotations (optional in list search - depends on UDF in GP API setup)","disabled":true},{"key":"erpKey","value":"149231","description":"Quotation Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"122608","description":"Quotation Document Number in ERP (optional - unitary search)","disabled":true},{"key":"orderNum","value":"1074052740415-01","description":"Partner Quotation Number in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"3","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-11-03T18: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":"Set-Cookie","value":"JSESSIONID=892C487C3725B39F829847C8C87C1AB1; 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":"Tue, 01 Dec 2020 21:43:37 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"Quotations\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"quotations\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-12-01T19:43:32\",\n \"createdFrom\": \"2018-06-19\",\n \"createdTo\": \"2018-06-19\",\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 \"sellerKey\": \"3\",\n \"salesAgentKey\": \"\",\n \"erpKey\": \"45\",\n \"orderNum\": \"\",\n \"docNum\": \"45\",\n \"docStatus\": \"C\",\n \"docDate\": \"2018-06-19\",\n \"docDueDate\": \"2018-07-19\",\n \"taxDate\": \"2018-06-19\",\n \"docValue\": 1050,\n \"comments\": \"\",\n \"createdAt\": \"2018-06-19T10:31:00\",\n \"updatedAt\": \"2018-06-19T10:40:40\",\n \"canceledAt\": null,\n \"customer\": {\n \"type\": \"C\",\n \"taxType\": \"C\",\n \"partnerKey\": \"C005\",\n \"fullName\": \"Confederação Brasileira de Futebol\",\n \"aliasName\": \"\",\n \"email\": \"\",\n \"phone\": \"9843-2300\",\n \"phoneSecondary\": \"21\",\n \"cellular\": \"\",\n \"taxNumber\": \"33.655.721/0001-99\",\n \"stateTaxNumber\": \"Isento\",\n \"cityTaxNumber\": \"\",\n \"billingAddress\": {\n \"address1\": \"Rio Branco\",\n \"address2\": \"\",\n \"city\": \"Rio de Janeiro\",\n \"county\": \"3656\",\n \"postalCode\": \"\",\n \"stateCode\": \"RJ\",\n \"countryCode\": \"BR\",\n \"community\": \"\",\n \"exteriorNumber\": \"123\",\n \"streetType\": \"Av.\"\n },\n \"shippingAddress\": {\n \"address1\": \"Rio Branco\",\n \"address2\": \"\",\n \"city\": \"Rio de Janeiro\",\n \"county\": \"3656\",\n \"postalCode\": \"\",\n \"stateCode\": \"RJ\",\n \"countryCode\": \"BR\",\n \"community\": \"\",\n \"exteriorNumber\": \"123\",\n \"streetType\": \"Av.\"\n }\n },\n \"items\": [\n {\n \"lineNum\": \"0\",\n \"productKey\": \"Consultoria\",\n \"codeBars\": \"\",\n \"productName\": \"Consultoria\",\n \"quantity\": 1,\n \"unit\": \"\",\n \"unitPrice\": 1000,\n \"taxBasis\": 1000,\n \"usage\": \"\",\n \"cfop\": \"5933\",\n \"whsCode\": \"01\",\n \"discountRate\": 0,\n \"taxValue\": 0,\n \"freightValue\": 0,\n \"grossValue\": 1050,\n \"unitCost\": 0,\n \"comments\": \"\"\n }\n ],\n \"totals\": {\n \"orderTotal\": {\n \"netValue\": 1000,\n \"grossValue\": 1050,\n \"baseValue\": 1000,\n \"taxValue\": 50\n },\n \"merchandizeTotal\": {\n \"netValue\": 1000,\n \"grossValue\": 1050,\n \"baseValue\": 1000,\n \"taxValue\": 50,\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":"c063b892-3332-4a89-9837-fb78668a33ad","name":"Sale Quotations - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/quotations?createdFrom=2021-01-01&createdTo=2021-01-31","host":["{{endpoint}}"],"path":["quotations"],"query":[{"key":"createdFrom","value":"2021-01-01","description":"Initial create date to filter sales quotations (required if not unitary search)"},{"key":"createdTo","value":"2021-01-31","description":"Final create date to filter sales quotations (required if not unitary search)"},{"key":"branch","value":"01","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":"sellerKey","value":"22","description":"Seller Primary Key in ERP (optional in list search - SAPB1 only)","disabled":true},{"key":"salesAgentKey","value":"Intergate","description":"Sales Agent Primary Key in ERP (optional in list search - SAPB1 only)","disabled":true},{"key":"status","value":null,"description":"Quotation Status to filter sales quotations (optional in list search - depends on UDF in GP API setup)","disabled":true},{"key":"erpKey","value":"149231","description":"Quotation Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"122608","description":"Quotation Document Number in ERP (optional - unitary search)","disabled":true},{"key":"orderNum","value":"1074052740415-01","description":"Partner Quotation Number in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"3","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-11-03T18: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\": \"salesAPI\",\n \"process\": \"Quotations\",\n \"system\": \"totvsProtheus\",\n \"target\": \"quotations\",\n \"user\": \"intergate\",\n \"host\": \"192.168.210.1\",\n \"effectiveTimestamp\": \"2021-01-05T17:22:15\",\n \"createdFrom\": \"2021-01-01\",\n \"createdTo\": \"2021-01-31\",\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\": \"000001\",\n \"orderNum\": \"\",\n \"docNum\": \"1\",\n \"docStatus\": \"O\",\n \"docDate\": \"2021-01-05\",\n \"docDueDate\": \"2021-01-05\",\n \"taxDate\": \"2021-01-05\",\n \"docValue\": 45,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null,\n \"customer\": {\n \"type\": \"C\",\n \"taxType\": \"C\",\n \"partnerKey\": \"000001_01\",\n \"fullName\": \"CLIENTE\",\n \"aliasName\": \"CLIENTE\",\n \"email\": \"\",\n \"phone\": \"\",\n \"phoneSecundary\": \"\",\n \"cellular\": null,\n \"taxNumber\": \"\",\n \"stateTaxNumber\": \"\",\n \"cityTaxNumber\": \"\",\n \"contactPerson\": \"\",\n \"billingAddress\": {\n \"address1\": \".\",\n \"exteriorNumber\": null,\n \"address2\": \"\",\n \"community\": \".\",\n \"city\": \".\",\n \"county\": \"\",\n \"stateCode\": \"SC\",\n \"countryCode\": \"01058\",\n \"postalCode\": \"\",\n \"streetType\": null\n },\n \"shippingAddress\": {\n \"address1\": \".\",\n \"exteriorNumber\": null,\n \"address2\": \"\",\n \"community\": \".\",\n \"city\": \".\",\n \"county\": \"\",\n \"stateCode\": \"SC\",\n \"countryCode\": \"01058\",\n \"postalCode\": \"\",\n \"streetType\": null\n }\n },\n \"items\": [\n {\n \"lineNum\": \"01\",\n \"productKey\": \"PA000001\",\n \"codeBars\": \"\",\n \"productName\": \"TENIS TOPPER STYLUS 35\",\n \"quantity\": 1,\n \"unit\": \"UN\",\n \"unitPrice\": 45,\n \"taxBasis\": 45,\n \"usage\": \"501\",\n \"cfop\": \"\",\n \"discountRate\": 0,\n \"taxValue\": 0,\n \"freightValue\": 0,\n \"grossValue\": 45,\n \"unitCost\": 5.05\n }\n ],\n \"totals\": {\n \"orderTotal\": {\n \"netValue\": 45,\n \"grossValue\": 45,\n \"baseValue\": 45,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 45,\n \"grossValue\": 45,\n \"baseValue\": 45,\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 \"count\": 1\n}"}],"_postman_id":"7da6881d-9b7c-4031-acfc-f0f9e4d860f5"},{"name":"Sale Quotation","id":"095974ea-c553-41ed-8880-18cbe039fd1a","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-01-10\",\n \"comments\": \"Test\",\n \"customer\": {\n\t\t\"type\": \"L\",\n\t\t\"taxType\": \"P\",\n\t\t\"fullName\": \"Rafael Hernandes Ogeda\",\n\t\t\"aliasName\": \"Ogeda\",\n\t\t\"email\": \"rafael.ogeda@terra.com.br\",\n\t\t\"phone\": \"+5547988493101\",\n\t \"cellular\": \"+5547988493101\",\n\t\t\"taxNumber\": \"891.751.749-87\",\n\t\t\"billingAddress\": {\n\t\t\t\"address1\": \"Luiz Walendowsky\",\n\t\t\t\"address2\": \"\",\n\t\t\t\"city\": \"Porto Belo\",\n\t\t\t\"postalCode\": \"88210-000\",\n\t\t\t\"stateCode\": \"SC\",\n\t\t\t\"community\": \"Pereque\",\n\t\t\t\"exteriorNumber\": \"218\",\n\t\t\t\"streetType\": \"Rua\",\n\t\t\t\"countryCode\": \"BR\"\n\t\t}\n },\n \"items\": [\n {\n \"productKey\": \"PA100001\",\n \"productName\": \"CAMISA TOPPER FLAMENGO P\",\n \"quantity\": 1,\n \"unit\": \"UN\",\n \"unitPrice\": 49.9,\n \"taxBasis\": 49.9,\n \"comments\": \"\"\n }\n ],\n \"shipment\": {\n \"shippingAddress\": {\n \"address1\": \"Luiz Walendowsky\",\n \"address2\": \"\",\n \"city\": \"Porto Belo\",\n \"postalCode\": \"88210-000\",\n \"stateCode\": \"SC\",\n \"community\": \"Pereque\",\n \"exteriorNumber\": \"218\",\n \"streetType\": \"Rua\",\n \"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 \"priceAdjustValue\": 0,\n \"priceAdjustType\": \"\",\n \"priceAdjustPromotionId\": \"\",\n \"priceAdjustCouponId\": \"\"\n },\n \"shippingTotal\": {\n \"netValue\": 9.81,\n \"grossValue\": 9.81,\n \"baseValue\": 9.81,\n \"taxValue\": 0,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/quotations","description":"

Insert sales quotation in ERP

(sapBusinessOne=23/OQUT, totvsProtheus=SCJ)

This service allows to insert a new sales quotation in the ERP, with treatment for new and existing partner.

The scenario will validate the data received, making selects in the ERP database.

A new sales quotation will be added if the sales quotation is not found on the ERP by branch + orderNum:

SAP B1: OQUT.BPLId + OQUT.NumAtCard
TOTVS Protheus: CJ_FILIAL + CJ_PEDECOM

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.

SAP Business One: CRD7.TaxId0 (company / government) or CRD7.TaxId4 (person / employee)
TOTVS Protheus: A1_CGC (customer / lead) or A2_CGC (supplier)

The products sent for the service will be identified in the ERP:

SAP B1: OITM.CodeBars = codeBars or OITM.ItemCode = productKey
TOTVS Protheus: B1_CODBAR = codeBars or B1_COD = productKey

Comments:

Customer: [1] customer/type: C = customer, S = supplier, L = lead, [2] customer/taxType: P = person, C = company, G = government, E = employee. Each PN will have 2 registered addresses (CRD1, CRD7), namely: ShipToCode (S) = /customer/fullName OR /shipment/shippingAddress/firstName + \"\" + /shipment/shippingAddress/lastName, BillToCode (B) = /customer/fullName OR /customer/billingAddress/firstName + \"\" + /customer/billingAddress/lastName. Each PN will have 3 tax identification numbers (CRD12), namely: ShipToCode, BillToCode, empty.
Seller: sellerKey
Discounts: in total items (priceAdjustValue), in total freight (shipAdjustValue). shipAdjustType = minus or plus
items: Duplication of items on more than 1 order line is not accepted, basePrice: base/gross price, taxBasis: total value of the item (quantity * price), calculation date for tax
shipment: shipment data, as shipping address, carrier primary key in ERP, shipping method and carrier message
totals: 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 sales order table (SAPB1: OQUT, TOTVS: SCJ), the respective registration must be performed in the Custom Table.

Request object has the following properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
branch	string	Number branch
orderNum	string	Number Sales Order
brand	string	Brand
sellerKey	string	Seller Primary Key in ERP
salesAgentKey	string	Sales Agent Primary Key in ERP
customer	object	Customer
customer.type	string	C=customer, S=supplier, L=lead
customer.taxType	string	P=person, C=company, G=government, E=employee
customer.partnerId	string	Id partner
customer.fullName	string	Customer full name
customer.aliasName	string	Customer alias name
customer.email	string	Customer emai
customer.phone	string	Customer phone Number
customer.phoneSecondary	string	Customer secondary phone number
customer.cellular	string	cell Customer phone number
customer.taxNumber	string	Customer identification number
customer.stateTaxNumber	string	State customer identification number
customer.cityTaxNumber	string	City customer identification number
customer.billingAddress	object	Customer billing addresses
customer.billingAddress.address1	string	Customer billing address1
customer.billingAddress.address2	string	Customer billing address2
customer.billingAddress.city	string	Customer billing city
customer.billingAddress.postalCode	string	Customer billing postal Code
customer.billingAddress.stateCode	string	Customer billing state Code
customer.billingAddress.community	string	Customer billing community
customer.billingAddress.exteriorNumber	string	Customer billing exterior number
customer.billingAddress.streetType	string	Customer billing type street
customer.billingAddress.countryCode	string	Customer billing country code
items	array	Order Items Object
productKey	string	Product key
productName	string	Product Name
quantity	number	Quantity
unit	string	Unit
unitPrice	number	Unit price
taxBasis	number	Tax Basis
shipment	object	Shipment
shipment.carrierKey	string	Carrier Primary Key in ERP
shipment.shippingMethod	string	Shipping method
shipment.carrierMessage	string	Carrier message
shipment.shippingAddress	array	Shipping adress
shippingAdress.address1	string	Shipping first adress
shippingAdress.address2	string	Shipping second adress
shippingAdress.city	string	Shipping city
shippingAdress.postalCode	string	Shipping postal Code
shippingAdress.stateCode	string	Shipping state Code
shippingAdress.community	string	Shipping community
shippingAdress.exteriorNumber	string	Shipping exterior number
shippingAdress.streetType	string	Shipping type street
shippingAdress.countryCode	string	Shipping country Code
totals	object	Totals
totals.orderTotal	object	Order totals
totals.orderTotal.netValue	number	Totals net value
totals.orderTotal.grossValue	number	Totals gross value
totals.orderTotal.baseValue	number	Totals base value
totals.orderTotal.taxValue	number	Totals taxes that increase the value
totals.merchandizeTotal	object	Merchandize Totals
totals.merchandizeTotal.netValue	number	Net value merchandize
totals.merchandizeTotal.grossValue	number	Gross value merchandize
totals.merchandizeTotal.baseValue	number	Base value merchandize
totals.merchandizeTotal.taxValue	number	Taxes that increase the value merchandizeTotal
totals.merchandizeTotal.priceAdjustValue	number	Discounts in total items
totals.merchandizeTotal.priceAdjustType	string	Price adjustment type
totals.merchandizeTotal.priceAdjustPromotionId	string	Price adjustment Id promotion
totals.merchandizeTotal.priceAdjustCouponId	string	Price adjustment Id coupon
totals.shippingTotal	object	Shipping totals
totals.shippingTotal.netValue	number	Shipping total Net value
totals.shippingTotal.grossValue	number	Shipping total Gross value
totals.shippingTotal.baseValue	number	Shipping totals base value
totals.shippingTotal.taxValue	number	Shipping total Tax value
totals.shippingTotal.priceAdjustValue	number	Discounts on total shipping
totals.shippingTotal.priceAdjustType	string	Price adjust type
totals.shippingTotal.priceAdjustPromotionId	string	Price adjust Id promotion
totals.shippingTotal.priceAdjustCouponId	string	Price adjust Id coupon

* = Required field

Response object has the following properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
package	string	package
process	string	process
system	string	System
target	string	Target
user	string	user
host	string	host
effectiveTimestamp	string	Effective Time stamp
code	string	Code
success	booleano	Success
values	array	Values
values.object	string	Object
values.table	string	Table
values.action	string	action
values.erpKey	string	Erpkey

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"11834bc6-bff3-4272-b68a-24430df885aa","id":"11834bc6-bff3-4272-b68a-24430df885aa","name":"salesAPI - Sales API for ERP (v2)","type":"collection"}},"urlObject":{"path":["quotations"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"a57179d2-8c8f-41fa-90a9-94eef423ba45","name":"Sale Quotation - TOTVS Protheus","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"branch\": \"01\",\n \"orderNum\": \"1013\",\n \"dueDate\": \"2021-01-10\",\n \"comments\": \"Test\",\n \"customer\": {\n\t\t\"type\": \"L\",\n\t\t\"taxType\": \"P\",\n\t\t\"fullName\": \"Rafael Hernandes Ogeda\",\n\t\t\"aliasName\": \"Ogeda\",\n\t\t\"email\": \"rafael.ogeda@terra.com.br\",\n\t\t\"phone\": \"+5547988493101\",\n\t \"cellular\": \"+5547988493101\",\n\t\t\"taxNumber\": \"891.751.749-87\",\n\t\t\"billingAddress\": {\n\t\t\t\"address1\": \"Luiz Walendowsky\",\n\t\t\t\"address2\": \"\",\n\t\t\t\"city\": \"Porto Belo\",\n\t\t\t\"postalCode\": \"88210-000\",\n\t\t\t\"stateCode\": \"SC\",\n\t\t\t\"community\": \"Pereque\",\n\t\t\t\"exteriorNumber\": \"218\",\n\t\t\t\"streetType\": \"Rua\",\n\t\t\t\"countryCode\": \"BR\"\n\t\t}\n },\n \"items\": [\n {\n \"productKey\": \"PA100001\",\n \"productName\": \"CAMISA TOPPER FLAMENGO P\",\n \"quantity\": 1,\n \"unit\": \"UN\",\n \"unitPrice\": 49.9,\n \"taxBasis\": 49.9,\n \"comments\": \"\"\n }\n ],\n \"shipment\": {\n \"shippingAddress\": {\n \"address1\": \"Luiz Walendowsky\",\n \"address2\": \"\",\n \"city\": \"Porto Belo\",\n \"postalCode\": \"88210-000\",\n \"stateCode\": \"SC\",\n \"community\": \"Pereque\",\n \"exteriorNumber\": \"218\",\n \"streetType\": \"Rua\",\n \"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 \"priceAdjustValue\": 0,\n \"priceAdjustType\": \"\",\n \"priceAdjustPromotionId\": \"\",\n \"priceAdjustCouponId\": \"\"\n },\n \"shippingTotal\": {\n \"netValue\": 9.81,\n \"grossValue\": 9.81,\n \"baseValue\": 9.81,\n \"taxValue\": 0,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/quotations"},"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\": \"salesAPI\",\n \"process\": \"Quotations\",\n \"system\": \"totvsProtheus\",\n \"target\": \"quotations\",\n \"user\": \"intergate\",\n \"host\": \"192.168.210.1\",\n \"effectiveTimestamp\": \"2021-01-05T18:06:37\",\n \"code\": \"200\",\n \"success\": true,\n \"values\": [\n {\n \"object\": \"2\",\n \"table\": \"SUS\",\n \"action\": \"Insert\",\n \"erpKey\": \"000006_01\"\n },\n {\n \"object\": \"23\",\n \"table\": \"SCJ\",\n \"action\": \"Insert\",\n \"erpKey\": \"000003\"\n }\n ]\n}"},{"id":"fc28b360-32b1-4ade-b136-471cb48c740c","name":"Sale Quotation - SAP Business One","originalRequest":{"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\": \"2020-12-10\",\n \"comments\": \"Test\",\n \"customer\": {\n\t\t\"type\": \"C\",\n\t\t\"taxType\": \"C\",\n\t\t\"partnerId\": \"C001\",\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\": \"+551120953000\",\n\t \"cellular\": \"+551195952000\",\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\": \"I001\",\n \"productName\": \"Camisa Nike Flamengo I 09/10\",\n \"quantity\": 1,\n \"unit\": \"PAR\",\n \"unitPrice\": 49.9,\n \"taxBasis\": 49.9,\n \"comments\": \"\"\n }\n ],\n \"shipment\": {\n \"carrierKey\": \"\",\n \"shippingMethod\": \"BR-Standard-Shipping\",\n \"carrierMessage\": \"\",\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 \"priceAdjustValue\": 0,\n \"priceAdjustType\": \"\",\n \"priceAdjustPromotionId\": \"\",\n \"priceAdjustCouponId\": \"\"\n },\n \"shippingTotal\": {\n \"netValue\": 9.81,\n \"grossValue\": 9.81,\n \"baseValue\": 9.81,\n \"taxValue\": 0,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/quotations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"JSESSIONID=9AEEE810218BEBDCC23D20DE5C4CCA2B; 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":"Tue, 01 Dec 2020 22:04:46 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"Quotations\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"quotations\",\n \"user\": \"intergate\",\n \"host\": \"186.251.108.77\",\n \"effectiveTimestamp\": \"2020-12-01T19:29:59\",\n \"code\": \"200\",\n \"success\": true,\n \"useCustom\": \"true\",\n \"values\": [\n {\n \"object\": \"2\",\n \"table\": \"OCRD\",\n \"action\": \"Update\",\n \"erpKey\": \"C144611\"\n },\n {\n \"object\": \"23\",\n \"table\": \"OQUT\",\n \"action\": \"Insert\",\n \"erpKey\": \"19\"\n }\n ]\n}"}],"_postman_id":"095974ea-c553-41ed-8880-18cbe039fd1a"},{"name":"Sale Quotation","id":"73a7c5c3-5f6b-4939-9a44-7520b6994ad3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"branch\": \"01\",\n \"orderNum\": \"1015\",\n \"freightType\": \"A\",\n \"customSCJ\": \"\",\n \"customer\": {\n \"type\": \"C\",\n \"taxType\": \"C\",\n \"partnerType\": \"R\",\n \"fullName\": \"4INFRA CONSULTORIA EM TI LTDA\",\n \"aliasName\": \"4INFRA CONSULTORIA E\",\n \"phone\": \"31 994575976\",\n \"taxNumber\": \"17364114000113\",\n \"stateTaxNumber\": \"ISENTO\",\n \"financialNature\": \"5000000001\",\n \"homepage\": \"http://intergate.net.br\",\n \"recMkt\": false,\n \"billingAddress\": {\n \"address1\": \"R PEDRA BONITA, 922\",\n \"address2\": \"COMPBILL\",\n \"community\": \"BARROCA\",\n \"city\": \"BELO HORIZONTE\",\n \"county\": \"06200\",\n \"stateCode\": \"MG\",\n \"postalCode\": \"30431-065\"\n },\n \"shippingAddress\": {\n \"address1\": \"R PEDRA BONITA, 922\",\n \"address2\": \"COMPSHIP\",\n \"community\": \"BARROCA\",\n \"city\": \"BELO HORIZONTE\",\n \"county\": \"06200\",\n \"stateCode\": \"MG\",\n \"postalCode\": \"30431-065\"\n }\n },\n \"items\": [\n {\n \"productKey\": \"PA000002\",\n \"productName\": \"CAMISA TOPPER FLAMENGO P\",\n \"quantity\": 2,\n \"unit\": \"UN\",\n \"unitPrice\": 200,\n \"taxBasis\": 400,\n \"whsCode\": \"01\",\n \"customSCK\": \"ABC\",\n \"comissionPercent1\": 3\n },\n {\n \"productKey\": \"PA000001\",\n \"productName\": \"CAMISA TOPPER FLAMENGO P\",\n \"quantity\": 1,\n \"unit\": \"UN\",\n \"unitPrice\": 250,\n \"taxBasis\": 250,\n \"whsCode\": \"01\",\n \"customSCK\": \"abc\",\n \"comissionPercent1\": 1\n }\n ],\n \"totals\": {\n \"orderTotal\": {\n \"netValue\": 670,\n \"grossValue\": 670,\n \"baseValue\": 670,\n \"taxValue\": 0\n },\n \"merchandizeTotal\": {\n \"netValue\": 650,\n \"grossValue\": 650,\n \"baseValue\": 650,\n \"taxValue\": 0\n },\n \"shippingTotal\": {\n \"netValue\": 20,\n \"grossValue\": 20,\n \"baseValue\": 20,\n \"taxValue\": 0\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/quotations","description":"

Insert sales quotation in ERP

(sapBusinessOne=23/OQUT, totvsProtheus=SCJ)

This service allows to insert a new sales quotation in the ERP, with treatment for new and existing partner.

The scenario will validate the data received, making selects in the ERP database.

A new sales quotation will be added if the sales quotation is not found on the ERP by branch + orderNum:

SAP B1: OQUT.BPLId + OQUT.NumAtCard
TOTVS Protheus: CJ_FILIAL + CJ_PEDECOM

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.

SAP Business One: CRD7.TaxId0 (company / government) or CRD7.TaxId4 (person / employee)
TOTVS Protheus: A1_CGC (customer / lead) or A2_CGC (supplier)

The products sent for the service will be identified in the ERP:

SAP B1: OITM.CodeBars = codeBars or OITM.ItemCode = productKey
TOTVS Protheus: B1_CODBAR = codeBars or B1_COD = productKey

Comments:

Customer: [1] customer/type: C = customer, S = supplier, L = lead, [2] customer/taxType: P = person, C = company, G = government, E = employee. Each PN will have 2 registered addresses (CRD1, CRD7), namely: ShipToCode (S) = /customer/fullName OR /shipment/shippingAddress/firstName + \"\" + /shipment/shippingAddress/lastName, BillToCode (B) = /customer/fullName OR /customer/billingAddress/firstName + \"\" + /customer/billingAddress/lastName. Each PN will have 3 tax identification numbers (CRD12), namely: ShipToCode, BillToCode, empty.
Seller: sellerKey
Discounts: in total items (priceAdjustValue), in total freight (shipAdjustValue). shipAdjustType = minus or plus
items: Duplication of items on more than 1 order line is not accepted, basePrice: base/gross price, taxBasis: total value of the item (quantity * price), calculation date for tax
shipment: shipment data, as shipping address, carrier primary key in ERP, shipping method and carrier message
totals: 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 sales order table (SAPB1: OQUT, TOTVS: SCJ), the respective registration must be performed in the Custom Table.

Request object has the following properties

Field	Type	Description
branch	string	Number branch
orderNum	string	Number Sales Order
brand	string	Brand
sellerKey	string	Seller Primary Key in ERP
salesAgentKey	string	Sales Agent Primary Key in ERP
customer	object	Customer
customer.type	string	C=customer, S=supplier, L=lead
customer.taxType	string	P=person, C=company, G=government, E=employee
customer.partnerId	string	Id partner
customer.fullName	string	Customer full name
customer.aliasName	string	Customer alias name
customer.email	string	Customer emai
customer.phone	string	Customer phone Number
customer.phoneSecondary	string	Customer secondary phone number
customer.cellular	string	cell Customer phone number
customer.taxNumber	string	Customer identification number
customer.stateTaxNumber	string	State customer identification number
customer.cityTaxNumber	string	City customer identification number
customer.billingAddress	object	Customer billing addresses
customer.billingAddress.address1	string	Customer billing address1
customer.billingAddress.address2	string	Customer billing address2
customer.billingAddress.city	string	Customer billing city
customer.billingAddress.postalCode	string	Customer billing postal Code
customer.billingAddress.stateCode	string	Customer billing state Code
customer.billingAddress.community	string	Customer billing community
customer.billingAddress.exteriorNumber	string	Customer billing exterior number
customer.billingAddress.streetType	string	Customer billing type street
customer.billingAddress.countryCode	string	Customer billing country code
items	array	Order Items Object
productKey	string	Product key
productName	string	Product Name
quantity	number	Quantity
unit	string	Unit
unitPrice	number	Unit price
taxBasis	number	Tax Basis
shipment	object	Shipment
shipment.carrierKey	string	Carrier Primary Key in ERP
shipment.shippingMethod	string	Shipping method
shipment.carrierMessage	string	Carrier message
shipment.shippingAddress	array	Shipping adress
shippingAdress.address1	string	Shipping first adress
shippingAdress.address2	string	Shipping second adress
shippingAdress.city	string	Shipping city
shippingAdress.postalCode	string	Shipping postal Code
shippingAdress.stateCode	string	Shipping state Code
shippingAdress.community	string	Shipping community
shippingAdress.exteriorNumber	string	Shipping exterior number
shippingAdress.streetType	string	Shipping type street
shippingAdress.countryCode	string	Shipping country Code
totals	object	Totals
totals.orderTotal	object	Order totals
totals.orderTotal.netValue	number	Totals net value
totals.orderTotal.grossValue	number	Totals gross value
totals.orderTotal.baseValue	number	Totals base value
totals.orderTotal.taxValue	number	Totals taxes that increase the value
totals.merchandizeTotal	object	Merchandize Totals
totals.merchandizeTotal.netValue	number	Net value merchandize
totals.merchandizeTotal.grossValue	number	Gross value merchandize
totals.merchandizeTotal.baseValue	number	Base value merchandize
totals.merchandizeTotal.taxValue	number	Taxes that increase the value merchandizeTotal
totals.merchandizeTotal.priceAdjustValue	number	Discounts in total items
totals.merchandizeTotal.priceAdjustType	string	Price adjustment type
totals.merchandizeTotal.priceAdjustPromotionId	string	Price adjustment Id promotion
totals.merchandizeTotal.priceAdjustCouponId	string	Price adjustment Id coupon
totals.shippingTotal	object	Shipping totals
totals.shippingTotal.netValue	number	Shipping total Net value
totals.shippingTotal.grossValue	number	Shipping total Gross value
totals.shippingTotal.baseValue	number	Shipping totals base value
totals.shippingTotal.taxValue	number	Shipping total Tax value
totals.shippingTotal.priceAdjustValue	number	Discounts on total shipping
totals.shippingTotal.priceAdjustType	string	Price adjust type
totals.shippingTotal.priceAdjustPromotionId	string	Price adjust Id promotion
totals.shippingTotal.priceAdjustCouponId	string	Price adjust Id coupon

* = Required field

Response object has the following properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
package	string	package
process	string	process
system	string	System
target	string	Target
user	string	user
host	string	host
effectiveTimestamp	string	Effective Time stamp
code	string	Code
success	booleano	Success
values	array	Values
values.object	string	Object
values.table	string	Table
values.action	string	action
values.erpKey	string	Erpkey

Insert sales quotation in ERP

(sapBusinessOne=23/OQUT, totvsProtheus=SCJ)

This service allows to insert a new sales quotation in the ERP, with treatment for new and existing partner.

The scenario will validate the data received, making selects in the ERP database.

A new sales quotation will be added if the sales quotation is not found on the ERP by branch + orderNum:

SAP B1: OQUT.BPLId + OQUT.NumAtCard
TOTVS Protheus: CJ_FILIAL + CJ_PEDECOM

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.

SAP Business One: CRD7.TaxId0 (company / government) or CRD7.TaxId4 (person / employee)
TOTVS Protheus: A1_CGC (customer / lead) or A2_CGC (supplier)

The products sent for the service will be identified in the ERP:

SAP B1: OITM.CodeBars = codeBars or OITM.ItemCode = productKey
TOTVS Protheus: B1_CODBAR = codeBars or B1_COD = productKey

Comments:

Customer: [1] customer/type: C = customer, S = supplier, L = lead, [2] customer/taxType: P = person, C = company, G = government, E = employee. Each PN will have 2 registered addresses (CRD1, CRD7), namely: ShipToCode (S) = /customer/fullName OR /shipment/shippingAddress/firstName + \"\" + /shipment/shippingAddress/lastName, BillToCode (B) = /customer/fullName OR /customer/billingAddress/firstName + \"\" + /customer/billingAddress/lastName. Each PN will have 3 tax identification numbers (CRD12), namely: ShipToCode, BillToCode, empty.
Seller: sellerKey
Discounts: in total items (priceAdjustValue), in total freight (shipAdjustValue). shipAdjustType = minus or plus
items: Duplication of items on more than 1 order line is not accepted, basePrice: base/gross price, taxBasis: total value of the item (quantity * price), calculation date for tax
shipment: shipment data, as shipping address, carrier primary key in ERP, shipping method and carrier message
totals: 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 sales order table (SAPB1: OQUT, TOTVS: SCJ), the respective registration must be performed in the Custom Table.

Request object has the following properties

Field	Type	Description
branch	string	Number branch
orderNum	string	Number Sales Order
brand	string	Brand
sellerKey	string	Seller Primary Key in ERP
salesAgentKey	string	Sales Agent Primary Key in ERP
customer	object	Customer
customer.type	string	C=customer, S=supplier, L=lead
customer.taxType	string	P=person, C=company, G=government, E=employee
customer.partnerId	string	Id partner
customer.fullName	string	Customer full name
customer.aliasName	string	Customer alias name
customer.email	string	Customer emai
customer.phone	string	Customer phone Number
customer.phoneSecondary	string	Customer secondary phone number
customer.cellular	string	cell Customer phone number
customer.taxNumber	string	Customer identification number
customer.stateTaxNumber	string	State customer identification number
customer.cityTaxNumber	string	City customer identification number
customer.billingAddress	object	Customer billing addresses
customer.billingAddress.address1	string	Customer billing address1
customer.billingAddress.address2	string	Customer billing address2
customer.billingAddress.city	string	Customer billing city
customer.billingAddress.postalCode	string	Customer billing postal Code
customer.billingAddress.stateCode	string	Customer billing state Code
customer.billingAddress.community	string	Customer billing community
customer.billingAddress.exteriorNumber	string	Customer billing exterior number
customer.billingAddress.streetType	string	Customer billing type street
customer.billingAddress.countryCode	string	Customer billing country code
items	array	Order Items Object
productKey	string	Product key
productName	string	Product Name
quantity	number	Quantity
unit	string	Unit
unitPrice	number	Unit price
taxBasis	number	Tax Basis
shipment	object	Shipment
shipment.carrierKey	string	Carrier Primary Key in ERP
shipment.shippingMethod	string	Shipping method
shipment.carrierMessage	string	Carrier message
shipment.shippingAddress	array	Shipping adress
shippingAdress.address1	string	Shipping first adress
shippingAdress.address2	string	Shipping second adress
shippingAdress.city	string	Shipping city
shippingAdress.postalCode	string	Shipping postal Code
shippingAdress.stateCode	string	Shipping state Code
shippingAdress.community	string	Shipping community
shippingAdress.exteriorNumber	string	Shipping exterior number
shippingAdress.streetType	string	Shipping type street
shippingAdress.countryCode	string	Shipping country Code
totals	object	Totals
totals.orderTotal	object	Order totals
totals.orderTotal.netValue	number	Totals net value
totals.orderTotal.grossValue	number	Totals gross value
totals.orderTotal.baseValue	number	Totals base value
totals.orderTotal.taxValue	number	Totals taxes that increase the value
totals.merchandizeTotal	object	Merchandize Totals
totals.merchandizeTotal.netValue	number	Net value merchandize
totals.merchandizeTotal.grossValue	number	Gross value merchandize
totals.merchandizeTotal.baseValue	number	Base value merchandize
totals.merchandizeTotal.taxValue	number	Taxes that increase the value merchandizeTotal
totals.merchandizeTotal.priceAdjustValue	number	Discounts in total items
totals.merchandizeTotal.priceAdjustType	string	Price adjustment type
totals.merchandizeTotal.priceAdjustPromotionId	string	Price adjustment Id promotion
totals.merchandizeTotal.priceAdjustCouponId	string	Price adjustment Id coupon
totals.shippingTotal	object	Shipping totals
totals.shippingTotal.netValue	number	Shipping total Net value
totals.shippingTotal.grossValue	number	Shipping total Gross value
totals.shippingTotal.baseValue	number	Shipping totals base value
totals.shippingTotal.taxValue	number	Shipping total Tax value
totals.shippingTotal.priceAdjustValue	number	Discounts on total shipping
totals.shippingTotal.priceAdjustType	string	Price adjust type
totals.shippingTotal.priceAdjustPromotionId	string	Price adjust Id promotion
totals.shippingTotal.priceAdjustCouponId	string	Price adjust Id coupon

* = Required field

Response object has the following properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
package	string	package
process	string	process
system	string	System
target	string	Target
user	string	user
host	string	host
effectiveTimestamp	string	Effective Time stamp
code	string	Code
success	booleano	Success
values	array	Values
values.object	string	Object
values.table	string	Table
values.action	string	action
values.erpKey	string	Erpkey

Search sales orders in ERP

(sapBusinessOne=17/ORDR, totvsProtheus=SC5)

This service will allow you to search sales orders on the ERP.

Searching sales orders allows you to filter the ERP by:

List search: by createdFrom + createdTo {required}, by branch, partnerKey {optional}
Unitary search: by erpKey or orderNum or docNum or customOrderKey

If 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 informed in request.

The orders service will consider sales orders with:

SAP Business One: ORDR.ObjType = 17
TOTVS Protheus: C5_TIPO IN 'N', 'C', 'I', 'P'

Comments:

branch: 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 (PROTHEUS = all itens with C6_BLQ=R), X = canceled, B = billed, P = paid, R = returned, L = released (only PROTHEUS = with SC9)
customOrderKey: sales order custom field definied in API Setup, and present in filter and response
customStatus: sales order custom field definied in API Setup, and present in filter and response
customStatusNotify: sales order custom field definied in API Setup, and present in filter and response
customShipMethod: sales order custom field definied in API Setup, and present in filter and response
customShipType: sales order custom field definied in API Setup, and present in filter and response
customTrackingKey: sales order custom field definied in API Setup, and present in response
customTrackingUrl: sales order custom field definied in API Setup, and present in response
carrierKey, brand, packDescription: sales order details

Data returned in response: Order data, Partner data, Items (+ taxes), Totals, Payments, Taxes, Sales Invoices

The response will inform:

The number of returned objects in the count field

For list search, the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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, reported in the response
hasNext = if there are more pages (true / false), informed in the response

This service will allow you to search the sales order list in two situations:

Full Search: will result in all sales orders, according to filters.
Incremental Search: will result in all sales orders, 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 Consultation, the updatedAt 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 (ORDR.CreateDate, ORDR.UpdateDate, ORDR.CreateTS, ORDR.UpdateTS), [2] TOTVS Protheus: fields C5_USERLGI and C5_USERLGA

For the use of user fields (UDF) created in the sales order table (SAPB1: ORDR, TOTVS: SC5), the respective registration must be performed in the Custom Table.

Initial create date to filter sales orders (required if not unitary search)

\n","type":"text/plain"},"key":"createdFrom","value":"2021-02-24"},{"description":{"content":"

Final create date to filter sales orders (required if not unitary search)

\n","type":"text/plain"},"key":"createdTo","value":"2021-02-24"},{"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":"

Seller Primary Key in ERP (optional in list search)

\n","type":"text/plain"},"key":"sellerKey","value":"22"},{"description":{"content":"

Sales Agent Primary Key in ERP (optional in list search)

\n","type":"text/plain"},"key":"salesAgentKey","value":"Intergate"},{"description":{"content":"

Carrier Primary Key in ERP to filter sales order (optional in list search - depends on UDF in API setup - NEW)

\n","type":"text/plain"},"key":"carrierKey","value":"T002"},{"description":{"content":"

Default Order Status to filter sales order (optional in list search - NEW)

\n","type":"text/plain"},"key":"docStatus","value":"O"},{"description":{"content":"

Custom 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 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 sales order (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 sales order (optional in list search - depends on UDF in API setup - NEW)

\n","type":"text/plain"},"key":"customShipType","value":"NEW"},{"description":{"content":"

Order Primary Key in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"erpKey","value":"149231"},{"description":{"content":"

Order Document Number in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"docNum","value":"122608"},{"description":{"content":"

Partner Order Number in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"orderNum","value":"1074052740415-01"},{"description":{"content":"

Custom Order Key to filter sales 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":"2"},{"description":{"content":"

Date do filter modified registers - incremental search (optional)

\n","type":"text/plain"},"key":"updatedAt","value":"2018-11-03T18:00:00"}],"variable":[]}},"response":[{"id":"75c99bb4-df7c-4d38-9b95-85577e5d9d79","name":"Sale Orders - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/orders?branch=1&createdFrom=2020-01-24&createdTo=2020-01-24&updatedAt=2020-01-24T12:00:00","host":["{{endpoint}}"],"path":["orders"],"query":[{"key":"branch","value":"1","description":"Branch (required if not unit query)"},{"key":"createdFrom","value":"2020-01-24","description":"Initial create date to filter sales orders (required if not unit query)"},{"key":"createdTo","value":"2020-01-24","description":"Final create date to filter invoices (required if not unit query)"},{"key":"partnerKey","value":"C001","description":"Partner Primary Key in ERP (optional in full query)","disabled":true},{"key":"erpKey","value":"121313","description":"Primary Key in ERP (optional)","disabled":true},{"key":"orderNo","value":"FM-2001026731","description":"Order Partner Number in ERP (optional)","disabled":true},{"key":"docNum","value":"121313","description":"Doc Num in ERP (optional)","disabled":true},{"key":"pageNum","value":"1","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-24T12:00:00","description":"Date to filter sales order changes - incremental query (optional)"},{"key":"action","value":"orders","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":"Mon, 03 Feb 2020 15:46:02 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"Orders\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"orders\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.104\",\n \"effectiveTimestamp\": \"2020-02-03T12:45:59\",\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-MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"erpKey\": \"252\",\n \"orderNum\": \"FM-2001026731\",\n \"docNum\": \"252\",\n \"docStatus\": \"C\",\n \"docDate\": \"2020-01-24\",\n \"docDueDate\": \"2020-01-24\",\n \"taxDate\": \"2020-01-24\",\n \"docValue\": 158.64,\n \"lojaWeb\": \"DIRETA\",\n \"createdAt\": \"2020-01-24T12:05:29\",\n \"updatedAt\": \"2020-01-24T12:05:30\",\n \"canceledAt\": null,\n \"customer\": {\n \"type\": \"C\",\n \"taxType\": \"P\",\n \"partnerKey\": \"C000004\",\n \"docEntry\": \"73\",\n \"fullName\": \"Rafael Ogeda\",\n \"aliasName\": \"Rafael Ogeda\",\n \"email\": \"rafael.ogeda.ro@gmail.com\",\n \"phone\": \"(47) 98849-3101\",\n \"phoneSecondary\": \"\",\n \"cellular\": \"\",\n \"taxNumber\": \"055.467.686-90\",\n \"stateTaxNumber\": \"\",\n \"cityTaxNumber\": \"\",\n \"billingAddress\": {\n \"address1\": \"Luiz Walendowsky\",\n \"address2\": \"\",\n \"city\": \"Porto Belo\",\n \"county\": \"4614\",\n \"postalCode\": \"88210000\",\n \"stateCode\": \"SC\",\n \"countryCode\": \"BR\",\n \"community\": \"Pereque\",\n \"exteriorNumber\": \"218\",\n \"streetType\": \"\"\n },\n \"shippingAddress\": {\n \"address1\": \"Luiz Walendowsky\",\n \"address2\": \"\",\n \"city\": \"Porto Belo\",\n \"county\": \"4614\",\n \"postalCode\": \"88210000\",\n \"stateCode\": \"SC\",\n \"countryCode\": \"BR\",\n \"community\": \"Pereque\",\n \"exteriorNumber\": \"218\",\n \"streetType\": \"\"\n }\n },\n \"items\": [\n {\n \"lineNum\": \"0\",\n \"productKey\": \"I006\",\n \"codeBars\": \"I006\",\n \"productName\": \"Bola Adidas Torpedo X-Lite\",\n \"quantity\": 1,\n \"unit\": \"Un\",\n \"unitPrice\": 110.26,\n \"taxBasis\": 110.26,\n \"usage\": \"5\",\n \"cfop\": \"6102\",\n \"discountRate\": 0,\n \"taxValue\": 24.08,\n \"freightValue\": 24.3,\n \"grossValue\": 157.67,\n \"unitCost\": 83.39,\n \"itemTaxes\": [\n {\n \"taxRelate\": \"product\",\n \"taxCode\": \"ICMSBI00\",\n \"taxBasis\": 110.26,\n \"taxRate\": 18,\n \"taxValue\": 19.85\n },\n {\n \"taxRelate\": \"product\",\n \"taxCode\": \"IPIBI000\",\n \"taxBasis\": 110.26,\n \"taxRate\": 7,\n \"taxValue\": 7.72\n },\n {\n \"taxRelate\": \"product\",\n \"taxCode\": \"STA1850\",\n \"taxBasis\": 176.97,\n \"taxRate\": 18,\n \"taxValue\": 12.01\n },\n {\n \"taxRelate\": \"freight\",\n \"taxCode\": \"ICMSBI00\",\n \"taxBasis\": 24.3,\n \"taxRate\": 18,\n \"taxValue\": 4.37\n },\n {\n \"taxRelate\": \"freight\",\n \"taxCode\": \"IPIBI000\",\n \"taxBasis\": 24.3,\n \"taxRate\": 7,\n \"taxValue\": 1.7\n },\n {\n \"taxRelate\": \"freight\",\n \"taxCode\": \"STA1850\",\n \"taxBasis\": 39,\n \"taxRate\": 18,\n \"taxValue\": 2.65\n }\n ]\n }\n ],\n \"totals\": {\n \"orderTotal\": {\n \"netValue\": 134.56,\n \"grossValue\": 158.64,\n \"baseValue\": 134.56,\n \"taxValue\": 24.08\n },\n \"merchandizeTotal\": {\n \"netValue\": 110.26,\n \"grossValue\": 129.99,\n \"baseValue\": 110.26,\n \"taxValue\": 19.73,\n \"priceAdjustValue\": 0,\n \"priceAdjustType\": \"\",\n \"priceAdjustPromotionId\": \"\",\n \"priceAdjustCouponId\": \"\"\n },\n \"shippingTotal\": {\n \"netValue\": 24.3,\n \"grossValue\": 28.65,\n \"baseValue\": 24.3,\n \"taxValue\": 4.35,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n },\n \"payments\": [\n {\n \"paymentMethod\": \"deposit\",\n \"amount\": 134.56,\n \"installments\": 1,\n \"status\": \"O\"\n }\n ],\n \"taxes\": [\n {\n \"taxCode\": \"ICMSBI00\",\n \"taxBasis\": 134.56,\n \"taxValue\": 24.22\n },\n {\n \"taxCode\": \"IPIBI000\",\n \"taxBasis\": 134.56,\n \"taxValue\": 9.42\n },\n {\n \"taxCode\": \"STA1850\",\n \"taxBasis\": 215.97,\n \"taxValue\": 14.66\n }\n ],\n \"invoices\": [\n {\n \"docNum\": \"137\",\n \"docEntry\": \"137\",\n \"docStatus\": \"O\",\n \"docDate\": \"2020-01-24\",\n \"docDueDate\": \"2020-01-24\",\n \"taxDate\": \"2020-01-24\",\n \"docValue\": 158.64,\n \"nfeSeries\": \"1\",\n \"nfeNum\": \"90\",\n \"nfeType\": \"NFe\",\n \"nfeModel\": \"55\",\n \"nfeKey\": \"\",\n \"nfeValue\": 158.64,\n \"createdAt\": \"2020-01-24T15:34:24\",\n \"updatedAt\": \"2020-01-24T15:34:25\",\n \"canceledAt\": null\n }\n ]\n }\n ]\n}"}],"_postman_id":"d83a70da-0c30-4886-b2c9-98a6d3f3891f"},{"name":"Sale Order","id":"0b2c0d52-b7fc-4ee7-9192-87c75e560c4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"branch\": \"23\",\n \"orderNum\": \"1013\",\n \"dueDate\": \"\",\n \"sellerKey\": \"\",\n \"salesAgentKey\": \"\",\n \"mainUsage\": \"\",\n \"mainCostCenter\": \"\",\n \"whsCode\": \"\",\n \"paymentCondition***\": \"\",\n \"paymentMethod***\": \"\",\n \"carrierKey\": \"\",\n \"packDescription\": \"\",\n \"brand\": \"\",\n \"customOrderStatus\": \"\",\n \"customOrderStatusNotify\": \"\",\n \"customShipType\": \"\",\n \"customShipMethod\": \"\",\n \"insMktDoc\": \"false/invoice/delivery/downPayment\",\n \"comments\": \"\",\n \"remarksFooter\": \"\",\n \"customer\": {\n \"type\": \"C\",\n \"taxType\": \"C\",\n \"partnerId\": \"C001\",\n \"fullName\": \"Sport Club Corinthians Paulista\",\n \"aliasName\": \"Timão\",\n \"email\": \"campeão@corinthians.com.br\",\n \"phone\": \"2095-3000\",\n \"phoneSecondary\": \"11\",\n \"cellular\": \"11-9595-2000\",\n \"taxNumber\": \"61.902.722/0001-26\",\n \"stateTaxNumber\": \"113.440.120.113\",\n \"cityTaxNumber\": \"\",\n \"billingAddress\": {\n \"address1\": \"São Jorge\",\n \"address2\": \"\",\n \"city\": \"São Paulo\",\n \"postalCode\": \"03087-000\",\n \"stateCode\": \"SP\",\n \"community\": \"Tatuapé\",\n \"exteriorNumber\": \"777\",\n \"streetType\": \"Rua\",\n \"countryCode\": \"BR\"\n }\n },\n \"items\": [\n {\n \"codeBars\": \"\",\n \"productKey\": \"900.000.003\",\n \"productName\": \"Camisa Nike Flamengo I 09/10\",\n \"quantity\": 1,\n \"unit\": \"PAR\",\n \"unitPrice\": 49.9,\n \"taxBasis\": 49.9,\n \"comments\": \"\"\n }\n ],\n \"shipment\": {\n \"shippingAddress\": {\n \"receiverName *\": null,\n \"isMain *\": null,\n \"address1\": \"São Jorge 2\",\n \"address2\": \"\",\n \"city\": \"São Paulo\",\n \"postalCode\": \"03087-000\",\n \"stateCode\": \"SP\",\n \"community\": \"Tatuapé\",\n \"exteriorNumber\": \"777\",\n \"streetType\": \"Rua\",\n \"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 \"priceAdjustValue\": 0,\n \"priceAdjustType\": \"\",\n \"priceAdjustPromotionId\": \"\",\n \"priceAdjustCouponId\": \"\"\n },\n \"shippingTotal\": {\n \"netValue\": 9.81,\n \"grossValue\": 9.81,\n \"baseValue\": 9.81,\n \"taxValue\": 0,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n },\n \"payments\": [\n {\n \"paymentMethod\": \"creditCard\",\n \"installments\": 3,\n \"amount\": 49.71,\n \"details\": {\n \"tid\": \"a1a33b4e-92a0-4e78-9ea7-6cd4cbe40146\",\n \"cardName\": \"Visa\",\n \"acquirer\": null,\n \"authid\": \"11176253608FGC0S3U0B\",\n \"nsu\": \"025479\"\n },\n \"gateway\": {\n \"gatewayName\": \"\",\n \"gatewayOrderId\": \"\",\n \"gatewayPayId\": \"\"\n }\n },\n {\n \"paymentMethod\": \"transfer\",\n \"installments\": 1,\n \"amount\": 10.00\n }\n ],\n \"installments\": [\n {\n \"dueDate\": \"2021-07-16\",\n \"amount\": 10.00\n },\n {\n \"dueDate\": \"2021-08-01\",\n \"amount\": 20.00\n },\n {\n \"dueDate\": \"2021-08-10\",\n \"amount\": 20.00\n },\n {\n \"dueDate\": \"2021-08-30\",\n \"amount\": 9.71\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/orders","description":"

Insert sales order in ERP

(sapBusinessOne=17/ORDR, totvsProtheus=SC5)

This service allows to insert a new sales order in the ERP, with treatment for new and existing partner, physical separation of products, sales invoice and incoming payments.

The scenario will validate the data received, making selects in the ERP database.

A new sales order will be added if the sales order is not found on the ERP by branch + orderNum:

SAP B1: ORDR.BPLId + ORDR.NumAtCard
TOTVS Protheus: C5_FILIAL + C5_PEDECOM (note: field C5_PEDECOM is only 10 characters long and cannot be increased)

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.

SAP Business One: CRD7.TaxId0 (company / government) or CRD7.TaxId4 (person / employee)
TOTVS Protheus: A1_CGC (customer / lead) or A2_CGC (supplier)

The products sent for the service will be identified in the ERP:

SAP B1: OITM.CodeBars = codeBars or OITM.ItemCode = productKey
TOTVS Protheus: B1_CODBAR = codeBars or B1_COD = productKey

The following processes can be carried out after the inclusion of the sales order in the ERP:

Marketing Document insert: if GlobalProperty SalesOrderInsMktDoc|IG_USEMKTD=invoice|downPayment|delivery in API Setup, or if insMktDoc=invoice|downPayment|delivery in JSON request (delivery only SAPB1). If the process insert invoice or downPayment, the payments array is required in JSON request, and will be inserted Incoming Payment(s) for invoice or downPayment. PROTHEUS = downPayment not yet available...
Custom Payments Table insert: if there is payments in JSON request, the payments are inserted in the Payments Custom Table (for further use)
Picklist insert (SAPB1 only): if the GlobalProperty SalesOrderInsPicklist=true in API Setup, or if insPickist=true in JSON request

Comments:

Customer: [1] customer/type: C = customer, S = supplier, L = lead, [2] customer/taxType: P = person, C = company, G = government, E = employee. Each PN will have 2 registered addresses (CRD1, CRD7), namely: ShipToCode (S) = /customer/fullName OR /shipment/shippingAddress/firstName + \"\" + /shipment/shippingAddress/lastName, BillToCode (B) = /customer/fullName OR /customer/billingAddress/firstName + \"\" + /customer/billingAddress/lastName. Each PN will have 3 tax identification numbers (CRD12), namely: ShipToCode, BillToCode, empty.
Seller: sellerKey
Discounts: in total items (priceAdjustValue), in total freight (shipAdjustValue). shipAdjustType = minus or plus
items: Duplication of items on more than 1 order line is not accepted, basePrice: base/gross price, taxBasis: total value of the item (quantity * price), calculation date for tax
shipment: shipment data, as shipping address, carrier primary key in ERP, shipping method and carrier message
totals: 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, ...)
customStatus: sales order custom field definied in API Setup
customStatusNotify: sales order custom field definied in API Setup
customShipMethod: sales order custom field definied in API Setup
customShipType: sales order custom field definied in API Setup

Payments:\npaymentCondition: ERP payment condition key in ERP

paymentMethod: not working for SAP Business One and TOTVS Protheus
array payments: 5 payment methods are accepted (paymentMethod): transfer, boe, creditCard (mandatory fields: cardName and authid), cash, check
The ERP payment method code for TOTVS Protheus can be entered in the paymentMethodKey field
for payment with paymentMethod=creditCard you will need to inform details object (cardName, authid and nsu are required) - only SAP Business One
for paymentCondition of type 9 in TOTVS Protheus, you will need to inform installments array in first level with the pairs dueDate/amount (API dows not support maturities in percent, only in values)

For the use of user fields (UDF) created in the sales order table (SAPB1: ORDR / RDR1, TOTVS: SC5 / SC6), the respective registration must be performed in the Custom Table.

Request object has the following properties

Field	Type	Description
branch	string	Number branch
orderNum	string	Number Sales Order
brand	string	Brand
sellerKey	string	Seller Primary Key in ERP
salesAgentKey	string	Sales Agent Primary Key in ERP
carrierKey	string	Carrier Primary Key in ERP
mainUsage	string	Usage Primary Key in ERP
mainCostCenter	string	Cost Center Primary Key in ERP
whsCode	string	Warehouse Primary Key in ERP
comments	string	Comments in ERP
customer	object	Customer
customer.type	string	C=customer, S=supplier, L=lead
customer.taxType	string	P=person, C=company, G=government, E=employee
customer.partnerId	string	Id partner
customer.fullName	string	Customer full name
customer.aliasName	string	Customer alias name
customer.email	string	Customer emai
customer.phone	string	Customer phone Number
customer.phoneSecondary	string	Customer secondary phone number
customer.cellular	string	cell Customer phone number
customer.taxNumber	string	Customer identification number
customer.stateTaxNumber	string	State customer identification number
customer.cityTaxNumber	string	City customer identification number
customer.billingAddress	object	Customer billing addresses
customer.billingAddress.address1	string	Customer billing address1
customer.billingAddress.address2	string	Customer billing address2
customer.billingAddress.city	string	Customer billing city
customer.billingAddress.postalCode	string	Customer billing postal Code
customer.billingAddress.stateCode	string	Customer billing state Code
customer.billingAddress.community	string	Customer billing community
customer.billingAddress.exteriorNumber	string	Customer billing exterior number
customer.billingAddress.streetType	string	Customer billing type street
customer.billingAddress.countryCode	string	Customer billing country code
items	array	Order Items Object
productKey	string	Product key
productName	string	Product Name
quantity	number	Quantity
unit	string	Unit
unitPrice	number	Unit price
taxBasis	number	Tax Basis
shipment	object	Shipment
shipment.carrierKey	string	Carrier Primary Key in ERP
shipment.shippingMethod	string	Shipping method
shipment.carrierMessage	string	Carrier message
shipment.shippingAddress	array	Shipping adress
shippingAdress.address1	string	Shipping first adress
shippingAdress.address2	string	Shipping second adress
shippingAdress.city	string	Shipping city
shippingAdress.postalCode	string	Shipping postal Code
shippingAdress.stateCode	string	Shipping state Code
shippingAdress.community	string	Shipping community
shippingAdress.exteriorNumber	string	Shipping exterior number
shippingAdress.streetType	string	Shipping type street
shippingAdress.countryCode	string	Shipping country Code
totals	object	Totals
totals.orderTotal	object	Order totals
totals.orderTotal.netValue	number	Totals net value
totals.orderTotal.grossValue	number	Totals gross value
totals.orderTotal.baseValue	number	Totals base value
totals.orderTotal.taxValue	number	Totals taxes that increase the value
totals.merchandizeTotal	object	Merchandize Totals
totals.merchandizeTotal.netValue	number	Net value merchandize
totals.merchandizeTotal.grossValue	number	Gross value merchandize
totals.merchandizeTotal.baseValue	number	Base value merchandize
totals.merchandizeTotal.taxValue	number	Taxes that increase the value merchandizeTotal
totals.merchandizeTotal.priceAdjustValue	number	Discounts in total items
totals.merchandizeTotal.priceAdjustType	string	Price adjustment type
totals.merchandizeTotal.priceAdjustPromotionId	string	Price adjustment Id promotion
totals.merchandizeTotal.priceAdjustCouponId	string	Price adjustment Id coupon
totals.shippingTotal	object	Shipping totals
totals.shippingTotal.netValue	number	Shipping total Net value
totals.shippingTotal.grossValue	number	Shipping total Gross value
totals.shippingTotal.baseValue	number	Shipping totals base value
totals.shippingTotal.taxValue	number	Shipping total Tax value
totals.shippingTotal.priceAdjustValue	number	Discounts on total shipping
totals.shippingTotal.priceAdjustType	string	Price adjust type
totals.shippingTotal.priceAdjustPromotionId	string	Price adjust Id promotion
totals.shippingTotal.priceAdjustCouponId	string	Price adjust Id coupon
payments	array	Payments
payments.paymentMethod	string	Payment Method
payments.installments	number	Installments
payments.amount	number	Amount
payments.details	object	Details
payments.details.tid	string	Tid
payments.details.cardName	string	Card name
payments.details.acquirer	booleano	Acquirer
payments.details.authid	string	Authid
payments.details.nsu	string	nsu
payments.gateway	object	gateway
payments.gateway.gatewayName	string	Gateway name
payments.gateway.gatewayOrderId	string	Gateway Id order
payments.gateway.gatewayPayId	string	Gateway Id payment
payments.paymentMethod	string	Payment Method
payments.installments	number	Installments
payments.amount	number	Amount
installments	array	maturities for paymentCondition of type 9 (only TOTVS Protheus)
installments.dueDate	string	maturity date
installments.amount	number	maturity amount

* = Required field

Response object has the following properties

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
package	string	package
process	string	process
system	string	System
target	string	Target
user	string	user
host	string	host
effectiveTimestamp	string	Effective Time stamp
code	string	Code
success	booleano	Success
values	array	Values
values.object	string	Object
values.table	string	Table
values.action	string	action
values.erpKey	string	Erpkey

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"11834bc6-bff3-4272-b68a-24430df885aa","id":"11834bc6-bff3-4272-b68a-24430df885aa","name":"salesAPI - Sales API for ERP (v2)","type":"collection"}},"urlObject":{"path":["orders"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[{"id":"60904a1e-e8af-44e9-8af1-f225f56eb5b5","name":"Sale Order - SAP Business One","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"branch\": \"1\",\n \"orderNum\": \"1010\",\n \"brand\": \"3\",\n \"customer\": {\n\t\t\"type\": \"C\",\n\t\t\"taxType\": \"C\",\n\t\t\"partnerId\": \"C001\",\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 \"codeBars\": \"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 \"shipment\": {\n \"shippingMethod\": \"BR-Standard-Shipping\",\n \"carrierMessage\": \"\",\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 \"priceAdjustValue\": 0,\n \"priceAdjustType\": \"\",\n \"priceAdjustPromotionId\": \"\",\n \"priceAdjustCouponId\": \"\"\n },\n \"shippingTotal\": {\n \"netValue\": 9.81,\n \"grossValue\": 9.81,\n \"baseValue\": 9.81,\n \"taxValue\": 0,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n },\n \"payments\": [\n {\n \"paymentMethod\": \"creditCard\",\n \"installments\": 3,\n \"amount\": 49.71,\n \"details\": {\n \t\"tid\": \"a1a33b4e-92a0-4e78-9ea7-6cd4cbe40146\",\n \t\"cardName\": \"Visa\",\n \t\"acquirer\": null,\n \t\"authid\": \"11176253608FGC0S3U0B\",\n \t\"nsu\": \"025479\"\n },\n \"gateway\": {\n \t\"gatewayName\": \"\",\n \t\"gatewayOrderId\": \"\",\n \t\"gatewayPayId\": \"\"\n }\n },\n {\n \"paymentMethod\": \"transfer\",\n \"installments\": 1,\n \"amount\": 10.00\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/orders"},"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":"Tue, 24 Mar 2020 01:03:51 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"Orders\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"orders\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.104\",\n \"effectiveTimestamp\": \"2020-03-23T22:03:27\",\n \"code\": \"200\",\n \"success\": true,\n \"useCustom\": \"true\",\n \"values\": [\n {\n \"object\": \"2\",\n \"table\": \"OCRD\",\n \"action\": \"Update\",\n \"erpKey\": \"C001\"\n },\n {\n \"object\": \"17\",\n \"table\": \"ORDR\",\n \"action\": \"Insert\",\n \"erpKey\": \"273\"\n },\n {\n \"object\": \"13\",\n \"table\": \"OINV\",\n \"action\": \"Insert\",\n \"erpKey\": \"171\"\n },\n {\n \"object\": \"24\",\n \"table\": \"ORCT\",\n \"action\": \"Insert\",\n \"erpKey\": \"216\"\n },\n {\n \"object\": \"24\",\n \"table\": \"ORCT\",\n \"action\": \"Insert\",\n \"erpKey\": \"217\"\n }\n ]\n}"},{"id":"652e7797-3129-4403-b36a-44085bda86f8","name":"Sale Order - TOTVS Protheus","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"branch\": \"1\",\n \"orderNum\": \"1024\",\n \"customer\": {\n\t\t\"type\": \"C\",\n\t\t\"taxType\": \"C\",\n\t\t\"partnerId\": \"C001\",\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\": \"900.000.003\",\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 \"shipment\": {\n \"shippingMethod\": \"BR-Standard-Shipping\",\n \"carrierMessage\": \"\",\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 \"priceAdjustValue\": 0,\n \"priceAdjustType\": \"\",\n \"priceAdjustPromotionId\": \"\",\n \"priceAdjustCouponId\": \"\"\n },\n \"shippingTotal\": {\n \"netValue\": 9.81,\n \"grossValue\": 9.81,\n \"baseValue\": 9.81,\n \"taxValue\": 0,\n \"shipAdjustValue\": 0,\n \"shipAdjustType\": \"\",\n \"shipAdjustPromotionId\": \"\",\n \"shipAdjustCouponId\": \"\"\n }\n },\n \"payments\": [\n {\n \"paymentMethod\": \"creditCard\",\n \"installments\": 3,\n \"amount\": 49.71,\n \"details\": {\n \t\"tid\": \"a1a33b4e-92a0-4e78-9ea7-6cd4cbe40146\",\n \t\"cardName\": \"Visa\",\n \t\"acquirer\": null,\n \t\"authid\": \"11176253608FGC0S3U0B\",\n \t\"nsu\": \"025479\"\n },\n \"gateway\": {\n \t\"gatewayName\": \"\",\n \t\"gatewayOrderId\": \"\",\n \t\"gatewayPayId\": \"\"\n }\n },\n {\n \"paymentMethod\": \"transfer\",\n \"installments\": 1,\n \"amount\": 10.00\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/orders"},"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-Length","value":"593"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"salesAPI\",\n \"process\": \"Orders\",\n \"system\": \"totvsProtheus\",\n \"target\": \"orders\",\n \"user\": \"intergate\",\n \"host\": \"127.0.0.1\",\n \"effectiveTimestamp\": \"2020-04-01T18:26:14\",\n \"code\": \"200\",\n \"success\": true,\n \"values\": [\n {\n \"object\": \"2\",\n \"table\": \"SA1\",\n \"action\": \"Update\",\n \"erpKey\": \"00003601\"\n },\n {\n \"object\": \"17\",\n \"table\": \"SC5\",\n \"action\": \"Insert\",\n \"erpKey\": \"000032\"\n },\n {\n \"object\": \"13\",\n \"table\": \"SF2\",\n \"action\": \"Insert\",\n \"erpKey\": \"1/000030\"\n },\n {\n \"object\": \"24\",\n \"table\": \"FK1\",\n \"action\": \"Insert\",\n \"erpKey\": \"89ca0b2836b0437481AL\"\n },\n {\n \"object\": \"24\",\n \"table\": \"FK1\",\n \"action\": \"Insert\",\n \"erpKey\": \"89ca0b2836b0437481AM\"\n }\n ]\n}"}],"_postman_id":"0b2c0d52-b7fc-4ee7-9192-87c75e560c4f"},{"name":"Order Status","id":"78ff8d56-7623-4119-9dce-1e5021760e4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/orderStatus?createdFrom=2020-01-01&createdTo=2020-12-31&branch=1&partnerKey=NEW&sellerKey=NEW&salesAgentKey=NEW&carrierKey=NEW&docStatus=NEW&erpKey=NEW&docNum=NEW&orderNum=NEW&customStatus=2&customStatusNotify=NEW&customShipMethod=NEW&customShipType=NEW&customOrderKey=NEW&pageNum=1&updatedAt=2021-06-07T10:00:00","description":"

Search sales order status changes in ERP

(sapBusinessOne=17/ORDR)

This service will allow you to search sales orders status on the ERP.

Searching sales orders status allows you to filter the ERP by:

List search: by createdFrom + createdTo {required}, by branch, partnerKey, sellerKey, salesAgentKey, carrierKey, docStatus or any of four custom fields definied in this service {optional}
Unitary search: by erpKey or orderNum or docNum or customOrderKey

The orders service will consider sales orders with:

SAP Business One: ORDR.ObjType = 17
TOTVS Protheus: C5_TIPO IN 'N', 'C', 'I', 'P'

Comments:

branch: 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=returned
customOrderKey: sales order custom field definied in API Setup, and present in filter and response
customStatus: sales order custom field definied in API Setup, and present in filter and response
customStatusNotify: sales order custom field definied in API Setup, and present in filter and response
customShipMethod: sales order custom field definied in API Setup, and present in filter and response
customShipType: sales order custom field definied in API Setup, and present in filter and response
customTrackingKey: sales order custom field definied in API Setup, and present in response
customTrackingUrl: sales order custom field definied in API Setup, and present in response

This service will allow you to search the sales order status list in two situations:

Full Search: will result in all orders from a specific branch that had a status change in the createdFrom/createdTo period.
Incremental Search: will result in all orders from a specific branch that have changed status in the createdFrom / createdTo period and after a given date / time provided in the request. 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 (OIVL.CreateDate and OIVL.CreateTime), [2] TOTVS Protheus: not implemented

The response will inform:

The number of returned objects in count field

For list search the pagination feature in the response will be used, where the following fields are used to control the pagination:

pageSize = 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 does not have user field (UDF) treatment.

Initial create date to filter change sales orders (required if not unitary search)

\n","type":"text/plain"},"key":"createdFrom","value":"2020-01-01"},{"description":{"content":"

Final create date to filter sales 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":"NEW"},{"description":{"content":"

Seller Primary Key in ERP (optional in list search)

\n","type":"text/plain"},"key":"sellerKey","value":"NEW"},{"description":{"content":"

Sales Agent Primary Key in ERP (optional in list search)

\n","type":"text/plain"},"key":"salesAgentKey","value":"NEW"},{"description":{"content":"

Carrier Primary Key in ERP to filter sales order (optional in list search - depends on UDF in API setup - NEW)

\n","type":"text/plain"},"key":"carrierKey","value":"NEW"},{"description":{"content":"

Default Order Status to filter sales order (optional in list search - NEW)

\n","type":"text/plain"},"key":"docStatus","value":"NEW"},{"description":{"content":"

Order Primary Key in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"erpKey","value":"NEW"},{"description":{"content":"

Order Document Number in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"docNum","value":"NEW"},{"description":{"content":"

Partner Order Number in ERP (optional - unitary search)

\n","type":"text/plain"},"key":"orderNum","value":"NEW"},{"description":{"content":"