SpotGo
  1. Documents
SpotGo
  • Getting started
    • Introduction
    • Authentication
    • Opportunities vs Orders
    • Mappings
  • Order
    • Orders Processing
    • /api/v1/orders/file
      POST
    • /api/v1/orders
      POST
    • /api/v2/orders/{orderId}
      GET
    • /api/v1/orders/{orderId}/file
      GET
  • Opportunity
    • Opportunities (Freight Qoutes)
    • /api/v1/opportunities
      POST
    • /api/v1/opportunities/file
      POST
    • /api/v1/opportunities/image
      POST
    • /api/v1/opportunities/{opportunityId}
      GET
    • /api/v1/opportunities/{opportunityId}/custom
      GET
    • /api/v1/opportunities/{opportunityId}/default
      GET
  • Freight
    • Freight publish
    • /api/v1/freights
      POST
    • /api/v1/freights/{freightId}
      PUT
    • /api/v1/freights/{freightId}
      DELETE
  • Vehicles
    • /api/v1/vehicles
    • /api/v1/vehicles
    • /api/v1/vehicles/{vehicleId}
    • /api/v1/vehicles/{vehicleId}
    • /api/v1/vehicles/{vehicleId}
  • Feedback
    • /api/v1/feedback
  • Webhook
    • Webhooks flow
    • /api/v1/webhooks
    • /api/v1/webhooks
    • /api/v1/webhooks/{subscriptionId}
  • Documents
    • Documents processing
    • /api/v1/documents
      POST
    • /api/v1/documents/{documentId}/file
      GET
    • /api/v1/documents/invoice/{documentId}
      GET
    • /api/v1/documents/receipt/{documentId}
      GET
    • /api/v1/documents/cmr/{documentId}
      GET
  • AccountManagement
    • /api/v1/accounts
    • /api/v1/accounts/block
  1. Documents

Documents processing

The Document API is designed to process documents, extract key information, and provide access to both the structured data and the original files.
Currently, the API is primarily oriented towards processing Invoice documents, particularly those related to road transport. However, the system is being developed to handle other types of invoices and potentially other document types in the future. The focus is on converting unstructured or semi-structured document formats (like PDFs) into usable, structured data formats (like JSON).

Enums#

DocumentFileType: Specifies the format of the submitted document file.
Pdf
Image
SpotGoDocumentType: Specifies the type of document being processed by the system.
Invoices
Receipts
Cmrs
DocumentStatus: Indicates the result of the document processing operation.
Succeeded
Failed
Modified at 2025-05-26 17:57:50
Previous
/api/v1/webhooks/{subscriptionId}
Next
/api/v1/documents
Built with