{"info":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","description":"

This document contains the necessary data and requirements for integration with the finAPI conector, a passive API to connect Finantial and Accounting systems with ERP systems, as SAP Business One or TOTVS Protheus.

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

chartAccounts: search chart of accounts in ERP
costCentres: search cost/profit centres in ERP
financialProjects: search financial projects in ERP
bankAccounts: search bank accounts in ERP
payConditions: search payment conditions in ERP
payMethods: search payment methods in ERP
creditCards: search credit cards in ERP
journalEntries: search journal entries in ERP
bankMovements: search bank movements in ERP
finantialDeposits: search finantial deposits in ERP
billOfExchanges: search bill of exchanges in ERP
checks: search checks in ERP

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

Authentication: finAPI 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":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","publishedId":"TVKFzbno","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-09-24T23:36:40.000Z"},"item":[{"name":"Base Objects","item":[{"name":"Chart of Accounts","id":"a6b2bbb4-59bd-48ab-8d42-19ef1ee71235","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/chartAccounts?erpKey=1&pageNum=2&updatedAt=2021-11-01T00:00:00","description":"

Search Chart of Accounts in ERP

(sapBusinessOne=1/OACT, totvsProtheus=CT1)

The search of Chart of Accounts allows you to filter the ERP by:

List
Unitary: by erpKey

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

The Chart of Accounts service will consider as valid Accounts:

SAP Business One: [1] OACT.FrozenFor=N
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.

Account 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":"2"},{"description":{"content":"

Date do filter modified registers - incremental search (optional) [NEW]

\n","type":"text/plain"},"key":"updatedAt","value":"2021-11-01T00:00:00"}],"variable":[]}},"response":[{"id":"7bb76ef8-eec1-4da1-bf13-42f8c0a51670","name":"Chart of Accounts - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/chartAccounts","host":["{{endpoint}}"],"path":["chartAccounts"],"query":[{"key":"erpKey","value":"1","description":"Account 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":"Wed, 14 Oct 2020 13:29:07 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"finAPI\",\n \"process\": \"ChartAccounts\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"chartAccounts\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-10-14T10:28:51\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 500,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 3,\n \"values\": [\n {\n \"erpKey\": \"1.1\",\n \"fullName\": \"CIRCULANTE\",\n \"isTitle\": true,\n \"isCash\": false,\n \"fatherKey\": \"100000000000000\",\n \"level\": 2,\n \"accountType\": \"balance\",\n \"groupKey\": \"1\",\n \"groupDesc\": \"Ativo\",\n \"exportCode\": \"\",\n \"referenceCode\": \"\",\n \"balanceCurrent\": 0,\n \"balanceOpening\": 0,\n \"createdAt\": \"2006-01-01T00:00:00\",\n \"updatedAt\": \"2014-06-15T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"1.1.1\",\n \"fullName\": \"DISPONÍVEL\",\n \"isTitle\": true,\n \"isCash\": false,\n \"fatherKey\": \"1.1\",\n \"level\": 3,\n \"accountType\": \"balance\",\n \"groupKey\": \"1\",\n \"groupDesc\": \"Ativo\",\n \"exportCode\": \"\",\n \"referenceCode\": \"\",\n \"balanceCurrent\": 0,\n \"balanceOpening\": 0,\n \"createdAt\": \"2006-01-01T00:00:00\",\n \"updatedAt\": \"2014-06-15T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"1.1.1.1\",\n \"fullName\": \"Bens Numerários\",\n \"isTitle\": true,\n \"isCash\": false,\n \"fatherKey\": \"1.1.1\",\n \"level\": 4,\n \"accountType\": \"balance\",\n \"groupKey\": \"1\",\n \"groupDesc\": \"Ativo\",\n \"exportCode\": \"\",\n \"referenceCode\": \"\",\n \"balanceCurrent\": 0,\n \"balanceOpening\": 0,\n \"createdAt\": \"2006-01-01T00:00:00\",\n \"updatedAt\": \"2014-06-15T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"1.1.1.1.1\",\n \"fullName\": \"Caixa\",\n \"isTitle\": false,\n \"isCash\": true,\n \"fatherKey\": \"1.1.1.1\",\n \"level\": 5,\n \"accountType\": \"balance\",\n \"groupKey\": \"1\",\n \"groupDesc\": \"Ativo\",\n \"exportCode\": \"\",\n \"referenceCode\": \"\",\n \"balanceCurrent\": 458.9,\n \"balanceOpening\": 0,\n \"createdAt\": \"2006-01-01T00:00:00\",\n \"updatedAt\": \"2014-07-23T00:00:00\",\n \"canceledAt\": null\n }\n ]\n}"},{"id":"cdd6f2fb-3abf-4a83-b983-931a2bc1d3aa","name":"Chart of Accounts - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/chartAccounts","host":["{{endpoint}}"],"path":["chartAccounts"],"query":[{"key":"erpKey","value":"1","description":"Account 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\": \"finAPI\",\n \"process\": \"ChartAccounts\",\n \"system\": \"totvsProtheus\",\n \"target\": \"chartAccounts\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-12T13:14:14\",\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\": \"1\",\n \"fullName\": \"ATIVO\",\n \"isTitle\": true,\n \"isCash\": null,\n \"fatherKey\": \"\",\n \"level\": null,\n \"accountType\": \"\",\n \"groupKey\": \"\",\n \"groupDesc\": \"\",\n \"exportCode\": \"1\",\n \"referenceCode\": \"\",\n \"balanceCurrent\": 0,\n \"balanceOpening\": 0,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"11\",\n \"fullName\": \"ATIVO CIRCULANTE\",\n \"isTitle\": true,\n \"isCash\": null,\n \"fatherKey\": \"1\",\n \"level\": null,\n \"accountType\": \"\",\n \"groupKey\": \"\",\n \"groupDesc\": \"\",\n \"exportCode\": \"1\",\n \"referenceCode\": \"\",\n \"balanceCurrent\": 0,\n \"balanceOpening\": 0,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"1101\",\n \"fullName\": \"DISPONIBILIDADES\",\n \"isTitle\": true,\n \"isCash\": null,\n \"fatherKey\": \"11\",\n \"level\": null,\n \"accountType\": \"\",\n \"groupKey\": \"\",\n \"groupDesc\": \"\",\n \"exportCode\": \"1\",\n \"referenceCode\": \"\",\n \"balanceCurrent\": 0,\n \"balanceOpening\": 0,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"110101\",\n \"fullName\": \"BENS NUMERARIOS\",\n \"isTitle\": true,\n \"isCash\": null,\n \"fatherKey\": \"1101\",\n \"level\": null,\n \"accountType\": \"\",\n \"groupKey\": \"\",\n \"groupDesc\": \"\",\n \"exportCode\": \"1\",\n \"referenceCode\": \"\",\n \"balanceCurrent\": 0,\n \"balanceOpening\": 0,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"110101001\",\n \"fullName\": \"CAIXA MATRIZ\",\n \"isTitle\": false,\n \"isCash\": null,\n \"fatherKey\": \"110101\",\n \"level\": null,\n \"accountType\": \"\",\n \"groupKey\": \"\",\n \"groupDesc\": \"\",\n \"exportCode\": \"110101001\",\n \"referenceCode\": \"\",\n \"balanceCurrent\": 0,\n \"balanceOpening\": 0,\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ],\n \"count\": 5\n}"}],"_postman_id":"a6b2bbb4-59bd-48ab-8d42-19ef1ee71235"},{"name":"Bank Accounts","id":"2ae0cd8f-3317-4c60-be0e-d6a45f8a1fe6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/bankAccounts?erpKey=1&pageNum","description":"

Search Bank Accounts in ERP

(sapBusinessOne=3/DSC1, totvsProtheus=SA6)

The search of Bank Accounts 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 bank accounts service will consider as valid bank accounts:

SAP Business One:
TOTVS Protheus:

Comments:

erpKey: SAP Business One (DSC1.AbsEntry), TOTVS Protheus (A6_COD+\"\"+A6_AGENCIA+\"\"+A6_NUMCON)

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.

Bank Account 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":"2f5b78e3-0fbb-441f-a101-9c8b72d525ed","name":"Bank Accounts - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/bankAccounts","host":["{{endpoint}}"],"path":["bankAccounts"],"query":[{"key":"erpKey","value":"1","description":"Bank Account 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\": \"finAPI\",\n \"process\": \"bankAccounts\",\n \"system\": \"totvsProtheus\",\n \"target\": \"bankAccounts\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-12T15:31:28\",\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\": \"341_0132_08654\",\n \"fullName\": \"ITAU PJ\",\n \"bankCode\": \"341\",\n \"bankBranch\": \"0132\",\n \"bankAccount\": \"08654\",\n \"bankAccountKey\": \"7\",\n \"phone\": \"\",\n \"accountCode\": \"\",\n \"bankAddress\": {\n \"streetType\": \"\",\n \"address\": \"\",\n \"exteriorNumber\": \"\",\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\": \"CX1_00001_0000000001\",\n \"fullName\": \"CAIXA GERAL\",\n \"bankCode\": \"CX1\",\n \"bankBranch\": \"00001\",\n \"bankAccount\": \"0000000001\",\n \"bankAccountKey\": \"\",\n \"phone\": \"\",\n \"accountCode\": \"\",\n \"bankAddress\": {\n \"streetType\": \"\",\n \"address\": \"\",\n \"exteriorNumber\": \"\",\n \"community\": \"\",\n \"city\": \"\",\n \"county\": \"\",\n \"stateCode\": \"\",\n \"countryCode\": \"\",\n \"postalCode\": \"\"\n },\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ],\n \"count\": 2\n}"},{"id":"c55bece2-1e26-4641-9d07-422bf65074ec","name":"Bank Accounts - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/bankAccounts","host":["{{endpoint}}"],"path":["bankAccounts"],"query":[{"description":"Bank Account Primary Key in ERP (optional)","key":"erpKey","value":"1","disabled":true},{"description":"Number of page - pagination (optional)","key":"pageNum","type":"text","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"JSESSIONID=8FFE74C75D22A7E493343FC9CA17AF12; 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, 14 Oct 2020 13:33:53 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"finAPI\",\n \"process\": \"BankAccounts\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"bankAccounts\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-10-14T10:33:50\",\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\": \"1\",\n \"fullName\": \"\",\n \"bankCode\": \"341\",\n \"bankBranch\": \"3748\",\n \"bankAccount\": \"03761\",\n \"bankAccountKey\": \"\",\n \"phone\": \"\",\n \"accountCode\": \"1.1.1.2.2\",\n \"createdAt\": null,\n \"updatedAt\": \"2009-06-23T00:00:00\",\n \"canceledAt\": null,\n \"bankAddress\": {\n \"streetType\": \"Rua\",\n \"address\": \"Arizona\",\n \"exteriorNumber\": \"1467\",\n \"community\": \"Morumbi\",\n \"city\": \"São Paulo\",\n \"county\": \"5344\",\n \"stateCode\": \"SP\",\n \"countryCode\": \"BR\",\n \"postalCode\": \"04567-003\"\n }\n }\n ]\n}"}],"_postman_id":"2ae0cd8f-3317-4c60-be0e-d6a45f8a1fe6"},{"name":"Bank Instructions [new]","id":"f5288751-0c61-471e-8cd9-330b78db7249","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/bankInstructions?bankCode=237&instructionType=S&instructionCode&pageNum=3","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}},"urlObject":{"path":["bankInstructions"],"host":["{{endpoint}}"],"query":[{"key":"bankCode","value":"237"},{"key":"instructionType","value":"S"},{"key":"instructionCode","value":null},{"key":"pageNum","value":"3"}],"variable":[]}},"response":[],"_postman_id":"f5288751-0c61-471e-8cd9-330b78db7249"}],"id":"5632b98b-4b71-4091-beba-dab87c671bd0","_postman_id":"5632b98b-4b71-4091-beba-dab87c671bd0","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}}},{"name":"Journal Entries**","item":[{"name":"Journal Entries","id":"f4ffbca4-acdf-474e-b532-7b4680b428c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/journalEntries?createdFrom=2020-01-01&createdTo=2020-11-30&branch=1&costCentreKey=C001&erpKey=120&docNum=49084&pageNum=2&updatedAt=2020-10-26T18:00:00","description":"

Search journal entries in ERP

(sapBusinessOne=30/OJDT, totvsProtheus=CT2)

This service will allow to search journal entries in the ERP.

The search of journal entries allows filtering the ERP by:

List Search: by createdFrom + createdTo {required}, by branch, costCenterKey {optional = NOT IMPLEMENTED}
Unitary Search: erpKey or docNum (SAP Business One only)

If no field for unitary search (erpKey or docNum) is informed in the request, the search for journal entries is carried out by date of creation from/to (which become mandatory).

The journal entries service will consider journal entries with:

SAP Business One: [1] OJDT.ObjType=30
TOTVS Protheus: [1] CT2_TPSALD=1, [2] CT2_VALOR>0

For TOTVS Protheus only: registers with CT2_DC=3 (double match) will return 2 objects in values array, one for debit and other for credit

Comments:

branch: SAP Business One (JDT1.BPLId), TOTVS Protheus (CT2_FILIAL)
costCenterKey: SAP Business One (JDT1.ProfitCode), TOTVS Protheus (CT2_CCD or CT2_CCC)
erpKey: SAP Business One (OJDT.TransId), TOTVS Protheus (CT2_SEQUEN)
docNum: SAP Business One (OJDT.Number), TOTVS Protheus (CT2_DATA+''+CT2_LOTE+''+CT2_SBLOTE+'_'+CT2_DOC)
docStatus: O = open, C = closed => SAP Business One (JDT1.Closed), TOTVS Protheus (CT2_CONFST)

Data returned in response: journal entries data and lines.

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 will allow you to search the journal entries list in two situations:

Full Search: will result in all journal entries, according to filters.
Incremental Search: will result in all journal entries, according to filters, which have been included and/or changed in the main register after a certain date/time provided in the request. In the Incremental Search, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which exit notes should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields for the Document record in SAP Business One (OJDT.CreateDate, OJDT.UpdateDate, OJDT.CreateTime), [2] TOTVS Protheus: the CT2_USERLGI and CT2_USERLGA fields

For the use of user fields (UDF) created in the table of journal entries (SAPB1: OJDT, TOTVS: CT2), the respective registration must be performed in the Custom Table.

Initial create date to filter journal entries (required in list search)

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

Final create date to filter journal entries (required in list search)

\n","type":"text/plain"},"key":"createdTo","value":"2020-11-30"},{"description":{"content":"

Branch (optional in list search) => ONLY PROTHEUS

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

Cost Centre Primary Key in ERP (optional - list search) => ONLY PROTHEUS

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

Journal Entry Primary Key in ERP (optional - unitary search)

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

Journal Entry Document Number in ERP (optional - unitary search)

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

Number of page - pagination (optional)

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

Date do filter modified registers - incremental search (optional)

\n","type":"text/plain"},"key":"updatedAt","value":"2020-10-26T18:00:00"}],"variable":[]}},"response":[{"id":"0728df4f-867c-4206-b3c9-892fa6ad0820","name":"Journal Entries - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/journalEntries?createdFrom=2020-06-01&createdTo=2020-08-27","host":["{{endpoint}}"],"path":["journalEntries"],"query":[{"key":"createdFrom","value":"2020-06-01","description":"Initial create date to filter journal entries (required if not unitary search)"},{"key":"createdTo","value":"2020-08-27","description":"Final create date to filter journal entries (required if not unitary search)"},{"description":"Branch (optional in list search) => NOT IMPLEMENTED","key":"branch","value":"1","disabled":true},{"description":"Cost Centre Primary Key in ERP (optional in list search) => NOT IMPLEMENTED SAPB1","key":"costCentreKey","value":"C001","disabled":true},{"key":"erpKey","value":"120","description":"Journal Entry Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"49084","description":"Journal Entry Document Number in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-24T15:34:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"Set-Cookie","value":"JSESSIONID=451E1FB8D411A767D075BBA515575664; 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, 14 Oct 2020 15:17:37 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"finAPI\",\n \"process\": \"JournalEntries\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"journalEntries\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-10-14T12:17:33\",\n \"createdFrom\": \"2020-06-01\",\n \"createdTo\": \"2020-08-27\",\n \"code\": \"200\",\n \"success\": true,\n \"useCustom\": \"false\",\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 3,\n \"values\": [\n {\n \"erpKey\": \"1398\",\n \"docNum\": \"1398\",\n \"docDate\": \"2020-06-19\",\n \"docDueDate\": \"2020-06-19\",\n \"taxDate\": \"2020-06-19\",\n \"debitTotal\": 139.16,\n \"creditTotal\": 139.16,\n \"baseObject\": \"13\",\n \"baseKey\": \"175\",\n \"comments\": \"A/R Invoices - C001\",\n \"createdAt\": \"2020-06-19T17:59:00\",\n \"updatedAt\": \"2020-06-19T00:00:00\",\n \"canceledAt\": null,\n \"lines\": [\n {\n \"lineNum\": \"0\",\n \"account\": \"1.1.2.1.1\",\n \"aliasAccount\": \"C001\",\n \"accountName\": \"(uma conta para cada cliente)\",\n \"type\": \"D\",\n \"debitValue\": 63.89,\n \"creditValue\": 0,\n \"contraAccount\": \"3.1.1.1.1\",\n \"costCentre\": \"\",\n \"project\": \"Amadeus\",\n \"baseObject\": \"13\",\n \"baseKey\": \"175\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n },\n {\n \"lineNum\": \"1\",\n \"account\": \"2.1.1.6.1\",\n \"aliasAccount\": \"2.1.1.6.1\",\n \"accountName\": \"ICMS a recolher\",\n \"type\": \"C\",\n \"debitValue\": 0,\n \"creditValue\": 12.92,\n \"contraAccount\": \"C001\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"13\",\n \"baseKey\": \"175\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n },\n {\n \"lineNum\": \"2\",\n \"account\": \"2.1.1.6.2\",\n \"aliasAccount\": \"2.1.1.6.2\",\n \"accountName\": \"IPI a recolher\",\n \"type\": \"C\",\n \"debitValue\": 0,\n \"creditValue\": 4.18,\n \"contraAccount\": \"C001\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"13\",\n \"baseKey\": \"175\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n },\n {\n \"lineNum\": \"3\",\n \"account\": \"3.1.1.1.1\",\n \"aliasAccount\": \"3.1.1.1.1\",\n \"accountName\": \"Mercado nacional\",\n \"type\": \"C\",\n \"debitValue\": 0,\n \"creditValue\": 49.9,\n \"contraAccount\": \"C001\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"13\",\n \"baseKey\": \"175\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n },\n {\n \"lineNum\": \"4\",\n \"account\": \"1.1.3.1.1\",\n \"aliasAccount\": \"1.1.3.1.1\",\n \"accountName\": \"Mercadorias para revenda\",\n \"type\": \"C\",\n \"debitValue\": 0,\n \"creditValue\": 62.35,\n \"contraAccount\": \"C001\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"13\",\n \"baseKey\": \"175\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n },\n {\n \"lineNum\": \"5\",\n \"account\": \"3.2.1.1\",\n \"aliasAccount\": \"3.2.1.1\",\n \"accountName\": \"CUSTOS DOS PRODUTOS VENDIDOS\",\n \"type\": \"D\",\n \"debitValue\": 62.35,\n \"creditValue\": 0,\n \"contraAccount\": \"C001\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"13\",\n \"baseKey\": \"175\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n },\n {\n \"lineNum\": \"6\",\n \"account\": \"3.1.1.2.3\",\n \"aliasAccount\": \"3.1.1.2.3\",\n \"accountName\": \"Frete Seguro Outros\",\n \"type\": \"C\",\n \"debitValue\": 0,\n \"creditValue\": 9.81,\n \"contraAccount\": \"C001\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"13\",\n \"baseKey\": \"175\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n },\n {\n \"lineNum\": \"7\",\n \"account\": \"3.1.2.3.2\",\n \"aliasAccount\": \"3.1.2.3.2\",\n \"accountName\": \"ICMS – Imposto sobre circulação de mercadorias\",\n \"type\": \"D\",\n \"debitValue\": 12.92,\n \"creditValue\": 0,\n \"contraAccount\": \"C001\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"13\",\n \"baseKey\": \"175\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n }\n ]\n },\n {\n \"erpKey\": \"1399\",\n \"docNum\": \"1399\",\n \"docDate\": \"2020-06-19\",\n \"docDueDate\": \"2020-08-25\",\n \"taxDate\": \"2020-06-19\",\n \"debitTotal\": 49.71,\n \"creditTotal\": 49.71,\n \"baseObject\": \"24\",\n \"baseKey\": \"223\",\n \"comments\": \"Incoming Payments - C001\",\n \"createdAt\": \"2020-06-19T18:00:00\",\n \"updatedAt\": \"2020-06-19T00:00:00\",\n \"canceledAt\": null,\n \"lines\": [\n {\n \"lineNum\": \"0\",\n \"account\": \"1.1.2.10.2\",\n \"aliasAccount\": \"1.1.2.10.2\",\n \"accountName\": \"Visa\",\n \"type\": \"D\",\n \"debitValue\": 16.57,\n \"creditValue\": 0,\n \"contraAccount\": \"C001\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"24\",\n \"baseKey\": \"223\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n },\n {\n \"lineNum\": \"1\",\n \"account\": \"1.1.2.10.2\",\n \"aliasAccount\": \"1.1.2.10.2\",\n \"accountName\": \"Visa\",\n \"type\": \"D\",\n \"debitValue\": 16.57,\n \"creditValue\": 0,\n \"contraAccount\": \"C001\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"24\",\n \"baseKey\": \"223\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n },\n {\n \"lineNum\": \"2\",\n \"account\": \"1.1.2.10.2\",\n \"aliasAccount\": \"1.1.2.10.2\",\n \"accountName\": \"Visa\",\n \"type\": \"D\",\n \"debitValue\": 16.57,\n \"creditValue\": 0,\n \"contraAccount\": \"C001\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"24\",\n \"baseKey\": \"223\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n },\n {\n \"lineNum\": \"3\",\n \"account\": \"1.1.2.1.1\",\n \"aliasAccount\": \"C001\",\n \"accountName\": \"(uma conta para cada cliente)\",\n \"type\": \"C\",\n \"debitValue\": 0,\n \"creditValue\": 49.71,\n \"contraAccount\": \"1.1.2.10.2\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"24\",\n \"baseKey\": \"223\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n }\n ]\n },\n {\n \"erpKey\": \"1400\",\n \"docNum\": \"1400\",\n \"docDate\": \"2020-06-19\",\n \"docDueDate\": \"2020-06-19\",\n \"taxDate\": \"2020-06-19\",\n \"creditTotal\": 10,\n \"debitTotal\": 10,\n \"baseObject\": \"24\",\n \"baseKey\": \"224\",\n \"comments\": \"Incoming Payments - C001\",\n \"createdAt\": \"2020-06-19T18:01:00\",\n \"updatedAt\": \"2020-06-19T00:00:00\",\n \"canceledAt\": null,\n \"lines\": [\n {\n \"lineNum\": \"0\",\n \"account\": \"1.1.1.2.2\",\n \"aliasAccount\": \"1.1.1.2.2\",\n \"accountName\": \"Banco Itaú\",\n \"type\": \"D\",\n \"debitValue\": 10,\n \"creditValue\": 0,\n \"contraAccount\": \"C001\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"24\",\n \"baseKey\": \"224\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n },\n {\n \"lineNum\": \"1\",\n \"account\": \"1.1.2.1.1\",\n \"aliasAccount\": \"C001\",\n \"accountName\": \"(uma conta para cada cliente)\",\n \"type\": \"C\",\n \"debitValue\": 0,\n \"creditValue\": 10,\n \"contraAccount\": \"1.1.1.2.2\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"24\",\n \"baseKey\": \"224\",\n \"branch\": \"1\",\n \"branchName\": \"MATRIZ\",\n \"branchTaxNumber\": \"98.899.922/0001-87\",\n \"status\": \"O\"\n }\n ]\n }\n ]\n}"},{"id":"7ef975a3-33fd-40c4-bfd4-b676a6190fdc","name":"Journal Entries - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/journalEntries?createdFrom=2020-11-01&createdTo=2020-11-30","host":["{{endpoint}}"],"path":["journalEntries"],"query":[{"key":"createdFrom","value":"2020-11-01","description":"Initial create date to filter journal entries (required if not unitary search)"},{"key":"createdTo","value":"2020-11-30","description":"Final create date to filter journal entries (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional in list search) => NOT IMPLEMENTED SAPB1","disabled":true},{"key":"costCentreKey","value":"C001","description":"Cost Centre Primary Key in ERP (optional in list search) => NOT IMPLEMENTED SAPB1","disabled":true},{"key":"erpKey","value":"120","description":"Journal Entry Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"49084","description":"Journal Entry Document Number in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-10-26T18: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\": \"finAPI\",\n \"process\": \"JournalEntries\",\n \"system\": \"totvsProtheus\",\n \"target\": \"journalEntries\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-13T13:11:57\",\n \"createdFrom\": \"2020-11-01\",\n \"createdTo\": \"2020-11-30\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"count\": 1,\n \"values\": [\n {\n \"erpKey\": \"0000000002\",\n \"docNum\": \"2020-11-10_008820_001_000001\",\n \"docDate\": \"2020-11-10\",\n \"docDueDate\": \"1900-01-01\",\n \"taxDate\": \"2020-11-10\",\n \"debitTotal\": 120,\n \"creditTotal\": 120,\n \"baseObject\": \"\",\n \"baseKey\": \"\",\n \"comments\": \"\",\n \"createdAt\": \"2020-11-12\",\n \"updatedAt\": \"2020-11-12\",\n \"canceledAt\": null,\n \"lines\": [\n {\n \"lineNum\": \"001\",\n \"account\": \"210101\",\n \"aliasAccount\": \"\",\n \"accountName\": \"FORNECEDORES NACIONAIS\",\n \"type\": \"D\",\n \"debitValue\": 120,\n \"creditValue\": 0,\n \"contraAccount\": \"\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"13\",\n \"branch\": \"01\",\n \"status\": \"C\",\n \"comments\": \"DEV NF.000000002/1 -PIXEL INFORMATICA E\"\n },\n {\n \"lineNum\": \"003\",\n \"account\": \"410422\",\n \"aliasAccount\": \"4236\",\n \"accountName\": \"SERVICOS PROFISSIONAIS DE TERCEIROS\",\n \"type\": \"C\",\n \"debitValue\": 0,\n \"creditValue\": 105.6,\n \"contraAccount\": \"\",\n \"costCentre\": \"000000002\",\n \"project\": \"\",\n \"baseObject\": \"13\",\n \"branch\": \"01\",\n \"status\": \"C\",\n \"comments\": \"DEV. NF.000000002/1 -PIXEL INFORMATICA\"\n },\n {\n \"lineNum\": \"005\",\n \"account\": \"110317004\",\n \"aliasAccount\": \"\",\n \"accountName\": \"ICMS A RECUPERAR\",\n \"type\": \"C\",\n \"debitValue\": 0,\n \"creditValue\": 14.4,\n \"contraAccount\": \"\",\n \"costCentre\": \"\",\n \"project\": \"\",\n \"baseObject\": \"13\",\n \"branch\": \"01\",\n \"status\": \"C\",\n \"comments\": \"DEV.ICMS NF.000000002/1 -PIXEL INFORMAT\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"f4ffbca4-acdf-474e-b532-7b4680b428c2"},{"name":"Journal Entries**","id":"f98faddd-e543-425c-bfc4-f02cf504f5b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"branch\": \"1\",\r\n\t\"totalValue\": 10.0,\r\n \"comments\": \"\",\r\n\t\"lines\": [\r\n\t\t{\r\n\t\t\t\"lineNum\": \"1\",\r\n \"type\": \"C\",\r\n\t\t\t\"accountKey\": \"900.000.003\",\r\n\t\t\t\"value\": 10.0\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"lineNum\": \"2\",\r\n \"type\": \"D\",\r\n\t\t\t\"accountKey\": \"900.000.004\",\r\n\t\t\t\"value\": 10.0\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/journalEntries","description":"

Insert journal entries in ERP

(sapBusinessOne=30/OJDT, totvsProtheus=CT2)

<<< NOT YET AVAILABLE. RELEASE IN 2020 Q4 >>>

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

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

A new journal entries will be insert if the informed accounts are located and validated on the ERP. The key for locating the accounts on the ERP can be:

SAP Business One: OACT.AcctCode
TOTVS Protheus: CT1_CONTA

For the use of user fields (UDF) created in the table of journal entries (SAPB1: OJDT, TOTVS: CT2), 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

Field	Type	Description
branch	number	Branch

* = 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	Erp key

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}},"urlObject":{"path":["journalEntries"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f98faddd-e543-425c-bfc4-f02cf504f5b1"}],"id":"f5b14942-d5b5-46af-a745-16c7d704664c","_postman_id":"f5b14942-d5b5-46af-a745-16c7d704664c","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}}},{"name":"Bill of Exchanges","item":[{"name":"Bill of Exchanges","id":"80a3e600-60be-49d9-ba29-fe058830c011","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"url":"{{endpoint}}/billOfExchanges?createdFrom=2010-08-27&createdTo=2020-12-31&payType=I&branch=1&partnerKey&status=O&erpKey=120&docNum=49084&pageNum=2&updatedAt=2020-01-24T15:34:00","description":"

Search bill of exchanges in ERP

(sapBusinessOne=181/OBOE, totvsProtheus=SEA/SE2)

This service will allow to search bill of exchanges in the ERP.

List Search: by createdFrom + createdTo {required}, by branch {optional}
Unitary Search: erpKey or docNum

If no field for unitary search (erpKey or docNum) is informed in the request, the search for bill of exchanges is carried out by date of creation from/to (which become required).

The bill of exchanges service will consider bill of exchanges with:

SAP Business One:
TOTVS Protheus:

Comments:

branch: SAP Business One (OBOE.?), TOTVS Protheus (EA_FILIAL)
erpKey: SAP Business One (OBOE.BoeKey), TOTVS Protheus (EA_PREFIXO+''+EA_NUM+''+EA_PARCELA)
docNum: SAP Business One (OBOE.BoeNum), TOTVS Protheus (EA_NUMBOR)
payType: I=incoming payment, O=outgoing payment | TOTVS Protheus (EA_CART)

Data returned in response: bill of exchanges data

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 will allow you to search the bill of exchanges list in two situations:

Full Search: will result in all bill of exchanges, according to filters.
Incremental Search: will result in all bill of exchanges, according to filters, which have been included and/or changed in the main register after a certain date/time provided in the request. In the Incremental Search, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which exit notes should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields for the Document record in SAP Business One (OBOE.CreateDate, OBOE.UpdateDate, OBOE.CreateTS, OBOE.UpdateTS), [2] TOTVS Protheus: the EA_USERLGI and EA_USERLGA fields

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

Initial create date to filter bill of exchanges (required if not unitary search)

\n","type":"text/plain"},"key":"createdFrom","value":"2010-08-27"},{"description":{"content":"

Final create date to filter bill of exchanges (required if not unitary search)

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

Payment Type: I=incoming boe, O=outgoing boe (optional in list search)

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

Branch (optional in list search) *PROTHEUS only

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

Bill of Exchange Status: O=Open S=Sent D=Deposited P=Paid X=Canceled C=Closed F=Failed V=BoE to Vendor (optional - list search)

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

Bill of Exchange Primary Key in ERP (optional - unitary search)

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

Bill of Exchange Document Number in ERP (optional - unitary search) *SAPB1 only

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

Number of page - pagination (optional)

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

Date do filter modified registers - incremental search (optional)

\n","type":"text/plain"},"key":"updatedAt","value":"2020-01-24T15:34:00"},{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"6cc10c78-a41f-44d6-a703-18a3d8d4ad1c","name":"Bill of Exchanges - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/billOfExchanges?createdFrom=2018-08-01&createdTo=2020-08-27","host":["{{endpoint}}"],"path":["billOfExchanges"],"query":[{"key":"createdFrom","value":"2018-08-01","description":"Initial create date to filter bill of exchanges (required if not unitary search)"},{"key":"createdTo","value":"2020-08-27","description":"Final create date to filter bill of exchanges (required if not unitary search)"},{"key":"payType","value":"I","description":"Payment Type: I=incoming boe, O=outgoing boe (optional in list search)","disabled":true},{"key":"Xbranch","value":"1","description":"Branch (optional in list search)","disabled":true},{"key":"partnerKey","value":null,"description":"Partner Primary Key in ERP (optional - list search)","disabled":true},{"key":"status","value":"O","description":"Bill of Exchange Status: O=Open S=Sent D=Deposited P=Paid X=Canceled C=Closed F=Failed V=BoE to Vendor (optional - list search)","disabled":true},{"key":"erpKey","value":"120","description":"Bill of Exchange Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"49084","description":"Bill of Exchange Document Number in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-24T15:34:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"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 15:47:43 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"finAPI\",\n \"process\": \"BillOfExchanges\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"billOfExchanges\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-04T13:47:40\",\n \"createdFrom\": \"2018-08-01\",\n \"createdTo\": \"2020-08-27\",\n \"code\": \"200\",\n \"success\": true,\n \"useCustom\": \"false\",\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 1,\n \"values\": [\n {\n \"erpKey\": \"17\",\n \"docNum\": \"184\",\n \"payType\": \"I\",\n \"status\": \"O\",\n \"docDate\": \"2018-08-17\",\n \"docDueDate\": \"2018-09-06\",\n \"taxDate\": \"2018-08-17\",\n \"currency\": \"R$\",\n \"docValue\": 100,\n \"baseObject\": \"24\",\n \"baseNum\": \"184\",\n \"depositNum\": \"\",\n \"partnerKey\": \"C000001\",\n \"partnerName\": \"PAULA LIMP BRANDÃO TEIXEIRA\",\n \"accountCode\": \"1.1.2.1.1\",\n \"ourNumber\": \"0\",\n \"ourNumberChkDig\": \"0\",\n \"codeBars\": \"0000000000\",\n \"codeBarsRep\": \"0000000000\",\n \"reference\": \"\",\n \"comments\": \"\",\n \"createdAt\": \"2018-08-17T00:00:00\",\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"},{"id":"854c7b80-1399-4960-b142-b8b383815c74","name":"Bill of Exchanges - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/billOfExchanges?createdFrom=2010-08-27&createdTo=2020-12-31","host":["{{endpoint}}"],"path":["billOfExchanges"],"query":[{"key":"createdFrom","value":"2010-08-27","description":"Initial create date to filter bill of exchanges (required if not unitary search)"},{"key":"createdTo","value":"2020-12-31","description":"Final create date to filter bill of exchanges (required if not unitary search)"},{"key":"payType","value":"I","description":"Payment Type: I=incoming boe, O=outgoing boe (optional in list search)","disabled":true},{"key":"branch","value":"1","description":"Branch (optional in list search) *PROTHEUS only","disabled":true},{"key":"partnerKey","value":null,"disabled":true},{"key":"status","value":"O","description":"Bill of Exchange Status: O=Open S=Sent D=Deposited P=Paid X=Canceled C=Closed F=Failed V=BoE to Vendor (optional - list search)","disabled":true},{"key":"erpKey","value":"120","description":"Bill of Exchange Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"49084","description":"Bill of Exchange Document Number in ERP (optional - unitary search) *SAPB1 only","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-24T15:34:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Version","value":"1.1"},{"key":"FWRESTBUILD","value":"1.15.0717"},{"key":"Content-Type","value":"application/json"},{"key":"Status","value":"200 OK"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"finAPI\",\n \"process\": \"BillOfExchanges\",\n \"system\": \"totvsProtheus\",\n \"target\": \"billOfExchanges\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-13T17:18:14\",\n \"createdFrom\": \"2010-08-27\",\n \"createdTo\": \"2020-12-31\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"count\": 1,\n \"values\": [\n {\n \"erpKey\": \"1_000000001_\",\n \"docNum\": \"000004\",\n \"payType\": \"I\",\n \"status\": null,\n \"docDate\": \"2020-11-12\",\n \"ducDueDate\": \"2020-09-03\",\n \"taxDate\": \"2020-11-12\",\n \"currency\": \"R$\",\n \"docValue\": 45,\n \"baseObject\": null,\n \"baseNum\": null,\n \"depositNum\": null,\n \"partnerKey\": \"00003801\",\n \"partnerName\": \"Rafael Ogeda\",\n \"accountCode\": \"\",\n \"ourNumber\": \"\",\n \"ourNumberChkDig\": null,\n \"codeBars\": \"\",\n \"codeBarsRep\": null,\n \"bankCode\": \"341\",\n \"bankBranch\": \"0132\",\n \"bankAccount\": \"08654\",\n \"reference\": \"\",\n \"comments\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"80a3e600-60be-49d9-ba29-fe058830c011"},{"name":"Bill of Exchanges","id":"f765500f-88d5-4fef-8715-7cb75812f726","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"USAR PUT incPayments PARA GERAR billOfExchanges\r\n{\r\n \"payType\": \"I\",\r\n \"status\": \"X\",\r\n \"docDueDate\": \"2014-03-20\",\r\n \"docValue\": 20.25,\r\n\r\n \"baseObject\": \"24\",\r\n \"baseNum\": \"11\",\r\n\r\n \"depositNum\": \"31\",\r\n \"partnerKey\": \"C001\",\r\n \"accountCode\": \"1.1.2.1.1\",\r\n \"ourNumber\": \"5521\",\r\n \"ourNumberChkDig\": \"8\",\r\n \"codeBars\": \"123456\",\r\n \"codeBarsRep\": \"34190.01007 00552.183741 80374.090001 1 60080000002025\",\r\n \"bankCode\": \"341\",\r\n \"bankBranch\": \"3748\",\r\n \"bankAccount\": \"03740\",\r\n \"reference\": \"\",\r\n \"comments\": \"\",\r\n\r\n \"originObject\": {\r\n \"originObject\": \"13\",\r\n \"originTable\": \"OINV\",\r\n \"originKey\": \"12\",\r\n \"originLineNum\": \"1\",\r\n \"originNfeNum\": \"19\",\r\n \"originNfeSeries\": \"1\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/billOfExchanges","description":"

Search bill of exchanges in ERP

(sapBusinessOne=181/OBOE, totvsProtheus=SEA/SE2)

This service will allow to search bill of exchanges in the ERP.

List Search: by createdFrom + createdTo {required}, by branch {optional}
Unitary Search: erpKey or docNum

If no field for unitary search (erpKey or docNum) is informed in the request, the search for bill of exchanges is carried out by date of creation from/to (which become required).

The bill of exchanges service will consider bill of exchanges with:

SAP Business One:
TOTVS Protheus:

Comments:

branch: SAP Business One (OBOE.?), TOTVS Protheus (EA_FILIAL)
erpKey: SAP Business One (OBOE.BoeKey), TOTVS Protheus (EA_PREFIXO+''+EA_NUM+''+EA_PARCELA)
docNum: SAP Business One (OBOE.BoeNum), TOTVS Protheus (EA_NUMBOR)
payType: I=incoming payment, O=outgoing payment | TOTVS Protheus (EA_CART)

Data returned in response: bill of exchanges data

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 will allow you to search the bill of exchanges list in two situations:

Full Search: will result in all bill of exchanges, according to filters.
Incremental Search: will result in all bill of exchanges, according to filters, which have been included and/or changed in the main register after a certain date/time provided in the request. In the Incremental Search, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which exit notes should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields for the Document record in SAP Business One (OBOE.CreateDate, OBOE.UpdateDate, OBOE.CreateTS, OBOE.UpdateTS), [2] TOTVS Protheus: the EA_USERLGI and EA_USERLGA fields

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

Search bill of exchanges in ERP

(sapBusinessOne=181/OBOE, totvsProtheus=SEA/SE2)

This service will allow to search bill of exchanges in the ERP.

List Search: by createdFrom + createdTo {required}, by branch {optional}
Unitary Search: erpKey or docNum

If no field for unitary search (erpKey or docNum) is informed in the request, the search for bill of exchanges is carried out by date of creation from/to (which become required).

The bill of exchanges service will consider bill of exchanges with:

SAP Business One:
TOTVS Protheus:

Comments:

branch: SAP Business One (OBOE.?), TOTVS Protheus (EA_FILIAL)
erpKey: SAP Business One (OBOE.BoeKey), TOTVS Protheus (EA_PREFIXO+''+EA_NUM+''+EA_PARCELA)
docNum: SAP Business One (OBOE.BoeNum), TOTVS Protheus (EA_NUMBOR)
payType: I=incoming payment, O=outgoing payment | TOTVS Protheus (EA_CART)

Data returned in response: bill of exchanges data

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 will allow you to search the bill of exchanges list in two situations:

Full Search: will result in all bill of exchanges, according to filters.
Incremental Search: will result in all bill of exchanges, according to filters, which have been included and/or changed in the main register after a certain date/time provided in the request. In the Incremental Search, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which exit notes should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields for the Document record in SAP Business One (OBOE.CreateDate, OBOE.UpdateDate, OBOE.CreateTS, OBOE.UpdateTS), [2] TOTVS Protheus: the EA_USERLGI and EA_USERLGA fields

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

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}},"urlObject":{"path":["billOfExchanges"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd8682d0-3c2c-46ed-ad63-e9872b0121b2"}],"id":"464cecdb-182e-48e8-971b-86e3726fb37b","_postman_id":"464cecdb-182e-48e8-971b-86e3726fb37b","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}}},{"name":"Billing Lists - PROTHEUS ONLY","item":[{"name":"Billing Lists","id":"90922313-24f1-4196-b528-bbbdcb93958b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/billingLists?createdFrom=2000-01-01&createdTo=2022-07-25&payType=I&branch=1&bankCode&bankKey&docStatus=O&partnerKey&erpKey=120&docNum=49084&pageNum=285&updatedAt=2000-01-01T00:00:00&baseErpKey&baseLineNum","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}},"urlObject":{"path":["billingLists"],"host":["{{endpoint}}"],"query":[{"key":"createdFrom","value":"2000-01-01"},{"key":"createdTo","value":"2022-07-25"},{"key":"payType","value":"I"},{"key":"branch","value":"1"},{"key":"bankCode","value":null},{"key":"bankKey","value":null},{"key":"docStatus","value":"O"},{"key":"partnerKey","value":null},{"key":"erpKey","value":"120"},{"key":"docNum","value":"49084"},{"key":"pageNum","value":"285"},{"key":"updatedAt","value":"2000-01-01T00:00:00"},{"key":"baseErpKey","value":null},{"key":"baseLineNum","value":null}],"variable":[]}},"response":[],"_postman_id":"90922313-24f1-4196-b528-bbbdcb93958b"},{"name":"Billing Lists","id":"8f50301b-7aae-4c20-888c-2e4d6061996f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"branch\": \"01\",\r\n\t\"_payType\": \"I\",\r\n\t\"docNum\": \"\",\r\n\t\"erpKey\": \"\",\r\n\t\"_primaryKey\": \"\",\r\n \"_secondaryKey\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/billingLists","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}},"urlObject":{"path":["billingLists"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f50301b-7aae-4c20-888c-2e4d6061996f"},{"name":"Billing Lists createDocNum","id":"214d4a07-048c-4276-bcef-99ee223b5b20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"branch\": \"01\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/billingLists/createDocNum","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}},"urlObject":{"path":["billingLists","createDocNum"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"214d4a07-048c-4276-bcef-99ee223b5b20"}],"id":"a3c6fddb-392c-4383-adf9-27f4c9f91b02","_postman_id":"a3c6fddb-392c-4383-adf9-27f4c9f91b02","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}}},{"name":"Billing Instructions","item":[{"name":"Billing Instructions","id":"d41ea3ba-d270-4d17-8437-67ef62b211ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{endpoint}}/billingInstructions?createdFrom=2000-01-01&createdTo=2022-07-25&payType=I&branch=1&bankCode&bankKey&docStatus=O&partnerKey&X erpKey=120&X docNum=49084&pageNum=285&updatedAt=2000-01-01T00:00:00&baseErpKey&baseLineNum&generatedFrom&generatedTo","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}},"urlObject":{"path":["billingInstructions"],"host":["{{endpoint}}"],"query":[{"key":"createdFrom","value":"2000-01-01"},{"key":"createdTo","value":"2022-07-25"},{"key":"payType","value":"I"},{"key":"branch","value":"1"},{"key":"bankCode","value":null},{"key":"bankKey","value":null},{"key":"docStatus","value":"O"},{"key":"partnerKey","value":null},{"key":"X erpKey","value":"120"},{"key":"X docNum","value":"49084"},{"key":"pageNum","value":"285"},{"key":"updatedAt","value":"2000-01-01T00:00:00"},{"key":"baseErpKey","value":null},{"key":"baseLineNum","value":null},{"key":"generatedFrom","value":null},{"key":"generatedTo","value":null}],"variable":[]}},"response":[],"_postman_id":"d41ea3ba-d270-4d17-8437-67ef62b211ae"},{"name":"Billing Instructions","id":"1b550ed7-f10b-4ace-aec4-302a0003f5d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"baseErpKey\": \"1_000000001\",\r\n \"baseLineNum\": \"\",\r\n \"instructionCode\": \"06\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/billingInstructions","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}},"urlObject":{"path":["billingInstructions"],"host":["{{endpoint}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b550ed7-f10b-4ace-aec4-302a0003f5d5"}],"id":"88b41e06-52c9-43bc-8074-6adfb2fb303e","_postman_id":"88b41e06-52c9-43bc-8074-6adfb2fb303e","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}}},{"name":"Finantial Movements","item":[{"name":"Bank Movements","id":"62e8a67d-631a-4b37-b82d-939d9c4ad105","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"{{endpoint}}/bankMovements?createdFrom=2020-11-09&createdTo=2020-11-12&branch=1&bankKey=1&erpKey=120&pageNum=2&updatedAt=2020-01-24T15:34:00","description":"

Search bank movements in ERP

(sapBusinessOne=JDT1, totvsProtheus=FK5)

This service will allow to search bank movements in the ERP.

The search of bank movements allows filtering the ERP by:

List Search: by createdFrom + createdTo {required}, by branch or bankKey {optional}
Unitary Search: erpKey

If no field for unitary search (erpKey) is informed in the request, the search for bank movements is carried out by date of creation from/to (which become required).

The bank movements service will consider sales bank movements with:

SAP Business One: [1] JDT1.ObjType=30
TOTVS Protheus: [1] FK5_STATUS=1

Comments:

branch: SAP Business One (JDT1.BPLId), TOTVS Protheus (FK5_FILIAL)
erpKey: SAP Business One (JDT1:TransId), TOTVS Protheus (FK5_IDMOV)
type: I=incoming (positive value), O=outcoming (negative value)

Data returned in response: bank movement data, bank data, base reference

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 will allow you to search the bank movements list in two situations:

Full Search: will result in all bank movements, according to filters.
Incremental Search: will result in all bank movements, according to filters, which have been included and/or changed in the main register after a certain date/time provided in the request. In the Incremental Search, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which exit notes should be returned. This information will be used in conjunction with: [1] SAP Business One: OJDT.CreateDate, OJDT.UpdateDate, OJDT.DocTime, [2] TOTVS Protheus: the FK5_USERLGI and FK5_USERLGA fields

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

Initial create date to filter bank movements (required if not unitary search)

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

Final create date to filter bank movements (required if not unitary search)

\n","type":"text/plain"},"key":"createdTo","value":"2020-11-12"},{"description":{"content":"

Branch (optional - list search)

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

Bank Account Primary Key in ERP (optional - list search)

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

Bank Movement Primary Key in ERP (optional - unitary search)

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

Number of page - pagination (optional)

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

Date do filter modified registers - incremental search (optional)

\n","type":"text/plain"},"key":"updatedAt","value":"2020-01-24T15:34:00"}],"variable":[]}},"response":[{"id":"788e939c-7b16-4a0f-9348-b282c4431ca8","name":"Bank Movements - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/bankMovements?createdFrom=2020-11-09&createdTo=2020-11-12","host":["{{endpoint}}"],"path":["bankMovements"],"query":[{"key":"createdFrom","value":"2020-11-09","description":"Initial create date to filter bank movements (required if not unitary search)"},{"key":"createdTo","value":"2020-11-12","description":"Final create date to filter bank movements (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional - list search)","disabled":true},{"key":"bankKey","value":"1","description":"Bank Account Primary Key in ERP (optional - list search)","disabled":true},{"key":"erpKey","value":"120","description":"Bank Movement Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-24T15:34:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Version","value":"1.1"},{"key":"FWRESTBUILD","value":"1.15.0717"},{"key":"Content-Type","value":"application/json"},{"key":"Status","value":"200 OK"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"finAPI\",\n \"process\": \"BankMovements\",\n \"system\": \"totvsProtheus\",\n \"target\": \"bankMovements\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-12T18:57:50\",\n \"createdFrom\": \"2020-11-09\",\n \"createdTo\": \"2020-11-12\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"count\": 1,\n \"values\": [\n {\n \"branch\": \"01\",\n \"erpKey\": \"dd800d163f00400097EF758c4b30e50c\",\n \"erpId\": \"1\",\n \"bankKey\": \"CX1/00001/0000000001\",\n \"bankCode\": \"CX1\",\n \"bankBranch\": \"00001\",\n \"bankAccount\": \"0000000001\",\n \"bankAccountKey\": \"\",\n \"account\": \"\",\n \"docDate\": \"2020-11-09\",\n \"type\": \"O\",\n \"value\": -50,\n \"comments\": \"Valor pago s/ Titulo\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"},{"id":"c1641bf8-766b-408e-b562-355bf97eb119","name":"Bank Movements - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/bankMovements?createdFrom=2010-08-27&createdTo=2020-08-27","host":["{{endpoint}}"],"path":["bankMovements"],"query":[{"key":"createdFrom","value":"2010-08-27","description":"Initial create date to filter bank movements (required if not unitary search)"},{"key":"createdTo","value":"2020-08-27","description":"Final create date to filter bank movements (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional - list search)","disabled":true},{"key":"bankKey","value":null,"description":"Bank Account Primary Key in ERP (optional - list search)","type":"text","disabled":true},{"key":"erpKey","value":"120","description":"Bank Movement Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-24T15:34:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"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, 09 Nov 2020 15:06:52 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"finAPI\",\n \"process\": \"BankMovements\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"bankMovements\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-09T13:06:40\",\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 \"branch\": \"1\",\n \"erpKey\": \"194\",\n \"bankKey\": \"1\",\n \"bankCode\": \"341\",\n \"bankBranch\": \"3748\",\n \"bankAccount\": \"03740\",\n \"bankAccountKey\": \"9\",\n \"account\": \"1.1.1.2.2\",\n \"docDate\": \"2014-02-20\",\n \"type\": \"I\",\n \"value\": 20.25,\n \"baseObject\": \"25\",\n \"baseKey\": \"1\",\n \"comments\": \"Depositar - 1.1.1.2.2\",\n \"createdAt\": \"2014-02-20T16:16:00\",\n \"updatedAt\": \"2014-02-20T00:00:00\",\n \"canceledAt\": null\n },\n {\n \"branch\": \"1\",\n \"erpKey\": \"342\",\n \"bankKey\": \"1\",\n \"bankCode\": \"341\",\n \"bankBranch\": \"3748\",\n \"bankAccount\": \"03740\",\n \"bankAccountKey\": \"9\",\n \"account\": \"1.1.1.2.2\",\n \"docDate\": \"2015-03-18\",\n \"type\": \"C\",\n \"value\": -400,\n \"baseObject\": \"30\",\n \"baseKey\": \"342\",\n \"comments\": \"\",\n \"createdAt\": \"2015-03-18T14:58:00\",\n \"updatedAt\": \"2015-03-18T00:00:00\",\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"62e8a67d-631a-4b37-b82d-939d9c4ad105"},{"name":"Bank Movements","id":"1fc3d426-7e66-4008-8f98-3b41ab060465","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"branch\": \"1\",\r\n\t\"totalValue\": 10.0,\r\n \"comments\": \"\",\r\n\t\"lines\": [\r\n\t\t{\r\n\t\t\t\"lineNum\": \"1\",\r\n \"type\": \"C\",\r\n\t\t\t\"accountKey\": \"900.000.003\",\r\n\t\t\t\"value\": 10.0\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"lineNum\": \"2\",\r\n \"type\": \"D\",\r\n\t\t\t\"accountKey\": \"900.000.004\",\r\n\t\t\t\"value\": 10.0\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/bankMovements","description":"

Search bank movements in ERP

(sapBusinessOne=JDT1, totvsProtheus=FK5)

This service will allow to search bank movements in the ERP.

The search of bank movements allows filtering the ERP by:

List Search: by createdFrom + createdTo {required}, by branch or bankKey {optional}
Unitary Search: erpKey

If no field for unitary search (erpKey) is informed in the request, the search for bank movements is carried out by date of creation from/to (which become required).

The bank movements service will consider sales bank movements with:

SAP Business One: [1] JDT1.ObjType=30
TOTVS Protheus: [1] FK5_STATUS=1

Comments:

branch: SAP Business One (JDT1.BPLId), TOTVS Protheus (FK5_FILIAL)
erpKey: SAP Business One (JDT1:TransId), TOTVS Protheus (FK5_IDMOV)
type: I=incoming (positive value), O=outcoming (negative value)

Data returned in response: bank movement data, bank data, base reference

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 will allow you to search the bank movements list in two situations:

Full Search: will result in all bank movements, according to filters.
Incremental Search: will result in all bank movements, according to filters, which have been included and/or changed in the main register after a certain date/time provided in the request. In the Incremental Search, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which exit notes should be returned. This information will be used in conjunction with: [1] SAP Business One: OJDT.CreateDate, OJDT.UpdateDate, OJDT.DocTime, [2] TOTVS Protheus: the FK5_USERLGI and FK5_USERLGA fields

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

Search finantial deposits in ERP

(sapBusinessOne=25/ODPS)

This service will allow to search finantial deposits in the ERP.

List Search: by createdFrom + createdTo {required}, by branch {optional}
Unitary Search: erpKey

If no field for unitary search (erpKey) is informed in the request, the search for finantial deposits is carried out by date of creation from/to (which become required).

The finantial deposits service will consider finantial deposits with:

SAP Business One:

Comments:

branch: SAP Business One (ODPS.BPLId)
erpKey: SAP Business One (ODPS.DeposId)

Data returned in response: finantial deposit data

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 will allow you to search the finantial deposits list in two situations:

Full Search: will result in all finantial deposits, according to filters.
Incremental Search: will result in all finantial deposits, according to filters, which have been included and/or changed in the main register after a certain date/time provided in the request. In the Incremental Search, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which exit notes should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields for the Document record in SAP Business One (ODPS.CreateDate, ODPS.UpdateDate, ODPS.CreateTS, ODPS.UpdateTS)

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

Initial create date to filter finantial deposits (required if not unitary search)

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

Final create date to filter finantial deposits (required if not unitary search)

\n","type":"text/plain"},"key":"createdTo","value":"2020-08-27"},{"description":{"content":"

Branch (optional - list search)

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

Deposit Type: cash, check, boe or creditCard (optional - list search)

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

Partner Primary Key (optional - list search)

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

Finantial Deposit Primary Key in ERP (optional - unitary search)

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

Finantial Deposit Document Number in ERP (optional - unitary search)

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

Number of page - pagination (optional)

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

Date do filter modified registers - incremental search (optional)

\n","type":"text/plain"},"key":"updatedAt","value":"2020-01-24T15:34:00"}],"variable":[]}},"response":[{"id":"f339d8f5-38f5-442a-8f62-1da4f968e3b4","name":"Finantial Deposits - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/financialDeposits?createdFrom=2018-04-01&createdTo=2020-08-27","host":["{{endpoint}}"],"path":["financialDeposits"],"query":[{"key":"createdFrom","value":"2018-04-01","description":"Initial create date to filter finantial deposits (required if not unitary search)"},{"key":"createdTo","value":"2020-08-27","description":"Final create date to filter finantial deposits (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional - list search)","disabled":true},{"key":"depositType","value":"boe","description":"Deposit Type: cash, check, boe or creditCard (optional - list search)","disabled":true},{"key":"partnerKey","value":"C001","description":"Partner Primary Key (optional - list search)","disabled":true},{"key":"erpKey","value":"120","description":"Finantial Deposit Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"49084","description":"Finantial Deposit Document Number in ERP (optional - unitary search)","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"updatedAt","value":"2020-01-24T15:34:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"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 23:39:42 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"finAPI\",\n \"process\": \"FinancialDeposits\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"financialDeposits\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-05T21:39:40\",\n \"createdFrom\": \"2018-04-01\",\n \"createdTo\": \"2020-08-27\",\n \"code\": \"200\",\n \"success\": true,\n \"useCustom\": \"false\",\n \"pageSize\": 200,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"count\": 1,\n \"values\": [\n {\n \"branch\": \"1\",\n \"erpKey\": \"36\",\n \"docNum\": \"36\",\n \"depositType\": \"boe\",\n \"status\": \"O\",\n \"docDate\": \"2018-04-01\",\n \"taxDate\": \"2018-04-01\",\n \"currency\": \"R$\",\n \"docValue\": -234.54,\n \"partnerKey\": \"\",\n \"account\": \"1.1.1.2.2\",\n \"reference\": \"36\",\n \"comments\": \"Depositar - 1.1.1.2.2\",\n \"createdAt\": \"2018-04-01T18:25:00\",\n \"updatedAt\": \"2018-04-01T00:00:00\",\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"385b52d0-9e2d-48a1-827b-0b389735c1cc"},{"name":"Finantial Deposits","id":"2fa12db4-9163-4b21-a73c-b3f33559b01b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n\t\"branch\": \"1\",\r\n\t\"totalValue\": 10.0,\r\n \"comments\": \"\",\r\n\t\"lines\": [\r\n\t\t{\r\n\t\t\t\"lineNum\": \"1\",\r\n \"type\": \"C\",\r\n\t\t\t\"accountKey\": \"900.000.003\",\r\n\t\t\t\"value\": 10.0\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"lineNum\": \"2\",\r\n \"type\": \"D\",\r\n\t\t\t\"accountKey\": \"900.000.004\",\r\n\t\t\t\"value\": 10.0\r\n\t\t}\r\n\t]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{endpoint}}/financialDeposits","description":"

Search finantial deposits in ERP

(sapBusinessOne=25/ODPS)

This service will allow to search finantial deposits in the ERP.

List Search: by createdFrom + createdTo {required}, by branch {optional}
Unitary Search: erpKey

If no field for unitary search (erpKey) is informed in the request, the search for finantial deposits is carried out by date of creation from/to (which become required).

The finantial deposits service will consider finantial deposits with:

SAP Business One:

Comments:

branch: SAP Business One (ODPS.BPLId)
erpKey: SAP Business One (ODPS.DeposId)

Data returned in response: finantial deposit data

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 will allow you to search the finantial deposits list in two situations:

Full Search: will result in all finantial deposits, according to filters.
Incremental Search: will result in all finantial deposits, according to filters, which have been included and/or changed in the main register after a certain date/time provided in the request. In the Incremental Search, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which exit notes should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields for the Document record in SAP Business One (ODPS.CreateDate, ODPS.UpdateDate, ODPS.CreateTS, ODPS.UpdateTS)

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

Search checks in ERP

(sapBusinessOne=27/OCHH + OCHO/57, totvsProtheus=SEF)

This service will allow to checks in the ERP.

List Search: by createdFrom + createdTo {required}, by branch {optional - PROTHEUS}
Unitary Search: erpKey or docNum

If no field for unitary search (erpKey or docNum) is informed in the request, the search for checks is carried out by date of creation from/to (which become required).

The checks service will consider checks with:

SAP Business One:
TOTVS Protheus: [1] EF_IMPRESS not A

Comments:

branch: SAP Business One (-), TOTVS Protheus (EF_FILIAL)
erpKey: SAP Business One (OCHH.CheckKey/OCHO.CheckKey), TOTVS Protheus (EF_BANCO+''+EF_AGENCIA+''+EF_CONTA+'_'+EF_NUM)
docNum: SAP Business One (OCHH.CheckNum/OCHO.CheckNum), TOTVS Protheus (EF_NUM)
payType: I=incoming payment, O=outgoing payment (SAP Business One: OCHH, OCHO | TOTVS Protheus: EF_CART)

Data returned in response: checks data

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 will allow you to search the registers list in two situations:

Full Search: will result in all registers, according to filters.
Incremental Search: will result in all registers, according to filters, which have been included and/or changed in the main register after a certain date/time provided in the request. In the Incremental Search, the updatedAt field of the body request (format YYYY-MM-DDTHH:MM:SS) will be used to determine which exit notes should be returned. This information will be used in conjunction with: [1] SAP Business One: the Creation Date and Update Date fields for the Document record in SAP Business One (OCHH.CheckDate, OCHO.CheckDate), [2] TOTVS Protheus: the EF_USERLGI/EF_USERLGA fields

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

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

\n","type":"text/plain"},"key":"createdFrom","value":"2018-08-27"},{"description":{"content":"

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

\n","type":"text/plain"},"key":"createdTo","value":"2020-11-30"},{"description":{"content":"

Branch (optional in list search) *PROTHEUS only

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

Payment Type: I=incoming boe, O=outgoing boe (optional in list search)

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

Partner Primary Key in ERP (optional - list search) *PROTHEUS only

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

Check Primary Key in ERP (optional - unitary search)

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

Check Document Number in ERP (optional - unitary search)

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

Number of page - pagination (optional)

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

Date do filter modified registers - incremental search (optional) *PROTHEUS only

\n","type":"text/plain"},"key":"updatedAt","value":"2020-01-24T15:34:00"}],"variable":[]}},"response":[{"id":"7f8a4369-5a16-4819-9849-24fc10cce7e2","name":"Checks - SAP Business One","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/checks?createdFrom=2018-08-27&createdTo=2020-08-27","host":["{{endpoint}}"],"path":["checks"],"query":[{"key":"createdFrom","value":"2018-08-27","description":"Initial create date to filter checks (required if not unitary search)"},{"key":"createdTo","value":"2020-08-27","description":"Final create date to filter checks (required if not unitary search)"},{"key":"Xbranch","value":"1","description":"Branch (optional in list search)","disabled":true},{"key":"XpartnerKey","value":null,"description":"Partner Primary Key in ERP (optional - list search)","type":"text","disabled":true},{"key":"erpKey","value":"120","description":"Check Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"XdocNum","value":"49084","description":"Check Document Number in ERP (optional - unitary search) ","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"XupdatedAt","value":"2020-01-24T15:34:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-FRAME-OPTIONS","value":"SAMEORIGIN"},{"key":"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 14:12:49 GMT"},{"key":"Server","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"finAPI\",\n \"process\": \"Checks\",\n \"system\": \"sapBusinessOne\",\n \"target\": \"checks\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-04T12:12:41\",\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\": \"51\",\n \"docNum\": \"1\",\n \"payType\": \"I\",\n \"bankCode\": \"001\",\n \"bankBranch\": \"0167\",\n \"bankAccount\": \"\",\n \"bankAccountKey\": \"\",\n \"docDate\": \"2018-08-17\",\n \"currency\": \"R$\",\n \"docValue\": \"20.000000\",\n \"partnerKey\": \"C000001\",\n \"partnerName\": \"PAULA LIMP BRANDÃO TEIXEIRA\",\n \"accountCode\": \"1.1.2.8\",\n \"paymentKey\": \"185\",\n \"paymentDocNum\": \"185\",\n \"paymentDate\": \"2018-08-17\",\n \"createdAt\": \"2018-09-06T00:00:00\",\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"},{"id":"a476ada8-fcb9-4ef5-a91d-ef66eb6ec8f9","name":"Checks - TOTVS Protheus","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{endpoint}}/checks?createdFrom=2018-08-27&createdTo=2020-11-30","host":["{{endpoint}}"],"path":["checks"],"query":[{"key":"createdFrom","value":"2018-08-27","description":"Initial create date to filter checks (required if not unitary search)"},{"key":"createdTo","value":"2020-11-30","description":"Final create date to filter checks (required if not unitary search)"},{"key":"branch","value":"1","description":"Branch (optional in list search) *PROTHEUS only","disabled":true},{"key":"payType","value":null,"description":"Payment Type: I=incoming boe, O=outgoing boe (optional in list search)","type":"text","disabled":true},{"key":"partnerKey","value":"","description":"Partner Primary Key in ERP (optional - list search) *PROTHEUS only","type":"text","disabled":true},{"key":"erpKey","value":"120","description":"Check Primary Key in ERP (optional - unitary search)","disabled":true},{"key":"docNum","value":"49084","description":"Check Document Number in ERP (optional - unitary search) *PROTHEUS only","disabled":true},{"key":"pageNum","value":"2","description":"Number of page - pagination (optional)","disabled":true},{"key":"XupdatedAt","value":"2020-01-24T15:34:00","description":"Date do filter modified registers - incremental search (optional)","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Version","value":"1.1"},{"key":"FWRESTBUILD","value":"1.15.0717"},{"key":"Content-Type","value":"application/json"},{"key":"Status","value":"200 OK"},{"key":"Content-Encoding","value":"gzip"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=15"}],"cookie":[],"responseTime":null,"body":"{\n \"package\": \"finAPI\",\n \"process\": \"Checks\",\n \"system\": \"totvsProtheus\",\n \"target\": \"checks\",\n \"user\": \"intergate\",\n \"host\": \"192.168.0.108\",\n \"effectiveTimestamp\": \"2020-11-13T15:51:56\",\n \"createdFrom\": \"2018-08-27\",\n \"createdTo\": \"2020-11-30\",\n \"code\": \"200\",\n \"success\": true,\n \"pageSize\": 100,\n \"pageNum\": 1,\n \"pageTotal\": 1,\n \"hasNext\": false,\n \"useCustom\": true,\n \"count\": 2,\n \"values\": [\n {\n \"erpKey\": \"341_0132_08654_123678\",\n \"docNum\": \"123678\",\n \"payType\": \"I\",\n \"bankCode\": \"341\",\n \"bankBranch\": \"0132\",\n \"bankAccount\": \"08654\",\n \"docDate\": \"2020-11-12\",\n \"ducDueDate\": \"2020-11-30\",\n \"currency\": \"R$\",\n \"docValue\": 100,\n \"partnerKey\": \"00003801\",\n \"partnerName\": \"Rafael Ogeda\",\n \"accountCode\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n },\n {\n \"erpKey\": \"341_0132_08654_123789\",\n \"docNum\": \"123789\",\n \"bankCode\": \"341\",\n \"bankBranch\": \"0132\",\n \"bankAccount\": \"08654\",\n \"docDate\": \"2020-11-12\",\n \"ducDueDate\": \"1900-01-01\",\n \"currency\": \"R$\",\n \"checkValue\": 70,\n \"payType\": \"O\",\n \"partnerKey\": \"\",\n \"partnerName\": \"\",\n \"accountCode\": \"\",\n \"createdAt\": null,\n \"updatedAt\": null,\n \"canceledAt\": null\n }\n ]\n}"}],"_postman_id":"f16a75f3-25be-49f8-9366-e07c16fdea44"}],"id":"2d8a8511-5c1d-4e83-a88d-ab2b6e10a43d","event":[{"listen":"prerequest","script":{"id":"115802df-1798-41ce-ae50-772170bd7479","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6dbb1bc5-22b9-464e-8a34-f35c77f04dce","type":"text/javascript","exec":[""]}}],"_postman_id":"2d8a8511-5c1d-4e83-a88d-ab2b6e10a43d","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}}},{"name":"Incoming Agreements - PROTHEUS ONLY","item":[{"name":"Incoming Agreements","id":"0b8c8b60-bb92-4228-9172-b36959203fdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"?createdFrom=2000-01-01&createdTo=2024-03-31&branch&partnerKey&erpKey&docNum&pageNum&updatedAt=2022-10-01T00:00:00&status=NOT IMPLEMENTED&docStatus=G","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}},"urlObject":{"query":[{"key":"createdFrom","value":"2000-01-01"},{"key":"createdTo","value":"2024-03-31"},{"key":"branch","value":null},{"key":"partnerKey","value":null},{"key":"erpKey","value":null},{"key":"docNum","value":null},{"key":"pageNum","value":null},{"key":"updatedAt","value":"2022-10-01T00:00:00"},{"key":"status","value":"NOT IMPLEMENTED"},{"key":"docStatus","value":"G"}],"variable":[]}},"response":[],"_postman_id":"0b8c8b60-bb92-4228-9172-b36959203fdd"},{"name":"Incoming Agreements","id":"dc2d5064-c4a9-4bb1-8049-1935d9ee74dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"partnerKey\": \"001010_01\",\r\n \"destinationNum\": \"100000001\",\r\n \"amount\": 104,\r\n \"interestValue\": 1,\r\n \"correctionValue\": 0,\r\n \"feeValue\": 0,\r\n \"fineValue\": 3,\r\n \"discountValue\": 0,\r\n \"origins\": [\r\n {\r\n \"erpKey\": \"BOL_000000002\",\r\n \"lineNum\": \"01\",\r\n \"amount\": 20,\r\n \"_interestValue\": 0,\r\n \"_fineValue\": 0,\r\n \"_discountValue\": 0,\r\n \"_aditionalValue\": 0,\r\n \"comments\": \"023567\"\r\n },\r\n {\r\n \"erpKey\": \"BOL_000000003\",\r\n \"lineNum\": \"01\",\r\n \"amount\": 80,\r\n \"_interestValue\": 0,\r\n \"_fineValue\": 0,\r\n \"_discountValue\": 0,\r\n \"_aditionalValue\": 0,\r\n \"comments\": \"\"\r\n }\r\n ],\r\n \"destinations\": [\r\n {\r\n \"docDueDate\": \"2022-11-10\",\r\n \"amount\": 44,\r\n \"comments\": \"\"\r\n },\r\n {\r\n \"docDueDate\": \"2022-11-20\",\r\n \"amount\": 30,\r\n \"comments\": \"\"\r\n },\r\n {\r\n \"docDueDate\": \"2022-11-30\",\r\n \"amount\": 30,\r\n \"comments\": \"\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"dc2d5064-c4a9-4bb1-8049-1935d9ee74dd"},{"name":"Incoming Agreements","id":"5c4c90e5-7ca2-475b-abb0-8aa7f3e026f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"branch\": \"01\",\r\n \"erpKey\": \"000000000000049\",\r\n \"_docNum\": \"000020\"\r\n}","options":{"raw":{"language":"json"}}},"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"5c4c90e5-7ca2-475b-abb0-8aa7f3e026f0"}],"id":"02c4db43-03e6-4464-8a0e-9ad78f0d0e12","_postman_id":"02c4db43-03e6-4464-8a0e-9ad78f0d0e12","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]},"isInherited":true,"source":{"_postman_id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","id":"8b5f55a8-a9e0-4ce7-bc5b-0d94bd0bf8b2","name":"finAPI - Finantial and Accounting API for ERP (v2)","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{user}}"},{"key":"password","value":"{{pass}}"}]}},"event":[{"listen":"prerequest","script":{"id":"784800b8-20be-4b32-b6da-308079af053c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2b4d478d-1bb4-4f06-82c9-1356515f9b18","type":"text/javascript","exec":[""]}}]}