openapi: 3.0.3
info:
title: 'API Reference'
description: "Welcome to the Rejoose API Documentation\r\n\r\n
Our APIs help you integrate sustainability data seamlessly into your workflows. This documentation covers multiple APIs, each serving a specific purpose. Please review the section relevant to your needs:
\r\n\r\n
\r\n
e.voice – Carbon data for invoices or similar transactions.
\r\n
e.voice Circularity – Refurbished product carbon data for ITADs and circular IT.
\r\n
e.product & e.product+ – Carbon data for single or bulk products. Standard provides total CO₂e; e.product+ includes full life cycle (LCA) data.
\r\n
Group Data Extraction (e.hub Enterprise) – Advanced data extraction and aggregation for enterprise accounts.
\r\n
\r\n\r\n
How Our APIs Work
\r\n\r\n
\r\n
All Rejoose APIs follow REST principles, using standard REST-oriented URLs and HTTP verbs.
\r\n
Requests are form-encoded, and responses are JSON-encoded.
\r\n
Authentication is handled via API tokens, which you can generate in e.hub. Contact support@rejoose.com for access.
\r\n
Our APIs evolve over time. We aim to minimize changes, but when updates occur, we'll notify you in advance.
\r\n
\r\n\r\n
Getting Started
\r\n\r\n
Once your contract is signed, we'll begin a thorough onboarding process.
\r\n\r\n
If you need support before the contract is finalized, please reach out - we'll do our best to assist. Pre-contract support may incur a cost, depending on scope and hours required (we'll inform you beforehand).
\r\n\r\n
Tips for Using the Docs
\r\n\r\n
\r\n
Expand objects marked with ⯈ (e.g., ⯈ client, ⯈ devices) to view additional fields.
\r\n
Use the sandbox mode for safe testing before going live.
\r\n
Do not use the production environment for testing!
The e.voice API enables the generation of an environmental invoice (e.voice), serving as the carbon counterpart to a financial invoice. It bridges financial transactions with their associated carbon impact, allowing businesses to track and report emissions seamlessly.
\n
When using the e.voice API, you have flexible implementation options:
\n
\n
The solution can be fully anonymized, using only unique identifiers known to you, or it can include customer names.
\n
Rejoose does not receive a copy of the financial invoice. Instead, only specific extracted data points are transmitted—just enough to determine the carbon footprint and link the e.voice with its corresponding financial transaction.
\n
\n
Upon a successful transaction, the API provides:
\n
\n
Transaction details confirming all is good or other relevant error responses (see example response).
\n
Carbon data for the total transaction and individual products (raw data format). (optional)
\n
A base64-encoded PDF file (the e.voice document). (optional)
\n
\n\n\nKeep in mind that you do not need to save the above data in your ERP system (or similar), as everything is archived for you in the\ne.hub and for your customers via e.insights.\n\n\n
e.voice API – Options Explained
\n
\n
\n deferred: Specifies whether the e.voice generation should run as a background (deferred) job.\n \n This is useful for large batches or when you want to avoid delays in your primary workflow. Setting deferred to true allows the generation process to run asynchronously, reducing impact on real-time operations.\n
\n
\n include_pdf: Specifies whether the API response should include a base64-encoded PDF file of the e.voice document.\n Great for scenarios where you only need raw carbon data and want to reduce payload size. Set include_pdf to false if you’re storing PDFs separately or handling document generation downstream.\n
\n
\n credit_note: Specifies whether the e.voice is a credit note, which reverses the carbon data recorded for a transaction. (amounts will be handled as absolute numbers)\n Ideal for returns, corrections, or adjustments where you need to negate previously recorded carbon impacts. Setting credit_note to true ensures your carbon accounting stays accurate and reflects true net impacts.\n
\n
\n\n
Quick tips
\n
\n
Use deferred: true for better system performance and faster responses (a sustainable choice).
\n
Set include_pdf: false if you only want to minimize response size and rely on retrieving data from e.hub and e.insights
\n
Mark transactions as credit_note: true to define this is an credit note and return of products, and this will be visible in the carbon reporting.
\n
\n
You can access more detailed information in the API documentation by expanding objects marked with a small black arrow (⯈), such as ⯈ client or ⯈ devices. Simply click the arrow to reveal additional data fields.
"
-
name: 'e.voice - circularity'
description: "Provides carbon footprint and avoided emissions data for IT products in the ITAD industry. This API is used when receiving used IT products for refurbishment or selling refurbished products for reuse.\n\n
The response includes:
\n
\n
Avoided emissions from refurbishing the products (kg CO2e).
\n
Carbon impact of the refurbishment process itself (kg CO2e).
\n
\n\nBoth datasets are used for customer reporting and internal documentation."
-
name: e.product
description: "
The e.product API provides carbon footprint data for individual products, making it ideal for use in e-commerce, quotations, and other during-sales scenarios where a general carbon assessment is needed. For more detailed, transaction-specific reporting at the customer level, you should be using the e.voice API, which complements e.product by focusing on post-sales impact and needed documentation.
\n
How Product Identification Works
\n
In this solution, one product is defined as a country-specific dataset based on a combination of:
\n
\n
Manufacturer Part Number (MPN): The unique manufacturer part number (SKU/MPN) provided by the vendor or distributor, or an internal part number.
\n
Brand: The product manufacturer's name. Used together with the MPN and category to ensure a unique data match.
\n
Category: Used alongside the external ID and brand to ensure accurate product matching. Also enables the system to provide carbon data for the category when specific LCA data is unavailable.
\n
\n
This ensures that the footprint reflects region-specific factors such as electricity mix and product lifecycle variations.
\n\n
API Response
\n
When querying the e.product endpoint, the API returns the following carbon footprint data:
\n
\n
Total carbon footprint (LCA) – The full lifecycle emissions of a new product, e.g., 33.3 kg CO₂e.
\n
Refurbishment impact (LCA) – The emissions from refurbishing the product instead of manufacturing a new one, e.g., 3.5 kg CO₂e
\n
Avoided emissions by choosing refurbished – The emissions savings when selecting a refurbished product over a new one, e.g., 28.0 kg CO₂e.
\n
\n\n
Please look through the API docs for more details or contact support@rejoose.com for assistance.
\n\n"
-
name: Groups
description: "
Enterprise Grouping in e.hub
\n
The e.hub Enterprise Functionality is an advanced feature exclusively available to Enterprise Subscription customers. It is designed for companies operating with multiple ERP systems that do not share common company or organization identifiers. This is particularly useful for businesses using different ERP systems across regions, such as SAP in the EU and Business Central in the US, where customer naming conventions and identifiers are not aligned.
\n
Seamless Data Consolidation Across Multiple ERP Systems
\n
With this feature, you can link and unify organization data from multiple disconnected ERP systems into a single Group Structure, ensuring a consistent, company-wide carbon reporting framework.
\n\n
Three-Tiered Reporting Structure
\n
The grouping model enables full organizational alignment across various business units:
\n
\n
Group: The top-level entity, representing the entire enterprise. (unique to Enterprise Grouping)
\n
Organization: Major business divisions or regions, each containing multiple companies. (standard e.voice function).
\n
Companies: TIndividual subsidiaries or business units. (standard e.voice function)
\n
\n
Each Group can contain multiple Organizations, and each Organization can include hundreds of subsidiaries, ensuring scalability for even the largest enterprises.
\n
Data Extraction & Integration
\n
A dedicated data extraction endpoint allows you to:
\n
\n
Retrieve grouped and structured data for data warehouse integration.
\n
Extract e.voice records and filter reports by Group, Organization, or Company.
\n
Seamlessly integrate consolidated data into your internal analytics or reporting systems.
\n
\n\n"
components:
securitySchemes:
default:
type: http
scheme: bearer
description: "You can retrieve your API token by logging into Rejoose e/hub® https://e-hub.rejoose.com \r\nand visiting your admin dashboard and clicking \"Create API Key\"."
security:
-
default: []
paths:
/api/v3/evoices/generate:
post:
summary: 'Generate e.voice'
operationId: generateEvoice
description: ''
parameters: []
responses:
200:
description: 'When using deferred'
content:
application/json:
schema:
type: object
example:
success: true
data:
external_invoice_id: 94825344-eb3a-4b5d-8ac8-6e462f37bba2
properties:
success:
type: boolean
example: true
data:
type: object
properties:
external_invoice_id:
type: string
example: 94825344-eb3a-4b5d-8ac8-6e462f37bba2
201:
description: ''
content:
application/json:
schema:
oneOf:
-
description: ''
type: object
example:
success: true
data:
external_invoice_id: '123456789'
external_invoice_date: '2023-09-25'
country_code: DK
supplier_contact: example@rejoose.com
pdf_base64: JVBERi0xLjcKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZwovT3V0bGluZXMgMiAwIFIKL1BhZ2VzIDMgMCBSID4+CmVuZG9iagoyIDAgb2JqCjw8IC9UeXBlIC9PdXRsaW5lcyAvQ291bnQgMCA+PgplbmRvYmoKMyAwIG9iago8PCAvVHlwZSAvUGFnZXMKL0tpZHMgWzYgMCBSCl0KL0NvdW50IDEKL1Jlc291cmNlcyA8PAovUHJvY1NldCA0IDAgUgovRm9udCA8PCAKL0YxIDggMCBSCi9GMiA5IDAgUgovRjMgMTAgMCBSCj4+Cj4+Ci9NZWRpYUJveCBbMC4wMDAgMC4wMDAgNTk1LjI4MCA4NDEuODkwXQogPj4KZW5kb2JqCjQgMCBvYmoKWy9QREYgL1RleHQgXQplbmRvYmoKNSAwIG9iago8PAovUHJvZHVjZXIgKP7/AGQAbwBtAHAAZABmACAAMgAuADAALgAzACAAKwAgAEMAUABEAEYpCi9DcmVhdGlvbkRhdGUgKEQ6MjAyNDAxMDUxMzIzMTArMDAnMDAnKQovTW9kRGF0ZSAoRDoyMDI0MDEwNTEzMjMxMCswMCcwMCcpCi9UaXRsZSAo/v8ARQB2AG8AaQBjAGUpCj4+CmVuZG9iago2IDAgb2JqCjw8IC9UeXBlIC9QYWdlCi9NZWRpYUJveCBbMC4wMDAgMC4wMDAgNTk1LjI4MCA4NDEuODkwXQovUGFyZW50IDMgMCBSCi9Bbm5vdHMgWyAxMSAwIFIgXQovQ29udGVudHMgNyAwIFIKPj4KZW5kb2JqCjcgMCBvYmoKPDwgL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAyODM3ID4+CnN0cmVhbQp4nK2b23LcNhKG7/UUqORmt0qiiQNxyNXGsezaHCqxpdhV6/LFaIaSGM2Q8gxlRy+VZ9wGB2iCHhIYU/aFytVmA/g/NNANCD75eMJ0xoUkSuRZLgTZEG/gpjOsSSFlZrgYszin0EKzorNgu97wjtQn8LnSJM9YYeCnEIq8eXUCH5DPJCc/k/eEfIC/rMJBKWMHFfZoLWtycfJ6pLntzcnzS+xbs0wpQS5X5NlLRrjt6PKakPf/elP+1TS7kvx4f/HvD+TyZ3J+af0KCi0yRZQUmZTcO4JVOcerRzJwYAV0m0ccXE+hE4wz01JEhnf+7FNTLQdOhVRZbqAnY7JCMeyJZblz+gc/x0mVhejg46TKgrvZ8EDHLOLAIt00YzPeMGNSZVFkbDCp3oKTmuck/DmcVJZnhso9AE4UQru8rXbEkSPLpm4XVU3a25K0TbtYk/tts3pYtmS52F41NSk31W5XNfUuhOy7sFTzkS6gwW15XW7Lemmb7Vq/rupFvaygh3a7qHeLZQutZsFccFNAUHEipQY4hlBFQQAlBUykKaDBDiLtlIY/ASKE0QFF35xiCkLOAEZR5BnnCi0W45QnNxq+026po4UWGYRy57kfsFLQA5UZg2YgQjQVhMKwqPHjnVp63Chwss4m4/CFYygz7Ri+WLTlD4jn9fHCgV1WaBUIx00hIdx6GskC4WgJhI952h4KUNh7omWADKfAIaPwrxqYHDAbjWxR0Ex33gEzGjC7KO/bcnNVbgnsN4TB9M8BiJEDgzPwWRA5zpKMHCcviJycw/fyy8jJYQuBBTQvcnKYzdwcRs5/6/3ahiX4tABC/RhACf19uHj9aAn0RwMIPdEyIIcz4cjNDKAQXRhAkl8vlTbLM2kWV2eiWOkzky/ZmaDi6roslGHs6kkhBcOmnIYh5SzJkHKC+5CSBvZHmKZhSEkDyRLanRVS0lia+WFI/fSwa5tNuX1aPKF4jKeE+D56vHhvCcVH4wk9vWWIzU+DxzYvngbcwng6XzZnL7dVWa/Wj+SiWT/YpLcjv7arp0SRHSwHCH0UeUsqirzMIIo0hAPVX0YRWI3UM6NIC/iCjkRR81C320coOlZPS209ACyNEgD6uPEA0BIAiEVS74mWATqcCoduZiSF7MJIevHLkyIGBlUYHkaMs8QixldjmonQ01mSseZABLHmKrsvYk2ajBozM9YUzHvORmJtX75WdVvWu6p9fFq8IT6MtwQ+9ER86JnAF8blHh9aAnzRSEVPtAzA9xO5Bz8zUkPyYaRSiJqbZ3fvbgPiySOohFMd5VjMBMc1f1Jpm34KE0cfyaAxmR+eS47YjoNWYBCswE29b+XtoiXf/0DOf/r9JWgVcOIc84ayhYsRbwqjPa8/VduGvFs8klPbDmd0pInCiEzwkSZebcuyflut1+UpeVHWm8X2buBu7MAFKXSRSc29f8CUhCTHpwUWp21jel4uHu7v11VYEkzOipEQrWJ6WiZuGdBvaiLKvxeb+3X5n+3eP1s2m/Bs7yQUWmaiWw69RXUWOLnD4ZLC0hqzyAMLd5a+HW+ZPN7zg8M9+gq/SLH9vSVxZeP9Yfnl/iZlMDGX3TH+1bs/khMj7AYApfV0WxSWOD0tyN0N+en3wTWLgF2A6e66hQWu/YUOG36u9honeyo/xmOSmSw3kghNATmDvUrD0KEF6B4UwJ51ffy27taXMLZNu6tTGJ6BndBbpnZYcFSMdp+5iHIG2HEV3Vcfh6PYw4aBa8PgUzh6aDFyantBvo8jwFEGDLQyAwZjo7Z+TJhAL4NZkzB7Kb3WU0Ku6gWj5QjFVMMxXRTTkv9wV01Vfd0kZt8P2EkvQBFPK2eQ/7TSgXLOYE+kKj3TNq4hvoKp9pYjlDPYGHiup5W/fljULVQlcdU4WKdawr8Dz5RqzkSmpQpVw2YGu2hSte2QCRaoRssRqrkQUNDZ5ZFneqwmu1g29yXh4cbABWwB3LYvMtZfZkCnzud9t/UwUn78kIDlNX4lLEiSWrIAlr12lnk6RGyHjKsQlrccAUvkUP3KIgVrsIsKqClyJr8BLNTYr6dCsyQsIWB8RRhZBcgwPL1z2g4ZDyMLLcfAkiCYimlYv1bXZVtthr8+gMXPeYzWpqnb210CFSr8uriybrABhqjcASCFynoWMtx00RKgih0AAk9vOQJyYdOi4tOQu8Ji+FsdOAJ0W+JXxaNiBeBVSsJPzYswu0uaSSX67A5mriP7u0vkMDW5VmEid5ZUIndz2idymF3jDmcf06OKnZO4PSBaZ2gZRnJ41ciey99+vOTnfwbnpHE4Pvm5cfjkF8A5vvTxGRGRhUkmigzzHzLzliG01Gij0KjcD2aKGs1TtFCP69+v1zm0MJP2tIIsE6PV501PCy0DWsnRRmnZ+h2cJmlB1XfKk8C8pG8BzGdTBBZmmigwzJ0IzFuGwFKjjd5dwKKk0kSAKX0qUsBQUh/hXfKcAwwzKgIL800MWJ8/PTC0DIAlRxsFZuR+MFPAFEvRQj3fILwwqfa0fFJN0OpTqKeFloBWNKn2nt4y4JzUGeNcCMjYsWxRMHWqUqgx+wUJqzsgzmGNp0ZkHR7CYqz7M6InhpYBsfRwY8hohwy8FcuUkSM1YVk3n5qwXkEXaQ8qI5Qvb6v67m1l3zuQcybOQGxQt1BYp3kmC8udwTnHnfVAk7RFOTRqV7JrVGMR9GbOzbOvbAANMyasbJwlVdk4pn1lI+xFnvyisrG3OFrOrGyE7kZ0+Fv4384uDNXP//fLi/Pz57PU+yoF5Yd5MiofaxLU7y1DAD6WHYF5VcoUgUGV8vXVRq86SHYx1X1t4VWjZaAaKTrV86qNKdVKsFM5S7ivGlB4mLSiwrFGQOHeMhTuQc4RLvj+6dekcE5P2RzdmPxRd5hEYrr7VO91o2WgGzn2YT4j+U/qnhXmmMR71T6JJ1T3KdurRkugOprEe09vGfBC/nPiBJP45AJR/FTPQYa5GJGFp6wYsj7zeuFoGQjH9BJkhBm5uOBgHXnMdrHY7B7qm9FkLERm9AitV4v14u9HcsE4+XPdbhfJY7LLabbGp6rPafhbzRm/IbCPcikN06+zRNJv5wiDge0wdHSWVN52/Pu8DX5cqi/y9qTG6O/MXd6G7YyxkUc+3f3O7ugiMxhDFylzOGNgI+gwMcdAoyeSRs8E6XAB7FGjZcA6LdTCTt3ZOGdfX8wKRl8NIaQwj0ej0XsiJPRMhWNQNbl49JZhQKZ0HlVHTUUkO/62x/XvN+w5nLH+6jkHZUOMM3r2nL1ngnNYp+05o2XAOanzqMptirMx9NQcfU/0LVD7ig9Rh5VKFLX3RNTomUIdVIYOtbcMUad0HnXDNIWa52ZQJMdvmPpV1ZVtc1BjkYmowyInhho9ETV6JlCHxegeNVoGqJM6IzssjuUbhCOWpD0jX5ImGKFnz8h7JhiFpeueEVoCRtFitvf0lgHdJKF4MWsfH0X2DPc0ZBDK4035moiq7hnbwTOeN+X1w/aq2t2WK7IqP1XLckcWMDz7rglMn6v2lixq8l3yKobaJ4R2n5vsKfkkhhY2yUcG+1367RQ1sN1C0Qy1sza6vxAy/mniulrekdty2/3fmMUS9O6IfwO1KdvbZtWsm5tH8vm2aktyv7gvt1mk1y6oxeDPQc3jh6S6t8/2SabMqGDesA+1qeJeZ4wW9kZLIxD7H8AOX2+RM2iYwse5hL++rOpdWe8+lX8RGPEZYbZNMG/LVbmt7nZX5fYmG3vAZl8JFXbNsowrOdIlfYbv5f4P4se8CQplbmRzdHJlYW0KZW5kb2JqCjggMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GMQovQmFzZUZvbnQgL1RpbWVzLVJvbWFuCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCj4+CmVuZG9iago5IDAgb2JqCjw8IC9UeXBlIC9Gb250Ci9TdWJ0eXBlIC9UeXBlMQovTmFtZSAvRjIKL0Jhc2VGb250IC9IZWx2ZXRpY2EtQm9sZAovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZwo+PgplbmRvYmoKMTAgMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GMwovQmFzZUZvbnQgL1RpbWVzLUJvbGQKL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcKPj4KZW5kb2JqCjExIDAgb2JqCjw8IC9UeXBlIC9Bbm5vdAovU3VidHlwZSAvTGluawovQSAxMiAwIFIKL0JvcmRlciBbMCAwIDBdCi9IIC9JCi9SZWN0IFsgMTk5LjEzNzggMTguMjE4NSAzOTYuMTQyMiAyNy4wMTg1IF0KPj4KZW5kb2JqCjEyIDAgb2JqCjw8IC9UeXBlIC9BY3Rpb24KL1MgL1VSSQovVVJJIChodHRwczovL3Jlam9vc2UuY29tL3dwLWNvbnRlbnQvdXBsb2Fkcy8yMDIzLzA2L0V2b2ljZV9FeHBsYWluZXIucGRmKQo+PgplbmRvYmoKeHJlZgowIDEzCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAwOSAwMDAwMCBuIAowMDAwMDAwMDc0IDAwMDAwIG4gCjAwMDAwMDAxMjAgMDAwMDAgbiAKMDAwMDAwMDI5NSAwMDAwMCBuIAowMDAwMDAwMzI0IDAwMDAwIG4gCjAwMDAwMDA0OTcgMDAwMDAgbiAKMDAwMDAwMDYxOSAwMDAwMCBuIAowMDAwMDAzNTI5IDAwMDAwIG4gCjAwMDAwMDM2MzggMDAwMDAgbiAKMDAwMDAwMzc1MCAwMDAwMCBuIAowMDAwMDAzODU5IDAwMDAwIG4gCjAwMDAwMDM5ODUgMDAwMDAgbiAKdHJhaWxlcgo8PAovU2l6ZSAxMwovUm9vdCAxIDAgUgovSW5mbyA1IDAgUgovSURbPGQ0MjEyYTIwY2E1NTc3NTg1NGNiOWUyNmM3NGRiYjdiPjxkNDIxMmEyMGNhNTU3NzU4NTRjYjllMjZjNzRkYmI3Yj5dCj4+CnN0YXJ0eHJlZgo0MTA0CiUlRU9GCg==
carbon_intensity_gram: 123
total_kg_co2_eq: 1301.51
status: finalized
type: evoice
created_at: '2024-01-05T13:11:49.000000Z'
client:
name: 'Eco-Friendly Solutions Ltd'
vat_number: ECOF1234567
organization_id: EcoFriendly-4987
address: '100 Enviro Way'
address2: 'Sustainability Lane 3'
zip_code: ECO321
city: GreenVille
country: Denmark
country_code: DK
devices:
-
external_id: RE8989121
original_manufacturer_part_number: 62B6MAT3EU
quantity: 10
brand: Lenovo
model_name: 'ThinkPad T480'
category: Notebook
lifetime_months: 72
scope_2_kg_co2_eq: 278.41
scope_3_kg_co2_eq: 249.27
total_kg_co2_eq: 527.68
refurbished: true
avoided_emissions_kg_co2_eq: 256.68
-
external_id: SM-S918BZKDEEB
original_manufacturer_part_number: null
quantity: 10
brand: Samsung
model_name: 'Galaxy S23 Ultra'
category: Smartphone
lifetime_months: 30
scope_2_kg_co2_eq: 31.18
scope_3_kg_co2_eq: 742.65
total_kg_co2_eq: 773.83
refurbished: false
avoided_emissions_kg_co2_eq: 0
links:
self: 'https://app.rejoose.com/api/v3/evoices/123456789'
properties:
success:
type: boolean
example: true
data:
type: object
properties:
external_invoice_id:
type: string
example: '123456789'
external_invoice_date:
type: string
example: '2023-09-25'
country_code:
type: string
example: DK
supplier_contact:
type: string
example: example@rejoose.com
pdf_base64:
type: string
example: JVBERi0xLjcKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZwovT3V0bGluZXMgMiAwIFIKL1BhZ2VzIDMgMCBSID4+CmVuZG9iagoyIDAgb2JqCjw8IC9UeXBlIC9PdXRsaW5lcyAvQ291bnQgMCA+PgplbmRvYmoKMyAwIG9iago8PCAvVHlwZSAvUGFnZXMKL0tpZHMgWzYgMCBSCl0KL0NvdW50IDEKL1Jlc291cmNlcyA8PAovUHJvY1NldCA0IDAgUgovRm9udCA8PCAKL0YxIDggMCBSCi9GMiA5IDAgUgovRjMgMTAgMCBSCj4+Cj4+Ci9NZWRpYUJveCBbMC4wMDAgMC4wMDAgNTk1LjI4MCA4NDEuODkwXQogPj4KZW5kb2JqCjQgMCBvYmoKWy9QREYgL1RleHQgXQplbmRvYmoKNSAwIG9iago8PAovUHJvZHVjZXIgKP7/AGQAbwBtAHAAZABmACAAMgAuADAALgAzACAAKwAgAEMAUABEAEYpCi9DcmVhdGlvbkRhdGUgKEQ6MjAyNDAxMDUxMzIzMTArMDAnMDAnKQovTW9kRGF0ZSAoRDoyMDI0MDEwNTEzMjMxMCswMCcwMCcpCi9UaXRsZSAo/v8ARQB2AG8AaQBjAGUpCj4+CmVuZG9iago2IDAgb2JqCjw8IC9UeXBlIC9QYWdlCi9NZWRpYUJveCBbMC4wMDAgMC4wMDAgNTk1LjI4MCA4NDEuODkwXQovUGFyZW50IDMgMCBSCi9Bbm5vdHMgWyAxMSAwIFIgXQovQ29udGVudHMgNyAwIFIKPj4KZW5kb2JqCjcgMCBvYmoKPDwgL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAyODM3ID4+CnN0cmVhbQp4nK2b23LcNhKG7/UUqORmt0qiiQNxyNXGsezaHCqxpdhV6/LFaIaSGM2Q8gxlRy+VZ9wGB2iCHhIYU/aFytVmA/g/NNANCD75eMJ0xoUkSuRZLgTZEG/gpjOsSSFlZrgYszin0EKzorNgu97wjtQn8LnSJM9YYeCnEIq8eXUCH5DPJCc/k/eEfIC/rMJBKWMHFfZoLWtycfJ6pLntzcnzS+xbs0wpQS5X5NlLRrjt6PKakPf/elP+1TS7kvx4f/HvD+TyZ3J+af0KCi0yRZQUmZTcO4JVOcerRzJwYAV0m0ccXE+hE4wz01JEhnf+7FNTLQdOhVRZbqAnY7JCMeyJZblz+gc/x0mVhejg46TKgrvZ8EDHLOLAIt00YzPeMGNSZVFkbDCp3oKTmuck/DmcVJZnhso9AE4UQru8rXbEkSPLpm4XVU3a25K0TbtYk/tts3pYtmS52F41NSk31W5XNfUuhOy7sFTzkS6gwW15XW7Lemmb7Vq/rupFvaygh3a7qHeLZQutZsFccFNAUHEipQY4hlBFQQAlBUykKaDBDiLtlIY/ASKE0QFF35xiCkLOAEZR5BnnCi0W45QnNxq+026po4UWGYRy57kfsFLQA5UZg2YgQjQVhMKwqPHjnVp63Chwss4m4/CFYygz7Ri+WLTlD4jn9fHCgV1WaBUIx00hIdx6GskC4WgJhI952h4KUNh7omWADKfAIaPwrxqYHDAbjWxR0Ex33gEzGjC7KO/bcnNVbgnsN4TB9M8BiJEDgzPwWRA5zpKMHCcviJycw/fyy8jJYQuBBTQvcnKYzdwcRs5/6/3ahiX4tABC/RhACf19uHj9aAn0RwMIPdEyIIcz4cjNDKAQXRhAkl8vlTbLM2kWV2eiWOkzky/ZmaDi6roslGHs6kkhBcOmnIYh5SzJkHKC+5CSBvZHmKZhSEkDyRLanRVS0lia+WFI/fSwa5tNuX1aPKF4jKeE+D56vHhvCcVH4wk9vWWIzU+DxzYvngbcwng6XzZnL7dVWa/Wj+SiWT/YpLcjv7arp0SRHSwHCH0UeUsqirzMIIo0hAPVX0YRWI3UM6NIC/iCjkRR81C320coOlZPS209ACyNEgD6uPEA0BIAiEVS74mWATqcCoduZiSF7MJIevHLkyIGBlUYHkaMs8QixldjmonQ01mSseZABLHmKrsvYk2ajBozM9YUzHvORmJtX75WdVvWu6p9fFq8IT6MtwQ+9ER86JnAF8blHh9aAnzRSEVPtAzA9xO5Bz8zUkPyYaRSiJqbZ3fvbgPiySOohFMd5VjMBMc1f1Jpm34KE0cfyaAxmR+eS47YjoNWYBCswE29b+XtoiXf/0DOf/r9JWgVcOIc84ayhYsRbwqjPa8/VduGvFs8klPbDmd0pInCiEzwkSZebcuyflut1+UpeVHWm8X2buBu7MAFKXSRSc29f8CUhCTHpwUWp21jel4uHu7v11VYEkzOipEQrWJ6WiZuGdBvaiLKvxeb+3X5n+3eP1s2m/Bs7yQUWmaiWw69RXUWOLnD4ZLC0hqzyAMLd5a+HW+ZPN7zg8M9+gq/SLH9vSVxZeP9Yfnl/iZlMDGX3TH+1bs/khMj7AYApfV0WxSWOD0tyN0N+en3wTWLgF2A6e66hQWu/YUOG36u9honeyo/xmOSmSw3kghNATmDvUrD0KEF6B4UwJ51ffy27taXMLZNu6tTGJ6BndBbpnZYcFSMdp+5iHIG2HEV3Vcfh6PYw4aBa8PgUzh6aDFyantBvo8jwFEGDLQyAwZjo7Z+TJhAL4NZkzB7Kb3WU0Ku6gWj5QjFVMMxXRTTkv9wV01Vfd0kZt8P2EkvQBFPK2eQ/7TSgXLOYE+kKj3TNq4hvoKp9pYjlDPYGHiup5W/fljULVQlcdU4WKdawr8Dz5RqzkSmpQpVw2YGu2hSte2QCRaoRssRqrkQUNDZ5ZFneqwmu1g29yXh4cbABWwB3LYvMtZfZkCnzud9t/UwUn78kIDlNX4lLEiSWrIAlr12lnk6RGyHjKsQlrccAUvkUP3KIgVrsIsKqClyJr8BLNTYr6dCsyQsIWB8RRhZBcgwPL1z2g4ZDyMLLcfAkiCYimlYv1bXZVtthr8+gMXPeYzWpqnb210CFSr8uriybrABhqjcASCFynoWMtx00RKgih0AAk9vOQJyYdOi4tOQu8Ji+FsdOAJ0W+JXxaNiBeBVSsJPzYswu0uaSSX67A5mriP7u0vkMDW5VmEid5ZUIndz2idymF3jDmcf06OKnZO4PSBaZ2gZRnJ41ciey99+vOTnfwbnpHE4Pvm5cfjkF8A5vvTxGRGRhUkmigzzHzLzliG01Gij0KjcD2aKGs1TtFCP69+v1zm0MJP2tIIsE6PV501PCy0DWsnRRmnZ+h2cJmlB1XfKk8C8pG8BzGdTBBZmmigwzJ0IzFuGwFKjjd5dwKKk0kSAKX0qUsBQUh/hXfKcAwwzKgIL800MWJ8/PTC0DIAlRxsFZuR+MFPAFEvRQj3fILwwqfa0fFJN0OpTqKeFloBWNKn2nt4y4JzUGeNcCMjYsWxRMHWqUqgx+wUJqzsgzmGNp0ZkHR7CYqz7M6InhpYBsfRwY8hohwy8FcuUkSM1YVk3n5qwXkEXaQ8qI5Qvb6v67m1l3zuQcybOQGxQt1BYp3kmC8udwTnHnfVAk7RFOTRqV7JrVGMR9GbOzbOvbAANMyasbJwlVdk4pn1lI+xFnvyisrG3OFrOrGyE7kZ0+Fv4384uDNXP//fLi/Pz57PU+yoF5Yd5MiofaxLU7y1DAD6WHYF5VcoUgUGV8vXVRq86SHYx1X1t4VWjZaAaKTrV86qNKdVKsFM5S7ivGlB4mLSiwrFGQOHeMhTuQc4RLvj+6dekcE5P2RzdmPxRd5hEYrr7VO91o2WgGzn2YT4j+U/qnhXmmMR71T6JJ1T3KdurRkugOprEe09vGfBC/nPiBJP45AJR/FTPQYa5GJGFp6wYsj7zeuFoGQjH9BJkhBm5uOBgHXnMdrHY7B7qm9FkLERm9AitV4v14u9HcsE4+XPdbhfJY7LLabbGp6rPafhbzRm/IbCPcikN06+zRNJv5wiDge0wdHSWVN52/Pu8DX5cqi/y9qTG6O/MXd6G7YyxkUc+3f3O7ugiMxhDFylzOGNgI+gwMcdAoyeSRs8E6XAB7FGjZcA6LdTCTt3ZOGdfX8wKRl8NIaQwj0ej0XsiJPRMhWNQNbl49JZhQKZ0HlVHTUUkO/62x/XvN+w5nLH+6jkHZUOMM3r2nL1ngnNYp+05o2XAOanzqMptirMx9NQcfU/0LVD7ig9Rh5VKFLX3RNTomUIdVIYOtbcMUad0HnXDNIWa52ZQJMdvmPpV1ZVtc1BjkYmowyInhho9ETV6JlCHxegeNVoGqJM6IzssjuUbhCOWpD0jX5ImGKFnz8h7JhiFpeueEVoCRtFitvf0lgHdJKF4MWsfH0X2DPc0ZBDK4035moiq7hnbwTOeN+X1w/aq2t2WK7IqP1XLckcWMDz7rglMn6v2lixq8l3yKobaJ4R2n5vsKfkkhhY2yUcG+1367RQ1sN1C0Qy1sza6vxAy/mniulrekdty2/3fmMUS9O6IfwO1KdvbZtWsm5tH8vm2aktyv7gvt1mk1y6oxeDPQc3jh6S6t8/2SabMqGDesA+1qeJeZ4wW9kZLIxD7H8AOX2+RM2iYwse5hL++rOpdWe8+lX8RGPEZYbZNMG/LVbmt7nZX5fYmG3vAZl8JFXbNsowrOdIlfYbv5f4P4se8CQplbmRzdHJlYW0KZW5kb2JqCjggMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GMQovQmFzZUZvbnQgL1RpbWVzLVJvbWFuCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCj4+CmVuZG9iago5IDAgb2JqCjw8IC9UeXBlIC9Gb250Ci9TdWJ0eXBlIC9UeXBlMQovTmFtZSAvRjIKL0Jhc2VGb250IC9IZWx2ZXRpY2EtQm9sZAovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZwo+PgplbmRvYmoKMTAgMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GMwovQmFzZUZvbnQgL1RpbWVzLUJvbGQKL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcKPj4KZW5kb2JqCjExIDAgb2JqCjw8IC9UeXBlIC9Bbm5vdAovU3VidHlwZSAvTGluawovQSAxMiAwIFIKL0JvcmRlciBbMCAwIDBdCi9IIC9JCi9SZWN0IFsgMTk5LjEzNzggMTguMjE4NSAzOTYuMTQyMiAyNy4wMTg1IF0KPj4KZW5kb2JqCjEyIDAgb2JqCjw8IC9UeXBlIC9BY3Rpb24KL1MgL1VSSQovVVJJIChodHRwczovL3Jlam9vc2UuY29tL3dwLWNvbnRlbnQvdXBsb2Fkcy8yMDIzLzA2L0V2b2ljZV9FeHBsYWluZXIucGRmKQo+PgplbmRvYmoKeHJlZgowIDEzCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAwOSAwMDAwMCBuIAowMDAwMDAwMDc0IDAwMDAwIG4gCjAwMDAwMDAxMjAgMDAwMDAgbiAKMDAwMDAwMDI5NSAwMDAwMCBuIAowMDAwMDAwMzI0IDAwMDAwIG4gCjAwMDAwMDA0OTcgMDAwMDAgbiAKMDAwMDAwMDYxOSAwMDAwMCBuIAowMDAwMDAzNTI5IDAwMDAwIG4gCjAwMDAwMDM2MzggMDAwMDAgbiAKMDAwMDAwMzc1MCAwMDAwMCBuIAowMDAwMDAzODU5IDAwMDAwIG4gCjAwMDAwMDM5ODUgMDAwMDAgbiAKdHJhaWxlcgo8PAovU2l6ZSAxMwovUm9vdCAxIDAgUgovSW5mbyA1IDAgUgovSURbPGQ0MjEyYTIwY2E1NTc3NTg1NGNiOWUyNmM3NGRiYjdiPjxkNDIxMmEyMGNhNTU3NzU4NTRjYjllMjZjNzRkYmI3Yj5dCj4+CnN0YXJ0eHJlZgo0MTA0CiUlRU9GCg==
carbon_intensity_gram:
type: integer
example: 123
total_kg_co2_eq:
type: number
example: 1301.51
status:
type: string
example: finalized
type:
type: string
example: evoice
created_at:
type: string
example: '2024-01-05T13:11:49.000000Z'
client:
type: object
properties:
name:
type: string
example: 'Eco-Friendly Solutions Ltd'
vat_number:
type: string
example: ECOF1234567
organization_id:
type: string
example: EcoFriendly-4987
address:
type: string
example: '100 Enviro Way'
address2:
type: string
example: 'Sustainability Lane 3'
zip_code:
type: string
example: ECO321
city:
type: string
example: GreenVille
country:
type: string
example: Denmark
country_code:
type: string
example: DK
devices:
type: array
example:
-
external_id: RE8989121
original_manufacturer_part_number: 62B6MAT3EU
quantity: 10
brand: Lenovo
model_name: 'ThinkPad T480'
category: Notebook
lifetime_months: 72
scope_2_kg_co2_eq: 278.41
scope_3_kg_co2_eq: 249.27
total_kg_co2_eq: 527.68
refurbished: true
avoided_emissions_kg_co2_eq: 256.68
-
external_id: SM-S918BZKDEEB
original_manufacturer_part_number: null
quantity: 10
brand: Samsung
model_name: 'Galaxy S23 Ultra'
category: Smartphone
lifetime_months: 30
scope_2_kg_co2_eq: 31.18
scope_3_kg_co2_eq: 742.65
total_kg_co2_eq: 773.83
refurbished: false
avoided_emissions_kg_co2_eq: 0
items:
type: object
properties:
external_id:
type: string
example: RE8989121
original_manufacturer_part_number:
type: string
example: 62B6MAT3EU
quantity:
type: integer
example: 10
brand:
type: string
example: Lenovo
model_name:
type: string
example: 'ThinkPad T480'
category:
type: string
example: Notebook
lifetime_months:
type: integer
example: 72
scope_2_kg_co2_eq:
type: number
example: 278.41
scope_3_kg_co2_eq:
type: number
example: 249.27
total_kg_co2_eq:
type: number
example: 527.68
refurbished:
type: boolean
example: true
avoided_emissions_kg_co2_eq:
type: number
example: 256.68
links:
type: object
properties:
self:
type: string
example: 'https://app.rejoose.com/api/v3/evoices/123456789'
-
description: 'When using credit_note'
type: object
example:
success: true
data:
external_invoice_id: '123456789'
external_invoice_date: '2023-09-25'
country_code: DK
supplier_contact: example@rejoose.com
pdf_base64: JVBERi0xLjcKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZwovT3V0bGluZXMgMiAwIFIKL1BhZ2VzIDMgMCBSID4+CmVuZG9iagoyIDAgb2JqCjw8IC9UeXBlIC9PdXRsaW5lcyAvQ291bnQgMCA+PgplbmRvYmoKMyAwIG9iago8PCAvVHlwZSAvUGFnZXMKL0tpZHMgWzYgMCBSCl0KL0NvdW50IDEKL1Jlc291cmNlcyA8PAovUHJvY1NldCA0IDAgUgovRm9udCA8PCAKL0YxIDggMCBSCi9GMiA5IDAgUgovRjMgMTAgMCBSCj4+Cj4+Ci9NZWRpYUJveCBbMC4wMDAgMC4wMDAgNTk1LjI4MCA4NDEuODkwXQogPj4KZW5kb2JqCjQgMCBvYmoKWy9QREYgL1RleHQgXQplbmRvYmoKNSAwIG9iago8PAovUHJvZHVjZXIgKP7/AGQAbwBtAHAAZABmACAAMgAuADAALgAzACAAKwAgAEMAUABEAEYpCi9DcmVhdGlvbkRhdGUgKEQ6MjAyNDAxMDUxMzIzMTArMDAnMDAnKQovTW9kRGF0ZSAoRDoyMDI0MDEwNTEzMjMxMCswMCcwMCcpCi9UaXRsZSAo/v8ARQB2AG8AaQBjAGUpCj4+CmVuZG9iago2IDAgb2JqCjw8IC9UeXBlIC9QYWdlCi9NZWRpYUJveCBbMC4wMDAgMC4wMDAgNTk1LjI4MCA4NDEuODkwXQovUGFyZW50IDMgMCBSCi9Bbm5vdHMgWyAxMSAwIFIgXQovQ29udGVudHMgNyAwIFIKPj4KZW5kb2JqCjcgMCBvYmoKPDwgL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAyODM3ID4+CnN0cmVhbQp4nK2b23LcNhKG7/UUqORmt0qiiQNxyNXGsezaHCqxpdhV6/LFaIaSGM2Q8gxlRy+VZ9wGB2iCHhIYU/aFytVmA/g/NNANCD75eMJ0xoUkSuRZLgTZEG/gpjOsSSFlZrgYszin0EKzorNgu97wjtQn8LnSJM9YYeCnEIq8eXUCH5DPJCc/k/eEfIC/rMJBKWMHFfZoLWtycfJ6pLntzcnzS+xbs0wpQS5X5NlLRrjt6PKakPf/elP+1TS7kvx4f/HvD+TyZ3J+af0KCi0yRZQUmZTcO4JVOcerRzJwYAV0m0ccXE+hE4wz01JEhnf+7FNTLQdOhVRZbqAnY7JCMeyJZblz+gc/x0mVhejg46TKgrvZ8EDHLOLAIt00YzPeMGNSZVFkbDCp3oKTmuck/DmcVJZnhso9AE4UQru8rXbEkSPLpm4XVU3a25K0TbtYk/tts3pYtmS52F41NSk31W5XNfUuhOy7sFTzkS6gwW15XW7Lemmb7Vq/rupFvaygh3a7qHeLZQutZsFccFNAUHEipQY4hlBFQQAlBUykKaDBDiLtlIY/ASKE0QFF35xiCkLOAEZR5BnnCi0W45QnNxq+026po4UWGYRy57kfsFLQA5UZg2YgQjQVhMKwqPHjnVp63Chwss4m4/CFYygz7Ri+WLTlD4jn9fHCgV1WaBUIx00hIdx6GskC4WgJhI952h4KUNh7omWADKfAIaPwrxqYHDAbjWxR0Ex33gEzGjC7KO/bcnNVbgnsN4TB9M8BiJEDgzPwWRA5zpKMHCcviJycw/fyy8jJYQuBBTQvcnKYzdwcRs5/6/3ahiX4tABC/RhACf19uHj9aAn0RwMIPdEyIIcz4cjNDKAQXRhAkl8vlTbLM2kWV2eiWOkzky/ZmaDi6roslGHs6kkhBcOmnIYh5SzJkHKC+5CSBvZHmKZhSEkDyRLanRVS0lia+WFI/fSwa5tNuX1aPKF4jKeE+D56vHhvCcVH4wk9vWWIzU+DxzYvngbcwng6XzZnL7dVWa/Wj+SiWT/YpLcjv7arp0SRHSwHCH0UeUsqirzMIIo0hAPVX0YRWI3UM6NIC/iCjkRR81C320coOlZPS209ACyNEgD6uPEA0BIAiEVS74mWATqcCoduZiSF7MJIevHLkyIGBlUYHkaMs8QixldjmonQ01mSseZABLHmKrsvYk2ajBozM9YUzHvORmJtX75WdVvWu6p9fFq8IT6MtwQ+9ER86JnAF8blHh9aAnzRSEVPtAzA9xO5Bz8zUkPyYaRSiJqbZ3fvbgPiySOohFMd5VjMBMc1f1Jpm34KE0cfyaAxmR+eS47YjoNWYBCswE29b+XtoiXf/0DOf/r9JWgVcOIc84ayhYsRbwqjPa8/VduGvFs8klPbDmd0pInCiEzwkSZebcuyflut1+UpeVHWm8X2buBu7MAFKXSRSc29f8CUhCTHpwUWp21jel4uHu7v11VYEkzOipEQrWJ6WiZuGdBvaiLKvxeb+3X5n+3eP1s2m/Bs7yQUWmaiWw69RXUWOLnD4ZLC0hqzyAMLd5a+HW+ZPN7zg8M9+gq/SLH9vSVxZeP9Yfnl/iZlMDGX3TH+1bs/khMj7AYApfV0WxSWOD0tyN0N+en3wTWLgF2A6e66hQWu/YUOG36u9honeyo/xmOSmSw3kghNATmDvUrD0KEF6B4UwJ51ffy27taXMLZNu6tTGJ6BndBbpnZYcFSMdp+5iHIG2HEV3Vcfh6PYw4aBa8PgUzh6aDFyantBvo8jwFEGDLQyAwZjo7Z+TJhAL4NZkzB7Kb3WU0Ku6gWj5QjFVMMxXRTTkv9wV01Vfd0kZt8P2EkvQBFPK2eQ/7TSgXLOYE+kKj3TNq4hvoKp9pYjlDPYGHiup5W/fljULVQlcdU4WKdawr8Dz5RqzkSmpQpVw2YGu2hSte2QCRaoRssRqrkQUNDZ5ZFneqwmu1g29yXh4cbABWwB3LYvMtZfZkCnzud9t/UwUn78kIDlNX4lLEiSWrIAlr12lnk6RGyHjKsQlrccAUvkUP3KIgVrsIsKqClyJr8BLNTYr6dCsyQsIWB8RRhZBcgwPL1z2g4ZDyMLLcfAkiCYimlYv1bXZVtthr8+gMXPeYzWpqnb210CFSr8uriybrABhqjcASCFynoWMtx00RKgih0AAk9vOQJyYdOi4tOQu8Ji+FsdOAJ0W+JXxaNiBeBVSsJPzYswu0uaSSX67A5mriP7u0vkMDW5VmEid5ZUIndz2idymF3jDmcf06OKnZO4PSBaZ2gZRnJ41ciey99+vOTnfwbnpHE4Pvm5cfjkF8A5vvTxGRGRhUkmigzzHzLzliG01Gij0KjcD2aKGs1TtFCP69+v1zm0MJP2tIIsE6PV501PCy0DWsnRRmnZ+h2cJmlB1XfKk8C8pG8BzGdTBBZmmigwzJ0IzFuGwFKjjd5dwKKk0kSAKX0qUsBQUh/hXfKcAwwzKgIL800MWJ8/PTC0DIAlRxsFZuR+MFPAFEvRQj3fILwwqfa0fFJN0OpTqKeFloBWNKn2nt4y4JzUGeNcCMjYsWxRMHWqUqgx+wUJqzsgzmGNp0ZkHR7CYqz7M6InhpYBsfRwY8hohwy8FcuUkSM1YVk3n5qwXkEXaQ8qI5Qvb6v67m1l3zuQcybOQGxQt1BYp3kmC8udwTnHnfVAk7RFOTRqV7JrVGMR9GbOzbOvbAANMyasbJwlVdk4pn1lI+xFnvyisrG3OFrOrGyE7kZ0+Fv4384uDNXP//fLi/Pz57PU+yoF5Yd5MiofaxLU7y1DAD6WHYF5VcoUgUGV8vXVRq86SHYx1X1t4VWjZaAaKTrV86qNKdVKsFM5S7ivGlB4mLSiwrFGQOHeMhTuQc4RLvj+6dekcE5P2RzdmPxRd5hEYrr7VO91o2WgGzn2YT4j+U/qnhXmmMR71T6JJ1T3KdurRkugOprEe09vGfBC/nPiBJP45AJR/FTPQYa5GJGFp6wYsj7zeuFoGQjH9BJkhBm5uOBgHXnMdrHY7B7qm9FkLERm9AitV4v14u9HcsE4+XPdbhfJY7LLabbGp6rPafhbzRm/IbCPcikN06+zRNJv5wiDge0wdHSWVN52/Pu8DX5cqi/y9qTG6O/MXd6G7YyxkUc+3f3O7ugiMxhDFylzOGNgI+gwMcdAoyeSRs8E6XAB7FGjZcA6LdTCTt3ZOGdfX8wKRl8NIaQwj0ej0XsiJPRMhWNQNbl49JZhQKZ0HlVHTUUkO/62x/XvN+w5nLH+6jkHZUOMM3r2nL1ngnNYp+05o2XAOanzqMptirMx9NQcfU/0LVD7ig9Rh5VKFLX3RNTomUIdVIYOtbcMUad0HnXDNIWa52ZQJMdvmPpV1ZVtc1BjkYmowyInhho9ETV6JlCHxegeNVoGqJM6IzssjuUbhCOWpD0jX5ImGKFnz8h7JhiFpeueEVoCRtFitvf0lgHdJKF4MWsfH0X2DPc0ZBDK4035moiq7hnbwTOeN+X1w/aq2t2WK7IqP1XLckcWMDz7rglMn6v2lixq8l3yKobaJ4R2n5vsKfkkhhY2yUcG+1367RQ1sN1C0Qy1sza6vxAy/mniulrekdty2/3fmMUS9O6IfwO1KdvbZtWsm5tH8vm2aktyv7gvt1mk1y6oxeDPQc3jh6S6t8/2SabMqGDesA+1qeJeZ4wW9kZLIxD7H8AOX2+RM2iYwse5hL++rOpdWe8+lX8RGPEZYbZNMG/LVbmt7nZX5fYmG3vAZl8JFXbNsowrOdIlfYbv5f4P4se8CQplbmRzdHJlYW0KZW5kb2JqCjggMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GMQovQmFzZUZvbnQgL1RpbWVzLVJvbWFuCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCj4+CmVuZG9iago5IDAgb2JqCjw8IC9UeXBlIC9Gb250Ci9TdWJ0eXBlIC9UeXBlMQovTmFtZSAvRjIKL0Jhc2VGb250IC9IZWx2ZXRpY2EtQm9sZAovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZwo+PgplbmRvYmoKMTAgMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GMwovQmFzZUZvbnQgL1RpbWVzLUJvbGQKL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcKPj4KZW5kb2JqCjExIDAgb2JqCjw8IC9UeXBlIC9Bbm5vdAovU3VidHlwZSAvTGluawovQSAxMiAwIFIKL0JvcmRlciBbMCAwIDBdCi9IIC9JCi9SZWN0IFsgMTk5LjEzNzggMTguMjE4NSAzOTYuMTQyMiAyNy4wMTg1IF0KPj4KZW5kb2JqCjEyIDAgb2JqCjw8IC9UeXBlIC9BY3Rpb24KL1MgL1VSSQovVVJJIChodHRwczovL3Jlam9vc2UuY29tL3dwLWNvbnRlbnQvdXBsb2Fkcy8yMDIzLzA2L0V2b2ljZV9FeHBsYWluZXIucGRmKQo+PgplbmRvYmoKeHJlZgowIDEzCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAwOSAwMDAwMCBuIAowMDAwMDAwMDc0IDAwMDAwIG4gCjAwMDAwMDAxMjAgMDAwMDAgbiAKMDAwMDAwMDI5NSAwMDAwMCBuIAowMDAwMDAwMzI0IDAwMDAwIG4gCjAwMDAwMDA0OTcgMDAwMDAgbiAKMDAwMDAwMDYxOSAwMDAwMCBuIAowMDAwMDAzNTI5IDAwMDAwIG4gCjAwMDAwMDM2MzggMDAwMDAgbiAKMDAwMDAwMzc1MCAwMDAwMCBuIAowMDAwMDAzODU5IDAwMDAwIG4gCjAwMDAwMDM5ODUgMDAwMDAgbiAKdHJhaWxlcgo8PAovU2l6ZSAxMwovUm9vdCAxIDAgUgovSW5mbyA1IDAgUgovSURbPGQ0MjEyYTIwY2E1NTc3NTg1NGNiOWUyNmM3NGRiYjdiPjxkNDIxMmEyMGNhNTU3NzU4NTRjYjllMjZjNzRkYmI3Yj5dCj4+CnN0YXJ0eHJlZgo0MTA0CiUlRU9GCg==
carbon_intensity_gram: 123
total_kg_co2_eq: -1301.51
status: finalized
type: credit_note
created_at: '2024-01-05T13:11:49.000000Z'
client:
name: 'Eco-Friendly Solutions Ltd'
vat_number: ECOF1234567
organization_id: EcoFriendly-4987
address: '100 Enviro Way'
address2: 'Sustainability Lane 3'
zip_code: ECO321
city: GreenVille
country: Denmark
country_code: DK
devices:
-
external_id: RE8989121
original_manufacturer_part_number: 62B6MAT3EU
quantity: 10
brand: Lenovo
model_name: 'ThinkPad T480'
category: Notebook
lifetime_months: 72
scope_2_kg_co2_eq: -278.41
scope_3_kg_co2_eq: -249.27
total_kg_co2_eq: -527.68
refurbished: true
avoided_emissions_kg_co2_eq: -256.68
-
external_id: SM-S918BZKDEEB
original_manufacturer_part_number: null
quantity: 10
brand: Samsung
model_name: 'Galaxy S23 Ultra'
category: Smartphone
lifetime_months: 30
scope_2_kg_co2_eq: -31.18
scope_3_kg_co2_eq: -742.65
total_kg_co2_eq: -773.83
refurbished: false
avoided_emissions_kg_co2_eq: 0
links:
self: 'https://app.rejoose.com/api/v3/evoices/123456789'
properties:
success:
type: boolean
example: true
data:
type: object
properties:
external_invoice_id:
type: string
example: '123456789'
external_invoice_date:
type: string
example: '2023-09-25'
country_code:
type: string
example: DK
supplier_contact:
type: string
example: example@rejoose.com
pdf_base64:
type: string
example: JVBERi0xLjcKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZwovT3V0bGluZXMgMiAwIFIKL1BhZ2VzIDMgMCBSID4+CmVuZG9iagoyIDAgb2JqCjw8IC9UeXBlIC9PdXRsaW5lcyAvQ291bnQgMCA+PgplbmRvYmoKMyAwIG9iago8PCAvVHlwZSAvUGFnZXMKL0tpZHMgWzYgMCBSCl0KL0NvdW50IDEKL1Jlc291cmNlcyA8PAovUHJvY1NldCA0IDAgUgovRm9udCA8PCAKL0YxIDggMCBSCi9GMiA5IDAgUgovRjMgMTAgMCBSCj4+Cj4+Ci9NZWRpYUJveCBbMC4wMDAgMC4wMDAgNTk1LjI4MCA4NDEuODkwXQogPj4KZW5kb2JqCjQgMCBvYmoKWy9QREYgL1RleHQgXQplbmRvYmoKNSAwIG9iago8PAovUHJvZHVjZXIgKP7/AGQAbwBtAHAAZABmACAAMgAuADAALgAzACAAKwAgAEMAUABEAEYpCi9DcmVhdGlvbkRhdGUgKEQ6MjAyNDAxMDUxMzIzMTArMDAnMDAnKQovTW9kRGF0ZSAoRDoyMDI0MDEwNTEzMjMxMCswMCcwMCcpCi9UaXRsZSAo/v8ARQB2AG8AaQBjAGUpCj4+CmVuZG9iago2IDAgb2JqCjw8IC9UeXBlIC9QYWdlCi9NZWRpYUJveCBbMC4wMDAgMC4wMDAgNTk1LjI4MCA4NDEuODkwXQovUGFyZW50IDMgMCBSCi9Bbm5vdHMgWyAxMSAwIFIgXQovQ29udGVudHMgNyAwIFIKPj4KZW5kb2JqCjcgMCBvYmoKPDwgL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAyODM3ID4+CnN0cmVhbQp4nK2b23LcNhKG7/UUqORmt0qiiQNxyNXGsezaHCqxpdhV6/LFaIaSGM2Q8gxlRy+VZ9wGB2iCHhIYU/aFytVmA/g/NNANCD75eMJ0xoUkSuRZLgTZEG/gpjOsSSFlZrgYszin0EKzorNgu97wjtQn8LnSJM9YYeCnEIq8eXUCH5DPJCc/k/eEfIC/rMJBKWMHFfZoLWtycfJ6pLntzcnzS+xbs0wpQS5X5NlLRrjt6PKakPf/elP+1TS7kvx4f/HvD+TyZ3J+af0KCi0yRZQUmZTcO4JVOcerRzJwYAV0m0ccXE+hE4wz01JEhnf+7FNTLQdOhVRZbqAnY7JCMeyJZblz+gc/x0mVhejg46TKgrvZ8EDHLOLAIt00YzPeMGNSZVFkbDCp3oKTmuck/DmcVJZnhso9AE4UQru8rXbEkSPLpm4XVU3a25K0TbtYk/tts3pYtmS52F41NSk31W5XNfUuhOy7sFTzkS6gwW15XW7Lemmb7Vq/rupFvaygh3a7qHeLZQutZsFccFNAUHEipQY4hlBFQQAlBUykKaDBDiLtlIY/ASKE0QFF35xiCkLOAEZR5BnnCi0W45QnNxq+026po4UWGYRy57kfsFLQA5UZg2YgQjQVhMKwqPHjnVp63Chwss4m4/CFYygz7Ri+WLTlD4jn9fHCgV1WaBUIx00hIdx6GskC4WgJhI952h4KUNh7omWADKfAIaPwrxqYHDAbjWxR0Ex33gEzGjC7KO/bcnNVbgnsN4TB9M8BiJEDgzPwWRA5zpKMHCcviJycw/fyy8jJYQuBBTQvcnKYzdwcRs5/6/3ahiX4tABC/RhACf19uHj9aAn0RwMIPdEyIIcz4cjNDKAQXRhAkl8vlTbLM2kWV2eiWOkzky/ZmaDi6roslGHs6kkhBcOmnIYh5SzJkHKC+5CSBvZHmKZhSEkDyRLanRVS0lia+WFI/fSwa5tNuX1aPKF4jKeE+D56vHhvCcVH4wk9vWWIzU+DxzYvngbcwng6XzZnL7dVWa/Wj+SiWT/YpLcjv7arp0SRHSwHCH0UeUsqirzMIIo0hAPVX0YRWI3UM6NIC/iCjkRR81C320coOlZPS209ACyNEgD6uPEA0BIAiEVS74mWATqcCoduZiSF7MJIevHLkyIGBlUYHkaMs8QixldjmonQ01mSseZABLHmKrsvYk2ajBozM9YUzHvORmJtX75WdVvWu6p9fFq8IT6MtwQ+9ER86JnAF8blHh9aAnzRSEVPtAzA9xO5Bz8zUkPyYaRSiJqbZ3fvbgPiySOohFMd5VjMBMc1f1Jpm34KE0cfyaAxmR+eS47YjoNWYBCswE29b+XtoiXf/0DOf/r9JWgVcOIc84ayhYsRbwqjPa8/VduGvFs8klPbDmd0pInCiEzwkSZebcuyflut1+UpeVHWm8X2buBu7MAFKXSRSc29f8CUhCTHpwUWp21jel4uHu7v11VYEkzOipEQrWJ6WiZuGdBvaiLKvxeb+3X5n+3eP1s2m/Bs7yQUWmaiWw69RXUWOLnD4ZLC0hqzyAMLd5a+HW+ZPN7zg8M9+gq/SLH9vSVxZeP9Yfnl/iZlMDGX3TH+1bs/khMj7AYApfV0WxSWOD0tyN0N+en3wTWLgF2A6e66hQWu/YUOG36u9honeyo/xmOSmSw3kghNATmDvUrD0KEF6B4UwJ51ffy27taXMLZNu6tTGJ6BndBbpnZYcFSMdp+5iHIG2HEV3Vcfh6PYw4aBa8PgUzh6aDFyantBvo8jwFEGDLQyAwZjo7Z+TJhAL4NZkzB7Kb3WU0Ku6gWj5QjFVMMxXRTTkv9wV01Vfd0kZt8P2EkvQBFPK2eQ/7TSgXLOYE+kKj3TNq4hvoKp9pYjlDPYGHiup5W/fljULVQlcdU4WKdawr8Dz5RqzkSmpQpVw2YGu2hSte2QCRaoRssRqrkQUNDZ5ZFneqwmu1g29yXh4cbABWwB3LYvMtZfZkCnzud9t/UwUn78kIDlNX4lLEiSWrIAlr12lnk6RGyHjKsQlrccAUvkUP3KIgVrsIsKqClyJr8BLNTYr6dCsyQsIWB8RRhZBcgwPL1z2g4ZDyMLLcfAkiCYimlYv1bXZVtthr8+gMXPeYzWpqnb210CFSr8uriybrABhqjcASCFynoWMtx00RKgih0AAk9vOQJyYdOi4tOQu8Ji+FsdOAJ0W+JXxaNiBeBVSsJPzYswu0uaSSX67A5mriP7u0vkMDW5VmEid5ZUIndz2idymF3jDmcf06OKnZO4PSBaZ2gZRnJ41ciey99+vOTnfwbnpHE4Pvm5cfjkF8A5vvTxGRGRhUkmigzzHzLzliG01Gij0KjcD2aKGs1TtFCP69+v1zm0MJP2tIIsE6PV501PCy0DWsnRRmnZ+h2cJmlB1XfKk8C8pG8BzGdTBBZmmigwzJ0IzFuGwFKjjd5dwKKk0kSAKX0qUsBQUh/hXfKcAwwzKgIL800MWJ8/PTC0DIAlRxsFZuR+MFPAFEvRQj3fILwwqfa0fFJN0OpTqKeFloBWNKn2nt4y4JzUGeNcCMjYsWxRMHWqUqgx+wUJqzsgzmGNp0ZkHR7CYqz7M6InhpYBsfRwY8hohwy8FcuUkSM1YVk3n5qwXkEXaQ8qI5Qvb6v67m1l3zuQcybOQGxQt1BYp3kmC8udwTnHnfVAk7RFOTRqV7JrVGMR9GbOzbOvbAANMyasbJwlVdk4pn1lI+xFnvyisrG3OFrOrGyE7kZ0+Fv4384uDNXP//fLi/Pz57PU+yoF5Yd5MiofaxLU7y1DAD6WHYF5VcoUgUGV8vXVRq86SHYx1X1t4VWjZaAaKTrV86qNKdVKsFM5S7ivGlB4mLSiwrFGQOHeMhTuQc4RLvj+6dekcE5P2RzdmPxRd5hEYrr7VO91o2WgGzn2YT4j+U/qnhXmmMR71T6JJ1T3KdurRkugOprEe09vGfBC/nPiBJP45AJR/FTPQYa5GJGFp6wYsj7zeuFoGQjH9BJkhBm5uOBgHXnMdrHY7B7qm9FkLERm9AitV4v14u9HcsE4+XPdbhfJY7LLabbGp6rPafhbzRm/IbCPcikN06+zRNJv5wiDge0wdHSWVN52/Pu8DX5cqi/y9qTG6O/MXd6G7YyxkUc+3f3O7ugiMxhDFylzOGNgI+gwMcdAoyeSRs8E6XAB7FGjZcA6LdTCTt3ZOGdfX8wKRl8NIaQwj0ej0XsiJPRMhWNQNbl49JZhQKZ0HlVHTUUkO/62x/XvN+w5nLH+6jkHZUOMM3r2nL1ngnNYp+05o2XAOanzqMptirMx9NQcfU/0LVD7ig9Rh5VKFLX3RNTomUIdVIYOtbcMUad0HnXDNIWa52ZQJMdvmPpV1ZVtc1BjkYmowyInhho9ETV6JlCHxegeNVoGqJM6IzssjuUbhCOWpD0jX5ImGKFnz8h7JhiFpeueEVoCRtFitvf0lgHdJKF4MWsfH0X2DPc0ZBDK4035moiq7hnbwTOeN+X1w/aq2t2WK7IqP1XLckcWMDz7rglMn6v2lixq8l3yKobaJ4R2n5vsKfkkhhY2yUcG+1367RQ1sN1C0Qy1sza6vxAy/mniulrekdty2/3fmMUS9O6IfwO1KdvbZtWsm5tH8vm2aktyv7gvt1mk1y6oxeDPQc3jh6S6t8/2SabMqGDesA+1qeJeZ4wW9kZLIxD7H8AOX2+RM2iYwse5hL++rOpdWe8+lX8RGPEZYbZNMG/LVbmt7nZX5fYmG3vAZl8JFXbNsowrOdIlfYbv5f4P4se8CQplbmRzdHJlYW0KZW5kb2JqCjggMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GMQovQmFzZUZvbnQgL1RpbWVzLVJvbWFuCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCj4+CmVuZG9iago5IDAgb2JqCjw8IC9UeXBlIC9Gb250Ci9TdWJ0eXBlIC9UeXBlMQovTmFtZSAvRjIKL0Jhc2VGb250IC9IZWx2ZXRpY2EtQm9sZAovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZwo+PgplbmRvYmoKMTAgMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GMwovQmFzZUZvbnQgL1RpbWVzLUJvbGQKL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcKPj4KZW5kb2JqCjExIDAgb2JqCjw8IC9UeXBlIC9Bbm5vdAovU3VidHlwZSAvTGluawovQSAxMiAwIFIKL0JvcmRlciBbMCAwIDBdCi9IIC9JCi9SZWN0IFsgMTk5LjEzNzggMTguMjE4NSAzOTYuMTQyMiAyNy4wMTg1IF0KPj4KZW5kb2JqCjEyIDAgb2JqCjw8IC9UeXBlIC9BY3Rpb24KL1MgL1VSSQovVVJJIChodHRwczovL3Jlam9vc2UuY29tL3dwLWNvbnRlbnQvdXBsb2Fkcy8yMDIzLzA2L0V2b2ljZV9FeHBsYWluZXIucGRmKQo+PgplbmRvYmoKeHJlZgowIDEzCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAwOSAwMDAwMCBuIAowMDAwMDAwMDc0IDAwMDAwIG4gCjAwMDAwMDAxMjAgMDAwMDAgbiAKMDAwMDAwMDI5NSAwMDAwMCBuIAowMDAwMDAwMzI0IDAwMDAwIG4gCjAwMDAwMDA0OTcgMDAwMDAgbiAKMDAwMDAwMDYxOSAwMDAwMCBuIAowMDAwMDAzNTI5IDAwMDAwIG4gCjAwMDAwMDM2MzggMDAwMDAgbiAKMDAwMDAwMzc1MCAwMDAwMCBuIAowMDAwMDAzODU5IDAwMDAwIG4gCjAwMDAwMDM5ODUgMDAwMDAgbiAKdHJhaWxlcgo8PAovU2l6ZSAxMwovUm9vdCAxIDAgUgovSW5mbyA1IDAgUgovSURbPGQ0MjEyYTIwY2E1NTc3NTg1NGNiOWUyNmM3NGRiYjdiPjxkNDIxMmEyMGNhNTU3NzU4NTRjYjllMjZjNzRkYmI3Yj5dCj4+CnN0YXJ0eHJlZgo0MTA0CiUlRU9GCg==
carbon_intensity_gram:
type: integer
example: 123
total_kg_co2_eq:
type: number
example: -1301.51
status:
type: string
example: finalized
type:
type: string
example: credit_note
created_at:
type: string
example: '2024-01-05T13:11:49.000000Z'
client:
type: object
properties:
name:
type: string
example: 'Eco-Friendly Solutions Ltd'
vat_number:
type: string
example: ECOF1234567
organization_id:
type: string
example: EcoFriendly-4987
address:
type: string
example: '100 Enviro Way'
address2:
type: string
example: 'Sustainability Lane 3'
zip_code:
type: string
example: ECO321
city:
type: string
example: GreenVille
country:
type: string
example: Denmark
country_code:
type: string
example: DK
devices:
type: array
example:
-
external_id: RE8989121
original_manufacturer_part_number: 62B6MAT3EU
quantity: 10
brand: Lenovo
model_name: 'ThinkPad T480'
category: Notebook
lifetime_months: 72
scope_2_kg_co2_eq: -278.41
scope_3_kg_co2_eq: -249.27
total_kg_co2_eq: -527.68
refurbished: true
avoided_emissions_kg_co2_eq: -256.68
-
external_id: SM-S918BZKDEEB
original_manufacturer_part_number: null
quantity: 10
brand: Samsung
model_name: 'Galaxy S23 Ultra'
category: Smartphone
lifetime_months: 30
scope_2_kg_co2_eq: -31.18
scope_3_kg_co2_eq: -742.65
total_kg_co2_eq: -773.83
refurbished: false
avoided_emissions_kg_co2_eq: 0
items:
type: object
properties:
external_id:
type: string
example: RE8989121
original_manufacturer_part_number:
type: string
example: 62B6MAT3EU
quantity:
type: integer
example: 10
brand:
type: string
example: Lenovo
model_name:
type: string
example: 'ThinkPad T480'
category:
type: string
example: Notebook
lifetime_months:
type: integer
example: 72
scope_2_kg_co2_eq:
type: number
example: -278.41
scope_3_kg_co2_eq:
type: number
example: -249.27
total_kg_co2_eq:
type: number
example: -527.68
refurbished:
type: boolean
example: true
avoided_emissions_kg_co2_eq:
type: number
example: -256.68
links:
type: object
properties:
self:
type: string
example: 'https://app.rejoose.com/api/v3/evoices/123456789'
422:
description: 'Validation Error'
content:
application/json:
schema:
type: object
example:
errors:
external_invoice_id:
- 'The external invoice id field is required.'
external_invoice_date:
- 'The external invoice date field is required.'
client.name:
- 'The client.name field is required.'
properties:
errors:
type: object
properties:
external_invoice_id:
type: array
example:
- 'The external invoice id field is required.'
items:
type: string
external_invoice_date:
type: array
example:
- 'The external invoice date field is required.'
items:
type: string
client.name:
type: array
example:
- 'The client.name field is required.'
items:
type: string
429:
description: 'Too Many Attempts'
content:
application/json:
schema:
type: object
example:
message: 'Too Many Attempts.'
properties:
message:
type: string
example: 'Too Many Attempts.'
tags:
- e.voice
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
options:
type: object
description: 'Settings for the request.'
example: []
nullable: false
properties:
deferred:
type: boolean
description: 'Specifies whether the e.voice generation should run as a background job. Defaults to false.'
example: true
nullable: false
include_pdf:
type: boolean
description: 'Specifies whether the response should include a base64-encoded PDF file. Defaults to true.'
example: false
nullable: false
credit_note:
type: boolean
description: 'Specifies whether the e.voice is a credit note. If set to true, it will mark the e.voice as a credit note, reversing the carbon data. Defaults to false.'
example: true
nullable: false
external_invoice_id:
type: string
description: 'A unique identifier that can connect the e.voice with the invoice sent to the customer. It is recommended to use the actual invoice number stated on the customer invoice. Must be between 1 and 255 characters.'
example: '123456789'
nullable: false
external_invoice_date:
type: string
description: 'The date of the financial transaction. The date should use the invoicing date in ISO 8601 standard (YYYY-MM-DD).'
example: '2023-09-25'
nullable: false
country_code:
type: string
description: 'Country code for product delivery. This defines the use phase country, so this should represent the country where products are shipped to and used in. Should be ISO 3166-2 or ISO 3166-2:US - alpha-2 code. US states need to have the prefix "US-". This will determine the use country carbon intensity (gram CO2e per kWh) used for the e.voice.'
example: GB
nullable: false
supplier_contact:
type: string
description: 'Contact email for a person or mailbox for you as the supplier to the customer. This contact email address will be visible on the e.voice. Must be between 1 and 80 characters.'
example: example@rejoose.com
nullable: false
client:
type: object
description: 'Client information object. Within this client information object, are two crucial identifiers that greatly impact reporting. The `organization_id`, which identifies your customer on a group level, and the `vat_number`, which defines the company within the organization. We recommend using unique and static values for `organization_id` as they are utilized by the e.hub and e.insights reporting portals to group and aggregate data.'
example:
name: 'Eco-Friendly Solutions Ltd'
vat_number: ECOF1234567
organization_id: EcoFriendly-4987
address: '100 Enviro Way'
address2: 'Sustainability Lane 3'
zip_code: ECO321
city: GreenVille
country: Denmark
country_code: DK
nullable: false
properties:
name:
type: string
description: 'The name of the customer as on the invoice. This line will be shown on the e.voice. Can be made anonymous by e.g., inserting a dash instead (-) or similar. Must be between 1 and 80 characters.'
example: 'Eco-Friendly Solutions Ltd'
nullable: false
organization_id:
type: string
description: 'An identifier for the client group/organization in your system. This identifier is important as it is used to aggregate reporting functions at group level for the customer with several companies in the group (VAT numbers). Must be between 1 and 240 characters.'
example: company-4987
nullable: false
vat_number:
type: string
description: 'This defines the company, and as with `organization_id` is used for reporting purposes. We recommend this to be the VAT number but could be another unique identifier. Must be between 1 and 80 characters.'
example: ECOF1234567
nullable: false
address:
type: string
description: 'The address of the customer as on the invoice. This line will be shown on the e.voice. Can be made anonymous by e.g., inserting a dash instead (-) or similar. Must be between 1 and 80 characters.'
example: '100 Enviro Way'
nullable: false
address2:
type: string
description: 'The second line of the address of the customer as on the invoice. Must be between 1 and 80 characters.'
example: 'Sustainability Lane 3'
nullable: false
zip_code:
type: string
description: 'The zip code of the customer as on the invoice. This line will be shown on the e.voice. Can be made anonymous by e.g., inserting a dash instead (-) or similar. Must be between 1 and 80 characters.'
example: ECO321
nullable: false
city:
type: string
description: 'The city of the customer as on the invoice. This line will be shown on the e.voice. Can be made anonymous by e.g., inserting a dash instead (-) or similar. Must be between 1 and 80 characters.'
example: GreenVille
nullable: false
country:
type: string
description: 'The country of the customer as on the invoice. This line will be shown on the e.voice. Can be made anonymous by e.g., inserting a dash instead (-) or similar. Must be between 1 and 80 characters.'
example: Denmark
nullable: false
country_code:
type: string
description: 'The country code of the customer as on the invoice. Should be ISO 3166-2 or ISO 3166-2:US - alpha-2 code.'
example: DK
nullable: false
required:
- name
- organization_id
- vat_number
- address
- zip_code
- city
- country
- country_code
devices:
type: array
description: 'This is the list of devices and products from the invoice sent to the customer (Array of device objects).'
example:
- []
items:
type: object
properties:
external_id:
type: string
description: "Provide the product's manufacturer part number (MPN). If another identifier is used, the `original_manufacturer_part_number` should be provided."
example: RE8989121
nullable: false
original_manufacturer_part_number:
type: string
description: 'This is the unique manufacturer part number (MPN). The MPN is a special code that uniquely identifies a product from a specific manufacturer. If another identifier is used as `external_id`, the original manufacturer part number should be provided.'
example: 62B6ASD3EU
nullable: false
quantity:
type: integer
description: 'The number of units for the invoiced or credited item. For e.voices, this represents the quantity sold. For credit notes, this represents the quantity being reversed. Can be both a positive or negative integer.'
example: 10
nullable: false
category:
type: string
description: 'The category information serves two purposes: together with the `external_id` and `brand`, it provides a 100% unique data set for secure product matching. In the absence of LCA data, the system can provide CA data for the brand/category. Must be between 1 and 80 characters.'
example: Notebook
nullable: false
brand:
type: string
description: 'The name of the manufacturer of the product. This information, together with the `external_id` (MPN) and `category`, provides a unique data set to match carbon data to the specific product. Must be between 1 and 80 characters.'
example: Lenovo
nullable: false
model_name:
type: string
description: 'The product model name as on the invoice. This line of text will also be shown on the e.voice to have a 1:1 match with the invoice. Must be between 1 and 240. characters.'
example: 'ThinkPad T480'
nullable: false
refurbished:
type: boolean
description: 'Utilize this if you are selling a refurbished product; otherwise, do not add this. Set the parameter as `true` to define this as a refurbished product and you will receive a data set for this.'
example: true
nullable: false
lifetime_months:
type: integer
description: 'Use this if you know the actual lifespan of the product in months. If not used, Rejoose will utilize the standard EU lifespan. Must be at least 1.'
example: 48
nullable: false
excluded:
type: boolean
description: "Use this if you want to exclude this product's LCA data from the e.voice. Use cases could include products with no carbon footprint or products where the footprint has already been accounted for elsewhere. This defaults to false."
example: true
nullable: false
required:
- external_id
- quantity
- category
- brand
- model_name
required:
- external_invoice_id
- external_invoice_date
- country_code
- supplier_contact
- client
- devices
'/api/v3/evoices/{external_invoice_id}':
get:
summary: 'GET e.voice data'
operationId: gETEvoiceData
description: 'Returns the e.voice data'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
success: true
data:
external_invoice_id: '123456789'
external_invoice_date: '2023-09-25'
country_code: DK
supplier_contact: example@rejoose.com
pdf_base64: JVBERi0xLjcKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZwovT3V0bGluZXMgMiAwIFIKL1BhZ2VzIDMgMCBSID4+CmVuZG9iagoyIDAgb2JqCjw8IC9UeXBlIC9PdXRsaW5lcyAvQ291bnQgMCA+PgplbmRvYmoKMyAwIG9iago8PCAvVHlwZSAvUGFnZXMKL0tpZHMgWzYgMCBSCl0KL0NvdW50IDEKL1Jlc291cmNlcyA8PAovUHJvY1NldCA0IDAgUgovRm9udCA8PCAKL0YxIDggMCBSCi9GMiA5IDAgUgovRjMgMTAgMCBSCj4+Cj4+Ci9NZWRpYUJveCBbMC4wMDAgMC4wMDAgNTk1LjI4MCA4NDEuODkwXQogPj4KZW5kb2JqCjQgMCBvYmoKWy9QREYgL1RleHQgXQplbmRvYmoKNSAwIG9iago8PAovUHJvZHVjZXIgKP7/AGQAbwBtAHAAZABmACAAMgAuADAALgAzACAAKwAgAEMAUABEAEYpCi9DcmVhdGlvbkRhdGUgKEQ6MjAyNDAxMDUxMzIzMTArMDAnMDAnKQovTW9kRGF0ZSAoRDoyMDI0MDEwNTEzMjMxMCswMCcwMCcpCi9UaXRsZSAo/v8ARQB2AG8AaQBjAGUpCj4+CmVuZG9iago2IDAgb2JqCjw8IC9UeXBlIC9QYWdlCi9NZWRpYUJveCBbMC4wMDAgMC4wMDAgNTk1LjI4MCA4NDEuODkwXQovUGFyZW50IDMgMCBSCi9Bbm5vdHMgWyAxMSAwIFIgXQovQ29udGVudHMgNyAwIFIKPj4KZW5kb2JqCjcgMCBvYmoKPDwgL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAyODM3ID4+CnN0cmVhbQp4nK2b23LcNhKG7/UUqORmt0qiiQNxyNXGsezaHCqxpdhV6/LFaIaSGM2Q8gxlRy+VZ9wGB2iCHhIYU/aFytVmA/g/NNANCD75eMJ0xoUkSuRZLgTZEG/gpjOsSSFlZrgYszin0EKzorNgu97wjtQn8LnSJM9YYeCnEIq8eXUCH5DPJCc/k/eEfIC/rMJBKWMHFfZoLWtycfJ6pLntzcnzS+xbs0wpQS5X5NlLRrjt6PKakPf/elP+1TS7kvx4f/HvD+TyZ3J+af0KCi0yRZQUmZTcO4JVOcerRzJwYAV0m0ccXE+hE4wz01JEhnf+7FNTLQdOhVRZbqAnY7JCMeyJZblz+gc/x0mVhejg46TKgrvZ8EDHLOLAIt00YzPeMGNSZVFkbDCp3oKTmuck/DmcVJZnhso9AE4UQru8rXbEkSPLpm4XVU3a25K0TbtYk/tts3pYtmS52F41NSk31W5XNfUuhOy7sFTzkS6gwW15XW7Lemmb7Vq/rupFvaygh3a7qHeLZQutZsFccFNAUHEipQY4hlBFQQAlBUykKaDBDiLtlIY/ASKE0QFF35xiCkLOAEZR5BnnCi0W45QnNxq+026po4UWGYRy57kfsFLQA5UZg2YgQjQVhMKwqPHjnVp63Chwss4m4/CFYygz7Ri+WLTlD4jn9fHCgV1WaBUIx00hIdx6GskC4WgJhI952h4KUNh7omWADKfAIaPwrxqYHDAbjWxR0Ex33gEzGjC7KO/bcnNVbgnsN4TB9M8BiJEDgzPwWRA5zpKMHCcviJycw/fyy8jJYQuBBTQvcnKYzdwcRs5/6/3ahiX4tABC/RhACf19uHj9aAn0RwMIPdEyIIcz4cjNDKAQXRhAkl8vlTbLM2kWV2eiWOkzky/ZmaDi6roslGHs6kkhBcOmnIYh5SzJkHKC+5CSBvZHmKZhSEkDyRLanRVS0lia+WFI/fSwa5tNuX1aPKF4jKeE+D56vHhvCcVH4wk9vWWIzU+DxzYvngbcwng6XzZnL7dVWa/Wj+SiWT/YpLcjv7arp0SRHSwHCH0UeUsqirzMIIo0hAPVX0YRWI3UM6NIC/iCjkRR81C320coOlZPS209ACyNEgD6uPEA0BIAiEVS74mWATqcCoduZiSF7MJIevHLkyIGBlUYHkaMs8QixldjmonQ01mSseZABLHmKrsvYk2ajBozM9YUzHvORmJtX75WdVvWu6p9fFq8IT6MtwQ+9ER86JnAF8blHh9aAnzRSEVPtAzA9xO5Bz8zUkPyYaRSiJqbZ3fvbgPiySOohFMd5VjMBMc1f1Jpm34KE0cfyaAxmR+eS47YjoNWYBCswE29b+XtoiXf/0DOf/r9JWgVcOIc84ayhYsRbwqjPa8/VduGvFs8klPbDmd0pInCiEzwkSZebcuyflut1+UpeVHWm8X2buBu7MAFKXSRSc29f8CUhCTHpwUWp21jel4uHu7v11VYEkzOipEQrWJ6WiZuGdBvaiLKvxeb+3X5n+3eP1s2m/Bs7yQUWmaiWw69RXUWOLnD4ZLC0hqzyAMLd5a+HW+ZPN7zg8M9+gq/SLH9vSVxZeP9Yfnl/iZlMDGX3TH+1bs/khMj7AYApfV0WxSWOD0tyN0N+en3wTWLgF2A6e66hQWu/YUOG36u9honeyo/xmOSmSw3kghNATmDvUrD0KEF6B4UwJ51ffy27taXMLZNu6tTGJ6BndBbpnZYcFSMdp+5iHIG2HEV3Vcfh6PYw4aBa8PgUzh6aDFyantBvo8jwFEGDLQyAwZjo7Z+TJhAL4NZkzB7Kb3WU0Ku6gWj5QjFVMMxXRTTkv9wV01Vfd0kZt8P2EkvQBFPK2eQ/7TSgXLOYE+kKj3TNq4hvoKp9pYjlDPYGHiup5W/fljULVQlcdU4WKdawr8Dz5RqzkSmpQpVw2YGu2hSte2QCRaoRssRqrkQUNDZ5ZFneqwmu1g29yXh4cbABWwB3LYvMtZfZkCnzud9t/UwUn78kIDlNX4lLEiSWrIAlr12lnk6RGyHjKsQlrccAUvkUP3KIgVrsIsKqClyJr8BLNTYr6dCsyQsIWB8RRhZBcgwPL1z2g4ZDyMLLcfAkiCYimlYv1bXZVtthr8+gMXPeYzWpqnb210CFSr8uriybrABhqjcASCFynoWMtx00RKgih0AAk9vOQJyYdOi4tOQu8Ji+FsdOAJ0W+JXxaNiBeBVSsJPzYswu0uaSSX67A5mriP7u0vkMDW5VmEid5ZUIndz2idymF3jDmcf06OKnZO4PSBaZ2gZRnJ41ciey99+vOTnfwbnpHE4Pvm5cfjkF8A5vvTxGRGRhUkmigzzHzLzliG01Gij0KjcD2aKGs1TtFCP69+v1zm0MJP2tIIsE6PV501PCy0DWsnRRmnZ+h2cJmlB1XfKk8C8pG8BzGdTBBZmmigwzJ0IzFuGwFKjjd5dwKKk0kSAKX0qUsBQUh/hXfKcAwwzKgIL800MWJ8/PTC0DIAlRxsFZuR+MFPAFEvRQj3fILwwqfa0fFJN0OpTqKeFloBWNKn2nt4y4JzUGeNcCMjYsWxRMHWqUqgx+wUJqzsgzmGNp0ZkHR7CYqz7M6InhpYBsfRwY8hohwy8FcuUkSM1YVk3n5qwXkEXaQ8qI5Qvb6v67m1l3zuQcybOQGxQt1BYp3kmC8udwTnHnfVAk7RFOTRqV7JrVGMR9GbOzbOvbAANMyasbJwlVdk4pn1lI+xFnvyisrG3OFrOrGyE7kZ0+Fv4384uDNXP//fLi/Pz57PU+yoF5Yd5MiofaxLU7y1DAD6WHYF5VcoUgUGV8vXVRq86SHYx1X1t4VWjZaAaKTrV86qNKdVKsFM5S7ivGlB4mLSiwrFGQOHeMhTuQc4RLvj+6dekcE5P2RzdmPxRd5hEYrr7VO91o2WgGzn2YT4j+U/qnhXmmMR71T6JJ1T3KdurRkugOprEe09vGfBC/nPiBJP45AJR/FTPQYa5GJGFp6wYsj7zeuFoGQjH9BJkhBm5uOBgHXnMdrHY7B7qm9FkLERm9AitV4v14u9HcsE4+XPdbhfJY7LLabbGp6rPafhbzRm/IbCPcikN06+zRNJv5wiDge0wdHSWVN52/Pu8DX5cqi/y9qTG6O/MXd6G7YyxkUc+3f3O7ugiMxhDFylzOGNgI+gwMcdAoyeSRs8E6XAB7FGjZcA6LdTCTt3ZOGdfX8wKRl8NIaQwj0ej0XsiJPRMhWNQNbl49JZhQKZ0HlVHTUUkO/62x/XvN+w5nLH+6jkHZUOMM3r2nL1ngnNYp+05o2XAOanzqMptirMx9NQcfU/0LVD7ig9Rh5VKFLX3RNTomUIdVIYOtbcMUad0HnXDNIWa52ZQJMdvmPpV1ZVtc1BjkYmowyInhho9ETV6JlCHxegeNVoGqJM6IzssjuUbhCOWpD0jX5ImGKFnz8h7JhiFpeueEVoCRtFitvf0lgHdJKF4MWsfH0X2DPc0ZBDK4035moiq7hnbwTOeN+X1w/aq2t2WK7IqP1XLckcWMDz7rglMn6v2lixq8l3yKobaJ4R2n5vsKfkkhhY2yUcG+1367RQ1sN1C0Qy1sza6vxAy/mniulrekdty2/3fmMUS9O6IfwO1KdvbZtWsm5tH8vm2aktyv7gvt1mk1y6oxeDPQc3jh6S6t8/2SabMqGDesA+1qeJeZ4wW9kZLIxD7H8AOX2+RM2iYwse5hL++rOpdWe8+lX8RGPEZYbZNMG/LVbmt7nZX5fYmG3vAZl8JFXbNsowrOdIlfYbv5f4P4se8CQplbmRzdHJlYW0KZW5kb2JqCjggMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GMQovQmFzZUZvbnQgL1RpbWVzLVJvbWFuCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCj4+CmVuZG9iago5IDAgb2JqCjw8IC9UeXBlIC9Gb250Ci9TdWJ0eXBlIC9UeXBlMQovTmFtZSAvRjIKL0Jhc2VGb250IC9IZWx2ZXRpY2EtQm9sZAovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZwo+PgplbmRvYmoKMTAgMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GMwovQmFzZUZvbnQgL1RpbWVzLUJvbGQKL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcKPj4KZW5kb2JqCjExIDAgb2JqCjw8IC9UeXBlIC9Bbm5vdAovU3VidHlwZSAvTGluawovQSAxMiAwIFIKL0JvcmRlciBbMCAwIDBdCi9IIC9JCi9SZWN0IFsgMTk5LjEzNzggMTguMjE4NSAzOTYuMTQyMiAyNy4wMTg1IF0KPj4KZW5kb2JqCjEyIDAgb2JqCjw8IC9UeXBlIC9BY3Rpb24KL1MgL1VSSQovVVJJIChodHRwczovL3Jlam9vc2UuY29tL3dwLWNvbnRlbnQvdXBsb2Fkcy8yMDIzLzA2L0V2b2ljZV9FeHBsYWluZXIucGRmKQo+PgplbmRvYmoKeHJlZgowIDEzCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAwOSAwMDAwMCBuIAowMDAwMDAwMDc0IDAwMDAwIG4gCjAwMDAwMDAxMjAgMDAwMDAgbiAKMDAwMDAwMDI5NSAwMDAwMCBuIAowMDAwMDAwMzI0IDAwMDAwIG4gCjAwMDAwMDA0OTcgMDAwMDAgbiAKMDAwMDAwMDYxOSAwMDAwMCBuIAowMDAwMDAzNTI5IDAwMDAwIG4gCjAwMDAwMDM2MzggMDAwMDAgbiAKMDAwMDAwMzc1MCAwMDAwMCBuIAowMDAwMDAzODU5IDAwMDAwIG4gCjAwMDAwMDM5ODUgMDAwMDAgbiAKdHJhaWxlcgo8PAovU2l6ZSAxMwovUm9vdCAxIDAgUgovSW5mbyA1IDAgUgovSURbPGQ0MjEyYTIwY2E1NTc3NTg1NGNiOWUyNmM3NGRiYjdiPjxkNDIxMmEyMGNhNTU3NzU4NTRjYjllMjZjNzRkYmI3Yj5dCj4+CnN0YXJ0eHJlZgo0MTA0CiUlRU9GCg==
carbon_intensity_gram: 123
total_kg_co2_eq: 1301.51
status: finalized
type: evoice
created_at: '2024-01-05T13:11:49.000000Z'
client:
name: 'Eco-Friendly Solutions Ltd'
vat_number: ECOF1234567
organization_id: EcoFriendly-4987
address: '100 Enviro Way'
address2: 'Sustainability Lane 3'
zip_code: ECO321
city: GreenVille
country: Denmark
country_code: DK
devices:
-
external_id: RE8989121
original_manufacturer_part_number: 62B6MAT3EU
quantity: 10
brand: Lenovo
model_name: 'ThinkPad T480'
category: Notebook
lifetime_months: 72
scope_2_kg_co2_eq: 278.41
scope_3_kg_co2_eq: 249.27
total_kg_co2_eq: 527.68
refurbished: true
avoided_emissions_kg_co2_eq: 256.68
-
external_id: SM-S918BZKDEEB
original_manufacturer_part_number: null
quantity: 10
brand: Samsung
model_name: 'Galaxy S23 Ultra'
category: Smartphone
lifetime_months: 30
scope_2_kg_co2_eq: 31.18
scope_3_kg_co2_eq: 742.65
total_kg_co2_eq: 773.83
refurbished: false
avoided_emissions_kg_co2_eq: 0
links:
self: 'https://app.rejoose.com/api/v3/evoices/123456789'
properties:
success:
type: boolean
example: true
data:
type: object
properties:
external_invoice_id:
type: string
example: '123456789'
external_invoice_date:
type: string
example: '2023-09-25'
country_code:
type: string
example: DK
supplier_contact:
type: string
example: example@rejoose.com
pdf_base64:
type: string
example: JVBERi0xLjcKMSAwIG9iago8PCAvVHlwZSAvQ2F0YWxvZwovT3V0bGluZXMgMiAwIFIKL1BhZ2VzIDMgMCBSID4+CmVuZG9iagoyIDAgb2JqCjw8IC9UeXBlIC9PdXRsaW5lcyAvQ291bnQgMCA+PgplbmRvYmoKMyAwIG9iago8PCAvVHlwZSAvUGFnZXMKL0tpZHMgWzYgMCBSCl0KL0NvdW50IDEKL1Jlc291cmNlcyA8PAovUHJvY1NldCA0IDAgUgovRm9udCA8PCAKL0YxIDggMCBSCi9GMiA5IDAgUgovRjMgMTAgMCBSCj4+Cj4+Ci9NZWRpYUJveCBbMC4wMDAgMC4wMDAgNTk1LjI4MCA4NDEuODkwXQogPj4KZW5kb2JqCjQgMCBvYmoKWy9QREYgL1RleHQgXQplbmRvYmoKNSAwIG9iago8PAovUHJvZHVjZXIgKP7/AGQAbwBtAHAAZABmACAAMgAuADAALgAzACAAKwAgAEMAUABEAEYpCi9DcmVhdGlvbkRhdGUgKEQ6MjAyNDAxMDUxMzIzMTArMDAnMDAnKQovTW9kRGF0ZSAoRDoyMDI0MDEwNTEzMjMxMCswMCcwMCcpCi9UaXRsZSAo/v8ARQB2AG8AaQBjAGUpCj4+CmVuZG9iago2IDAgb2JqCjw8IC9UeXBlIC9QYWdlCi9NZWRpYUJveCBbMC4wMDAgMC4wMDAgNTk1LjI4MCA4NDEuODkwXQovUGFyZW50IDMgMCBSCi9Bbm5vdHMgWyAxMSAwIFIgXQovQ29udGVudHMgNyAwIFIKPj4KZW5kb2JqCjcgMCBvYmoKPDwgL0ZpbHRlciAvRmxhdGVEZWNvZGUKL0xlbmd0aCAyODM3ID4+CnN0cmVhbQp4nK2b23LcNhKG7/UUqORmt0qiiQNxyNXGsezaHCqxpdhV6/LFaIaSGM2Q8gxlRy+VZ9wGB2iCHhIYU/aFytVmA/g/NNANCD75eMJ0xoUkSuRZLgTZEG/gpjOsSSFlZrgYszin0EKzorNgu97wjtQn8LnSJM9YYeCnEIq8eXUCH5DPJCc/k/eEfIC/rMJBKWMHFfZoLWtycfJ6pLntzcnzS+xbs0wpQS5X5NlLRrjt6PKakPf/elP+1TS7kvx4f/HvD+TyZ3J+af0KCi0yRZQUmZTcO4JVOcerRzJwYAV0m0ccXE+hE4wz01JEhnf+7FNTLQdOhVRZbqAnY7JCMeyJZblz+gc/x0mVhejg46TKgrvZ8EDHLOLAIt00YzPeMGNSZVFkbDCp3oKTmuck/DmcVJZnhso9AE4UQru8rXbEkSPLpm4XVU3a25K0TbtYk/tts3pYtmS52F41NSk31W5XNfUuhOy7sFTzkS6gwW15XW7Lemmb7Vq/rupFvaygh3a7qHeLZQutZsFccFNAUHEipQY4hlBFQQAlBUykKaDBDiLtlIY/ASKE0QFF35xiCkLOAEZR5BnnCi0W45QnNxq+026po4UWGYRy57kfsFLQA5UZg2YgQjQVhMKwqPHjnVp63Chwss4m4/CFYygz7Ri+WLTlD4jn9fHCgV1WaBUIx00hIdx6GskC4WgJhI952h4KUNh7omWADKfAIaPwrxqYHDAbjWxR0Ex33gEzGjC7KO/bcnNVbgnsN4TB9M8BiJEDgzPwWRA5zpKMHCcviJycw/fyy8jJYQuBBTQvcnKYzdwcRs5/6/3ahiX4tABC/RhACf19uHj9aAn0RwMIPdEyIIcz4cjNDKAQXRhAkl8vlTbLM2kWV2eiWOkzky/ZmaDi6roslGHs6kkhBcOmnIYh5SzJkHKC+5CSBvZHmKZhSEkDyRLanRVS0lia+WFI/fSwa5tNuX1aPKF4jKeE+D56vHhvCcVH4wk9vWWIzU+DxzYvngbcwng6XzZnL7dVWa/Wj+SiWT/YpLcjv7arp0SRHSwHCH0UeUsqirzMIIo0hAPVX0YRWI3UM6NIC/iCjkRR81C320coOlZPS209ACyNEgD6uPEA0BIAiEVS74mWATqcCoduZiSF7MJIevHLkyIGBlUYHkaMs8QixldjmonQ01mSseZABLHmKrsvYk2ajBozM9YUzHvORmJtX75WdVvWu6p9fFq8IT6MtwQ+9ER86JnAF8blHh9aAnzRSEVPtAzA9xO5Bz8zUkPyYaRSiJqbZ3fvbgPiySOohFMd5VjMBMc1f1Jpm34KE0cfyaAxmR+eS47YjoNWYBCswE29b+XtoiXf/0DOf/r9JWgVcOIc84ayhYsRbwqjPa8/VduGvFs8klPbDmd0pInCiEzwkSZebcuyflut1+UpeVHWm8X2buBu7MAFKXSRSc29f8CUhCTHpwUWp21jel4uHu7v11VYEkzOipEQrWJ6WiZuGdBvaiLKvxeb+3X5n+3eP1s2m/Bs7yQUWmaiWw69RXUWOLnD4ZLC0hqzyAMLd5a+HW+ZPN7zg8M9+gq/SLH9vSVxZeP9Yfnl/iZlMDGX3TH+1bs/khMj7AYApfV0WxSWOD0tyN0N+en3wTWLgF2A6e66hQWu/YUOG36u9honeyo/xmOSmSw3kghNATmDvUrD0KEF6B4UwJ51ffy27taXMLZNu6tTGJ6BndBbpnZYcFSMdp+5iHIG2HEV3Vcfh6PYw4aBa8PgUzh6aDFyantBvo8jwFEGDLQyAwZjo7Z+TJhAL4NZkzB7Kb3WU0Ku6gWj5QjFVMMxXRTTkv9wV01Vfd0kZt8P2EkvQBFPK2eQ/7TSgXLOYE+kKj3TNq4hvoKp9pYjlDPYGHiup5W/fljULVQlcdU4WKdawr8Dz5RqzkSmpQpVw2YGu2hSte2QCRaoRssRqrkQUNDZ5ZFneqwmu1g29yXh4cbABWwB3LYvMtZfZkCnzud9t/UwUn78kIDlNX4lLEiSWrIAlr12lnk6RGyHjKsQlrccAUvkUP3KIgVrsIsKqClyJr8BLNTYr6dCsyQsIWB8RRhZBcgwPL1z2g4ZDyMLLcfAkiCYimlYv1bXZVtthr8+gMXPeYzWpqnb210CFSr8uriybrABhqjcASCFynoWMtx00RKgih0AAk9vOQJyYdOi4tOQu8Ji+FsdOAJ0W+JXxaNiBeBVSsJPzYswu0uaSSX67A5mriP7u0vkMDW5VmEid5ZUIndz2idymF3jDmcf06OKnZO4PSBaZ2gZRnJ41ciey99+vOTnfwbnpHE4Pvm5cfjkF8A5vvTxGRGRhUkmigzzHzLzliG01Gij0KjcD2aKGs1TtFCP69+v1zm0MJP2tIIsE6PV501PCy0DWsnRRmnZ+h2cJmlB1XfKk8C8pG8BzGdTBBZmmigwzJ0IzFuGwFKjjd5dwKKk0kSAKX0qUsBQUh/hXfKcAwwzKgIL800MWJ8/PTC0DIAlRxsFZuR+MFPAFEvRQj3fILwwqfa0fFJN0OpTqKeFloBWNKn2nt4y4JzUGeNcCMjYsWxRMHWqUqgx+wUJqzsgzmGNp0ZkHR7CYqz7M6InhpYBsfRwY8hohwy8FcuUkSM1YVk3n5qwXkEXaQ8qI5Qvb6v67m1l3zuQcybOQGxQt1BYp3kmC8udwTnHnfVAk7RFOTRqV7JrVGMR9GbOzbOvbAANMyasbJwlVdk4pn1lI+xFnvyisrG3OFrOrGyE7kZ0+Fv4384uDNXP//fLi/Pz57PU+yoF5Yd5MiofaxLU7y1DAD6WHYF5VcoUgUGV8vXVRq86SHYx1X1t4VWjZaAaKTrV86qNKdVKsFM5S7ivGlB4mLSiwrFGQOHeMhTuQc4RLvj+6dekcE5P2RzdmPxRd5hEYrr7VO91o2WgGzn2YT4j+U/qnhXmmMR71T6JJ1T3KdurRkugOprEe09vGfBC/nPiBJP45AJR/FTPQYa5GJGFp6wYsj7zeuFoGQjH9BJkhBm5uOBgHXnMdrHY7B7qm9FkLERm9AitV4v14u9HcsE4+XPdbhfJY7LLabbGp6rPafhbzRm/IbCPcikN06+zRNJv5wiDge0wdHSWVN52/Pu8DX5cqi/y9qTG6O/MXd6G7YyxkUc+3f3O7ugiMxhDFylzOGNgI+gwMcdAoyeSRs8E6XAB7FGjZcA6LdTCTt3ZOGdfX8wKRl8NIaQwj0ej0XsiJPRMhWNQNbl49JZhQKZ0HlVHTUUkO/62x/XvN+w5nLH+6jkHZUOMM3r2nL1ngnNYp+05o2XAOanzqMptirMx9NQcfU/0LVD7ig9Rh5VKFLX3RNTomUIdVIYOtbcMUad0HnXDNIWa52ZQJMdvmPpV1ZVtc1BjkYmowyInhho9ETV6JlCHxegeNVoGqJM6IzssjuUbhCOWpD0jX5ImGKFnz8h7JhiFpeueEVoCRtFitvf0lgHdJKF4MWsfH0X2DPc0ZBDK4035moiq7hnbwTOeN+X1w/aq2t2WK7IqP1XLckcWMDz7rglMn6v2lixq8l3yKobaJ4R2n5vsKfkkhhY2yUcG+1367RQ1sN1C0Qy1sza6vxAy/mniulrekdty2/3fmMUS9O6IfwO1KdvbZtWsm5tH8vm2aktyv7gvt1mk1y6oxeDPQc3jh6S6t8/2SabMqGDesA+1qeJeZ4wW9kZLIxD7H8AOX2+RM2iYwse5hL++rOpdWe8+lX8RGPEZYbZNMG/LVbmt7nZX5fYmG3vAZl8JFXbNsowrOdIlfYbv5f4P4se8CQplbmRzdHJlYW0KZW5kb2JqCjggMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GMQovQmFzZUZvbnQgL1RpbWVzLVJvbWFuCi9FbmNvZGluZyAvV2luQW5zaUVuY29kaW5nCj4+CmVuZG9iago5IDAgb2JqCjw8IC9UeXBlIC9Gb250Ci9TdWJ0eXBlIC9UeXBlMQovTmFtZSAvRjIKL0Jhc2VGb250IC9IZWx2ZXRpY2EtQm9sZAovRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZwo+PgplbmRvYmoKMTAgMCBvYmoKPDwgL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9OYW1lIC9GMwovQmFzZUZvbnQgL1RpbWVzLUJvbGQKL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcKPj4KZW5kb2JqCjExIDAgb2JqCjw8IC9UeXBlIC9Bbm5vdAovU3VidHlwZSAvTGluawovQSAxMiAwIFIKL0JvcmRlciBbMCAwIDBdCi9IIC9JCi9SZWN0IFsgMTk5LjEzNzggMTguMjE4NSAzOTYuMTQyMiAyNy4wMTg1IF0KPj4KZW5kb2JqCjEyIDAgb2JqCjw8IC9UeXBlIC9BY3Rpb24KL1MgL1VSSQovVVJJIChodHRwczovL3Jlam9vc2UuY29tL3dwLWNvbnRlbnQvdXBsb2Fkcy8yMDIzLzA2L0V2b2ljZV9FeHBsYWluZXIucGRmKQo+PgplbmRvYmoKeHJlZgowIDEzCjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAwOSAwMDAwMCBuIAowMDAwMDAwMDc0IDAwMDAwIG4gCjAwMDAwMDAxMjAgMDAwMDAgbiAKMDAwMDAwMDI5NSAwMDAwMCBuIAowMDAwMDAwMzI0IDAwMDAwIG4gCjAwMDAwMDA0OTcgMDAwMDAgbiAKMDAwMDAwMDYxOSAwMDAwMCBuIAowMDAwMDAzNTI5IDAwMDAwIG4gCjAwMDAwMDM2MzggMDAwMDAgbiAKMDAwMDAwMzc1MCAwMDAwMCBuIAowMDAwMDAzODU5IDAwMDAwIG4gCjAwMDAwMDM5ODUgMDAwMDAgbiAKdHJhaWxlcgo8PAovU2l6ZSAxMwovUm9vdCAxIDAgUgovSW5mbyA1IDAgUgovSURbPGQ0MjEyYTIwY2E1NTc3NTg1NGNiOWUyNmM3NGRiYjdiPjxkNDIxMmEyMGNhNTU3NzU4NTRjYjllMjZjNzRkYmI3Yj5dCj4+CnN0YXJ0eHJlZgo0MTA0CiUlRU9GCg==
carbon_intensity_gram:
type: integer
example: 123
total_kg_co2_eq:
type: number
example: 1301.51
status:
type: string
example: finalized
type:
type: string
example: evoice
created_at:
type: string
example: '2024-01-05T13:11:49.000000Z'
client:
type: object
properties:
name:
type: string
example: 'Eco-Friendly Solutions Ltd'
vat_number:
type: string
example: ECOF1234567
organization_id:
type: string
example: EcoFriendly-4987
address:
type: string
example: '100 Enviro Way'
address2:
type: string
example: 'Sustainability Lane 3'
zip_code:
type: string
example: ECO321
city:
type: string
example: GreenVille
country:
type: string
example: Denmark
country_code:
type: string
example: DK
devices:
type: array
example:
-
external_id: RE8989121
original_manufacturer_part_number: 62B6MAT3EU
quantity: 10
brand: Lenovo
model_name: 'ThinkPad T480'
category: Notebook
lifetime_months: 72
scope_2_kg_co2_eq: 278.41
scope_3_kg_co2_eq: 249.27
total_kg_co2_eq: 527.68
refurbished: true
avoided_emissions_kg_co2_eq: 256.68
-
external_id: SM-S918BZKDEEB
original_manufacturer_part_number: null
quantity: 10
brand: Samsung
model_name: 'Galaxy S23 Ultra'
category: Smartphone
lifetime_months: 30
scope_2_kg_co2_eq: 31.18
scope_3_kg_co2_eq: 742.65
total_kg_co2_eq: 773.83
refurbished: false
avoided_emissions_kg_co2_eq: 0
items:
type: object
properties:
external_id:
type: string
example: RE8989121
original_manufacturer_part_number:
type: string
example: 62B6MAT3EU
quantity:
type: integer
example: 10
brand:
type: string
example: Lenovo
model_name:
type: string
example: 'ThinkPad T480'
category:
type: string
example: Notebook
lifetime_months:
type: integer
example: 72
scope_2_kg_co2_eq:
type: number
example: 278.41
scope_3_kg_co2_eq:
type: number
example: 249.27
total_kg_co2_eq:
type: number
example: 527.68
refurbished:
type: boolean
example: true
avoided_emissions_kg_co2_eq:
type: number
example: 256.68
links:
type: object
properties:
self:
type: string
example: 'https://app.rejoose.com/api/v3/evoices/123456789'
202:
description: 'The e.voice is still processing'
content:
application/json:
schema:
type: object
example:
success: true
data:
external_invoice_id: 94825344-eb3a-4b5d-8ac8-6e462f37bba2
status: pending
properties:
success:
type: boolean
example: true
data:
type: object
properties:
external_invoice_id:
type: string
example: 94825344-eb3a-4b5d-8ac8-6e462f37bba2
status:
type: string
example: pending
404:
description: ''
content:
application/json:
schema:
type: object
example:
errors: 'Evoice with external_invoice_id 3.1415926535 not found'
properties:
errors:
type: string
example: 'Evoice with external_invoice_id 3.1415926535 not found'
tags:
- e.voice
parameters:
-
in: path
name: external_invoice_id
description: 'The `external_invoice_id` of the e.voice.'
example: '123456789'
required: true
schema:
type: string
/api/v3/evoices/circularity/generate:
post:
summary: 'POST e.voice circularity'
operationId: pOSTEvoiceCircularity
description: 'Generates the e.voice circularity'
parameters: []
responses:
201:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 31
external_doc_id: ab57e0f1-2396-430c-ba5a-339d77fda792
external_doc_date: '2024-01-22'
country_code: DK
batch_id: batch-123-example
e_waste_kg_co2_eq: 212.81
refurbishment_impact_kg_co2_eq: 180.42866
refurbishment_offset_kg_co2_eq: 3053.34679
client:
name: 'Rejoose ApS'
organization_id: rejoose_aps
vat_number: '39121506'
address: 'Finsensvej 78'
address2: 'Finsensvej 78'
zip_code: '2000'
city: Frederiksberg
country: Denmark
country_code: DK
devices:
-
external_id: X220-DEHO
amount: 5
brand: LENOVO
model_name: 'Lenovo X220'
category: Laptop
weight_kg: 2
refurbishment_impact_percentage: 0.0516
refurbishment_impact_kg_co2_eq: 75.08832
refurbishment_offset_kg_co2_eq: 1380.11168
refurbishment_avoided_e_waste_kg: 10
recycling_avoided_e_waste_kg: 0
recycling_avoided_emissions_kg_co2_eq: 0
-
external_id: X3T23AV
amount: 2
brand: HP
model_name: 'HP EliteBook 820 G4'
category: Notebook
weight_kg: null
recycled: true
refurbishment_impact_percentage: 0.0516
refurbishment_impact_kg_co2_eq: 0
refurbishment_offset_kg_co2_eq: 0
refurbishment_avoided_e_waste_kg: 0
recycling_avoided_e_waste_kg: 2.59
recycling_avoided_emissions_kg_co2_eq: 52.404
created_at: '2024-01-24T11:33:10.000000Z'
links:
self: 'https://app.rejoose.com/api/v3/evoices/circularity/ab57e0f1-2396-430c-ba5a-339d77fda792'
pdf: 'https://app.rejoose.com/api/v3/evoices/circularity/ab57e0f1-2396-430c-ba5a-339d77fda792/pdf'
base_64_pdf: 'https://app.rejoose.com/api/v3/evoices/circularity/ab57e0f1-2396-430c-ba5a-339d77fda792/pdf?base64=1'
errors: null
properties:
data:
type: object
properties:
id:
type: integer
example: 31
external_doc_id:
type: string
example: ab57e0f1-2396-430c-ba5a-339d77fda792
external_doc_date:
type: string
example: '2024-01-22'
country_code:
type: string
example: DK
batch_id:
type: string
example: batch-123-example
e_waste_kg_co2_eq:
type: number
example: 212.81
refurbishment_impact_kg_co2_eq:
type: number
example: 180.42866
refurbishment_offset_kg_co2_eq:
type: number
example: 3053.34679
client:
type: object
properties:
name:
type: string
example: 'Rejoose ApS'
organization_id:
type: string
example: rejoose_aps
vat_number:
type: string
example: '39121506'
address:
type: string
example: 'Finsensvej 78'
address2:
type: string
example: 'Finsensvej 78'
zip_code:
type: string
example: '2000'
city:
type: string
example: Frederiksberg
country:
type: string
example: Denmark
country_code:
type: string
example: DK
devices:
type: array
example:
-
external_id: X220-DEHO
amount: 5
brand: LENOVO
model_name: 'Lenovo X220'
category: Laptop
weight_kg: 2
refurbishment_impact_percentage: 0.0516
refurbishment_impact_kg_co2_eq: 75.08832
refurbishment_offset_kg_co2_eq: 1380.11168
refurbishment_avoided_e_waste_kg: 10
recycling_avoided_e_waste_kg: 0
recycling_avoided_emissions_kg_co2_eq: 0
-
external_id: X3T23AV
amount: 2
brand: HP
model_name: 'HP EliteBook 820 G4'
category: Notebook
weight_kg: null
recycled: true
refurbishment_impact_percentage: 0.0516
refurbishment_impact_kg_co2_eq: 0
refurbishment_offset_kg_co2_eq: 0
refurbishment_avoided_e_waste_kg: 0
recycling_avoided_e_waste_kg: 2.59
recycling_avoided_emissions_kg_co2_eq: 52.404
items:
type: object
properties:
external_id:
type: string
example: X220-DEHO
amount:
type: integer
example: 5
brand:
type: string
example: LENOVO
model_name:
type: string
example: 'Lenovo X220'
category:
type: string
example: Laptop
weight_kg:
type: integer
example: 2
refurbishment_impact_percentage:
type: number
example: 0.0516
refurbishment_impact_kg_co2_eq:
type: number
example: 75.08832
refurbishment_offset_kg_co2_eq:
type: number
example: 1380.11168
refurbishment_avoided_e_waste_kg:
type: integer
example: 10
recycling_avoided_e_waste_kg:
type: integer
example: 0
recycling_avoided_emissions_kg_co2_eq:
type: integer
example: 0
created_at:
type: string
example: '2024-01-24T11:33:10.000000Z'
links:
type: object
properties:
self:
type: string
example: 'https://app.rejoose.com/api/v3/evoices/circularity/ab57e0f1-2396-430c-ba5a-339d77fda792'
pdf:
type: string
example: 'https://app.rejoose.com/api/v3/evoices/circularity/ab57e0f1-2396-430c-ba5a-339d77fda792/pdf'
base_64_pdf:
type: string
example: 'https://app.rejoose.com/api/v3/evoices/circularity/ab57e0f1-2396-430c-ba5a-339d77fda792/pdf?base64=1'
errors:
type: string
example: null
422:
description: 'Validation Error'
content:
application/json:
schema:
type: object
example:
data: null
errors:
external_doc_id:
- 'The external doc id field is required.'
external_doc_date:
- 'The external doc date field is required.'
client.name:
- 'The client.name field is required.'
properties:
data:
type: string
example: null
errors:
type: object
properties:
external_doc_id:
type: array
example:
- 'The external doc id field is required.'
items:
type: string
external_doc_date:
type: array
example:
- 'The external doc date field is required.'
items:
type: string
client.name:
type: array
example:
- 'The client.name field is required.'
items:
type: string
429:
description: 'Too Many Attempts'
content:
application/json:
schema:
type: object
example:
message: 'Too Many Attempts.'
properties:
message:
type: string
example: 'Too Many Attempts.'
tags:
- 'e.voice - circularity'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
external_doc_id:
type: string
description: 'A unique identifier linking the e.voice circularity to the associated document, such as a purchase order or credit note. This may also refer to any other unique identifier. Must not exceed 255 characters.'
example: '123456789.'
nullable: false
external_doc_date:
type: string
description: 'The date of the document, such as a purchase order or credit note, following the invoicing date in ISO 8601 format (YYYY-MM-DD). Must be a valid date.'
example: 2023-09-25.
nullable: false
e_waste_kg:
type: integer
description: 'Weight of non-recycled electronics in kilograms, used for calculating the carbon emissions related to e-waste. Must be a minimum of 0.'
example: 10
nullable: false
country_code:
type: string
description: "The country code from which the products are sent, following the ISO 3166-2 or ISO 3166-2 alpha-2 standard. US states must include the 'US-' prefix."
example: GB.
nullable: false
supplier_contact:
type: string
description: 'Supplier contact email address, visible to the customer on the e.voice circularity. This can be a person or a general mailbox. Must be between 1 and 80 characters.'
example: example@rejoose.com.
nullable: false
batch_id:
type: string
description: 'An optional identifier for grouping multiple e.voice circularities together for reporting and filtering purposes. This allows you to organize and track related circularities as a batch.'
example: batch-2024-Q1-electronics.
nullable: false
client:
type: object
description: 'Client information object. Within this client information object, are two crucial identifiers that greatly impact reporting. The `organization_id`, which identifies your customer on a group level, and the `vat_number`, which defines the company within the organization. We recommend using unique and static values for `organization_id` as they are utilized by the e.hub and e.insights reporting portals to group and aggregate data.'
example:
name: 'Eco-Friendly Solutions Ltd'
vat_number: ECOF1234567
organization_id: EcoFriendly-4987
address: '100 Enviro Way'
address2: 'Sustainability Lane 3'
zip_code: ECO321
city: GreenVille
country: Denmark
country_code: DK
nullable: false
properties:
name:
type: string
description: 'The name of the customer as on the invoice. This line will be shown on the e.voice circularity. Can be made anonymous by e.g., inserting a dash instead (-) or similar. Must be between 1 and 80 characters.'
example: 'Eco-Friendly Solutions Ltd'
nullable: false
organization_id:
type: string
description: 'An identifier for the client group/organization in your system. This identifier is important as it is used to aggregate reporting functions at group level for the customer with several companies in the group (VAT numbers). Must be between 1 and 240 characters.'
example: company-4987
nullable: false
vat_number:
type: string
description: 'This defines the company, and as with `organization_id` is used for reporting purposes. We recommend this to be the VAT number but could be another unique identifier. Must be between 1 and 80 characters.'
example: ECOF1234567
nullable: false
address:
type: string
description: 'The address of the customer as on the invoice. This line will be shown on the e.voice circularity. Can be made anonymous by e.g., inserting a dash instead (-) or similar. Must be between 1 and 80 characters.'
example: '100 Enviro Way'
nullable: false
address2:
type: string
description: 'The second line of the address of the customer as on the invoice. Must be between 1 and 80 characters.'
example: 'Sustainability Lane 3'
nullable: false
zip_code:
type: string
description: 'The zip code of the customer as on the invoice. This line will be shown on the e.voice circularity. Can be made anonymous by e.g., inserting a dash instead (-) or similar. Must be between 1 and 80 characters.'
example: ECO321
nullable: false
city:
type: string
description: 'The city of the customer as on the invoice. This line will be shown on the e.voice circularity. Can be made anonymous by e.g., inserting a dash instead (-) or similar. Must be between 1 and 80 characters.'
example: GreenVille
nullable: false
country:
type: string
description: 'The country of the customer as on the invoice. This line will be shown on the e.voice circularity. Can be made anonymous by e.g., inserting a dash instead (-) or similar. Must be between 1 and 80 characters.'
example: Denmark
nullable: false
country_code:
type: string
description: 'The country code of the customer as on the invoice. Should be ISO 3166-2 or ISO 3166-2:US - alpha-2 code.'
example: DK
nullable: false
required:
- name
- organization_id
- vat_number
- address
- zip_code
- city
- country
- country_code
devices:
type: array
description: 'Array of devices.'
example:
- []
items:
type: object
properties:
external_id:
type: string
description: "Provide the product's original manufacturer part number (MPN)."
example: RE8989121
nullable: false
quantity:
type: integer
description: 'Number of units.'
example: 10
nullable: false
category:
type: string
description: 'The category information serves two purposes: together with the `external_id` and `brand`, it provides a 100% unique data set for secure product matching. In the absence of LCA data, the system can provide CA data for the brand/category. Must be between 1 and 80 characters.'
example: Notebook
nullable: false
brand:
type: string
description: 'The name of the manufacturer of the product. This information, together with the `external_id` (MPN) and `category`, provides a unique data set to match carbon data to the specific product. Must be between 1 and 80 characters.'
example: Lenovo
nullable: false
model_name:
type: string
description: 'Product model name.'
example: 'ThinkPad T480'
nullable: false
excluded:
type: boolean
description: "Use this if you want to exclude this product's carbon footprint and avoided emissions data from the e.voice circularity. Use cases could include products with no carbon footprint or products where the footprint has already been accounted for elsewhere. This defaults to false."
example: false
nullable: false
recycled:
type: boolean
description: 'Use this to indicate whether the device has been recycled. This can be used for tracking and reporting purposes related to circular economy metrics. This defaults to false.'
example: true
nullable: false
required:
- external_id
- quantity
- category
- brand
- model_name
required:
- external_doc_id
- external_doc_date
- country_code
- supplier_contact
- client
- devices
'/api/v3/evoices/circularity/{external_doc_id}/pdf':
get:
summary: 'GET e.voices circularity PDF'
operationId: gETEvoicesCircularityPDF
description: 'Returns the e.voice circularity PDF'
parameters: []
responses:
200:
description: ''
content:
text/plain:
schema:
type: string
example: 'application/pdf The PDF file'
404:
description: ''
content:
application/json:
schema:
type: object
example:
data: null
errors:
not_found:
- 'Evoice Circularity with external document id 1 not found for your partner'
properties:
data:
type: string
example: null
errors:
type: object
properties:
not_found:
type: array
example:
- 'Evoice Circularity with external document id 1 not found for your partner'
items:
type: string
tags:
- 'e.voice - circularity'
parameters:
-
in: path
name: external_doc_id
description: 'The external document ID.'
example: ab57e0f1-2396-430c-ba5a-339d77fda792
required: true
schema:
type: string
'/api/v3/evoices/circularity/{external_doc_id}':
get:
summary: 'GET e.voice circularity data'
operationId: gETEvoiceCircularityData
description: 'Returns the e.voice circularity data'
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
id: 31
external_doc_id: ab57e0f1-2396-430c-ba5a-339d77fda792
external_doc_date: '2024-01-22'
country_code: DK
batch_id: batch-123-example
e_waste_kg_co2_eq: 212.81
refurbishment_impact_kg_co2_eq: 180.42866
refurbishment_offset_kg_co2_eq: 3053.34679
client:
name: 'Rejoose ApS'
organization_id: rejoose_aps
vat_number: '39121506'
address: 'Finsensvej 78'
address2: 'Finsensvej 78'
zip_code: '2000'
city: Frederiksberg
country: Denmark
country_code: DK
devices:
-
external_id: X220-DEHO
amount: 5
brand: LENOVO
model_name: 'Lenovo X220'
category: Laptop
weight_kg: 2
refurbishment_impact_percentage: 0.0516
refurbishment_impact_kg_co2_eq: 75.08832
refurbishment_offset_kg_co2_eq: 1380.11168
refurbishment_avoided_e_waste_kg: 10
recycling_avoided_e_waste_kg: 0
recycling_avoided_emissions_kg_co2_eq: 0
-
external_id: X3T23AV
amount: 2
brand: HP
model_name: 'HP EliteBook 820 G4'
category: Notebook
weight_kg: null
recycled: true
refurbishment_impact_percentage: 0.0516
refurbishment_impact_kg_co2_eq: 0
refurbishment_offset_kg_co2_eq: 0
refurbishment_avoided_e_waste_kg: 0
recycling_avoided_e_waste_kg: 2.59
recycling_avoided_emissions_kg_co2_eq: 52.404
created_at: '2024-01-24T11:33:10.000000Z'
links:
self: 'https://app.rejoose.com/api/v3/evoices/circularity/ab57e0f1-2396-430c-ba5a-339d77fda792'
pdf: 'https://app.rejoose.com/api/v3/evoices/circularity/ab57e0f1-2396-430c-ba5a-339d77fda792/pdf'
base_64_pdf: 'https://app.rejoose.com/api/v3/evoices/circularity/ab57e0f1-2396-430c-ba5a-339d77fda792/pdf?base64=1'
errors: null
properties:
data:
type: object
properties:
id:
type: integer
example: 31
external_doc_id:
type: string
example: ab57e0f1-2396-430c-ba5a-339d77fda792
external_doc_date:
type: string
example: '2024-01-22'
country_code:
type: string
example: DK
batch_id:
type: string
example: batch-123-example
e_waste_kg_co2_eq:
type: number
example: 212.81
refurbishment_impact_kg_co2_eq:
type: number
example: 180.42866
refurbishment_offset_kg_co2_eq:
type: number
example: 3053.34679
client:
type: object
properties:
name:
type: string
example: 'Rejoose ApS'
organization_id:
type: string
example: rejoose_aps
vat_number:
type: string
example: '39121506'
address:
type: string
example: 'Finsensvej 78'
address2:
type: string
example: 'Finsensvej 78'
zip_code:
type: string
example: '2000'
city:
type: string
example: Frederiksberg
country:
type: string
example: Denmark
country_code:
type: string
example: DK
devices:
type: array
example:
-
external_id: X220-DEHO
amount: 5
brand: LENOVO
model_name: 'Lenovo X220'
category: Laptop
weight_kg: 2
refurbishment_impact_percentage: 0.0516
refurbishment_impact_kg_co2_eq: 75.08832
refurbishment_offset_kg_co2_eq: 1380.11168
refurbishment_avoided_e_waste_kg: 10
recycling_avoided_e_waste_kg: 0
recycling_avoided_emissions_kg_co2_eq: 0
-
external_id: X3T23AV
amount: 2
brand: HP
model_name: 'HP EliteBook 820 G4'
category: Notebook
weight_kg: null
recycled: true
refurbishment_impact_percentage: 0.0516
refurbishment_impact_kg_co2_eq: 0
refurbishment_offset_kg_co2_eq: 0
refurbishment_avoided_e_waste_kg: 0
recycling_avoided_e_waste_kg: 2.59
recycling_avoided_emissions_kg_co2_eq: 52.404
items:
type: object
properties:
external_id:
type: string
example: X220-DEHO
amount:
type: integer
example: 5
brand:
type: string
example: LENOVO
model_name:
type: string
example: 'Lenovo X220'
category:
type: string
example: Laptop
weight_kg:
type: integer
example: 2
refurbishment_impact_percentage:
type: number
example: 0.0516
refurbishment_impact_kg_co2_eq:
type: number
example: 75.08832
refurbishment_offset_kg_co2_eq:
type: number
example: 1380.11168
refurbishment_avoided_e_waste_kg:
type: integer
example: 10
recycling_avoided_e_waste_kg:
type: integer
example: 0
recycling_avoided_emissions_kg_co2_eq:
type: integer
example: 0
created_at:
type: string
example: '2024-01-24T11:33:10.000000Z'
links:
type: object
properties:
self:
type: string
example: 'https://app.rejoose.com/api/v3/evoices/circularity/ab57e0f1-2396-430c-ba5a-339d77fda792'
pdf:
type: string
example: 'https://app.rejoose.com/api/v3/evoices/circularity/ab57e0f1-2396-430c-ba5a-339d77fda792/pdf'
base_64_pdf:
type: string
example: 'https://app.rejoose.com/api/v3/evoices/circularity/ab57e0f1-2396-430c-ba5a-339d77fda792/pdf?base64=1'
errors:
type: string
example: null
404:
description: ''
content:
application/json:
schema:
type: object
example:
data: null
errors:
not_found:
- 'Evoice Circularity with external document id 1 not found for your partner'
properties:
data:
type: string
example: null
errors:
type: object
properties:
not_found:
type: array
example:
- 'Evoice Circularity with external document id 1 not found for your partner'
items:
type: string
tags:
- 'e.voice - circularity'
parameters:
-
in: path
name: external_doc_id
description: 'The external document ID.'
example: ab57e0f1-2396-430c-ba5a-339d77fda792
required: true
schema:
type: string
/api/v3/products:
get:
summary: 'GET e.product'
operationId: gETEproduct
description: 'The GET endpoint returns the carbon footprint data of a single product.'
parameters:
-
in: query
name: manufacture_part_number
description: 'The unique manufacturer part number (SKU/MPN) provided by the vendor or distributor, or an internal part number.'
example: 286H8AA
required: true
schema:
type: string
description: 'The unique manufacturer part number (SKU/MPN) provided by the vendor or distributor, or an internal part number.'
example: 286H8AA
nullable: false
-
in: query
name: brand
description: "The product manufacturer's name. Used together with the MPN and category to ensure a unique data match."
example: 'HP Inc'
required: true
schema:
type: string
description: "The product manufacturer's name. Used together with the MPN and category to ensure a unique data match."
example: 'HP Inc'
nullable: false
-
in: query
name: category
description: 'Used alongside the external ID and brand to ensure accurate product matching. Also enables the system to provide carbon data for the category when specific LCA data is unavailable.'
example: 'Docking station'
required: true
schema:
type: string
description: 'Used alongside the external ID and brand to ensure accurate product matching. Also enables the system to provide carbon data for the category when specific LCA data is unavailable.'
example: 'Docking station'
nullable: false
-
in: query
name: country_code
description: 'The ISO 3166-2 (or ISO 3166-2:US) alpha-2 code representing the country where the product is typically used. Determines the carbon intensity used in calculations.'
example: DK
required: true
schema:
type: string
description: 'The ISO 3166-2 (or ISO 3166-2:US) alpha-2 code representing the country where the product is typically used. Determines the carbon intensity used in calculations.'
example: DK
nullable: false
-
in: query
name: refurbished
description: 'optional Indicates whether the product is refurbished (pre-owned). A value of 1 denotes a refurbished product.'
example: 1
required: false
schema:
type: integer
description: 'optional Indicates whether the product is refurbished (pre-owned). A value of 1 denotes a refurbished product.'
example: 1
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'NOTE: refurbishment_impact_kg_co2_eq and refurbishment_offset_kg_co2_eq will only be included when product is refurbished'
type: object
example:
data:
manufacture_part_number: 286H8AA
brand: 'HP Inc'
category: 'Docking station'
country_code: DK
refurbished: true
data_match: true
data_method: CA
total_kg_co2_eq: 33.32004288
carbon_intensity_gram: 123.42
lifetime_month: 48
refurbishment_impact_kg_co2_eq: 3.457734144
refurbishment_offset_kg_co2_eq: 28.03242874
errors: null
properties:
data:
type: object
properties:
manufacture_part_number:
type: string
example: 286H8AA
brand:
type: string
example: 'HP Inc'
category:
type: string
example: 'Docking station'
country_code:
type: string
example: DK
refurbished:
type: boolean
example: true
data_match:
type: boolean
example: true
data_method:
type: string
example: CA
total_kg_co2_eq:
type: number
example: 33.32004288
carbon_intensity_gram:
type: number
example: 123.42
lifetime_month:
type: integer
example: 48
refurbishment_impact_kg_co2_eq:
type: number
example: 3.457734144
refurbishment_offset_kg_co2_eq:
type: number
example: 28.03242874
errors:
type: string
example: null
-
description: "NOTE: Requires 'e.product-plus' to retrieve detailed LCA (Life Cycle Assessment) data."
type: object
example:
data:
manufacture_part_number: 286H8AA
brand: 'HP Inc'
category: 'Docking station'
country_code: DK
refurbished: false
data_match: true
data_method: CA
total_kg_co2_eq: 40.23551117
manufacturing_kg_co2_eq: 29.86230874
transportation_kg_co2_eq: 5.457734144
use_kg_co2_eq: 3.457734144
end_of_life_kg_co2_eq: 1.457734144
carbon_intensity_gram: 123.42
lifetime_month: 48
refurbishment_impact_kg_co2_eq: null
refurbishment_offset_kg_co2_eq: null
errors: null
properties:
data:
type: object
properties:
manufacture_part_number:
type: string
example: 286H8AA
brand:
type: string
example: 'HP Inc'
category:
type: string
example: 'Docking station'
country_code:
type: string
example: DK
refurbished:
type: boolean
example: false
data_match:
type: boolean
example: true
data_method:
type: string
example: CA
total_kg_co2_eq:
type: number
example: 40.23551117
manufacturing_kg_co2_eq:
type: number
example: 29.86230874
transportation_kg_co2_eq:
type: number
example: 5.457734144
use_kg_co2_eq:
type: number
example: 3.457734144
end_of_life_kg_co2_eq:
type: number
example: 1.457734144
carbon_intensity_gram:
type: number
example: 123.42
lifetime_month:
type: integer
example: 48
refurbishment_impact_kg_co2_eq:
type: string
example: null
refurbishment_offset_kg_co2_eq:
type: string
example: null
errors:
type: string
example: null
-
description: 'NOTE: The carbon data will be null when no product was found'
type: object
example:
data:
manufacture_part_number: 286H8AA
brand: 'HP Inc'
category: 'Docking station'
country_code: DK
refurbished: true
data_match: false
data_method: null
total_kg_co2_eq: null
carbon_intensity_gram: null
lifetime_month: null
refurbishment_impact_kg_co2_eq: null
refurbishment_offset_kg_co2_eq: null
errors: null
properties:
data:
type: object
properties:
manufacture_part_number:
type: string
example: 286H8AA
brand:
type: string
example: 'HP Inc'
category:
type: string
example: 'Docking station'
country_code:
type: string
example: DK
refurbished:
type: boolean
example: true
data_match:
type: boolean
example: false
data_method:
type: string
example: null
total_kg_co2_eq:
type: string
example: null
carbon_intensity_gram:
type: string
example: null
lifetime_month:
type: string
example: null
refurbishment_impact_kg_co2_eq:
type: string
example: null
refurbishment_offset_kg_co2_eq:
type: string
example: null
errors:
type: string
example: null
422:
description: ''
content:
application/json:
schema:
type: object
example:
data: null
errors:
manufacture_part_number:
- 'The manufacture part number field is required.'
brand:
- 'The brand field is required.'
category:
- 'The category field is required.'
refurbished:
- 'The refurbished field must not be greater than 1.'
properties:
data:
type: string
example: null
errors:
type: object
properties:
manufacture_part_number:
type: array
example:
- 'The manufacture part number field is required.'
items:
type: string
brand:
type: array
example:
- 'The brand field is required.'
items:
type: string
category:
type: array
example:
- 'The category field is required.'
items:
type: string
refurbished:
type: array
example:
- 'The refurbished field must not be greater than 1.'
items:
type: string
tags:
- e.product
post:
summary: 'POST e.product'
operationId: pOSTEproduct
description: "
e.product – Batch Product-Level Carbon Footprint API
\n\n
The e.product API allows you to retrieve carbon footprint data for multiple products in a single request, making it efficient for e-commerce, quotations, and bulk assessments. This minimizes processing time and optimizes performance when extracting carbon data at scale.
\n\n
Batch Processing
\n\n
\n
You can send between 1 and 100 products per request to streamline large-scale data extractions.
\n
Each product must be identified using a combination of Brand name, Manufacturer Part Number (MPN), and Country code to ensure accuracy.
\n
For larger datasets, consider splitting the request into multiple batches.
\n
\n\n
You can access more detailed information in the API documentation by expanding objects marked with a small black arrow (⯈), such as ⯈ client or ⯈ devices. Simply click the arrow to reveal additional data fields.
"
parameters: []
responses:
200:
description: ''
content:
application/json:
schema:
oneOf:
-
description: 'Note: refurbishment_impact_kg_co2_eq and refurbishment_offset_kg_co2_eq will only be included when product is refurbished'
type: object
example:
data:
-
manufacture_part_number: 286H8AA
brand: 'HP Inc'
category: 'Docking station'
country_code: DK
refurbished: true
data_match: true
data_method: CA+
total_kg_co2_eq: 3.7941664
carbon_intensity_gram: 103
lifetime_month: 48
refurbishment_impact_kg_co2_eq: 0.3267312
refurbishment_offset_kg_co2_eq: 6.0052688
errors: null
properties:
data:
type: array
example:
-
manufacture_part_number: 286H8AA
brand: 'HP Inc'
category: 'Docking station'
country_code: DK
refurbished: true
data_match: true
data_method: CA+
total_kg_co2_eq: 3.7941664
carbon_intensity_gram: 103
lifetime_month: 48
refurbishment_impact_kg_co2_eq: 0.3267312
refurbishment_offset_kg_co2_eq: 6.0052688
items:
type: object
properties:
manufacture_part_number:
type: string
example: 286H8AA
brand:
type: string
example: 'HP Inc'
category:
type: string
example: 'Docking station'
country_code:
type: string
example: DK
refurbished:
type: boolean
example: true
data_match:
type: boolean
example: true
data_method:
type: string
example: CA+
total_kg_co2_eq:
type: number
example: 3.7941664
carbon_intensity_gram:
type: integer
example: 103
lifetime_month:
type: integer
example: 48
refurbishment_impact_kg_co2_eq:
type: number
example: 0.3267312
refurbishment_offset_kg_co2_eq:
type: number
example: 6.0052688
errors:
type: string
example: null
-
description: "NOTE: Requires 'e.product-plus' to retrieve detailed LCA (Life Cycle Assessment) data."
type: object
example:
data:
-
manufacture_part_number: 286H8AA
brand: 'HP Inc'
category: 'Docking station'
country_code: DK
refurbished: false
data_match: true
data_method: CA
total_kg_co2_eq: 40.23551117
manufacturing_kg_co2_eq: 29.86230874
transportation_kg_co2_eq: 5.457734144
use_kg_co2_eq: 3.457734144
end_of_life_kg_co2_eq: 1.457734144
carbon_intensity_gram: 123.42
lifetime_month: 48
refurbishment_impact_kg_co2_eq: null
refurbishment_offset_kg_co2_eq: null
errors: null
properties:
data:
type: array
example:
-
manufacture_part_number: 286H8AA
brand: 'HP Inc'
category: 'Docking station'
country_code: DK
refurbished: false
data_match: true
data_method: CA
total_kg_co2_eq: 40.23551117
manufacturing_kg_co2_eq: 29.86230874
transportation_kg_co2_eq: 5.457734144
use_kg_co2_eq: 3.457734144
end_of_life_kg_co2_eq: 1.457734144
carbon_intensity_gram: 123.42
lifetime_month: 48
refurbishment_impact_kg_co2_eq: null
refurbishment_offset_kg_co2_eq: null
items:
type: object
properties:
manufacture_part_number:
type: string
example: 286H8AA
brand:
type: string
example: 'HP Inc'
category:
type: string
example: 'Docking station'
country_code:
type: string
example: DK
refurbished:
type: boolean
example: false
data_match:
type: boolean
example: true
data_method:
type: string
example: CA
total_kg_co2_eq:
type: number
example: 40.23551117
manufacturing_kg_co2_eq:
type: number
example: 29.86230874
transportation_kg_co2_eq:
type: number
example: 5.457734144
use_kg_co2_eq:
type: number
example: 3.457734144
end_of_life_kg_co2_eq:
type: number
example: 1.457734144
carbon_intensity_gram:
type: number
example: 123.42
lifetime_month:
type: integer
example: 48
refurbishment_impact_kg_co2_eq:
type: string
example: null
refurbishment_offset_kg_co2_eq:
type: string
example: null
errors:
type: string
example: null
-
description: 'Note: The carbon footprint data will be null when the product was not found.'
type: object
example:
data:
-
manufacture_part_number: 286H8AA
brand: 'HP Inc'
category: 'Docking station'
country_code: DK
refurbished: true
data_match: false
data_method: null
total_kg_co2_eq: null
carbon_intensity_gram: null
lifetime_month: null
refurbishment_impact_kg_co2_eq: null
refurbishment_offset_kg_co2_eq: null
errors: null
properties:
data:
type: array
example:
-
manufacture_part_number: 286H8AA
brand: 'HP Inc'
category: 'Docking station'
country_code: DK
refurbished: true
data_match: false
data_method: null
total_kg_co2_eq: null
carbon_intensity_gram: null
lifetime_month: null
refurbishment_impact_kg_co2_eq: null
refurbishment_offset_kg_co2_eq: null
items:
type: object
properties:
manufacture_part_number:
type: string
example: 286H8AA
brand:
type: string
example: 'HP Inc'
category:
type: string
example: 'Docking station'
country_code:
type: string
example: DK
refurbished:
type: boolean
example: true
data_match:
type: boolean
example: false
data_method:
type: string
example: null
total_kg_co2_eq:
type: string
example: null
carbon_intensity_gram:
type: string
example: null
lifetime_month:
type: string
example: null
refurbishment_impact_kg_co2_eq:
type: string
example: null
refurbishment_offset_kg_co2_eq:
type: string
example: null
errors:
type: string
example: null
422:
description: ''
content:
application/json:
schema:
type: object
example:
data: null
errors:
products.0.manufacture_part_number:
- 'The products.0.manufacture_part_number field is required.'
products.0.brand:
- 'The products.0.brand field is required.'
products.0.category:
- 'The products.0.category field is required.'
products.0.country_code:
- 'The products.0.country_code field is required.'
properties:
data:
type: string
example: null
errors:
type: object
properties:
products.0.manufacture_part_number:
type: array
example:
- 'The products.0.manufacture_part_number field is required.'
items:
type: string
products.0.brand:
type: array
example:
- 'The products.0.brand field is required.'
items:
type: string
products.0.category:
type: array
example:
- 'The products.0.category field is required.'
items:
type: string
products.0.country_code:
type: array
example:
- 'The products.0.country_code field is required.'
items:
type: string
tags:
- e.product
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
products:
type: array
description: 'The array of products. This array must not exceed 100 items.'
example:
- []
items:
type: object
properties:
manufacture_part_number:
type: string
description: 'The unique manufacturer part number (SKU/MPN) provided by the vendor or distributor, or an internal part number. Example:'
example: est
nullable: false
brand:
type: string
description: "The product manufacturer's name. Used together with the MPN and category to ensure a unique data match."
example: 'HP Inc'
nullable: false
category:
type: string
description: 'Used alongside the external ID and brand to ensure accurate product matching. Also enables the system to provide carbon data for the category when specific LCA data is unavailable.'
example: 'Docking station'
nullable: false
country_code:
type: string
description: 'The ISO 3166-2 (or ISO 3166-2:US) alpha-2 code representing the country where the product is typically used. Determines the carbon intensity used in calculations.'
example: DK
nullable: false
refurbished:
type: boolean
description: 'optional Indicates whether the product is refurbished (pre-owned). A value of 1 denotes a refurbished product.'
example: true
nullable: false
required:
- manufacture_part_number
- brand
- category
- country_code
required:
- products
/api/v3/products/changes:
get:
summary: 'GET changed products'
operationId: gETChangedProducts
description: "\n\n \n\nRetrieve changed products as a CSV file.\nThis endpoint provides a CSV file listing the changes for a specified date or week.\n The file contains columns for `manufacturer_part_number`, `brand`, and `category`.\n Use this file to check for relevant products and brands, then use the `e.product` API to obtain detailed information.\n\n### Daily File: If a `date` is specified, a daily changes file for that day is returned, specified date cannot be in the future.\n- Example: For `date` = `2024-11-06`, the file will list all products that changed on November 6, 2024.\n\n### Weekly Summary File: Aggregates product changes from Monday to Sunday for a specified week.\nWithout a `date`, a summary file for the specified or most recent week is retrieved.\nThe weekly file aggregates product changes from Monday to Sunday for the specified week.\n\n ### Weekly File Details:\n- Aggregates data from all daily files generated for each day of the specified week.\n- Most recent week means the last full week. If you request a weekly file in any given week without a date, you will receive data from previous week (Monday to Sunday).\n- Example: A weekly file for week 45 of 2024 contains all products that changed from Monday, 2024-11-04, to Sunday, 2024-11-10.\n- Removes duplicate entries to ensure a clean dataset.\n- Combines individual product changes into a single file.\n\n### Weekly File Composition:\nThe weekly file includes:\n- All changes recorded in the daily files from Monday to Sunday of the week.\n- A deduplicated list of products with details such as `manufacturer_part_number`, `brand`, and `category`.\n\n### Recommendations:\n- Use the weekly file for a comprehensive overview of all product changes for the week. We suggest that you get the weekly file every Monday after 12:00 UTC.\n- Refer to the daily file for specific changes on a particular day\n### Response Details:\n - Returns a **302 Redirect** to the CDN URL if the file is accessible there."
parameters:
-
in: query
name: date
description: 'Optional. The date of the changes (in format YYYY-MM-DD).'
example: '2024-11-01'
required: false
schema:
type: string
description: 'Optional. The date of the changes (in format YYYY-MM-DD).'
example: '2024-11-01'
nullable: false
-
in: query
name: week_number
description: 'Optional. The week number of the changes, between 1 and 52.'
example: 45
required: false
schema:
type: integer
description: 'Optional. The week number of the changes, between 1 and 52.'
example: 45
nullable: false
responses:
302:
description: ''
content:
text/plain:
schema:
type: string
example: "manufacturer_part_number,brand,category\r\nUT04CBE,Lenovo,Notebook\r\nRE242EP,HP,Notebook\r\nPSMA2E-00U01DGC,Toshiba,Notebook\r\nRH324ET#ABY-D30,HP,Notebook\r\nA3HF-5A027P,ASUS,Notebook\r\n"
404:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'File not found'
properties:
error:
type: string
example: 'File not found'
422:
description: ''
content:
application/json:
schema:
type: object
example:
error: 'Invalid week number. The week number should be no higher than last week'
properties:
error:
type: string
example: 'Invalid week number. The week number should be no higher than last week'
tags:
- e.product
'/api/v3/group/{slug}':
get:
summary: 'GET group e.voices by slug'
operationId: gETGroupEvoicesBySlug
description: 'Retrieve a paginated list of e.voices for a specific group, filtered by date and pagination options.'
parameters:
-
in: query
name: from
description: 'date The start date for filtering e.voices.'
example: '2024-01-01'
required: false
schema:
type: string
description: 'date The start date for filtering e.voices.'
example: '2024-01-01'
nullable: false
-
in: query
name: to
description: 'date The end date for filtering e.voices. Default: today.'
example: '2024-12-31'
required: false
schema:
type: string
description: 'date The end date for filtering e.voices. Default: today.'
example: '2024-12-31'
nullable: false
-
in: query
name: page
description: 'The page number for pagination. Default: 1.'
example: 2
required: false
schema:
type: integer
description: 'The page number for pagination. Default: 1.'
example: 2
nullable: false
-
in: query
name: per_page
description: 'The number of items per page (1-100). Default: 10.'
example: 20
required: false
schema:
type: integer
description: 'The number of items per page (1-100). Default: 10.'
example: 20
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
items:
-
external_invoice_id: a6e0f0bb-0285-4a2d-b6d8-93c63543d5a9
external_invoice_date: '2024-07-24T07:39:56.000000Z'
country_code: DK
carbon_intensity_gram: 123
total_kg_co2_eq: 1301.51
status: finalized
created_at: '2024-07-24T07:39:56.000000Z'
updated_at: '2024-07-24T07:39:59.000000Z'
group:
name: 'Eco Friendly Company'
slug: eco-friendly-company
client:
name: 'Eco-Friendly Solutions Ltd'
organization_id: ecofriendly-4987
address: '100 Enviro Way'
address2: 'Sustainability Lane 3'
zip_code: ECO321
city: GreenVille
country: Denmark
vat_number: ECOF1234567
devices:
-
external_id: RE8989121
original_manufacturer_part_number: 62B6MAT3EU
quantity: 10
brand: Lenovo
model_name: 'ThinkPad T480'
category: Notebook
lifetime_months: 72
scope_2_kg_co2_eq: 278.41
scope_3_kg_co2_eq: 249.27
total_kg_co2_eq: 527.68
refurbished: true
avoided_emissions_kg_co2_eq: 256.68
-
external_id: SM-S918BZKDEEB
original_manufacturer_part_number: null
quantity: 10
brand: Samsung
model_name: 'Galaxy S23 Ultra'
category: Smartphone
lifetime_months: 30
scope_2_kg_co2_eq: 31.18
scope_3_kg_co2_eq: 742.65
total_kg_co2_eq: 773.83
refurbished: false
avoided_emissions_kg_co2_eq: 0
links:
self: 'https://app.rejoose.com/api/v3/evoices/a6e0f0bb-0285-4a2d-b6d8-93c63543d5a9'
current_page: 2
last_page: 4522
total: 4522
per_page: 1
next_page: 'https://app.rejoose.com/api/v3/group/eco-friendly-company?page=3'
previous_page: 'https://app.rejoose.com/api/v3/group/eco-friendly-company?page=1'
errors: null
properties:
data:
type: object
properties:
items:
type: array
example:
-
external_invoice_id: a6e0f0bb-0285-4a2d-b6d8-93c63543d5a9
external_invoice_date: '2024-07-24T07:39:56.000000Z'
country_code: DK
carbon_intensity_gram: 123
total_kg_co2_eq: 1301.51
status: finalized
created_at: '2024-07-24T07:39:56.000000Z'
updated_at: '2024-07-24T07:39:59.000000Z'
group:
name: 'Eco Friendly Company'
slug: eco-friendly-company
client:
name: 'Eco-Friendly Solutions Ltd'
organization_id: ecofriendly-4987
address: '100 Enviro Way'
address2: 'Sustainability Lane 3'
zip_code: ECO321
city: GreenVille
country: Denmark
vat_number: ECOF1234567
devices:
-
external_id: RE8989121
original_manufacturer_part_number: 62B6MAT3EU
quantity: 10
brand: Lenovo
model_name: 'ThinkPad T480'
category: Notebook
lifetime_months: 72
scope_2_kg_co2_eq: 278.41
scope_3_kg_co2_eq: 249.27
total_kg_co2_eq: 527.68
refurbished: true
avoided_emissions_kg_co2_eq: 256.68
-
external_id: SM-S918BZKDEEB
original_manufacturer_part_number: null
quantity: 10
brand: Samsung
model_name: 'Galaxy S23 Ultra'
category: Smartphone
lifetime_months: 30
scope_2_kg_co2_eq: 31.18
scope_3_kg_co2_eq: 742.65
total_kg_co2_eq: 773.83
refurbished: false
avoided_emissions_kg_co2_eq: 0
links:
self: 'https://app.rejoose.com/api/v3/evoices/a6e0f0bb-0285-4a2d-b6d8-93c63543d5a9'
items:
type: object
properties:
external_invoice_id:
type: string
example: a6e0f0bb-0285-4a2d-b6d8-93c63543d5a9
external_invoice_date:
type: string
example: '2024-07-24T07:39:56.000000Z'
country_code:
type: string
example: DK
carbon_intensity_gram:
type: integer
example: 123
total_kg_co2_eq:
type: number
example: 1301.51
status:
type: string
example: finalized
created_at:
type: string
example: '2024-07-24T07:39:56.000000Z'
updated_at:
type: string
example: '2024-07-24T07:39:59.000000Z'
group:
type: object
properties:
name:
type: string
example: 'Eco Friendly Company'
slug:
type: string
example: eco-friendly-company
client:
type: object
properties:
name:
type: string
example: 'Eco-Friendly Solutions Ltd'
organization_id:
type: string
example: ecofriendly-4987
address:
type: string
example: '100 Enviro Way'
address2:
type: string
example: 'Sustainability Lane 3'
zip_code:
type: string
example: ECO321
city:
type: string
example: GreenVille
country:
type: string
example: Denmark
vat_number:
type: string
example: ECOF1234567
devices:
type: array
example:
-
external_id: RE8989121
original_manufacturer_part_number: 62B6MAT3EU
quantity: 10
brand: Lenovo
model_name: 'ThinkPad T480'
category: Notebook
lifetime_months: 72
scope_2_kg_co2_eq: 278.41
scope_3_kg_co2_eq: 249.27
total_kg_co2_eq: 527.68
refurbished: true
avoided_emissions_kg_co2_eq: 256.68
-
external_id: SM-S918BZKDEEB
original_manufacturer_part_number: null
quantity: 10
brand: Samsung
model_name: 'Galaxy S23 Ultra'
category: Smartphone
lifetime_months: 30
scope_2_kg_co2_eq: 31.18
scope_3_kg_co2_eq: 742.65
total_kg_co2_eq: 773.83
refurbished: false
avoided_emissions_kg_co2_eq: 0
items:
type: object
properties:
external_id:
type: string
example: RE8989121
original_manufacturer_part_number:
type: string
example: 62B6MAT3EU
quantity:
type: integer
example: 10
brand:
type: string
example: Lenovo
model_name:
type: string
example: 'ThinkPad T480'
category:
type: string
example: Notebook
lifetime_months:
type: integer
example: 72
scope_2_kg_co2_eq:
type: number
example: 278.41
scope_3_kg_co2_eq:
type: number
example: 249.27
total_kg_co2_eq:
type: number
example: 527.68
refurbished:
type: boolean
example: true
avoided_emissions_kg_co2_eq:
type: number
example: 256.68
links:
type: object
properties:
self:
type: string
example: 'https://app.rejoose.com/api/v3/evoices/a6e0f0bb-0285-4a2d-b6d8-93c63543d5a9'
current_page:
type: integer
example: 2
last_page:
type: integer
example: 4522
total:
type: integer
example: 4522
per_page:
type: integer
example: 1
next_page:
type: string
example: 'https://app.rejoose.com/api/v3/group/eco-friendly-company?page=3'
previous_page:
type: string
example: 'https://app.rejoose.com/api/v3/group/eco-friendly-company?page=1'
errors:
type: string
example: null
404:
description: ''
content:
application/json:
schema:
type: object
example:
data: null
errors:
not_found: 'Group with slug company-123 not found.'
properties:
data:
type: string
example: null
errors:
type: object
properties:
not_found:
type: string
example: 'Group with slug company-123 not found.'
tags:
- Groups
parameters:
-
in: path
name: slug
description: 'The group slug used to filter the e.voices.'
example: eco-friendly-company
required: true
schema:
type: string
/api/v3/groups:
get:
summary: 'GET groups e.voices'
operationId: gETGroupsEvoices
description: 'Retrieve a paginated list of e.voices for all groups, filtered by date and pagination options.'
parameters:
-
in: query
name: from
description: 'date The start date for filtering e.voices.'
example: '2024-01-01'
required: false
schema:
type: string
description: 'date The start date for filtering e.voices.'
example: '2024-01-01'
nullable: false
-
in: query
name: to
description: 'date The end date for filtering e.voices. Default: today.'
example: '2024-12-31'
required: false
schema:
type: string
description: 'date The end date for filtering e.voices. Default: today.'
example: '2024-12-31'
nullable: false
-
in: query
name: page
description: 'The page number for pagination. Default: 1.'
example: 2
required: false
schema:
type: integer
description: 'The page number for pagination. Default: 1.'
example: 2
nullable: false
-
in: query
name: per_page
description: 'The number of items per page (1-100). Default: 10.'
example: 20
required: false
schema:
type: integer
description: 'The number of items per page (1-100). Default: 10.'
example: 20
nullable: false
responses:
200:
description: ''
content:
application/json:
schema:
type: object
example:
data:
items:
-
external_invoice_id: a6e0f0bb-0285-4a2d-b6d8-93c63543d5a9
external_invoice_date: '2024-07-24T07:39:56.000000Z'
country_code: DK
carbon_intensity_gram: 123
total_kg_co2_eq: 1301.51
status: finalized
created_at: '2024-07-24T07:39:56.000000Z'
updated_at: '2024-07-24T07:39:59.000000Z'
group:
name: 'Eco Friendly Company'
slug: eco-friendly-company
client:
name: 'Eco-Friendly Solutions Ltd'
organization_id: ecofriendly-4987
address: '100 Enviro Way'
address2: 'Sustainability Lane 3'
zip_code: ECO321
city: GreenVille
country: Denmark
vat_number: ECOF1234567
devices:
-
external_id: RE8989121
original_manufacturer_part_number: 62B6MAT3EU
quantity: 10
brand: Lenovo
model_name: 'ThinkPad T480'
category: Notebook
lifetime_months: 72
scope_2_kg_co2_eq: 278.41
scope_3_kg_co2_eq: 249.27
total_kg_co2_eq: 527.68
refurbished: true
avoided_emissions_kg_co2_eq: 256.68
-
external_id: SM-S918BZKDEEB
original_manufacturer_part_number: null
quantity: 10
brand: Samsung
model_name: 'Galaxy S23 Ultra'
category: Smartphone
lifetime_months: 30
scope_2_kg_co2_eq: 31.18
scope_3_kg_co2_eq: 742.65
total_kg_co2_eq: 773.83
refurbished: false
avoided_emissions_kg_co2_eq: 0
links:
self: 'https://app.rejoose.com/api/v3/evoices/a6e0f0bb-0285-4a2d-b6d8-93c63543d5a9'
current_page: 2
last_page: 4522
total: 4522
per_page: 1
next_page: 'https://app.rejoose.com/api/v3/groups?page=3'
previous_page: 'https://app.rejoose.com/api/v3/groups?page=1'
errors: null
properties:
data:
type: object
properties:
items:
type: array
example:
-
external_invoice_id: a6e0f0bb-0285-4a2d-b6d8-93c63543d5a9
external_invoice_date: '2024-07-24T07:39:56.000000Z'
country_code: DK
carbon_intensity_gram: 123
total_kg_co2_eq: 1301.51
status: finalized
created_at: '2024-07-24T07:39:56.000000Z'
updated_at: '2024-07-24T07:39:59.000000Z'
group:
name: 'Eco Friendly Company'
slug: eco-friendly-company
client:
name: 'Eco-Friendly Solutions Ltd'
organization_id: ecofriendly-4987
address: '100 Enviro Way'
address2: 'Sustainability Lane 3'
zip_code: ECO321
city: GreenVille
country: Denmark
vat_number: ECOF1234567
devices:
-
external_id: RE8989121
original_manufacturer_part_number: 62B6MAT3EU
quantity: 10
brand: Lenovo
model_name: 'ThinkPad T480'
category: Notebook
lifetime_months: 72
scope_2_kg_co2_eq: 278.41
scope_3_kg_co2_eq: 249.27
total_kg_co2_eq: 527.68
refurbished: true
avoided_emissions_kg_co2_eq: 256.68
-
external_id: SM-S918BZKDEEB
original_manufacturer_part_number: null
quantity: 10
brand: Samsung
model_name: 'Galaxy S23 Ultra'
category: Smartphone
lifetime_months: 30
scope_2_kg_co2_eq: 31.18
scope_3_kg_co2_eq: 742.65
total_kg_co2_eq: 773.83
refurbished: false
avoided_emissions_kg_co2_eq: 0
links:
self: 'https://app.rejoose.com/api/v3/evoices/a6e0f0bb-0285-4a2d-b6d8-93c63543d5a9'
items:
type: object
properties:
external_invoice_id:
type: string
example: a6e0f0bb-0285-4a2d-b6d8-93c63543d5a9
external_invoice_date:
type: string
example: '2024-07-24T07:39:56.000000Z'
country_code:
type: string
example: DK
carbon_intensity_gram:
type: integer
example: 123
total_kg_co2_eq:
type: number
example: 1301.51
status:
type: string
example: finalized
created_at:
type: string
example: '2024-07-24T07:39:56.000000Z'
updated_at:
type: string
example: '2024-07-24T07:39:59.000000Z'
group:
type: object
properties:
name:
type: string
example: 'Eco Friendly Company'
slug:
type: string
example: eco-friendly-company
client:
type: object
properties:
name:
type: string
example: 'Eco-Friendly Solutions Ltd'
organization_id:
type: string
example: ecofriendly-4987
address:
type: string
example: '100 Enviro Way'
address2:
type: string
example: 'Sustainability Lane 3'
zip_code:
type: string
example: ECO321
city:
type: string
example: GreenVille
country:
type: string
example: Denmark
vat_number:
type: string
example: ECOF1234567
devices:
type: array
example:
-
external_id: RE8989121
original_manufacturer_part_number: 62B6MAT3EU
quantity: 10
brand: Lenovo
model_name: 'ThinkPad T480'
category: Notebook
lifetime_months: 72
scope_2_kg_co2_eq: 278.41
scope_3_kg_co2_eq: 249.27
total_kg_co2_eq: 527.68
refurbished: true
avoided_emissions_kg_co2_eq: 256.68
-
external_id: SM-S918BZKDEEB
original_manufacturer_part_number: null
quantity: 10
brand: Samsung
model_name: 'Galaxy S23 Ultra'
category: Smartphone
lifetime_months: 30
scope_2_kg_co2_eq: 31.18
scope_3_kg_co2_eq: 742.65
total_kg_co2_eq: 773.83
refurbished: false
avoided_emissions_kg_co2_eq: 0
items:
type: object
properties:
external_id:
type: string
example: RE8989121
original_manufacturer_part_number:
type: string
example: 62B6MAT3EU
quantity:
type: integer
example: 10
brand:
type: string
example: Lenovo
model_name:
type: string
example: 'ThinkPad T480'
category:
type: string
example: Notebook
lifetime_months:
type: integer
example: 72
scope_2_kg_co2_eq:
type: number
example: 278.41
scope_3_kg_co2_eq:
type: number
example: 249.27
total_kg_co2_eq:
type: number
example: 527.68
refurbished:
type: boolean
example: true
avoided_emissions_kg_co2_eq:
type: number
example: 256.68
links:
type: object
properties:
self:
type: string
example: 'https://app.rejoose.com/api/v3/evoices/a6e0f0bb-0285-4a2d-b6d8-93c63543d5a9'
current_page:
type: integer
example: 2
last_page:
type: integer
example: 4522
total:
type: integer
example: 4522
per_page:
type: integer
example: 1
next_page:
type: string
example: 'https://app.rejoose.com/api/v3/groups?page=3'
previous_page:
type: string
example: 'https://app.rejoose.com/api/v3/groups?page=1'
errors:
type: string
example: null
tags:
- Groups