Connection requirements.
TOKEN: To connect to these endpoints it is necessary to have a token in the headers. This token is obtained by login with the credentials assigned to the development team, the token must be added to the Authorization header as follows:
Authorization: Bearer {TOKEN}
VPN: Optionally we recommend using a VPN to make the connection between B2B Enterprise and external entities.
The endpoint is used to return the users with the Supplier role registered in B2B
Enterprise, depending on the configuration of the parameters it receives, it can be returned
All users registered as suppliers,
\nRelated suppliers (that have a condition active trading) with a customer
\nUnrelated providers (not having an active trading condition) with a customer
\n(true / false) indicates if you want to return the providers related to a specific client (this parameter is optional, by default it is taken as false, that is, unrelated providers. However, it is only used, when the id parameter is not null in the request)
\n","type":"text/plain"},"key":"related","value":null},{"description":{"content":"customer id (this parameter is optional, it indicates the id of the customer from which you want to get the related providers or no)
\n","type":"text/plain"},"key":"id","value":null}],"variable":[]}},"response":[{"id":"07610e9a-fd86-4872-ad3a-66958ed37dd5","name":"Get Suppliers","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{instance_url}}/v3/b2b/providers?related&id","host":["{{instance_url}}"],"path":["v3","b2b","providers"],"query":[{"key":"related","value":null,"description":"(true / false) indicates if you want to return the providers related to a specific client (this parameter is optional, by default it is taken as false, that is, unrelated providers. However, it is only used, when the id parameter is not null in the request)"},{"key":"id","value":null,"description":"customer id (this parameter is optional, it indicates the id of the customer from which you want to get the related providers or no)"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n //provider 1\n {\n \"id\": \"\",\n \"email\": \"\",\n \"status\": \"0/1\",\n \"user\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"document_number\": \"\",\n \"document_type\": {\n \"id\": \"\",\n \"document_type\": \"\"\n }\n },\n \"address\": \"\",\n \"id_bank\": \"id of the bank to which it belongs\",\n \"account_name\": \"name of the account\",\n \"admin_last_name\": \"administrator last name of the account\",\n \"admin_position\": \"administrator position of the account administrator\",\n \"document_type\": \"type of document of the administrator of the account\",\n \"document_number\": \"document number of the account administrator\",\n \"trade_code\": \"\",\n \"payment_conditions\": {\n \"customer\": \"\",\n \"id\": \"\",\n \"supplier_id\": \"\",\n \"agreed_days\": \"\",\n \"percentage\": \"\",\n \"condition_type\": \"(base, advance, defer)\",\n \"discount_rate\": \"\",\n \"limit_amount\": \"\",\n \"approval\": \"approval from receipt or approval\"\n }\n }, \n {} //provider 2 - provider n \n]"}],"_postman_id":"32163cd1-60f2-4c38-82ac-58b77c629e0b"},{"name":"Get Clients","id":"36568b8c-c6ce-4acd-abaa-9f554cd4a64f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{instance_url}}/v3/b2b/clients?related&id","description":"The endpoint It is used to return the users with the Client role registered in B2B
Enterprise, depending on the configuration of the parameters it receives, the following can be returned:
(true / false) indicates if you want to return the related customers with a specific provider (this parameter is optional, by default it is taken as false, that is, unrelated clients. However, it is only used when the id parameter is not null in the request)
\n","type":"text/plain"},"key":"related","value":null},{"description":{"content":"id of the provider (this parameter is optional, it indicates the id of the provider from which we want to Get related clients or not)
\n","type":"text/plain"},"key":"id","value":null}],"variable":[]}},"response":[{"id":"73d8ac9c-c6d2-42f4-9792-c540dff054d6","name":"Get Clients","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{instance_url}}/v3/b2b/clients?related&id","host":["{{instance_url}}"],"path":["v3","b2b","clients"],"query":[{"key":"related","value":null,"description":"(true / false) indicates if you want to return the related customers with a specific provider (this parameter is optional, by default it is taken as false, that is, unrelated clients. However, it is only used when the id parameter is not null in the request)"},{"key":"id","value":null,"description":"id of the provider (this parameter is optional, it indicates the id of the provider from which we want to Get related clients or not)"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n // customer 1\n {\n \"id\": \"\",\n \"email\": \"\",\n \"status\": \"0/1\",\n \"user\": {\n \"name\": \"\",\n \"surname\": \"\",\n \"document_number\": \"\",\n \"document_type\": {\n \"id\": \"\",\n \"document_type\": \"\"\n }\n },\n \"address\": \"\",\n \"id_bank\": \"id of the bank to which it belongs\",\n \"account_name\": \"name of the account\",\n \"admin_last_name\": \"administrator last name of the account\",\n \"admin_position\": \"administrator position of the account administrator\",\n \"document_type\": \"type of document of the administrator of the account\",\n \"document_number\": \"document number of the account administrator\",\n \"trade_code\": \"\",\n \"payment_conditions\": {\n \"customer\": \"\",\n \"id\": \"\",\n \"supplier_id\": \"\",\n \"agreed_days\": \"\",\n \"percentage\": \"\",\n \"condition_type\": \"(base, advance, defer)\",\n \"discount_rate\": \"\",\n \"limit_amount\": \"\",\n \"approval\": \"approval from receipt or approval\"\n }\n },\n {} // customer 2 - customer n\n]"}],"_postman_id":"36568b8c-c6ce-4acd-abaa-9f554cd4a64f"},{"name":"Get Transactions","id":"551f616b-6459-4e61-893d-91869e0dcc8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{instance_url}}/v3/b2b/transactions?person_id&role&expired&pending&approved&paid&reject&emit&date_min&date_max&bank_id","description":"The endpoint is used to return the transactions (invoices) registered in B2B Enterprise Depending on the configuration of the parameters it receives, the following can be returned:
\ncustomer or supplier to consult
\n","type":"text/plain"},"key":"person_id","value":null},{"description":{"content":"role from the cu When you want to see the transactions
\n","type":"text/plain"},"key":"role","value":null},{"description":{"content":"(true / false) indicates if you want to return the expired invoices (Advance,\nDeferred, Paid and Rejected)
\n","type":"text/plain"},"key":"expired","value":null},{"description":{"content":"(true / false) indicates if you want to return the invoices To be Approved
\n","type":"text/plain"},"key":"pending","value":null},{"description":{"content":"(true / false) indicates if you want to return the Approved invoices
\n","type":"text/plain"},"key":"approved","value":null},{"description":{"content":"(true / false) indicates if you want to return the Paid invoices
\n","type":"text/plain"},"key":"paid","value":null},{"description":{"content":"(true / false) indicates if you want to return the Rejected invoices
\n","type":"text/plain"},"key":"reject","value":null},{"description":{"content":"(true / false) indicates whether You want to return the invoices To be Issued
\n","type":"text/plain"},"key":"emit","value":null},{"description":{"content":"minimum filter date in reports
\n","type":"text/plain"},"key":"date_min","value":null},{"description":{"content":"maximum filter date in reports
\n","type":"text/plain"},"key":"date_max","value":null},{"description":{"content":"bank by which you want to filter
\n","type":"text/plain"},"key":"bank_id","value":null}],"variable":[]}},"response":[{"id":"5a49106e-955e-4aca-a433-ae2d1ee31306","name":"Get Transactions","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{instance_url}}/v3/b2b/transactions?person_id&role&expired&pending&approved&paid&reject&emit&date_min&date_max&bank_id","host":["{{instance_url}}"],"path":["v3","b2b","transactions"],"query":[{"key":"person_id","value":null,"description":"customer or supplier to consult"},{"key":"role","value":null,"description":"role from the cu When you want to see the transactions"},{"key":"expired","value":null,"description":"(true / false) indicates if you want to return the expired invoices (Advance,\nDeferred, Paid and Rejected)"},{"key":"pending","value":null,"description":"(true / false) indicates if you want to return the invoices To be Approved"},{"key":"approved","value":null,"description":"(true / false) indicates if you want to return the Approved invoices"},{"key":"paid","value":null,"description":"(true / false) indicates if you want to return the Paid invoices"},{"key":"reject","value":null,"description":"(true / false) indicates if you want to return the Rejected invoices"},{"key":"emit","value":null,"description":"(true / false) indicates whether You want to return the invoices To be Issued"},{"key":"date_min","value":null,"description":"minimum filter date in reports"},{"key":"date_max","value":null,"description":"maximum filter date in reports"},{"key":"bank_id","value":null,"description":"bank by which you want to filter"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n //Invoice 1\n {\n \"id\": \"\",\n \"invoice_number\": \"\",\n \"upload_date\": \"date of upload to the platform\",\n \"payment_date\": \"date of payment\",\n \"approval_date\": \"date of approval\",\n \"supplier_payment_date\": \"supplier payment date\",\n \"amount\": \"\",\n \"description\": \"\",\n \"customer_invoice_status\": {\n \"description\": \"\"\n },\n \"supplier_invoice_status\": {\n \"description\": \"\"\n },\n \"attachment\": \"\",\n \"payment_card\": \"\",\n \"payment_condition\": {\n \"agreed_days\": \"\",\n \"percentage\": \"\",\n \"type_of_condition\": \"(base, advance, defer)\",\n \"discount_rate\": \"\",\n \"limit_amount\": \"\",\n \"approval\": \"approval from reception or approval\"\n },\n \"customer_user\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"bank\": \"\",\n \"address\": \"\"\n },\n \"provider_user\": {\n \"id\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"bank\": \"\",\n \"address\": \"\"\n }\n },\n {} //Invoice 2 - Invoice n\n]"}],"_postman_id":"551f616b-6459-4e61-893d-91869e0dcc8e"},{"name":"User Registration","id":"f52dccf8-ce63-4dba-bc3c-70db61f02ae9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Katty CA\",\n \"document_type\": \"RUC\",\n \"document_number\": \"1232133\",\n \"email\": \"ckatty_demo@yopmail.com\",\n \"password\": \"123\",\n \"user_type\": \"business\",\n \"agency_user_type\": \"business_admin\",\n \"role_name\": 5,\n \"items\": [\n {\n \"id\": 42,\n \"description\": \"TELECOMMUNICATIONS\"\n }\n ],\n \"b2b\": {\n \" bank_id \": \" 5e95daf005de937ad03af649 \",\n \" admin \": 0,\n \" issuing_bank \": 0,\n \" acquiring_bank \": 0,\n \" seller \": 0,\n \" buyer \": 1,\n \" address \": \" zona industrial \",\n \" admin_name \": \"Sebastian\",\n \"admin_position\": \"CEO\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{instance_url}}/v3/api/register?is_profile=false","description":"The endpoint is used to register all users of the platform, regardless of whether they are payers, suppliers, sub-profiles or banks.
It receives the information associated with the user to register: Name, surname, type and number of document, email, the types of industries associated with the client (in case of being a client / supplier) and depending on the type of user from where the endpoint is called , the role of the user to be created is sent, for example: Issuing Banks create and send Customer role, Purchasing Banks create and send Supplier role.
As a response, you get the user object created in the B2B Enterprise platform.
The cliente load an invoice using this endpoint.
\nThe information is sent in raw value body in JSON format
\n","urlObject":{"path":["v3","sii","load-invoice"],"host":["{{instance_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ebd576e-b029-441c-8090-e0237077c0a1"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"5d3b1cd5-68db-45b7-9b8a-0657d75ab9fe","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7b80a28a-f9cc-4063-bd60-1d69a0781ee3","type":"text/javascript","exec":[""]}}]}