PUBLIC SERVICES [PROD]
    PUBLIC SERVICES [PROD]
    • Introduction
    • Document Management
    • External Integration
    • Authentication
      • Generate a token to access ROIT APIs
        POST
    • Invoice-to-Pay
      • Documents Manager
        • Create document export request
        • Get export request by id
        • Delete export request by id
        • Generate signed URLs for export files by id
      • External System Integration
        • Get pending entities to be integrated
        • Register delivery integration
        • Update integration status
        • Get all documents attached to a request
      • Upload Document
        • Upload document as base64
    • Tax Reform
      • Data Integration
        • Create Request
        • Update Request Status
        • Generate Signed Url
    • External System Integration
      • Reprocess a specific request
        POST

    External Integration

    Services#

    Delivery#

    Sending data to ROIT such as Purchase Orders, Contracts, Service Sheets, Supplier Registration, Accounts Payable, Cost Centers, among other important data for the hyperautomation of the Invoice-To-Pay process.
    Access the delivery documentation here

    Entrypoint - Search for pending documents#

    Used to search for documents pending integration with the ERP (NFE, NFSE, Invoices, Bank Slips), after the document is returned at this endpoint its status is PROCESSING, waiting for the ERP to return with DONE or ERROR status.

    Download Attached Documents#

    When searching for processed and structured data of a document for integration, you can also download the original linked documents through the route:
    Get all documents attached to a request
    Important Note: Through this route, you will only be able to retrieve documents that are ready for integration or have already been integrated.

    Use Case Example#

    In some ERPs, it's possible to link one or more documents to a fiscal entry to maintain better traceability. In this case, you fetch the data directly linked to the entry being processed.
    Access the entrypoint documentation here

    Document status update#

    After searching for the document and processing the integration, with success or error, this status must be returned to the flow to provide visibility and finalize the integration process.
    The possible statuses are:
    DONE - Integration successfully performe
    ERROR - Integration error occurred
    Access the status update here
    ATTENTION: Customizing data submissions to meet your needs
    The payloads provided here serve as basic integration templates, containing the fields we consider essential for most cases.
    Custom Fields: If you need to send or receive fields not listed in the default templates, simply request their inclusion. We will analyze your request and, if feasible, make the necessary fields available.
    Modified at 2025-02-28 17:37:25
    Previous
    Document Management
    Next
    Authentication
    Built with