• Register

Retrieve Files

Retrieves files from Spirit for the requested Type, optionally filtered by Extension and limited to MaxFileNumber, and returns each file as Base64 content together with its hash, barcode, SDI identifier and date, vendor, invoice number, amounts, currency, invoice date and company. When the Type contains the text FEEDBACK (in any letter case), the same request, including the FilesOK and FilesKO values, is sent to Spirit's acknowledgement endpoint instead of its file endpoint, and Spirit's reply is returned.

Request URI

Request Structure

API field Type Mandatory Description
request
    Type String Y Type
    Extension String N Extension
    MaxFileNumber String N Max File Number
    FilesOK String N Files OK
    FilesKO String N Files KO

Request sample

Request body

Response Structure

API field Type Description
response
    result
        Status String Status
        ErrorMessage String Error Message
        Files (0..∞)
            IdSnow String ID Snow
            FileName String File Name
            FileBase64 String File Base 64
            Hash String Hash
            Barcode String Barcode
            Idsdi String Idsdi
            SdiDate String Sdi Date
            Vendor String Vendor
            InvoiceNumber String Invoice Number
            TotalAmount String Total Amount
            NetAmount String Net Amount
            TaxAmount String Tax Amount
            Currency String Currency
            InvoiceDate String Invoice Date
            Company String Company

Response sample

Sample response

Docs Navigation