{"info":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","description":"

This is the API that will handle client-side requests for our B2B applications.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16445201","collectionId":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","publishedId":"UUy65PqB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"25ab00"},"publishDate":"2022-01-26T04:06:15.000Z"},"item":[{"name":"Authorization","item":[{"name":"Authorize client","event":[{"listen":"test","script":{"id":"8a28d803-f48c-4fe1-9045-318c5db4bdc9","exec":["pm.test(\"Save token to environment\", function () {"," var jsonData = pm.response.json();"," pm.environment.set(\"token\", jsonData.access_token);"," pm.environment.set(\"refresh_token\", jsonData.refresh_token);","});",""],"type":"text/javascript"}}],"id":"b90271a5-608c-4d9a-ab94-6f9d0a1d8a89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{client_id}}","type":"text"},{"key":"client_secret","value":"{{client_secret}}","type":"text"},{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"scope","value":"offline_access","type":"text"}]},"url":"{{host}}/auth/realms/{{realm}}/protocol/openid-connect/token","description":"

This request authorizes the client to log in.\nRequest parameters ->

\n\n \n \n \n\n \n \n \n\n\n \n \n\n
ParameterDescription
clientIdThe client's public credential key
clientSecretThe client's private credential key
\n\n

Response attributes ->

\n\n \n \n \n\n \n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n
AttributesDescription
accessTokenA token used to authorize the user's access.
token_typeThe type of token
expires_inThe amount of time until the token expires, in seconds
refresh_tokenThe refresh token provided in the authorization request
","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"6bb3de97-751e-47bd-8d88-63c43538c0d9","id":"6bb3de97-751e-47bd-8d88-63c43538c0d9","name":"Authorization","type":"folder"}},"urlObject":{"path":["auth","realms","{{realm}}","protocol","openid-connect","token"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"dd4a2768-0b3b-4aa0-a7da-47917b3217ab","name":"Authorize client","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"{{client_id}}","type":"text"},{"key":"client_secret","value":"{{client_secret}}","type":"text"},{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"scope","value":"offline_access","type":"text"}]},"url":"{{host}}/connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 22 Nov 2021 19:07:29 GMT"},{"key":"Content-Type","value":"application/json;charset=UTF-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"181"},{"key":"Cache-Control","value":"no-store"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"Thu, 01 Jan 1970 00:00:00 GMT"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"kRjvJJpQpwWHoWKi-K_5SO0w0dkAqiO2QudmyoJxlTI\",\n \"expires_in\": 36000,\n \"refresh_expires_in\": 0,\n \"token_type\": \"Bearer\",\n \"not-before-policy\": 0,\n \"scope\": \"profile email roles\"\n}"}],"_postman_id":"b90271a5-608c-4d9a-ab94-6f9d0a1d8a89"},{"name":"User Info","id":"1c02f63f-80d3-42fc-9a70-312146e04dce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"key":"client_id","value":"{{client_id}}","type":"text"},{"key":"client_secret","value":"{{client_secret}}","type":"text"},{"key":"grant_type","value":"client_credentials","type":"text"},{"key":"scope","value":"roles","type":"text"}]},"url":"{{host}}/auth/realms/{{realm}}/protocol/openid-connect/userinfo","description":"

A request that retrieves information from the user (or application key).

\n

Response Attributes ->

\n\n \n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n
AttributesDescription
ClientIdThe client identification (public key)
UserIdThe user identification
NameThe user's name
EmailThe user's email
IsAdminA boolean to identify if the user has admin privileges
IsEmailValidA boolean to identify if the user's email has been verified
CustomerIdThe ID of the customer the user or application is related to
CustomerApplicationIdThe ID of the customer's application (key)
CustomerTaxIdThe customer's tax document number
CustomerLegalNameThe customer's legal name
PermissionsAn array containing the permissions keys for the user (or application)
","urlObject":{"path":["auth","realms","{{realm}}","protocol","openid-connect","userinfo"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"4ee0da01-6afd-415d-b2b8-f8740390ede0","name":"User Info","originalRequest":{"method":"GET","header":[],"url":"{{host}}/connect/userinfo"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 28 Oct 2021 21:09:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"450"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"clientId\": \"pre-pago\",\n \"userId\": null,\n \"name\": null,\n \"email\": null,\n \"isAdmin\": false,\n \"isEmailValid\": null,\n \"customerId\": \"6aea7d01-5062-4aa3-ae22-ecd8069d6329\",\n \"customerApplicationId\": \"11b02c18-0a2a-4908-90ff-33ff88ce0672\",\n \"customerTaxId\": \"29.232.086/0001-60\",\n \"customerLegalName\": \"Teste pré pago\",\n \"permissions\": [\n \"customerApplication_read\",\n \"customerApplication_write\",\n \"financial_read\",\n \"financial_write\",\n \"orders_read\",\n \"orders_write\",\n \"users_read\",\n \"users_write\"\n ]\n}"}],"_postman_id":"1c02f63f-80d3-42fc-9a70-312146e04dce"}],"id":"6bb3de97-751e-47bd-8d88-63c43538c0d9","description":"

This folder handles authorization requests.

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"d8bc37e8-c8ef-43b1-bf20-e10a21df261a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8383d103-6fd7-411f-b6d6-7b1954ed756f","type":"text/javascript","exec":[""]}}],"_postman_id":"6bb3de97-751e-47bd-8d88-63c43538c0d9"},{"name":"Customer","item":[{"name":"Balance","item":[{"name":"Balance","id":"8563cab2-a336-4ef3-9d96-9eb04c7cf7cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"formdata","formdata":[]},"url":"{{api_host}}/v1/customers/balance","description":"

This request returns the balance of the customer for each currency it has orders and/or invoices in. The balance is a sum between invoices that generate credit and invoices that generate debt, alongside with detailed information of open invoices (debit) and non billed orders for the customer.

\n

Required permissions ->

\n\n \n \n\n\n\n\n
Required permissions
financial_write;
financial_read
\n\n\n

Request parameters ->

\n\n \n \n \n\n \n \n \n\n\n \n \n \n
ParameterDescription
startPeriod

Format: YYYY-MM-DD		Sets the start date to perform balance calculation from. This parameter is optional, if omitted the API will calculate the balance from the very first order and/or invoice.
endPeriod

Format: YYYY-MM-DD		Sets the end date to perform balance calculation to. This parameter is optional, if omitted the API will calculate the balance until the current date.
\n\n

Response attributes ->

\n\n \n \n \n\n \n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n \n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n
AttributeDescription
startPeriodThe date the request started looking for data. Will only appear in the response if it was part of the request.
endPeriodThe date the request stopped looking for data. Will only appear in the response if it was part of the request.
balancesByCurrencyAn array of objects, each containing a VcuBalance object, and the currency used to create orders.
currencyThe currency for this particular vcuBalance
vcuBalanceThe VcuBalance object
typeThe type of the value. This value is 'VCU'
balanceCustomer's balance (credit - usedCredit)
creditSum of invoices that generate credit for the customer
usedCreditSum of orders that consume from customer's balance
debitSum of open (yet to be paid) invoices
futureDebitSum of open orders (unbilled)
","urlObject":{"path":["v1","customers","balance"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"59eb8613-762b-407a-9e55-5441f1622cc4","name":"Balance","originalRequest":{"method":"GET","header":[],"url":"{{api_host}}/v1/customers/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 27 Oct 2021 19:09:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"354"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"startDate\": \"2023-03-03T17:52:38.695502\",\n \"endDate\": \"2023-03-03T22:46:41.5510758Z\",\n \"balancesByCurrency\": [\n {\n \"currency\": \"BRL\",\n \"vcuBalance\": {\n \"type\": \"VCU\",\n \"balance\": 97.0,\n \"credit\": 100.0,\n \"debt\": 0.0,\n \"futureDebt\": 0.0\n }\n }\n ]\n}"}],"_postman_id":"8563cab2-a336-4ef3-9d96-9eb04c7cf7cc"}],"id":"ce93fef3-3791-4bba-8446-a1120b93c07a","description":"

The requests in this folder refers to customer balance.

\n","_postman_id":"ce93fef3-3791-4bba-8446-a1120b93c07a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}}}],"id":"5749693d-c058-42b6-a41a-f9d9e7e4331f","description":"

The requests in this folder deal with customer requests.

\n","_postman_id":"5749693d-c058-42b6-a41a-f9d9e7e4331f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}}},{"name":"Applications","item":[{"name":"List Applications","id":"153bb2a0-3d9b-44b6-8d4f-d7f7aa332439","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_host}}/v1/customers/applications?page=2&page-size=10","description":"

This request returns a paginated list of applications (keys).

\n

Permissions ->

\n\n \n \n\n\n\n\n
Required permissions
customerApplication_write;
customerApplication_read
\n\n

Response parameters ->

\n\n \n \n \n\n \n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n
AttributeDescription
itemsAn array of paginated orders from the customer
client-idPublic key of the application
permissionsArray of permissions for the application (key)
nameThe name of the permission
keyThe key relating to the permission
pageIndexThe index of the returned page
totalPagesThe total number of pages
totalCountThe total number of orders
hasPreviousPageFlag (boolean) indicating whether the list has a previous page
hasNextPageFlag (boolean) indicating whether the list has a next page
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","customers","applications"],"host":["{{api_host}}"],"query":[{"key":"page","value":"2"},{"key":"page-size","value":"10"}],"variable":[]}},"response":[{"id":"1d7a5a92-423b-4a5c-9d91-6553ff9d6b6b","name":"Response","originalRequest":{"method":"GET","header":[],"url":"{{host}}/v1/customers/applications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Oct 2021 20:45:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"567"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"clientId\": \"app-test\",\n \"permissions\": [\n {\n \"name\": \"Users - Write\",\n \"key\": \"users_write\"\n },\n {\n \"name\": \"CustomerApplication - Write\",\n \"key\": \"customerApplication_write\"\n },\n {\n \"name\": \"Financial - Write\",\n \"key\": \"financial_write\"\n },\n {\n \"name\": \"Users - Read\",\n \"key\": \"users_read\"\n },\n {\n \"name\": \"Financial - Read\",\n \"key\": \"financial_read\"\n },\n {\n \"name\": \"Orders - Read\",\n \"key\": \"orders_read\"\n },\n {\n \"name\": \"CustomerApplication - Read\",\n \"key\": \"customerApplication_read\"\n },\n {\n \"name\": \"Orders - Write\",\n \"key\": \"orders_write\"\n }\n ]\n }\n ],\n \"pageIndex\": 1,\n \"totalPages\": 1,\n \"totalCount\": 1,\n \"hasPreviousPage\": false,\n \"hasNextPage\": false\n}"}],"_postman_id":"153bb2a0-3d9b-44b6-8d4f-d7f7aa332439"},{"name":"Application","id":"5c87d278-253f-4eef-b4c0-80e57e291451","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientId\": \"myapp_name2\",\n \"displayName\": \"Chave do Bot que vai gerar certificados tipo CBX\",\n \"customerId\": \"1f2f3c6f-0177-4905-88d4-f4e0b667fdca\",\n \"permissions\": [\n {\n \"id\": \"29062839-b2c4-4e15-888e-099478f8b003\"\n },\n {\n \"id\": \"ad41afae-a729-4eac-b1f2-ccf91ff5218e\"\n },\n {\n \"id\": \"11be13fe-204d-4a64-b61a-dc53aaaa229d\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{api_host}}/v1/customers/applications","description":"

This request creates an application (key) that can be used on machine-2-machine integrations with the API.

\n

Permissions ->

\n\n \n \n\n\n\n\n
Required permissions
customerApplication_write
\n\n

Request attributes ->

\n\n \n \n \n\n \n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n
ParameterDescription
clientIdThe generated client Id
clientNameThe client's name
permissionsAn array of object that contains the keys of the user's permissions
name (optional)Name of a desired permissions for the user
idId of a desired permissions for the user
\n\n\n

Response attributes ->

\n\n \n \n \n\n \n \n \n\n
ParameterDescription
customerApplicationKeyThe private (secret) key generated. This information is not stored and must be secured
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","customers","applications"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"82c9c324-8859-463e-b736-12ebf11faad4","name":"New Application key","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"clientId\": \"myapp_name\",\n \"displayName\": \"Chave do Bot que vai gerar certificados tipo CBX\",\n \"customerId\": \"1f2f3c6f-0177-4905-88d4-f4e0b667fdca\",\n \"permissions\": [\n {\n \"id\": \"29062839-b2c4-4e15-888e-099478f8b003\"\n },\n {\n \"id\": \"ad41afae-a729-4eac-b1f2-ccf91ff5218e\"\n },\n {\n \"id\": \"11be13fe-204d-4a64-b61a-dc53aaaa229d\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/customers/applications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 12 Nov 2021 21:56:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"65"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"bc3813a9-58bd-4e39-8ed6-64e195791345\",\n \"clientId\": \"cbx_b2b_myapp_name\",\n \"clientSecret\": \"3b713f38-a3b2-4065-8032-ce8269735450\"\n}"}],"_postman_id":"5c87d278-253f-4eef-b4c0-80e57e291451"},{"name":"Fetch an API","id":"f45ddb87-cc6c-49fa-a73d-0846a81b0a14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_host}}/v1/customers/applications/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","customers","applications",":id"],"host":["{{api_host}}"],"query":[],"variable":[{"type":"any","value":"02c75cc5-b575-4b5f-87d8-bf09e6009c23","key":"id"}]}},"response":[{"id":"b54de07c-3d55-49f6-9a10-11f0fefb132a","name":"Fetch an API","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_host}}/v1/customers/applications/:id","host":["{{api_host}}"],"path":["v1","customers","applications",":id"],"variable":[{"key":"id","value":"781d50ae-ab86-4988-8d39-48dca58da6a6"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"02c75cc5-b575-4b5f-87d8-bf09e6009c23\",\n \"clientId\": \"cbx_b2b_myapp4\",\n \"displayName\": \"My test app33\",\n \"permissions\": [\n {\n \"id\": \"781d50ae-ab86-4988-8d39-48dca58da6a6\",\n \"name\": \"default-roles-co2free\",\n \"description\": \"${role_default-roles}\",\n \"composite\": true,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n }\n ]\n}"}],"_postman_id":"f45ddb87-cc6c-49fa-a73d-0846a81b0a14"}],"id":"4f224bd6-b080-4d62-85ea-ef9b4875b9c6","description":"

Operations for customers applications (keys).

\n","_postman_id":"4f224bd6-b080-4d62-85ea-ef9b4875b9c6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}}},{"name":"Users","item":[{"name":"Users","event":[{"listen":"test","script":{"id":"9df633a5-bc0f-4f7c-bd15-4f1f0f4fd61d","exec":[""],"type":"text/javascript"}}],"id":"0e22d17d-490a-426b-8ddf-645972e1f299","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"{{api_host}}/v1/users","description":"

This request returns a paginated list of active users.

\n

Response attributes ->

\n\n \n \n \n\n \n \n \n\n \n \n \n\n \n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n \n \n \n\n\n \n \n\n \n \n \n\n\n \n \n\n
AttributeDescription
itemsA list of User objects
idUser's id
emailUser's email
nameUser's name
pictureLink to user's profile picture
preferredLanguageUser's language choice
customerIdId of the user's customer
isAdminA flag (boolean) that indicates if the user is Admininistrator
permissionsAn array of object that contains the keys of the user's permissions
nameName of the permission
keyKey of the permission
pageIndexThe number of the page of the response
totalPagesThe total number of pages contained in the response
totalCountThe total number of users
hasPreviousPageFlag (boolean) indicating whether the list has a previous page
hasNextPageFlag (boolean) indicating whether the list has a next page
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","users"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"a9085255-3973-44e9-ba16-fbf2a433ffb4","name":"Query user","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":{"raw":"{{host}}/v1/users?page=1&pagesize=10","host":["{{host}}"],"path":["v1","users"],"query":[{"key":"page","value":"1"},{"key":"pagesize","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Oct 2021 20:55:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"1009"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"73f66705-0361-4f67-aee3-65c02cd3804c\",\n \"email\": \"usuario@email.com\",\n \"name\": \"Usuario\",\n \"isEmailVerified\": false,\n \"permissions\": null\n },\n {\n \"id\": \"cb8b223d-b2a4-49b4-b8c5-6b74a44aed02\",\n \"email\": \"usuario1@email.com\",\n \"name\": \"Usuario1\",\n \"isEmailVerified\": false,\n \"permissions\": null\n },\n {\n \"id\": \"d6cf6eb0-7587-4c1d-9059-eba56fb065f6\",\n \"email\": \"usuario2@email.com\",\n \"name\": \"Usuario2\",\n \"isEmailVerified\": false,\n \"permissions\": null\n },\n {\n \"id\": \"29d18332-392e-42a4-9835-bbb3c33e4083\",\n \"email\": \"usuario3@email.com\",\n \"name\": \"Usuario3\",\n \"isEmailVerified\": false,\n \"permissions\": null\n },\n {\n \"id\": \"ca731fcd-abcd-412e-aa05-7502fbf52e25\",\n \"email\": \"usuario4@email.com\",\n \"name\": \"Usuario4\",\n \"isEmailVerified\": false,\n \"permissions\": null\n }\n ],\n \"pageIndex\": 1,\n \"totalPages\": 1,\n \"totalCount\": 5,\n \"aggregations\": null,\n \"hasPreviousPage\": false,\n \"hasNextPage\": false\n}"}],"_postman_id":"0e22d17d-490a-426b-8ddf-645972e1f299"},{"name":"User","id":"9c40c178-1491-421b-887b-baac400e5143","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"usuario17@email.com\",\n \"userPassword\": \"123456\",\n \"name\": \"Usuario 9\",\n \"permissions\": [\n {\n \"id\": \"c56452df-18fe-474b-9cab-82080af3e902\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{api_host}}/v1/users","description":"

This request creates a new user.

\n

Request body attributes ->

\n\n \n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n
AttributesDescription
emailUser's email
userPasswordUser's password
nameUser's name
permissionsAn array of object that contains the keys of the user's permissions
idId of the desired permissions for the user
\n\n

Response attributes ->

\n\n \n \n \n\n \n \n \n\n \n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n
AttributesDescription
idUser's Id
emailUser's email
nameUser's name
pictureLink to user's profile picture
preferredLanguageUser's language choice
isAdminA flag (boolean) that indicates if the user is Admininistrator
permissionsAn array of object that contains the user's permissions
nameName of the permission
keyKey of the permission
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","users"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"a6cc6cd9-d6ef-45e2-b918-2c5edddaaf98","name":"Create user","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"usuario3@email.com\",\n \"userPassword\": \"123456\",\n \"name\": \"Usuario 3\",\n \"permissions\":\n [\n {\n \"key\": \"users_write\"\n },\n {\n \"key\": \"users_read\"\n },\n {\n \"key\": \"customerApplication_write\"\n },\n {\n \"key\": \"customerApplication_read\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Oct 2021 20:54:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"397"},{"key":"Location","value":""},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"73f66705-0361-4f67-aee3-65c02cd3804c\",\n \"email\": \"usuario@email.com\",\n \"name\": \"Usuario\",\n \"isEmailVerified\": false,\n \"permissions\": [\n {\n \"id\": \"c56452df-18fe-474b-9cab-82080af3e902\",\n \"name\": \"users_write\",\n \"description\": \"Criar/Remover usuários\",\n \"composite\": false,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n }\n ]\n}"}],"_postman_id":"9c40c178-1491-421b-887b-baac400e5143"},{"name":"User","id":"c75a833c-e988-4f8e-b8a2-f3254be1b22e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Usuario 3050\",\n \"permissions\": [\n {\n \"id\": \"29062839-b2c4-4e15-888e-099478f8b003\"\n },\n {\n \"id\": \"ad41afae-a729-4eac-b1f2-ccf91ff5218e\"\n },\n {\n \"id\": \"11be13fe-204d-4a64-b61a-dc53aaaa229d\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{api_host}}/v1/users/591fa3fd-5d15-47d1-8ad9-111a14cd8c2d","description":"

This request updates a user.

\n

Request parameters ->

\n\n \n \n \n\n \n \n \n\n
ParameterDescription
idThe user's id
\n\n\n

Request body attributes ->

\n\n \n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n
AttributeDescription
nameUser's name
permissionsAn array of object that contains the keys of the user's permissions
keyThe key of the user's permissions
\n\n

Response attributes ->

\n\n \n \n \n\n \n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n
AttributeDescription
IdUser's generated id
emailUser's email
nameUser's name
pictureLink to user's profile picure
preferredLanguageUser's language choice
isAdminA flag (boolean) that indicates if the user is Admininistrator
permissionsAn array of object that contains the user's permissions
name (optional)Name of a desired permissions for the user
keyKey of a desired permissions for the user
","urlObject":{"path":["v1","users","591fa3fd-5d15-47d1-8ad9-111a14cd8c2d"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"1eacd69a-0ff0-4754-8ade-5cf5f9e99374","name":"Edit user","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Usuario 2999000000\",\n \"permissions\":[\n {\n \"name\": \"Users - Write\",\n \"key\": \"users_write\"\n },\n {\n \"name\": \"CustomerApplication - Write\",\n \"key\": \"customerApplication_write\"\n },\n {\n \"name\": \"Users - Read\",\n \"key\": \"users_read\"\n },\n {\n \"name\": \"CustomerApplication - Read\",\n \"key\": \"customerApplication_read\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v1/users/:id","host":["{{host}}"],"path":["v1","users",":id"],"variable":[{"key":"id","value":"3f44d194-52cd-4a2b-ac37-1c9a7713add1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 06 Oct 2021 22:12:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"406"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"3f44d194-52cd-4a2b-ac37-1c9a7713add1\",\n \"email\": \"usuario2@email.com\",\n \"name\": \"Usuario 2999000000\",\n \"picture\": null,\n \"preferredLanguage\": null,\n \"isAdmin\": false,\n \"permissions\": [\n {\n \"name\": \"Users - Write\",\n \"key\": \"users_write\"\n },\n {\n \"name\": \"CustomerApplication - Write\",\n \"key\": \"customerApplication_write\"\n },\n {\n \"name\": \"Users - Read\",\n \"key\": \"users_read\"\n },\n {\n \"name\": \"CustomerApplication - Read\",\n \"key\": \"customerApplication_read\"\n }\n ]\n}"}],"_postman_id":"c75a833c-e988-4f8e-b8a2-f3254be1b22e"},{"name":"User","id":"c34045a0-d376-49b6-a981-5880883f40f0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{api_host}}/v1/users/:id","description":"

This request deletes a user.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","users",":id"],"host":["{{api_host}}"],"query":[],"variable":[{"type":"any","value":"d6cf6eb0-7587-4c1d-9059-eba56fb065f6","key":"id"}]}},"response":[{"id":"c37c6f33-de29-4319-903b-62965cfd0a40","name":"Delete user","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{host}}/v1/users/:id","host":["{{host}}"],"path":["v1","users",":id"],"variable":[{"key":"id","value":"8c9c9ecf-295c-49e5-a3f9-6f2cf27b169d"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 07 Oct 2021 17:18:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"4"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"c34045a0-d376-49b6-a981-5880883f40f0"},{"name":"User","id":"d7d21365-49f9-4353-af30-5c343fb590c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_host}}/v1/users/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","users",":id"],"host":["{{api_host}}"],"query":[],"variable":[{"type":"any","value":"d6cf6eb0-7587-4c1d-9059-eba56fb065f6","key":"id"}]}},"response":[{"id":"fabebaa4-60af-4616-ade6-22954d70330e","name":"User","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_host}}/v1/users/:id","host":["{{api_host}}"],"path":["v1","users",":id"],"variable":[{"key":"id","value":"781d50ae-ab86-4988-8d39-48dca58da6a6"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": \"d6cf6eb0-7587-4c1d-9059-eba56fb065f6\",\n \"email\": \"usuario@email.com\",\n \"name\": \"Usuario\",\n \"isEmailVerified\": false,\n \"permissions\": [\n {\n \"id\": \"781d50ae-ab86-4988-8d39-48dca58da6a6\",\n \"name\": \"default-roles-co2free\",\n \"description\": \"${role_default-roles}\",\n \"composite\": true,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n }\n ]\n}"}],"_postman_id":"d7d21365-49f9-4353-af30-5c343fb590c6"}],"id":"a208d7f4-a51b-4b7f-ab4d-dc5ec3e20e52","description":"

The requests in this folder handle CRUD operations on Users resources.

\n","event":[{"listen":"prerequest","script":{"id":"f424b711-beac-4b37-b895-df73928bfb55","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c13e66ae-ec17-471b-92e3-b174855341c3","type":"text/javascript","exec":[""]}}],"_postman_id":"a208d7f4-a51b-4b7f-ab4d-dc5ec3e20e52","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}}},{"name":"Prices","item":[{"name":"Vcu Price","id":"76930be4-5b32-40cb-b3f7-025b1823bf9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{api_host}}/v1/prices?vcu-amount=1","description":"

Retrieves the VCU unitary price.

\n

Response Attributes ->

\n\n \n \n \n\n\n \n \n\n\n \n \n\n
AttributesDescription
vcuPriceThe price applied for 1 VCU (equivalent to 1 ton CO2eq)
currencyThe currency of the price for which the price was calculated
","urlObject":{"path":["v1","prices"],"host":["{{api_host}}"],"query":[{"key":"vcu-amount","value":"1"}],"variable":[]}},"response":[{"id":"d91f0356-76d3-4448-9a40-2c5e4bcffc0b","name":"Vcu Price","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_host}}/v1/prices?vcu-amount=1","host":["{{api_host}}"],"path":["v1","prices"],"query":[{"key":"vcu-amount","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"openresty"},{"key":"Date","value":"Fri, 11 Feb 2022 17:37:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"36"},{"key":"Connection","value":"keep-alive"},{"key":"api-supported-versions","value":"1.0"},{"key":"X-Served-By","value":"auth-hml.carbonext.com.br"}],"cookie":[],"responseTime":null,"body":"{\n \"vcuPrice\": 110.00,\n \"currency\": \"BRL\",\n \"conversionRate\": 0.0\n}"}],"_postman_id":"76930be4-5b32-40cb-b3f7-025b1823bf9f"}],"id":"7d32904d-0c3a-4cd6-b2a0-c8ccb2fb575b","description":"

Pricing related requests.

\n","event":[{"listen":"prerequest","script":{"id":"53a3f2f0-b168-4cbd-b918-22a79aa958a1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"18aabf31-a30f-4152-a615-8ba5082129bf","type":"text/javascript","exec":[""]}}],"_postman_id":"7d32904d-0c3a-4cd6-b2a0-c8ccb2fb575b","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}}},{"name":"Orders","item":[{"name":"Orders","id":"dafa8168-20ad-44bc-bb4b-2932b2206842","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_host}}/v1/orders?page=1&page-size=6","description":"

This request returns a paginated list of orders.

\n

Response attributes ->

\n\n \n \n \n\n \n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n
AttributeDescription
itemsAn array of paginated orders from the customer
idThe order Id
vcuAmountThe total amount of VCUs requested in this order
vcuUnitPriceThe VCU unitary price at the time of the order's creation
targetCurrencyThe target currency the order was created in
statusName of the order's current status
createdAtThe date and time the order was created
pageIndexThe index of the returned page
totalPagesThe total number of pages
totalCountThe total number of orders
hasPreviousPageFlag (boolean) indicating whether the list has a previous page
hasNextPageFlag (boolean) indicating whether the list has a next page
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","orders"],"host":["{{api_host}}"],"query":[{"key":"page","value":"1"},{"key":"page-size","value":"6"}],"variable":[]}},"response":[{"id":"b6c5c2a9-adc8-4d89-9e80-b7d90313576a","name":"Orders","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v1/orders?page=1&page-size=100","host":["{{host}}"],"path":["v1","orders"],"query":[{"key":"page","value":"1"},{"key":"page-size","value":"100"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 23 Nov 2021 17:36:57 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"5746"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"768a7273-400c-4a9b-8536-71fe1ec00de7\",\n \"vcuAmount\": 1.0,\n \"vcuUnitPrice\": 110.00,\n \"totalPrice\": 110.00,\n \"targetCurrency\": \"BRL\",\n \"status\": \"Paid\",\n \"createdAt\": \"2023-03-03T18:07:57.155543\",\n \"notifyCertificateTo\": null,\n \"type\": \"Prepaid\",\n \"paymentDate\": \"2023-03-03T18:07:57.153643\",\n \"metaData\": null,\n \"retireForRecipient\": false,\n \"certificateRecipientInfo\": {\n \"name\": \"test test test\",\n \"email\": \"email@email.com\",\n \"taxId\": \"20.094.232/0001-63\",\n \"fileUploadKey\": null,\n \"origin\": 7,\n \"emailTemplateKey\": null,\n \"notificationEmailVariables\": null,\n \"fileTemplateKey\": null,\n \"certificateFileVariables\": null\n },\n \"invoices\": [],\n \"subscriptions\": []\n },\n {\n \"id\": \"833f0df0-02bc-44ff-84ee-7b84f3599496\",\n \"vcuAmount\": 1.0,\n \"vcuUnitPrice\": 110.00,\n \"totalPrice\": 110.00,\n \"targetCurrency\": \"BRL\",\n \"status\": \"Paid\",\n \"createdAt\": \"2023-03-03T18:07:27.488807\",\n \"notifyCertificateTo\": null,\n \"type\": \"Prepaid\",\n \"paymentDate\": \"2023-03-03T18:07:27.485366\",\n \"metaData\": null,\n \"retireForRecipient\": false,\n \"certificateRecipientInfo\": {\n \"name\": \"test test test\",\n \"email\": \"email@email.com\",\n \"taxId\": \"20.094.232/0001-63\",\n \"fileUploadKey\": null,\n \"origin\": 7,\n \"emailTemplateKey\": null,\n \"notificationEmailVariables\": null,\n \"fileTemplateKey\": null,\n \"certificateFileVariables\": null\n },\n \"invoices\": [],\n \"subscriptions\": []\n }\n ],\n \"pageIndex\": 1,\n \"totalPages\": 1,\n \"totalCount\": 2,\n \"aggregations\": null,\n \"hasPreviousPage\": false,\n \"hasNextPage\": false\n}"}],"_postman_id":"dafa8168-20ad-44bc-bb4b-2932b2206842"},{"name":"Order","id":"cb010abd-0585-4a3b-9047-84b203e394b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"vcuAmount\": 1,\n \"targetCurrency\": \"BRL\",\n \"certificateRecipientInfo\": {}\n}","options":{"raw":{"language":"json"}}},"url":"{{api_host}}/v1/orders","description":"

This request creates an order.

\n

Request attributes ->

\n\n \n \n \n\n \n \n \n\n \n \n \n\n \n \n \n\n
AttributeDescription
vcuAmountThe amount of VCU assigned to the order
targetCurrencyThe desired currency for the order to be charged in
payWithBalanceFlag (boolean) indicating if this order should automatically discount from customer balance or not(if the customer is allowed for creating postpaid orders)
\n\n

Response attributes ->

\n\n \n \n \n\n \n \n \n\n \n \n \n\n \n \n \n \n \n \n\n \n \n \n\n \n \n \n\n
AttributeDescription
idThe generated order Id
vcuAmountThe total amount of VCU requested in the order
vcuUnitPriceThe unitary price of a VCU at the time the ordere creation
targetCurrencyThe currency the order will be charged in
statusName of the order's current status
createdAtThe date and time the order was created
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","orders"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"57ed8495-2ee3-41b6-92a9-8b38e5884998","name":"Order","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"vcuAmount\":150,\n \"targetCurrency\":\"BRL\",\n \"PayWithBalance\":false\n}","options":{"raw":{"language":"json"}}},"url":"{{api_host}}/v1/orders"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 28 Oct 2021 21:12:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"159"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"5f9b8b6f-c8a1-48b1-be49-205fa7db\",\n \"vcuAmount\": 1.0,\n \"vcuUnitPrice\": 110.00,\n \"totalPrice\": 110.00,\n \"targetCurrency\": \"BRL\",\n \"status\": \"Paid\",\n \"createdAt\": \"2023-03-03T18:10:48.1824733Z\",\n \"notifyCertificateTo\": null,\n \"type\": \"Prepaid\",\n \"paymentDate\": \"2023-03-03T18:10:48.1806031Z\",\n \"metaData\": null,\n \"retireForRecipient\": false,\n \"certificateRecipientInfo\": {\n \"name\": \"test test test\",\n \"email\": \"email@email.com.br\",\n \"taxId\": \"20.094.232/0001-63\",\n \"fileUploadKey\": null,\n \"origin\": 7,\n \"emailTemplateKey\": null,\n \"notificationEmailVariables\": null,\n \"fileTemplateKey\": null,\n \"certificateFileVariables\": null\n }\n}"}],"_postman_id":"cb010abd-0585-4a3b-9047-84b203e394b0"},{"name":"Cancel order","id":"2eb7d095-fe1c-4ab8-970e-37100194d1b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{api_host}}/v1/orders/:orderId/cancel","description":"

This request cancels an order.

\n

Response attributes ->

\n\n \n \n \n\n \n \n \n\n\n \n \n\n \n \n \n\n\n \n \n\n \n \n \n\n\n \n \n\n
AttributeDescription
IdThe order's Id
vcuAmountThe amount of VCUs that this order was handling
vcuUnitPriceThe VCU price when the order was created
targetCurrencyThe currency this order was being handled in
statusName of the order's current status, value will be \"Cancelled\"
createdAtThe date and time this order was created
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","orders",":orderId","cancel"],"host":["{{api_host}}"],"query":[],"variable":[{"type":"any","value":"c0396eb3-2b25-46fc-b800-6e5c5f86614f","key":"orderId"}]}},"response":[{"id":"ff1b0355-eec6-4bb9-9ffa-c25a924b2a0d","name":"Cancel order","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{api_host}}/v1/orders/:orderId/cancel","host":["{{api_host}}"],"path":["v1","orders",":orderId","cancel"],"variable":[{"key":"orderId","value":"f8e48b36-b0e4-41eb-bbe5-0cc1bdfc5be2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 28 Oct 2021 21:13:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"162"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"768a7273-400c-4a9b-8536-71fe1ede7\",\n \"vcuAmount\": 1.0,\n \"vcuUnitPrice\": 110.00,\n \"totalPrice\": 110.00,\n \"targetCurrency\": \"BRL\",\n \"status\": \"Cancelled\",\n \"createdAt\": \"2023-03-03T18:07:57.155543\",\n \"notifyCertificateTo\": null,\n \"type\": \"Prepaid\",\n \"paymentDate\": \"2023-03-03T18:07:57.153643\",\n \"metaData\": null,\n \"retireForRecipient\": false,\n \"certificateRecipientInfo\": {\n \"name\": \"test test test\",\n \"email\": \"test@email.com.br\",\n \"taxId\": \"20.094.232/0001-63\",\n \"fileUploadKey\": null,\n \"origin\": 7,\n \"emailTemplateKey\": null,\n \"notificationEmailVariables\": null,\n \"fileTemplateKey\": null,\n \"certificateFileVariables\": null\n }\n}"}],"_postman_id":"2eb7d095-fe1c-4ab8-970e-37100194d1b4"},{"name":"Cancel orders","id":"92fc482b-bd01-4722-af45-ac65173806c6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"ordersIds\":\n [\n \"c0396eb3-2b25-46fc-b800-6e5c5f86614f\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{api_host}}/v1/orders/cancel","description":"

Orders can be cancelled in batches.

\n

Request parameters ->

\n\n \n \n \n\n \n \n \n\n
ParameterDescription
ordersIdsAn array of Ids of the orders to be cancelled
\n\n\n

Response ->

\n

Returns \"true\" if, and only if, all orders were successfully cancelled.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","orders","cancel"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"79dc45d5-7f99-4289-a419-d73a444e2083","name":"Successfull cancellation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"ordersIds\":\n [\n \"14a60138-d078-4f1d-b72a-87f0820b7ccb\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/v1/orders/cancel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 14 Oct 2021 14:57:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"4"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"true"}],"_postman_id":"92fc482b-bd01-4722-af45-ac65173806c6"}],"id":"30606df0-dd1e-466b-ba6e-b7851db3bd56","description":"

This folder presents request related to orders.

\n","event":[{"listen":"prerequest","script":{"id":"674f39b4-7383-432b-9a17-e8f66d4a8599","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"970531c6-8daa-4287-8e76-a63527e01758","type":"text/javascript","exec":[""]}}],"_postman_id":"30606df0-dd1e-466b-ba6e-b7851db3bd56","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}}},{"name":"Invoices","item":[{"name":"Invoices","id":"bc444d84-89ec-446b-92a3-77823a26ebe6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_host}}/v1/invoices?sort-by=totalVcuAmount_asc&filter-by=totalVcuAmount_ge:30~status_in:Paid-pending","description":"

This request returns a paginated list of invoices.

\n

Response attributes ->

\n\n \n \n \n\n \n \n \n\n \n \n \n\n \n \n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n
AttributesDescription
itemsAn object containing all invoices related to the customer id
idInvoice id
statusThe current status of an invoice.
totalVcuAmountTotal amount of VCUs charged in the invoice
totalPriceThe amount charged in the invoice,
currencyThe currency the invoice is charged in
customerIdThe Id of the customer that owns the invoice
ordersList of orders attached to the invoice
idThe order Id
vcuAmountThe total amount of VCUs requested in this order
vcuUnitPriceThe VCU unitary price at the time of the order's creation
targetCurrencyThe target currency the order is created in
statusName of the order's current status
createdAtThe date and time the order was created
pageIndexThe index of the returned page
totalPagesThe total number of pages
totalCountThe total number of orders
hasPreviousPageFlag (boolean) indicating whether the list has a previous page
hasNextPageFlag (boolean) indicating whether the list has a next page
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","invoices"],"host":["{{api_host}}"],"query":[{"key":"sort-by","value":"totalVcuAmount_asc"},{"key":"filter-by","value":"totalVcuAmount_ge:30~status_in:Paid-pending"}],"variable":[]}},"response":[{"id":"2c308211-1462-47ed-923f-1dc80801d334","name":"Invoices","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_host}}/v1/invoices?page=1&page-size=10&sort-by=totalVcuAmount_desc&filter-by=totalPrice_ge:1000~status_in:Paid-pending~bla","host":["{{api_host}}"],"path":["v1","invoices"],"query":[{"key":"page","value":"1"},{"key":"page-size","value":"10"},{"key":"sort-by","value":"totalVcuAmount_desc"},{"key":"filter-by","value":"totalPrice_ge:1000~status_in:Paid-pending~bla"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 28 Oct 2021 21:16:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"1959"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"2665d551-f8d2-4c16-8712-bee1390ef274\",\n \"status\": \"Paid\",\n \"totalVcuAmount\": 100.0,\n \"totalPrice\": 11000.00,\n \"currency\": \"BRL\",\n \"customerId\": \"520732d9-e2a0-4d27-aea3-fa7f0cba7390\",\n \"createdAt\": \"2023-03-03T17:52:38.695502\",\n \"paidAt\": \"2023-03-03T17:52:41.087552\",\n \"dueDate\": \"2023-03-13T17:52:38.675653\",\n \"paymentType\": \"creditCard\",\n \"generatesRetirement\": true,\n \"invoiceUploadUrl\": \"https://carbonext-b2b.s3.amazonaws.com/invoices\",\n \"paymentMethodId\": \"pm_1MhcmWJRcnwkuWspCNCqM0FG\",\n \"netSuiteIntegrationId\": \"31030\",\n \"purchaseType\": \"prePaid\",\n \"paymentData\": [],\n \"orders\": [],\n \"customer\": {}\n }\n ]\n}"}],"_postman_id":"bc444d84-89ec-446b-92a3-77823a26ebe6"},{"name":"Invoice","id":"318c37d0-26ce-4840-8628-8cb5afd011af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_host}}/v1/invoices/:id","description":"

This request will return information about a specific invoice.

\n

Response attributes ->

\n\n \n \n \n\n \n \n \n\n \n \n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n
AttributesDescription
idAn invoice's id
statusThe status of an invoice
totalVcuAmountHow many VCUs are being dealt in this invoice
totalPriceThe amount of currency being dealt in this invoice, in the currency specified below
currencyThe currency being dealt in this invoice
customerIdThe Id of the customer that owns the invoice
ordersList of orders attached to the invoice
idThe order Id
vcuAmountThe total amount of VCUs requested in this order
vcuUnitPriceThe VCU unitary price at the time of the order's creation
targetCurrencyThe target currency the order is created in
statusName of the order's current status
createdAtThe date and time the order was created
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","invoices",":id"],"host":["{{api_host}}"],"query":[],"variable":[{"type":"any","value":"b8a6c960-c21c-46fe-a2e9-1816217c3fa6","key":"id"}]}},"response":[{"id":"07ce9b61-d066-44b2-a8b5-389e9fd0f0d4","name":"Invoice","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_host}}/v1/invoices/:id","host":["{{api_host}}"],"path":["v1","invoices",":id"],"variable":[{"key":"id","value":"8dc48e75-4b71-4fa2-ada8-8516fb1a2cfd"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 28 Oct 2021 21:18:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"349"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"b8a6c960-c21c-46fe-a2e9-1816217c3fa6\",\n \"status\": \"Paid\",\n \"totalVcuAmount\": 1.0,\n \"totalPrice\": 110.00,\n \"currency\": \"BRL\",\n \"customerId\": \"b377ea40-4563-46cf-8f7f-d15f15b8772d\",\n \"createdAt\": \"2023-03-02T17:33:22.292083\",\n \"paidAt\": \"2023-03-02T17:33:24.837946\",\n \"dueDate\": \"2023-03-12T17:33:22.287299\",\n \"paymentType\": \"creditCard\",\n \"generatesRetirement\": true,\n \"invoiceUploadUrl\": \"https://carbonext-b2b.s3.amazonaws.com/invoices\",\n \"paymentMethodId\": \"pm_1MhG0KJRcnwkuWspxFMi2UtO\",\n \"netSuiteIntegrationId\": \"29630\",\n \"purchaseType\": \"prePaid\",\n \"paymentData\": [],\n \"orders\": []\n}"}],"_postman_id":"318c37d0-26ce-4840-8628-8cb5afd011af"}],"id":"4ae41bcc-206f-48ce-a55d-6450c0b61165","description":"

Invoice related requests.

\n","_postman_id":"4ae41bcc-206f-48ce-a55d-6450c0b61165","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}}},{"name":"Permissions","item":[{"name":"List permissions","id":"5395f00d-606a-4b88-8b61-99ceb55f2846","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_host}}/v1/permissions?page=1&page-size=20","description":"

This request returns a paginated lists all permissions available. This permissions can be attached to users and/or customerApplications (keys)

\n

Response attributes ->

\n\n \n \n \n\n \n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n
AttributesDescription
itemsA list of permissions
nameThe name of the permission
keyThe key relating to the permission
descriptionAny aditional info
pageIndexThe index of the returned page
totalPagesThe total number of pages
totalCountThe total number of orders
hasPreviousPageFlag (boolean) indicating whether the list has a previous page
hasNextPageFlag (boolean) indicating whether the list has a next page
","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","permissions"],"host":["{{api_host}}"],"query":[{"key":"page","value":"1"},{"key":"page-size","value":"20"}],"variable":[]}},"response":[{"id":"613ed4aa-adb5-4bf6-bada-1491f7eb3dcf","name":"List permissions","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_host}}/v1/permissions?page=1&page-size=20","host":["{{api_host}}"],"path":["v1","permissions"],"query":[{"key":"page","value":"1"},{"key":"page-size","value":"20"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 06 Dec 2021 19:38:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"1031"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"c56452df-18fe-474b-9cab-82080af3e902\",\n \"name\": \"users_write\",\n \"description\": \"Criar/Remover usuários\",\n \"composite\": false,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n },\n {\n \"id\": \"497efb5a-25eb-434f-9a2a-2e3aa6b2e6e1\",\n \"name\": \"certificates_read\",\n \"description\": \"Visualizar certificados\",\n \"composite\": false,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n },\n {\n \"id\": \"44032f0d-9fdf-415e-8707-6f1ff9753187\",\n \"name\": \"subscriptions_write\",\n \"description\": \"Criar/Pausar assinaturas\",\n \"composite\": false,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n },\n {\n \"id\": \"4f3ca574-0b89-4a92-83fa-794edcad6b76\",\n \"name\": \"customer_applications_write\",\n \"description\": \"Criar/Remover Chaves de API\",\n \"composite\": false,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n },\n {\n \"id\": \"5db0f399-28ab-4980-b320-9c321eea3bb1\",\n \"name\": \"orders_read\",\n \"description\": \"Visualizar pedidos\",\n \"composite\": false,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n },\n {\n \"id\": \"872f1e07-ec58-4058-8919-1df23e8e59da\",\n \"name\": \"financial_read\",\n \"description\": \"Visualizar informações financeiras\",\n \"composite\": false,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n },\n {\n \"id\": \"d1b9f6cb-a392-41d2-8bb5-8b07cebf137c\",\n \"name\": \"orders_write\",\n \"description\": \"Criar pedidos\",\n \"composite\": false,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n },\n {\n \"id\": \"db1a2ab4-2d26-446c-a6fe-4b2869d16c5a\",\n \"name\": \"subscriptions_read\",\n \"description\": \"Visualizar assinaturas\",\n \"composite\": false,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n },\n {\n \"id\": \"d08a41b6-f57c-4da6-806b-6610bb595f67\",\n \"name\": \"financial_write\",\n \"description\": \"Faturar pedidos\",\n \"composite\": false,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n },\n {\n \"id\": \"465a8197-8cdb-4f90-8509-b941862ba8e1\",\n \"name\": \"users_read\",\n \"description\": \"Visualizar usuários\",\n \"composite\": false,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n },\n {\n \"id\": \"c1dad7ce-a24f-4e9e-8cdd-1f1773ba4ba6\",\n \"name\": \"customer_applications_read\",\n \"description\": \"Visualizar Chaves de API\",\n \"composite\": false,\n \"clientRole\": false,\n \"containerId\": \"CO2FREE\",\n \"attributes\": null\n }\n]"}],"_postman_id":"5395f00d-606a-4b88-8b61-99ceb55f2846"}],"id":"9ae40301-99e8-41a0-901c-11ea4c980e34","event":[{"listen":"prerequest","script":{"id":"0015f0a3-e8ef-42e3-a4b5-4ff825a5c34d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"672418a8-9d51-41e5-858c-983bfcc413eb","type":"text/javascript","exec":[""]}}],"_postman_id":"9ae40301-99e8-41a0-901c-11ea4c980e34","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}}},{"name":"Certificates","item":[{"name":"List Certificates","id":"a87a1031-237d-49cc-8146-acd0d73b554f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{host_certificates}}/v1/certificates","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","certificates"],"host":["{{host_certificates}}"],"query":[{"disabled":true,"key":"customer-id","value":"212"}],"variable":[]}},"response":[{"id":"b1d9f6d8-226a-4a47-91a5-7f8bb6539e16","name":"List certificates","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_certificates}}/v1/certificates","host":["{{host_certificates}}"],"path":["v1","certificates"],"query":[{"key":"customer-id","value":"212","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jan 2022 20:07:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"3848"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": \"76d6c51c-594f-4e4a-b0e0-04cf740d6efd\",\n \"email\": \"emp1@email.com\",\n \"customerName\": \"Danilo \",\n \"type\": 0,\n \"reference\": \"2021-08-31T00:00:00\",\n \"footprint\": 3.2576876850833334,\n \"serialNumber\": \"TEST_CBX6271F05DD4A59F2E/B4E3DE\",\n \"fileUploadKey\": \"certificates/cbx/DEV-CBX20220930_212.pdf\",\n \"status\": 1,\n \"created\": \"2022-01-07T23:28:57.644955\",\n \"origin\": 999,\n \"notifyCustomer\": false,\n \"originSystemId\": \"212_sub_K8pA8d1vc5qpic_2021_08\"\n },\n {\n \"id\": \"5494f67a-b2b6-45b9-abd4-c3a36313ef3b\",\n \"email\": \"emp1@email.com\",\n \"customerName\": \"Danilo \",\n \"type\": 0,\n \"reference\": \"2021-10-01T00:00:00\",\n \"footprint\": 3.2576876850833334,\n \"serialNumber\": \"TEST_CBX28AB5FD2D09E9139/B4E3DE\",\n \"fileUploadKey\": \"certificates/cbx/DEV-CBX20221100_212.pdf\",\n \"status\": 1,\n \"created\": \"2022-01-07T23:28:59.691271\",\n \"origin\": 999,\n \"notifyCustomer\": false,\n \"originSystemId\": \"212_sub_K8pA8d1vc5qpic_2021_10\"\n },\n {\n \"id\": \"ce663dac-38a7-4d90-be09-bd88313ccc80\",\n \"email\": \"emp1@email.com\",\n \"customerName\": \"Danilo \",\n \"type\": 0,\n \"reference\": \"2021-11-01T00:00:00\",\n \"footprint\": 3.2576876850833334,\n \"serialNumber\": \"TEST_CBXE7663C1F9874AD34/B4E3DE\",\n \"fileUploadKey\": \"certificates/cbx/DEV-CBX20221200_212.pdf\",\n \"status\": 1,\n \"created\": \"2022-01-07T23:29:01.523423\",\n \"origin\": 999,\n \"notifyCustomer\": false,\n \"originSystemId\": \"212_sub_K8pA8d1vc5qpic_2021_11\"\n },\n {\n \"id\": \"ec8d91b8-9467-46d9-aad9-a4a9b2ba826e\",\n \"email\": \"emp1@email.com\",\n \"customerName\": \"Danilo \",\n \"type\": 0,\n \"reference\": \"2021-12-01T00:00:00\",\n \"footprint\": 3.2576876850833334,\n \"serialNumber\": \"TEST_CBX6FB63260029881BC/B4E3DE\",\n \"fileUploadKey\": \"certificates/cbx/DEV-CBX20221300_212.pdf\",\n \"status\": 1,\n \"created\": \"2022-01-07T23:29:03.574338\",\n \"origin\": 999,\n \"notifyCustomer\": false,\n \"originSystemId\": \"212_sub_K8pA8d1vc5qpic_2021_12\"\n },\n {\n \"id\": \"21bce60d-4b8e-4bc9-a05d-aa9e80056f7d\",\n \"email\": \"emp1@email.com\",\n \"customerName\": \"Danilo \",\n \"type\": 0,\n \"reference\": \"2021-09-01T03:00:00\",\n \"footprint\": 3.2576876850833333333333333333,\n \"serialNumber\": \"TEST_CBX9F7FC8062696A7B6/B4E3DE\",\n \"fileUploadKey\": \"a1466dd3942e430dba743d3e618bb1ca8eb2eeea275a4c1e97ae62c3a84602bf\",\n \"status\": 2,\n \"created\": \"2022-01-07T23:29:05.585162\",\n \"origin\": 0,\n \"notifyCustomer\": true,\n \"originSystemId\": \"212_sub_K8pA8d1vc5qpic_2021_09\"\n },\n {\n \"id\": \"b19350b4-58d0-4353-b292-11cf5571b9e7\",\n \"email\": \"emp1@email.com\",\n \"customerName\": \"Danilo \",\n \"type\": 0,\n \"reference\": \"2021-12-14T03:00:00\",\n \"footprint\": 3.239658153350354,\n \"serialNumber\": \"TEST_CBXBB00FC1C2C66B0F5/B4E3DE\",\n \"fileUploadKey\": \"acd89c3f9e4d4aaea4820f38191f449ba59ca4c70cf24419aa04d07699153f42\",\n \"status\": 2,\n \"created\": \"2022-01-07T23:29:07.00219\",\n \"origin\": 1,\n \"notifyCustomer\": true,\n \"originSystemId\": \"bcd93772-7961-4f6c-a02e-1bd230b3dcb7\"\n },\n {\n \"id\": \"e78f1adb-df5a-4d8a-90ca-45aab6512c6d\",\n \"email\": \"emp1@email.com\",\n \"customerName\": \"Danilo \",\n \"type\": 0,\n \"reference\": \"2021-12-14T03:00:00\",\n \"footprint\": 0.0317843103073364,\n \"serialNumber\": \"TEST_CBX5F42E2759FA5BD36/B4E3DE\",\n \"fileUploadKey\": \"b5725f9266c3439dafaa696d2a035bba8629232ab7d74995a7d62850a0980edc\",\n \"status\": 2,\n \"created\": \"2022-01-07T23:29:08.495836\",\n \"origin\": 1,\n \"notifyCustomer\": true,\n \"originSystemId\": \"b6fc68b0-a2d1-4330-ba97-9a30237aadc3\"\n },\n {\n \"id\": \"5887c850-b5a7-4b38-b3c1-7b8fb16e965d\",\n \"email\": \"emp1@email.com\",\n \"customerName\": \"Danilo \",\n \"type\": 1,\n \"reference\": \"2021-12-14T00:00:00\",\n \"footprint\": 13,\n \"serialNumber\": \"TEST_VERRAAEEAC2B99A20A1BA/B4E3DE\",\n \"fileUploadKey\": \"https://registry.verra.org/myModule/rpt/myrpt.asp?r=206&h=152812\",\n \"status\": 1,\n \"created\": \"2022-01-10T12:43:01.046693\",\n \"origin\": 999,\n \"notifyCustomer\": false,\n \"originSystemId\": \"212_sub_K8pA8d1vc5qpic_2021_12\"\n },\n {\n \"id\": \"9576bb45-cec7-42db-b56f-dbd23011d00e\",\n \"email\": \"emp1@email.com\",\n \"customerName\": \"Danilo \",\n \"type\": 1,\n \"reference\": \"2022-01-10T12:43:02.929939\",\n \"footprint\": 6,\n \"serialNumber\": \"TEST_VERRA6BE32966CF11805A/B4E3DE\",\n \"fileUploadKey\": null,\n \"status\": 0,\n \"created\": \"2022-01-10T12:43:03.735228\",\n \"origin\": 4,\n \"notifyCustomer\": false,\n \"originSystemId\": null\n }\n ],\n \"pageIndex\": 1,\n \"totalPages\": 1,\n \"totalCount\": 9,\n \"hasPreviousPage\": false,\n \"hasNextPage\": false\n}"}],"_postman_id":"a87a1031-237d-49cc-8146-acd0d73b554f"},{"name":"Get certificate by id","id":"b535f962-7389-45c0-b394-de43e101fb67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{host_certificates}}/v1/certificates/:origin-system-id","urlObject":{"path":["v1","certificates",":origin-system-id"],"host":["{{host_certificates}}"],"query":[],"variable":[{"type":"any","value":"e78f1adb-df5a-4d8a-90ca-45aab6512c6d","key":"origin-system-id"}]}},"response":[{"id":"5d08ddef-f015-4922-933e-f0def0815f3b","name":"Get certificate by id","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_certificates}}/v1/certificates/:id","host":["{{host_certificates}}"],"path":["v1","certificates",":id"],"variable":[{"key":"id","value":"e78f1adb-df5a-4d8a-90ca-45aab6512c6d"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jan 2022 20:07:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"440"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"e78f1adb-df5a-4d8a-90ca-45aab6512c6d\",\n \"email\": \"emp1@email.com\",\n \"customerName\": \"Example\",\n \"type\": 0,\n \"reference\": \"2021-12-14T03:00:00\",\n \"footprint\": 0.0317843103073364,\n \"serialNumber\": \"TEST_CBX5F42E2759FA5BD36/B4E3DE\",\n \"fileUploadKey\": \"b5725f9266c3439dafaa696d2a035bba8629232ab7d74995a7d62850a0980edc\",\n \"status\": 2,\n \"created\": \"2022-01-07T23:29:08.495836\",\n \"origin\": 1,\n \"notifyCustomer\": true,\n \"originSystemId\": \"b6fc68b0-a2d1-4330-ba97-9a30237aadc3\"\n}"}],"_postman_id":"b535f962-7389-45c0-b394-de43e101fb67"},{"name":"Get by external id","id":"81055d45-667c-492e-932c-ecfb05e34e25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"{{host_certificates}}/v1/certificates/:origin-system-id","urlObject":{"path":["v1","certificates",":origin-system-id"],"host":["{{host_certificates}}"],"query":[{"disabled":true,"key":"force-refresh","value":"true"}],"variable":[{"type":"any","value":"b6fc68b0-a2d1-4330-ba97-9a30237aadc3","key":"origin-system-id"}]}},"response":[{"id":"d8caa17b-1c9e-477d-be56-3f81553fb012","name":"Get by external id","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host_certificates}}/v1/certificates/:origin-system-id?external=true","host":["{{host_certificates}}"],"path":["v1","certificates",":origin-system-id"],"query":[{"key":"external","value":"true"},{"key":"force-refresh","value":"true","disabled":true}],"variable":[{"key":"origin-system-id","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jan 2022 20:07:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Server","value":"Kestrel"},{"key":"Content-Length","value":"440"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"e78f1adb-df5a-4d8a-90ca-45aab6512c6d\",\n \"email\": \"emp1@email.com\",\n \"customerName\": \"Danilo \",\n \"type\": 0,\n \"reference\": \"2021-12-14T03:00:00\",\n \"footprint\": 0.0317843103073364,\n \"serialNumber\": \"TEST_CBX5F42E2759FA5BD36/B4E3DE\",\n \"fileUploadKey\": \"b5725f9266c3439dafaa696d2a035bba8629232ab7d74995a7d62850a0980edc\",\n \"status\": 2,\n \"created\": \"2022-01-07T23:29:08.495836\",\n \"origin\": 1,\n \"notifyCustomer\": true,\n \"originSystemId\": \"b6fc68b0-a2d1-4330-ba97-9a30237aadc3\"\n}"}],"_postman_id":"81055d45-667c-492e-932c-ecfb05e34e25"}],"id":"c3d5f162-c691-4f64-877a-85d7703ac05b","_postman_id":"c3d5f162-c691-4f64-877a-85d7703ac05b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}}},{"name":"Helpers","item":[{"name":"Allowed filters","id":"fadbc8a9-57e2-4ca7-98e4-bfc8673a70fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_host}}/v1/allowed-filters/:entity","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","allowed-filters",":entity"],"host":["{{api_host}}"],"query":[],"variable":[{"type":"any","value":"orders","key":"entity"}]}},"response":[{"id":"218b9d13-eebc-4d81-84ad-563b602a9a1b","name":"Orders filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v1/allowed-filters/:entity","host":["{{host}}"],"path":["v1","allowed-filters",":entity"],"variable":[{"key":"entity","value":"orders"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"openresty"},{"key":"Date","value":"Wed, 09 Feb 2022 18:34:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"343"},{"key":"Connection","value":"keep-alive"},{"key":"api-supported-versions","value":"1.0"},{"key":"Strict-Transport-Security","value":"max-age=63072000;includeSubDomains; preload"},{"key":"X-Served-By","value":"api-b2b-dev.carbonext.com.br"}],"cookie":[],"responseTime":null,"body":"{\n \"filters\": [\n \"status_eq\",\n \"status_ne\",\n \"status_in\",\n \"vcuUnitPrice_ge\",\n \"vcuUnitPrice_le\",\n \"vcuUnitPrice_gt\",\n \"vcuUnitPrice_lt\",\n \"vcuAmount_eq\",\n \"vcuAmount_ge\",\n \"vcuAmount_le\",\n \"vcuAmount_gt\",\n \"vcuAmount_lt\",\n \"createdAt_eq\",\n \"createdAt_ge\",\n \"createdAt_le\",\n \"createdAt_gt\",\n \"createdAt_lt\",\n \"totalPrice_eq\",\n \"totalPrice_ge\",\n \"totalPrice_le\",\n \"totalPrice_gt\",\n \"totalPrice_lt\",\n \"type_eq\",\n \"type_ne\",\n \"type_in\",\n \"retireForRecipient_eq\",\n \"thirdPartyTaxId_eq\",\n \"invoiceId_eq\",\n \"subscriptionId_eq\"\n ],\n \"sort\": [\n \"createdAt\",\n \"vcuAmount\",\n \"status\",\n \"vcuUnitPrice\"\n ],\n \"aggregate\": {\n \"columns\": [\n \"vcuAmount\",\n \"vcuUnitPrice\",\n \"totalPrice\"\n ],\n \"operations\": [\n \"sum\",\n \"avg\",\n \"min\",\n \"max\",\n \"count\"\n ]\n }\n}"},{"id":"1caf5625-ead3-4b0b-812d-69931a72795b","name":"Invoices filters","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{host}}/v1/allowed-filters/:entity","host":["{{host}}"],"path":["v1","allowed-filters",":entity"],"variable":[{"key":"entity","value":"invoices"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"openresty"},{"key":"Date","value":"Wed, 09 Feb 2022 18:52:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"381"},{"key":"Connection","value":"keep-alive"},{"key":"api-supported-versions","value":"1.0"},{"key":"Strict-Transport-Security","value":"max-age=63072000;includeSubDomains; preload"},{"key":"X-Served-By","value":"api-b2b-dev.carbonext.com.br"}],"cookie":[],"responseTime":null,"body":"{\n \"filters\": [\n \"status_eq\",\n \"status_ne\",\n \"status_in\",\n \"totalPrice_eq\",\n \"totalPrice_ge\",\n \"totalPrice_le\",\n \"totalPrice_gt\",\n \"totalPrice_lt\",\n \"totalVcuAmount_eq\",\n \"totalVcuAmount_ge\",\n \"totalVcuAmount_le\",\n \"totalVcuAmount_gt\",\n \"totalVcuAmount_lt\",\n \"createdAt_eq\",\n \"createdAt_ge\",\n \"createdAt_le\",\n \"createdAt_gt\",\n \"createdAt_lt\"\n ],\n \"sort\": [\n \"createdAt\",\n \"paid\",\n \"dueDate\",\n \"totalPrice\",\n \"totalVcuAmount\",\n \"status\"\n ]\n}"}],"_postman_id":"fadbc8a9-57e2-4ca7-98e4-bfc8673a70fb"},{"name":"Resources","id":"1e974253-3089-4d4b-aa34-6ac44ac40458","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_host}}/v1/resources","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}},"urlObject":{"path":["v1","resources"],"host":["{{api_host}}"],"query":[],"variable":[]}},"response":[{"id":"4b7f20d5-01e0-4714-957f-2defca146fb9","name":"Resources","originalRequest":{"method":"GET","header":[],"url":"{{host}}/v1/resources"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Length","value":"68"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Fri, 21 Jan 2022 18:50:18 GMT"},{"key":"Server","value":"Kestrel"},{"key":"api-supported-versions","value":"1.0"}],"cookie":[],"responseTime":null,"body":"{\n \"entities\": [\n \"applications\",\n \"invoices\",\n \"orders\",\n \"subscriptions\",\n \"retirements\",\n \"users\"\n ]\n}"}],"_postman_id":"1e974253-3089-4d4b-aa34-6ac44ac40458"}],"id":"a789153b-d4c4-4f75-8caf-731412c0e064","_postman_id":"a789153b-d4c4-4f75-8caf-731412c0e064","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","id":"34c811b3-1a03-40ec-b230-9b79b9c1bd68","name":"B2B - Public","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"66635839-8be1-451e-9b86-0d2f2a9b4977","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a817072e-5246-48b4-b4fa-04365c68b044","type":"text/javascript","exec":[""]}}]}