HTTP status code 200

Body

Media type: application/json

Type: object

• countPerPage: required(integer)

  Number of result returned by this page

• totalEntities: required(integer)

  Total number of results available for this request

• totalPages: required(integer)

  Total number of pages available for this request

• nextPageUri: required(string)

  Request URI (URL without hostname) that allow to go to the next page of result, can be empty if there is no next page

  Example:

  /{entity}?page=1&per_page=3
  

• prevPageUri: required(string)

  Request URI (URL without hostname) that allow to go to the previous page of result, can be empty if no previous page

  Example:

  /{entity}?page=1&per_page=3
  

• results: required(array of document)

  Items: document

  • uid: required(string)

    Aboutgoods generated unique ID

  • createdAt: required(datetime)

    When this object has been registered in AG system

  • updatedAt: required(datetime)

    The last time this entity had been updated in AG system

  • dominantLanguage: required(string)

    A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

    • Usage : specifiy on which language the Receipt Analyzer should treat receipts

    Example:

    fr-FR

  • appId: (string)

    If this document has been received from AGKit (our mobile application SDK), this field allow to identify the application which have been used to send the document

  • processedRules: (object)
    • name: required(string)

      Name of the whole rule, must be unique for a given campaign

    • uid: required(string)

      unique uid of the rule

    • priceRule: (object)

      rule that defines rule on prices

      • eligibleOnly: required(number)

        minimum price of all matched items

      • totalAmount: (number)

        minimum total amount of receipt

      • isMatched: required(boolean)

        tells if the rule is matched in receipt

      Example:

      {
        "eligibleOnly": 20.25,
        "totalAmount": 40,
        "isMatched": false
      }

    • itemRule: required(object)

      rule that defines terms to search and various conditions of search (or, and)

      • term: (string)

        Just a simple rule to look for this term in the receipt. Mutually exclusive with AND and TERM.

      • quantityRequired: (integer)

        minimum required quantity of term or clause (AND/OR) to find. Is added by Rulio by default = 1.

      • or: (array of object)

        The result of running OR Rule with itemsMatched and isMatched.

        Items:
      • and: (array of object)

        The result of running AND Rule with itemsMatched and isMatched.

        Items:
      • not: (array of object)

        The result of running NOT Rule with itemsMatched and isMatched.

        Items:
      • isMatched: required(boolean)

        tells if the rule is matched in receipt

      • itemsMatched: (array of string)

        List of IDs of items that were matched by term. Even if the rule is false (quantityRequired is not met), can have some IDs.

      • quantityMatched: (integer)

        quantity of term or terms in clause (AND/OR) found (even if the quantityRequired is not met). Can be different from the number of items in itemsMatched (one product line - but bought twice)

      Example:

      {
        "quantityRequired": 2,
        "or": [
          {
            "term": "Labeyrie",
            "quantityRequired": 1,
            "itemsMatched": [
              "3"
            ],
            "isMatched": true,
            "quantityMatched": 1
          },
          {
            "term": "Blini",
            "quantityRequired": 1,
            "itemsMatched": [
              "1",
              "2"
            ],
            "quantityMatched": 2,
            "isMatched": true
          }
        ],
        "not": [
          {
            "isMatched": true,
            "term": "Auchan",
            "itemsMatched": [
              "2"
            ],
            "quantityMatched": 1
          },
          {
            "isMatched": false,
            "term": "Cora",
            "itemsMatched": [],
            "quantityMatched": 0
          },
          {
            "isMatched": false,
            "term": "Carrefour",
            "itemsMatched": [],
            "quantityMatched": 0
          }
        ],
        "itemsMatched": [
          "3",
          "1"
        ],
        "quantityMatched": 2,
        "isMatched": true
      }

    • signRule: (object)

      rule that defines the list of signs for a given promotion

      • signList: required(array of string)

        List of sign eligible for the promotion.

      • isMatched: required(boolean)

        tells if the rule is matched in receipt

      Example:

      {
        "signList": [
          "Auchan",
          "Cora"
        ],
        "isMatched": true
      }

    • dateRule: required(object)

      rule that defines range of dates for a given promotion

      • min: required(string)

        start date of the promotion/campaign

      • max: required(string)

        last date of the promotion/campaign

      • isMatched: required(boolean)

        tells if the rule is matched in receipt

      Example:

      {
        "min": "2019-01-01",
        "max": "2019-11-01",
        "isMatched": true
      }

    • allRulesMatched: required(boolean)

      summarizes all rules matching, true if all rules are matched

    • totalPriceOfMatchedItems: required(number)

      total price of items that matched ItemRule

    Example:

    {
      "name": "Labeyrie",
      "uid": "123",
      "itemRule": {
        "quantityRequired": 2,
        "or": [
          {
            "term": "Labeyrie",
            "quantityRequired": 1,
            "itemsMatched": [
              "3"
            ],
            "isMatched": true,
            "quantityMatched": 1
          },
          {
            "term": "Blini",
            "quantityRequired": 1,
            "itemsMatched": [
              "1",
              "2"
            ],
            "quantityMatched": 2,
            "isMatched": true
          }
        ],
        "not": [
          {
            "isMatched": true,
            "term": "Auchan",
            "itemsMatched": [
              "2"
            ],
            "quantityMatched": 1
          },
          {
            "isMatched": false,
            "term": "Cora",
            "itemsMatched": [],
            "quantityMatched": 0
          }
        ],
        "itemsMatched": [
          "3",
          "1"
        ],
        "quantityMatched": 2,
        "isMatched": true
      },
      "dateRule": {
        "min": "2019-01-01",
        "max": "2019-11-01",
        "isMatched": true
      },
      "priceRule": {
        "eligibleOnly": 15,
        "isMatched": false
      },
      "signRule": {
        "signList": [
          "Cora",
          "Auchan",
          "Carrefour"
        ],
        "isMatched": true
      },
      "allRulesMatched": false,
      "totalPriceOfMatchedItems": 9.74
    }

  • name: required(string)

    Id of this document that client (aka you) had set when sending the image of document in the first place.

    • Helps you to retrieve a document by it's name
  • endpointUid: (string)

    Endpoint id that had served this document

  • campaignUid: (string)

    If this document is a part of promotion campaign, id of campaign is displayed here

  • companyUid: (string)

    ID of the company which owns this Document (automatically set with Auth0 connection)

  • status: required(one of WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS, PROCESSING, PROCESSED, NOT_EXPLOITABLE)

    As of today we have 5 status for differents states of an image in our systems, when everything is fine PROCESSED

  • processReport: required(one of NO_ERROR, BAD_QUALITY_IMAGE, NOT_ENOUGH_TEXT, MULTIPLE_RECEIPT, UNREADABLE, BAD_LOCALE, NOT_RECEIPT, ERROR_JPG, BAD_URL, NOT_ANALYZED)

    Process Report represent a more detailled reason about why a receipt has not been analyzed correctly A key to let the client knows what happened during analysis, helps you understand the status

    • NO_ERROR => Everything is fine, this come with the PROCESSED status by default
    • BAD_QUALITY_IMAGE => We detected a too blurry image or too dark, it can also be the resolution of the image
    • NOT_ENOUGH_TEXT => Self explicit, we have a threshold for the text recognition in image, if our OCR did not found enough text to generate a satisfiable amount of data, we abandon the Process
    • MULTIPLE_RECEIPT => We do not handle multiple receipt in one image, when we detect this case, we stop the process
    • UNREADABLE => Our OCR could not determine any Text in the image
    • BAD_LOCALE => We could not find any language for the detection to operate. This means that the Language or country is currently not supported by our system
    • NOT_RECEIPT => We didn't find any receipt in the image
    • ERROR_IMAGE_FORMAT => The image format is not valid (not one of jpg, pdf, png)
    • BAD_URL => No image has been found at the given URL (internal error)
    • NOT_ANALYZED => The document has not been analyzed for the moment, this comes with the WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS or PROCESSING statuses
  • imageUrl: required(string)

    URL for getting image from a cdn repository

  • metaData: (object)

    Exif metadata extracted from IMAGE_TREAT process
  • imageQuality: (object)

    Set of key-value describing quality of image, generated from IMAGE_TREAT process
  • userPseudoId: (string)

    This ID correspond to a custom and client managed id specified by the developer of the application that had setup AGKit SDK (aka you in general).

    • This can also come from an userId that you sent over this very API when sending a receipt
  • data: (object)

    Actual data that has been extracted from the receipt content
    Note: This field will be empty on the first document post response, as the process is running asynchronously, expect this field to be filled with data when the Status is set to PROCESSED

    • payment: (string)

      Buying mode or paiment method(s) in one string separated by | (pipe), out of following CARD, CASH, CHEQUE, OTHER

    • buyHour: (string)

      The hour displayed on the receipt (ISO 8601 Time 'hh:mm:ss')

    • buyDate: (string)

      Date of buy for the receipt (ISO 8601 Date 2018-10-22)

    • articleCount: (number)

      Number of items in cart for this receipt

    • total: (number)

      Total amount paid by the customer (can be negative !)

    • currency: (string)

      The currency used for paiement (ISO 4217 EUR)

    • locale: (string)

      Locale found for this receipt

    • shop: (object)

      informations about the shop

      • city: (string)

        City where the store of this buy is located

      • sign: (string)

        Store name or sign name / Brand of the shop

      • phone: (string)

        Phone number of the store

      • address: (string)

        Exact address of the store

      • postalCode: (string)

        Postal code for the city where we found this store

      • geoLocation: (string)

        Latitude and longitude for the shop, following https://tools.ietf.org/html/rfc5870 standard (example 13.4125,103.8667)

    • items: (array of object)

      Items with products detected

      Items: items

      • id: required(string)

        An ID unique to this list of item. Mainly used to identify this particular item in this receipt for our rule processor to indicate which item has matched a given rule.

      • rawLabel: (string)

        Raw line read on the receipt by OCR

      • shortLabel: (string)

        Detected short label from rawLabel, we remove price and other non label data from rawLabel

      • quantity: (number)

        Quantity of item detected in receipt

      • unitPrice: (number)

        A price detected for one piece of this item

      • packageUnity: (string)

        Package unity for item, for example Kg

      • mass: (number)

        The mass detected for the package, example 5 (Kg from PackageUnity)

      • flags: (array of string)

        Some notable characteristics detected on the product, BIO for example, or gluten free or anything special

      • price: (number)

        Total price for this item, (if found quantity > 1, we multiply to get this data, or we read it from receipt)

      • product: (object)

        What we understood from the item, we link item data to a clean and well organized product from our database and we put informations about it here.

        • name: (string)

          Full name unshortened if possible.

        • category: (string)

          A category for this product infered by our AI algorithm

        • categoryUid: (string)

          Reference UID from Aboutgoods taxonomy

        • brand: (string)

          Brand of product if displayed in label infered by our AI algorithm

        • brandLine: (string)

          Brand line (sub brand) infered by our AI algorithm

        • averagePrice: (number)

          Global average price for this product

        Example:

        {
          "name": "pt nav.thon filet",
          "brand": "PETIT NAVIRE",
          "brandLine": "FILETS DE THON",
          "category" : "tinned_fish",
          "categoryUid" : "4e54e68c-637f-a7d9-d509-f7e32b849f60"
        }
        

      • bundle: (number)

        Number of products in a pack. 16 x 125g, 16 is the bundle, 125g is the mass.

      Example:

      {
        "id": "fa2cb",
        "rawLabel": "x5506 OATS QUAKER BIO",
        "quantity": 1,
        "unitPrice": 1.64,
        "packageUnity": "Kg",
        "mass": 1,
        "flags": [
          "bio"
        ],
        "price": 1.64,
        "bundle": 1,
        "product": {
          "category": "breakfast_cereals",
          "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
          "brand": "QUAKER"
        }
      }

    Example:

    {
      "shop": {
        "city": "Toulon",
        "sign": "Carrefour",
        "phone": "0494419879",
        "address": "CENTRE CIAL MAYOL",
        "postalCode": "83000"
      },
      "articleCount": 2,
      "total": 4.25,
      "payment": "CARD | CASH",
      "buyDate": "2016-12-07",
      "buyHour": "11:08",
      "items": [
        {
          "id": "fa2cb",
          "rawLabel": "x5506 OATS QUAKER",
          "quantity": 1,
          "unitPrice": 1.64,
          "packageUnity": "Kg",
          "mass": 1,
          "price": 1.64,
          "bundle": 1,
          "product": {
            "name": "Quaker Oats",
            "averagePrice": 2.02,
            "category": "breakfast_cereals",
            "brand": "QUAKER"
          }
        },
        {
          "id": "9d7fb",
          "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
          "shortLabel": "BTE 6X33CL COCA CO",
          "quantity": 1,
          "unitPrice": 2.61,
          "packageUnity": "CL",
          "mass": 33,
          "bundle": 6,
          "price": 2.61,
          "product": {
            "category": "soda",
            "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
            "brand": "COCA COLA"
          }
        }
      ]
    }

  Example:

  {
    "uid": "89cd32b8-15e9-4e63-af5e-9e85da188fa1",
    "createdAt": "2019-09-20T08:19:57Z",
    "updatedAt": "2019-09-20T08:20:09Z",
    "dominantLanguage": "fr-FR",
    "name": "receiptTest",
    "companyUid": "test-company-uid",
    "campaignUid": "fc928982-3acc-4aea-bca3-e50d22e0b6ca",
    "userPseudoId": "8335c8d1-5ae7-440c-90d1-50543c86d9b4",
    "status": "PROCESSED",
    "processReport": "NO_ERROR",
    "imageUrl": "https://receipt.agkit.io/v2/documents/89cd32b8-15e9-4e63-af5e-9e85da188fa1/show",
    "metaData": {
      "undefined": null
    },
    "imageQuality": {},
    "data": {
      "shop": {
        "city": "Toulon",
        "sign": "Carrefour",
        "phone": "0494419879",
        "address": "CENTRE CIAL MAYOL",
        "postalCode": "83000"
      },
      "articleCount": 3,
      "total": 6.51,
      "payment": "CARD | CASH",
      "barcode": "09999000403300321612071108",
      "buyDate": "2016-12-07",
      "buyHour": "11:08",
      "items": [
        {
          "id": "fa2cb",
          "rawLabel": "x5506 OATS QUAKER               1,64",
          "quantity": 1,
          "unitPrice": 1.64,
          "packageUnity": "Kg",
          "mass": 1,
          "price": 1.64,
          "bundle": 1,
          "product": {
            "category": "breakfast_cereals",
            "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
            "brand": "QUAKER"
          }
        },
        {
          "id": "47267",
          "rawLabel": "PEPSI  REGULAR                           2,26",
          "shortLabel": "PEPSI  REGULAR",
          "quantity": 1,
          "unitPrice": 2.26,
          "bundle": 1,
          "price": 2.26,
          "product": {
            "category": "soda",
            "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
            "brand": "PEPSI"
          }
        },
        {
          "id": "9d7fb",
          "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
          "shortLabel": "BTE 6X33CL COCA CO",
          "quantity": 1,
          "unitPrice": 2.61,
          "packageUnity": "CL",
          "mass": 33,
          "bundle": 6,
          "price": 2.61,
          "product": {
            "category": "soda",
            "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
            "brand": "COCA COLA"
          }
        }
      ]
    },
    "processedRules": {
      "uid": "1234",
      "name": "Quaker",
      "dateRule": {
        "min": "2019-01-01",
        "max": "2019-11-01",
        "isMatched": false
      },
      "signRule": {
        "signList": [
          "Carrefour"
        ],
        "isMatched": true
      },
      "itemRule": {
        "term": "Quaker",
        "quantityRequired": 1,
        "isMatched": true,
        "itemsMatched": [
          "fa2cb"
        ],
        "quantityMatched": 1
      },
      "allRulesMatched": false,
      "totalPriceOfMatchedItems": 1.64
    }
  }

HTTP status code 400

Filter malformed or invalid filter key

HTTP status code 403

You cannot access this resources with this token

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• uid: required(string)

  Aboutgoods generated unique ID

• createdAt: required(datetime)

  When this object has been registered in AG system

• updatedAt: required(datetime)

  The last time this entity had been updated in AG system

• dominantLanguage: required(string)

  A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

  • Usage : specifiy on which language the Receipt Analyzer should treat receipts

  Example:

  fr-FR

• appId: (string)

  If this document has been received from AGKit (our mobile application SDK), this field allow to identify the application which have been used to send the document

• processedRules: (object)
  • name: required(string)

    Name of the whole rule, must be unique for a given campaign

  • uid: required(string)

    unique uid of the rule

  • priceRule: (object)

    rule that defines rule on prices

    • eligibleOnly: required(number)

      minimum price of all matched items

    • totalAmount: (number)

      minimum total amount of receipt

    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    Example:

    {
      "eligibleOnly": 20.25,
      "totalAmount": 40,
      "isMatched": false
    }

  • itemRule: required(object)

    rule that defines terms to search and various conditions of search (or, and)

    • term: (string)

      Just a simple rule to look for this term in the receipt. Mutually exclusive with AND and TERM.

    • quantityRequired: (integer)

      minimum required quantity of term or clause (AND/OR) to find. Is added by Rulio by default = 1.

    • or: (array of object)

      The result of running OR Rule with itemsMatched and isMatched.

      Items:
    • and: (array of object)

      The result of running AND Rule with itemsMatched and isMatched.

      Items:
    • not: (array of object)

      The result of running NOT Rule with itemsMatched and isMatched.

      Items:
    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    • itemsMatched: (array of string)

      List of IDs of items that were matched by term. Even if the rule is false (quantityRequired is not met), can have some IDs.

    • quantityMatched: (integer)

      quantity of term or terms in clause (AND/OR) found (even if the quantityRequired is not met). Can be different from the number of items in itemsMatched (one product line - but bought twice)

    Example:

    {
      "quantityRequired": 2,
      "or": [
        {
          "term": "Labeyrie",
          "quantityRequired": 1,
          "itemsMatched": [
            "3"
          ],
          "isMatched": true,
          "quantityMatched": 1
        },
        {
          "term": "Blini",
          "quantityRequired": 1,
          "itemsMatched": [
            "1",
            "2"
          ],
          "quantityMatched": 2,
          "isMatched": true
        }
      ],
      "not": [
        {
          "isMatched": true,
          "term": "Auchan",
          "itemsMatched": [
            "2"
          ],
          "quantityMatched": 1
        },
        {
          "isMatched": false,
          "term": "Cora",
          "itemsMatched": [],
          "quantityMatched": 0
        },
        {
          "isMatched": false,
          "term": "Carrefour",
          "itemsMatched": [],
          "quantityMatched": 0
        }
      ],
      "itemsMatched": [
        "3",
        "1"
      ],
      "quantityMatched": 2,
      "isMatched": true
    }

  • signRule: (object)

    rule that defines the list of signs for a given promotion

    • signList: required(array of string)

      List of sign eligible for the promotion.

    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    Example:

    {
      "signList": [
        "Auchan",
        "Cora"
      ],
      "isMatched": true
    }

  • dateRule: required(object)

    rule that defines range of dates for a given promotion

    • min: required(string)

      start date of the promotion/campaign

    • max: required(string)

      last date of the promotion/campaign

    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    Example:

    {
      "min": "2019-01-01",
      "max": "2019-11-01",
      "isMatched": true
    }

  • allRulesMatched: required(boolean)

    summarizes all rules matching, true if all rules are matched

  • totalPriceOfMatchedItems: required(number)

    total price of items that matched ItemRule

  Example:

  {
    "name": "Labeyrie",
    "uid": "123",
    "itemRule": {
      "quantityRequired": 2,
      "or": [
        {
          "term": "Labeyrie",
          "quantityRequired": 1,
          "itemsMatched": [
            "3"
          ],
          "isMatched": true,
          "quantityMatched": 1
        },
        {
          "term": "Blini",
          "quantityRequired": 1,
          "itemsMatched": [
            "1",
            "2"
          ],
          "quantityMatched": 2,
          "isMatched": true
        }
      ],
      "not": [
        {
          "isMatched": true,
          "term": "Auchan",
          "itemsMatched": [
            "2"
          ],
          "quantityMatched": 1
        },
        {
          "isMatched": false,
          "term": "Cora",
          "itemsMatched": [],
          "quantityMatched": 0
        }
      ],
      "itemsMatched": [
        "3",
        "1"
      ],
      "quantityMatched": 2,
      "isMatched": true
    },
    "dateRule": {
      "min": "2019-01-01",
      "max": "2019-11-01",
      "isMatched": true
    },
    "priceRule": {
      "eligibleOnly": 15,
      "isMatched": false
    },
    "signRule": {
      "signList": [
        "Cora",
        "Auchan",
        "Carrefour"
      ],
      "isMatched": true
    },
    "allRulesMatched": false,
    "totalPriceOfMatchedItems": 9.74
  }

• name: required(string)

  Id of this document that client (aka you) had set when sending the image of document in the first place.

  • Helps you to retrieve a document by it's name
• endpointUid: (string)

  Endpoint id that had served this document

• campaignUid: (string)

  If this document is a part of promotion campaign, id of campaign is displayed here

• companyUid: (string)

  ID of the company which owns this Document (automatically set with Auth0 connection)

• status: required(one of WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS, PROCESSING, PROCESSED, NOT_EXPLOITABLE)

  As of today we have 5 status for differents states of an image in our systems, when everything is fine PROCESSED

• processReport: required(one of NO_ERROR, BAD_QUALITY_IMAGE, NOT_ENOUGH_TEXT, MULTIPLE_RECEIPT, UNREADABLE, BAD_LOCALE, NOT_RECEIPT, ERROR_JPG, BAD_URL, NOT_ANALYZED)

  Process Report represent a more detailled reason about why a receipt has not been analyzed correctly A key to let the client knows what happened during analysis, helps you understand the status

  • NO_ERROR => Everything is fine, this come with the PROCESSED status by default
  • BAD_QUALITY_IMAGE => We detected a too blurry image or too dark, it can also be the resolution of the image
  • NOT_ENOUGH_TEXT => Self explicit, we have a threshold for the text recognition in image, if our OCR did not found enough text to generate a satisfiable amount of data, we abandon the Process
  • MULTIPLE_RECEIPT => We do not handle multiple receipt in one image, when we detect this case, we stop the process
  • UNREADABLE => Our OCR could not determine any Text in the image
  • BAD_LOCALE => We could not find any language for the detection to operate. This means that the Language or country is currently not supported by our system
  • NOT_RECEIPT => We didn't find any receipt in the image
  • ERROR_IMAGE_FORMAT => The image format is not valid (not one of jpg, pdf, png)
  • BAD_URL => No image has been found at the given URL (internal error)
  • NOT_ANALYZED => The document has not been analyzed for the moment, this comes with the WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS or PROCESSING statuses
• imageUrl: required(string)

  URL for getting image from a cdn repository

• metaData: (object)

  Exif metadata extracted from IMAGE_TREAT process
• imageQuality: (object)

  Set of key-value describing quality of image, generated from IMAGE_TREAT process
• userPseudoId: (string)

  This ID correspond to a custom and client managed id specified by the developer of the application that had setup AGKit SDK (aka you in general).

  • This can also come from an userId that you sent over this very API when sending a receipt
• data: (object)

  Actual data that has been extracted from the receipt content
  Note: This field will be empty on the first document post response, as the process is running asynchronously, expect this field to be filled with data when the Status is set to PROCESSED

  • payment: (string)

    Buying mode or paiment method(s) in one string separated by | (pipe), out of following CARD, CASH, CHEQUE, OTHER

  • buyHour: (string)

    The hour displayed on the receipt (ISO 8601 Time 'hh:mm:ss')

  • buyDate: (string)

    Date of buy for the receipt (ISO 8601 Date 2018-10-22)

  • articleCount: (number)

    Number of items in cart for this receipt

  • total: (number)

    Total amount paid by the customer (can be negative !)

  • currency: (string)

    The currency used for paiement (ISO 4217 EUR)

  • locale: (string)

    Locale found for this receipt

  • shop: (object)

    informations about the shop

    • city: (string)

      City where the store of this buy is located

    • sign: (string)

      Store name or sign name / Brand of the shop

    • phone: (string)

      Phone number of the store

    • address: (string)

      Exact address of the store

    • postalCode: (string)

      Postal code for the city where we found this store

    • geoLocation: (string)

      Latitude and longitude for the shop, following https://tools.ietf.org/html/rfc5870 standard (example 13.4125,103.8667)

  • items: (array of object)

    Items with products detected

    Items: items

    • id: required(string)

      An ID unique to this list of item. Mainly used to identify this particular item in this receipt for our rule processor to indicate which item has matched a given rule.

    • rawLabel: (string)

      Raw line read on the receipt by OCR

    • shortLabel: (string)

      Detected short label from rawLabel, we remove price and other non label data from rawLabel

    • quantity: (number)

      Quantity of item detected in receipt

    • unitPrice: (number)

      A price detected for one piece of this item

    • packageUnity: (string)

      Package unity for item, for example Kg

    • mass: (number)

      The mass detected for the package, example 5 (Kg from PackageUnity)

    • flags: (array of string)

      Some notable characteristics detected on the product, BIO for example, or gluten free or anything special

    • price: (number)

      Total price for this item, (if found quantity > 1, we multiply to get this data, or we read it from receipt)

    • product: (object)

      What we understood from the item, we link item data to a clean and well organized product from our database and we put informations about it here.

      • name: (string)

        Full name unshortened if possible.

      • category: (string)

        A category for this product infered by our AI algorithm

      • categoryUid: (string)

        Reference UID from Aboutgoods taxonomy

      • brand: (string)

        Brand of product if displayed in label infered by our AI algorithm

      • brandLine: (string)

        Brand line (sub brand) infered by our AI algorithm

      • averagePrice: (number)

        Global average price for this product

      Example:

      {
        "name": "pt nav.thon filet",
        "brand": "PETIT NAVIRE",
        "brandLine": "FILETS DE THON",
        "category" : "tinned_fish",
        "categoryUid" : "4e54e68c-637f-a7d9-d509-f7e32b849f60"
      }
      

    • bundle: (number)

      Number of products in a pack. 16 x 125g, 16 is the bundle, 125g is the mass.

    Example:

    {
      "id": "fa2cb",
      "rawLabel": "x5506 OATS QUAKER BIO",
      "quantity": 1,
      "unitPrice": 1.64,
      "packageUnity": "Kg",
      "mass": 1,
      "flags": [
        "bio"
      ],
      "price": 1.64,
      "bundle": 1,
      "product": {
        "category": "breakfast_cereals",
        "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
        "brand": "QUAKER"
      }
    }

  Example:

  {
    "shop": {
      "city": "Toulon",
      "sign": "Carrefour",
      "phone": "0494419879",
      "address": "CENTRE CIAL MAYOL",
      "postalCode": "83000"
    },
    "articleCount": 2,
    "total": 4.25,
    "payment": "CARD | CASH",
    "buyDate": "2016-12-07",
    "buyHour": "11:08",
    "items": [
      {
        "id": "fa2cb",
        "rawLabel": "x5506 OATS QUAKER",
        "quantity": 1,
        "unitPrice": 1.64,
        "packageUnity": "Kg",
        "mass": 1,
        "price": 1.64,
        "bundle": 1,
        "product": {
          "name": "Quaker Oats",
          "averagePrice": 2.02,
          "category": "breakfast_cereals",
          "brand": "QUAKER"
        }
      },
      {
        "id": "9d7fb",
        "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
        "shortLabel": "BTE 6X33CL COCA CO",
        "quantity": 1,
        "unitPrice": 2.61,
        "packageUnity": "CL",
        "mass": 33,
        "bundle": 6,
        "price": 2.61,
        "product": {
          "category": "soda",
          "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
          "brand": "COCA COLA"
        }
      }
    ]
  }

Example:

{
  "uid": "89cd32b8-15e9-4e63-af5e-9e85da188fa1",
  "createdAt": "2019-09-20T08:19:57Z",
  "updatedAt": "2019-09-20T08:20:09Z",
  "dominantLanguage": "fr-FR",
  "name": "receiptTest",
  "companyUid": "test-company-uid",
  "campaignUid": "fc928982-3acc-4aea-bca3-e50d22e0b6ca",
  "userPseudoId": "8335c8d1-5ae7-440c-90d1-50543c86d9b4",
  "status": "PROCESSED",
  "processReport": "NO_ERROR",
  "imageUrl": "https://receipt.agkit.io/v2/documents/89cd32b8-15e9-4e63-af5e-9e85da188fa1/show",
  "metaData": {
    "undefined": null
  },
  "imageQuality": {},
  "data": {
    "shop": {
      "city": "Toulon",
      "sign": "Carrefour",
      "phone": "0494419879",
      "address": "CENTRE CIAL MAYOL",
      "postalCode": "83000"
    },
    "articleCount": 3,
    "total": 6.51,
    "payment": "CARD | CASH",
    "barcode": "09999000403300321612071108",
    "buyDate": "2016-12-07",
    "buyHour": "11:08",
    "items": [
      {
        "id": "fa2cb",
        "rawLabel": "x5506 OATS QUAKER               1,64",
        "quantity": 1,
        "unitPrice": 1.64,
        "packageUnity": "Kg",
        "mass": 1,
        "price": 1.64,
        "bundle": 1,
        "product": {
          "category": "breakfast_cereals",
          "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
          "brand": "QUAKER"
        }
      },
      {
        "id": "47267",
        "rawLabel": "PEPSI  REGULAR                           2,26",
        "shortLabel": "PEPSI  REGULAR",
        "quantity": 1,
        "unitPrice": 2.26,
        "bundle": 1,
        "price": 2.26,
        "product": {
          "category": "soda",
          "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
          "brand": "PEPSI"
        }
      },
      {
        "id": "9d7fb",
        "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
        "shortLabel": "BTE 6X33CL COCA CO",
        "quantity": 1,
        "unitPrice": 2.61,
        "packageUnity": "CL",
        "mass": 33,
        "bundle": 6,
        "price": 2.61,
        "product": {
          "category": "soda",
          "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
          "brand": "COCA COLA"
        }
      }
    ]
  },
  "processedRules": {
    "uid": "1234",
    "name": "Quaker",
    "dateRule": {
      "min": "2019-01-01",
      "max": "2019-11-01",
      "isMatched": false
    },
    "signRule": {
      "signList": [
        "Carrefour"
      ],
      "isMatched": true
    },
    "itemRule": {
      "term": "Quaker",
      "quantityRequired": 1,
      "isMatched": true,
      "itemsMatched": [
        "fa2cb"
      ],
      "quantityMatched": 1
    },
    "allRulesMatched": false,
    "totalPriceOfMatchedItems": 1.64
  }
}

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "badRequest" : "You are missing some field or they are malformed" }
  

HTTP status code 401

Authentication with Auth0 failed

HTTP status code 402

Your quota has been exceeded

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

HTTP status code 409

Document or name already exists for your company

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• uid: required(string)

  UID of this receipt attributed by Aboutgoods System to managed receipts

• name: required(string)

  Id given by the client to allow client to retrieve this exact document after analysis

• status: required(string)

  Status of the image quality check (EXPLOITABLE or NOT_EXPLOITABLE)

• processReport: required(string)

  Describe the reason of the status (NO_ERROR when EXPLOITABLE, BAD_QUALITY_IMAGE, MULTIPLE_RECEIPT, NOT_RECEIPT OR ERROR_IMAGE_FORMAT when NOT_EXPLOITABLE)

• imageQuality: required(object)

  Set of key-value describing quality of image. Each of them are compared to a threshold value to determine the overall quality of the image.

  • bluriness: required(integer)
  • contrast: required(integer)
  • luminosity: required(integer)
  • goodSize: required(boolean)

Example:

{
  "uid": "12345678-abcd-eeee-dcba-ab12ab12ab12",
  "name": "the one passed in query parameters",
  "status": "EXPLOITABLE",
  "processReport": "NO_ERROR",
  "imageQuality": {
    "bluriness": 158,
    "contrast": 31,
    "goodSize": true,
    "luminosity": 193
  }
}

HTTP status code 400

Cannot read image data

Secured by OAuth2.0 - Hydra

HTTP status code 202

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• uid: required(string)

  Aboutgoods generated unique ID

• createdAt: required(datetime)

  When this object has been registered in AG system

• updatedAt: required(datetime)

  The last time this entity had been updated in AG system

• dominantLanguage: required(string)

  A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

  • Usage : specifiy on which language the Receipt Analyzer should treat receipts

  Example:

  fr-FR

• appId: (string)

  If this document has been received from AGKit (our mobile application SDK), this field allow to identify the application which have been used to send the document

• processedRules: (object)
  • name: required(string)

    Name of the whole rule, must be unique for a given campaign

  • uid: required(string)

    unique uid of the rule

  • priceRule: (object)

    rule that defines rule on prices

    • eligibleOnly: required(number)

      minimum price of all matched items

    • totalAmount: (number)

      minimum total amount of receipt

    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    Example:

    {
      "eligibleOnly": 20.25,
      "totalAmount": 40,
      "isMatched": false
    }

  • itemRule: required(object)

    rule that defines terms to search and various conditions of search (or, and)

    • term: (string)

      Just a simple rule to look for this term in the receipt. Mutually exclusive with AND and TERM.

    • quantityRequired: (integer)

      minimum required quantity of term or clause (AND/OR) to find. Is added by Rulio by default = 1.

    • or: (array of object)

      The result of running OR Rule with itemsMatched and isMatched.

      Items:
    • and: (array of object)

      The result of running AND Rule with itemsMatched and isMatched.

      Items:
    • not: (array of object)

      The result of running NOT Rule with itemsMatched and isMatched.

      Items:
    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    • itemsMatched: (array of string)

      List of IDs of items that were matched by term. Even if the rule is false (quantityRequired is not met), can have some IDs.

    • quantityMatched: (integer)

      quantity of term or terms in clause (AND/OR) found (even if the quantityRequired is not met). Can be different from the number of items in itemsMatched (one product line - but bought twice)

    Example:

    {
      "quantityRequired": 2,
      "or": [
        {
          "term": "Labeyrie",
          "quantityRequired": 1,
          "itemsMatched": [
            "3"
          ],
          "isMatched": true,
          "quantityMatched": 1
        },
        {
          "term": "Blini",
          "quantityRequired": 1,
          "itemsMatched": [
            "1",
            "2"
          ],
          "quantityMatched": 2,
          "isMatched": true
        }
      ],
      "not": [
        {
          "isMatched": true,
          "term": "Auchan",
          "itemsMatched": [
            "2"
          ],
          "quantityMatched": 1
        },
        {
          "isMatched": false,
          "term": "Cora",
          "itemsMatched": [],
          "quantityMatched": 0
        },
        {
          "isMatched": false,
          "term": "Carrefour",
          "itemsMatched": [],
          "quantityMatched": 0
        }
      ],
      "itemsMatched": [
        "3",
        "1"
      ],
      "quantityMatched": 2,
      "isMatched": true
    }

  • signRule: (object)

    rule that defines the list of signs for a given promotion

    • signList: required(array of string)

      List of sign eligible for the promotion.

    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    Example:

    {
      "signList": [
        "Auchan",
        "Cora"
      ],
      "isMatched": true
    }

  • dateRule: required(object)

    rule that defines range of dates for a given promotion

    • min: required(string)

      start date of the promotion/campaign

    • max: required(string)

      last date of the promotion/campaign

    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    Example:

    {
      "min": "2019-01-01",
      "max": "2019-11-01",
      "isMatched": true
    }

  • allRulesMatched: required(boolean)

    summarizes all rules matching, true if all rules are matched

  • totalPriceOfMatchedItems: required(number)

    total price of items that matched ItemRule

  Example:

  {
    "name": "Labeyrie",
    "uid": "123",
    "itemRule": {
      "quantityRequired": 2,
      "or": [
        {
          "term": "Labeyrie",
          "quantityRequired": 1,
          "itemsMatched": [
            "3"
          ],
          "isMatched": true,
          "quantityMatched": 1
        },
        {
          "term": "Blini",
          "quantityRequired": 1,
          "itemsMatched": [
            "1",
            "2"
          ],
          "quantityMatched": 2,
          "isMatched": true
        }
      ],
      "not": [
        {
          "isMatched": true,
          "term": "Auchan",
          "itemsMatched": [
            "2"
          ],
          "quantityMatched": 1
        },
        {
          "isMatched": false,
          "term": "Cora",
          "itemsMatched": [],
          "quantityMatched": 0
        }
      ],
      "itemsMatched": [
        "3",
        "1"
      ],
      "quantityMatched": 2,
      "isMatched": true
    },
    "dateRule": {
      "min": "2019-01-01",
      "max": "2019-11-01",
      "isMatched": true
    },
    "priceRule": {
      "eligibleOnly": 15,
      "isMatched": false
    },
    "signRule": {
      "signList": [
        "Cora",
        "Auchan",
        "Carrefour"
      ],
      "isMatched": true
    },
    "allRulesMatched": false,
    "totalPriceOfMatchedItems": 9.74
  }

• name: required(string)

  Id of this document that client (aka you) had set when sending the image of document in the first place.

  • Helps you to retrieve a document by it's name
• endpointUid: (string)

  Endpoint id that had served this document

• campaignUid: (string)

  If this document is a part of promotion campaign, id of campaign is displayed here

• companyUid: (string)

  ID of the company which owns this Document (automatically set with Auth0 connection)

• status: required(one of WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS, PROCESSING, PROCESSED, NOT_EXPLOITABLE)

  As of today we have 5 status for differents states of an image in our systems, when everything is fine PROCESSED

• processReport: required(one of NO_ERROR, BAD_QUALITY_IMAGE, NOT_ENOUGH_TEXT, MULTIPLE_RECEIPT, UNREADABLE, BAD_LOCALE, NOT_RECEIPT, ERROR_JPG, BAD_URL, NOT_ANALYZED)

  Process Report represent a more detailled reason about why a receipt has not been analyzed correctly A key to let the client knows what happened during analysis, helps you understand the status

  • NO_ERROR => Everything is fine, this come with the PROCESSED status by default
  • BAD_QUALITY_IMAGE => We detected a too blurry image or too dark, it can also be the resolution of the image
  • NOT_ENOUGH_TEXT => Self explicit, we have a threshold for the text recognition in image, if our OCR did not found enough text to generate a satisfiable amount of data, we abandon the Process
  • MULTIPLE_RECEIPT => We do not handle multiple receipt in one image, when we detect this case, we stop the process
  • UNREADABLE => Our OCR could not determine any Text in the image
  • BAD_LOCALE => We could not find any language for the detection to operate. This means that the Language or country is currently not supported by our system
  • NOT_RECEIPT => We didn't find any receipt in the image
  • ERROR_IMAGE_FORMAT => The image format is not valid (not one of jpg, pdf, png)
  • BAD_URL => No image has been found at the given URL (internal error)
  • NOT_ANALYZED => The document has not been analyzed for the moment, this comes with the WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS or PROCESSING statuses
• imageUrl: required(string)

  URL for getting image from a cdn repository

• metaData: (object)

  Exif metadata extracted from IMAGE_TREAT process
• imageQuality: (object)

  Set of key-value describing quality of image, generated from IMAGE_TREAT process
• userPseudoId: (string)

  This ID correspond to a custom and client managed id specified by the developer of the application that had setup AGKit SDK (aka you in general).

  • This can also come from an userId that you sent over this very API when sending a receipt
• data: (object)

  Actual data that has been extracted from the receipt content
  Note: This field will be empty on the first document post response, as the process is running asynchronously, expect this field to be filled with data when the Status is set to PROCESSED

  • payment: (string)

    Buying mode or paiment method(s) in one string separated by | (pipe), out of following CARD, CASH, CHEQUE, OTHER

  • buyHour: (string)

    The hour displayed on the receipt (ISO 8601 Time 'hh:mm:ss')

  • buyDate: (string)

    Date of buy for the receipt (ISO 8601 Date 2018-10-22)

  • articleCount: (number)

    Number of items in cart for this receipt

  • total: (number)

    Total amount paid by the customer (can be negative !)

  • currency: (string)

    The currency used for paiement (ISO 4217 EUR)

  • locale: (string)

    Locale found for this receipt

  • shop: (object)

    informations about the shop

    • city: (string)

      City where the store of this buy is located

    • sign: (string)

      Store name or sign name / Brand of the shop

    • phone: (string)

      Phone number of the store

    • address: (string)

      Exact address of the store

    • postalCode: (string)

      Postal code for the city where we found this store

    • geoLocation: (string)

      Latitude and longitude for the shop, following https://tools.ietf.org/html/rfc5870 standard (example 13.4125,103.8667)

  • items: (array of object)

    Items with products detected

    Items: items

    • id: required(string)

      An ID unique to this list of item. Mainly used to identify this particular item in this receipt for our rule processor to indicate which item has matched a given rule.

    • rawLabel: (string)

      Raw line read on the receipt by OCR

    • shortLabel: (string)

      Detected short label from rawLabel, we remove price and other non label data from rawLabel

    • quantity: (number)

      Quantity of item detected in receipt

    • unitPrice: (number)

      A price detected for one piece of this item

    • packageUnity: (string)

      Package unity for item, for example Kg

    • mass: (number)

      The mass detected for the package, example 5 (Kg from PackageUnity)

    • flags: (array of string)

      Some notable characteristics detected on the product, BIO for example, or gluten free or anything special

    • price: (number)

      Total price for this item, (if found quantity > 1, we multiply to get this data, or we read it from receipt)

    • product: (object)

      What we understood from the item, we link item data to a clean and well organized product from our database and we put informations about it here.

      • name: (string)

        Full name unshortened if possible.

      • category: (string)

        A category for this product infered by our AI algorithm

      • categoryUid: (string)

        Reference UID from Aboutgoods taxonomy

      • brand: (string)

        Brand of product if displayed in label infered by our AI algorithm

      • brandLine: (string)

        Brand line (sub brand) infered by our AI algorithm

      • averagePrice: (number)

        Global average price for this product

      Example:

      {
        "name": "pt nav.thon filet",
        "brand": "PETIT NAVIRE",
        "brandLine": "FILETS DE THON",
        "category" : "tinned_fish",
        "categoryUid" : "4e54e68c-637f-a7d9-d509-f7e32b849f60"
      }
      

    • bundle: (number)

      Number of products in a pack. 16 x 125g, 16 is the bundle, 125g is the mass.

    Example:

    {
      "id": "fa2cb",
      "rawLabel": "x5506 OATS QUAKER BIO",
      "quantity": 1,
      "unitPrice": 1.64,
      "packageUnity": "Kg",
      "mass": 1,
      "flags": [
        "bio"
      ],
      "price": 1.64,
      "bundle": 1,
      "product": {
        "category": "breakfast_cereals",
        "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
        "brand": "QUAKER"
      }
    }

  Example:

  {
    "shop": {
      "city": "Toulon",
      "sign": "Carrefour",
      "phone": "0494419879",
      "address": "CENTRE CIAL MAYOL",
      "postalCode": "83000"
    },
    "articleCount": 2,
    "total": 4.25,
    "payment": "CARD | CASH",
    "buyDate": "2016-12-07",
    "buyHour": "11:08",
    "items": [
      {
        "id": "fa2cb",
        "rawLabel": "x5506 OATS QUAKER",
        "quantity": 1,
        "unitPrice": 1.64,
        "packageUnity": "Kg",
        "mass": 1,
        "price": 1.64,
        "bundle": 1,
        "product": {
          "name": "Quaker Oats",
          "averagePrice": 2.02,
          "category": "breakfast_cereals",
          "brand": "QUAKER"
        }
      },
      {
        "id": "9d7fb",
        "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
        "shortLabel": "BTE 6X33CL COCA CO",
        "quantity": 1,
        "unitPrice": 2.61,
        "packageUnity": "CL",
        "mass": 33,
        "bundle": 6,
        "price": 2.61,
        "product": {
          "category": "soda",
          "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
          "brand": "COCA COLA"
        }
      }
    ]
  }

Example:

{
  "uid": "89cd32b8-15e9-4e63-af5e-9e85da188fa1",
  "createdAt": "2019-09-20T08:19:57Z",
  "updatedAt": "2019-09-20T08:20:09Z",
  "dominantLanguage": "fr-FR",
  "name": "receiptTest",
  "companyUid": "test-company-uid",
  "campaignUid": "fc928982-3acc-4aea-bca3-e50d22e0b6ca",
  "userPseudoId": "8335c8d1-5ae7-440c-90d1-50543c86d9b4",
  "status": "PROCESSED",
  "processReport": "NO_ERROR",
  "imageUrl": "https://receipt.agkit.io/v2/documents/89cd32b8-15e9-4e63-af5e-9e85da188fa1/show",
  "metaData": {
    "undefined": null
  },
  "imageQuality": {},
  "data": {
    "shop": {
      "city": "Toulon",
      "sign": "Carrefour",
      "phone": "0494419879",
      "address": "CENTRE CIAL MAYOL",
      "postalCode": "83000"
    },
    "articleCount": 3,
    "total": 6.51,
    "payment": "CARD | CASH",
    "barcode": "09999000403300321612071108",
    "buyDate": "2016-12-07",
    "buyHour": "11:08",
    "items": [
      {
        "id": "fa2cb",
        "rawLabel": "x5506 OATS QUAKER               1,64",
        "quantity": 1,
        "unitPrice": 1.64,
        "packageUnity": "Kg",
        "mass": 1,
        "price": 1.64,
        "bundle": 1,
        "product": {
          "category": "breakfast_cereals",
          "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
          "brand": "QUAKER"
        }
      },
      {
        "id": "47267",
        "rawLabel": "PEPSI  REGULAR                           2,26",
        "shortLabel": "PEPSI  REGULAR",
        "quantity": 1,
        "unitPrice": 2.26,
        "bundle": 1,
        "price": 2.26,
        "product": {
          "category": "soda",
          "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
          "brand": "PEPSI"
        }
      },
      {
        "id": "9d7fb",
        "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
        "shortLabel": "BTE 6X33CL COCA CO",
        "quantity": 1,
        "unitPrice": 2.61,
        "packageUnity": "CL",
        "mass": 33,
        "bundle": 6,
        "price": 2.61,
        "product": {
          "category": "soda",
          "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
          "brand": "COCA COLA"
        }
      }
    ]
  },
  "processedRules": {
    "uid": "1234",
    "name": "Quaker",
    "dateRule": {
      "min": "2019-01-01",
      "max": "2019-11-01",
      "isMatched": false
    },
    "signRule": {
      "signList": [
        "Carrefour"
      ],
      "isMatched": true
    },
    "itemRule": {
      "term": "Quaker",
      "quantityRequired": 1,
      "isMatched": true,
      "itemsMatched": [
        "fa2cb"
      ],
      "quantityMatched": 1
    },
    "allRulesMatched": false,
    "totalPriceOfMatchedItems": 1.64
  }
}

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "badRequest" : "You are missing some field or they are malformed" }
  

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

Secured by OAuth2.0 - Hydra

HTTP status code 204

Image has been deleted

HTTP status code 403

You cannot access this resources with this token

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: image/jpg

Type: file

Media type: image/png

Type: file

Media type: application/pdf

Type: file

HTTP status code 403

You cannot access this resources with this token

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

HTTP status code 200

Body

Media type: application/json

Type: object

• countPerPage: required(integer)

  Number of result returned by this page

• totalEntities: required(integer)

  Total number of results available for this request

• totalPages: required(integer)

  Total number of pages available for this request

• nextPageUri: required(string)

  Request URI (URL without hostname) that allow to go to the next page of result, can be empty if there is no next page

  Example:

  /{entity}?page=1&per_page=3
  

• prevPageUri: required(string)

  Request URI (URL without hostname) that allow to go to the previous page of result, can be empty if no previous page

  Example:

  /{entity}?page=1&per_page=3
  

• results: required(array of campaign)

  Items: campaign

  • uid: required(string)

    UID of this receipt attributed by Aboutgoods System to managed receipts

  • createdAt: required(datetime)

    When this object has been registered in AG system

  • updatedAt: required(datetime)

    The last time this entity had been updated in AG system

  • dominantLanguage: required(string)

    A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

    • Usage : specifiy on which language the Receipt Analyzer should treat receipts

    Example:

    fr-FR

  • name: required(string)

    Id given by the client to allow client to retrieve this exact document after analysis

  • rules: required(object)

    Rules for detection of data inside all documents that are process in the context of this campaign

    • name: required(string)

      Name of the whole rule, must be unique for a given campaign

    • uid: required(string)

      Unique uid of the rule

    • priceRule: (object)

      Rule that defines rule on prices

      • eligibleOnly: required(number)

        minimum price of all matched items. Float format.

      • totalAmount: (number)

        minimum total amount of receipt. Float format.

    • itemRule: required(object)

      Rule that defines terms to search and various conditions of search (or, and)

      • quantityRequired: (integer)

        Minimun required quantity of times this rules should be found (is added by Rulio by default = 1)

      • and: (array of object)

        AND Rule, means that this entity contains ItemRules that system will search in document to match them all. Mutually exclusive with OR and TERM.

        Items:
      • or: (array of object)

        OR Rule, means that all ItemRules in array system will search in document with an inclusive OR. Mutually exclusive with AND and TERM.

        Items:
      • not: (array of object)

        itemRules only containing terms. AND/OR are not allowed.

        Items:
      • term: (string)

        Just a simple rule to look for this term in the receipt. Mutually exclusive with AND and TERM.

      Example:

      {
        "and": [
          {
            "term": "Dodot"
          },
          {
            "or": [
              {
                "term": "geant vert"
              },
              {
                "term": "g vert"
              }
            ],
            "quantityRequired": 2
          }
        ],
        "not": [
          {
            "term": "haricot vert"
          }
        ]
      }

    • signRule: (object)

      Rule that defines the list of signs for a given promotion

      • signList: required(array of string)

        List of sign eligible for the promotion.

      Example:

      {
        "signList": [
          "Auchan",
          "Cora"
        ]
      }

    • dateRule: required(object)

      Rule that defines range of dates for a given promotion

      • min: required(string)

        start date of the promotion/campaign

      • max: required(string)

        last date of the promotion/campaign

    Example:

    {
      "name": "Labeyrie",
      "uid": "123",
      "dateRule": {
        "min": "2019-01-01",
        "max": "2019-11-01"
      },
      "priceRule": {
        "eligibleOnly": 20.25,
        "totalAmount": 40
      },
      "signRule": {
        "signList": [
          "Cora",
          "Auchan",
          "Carrefour"
        ]
      },
      "itemRule": {
        "or": [
          {
            "term": "Labeyrie"
          },
          {
            "term": "Blini"
          }
        ],
        "quantityRequired": 2,
        "not": [
          {
            "term": "Auchan"
          },
          {
            "term": "Cora"
          }
        ]
      }
    }

  • companyId: required(string)

    ID of the company which owns this Campaign (automatically set with Auth0 connection)

  • outgoingUrl: (string)

    An URL that will be called when a document analysis is over. This URL must handle a document POST request with analysis in JSON.

  Example:

  {
    "uid": "003473db-f05b-4f72-a6a7-fffa39ed96b9",
    "createdAt": "2019-10-10T13:20:34Z",
    "updatedAt": "2019-10-10T13:20:34Z",
    "outgoingUrl": "https://myCallbackUrl/post",
    "dominantLanguage": "fr-FR",
    "name": "Test de campagne",
    "companyId": "myCompany",
    "rules": {
      "uid": "azertyuiop",
      "name": "Test de rules",
      "dateRule": {
        "min": "2010-09-01",
        "max": "2019-09-30"
      },
      "priceRule": {
        "eligibleOnly": 5
      },
      "signRule": {
        "signList": [
          "carrefour"
        ]
      },
      "itemRule": {
        "quantityRequired": 1,
        "or": [
          {
            "quantityRequired": 1,
            "term": "tomato"
          },
          {
            "quantityRequired": 1,
            "term": "carrots"
          }
        ]
      }
    }
  }

HTTP status code 400

Filter malformed or invalid filter key

HTTP status code 403

You cannot access this resources with this token

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• uid: required(string)

  UID of this receipt attributed by Aboutgoods System to managed receipts

• createdAt: required(datetime)

  When this object has been registered in AG system

• updatedAt: required(datetime)

  The last time this entity had been updated in AG system

• dominantLanguage: required(string)

  A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

  • Usage : specifiy on which language the Receipt Analyzer should treat receipts

  Example:

  fr-FR

• name: required(string)

  Id given by the client to allow client to retrieve this exact document after analysis

• rules: required(object)

  Rules for detection of data inside all documents that are process in the context of this campaign

  • name: required(string)

    Name of the whole rule, must be unique for a given campaign

  • uid: required(string)

    Unique uid of the rule

  • priceRule: (object)

    Rule that defines rule on prices

    • eligibleOnly: required(number)

      minimum price of all matched items. Float format.

    • totalAmount: (number)

      minimum total amount of receipt. Float format.

  • itemRule: required(object)

    Rule that defines terms to search and various conditions of search (or, and)

    • quantityRequired: (integer)

      Minimun required quantity of times this rules should be found (is added by Rulio by default = 1)

    • and: (array of object)

      AND Rule, means that this entity contains ItemRules that system will search in document to match them all. Mutually exclusive with OR and TERM.

      Items:
    • or: (array of object)

      OR Rule, means that all ItemRules in array system will search in document with an inclusive OR. Mutually exclusive with AND and TERM.

      Items:
    • not: (array of object)

      itemRules only containing terms. AND/OR are not allowed.

      Items:
    • term: (string)

      Just a simple rule to look for this term in the receipt. Mutually exclusive with AND and TERM.

    Example:

    {
      "and": [
        {
          "term": "Dodot"
        },
        {
          "or": [
            {
              "term": "geant vert"
            },
            {
              "term": "g vert"
            }
          ],
          "quantityRequired": 2
        }
      ],
      "not": [
        {
          "term": "haricot vert"
        }
      ]
    }

  • signRule: (object)

    Rule that defines the list of signs for a given promotion

    • signList: required(array of string)

      List of sign eligible for the promotion.

    Example:

    {
      "signList": [
        "Auchan",
        "Cora"
      ]
    }

  • dateRule: required(object)

    Rule that defines range of dates for a given promotion

    • min: required(string)

      start date of the promotion/campaign

    • max: required(string)

      last date of the promotion/campaign

  Example:

  {
    "name": "Labeyrie",
    "uid": "123",
    "dateRule": {
      "min": "2019-01-01",
      "max": "2019-11-01"
    },
    "priceRule": {
      "eligibleOnly": 20.25,
      "totalAmount": 40
    },
    "signRule": {
      "signList": [
        "Cora",
        "Auchan",
        "Carrefour"
      ]
    },
    "itemRule": {
      "or": [
        {
          "term": "Labeyrie"
        },
        {
          "term": "Blini"
        }
      ],
      "quantityRequired": 2,
      "not": [
        {
          "term": "Auchan"
        },
        {
          "term": "Cora"
        }
      ]
    }
  }

• companyId: required(string)

  ID of the company which owns this Campaign (automatically set with Auth0 connection)

• outgoingUrl: (string)

  An URL that will be called when a document analysis is over. This URL must handle a document POST request with analysis in JSON.

Example:

{
  "uid": "003473db-f05b-4f72-a6a7-fffa39ed96b9",
  "createdAt": "2019-10-10T13:20:34Z",
  "updatedAt": "2019-10-10T13:20:34Z",
  "outgoingUrl": "https://myCallbackUrl/post",
  "dominantLanguage": "fr-FR",
  "name": "Test de campagne",
  "companyId": "myCompany",
  "rules": {
    "uid": "azertyuiop",
    "name": "Test de rules",
    "dateRule": {
      "min": "2010-09-01",
      "max": "2019-09-30"
    },
    "priceRule": {
      "eligibleOnly": 5
    },
    "signRule": {
      "signList": [
        "carrefour"
      ]
    },
    "itemRule": {
      "quantityRequired": 1,
      "or": [
        {
          "quantityRequired": 1,
          "term": "tomato"
        },
        {
          "quantityRequired": 1,
          "term": "carrots"
        }
      ]
    }
  }
}

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

HTTP status code 406

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notAcceptable" : "Some fields contains invalid characters" }
  

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• countTotal: required(integer)

  Number total of documents associated to the filtered request

• countByStatus: required(object)
  • waitingForDocument: required(integer)

    Number of documents with status WAITING_FOR_DOCUMENT

  • waitingForProcess: required(integer)

    Number of documents with status WAITING_FOR_PROCESS

  • processing: required(integer)

    Number of documents with status PROCESSING

  • processed: required(integer)

    Number of documents with status PROCESSED

  • notExploitable: required(integer)

    Number of documents with status NOT_EXPLOITABLE

• countRulesMatched: required(integer)

  Number of documents which matched a rule (at least one product matched in the document)

Example:

{
  "countTotal": 9,
  "countByStatus": {
    "notExploitable": 1,
    "processed": 1,
    "processing": 1,
    "waitingForDocument": 4,
    "waitingForProcess": 2
  },
  "countRulesMatched": 1
}

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• uid: required(string)

  UID of this receipt attributed by Aboutgoods System to managed receipts

• createdAt: required(datetime)

  When this object has been registered in AG system

• updatedAt: required(datetime)

  The last time this entity had been updated in AG system

• dominantLanguage: required(string)

  A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

  • Usage : specifiy on which language the Receipt Analyzer should treat receipts

  Example:

  fr-FR

• name: required(string)

  Id given by the client to allow client to retrieve this exact document after analysis

• rules: required(object)

  Rules for detection of data inside all documents that are process in the context of this campaign

  • name: required(string)

    Name of the whole rule, must be unique for a given campaign

  • uid: required(string)

    Unique uid of the rule

  • priceRule: (object)

    Rule that defines rule on prices

    • eligibleOnly: required(number)

      minimum price of all matched items. Float format.

    • totalAmount: (number)

      minimum total amount of receipt. Float format.

  • itemRule: required(object)

    Rule that defines terms to search and various conditions of search (or, and)

    • quantityRequired: (integer)

      Minimun required quantity of times this rules should be found (is added by Rulio by default = 1)

    • and: (array of object)

      AND Rule, means that this entity contains ItemRules that system will search in document to match them all. Mutually exclusive with OR and TERM.

      Items:
    • or: (array of object)

      OR Rule, means that all ItemRules in array system will search in document with an inclusive OR. Mutually exclusive with AND and TERM.

      Items:
    • not: (array of object)

      itemRules only containing terms. AND/OR are not allowed.

      Items:
    • term: (string)

      Just a simple rule to look for this term in the receipt. Mutually exclusive with AND and TERM.

    Example:

    {
      "and": [
        {
          "term": "Dodot"
        },
        {
          "or": [
            {
              "term": "geant vert"
            },
            {
              "term": "g vert"
            }
          ],
          "quantityRequired": 2
        }
      ],
      "not": [
        {
          "term": "haricot vert"
        }
      ]
    }

  • signRule: (object)

    Rule that defines the list of signs for a given promotion

    • signList: required(array of string)

      List of sign eligible for the promotion.

    Example:

    {
      "signList": [
        "Auchan",
        "Cora"
      ]
    }

  • dateRule: required(object)

    Rule that defines range of dates for a given promotion

    • min: required(string)

      start date of the promotion/campaign

    • max: required(string)

      last date of the promotion/campaign

  Example:

  {
    "name": "Labeyrie",
    "uid": "123",
    "dateRule": {
      "min": "2019-01-01",
      "max": "2019-11-01"
    },
    "priceRule": {
      "eligibleOnly": 20.25,
      "totalAmount": 40
    },
    "signRule": {
      "signList": [
        "Cora",
        "Auchan",
        "Carrefour"
      ]
    },
    "itemRule": {
      "or": [
        {
          "term": "Labeyrie"
        },
        {
          "term": "Blini"
        }
      ],
      "quantityRequired": 2,
      "not": [
        {
          "term": "Auchan"
        },
        {
          "term": "Cora"
        }
      ]
    }
  }

• companyId: required(string)

  ID of the company which owns this Campaign (automatically set with Auth0 connection)

• outgoingUrl: (string)

  An URL that will be called when a document analysis is over. This URL must handle a document POST request with analysis in JSON.

Example:

{
  "uid": "003473db-f05b-4f72-a6a7-fffa39ed96b9",
  "createdAt": "2019-10-10T13:20:34Z",
  "updatedAt": "2019-10-10T13:20:34Z",
  "outgoingUrl": "https://myCallbackUrl/post",
  "dominantLanguage": "fr-FR",
  "name": "Test de campagne",
  "companyId": "myCompany",
  "rules": {
    "uid": "azertyuiop",
    "name": "Test de rules",
    "dateRule": {
      "min": "2010-09-01",
      "max": "2019-09-30"
    },
    "priceRule": {
      "eligibleOnly": 5
    },
    "signRule": {
      "signList": [
        "carrefour"
      ]
    },
    "itemRule": {
      "quantityRequired": 1,
      "or": [
        {
          "quantityRequired": 1,
          "term": "tomato"
        },
        {
          "quantityRequired": 1,
          "term": "carrots"
        }
      ]
    }
  }
}

HTTP status code 403

You cannot access this resources with this token

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• uid: required(string)

  UID of this receipt attributed by Aboutgoods System to managed receipts

• createdAt: required(datetime)

  When this object has been registered in AG system

• updatedAt: required(datetime)

  The last time this entity had been updated in AG system

• dominantLanguage: required(string)

  A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

  • Usage : specifiy on which language the Receipt Analyzer should treat receipts

  Example:

  fr-FR

• name: required(string)

  Id given by the client to allow client to retrieve this exact document after analysis

• rules: required(object)

  Rules for detection of data inside all documents that are process in the context of this campaign

  • name: required(string)

    Name of the whole rule, must be unique for a given campaign

  • uid: required(string)

    Unique uid of the rule

  • priceRule: (object)

    Rule that defines rule on prices

    • eligibleOnly: required(number)

      minimum price of all matched items. Float format.

    • totalAmount: (number)

      minimum total amount of receipt. Float format.

  • itemRule: required(object)

    Rule that defines terms to search and various conditions of search (or, and)

    • quantityRequired: (integer)

      Minimun required quantity of times this rules should be found (is added by Rulio by default = 1)

    • and: (array of object)

      AND Rule, means that this entity contains ItemRules that system will search in document to match them all. Mutually exclusive with OR and TERM.

      Items:
    • or: (array of object)

      OR Rule, means that all ItemRules in array system will search in document with an inclusive OR. Mutually exclusive with AND and TERM.

      Items:
    • not: (array of object)

      itemRules only containing terms. AND/OR are not allowed.

      Items:
    • term: (string)

      Just a simple rule to look for this term in the receipt. Mutually exclusive with AND and TERM.

    Example:

    {
      "and": [
        {
          "term": "Dodot"
        },
        {
          "or": [
            {
              "term": "geant vert"
            },
            {
              "term": "g vert"
            }
          ],
          "quantityRequired": 2
        }
      ],
      "not": [
        {
          "term": "haricot vert"
        }
      ]
    }

  • signRule: (object)

    Rule that defines the list of signs for a given promotion

    • signList: required(array of string)

      List of sign eligible for the promotion.

    Example:

    {
      "signList": [
        "Auchan",
        "Cora"
      ]
    }

  • dateRule: required(object)

    Rule that defines range of dates for a given promotion

    • min: required(string)

      start date of the promotion/campaign

    • max: required(string)

      last date of the promotion/campaign

  Example:

  {
    "name": "Labeyrie",
    "uid": "123",
    "dateRule": {
      "min": "2019-01-01",
      "max": "2019-11-01"
    },
    "priceRule": {
      "eligibleOnly": 20.25,
      "totalAmount": 40
    },
    "signRule": {
      "signList": [
        "Cora",
        "Auchan",
        "Carrefour"
      ]
    },
    "itemRule": {
      "or": [
        {
          "term": "Labeyrie"
        },
        {
          "term": "Blini"
        }
      ],
      "quantityRequired": 2,
      "not": [
        {
          "term": "Auchan"
        },
        {
          "term": "Cora"
        }
      ]
    }
  }

• companyId: required(string)

  ID of the company which owns this Campaign (automatically set with Auth0 connection)

• outgoingUrl: (string)

  An URL that will be called when a document analysis is over. This URL must handle a document POST request with analysis in JSON.

Example:

{
  "uid": "003473db-f05b-4f72-a6a7-fffa39ed96b9",
  "createdAt": "2019-10-10T13:20:34Z",
  "updatedAt": "2019-10-10T13:20:34Z",
  "outgoingUrl": "https://myCallbackUrl/post",
  "dominantLanguage": "fr-FR",
  "name": "Test de campagne",
  "companyId": "myCompany",
  "rules": {
    "uid": "azertyuiop",
    "name": "Test de rules",
    "dateRule": {
      "min": "2010-09-01",
      "max": "2019-09-30"
    },
    "priceRule": {
      "eligibleOnly": 5
    },
    "signRule": {
      "signList": [
        "carrefour"
      ]
    },
    "itemRule": {
      "quantityRequired": 1,
      "or": [
        {
          "quantityRequired": 1,
          "term": "tomato"
        },
        {
          "quantityRequired": 1,
          "term": "carrots"
        }
      ]
    }
  }
}

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "badRequest" : "You are missing some field or they are malformed" }
  

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

HTTP status code 406

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notAcceptable" : "Some fields contains invalid characters" }
  

Secured by OAuth2.0 - Hydra

HTTP status code 204

Image has been deleted

HTTP status code 403

You cannot access this resources with this token

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

Secured by OAuth2.0 - Hydra

HTTP status code 202

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• countPerPage: required(integer)

  Number of result returned by this page

• totalEntities: required(integer)

  Total number of results available for this request

• totalPages: required(integer)

  Total number of pages available for this request

• nextPageUri: required(string)

  Request URI (URL without hostname) that allow to go to the next page of result, can be empty if there is no next page

  Example:

  /{entity}?page=1&per_page=3
  

• prevPageUri: required(string)

  Request URI (URL without hostname) that allow to go to the previous page of result, can be empty if no previous page

  Example:

  /{entity}?page=1&per_page=3
  

• results: required(array of document)

  Items: document

  • uid: required(string)

    Aboutgoods generated unique ID

  • createdAt: required(datetime)

    When this object has been registered in AG system

  • updatedAt: required(datetime)

    The last time this entity had been updated in AG system

  • dominantLanguage: required(string)

    A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

    • Usage : specifiy on which language the Receipt Analyzer should treat receipts

    Example:

    fr-FR

  • appId: (string)

    If this document has been received from AGKit (our mobile application SDK), this field allow to identify the application which have been used to send the document

  • processedRules: (object)
    • name: required(string)

      Name of the whole rule, must be unique for a given campaign

    • uid: required(string)

      unique uid of the rule

    • priceRule: (object)

      rule that defines rule on prices

      • eligibleOnly: required(number)

        minimum price of all matched items

      • totalAmount: (number)

        minimum total amount of receipt

      • isMatched: required(boolean)

        tells if the rule is matched in receipt

      Example:

      {
        "eligibleOnly": 20.25,
        "totalAmount": 40,
        "isMatched": false
      }

    • itemRule: required(object)

      rule that defines terms to search and various conditions of search (or, and)

      • term: (string)

        Just a simple rule to look for this term in the receipt. Mutually exclusive with AND and TERM.

      • quantityRequired: (integer)

        minimum required quantity of term or clause (AND/OR) to find. Is added by Rulio by default = 1.

      • or: (array of object)

        The result of running OR Rule with itemsMatched and isMatched.

        Items:
      • and: (array of object)

        The result of running AND Rule with itemsMatched and isMatched.

        Items:
      • not: (array of object)

        The result of running NOT Rule with itemsMatched and isMatched.

        Items:
      • isMatched: required(boolean)

        tells if the rule is matched in receipt

      • itemsMatched: (array of string)

        List of IDs of items that were matched by term. Even if the rule is false (quantityRequired is not met), can have some IDs.

      • quantityMatched: (integer)

        quantity of term or terms in clause (AND/OR) found (even if the quantityRequired is not met). Can be different from the number of items in itemsMatched (one product line - but bought twice)

      Example:

      {
        "quantityRequired": 2,
        "or": [
          {
            "term": "Labeyrie",
            "quantityRequired": 1,
            "itemsMatched": [
              "3"
            ],
            "isMatched": true,
            "quantityMatched": 1
          },
          {
            "term": "Blini",
            "quantityRequired": 1,
            "itemsMatched": [
              "1",
              "2"
            ],
            "quantityMatched": 2,
            "isMatched": true
          }
        ],
        "not": [
          {
            "isMatched": true,
            "term": "Auchan",
            "itemsMatched": [
              "2"
            ],
            "quantityMatched": 1
          },
          {
            "isMatched": false,
            "term": "Cora",
            "itemsMatched": [],
            "quantityMatched": 0
          },
          {
            "isMatched": false,
            "term": "Carrefour",
            "itemsMatched": [],
            "quantityMatched": 0
          }
        ],
        "itemsMatched": [
          "3",
          "1"
        ],
        "quantityMatched": 2,
        "isMatched": true
      }

    • signRule: (object)

      rule that defines the list of signs for a given promotion

      • signList: required(array of string)

        List of sign eligible for the promotion.

      • isMatched: required(boolean)

        tells if the rule is matched in receipt

      Example:

      {
        "signList": [
          "Auchan",
          "Cora"
        ],
        "isMatched": true
      }

    • dateRule: required(object)

      rule that defines range of dates for a given promotion

      • min: required(string)

        start date of the promotion/campaign

      • max: required(string)

        last date of the promotion/campaign

      • isMatched: required(boolean)

        tells if the rule is matched in receipt

      Example:

      {
        "min": "2019-01-01",
        "max": "2019-11-01",
        "isMatched": true
      }

    • allRulesMatched: required(boolean)

      summarizes all rules matching, true if all rules are matched

    • totalPriceOfMatchedItems: required(number)

      total price of items that matched ItemRule

    Example:

    {
      "name": "Labeyrie",
      "uid": "123",
      "itemRule": {
        "quantityRequired": 2,
        "or": [
          {
            "term": "Labeyrie",
            "quantityRequired": 1,
            "itemsMatched": [
              "3"
            ],
            "isMatched": true,
            "quantityMatched": 1
          },
          {
            "term": "Blini",
            "quantityRequired": 1,
            "itemsMatched": [
              "1",
              "2"
            ],
            "quantityMatched": 2,
            "isMatched": true
          }
        ],
        "not": [
          {
            "isMatched": true,
            "term": "Auchan",
            "itemsMatched": [
              "2"
            ],
            "quantityMatched": 1
          },
          {
            "isMatched": false,
            "term": "Cora",
            "itemsMatched": [],
            "quantityMatched": 0
          }
        ],
        "itemsMatched": [
          "3",
          "1"
        ],
        "quantityMatched": 2,
        "isMatched": true
      },
      "dateRule": {
        "min": "2019-01-01",
        "max": "2019-11-01",
        "isMatched": true
      },
      "priceRule": {
        "eligibleOnly": 15,
        "isMatched": false
      },
      "signRule": {
        "signList": [
          "Cora",
          "Auchan",
          "Carrefour"
        ],
        "isMatched": true
      },
      "allRulesMatched": false,
      "totalPriceOfMatchedItems": 9.74
    }

  • name: required(string)

    Id of this document that client (aka you) had set when sending the image of document in the first place.

    • Helps you to retrieve a document by it's name
  • endpointUid: (string)

    Endpoint id that had served this document

  • campaignUid: (string)

    If this document is a part of promotion campaign, id of campaign is displayed here

  • companyUid: (string)

    ID of the company which owns this Document (automatically set with Auth0 connection)

  • status: required(one of WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS, PROCESSING, PROCESSED, NOT_EXPLOITABLE)

    As of today we have 5 status for differents states of an image in our systems, when everything is fine PROCESSED

  • processReport: required(one of NO_ERROR, BAD_QUALITY_IMAGE, NOT_ENOUGH_TEXT, MULTIPLE_RECEIPT, UNREADABLE, BAD_LOCALE, NOT_RECEIPT, ERROR_JPG, BAD_URL, NOT_ANALYZED)

    Process Report represent a more detailled reason about why a receipt has not been analyzed correctly A key to let the client knows what happened during analysis, helps you understand the status

    • NO_ERROR => Everything is fine, this come with the PROCESSED status by default
    • BAD_QUALITY_IMAGE => We detected a too blurry image or too dark, it can also be the resolution of the image
    • NOT_ENOUGH_TEXT => Self explicit, we have a threshold for the text recognition in image, if our OCR did not found enough text to generate a satisfiable amount of data, we abandon the Process
    • MULTIPLE_RECEIPT => We do not handle multiple receipt in one image, when we detect this case, we stop the process
    • UNREADABLE => Our OCR could not determine any Text in the image
    • BAD_LOCALE => We could not find any language for the detection to operate. This means that the Language or country is currently not supported by our system
    • NOT_RECEIPT => We didn't find any receipt in the image
    • ERROR_IMAGE_FORMAT => The image format is not valid (not one of jpg, pdf, png)
    • BAD_URL => No image has been found at the given URL (internal error)
    • NOT_ANALYZED => The document has not been analyzed for the moment, this comes with the WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS or PROCESSING statuses
  • imageUrl: required(string)

    URL for getting image from a cdn repository

  • metaData: (object)

    Exif metadata extracted from IMAGE_TREAT process
  • imageQuality: (object)

    Set of key-value describing quality of image, generated from IMAGE_TREAT process
  • userPseudoId: (string)

    This ID correspond to a custom and client managed id specified by the developer of the application that had setup AGKit SDK (aka you in general).

    • This can also come from an userId that you sent over this very API when sending a receipt
  • data: (object)

    Actual data that has been extracted from the receipt content
    Note: This field will be empty on the first document post response, as the process is running asynchronously, expect this field to be filled with data when the Status is set to PROCESSED

    • payment: (string)

      Buying mode or paiment method(s) in one string separated by | (pipe), out of following CARD, CASH, CHEQUE, OTHER

    • buyHour: (string)

      The hour displayed on the receipt (ISO 8601 Time 'hh:mm:ss')

    • buyDate: (string)

      Date of buy for the receipt (ISO 8601 Date 2018-10-22)

    • articleCount: (number)

      Number of items in cart for this receipt

    • total: (number)

      Total amount paid by the customer (can be negative !)

    • currency: (string)

      The currency used for paiement (ISO 4217 EUR)

    • locale: (string)

      Locale found for this receipt

    • shop: (object)

      informations about the shop

      • city: (string)

        City where the store of this buy is located

      • sign: (string)

        Store name or sign name / Brand of the shop

      • phone: (string)

        Phone number of the store

      • address: (string)

        Exact address of the store

      • postalCode: (string)

        Postal code for the city where we found this store

      • geoLocation: (string)

        Latitude and longitude for the shop, following https://tools.ietf.org/html/rfc5870 standard (example 13.4125,103.8667)

    • items: (array of object)

      Items with products detected

      Items: items

      • id: required(string)

        An ID unique to this list of item. Mainly used to identify this particular item in this receipt for our rule processor to indicate which item has matched a given rule.

      • rawLabel: (string)

        Raw line read on the receipt by OCR

      • shortLabel: (string)

        Detected short label from rawLabel, we remove price and other non label data from rawLabel

      • quantity: (number)

        Quantity of item detected in receipt

      • unitPrice: (number)

        A price detected for one piece of this item

      • packageUnity: (string)

        Package unity for item, for example Kg

      • mass: (number)

        The mass detected for the package, example 5 (Kg from PackageUnity)

      • flags: (array of string)

        Some notable characteristics detected on the product, BIO for example, or gluten free or anything special

      • price: (number)

        Total price for this item, (if found quantity > 1, we multiply to get this data, or we read it from receipt)

      • product: (object)

        What we understood from the item, we link item data to a clean and well organized product from our database and we put informations about it here.

        • name: (string)

          Full name unshortened if possible.

        • category: (string)

          A category for this product infered by our AI algorithm

        • categoryUid: (string)

          Reference UID from Aboutgoods taxonomy

        • brand: (string)

          Brand of product if displayed in label infered by our AI algorithm

        • brandLine: (string)

          Brand line (sub brand) infered by our AI algorithm

        • averagePrice: (number)

          Global average price for this product

        Example:

        {
          "name": "pt nav.thon filet",
          "brand": "PETIT NAVIRE",
          "brandLine": "FILETS DE THON",
          "category" : "tinned_fish",
          "categoryUid" : "4e54e68c-637f-a7d9-d509-f7e32b849f60"
        }
        

      • bundle: (number)

        Number of products in a pack. 16 x 125g, 16 is the bundle, 125g is the mass.

      Example:

      {
        "id": "fa2cb",
        "rawLabel": "x5506 OATS QUAKER BIO",
        "quantity": 1,
        "unitPrice": 1.64,
        "packageUnity": "Kg",
        "mass": 1,
        "flags": [
          "bio"
        ],
        "price": 1.64,
        "bundle": 1,
        "product": {
          "category": "breakfast_cereals",
          "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
          "brand": "QUAKER"
        }
      }

    Example:

    {
      "shop": {
        "city": "Toulon",
        "sign": "Carrefour",
        "phone": "0494419879",
        "address": "CENTRE CIAL MAYOL",
        "postalCode": "83000"
      },
      "articleCount": 2,
      "total": 4.25,
      "payment": "CARD | CASH",
      "buyDate": "2016-12-07",
      "buyHour": "11:08",
      "items": [
        {
          "id": "fa2cb",
          "rawLabel": "x5506 OATS QUAKER",
          "quantity": 1,
          "unitPrice": 1.64,
          "packageUnity": "Kg",
          "mass": 1,
          "price": 1.64,
          "bundle": 1,
          "product": {
            "name": "Quaker Oats",
            "averagePrice": 2.02,
            "category": "breakfast_cereals",
            "brand": "QUAKER"
          }
        },
        {
          "id": "9d7fb",
          "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
          "shortLabel": "BTE 6X33CL COCA CO",
          "quantity": 1,
          "unitPrice": 2.61,
          "packageUnity": "CL",
          "mass": 33,
          "bundle": 6,
          "price": 2.61,
          "product": {
            "category": "soda",
            "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
            "brand": "COCA COLA"
          }
        }
      ]
    }

  Example:

  {
    "uid": "89cd32b8-15e9-4e63-af5e-9e85da188fa1",
    "createdAt": "2019-09-20T08:19:57Z",
    "updatedAt": "2019-09-20T08:20:09Z",
    "dominantLanguage": "fr-FR",
    "name": "receiptTest",
    "companyUid": "test-company-uid",
    "campaignUid": "fc928982-3acc-4aea-bca3-e50d22e0b6ca",
    "userPseudoId": "8335c8d1-5ae7-440c-90d1-50543c86d9b4",
    "status": "PROCESSED",
    "processReport": "NO_ERROR",
    "imageUrl": "https://receipt.agkit.io/v2/documents/89cd32b8-15e9-4e63-af5e-9e85da188fa1/show",
    "metaData": {
      "undefined": null
    },
    "imageQuality": {},
    "data": {
      "shop": {
        "city": "Toulon",
        "sign": "Carrefour",
        "phone": "0494419879",
        "address": "CENTRE CIAL MAYOL",
        "postalCode": "83000"
      },
      "articleCount": 3,
      "total": 6.51,
      "payment": "CARD | CASH",
      "barcode": "09999000403300321612071108",
      "buyDate": "2016-12-07",
      "buyHour": "11:08",
      "items": [
        {
          "id": "fa2cb",
          "rawLabel": "x5506 OATS QUAKER               1,64",
          "quantity": 1,
          "unitPrice": 1.64,
          "packageUnity": "Kg",
          "mass": 1,
          "price": 1.64,
          "bundle": 1,
          "product": {
            "category": "breakfast_cereals",
            "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
            "brand": "QUAKER"
          }
        },
        {
          "id": "47267",
          "rawLabel": "PEPSI  REGULAR                           2,26",
          "shortLabel": "PEPSI  REGULAR",
          "quantity": 1,
          "unitPrice": 2.26,
          "bundle": 1,
          "price": 2.26,
          "product": {
            "category": "soda",
            "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
            "brand": "PEPSI"
          }
        },
        {
          "id": "9d7fb",
          "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
          "shortLabel": "BTE 6X33CL COCA CO",
          "quantity": 1,
          "unitPrice": 2.61,
          "packageUnity": "CL",
          "mass": 33,
          "bundle": 6,
          "price": 2.61,
          "product": {
            "category": "soda",
            "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
            "brand": "COCA COLA"
          }
        }
      ]
    },
    "processedRules": {
      "uid": "1234",
      "name": "Quaker",
      "dateRule": {
        "min": "2019-01-01",
        "max": "2019-11-01",
        "isMatched": false
      },
      "signRule": {
        "signList": [
          "Carrefour"
        ],
        "isMatched": true
      },
      "itemRule": {
        "term": "Quaker",
        "quantityRequired": 1,
        "isMatched": true,
        "itemsMatched": [
          "fa2cb"
        ],
        "quantityMatched": 1
      },
      "allRulesMatched": false,
      "totalPriceOfMatchedItems": 1.64
    }
  }

HTTP status code 400

Filter malformed or invalid filter key

HTTP status code 403

You cannot access this resources with this token

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• uid: required(string)

  Aboutgoods generated unique ID

• createdAt: required(datetime)

  When this object has been registered in AG system

• updatedAt: required(datetime)

  The last time this entity had been updated in AG system

• dominantLanguage: required(string)

  A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

  • Usage : specifiy on which language the Receipt Analyzer should treat receipts

  Example:

  fr-FR

• appId: (string)

  If this document has been received from AGKit (our mobile application SDK), this field allow to identify the application which have been used to send the document

• processedRules: (object)
  • name: required(string)

    Name of the whole rule, must be unique for a given campaign

  • uid: required(string)

    unique uid of the rule

  • priceRule: (object)

    rule that defines rule on prices

    • eligibleOnly: required(number)

      minimum price of all matched items

    • totalAmount: (number)

      minimum total amount of receipt

    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    Example:

    {
      "eligibleOnly": 20.25,
      "totalAmount": 40,
      "isMatched": false
    }

  • itemRule: required(object)

    rule that defines terms to search and various conditions of search (or, and)

    • term: (string)

      Just a simple rule to look for this term in the receipt. Mutually exclusive with AND and TERM.

    • quantityRequired: (integer)

      minimum required quantity of term or clause (AND/OR) to find. Is added by Rulio by default = 1.

    • or: (array of object)

      The result of running OR Rule with itemsMatched and isMatched.

      Items:
    • and: (array of object)

      The result of running AND Rule with itemsMatched and isMatched.

      Items:
    • not: (array of object)

      The result of running NOT Rule with itemsMatched and isMatched.

      Items:
    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    • itemsMatched: (array of string)

      List of IDs of items that were matched by term. Even if the rule is false (quantityRequired is not met), can have some IDs.

    • quantityMatched: (integer)

      quantity of term or terms in clause (AND/OR) found (even if the quantityRequired is not met). Can be different from the number of items in itemsMatched (one product line - but bought twice)

    Example:

    {
      "quantityRequired": 2,
      "or": [
        {
          "term": "Labeyrie",
          "quantityRequired": 1,
          "itemsMatched": [
            "3"
          ],
          "isMatched": true,
          "quantityMatched": 1
        },
        {
          "term": "Blini",
          "quantityRequired": 1,
          "itemsMatched": [
            "1",
            "2"
          ],
          "quantityMatched": 2,
          "isMatched": true
        }
      ],
      "not": [
        {
          "isMatched": true,
          "term": "Auchan",
          "itemsMatched": [
            "2"
          ],
          "quantityMatched": 1
        },
        {
          "isMatched": false,
          "term": "Cora",
          "itemsMatched": [],
          "quantityMatched": 0
        },
        {
          "isMatched": false,
          "term": "Carrefour",
          "itemsMatched": [],
          "quantityMatched": 0
        }
      ],
      "itemsMatched": [
        "3",
        "1"
      ],
      "quantityMatched": 2,
      "isMatched": true
    }

  • signRule: (object)

    rule that defines the list of signs for a given promotion

    • signList: required(array of string)

      List of sign eligible for the promotion.

    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    Example:

    {
      "signList": [
        "Auchan",
        "Cora"
      ],
      "isMatched": true
    }

  • dateRule: required(object)

    rule that defines range of dates for a given promotion

    • min: required(string)

      start date of the promotion/campaign

    • max: required(string)

      last date of the promotion/campaign

    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    Example:

    {
      "min": "2019-01-01",
      "max": "2019-11-01",
      "isMatched": true
    }

  • allRulesMatched: required(boolean)

    summarizes all rules matching, true if all rules are matched

  • totalPriceOfMatchedItems: required(number)

    total price of items that matched ItemRule

  Example:

  {
    "name": "Labeyrie",
    "uid": "123",
    "itemRule": {
      "quantityRequired": 2,
      "or": [
        {
          "term": "Labeyrie",
          "quantityRequired": 1,
          "itemsMatched": [
            "3"
          ],
          "isMatched": true,
          "quantityMatched": 1
        },
        {
          "term": "Blini",
          "quantityRequired": 1,
          "itemsMatched": [
            "1",
            "2"
          ],
          "quantityMatched": 2,
          "isMatched": true
        }
      ],
      "not": [
        {
          "isMatched": true,
          "term": "Auchan",
          "itemsMatched": [
            "2"
          ],
          "quantityMatched": 1
        },
        {
          "isMatched": false,
          "term": "Cora",
          "itemsMatched": [],
          "quantityMatched": 0
        }
      ],
      "itemsMatched": [
        "3",
        "1"
      ],
      "quantityMatched": 2,
      "isMatched": true
    },
    "dateRule": {
      "min": "2019-01-01",
      "max": "2019-11-01",
      "isMatched": true
    },
    "priceRule": {
      "eligibleOnly": 15,
      "isMatched": false
    },
    "signRule": {
      "signList": [
        "Cora",
        "Auchan",
        "Carrefour"
      ],
      "isMatched": true
    },
    "allRulesMatched": false,
    "totalPriceOfMatchedItems": 9.74
  }

• name: required(string)

  Id of this document that client (aka you) had set when sending the image of document in the first place.

  • Helps you to retrieve a document by it's name
• endpointUid: (string)

  Endpoint id that had served this document

• campaignUid: (string)

  If this document is a part of promotion campaign, id of campaign is displayed here

• companyUid: (string)

  ID of the company which owns this Document (automatically set with Auth0 connection)

• status: required(one of WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS, PROCESSING, PROCESSED, NOT_EXPLOITABLE)

  As of today we have 5 status for differents states of an image in our systems, when everything is fine PROCESSED

• processReport: required(one of NO_ERROR, BAD_QUALITY_IMAGE, NOT_ENOUGH_TEXT, MULTIPLE_RECEIPT, UNREADABLE, BAD_LOCALE, NOT_RECEIPT, ERROR_JPG, BAD_URL, NOT_ANALYZED)

  Process Report represent a more detailled reason about why a receipt has not been analyzed correctly A key to let the client knows what happened during analysis, helps you understand the status

  • NO_ERROR => Everything is fine, this come with the PROCESSED status by default
  • BAD_QUALITY_IMAGE => We detected a too blurry image or too dark, it can also be the resolution of the image
  • NOT_ENOUGH_TEXT => Self explicit, we have a threshold for the text recognition in image, if our OCR did not found enough text to generate a satisfiable amount of data, we abandon the Process
  • MULTIPLE_RECEIPT => We do not handle multiple receipt in one image, when we detect this case, we stop the process
  • UNREADABLE => Our OCR could not determine any Text in the image
  • BAD_LOCALE => We could not find any language for the detection to operate. This means that the Language or country is currently not supported by our system
  • NOT_RECEIPT => We didn't find any receipt in the image
  • ERROR_IMAGE_FORMAT => The image format is not valid (not one of jpg, pdf, png)
  • BAD_URL => No image has been found at the given URL (internal error)
  • NOT_ANALYZED => The document has not been analyzed for the moment, this comes with the WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS or PROCESSING statuses
• imageUrl: required(string)

  URL for getting image from a cdn repository

• metaData: (object)

  Exif metadata extracted from IMAGE_TREAT process
• imageQuality: (object)

  Set of key-value describing quality of image, generated from IMAGE_TREAT process
• userPseudoId: (string)

  This ID correspond to a custom and client managed id specified by the developer of the application that had setup AGKit SDK (aka you in general).

  • This can also come from an userId that you sent over this very API when sending a receipt
• data: (object)

  Actual data that has been extracted from the receipt content
  Note: This field will be empty on the first document post response, as the process is running asynchronously, expect this field to be filled with data when the Status is set to PROCESSED

  • payment: (string)

    Buying mode or paiment method(s) in one string separated by | (pipe), out of following CARD, CASH, CHEQUE, OTHER

  • buyHour: (string)

    The hour displayed on the receipt (ISO 8601 Time 'hh:mm:ss')

  • buyDate: (string)

    Date of buy for the receipt (ISO 8601 Date 2018-10-22)

  • articleCount: (number)

    Number of items in cart for this receipt

  • total: (number)

    Total amount paid by the customer (can be negative !)

  • currency: (string)

    The currency used for paiement (ISO 4217 EUR)

  • locale: (string)

    Locale found for this receipt

  • shop: (object)

    informations about the shop

    • city: (string)

      City where the store of this buy is located

    • sign: (string)

      Store name or sign name / Brand of the shop

    • phone: (string)

      Phone number of the store

    • address: (string)

      Exact address of the store

    • postalCode: (string)

      Postal code for the city where we found this store

    • geoLocation: (string)

      Latitude and longitude for the shop, following https://tools.ietf.org/html/rfc5870 standard (example 13.4125,103.8667)

  • items: (array of object)

    Items with products detected

    Items: items

    • id: required(string)

      An ID unique to this list of item. Mainly used to identify this particular item in this receipt for our rule processor to indicate which item has matched a given rule.

    • rawLabel: (string)

      Raw line read on the receipt by OCR

    • shortLabel: (string)

      Detected short label from rawLabel, we remove price and other non label data from rawLabel

    • quantity: (number)

      Quantity of item detected in receipt

    • unitPrice: (number)

      A price detected for one piece of this item

    • packageUnity: (string)

      Package unity for item, for example Kg

    • mass: (number)

      The mass detected for the package, example 5 (Kg from PackageUnity)

    • flags: (array of string)

      Some notable characteristics detected on the product, BIO for example, or gluten free or anything special

    • price: (number)

      Total price for this item, (if found quantity > 1, we multiply to get this data, or we read it from receipt)

    • product: (object)

      What we understood from the item, we link item data to a clean and well organized product from our database and we put informations about it here.

      • name: (string)

        Full name unshortened if possible.

      • category: (string)

        A category for this product infered by our AI algorithm

      • categoryUid: (string)

        Reference UID from Aboutgoods taxonomy

      • brand: (string)

        Brand of product if displayed in label infered by our AI algorithm

      • brandLine: (string)

        Brand line (sub brand) infered by our AI algorithm

      • averagePrice: (number)

        Global average price for this product

      Example:

      {
        "name": "pt nav.thon filet",
        "brand": "PETIT NAVIRE",
        "brandLine": "FILETS DE THON",
        "category" : "tinned_fish",
        "categoryUid" : "4e54e68c-637f-a7d9-d509-f7e32b849f60"
      }
      

    • bundle: (number)

      Number of products in a pack. 16 x 125g, 16 is the bundle, 125g is the mass.

    Example:

    {
      "id": "fa2cb",
      "rawLabel": "x5506 OATS QUAKER BIO",
      "quantity": 1,
      "unitPrice": 1.64,
      "packageUnity": "Kg",
      "mass": 1,
      "flags": [
        "bio"
      ],
      "price": 1.64,
      "bundle": 1,
      "product": {
        "category": "breakfast_cereals",
        "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
        "brand": "QUAKER"
      }
    }

  Example:

  {
    "shop": {
      "city": "Toulon",
      "sign": "Carrefour",
      "phone": "0494419879",
      "address": "CENTRE CIAL MAYOL",
      "postalCode": "83000"
    },
    "articleCount": 2,
    "total": 4.25,
    "payment": "CARD | CASH",
    "buyDate": "2016-12-07",
    "buyHour": "11:08",
    "items": [
      {
        "id": "fa2cb",
        "rawLabel": "x5506 OATS QUAKER",
        "quantity": 1,
        "unitPrice": 1.64,
        "packageUnity": "Kg",
        "mass": 1,
        "price": 1.64,
        "bundle": 1,
        "product": {
          "name": "Quaker Oats",
          "averagePrice": 2.02,
          "category": "breakfast_cereals",
          "brand": "QUAKER"
        }
      },
      {
        "id": "9d7fb",
        "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
        "shortLabel": "BTE 6X33CL COCA CO",
        "quantity": 1,
        "unitPrice": 2.61,
        "packageUnity": "CL",
        "mass": 33,
        "bundle": 6,
        "price": 2.61,
        "product": {
          "category": "soda",
          "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
          "brand": "COCA COLA"
        }
      }
    ]
  }

Example:

{
  "uid": "89cd32b8-15e9-4e63-af5e-9e85da188fa1",
  "createdAt": "2019-09-20T08:19:57Z",
  "updatedAt": "2019-09-20T08:20:09Z",
  "dominantLanguage": "fr-FR",
  "name": "receiptTest",
  "companyUid": "test-company-uid",
  "campaignUid": "fc928982-3acc-4aea-bca3-e50d22e0b6ca",
  "userPseudoId": "8335c8d1-5ae7-440c-90d1-50543c86d9b4",
  "status": "PROCESSED",
  "processReport": "NO_ERROR",
  "imageUrl": "https://receipt.agkit.io/v2/documents/89cd32b8-15e9-4e63-af5e-9e85da188fa1/show",
  "metaData": {
    "undefined": null
  },
  "imageQuality": {},
  "data": {
    "shop": {
      "city": "Toulon",
      "sign": "Carrefour",
      "phone": "0494419879",
      "address": "CENTRE CIAL MAYOL",
      "postalCode": "83000"
    },
    "articleCount": 3,
    "total": 6.51,
    "payment": "CARD | CASH",
    "barcode": "09999000403300321612071108",
    "buyDate": "2016-12-07",
    "buyHour": "11:08",
    "items": [
      {
        "id": "fa2cb",
        "rawLabel": "x5506 OATS QUAKER               1,64",
        "quantity": 1,
        "unitPrice": 1.64,
        "packageUnity": "Kg",
        "mass": 1,
        "price": 1.64,
        "bundle": 1,
        "product": {
          "category": "breakfast_cereals",
          "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
          "brand": "QUAKER"
        }
      },
      {
        "id": "47267",
        "rawLabel": "PEPSI  REGULAR                           2,26",
        "shortLabel": "PEPSI  REGULAR",
        "quantity": 1,
        "unitPrice": 2.26,
        "bundle": 1,
        "price": 2.26,
        "product": {
          "category": "soda",
          "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
          "brand": "PEPSI"
        }
      },
      {
        "id": "9d7fb",
        "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
        "shortLabel": "BTE 6X33CL COCA CO",
        "quantity": 1,
        "unitPrice": 2.61,
        "packageUnity": "CL",
        "mass": 33,
        "bundle": 6,
        "price": 2.61,
        "product": {
          "category": "soda",
          "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
          "brand": "COCA COLA"
        }
      }
    ]
  },
  "processedRules": {
    "uid": "1234",
    "name": "Quaker",
    "dateRule": {
      "min": "2019-01-01",
      "max": "2019-11-01",
      "isMatched": false
    },
    "signRule": {
      "signList": [
        "Carrefour"
      ],
      "isMatched": true
    },
    "itemRule": {
      "term": "Quaker",
      "quantityRequired": 1,
      "isMatched": true,
      "itemsMatched": [
        "fa2cb"
      ],
      "quantityMatched": 1
    },
    "allRulesMatched": false,
    "totalPriceOfMatchedItems": 1.64
  }
}

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "badRequest" : "You are missing some field or they are malformed" }
  

HTTP status code 401

Authentication with Auth0 failed

HTTP status code 402

Your quota has been exceeded

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

HTTP status code 409

Document or name already exists for your company

Secured by OAuth2.0 - Hydra

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• uid: required(string)

  UID of this receipt attributed by Aboutgoods System to managed receipts

• createdAt: required(datetime)

  When this object has been registered in AG system

• updatedAt: required(datetime)

  The last time this entity had been updated in AG system

• dominantLanguage: required(string)

  A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

  • Usage : specifiy on which language the Receipt Analyzer should treat receipts

  Example:

  fr-FR

• outgoingUrl: (string)

  An URL that will be called when a document analysis is over. This URL must handle a document response with analysis in JSON

• name: required(string)

  Name of the endpoint from the client perspective, easy way to retrieve an endpoint by it's name, must be unique to this client

• companyUid: (string)

  ID of the company which owns this Endpoint (automatically set with Auth0 connection)

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "badRequest" : "You are missing some field or they are malformed" }
  

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• uid: required(string)

  UID of this receipt attributed by Aboutgoods System to managed receipts

• createdAt: required(datetime)

  When this object has been registered in AG system

• updatedAt: required(datetime)

  The last time this entity had been updated in AG system

• dominantLanguage: required(string)

  A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

  • Usage : specifiy on which language the Receipt Analyzer should treat receipts

  Example:

  fr-FR

• outgoingUrl: (string)

  An URL that will be called when a document analysis is over. This URL must handle a document response with analysis in JSON

• name: required(string)

  Name of the endpoint from the client perspective, easy way to retrieve an endpoint by it's name, must be unique to this client

• companyUid: (string)

  ID of the company which owns this Endpoint (automatically set with Auth0 connection)

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

HTTP status code 403

You cannot access this resources with this token

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• uid: required(string)

  UID of this receipt attributed by Aboutgoods System to managed receipts

• createdAt: required(datetime)

  When this object has been registered in AG system

• updatedAt: required(datetime)

  The last time this entity had been updated in AG system

• dominantLanguage: required(string)

  A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

  • Usage : specifiy on which language the Receipt Analyzer should treat receipts

  Example:

  fr-FR

• outgoingUrl: (string)

  An URL that will be called when a document analysis is over. This URL must handle a document response with analysis in JSON

• name: required(string)

  Name of the endpoint from the client perspective, easy way to retrieve an endpoint by it's name, must be unique to this client

• companyUid: (string)

  ID of the company which owns this Endpoint (automatically set with Auth0 connection)

HTTP status code 403

You cannot access this resources with this token

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

Secured by OAuth2.0 - Hydra

HTTP status code 204

Image has been deleted

HTTP status code 403

You cannot access this resources with this token

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

Secured by OAuth2.0 - Hydra

HTTP status code 202

HTTP status code 403

You cannot access this resources with this token

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• countPerPage: required(integer)

  Number of result returned by this page

• totalEntities: required(integer)

  Total number of results available for this request

• totalPages: required(integer)

  Total number of pages available for this request

• nextPageUri: required(string)

  Request URI (URL without hostname) that allow to go to the next page of result, can be empty if there is no next page

  Example:

  /{entity}?page=1&per_page=3
  

• prevPageUri: required(string)

  Request URI (URL without hostname) that allow to go to the previous page of result, can be empty if no previous page

  Example:

  /{entity}?page=1&per_page=3
  

• results: required(array of document)

  Items: document

  • uid: required(string)

    Aboutgoods generated unique ID

  • createdAt: required(datetime)

    When this object has been registered in AG system

  • updatedAt: required(datetime)

    The last time this entity had been updated in AG system

  • dominantLanguage: required(string)

    A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

    • Usage : specifiy on which language the Receipt Analyzer should treat receipts

    Example:

    fr-FR

  • appId: (string)

    If this document has been received from AGKit (our mobile application SDK), this field allow to identify the application which have been used to send the document

  • processedRules: (object)
    • name: required(string)

      Name of the whole rule, must be unique for a given campaign

    • uid: required(string)

      unique uid of the rule

    • priceRule: (object)

      rule that defines rule on prices

      • eligibleOnly: required(number)

        minimum price of all matched items

      • totalAmount: (number)

        minimum total amount of receipt

      • isMatched: required(boolean)

        tells if the rule is matched in receipt

      Example:

      {
        "eligibleOnly": 20.25,
        "totalAmount": 40,
        "isMatched": false
      }

    • itemRule: required(object)

      rule that defines terms to search and various conditions of search (or, and)

      • term: (string)

        Just a simple rule to look for this term in the receipt. Mutually exclusive with AND and TERM.

      • quantityRequired: (integer)

        minimum required quantity of term or clause (AND/OR) to find. Is added by Rulio by default = 1.

      • or: (array of object)

        The result of running OR Rule with itemsMatched and isMatched.

        Items:
      • and: (array of object)

        The result of running AND Rule with itemsMatched and isMatched.

        Items:
      • not: (array of object)

        The result of running NOT Rule with itemsMatched and isMatched.

        Items:
      • isMatched: required(boolean)

        tells if the rule is matched in receipt

      • itemsMatched: (array of string)

        List of IDs of items that were matched by term. Even if the rule is false (quantityRequired is not met), can have some IDs.

      • quantityMatched: (integer)

        quantity of term or terms in clause (AND/OR) found (even if the quantityRequired is not met). Can be different from the number of items in itemsMatched (one product line - but bought twice)

      Example:

      {
        "quantityRequired": 2,
        "or": [
          {
            "term": "Labeyrie",
            "quantityRequired": 1,
            "itemsMatched": [
              "3"
            ],
            "isMatched": true,
            "quantityMatched": 1
          },
          {
            "term": "Blini",
            "quantityRequired": 1,
            "itemsMatched": [
              "1",
              "2"
            ],
            "quantityMatched": 2,
            "isMatched": true
          }
        ],
        "not": [
          {
            "isMatched": true,
            "term": "Auchan",
            "itemsMatched": [
              "2"
            ],
            "quantityMatched": 1
          },
          {
            "isMatched": false,
            "term": "Cora",
            "itemsMatched": [],
            "quantityMatched": 0
          },
          {
            "isMatched": false,
            "term": "Carrefour",
            "itemsMatched": [],
            "quantityMatched": 0
          }
        ],
        "itemsMatched": [
          "3",
          "1"
        ],
        "quantityMatched": 2,
        "isMatched": true
      }

    • signRule: (object)

      rule that defines the list of signs for a given promotion

      • signList: required(array of string)

        List of sign eligible for the promotion.

      • isMatched: required(boolean)

        tells if the rule is matched in receipt

      Example:

      {
        "signList": [
          "Auchan",
          "Cora"
        ],
        "isMatched": true
      }

    • dateRule: required(object)

      rule that defines range of dates for a given promotion

      • min: required(string)

        start date of the promotion/campaign

      • max: required(string)

        last date of the promotion/campaign

      • isMatched: required(boolean)

        tells if the rule is matched in receipt

      Example:

      {
        "min": "2019-01-01",
        "max": "2019-11-01",
        "isMatched": true
      }

    • allRulesMatched: required(boolean)

      summarizes all rules matching, true if all rules are matched

    • totalPriceOfMatchedItems: required(number)

      total price of items that matched ItemRule

    Example:

    {
      "name": "Labeyrie",
      "uid": "123",
      "itemRule": {
        "quantityRequired": 2,
        "or": [
          {
            "term": "Labeyrie",
            "quantityRequired": 1,
            "itemsMatched": [
              "3"
            ],
            "isMatched": true,
            "quantityMatched": 1
          },
          {
            "term": "Blini",
            "quantityRequired": 1,
            "itemsMatched": [
              "1",
              "2"
            ],
            "quantityMatched": 2,
            "isMatched": true
          }
        ],
        "not": [
          {
            "isMatched": true,
            "term": "Auchan",
            "itemsMatched": [
              "2"
            ],
            "quantityMatched": 1
          },
          {
            "isMatched": false,
            "term": "Cora",
            "itemsMatched": [],
            "quantityMatched": 0
          }
        ],
        "itemsMatched": [
          "3",
          "1"
        ],
        "quantityMatched": 2,
        "isMatched": true
      },
      "dateRule": {
        "min": "2019-01-01",
        "max": "2019-11-01",
        "isMatched": true
      },
      "priceRule": {
        "eligibleOnly": 15,
        "isMatched": false
      },
      "signRule": {
        "signList": [
          "Cora",
          "Auchan",
          "Carrefour"
        ],
        "isMatched": true
      },
      "allRulesMatched": false,
      "totalPriceOfMatchedItems": 9.74
    }

  • name: required(string)

    Id of this document that client (aka you) had set when sending the image of document in the first place.

    • Helps you to retrieve a document by it's name
  • endpointUid: (string)

    Endpoint id that had served this document

  • campaignUid: (string)

    If this document is a part of promotion campaign, id of campaign is displayed here

  • companyUid: (string)

    ID of the company which owns this Document (automatically set with Auth0 connection)

  • status: required(one of WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS, PROCESSING, PROCESSED, NOT_EXPLOITABLE)

    As of today we have 5 status for differents states of an image in our systems, when everything is fine PROCESSED

  • processReport: required(one of NO_ERROR, BAD_QUALITY_IMAGE, NOT_ENOUGH_TEXT, MULTIPLE_RECEIPT, UNREADABLE, BAD_LOCALE, NOT_RECEIPT, ERROR_JPG, BAD_URL, NOT_ANALYZED)

    Process Report represent a more detailled reason about why a receipt has not been analyzed correctly A key to let the client knows what happened during analysis, helps you understand the status

    • NO_ERROR => Everything is fine, this come with the PROCESSED status by default
    • BAD_QUALITY_IMAGE => We detected a too blurry image or too dark, it can also be the resolution of the image
    • NOT_ENOUGH_TEXT => Self explicit, we have a threshold for the text recognition in image, if our OCR did not found enough text to generate a satisfiable amount of data, we abandon the Process
    • MULTIPLE_RECEIPT => We do not handle multiple receipt in one image, when we detect this case, we stop the process
    • UNREADABLE => Our OCR could not determine any Text in the image
    • BAD_LOCALE => We could not find any language for the detection to operate. This means that the Language or country is currently not supported by our system
    • NOT_RECEIPT => We didn't find any receipt in the image
    • ERROR_IMAGE_FORMAT => The image format is not valid (not one of jpg, pdf, png)
    • BAD_URL => No image has been found at the given URL (internal error)
    • NOT_ANALYZED => The document has not been analyzed for the moment, this comes with the WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS or PROCESSING statuses
  • imageUrl: required(string)

    URL for getting image from a cdn repository

  • metaData: (object)

    Exif metadata extracted from IMAGE_TREAT process
  • imageQuality: (object)

    Set of key-value describing quality of image, generated from IMAGE_TREAT process
  • userPseudoId: (string)

    This ID correspond to a custom and client managed id specified by the developer of the application that had setup AGKit SDK (aka you in general).

    • This can also come from an userId that you sent over this very API when sending a receipt
  • data: (object)

    Actual data that has been extracted from the receipt content
    Note: This field will be empty on the first document post response, as the process is running asynchronously, expect this field to be filled with data when the Status is set to PROCESSED

    • payment: (string)

      Buying mode or paiment method(s) in one string separated by | (pipe), out of following CARD, CASH, CHEQUE, OTHER

    • buyHour: (string)

      The hour displayed on the receipt (ISO 8601 Time 'hh:mm:ss')

    • buyDate: (string)

      Date of buy for the receipt (ISO 8601 Date 2018-10-22)

    • articleCount: (number)

      Number of items in cart for this receipt

    • total: (number)

      Total amount paid by the customer (can be negative !)

    • currency: (string)

      The currency used for paiement (ISO 4217 EUR)

    • locale: (string)

      Locale found for this receipt

    • shop: (object)

      informations about the shop

      • city: (string)

        City where the store of this buy is located

      • sign: (string)

        Store name or sign name / Brand of the shop

      • phone: (string)

        Phone number of the store

      • address: (string)

        Exact address of the store

      • postalCode: (string)

        Postal code for the city where we found this store

      • geoLocation: (string)

        Latitude and longitude for the shop, following https://tools.ietf.org/html/rfc5870 standard (example 13.4125,103.8667)

    • items: (array of object)

      Items with products detected

      Items: items

      • id: required(string)

        An ID unique to this list of item. Mainly used to identify this particular item in this receipt for our rule processor to indicate which item has matched a given rule.

      • rawLabel: (string)

        Raw line read on the receipt by OCR

      • shortLabel: (string)

        Detected short label from rawLabel, we remove price and other non label data from rawLabel

      • quantity: (number)

        Quantity of item detected in receipt

      • unitPrice: (number)

        A price detected for one piece of this item

      • packageUnity: (string)

        Package unity for item, for example Kg

      • mass: (number)

        The mass detected for the package, example 5 (Kg from PackageUnity)

      • flags: (array of string)

        Some notable characteristics detected on the product, BIO for example, or gluten free or anything special

      • price: (number)

        Total price for this item, (if found quantity > 1, we multiply to get this data, or we read it from receipt)

      • product: (object)

        What we understood from the item, we link item data to a clean and well organized product from our database and we put informations about it here.

        • name: (string)

          Full name unshortened if possible.

        • category: (string)

          A category for this product infered by our AI algorithm

        • categoryUid: (string)

          Reference UID from Aboutgoods taxonomy

        • brand: (string)

          Brand of product if displayed in label infered by our AI algorithm

        • brandLine: (string)

          Brand line (sub brand) infered by our AI algorithm

        • averagePrice: (number)

          Global average price for this product

        Example:

        {
          "name": "pt nav.thon filet",
          "brand": "PETIT NAVIRE",
          "brandLine": "FILETS DE THON",
          "category" : "tinned_fish",
          "categoryUid" : "4e54e68c-637f-a7d9-d509-f7e32b849f60"
        }
        

      • bundle: (number)

        Number of products in a pack. 16 x 125g, 16 is the bundle, 125g is the mass.

      Example:

      {
        "id": "fa2cb",
        "rawLabel": "x5506 OATS QUAKER BIO",
        "quantity": 1,
        "unitPrice": 1.64,
        "packageUnity": "Kg",
        "mass": 1,
        "flags": [
          "bio"
        ],
        "price": 1.64,
        "bundle": 1,
        "product": {
          "category": "breakfast_cereals",
          "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
          "brand": "QUAKER"
        }
      }

    Example:

    {
      "shop": {
        "city": "Toulon",
        "sign": "Carrefour",
        "phone": "0494419879",
        "address": "CENTRE CIAL MAYOL",
        "postalCode": "83000"
      },
      "articleCount": 2,
      "total": 4.25,
      "payment": "CARD | CASH",
      "buyDate": "2016-12-07",
      "buyHour": "11:08",
      "items": [
        {
          "id": "fa2cb",
          "rawLabel": "x5506 OATS QUAKER",
          "quantity": 1,
          "unitPrice": 1.64,
          "packageUnity": "Kg",
          "mass": 1,
          "price": 1.64,
          "bundle": 1,
          "product": {
            "name": "Quaker Oats",
            "averagePrice": 2.02,
            "category": "breakfast_cereals",
            "brand": "QUAKER"
          }
        },
        {
          "id": "9d7fb",
          "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
          "shortLabel": "BTE 6X33CL COCA CO",
          "quantity": 1,
          "unitPrice": 2.61,
          "packageUnity": "CL",
          "mass": 33,
          "bundle": 6,
          "price": 2.61,
          "product": {
            "category": "soda",
            "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
            "brand": "COCA COLA"
          }
        }
      ]
    }

  Example:

  {
    "uid": "89cd32b8-15e9-4e63-af5e-9e85da188fa1",
    "createdAt": "2019-09-20T08:19:57Z",
    "updatedAt": "2019-09-20T08:20:09Z",
    "dominantLanguage": "fr-FR",
    "name": "receiptTest",
    "companyUid": "test-company-uid",
    "campaignUid": "fc928982-3acc-4aea-bca3-e50d22e0b6ca",
    "userPseudoId": "8335c8d1-5ae7-440c-90d1-50543c86d9b4",
    "status": "PROCESSED",
    "processReport": "NO_ERROR",
    "imageUrl": "https://receipt.agkit.io/v2/documents/89cd32b8-15e9-4e63-af5e-9e85da188fa1/show",
    "metaData": {
      "undefined": null
    },
    "imageQuality": {},
    "data": {
      "shop": {
        "city": "Toulon",
        "sign": "Carrefour",
        "phone": "0494419879",
        "address": "CENTRE CIAL MAYOL",
        "postalCode": "83000"
      },
      "articleCount": 3,
      "total": 6.51,
      "payment": "CARD | CASH",
      "barcode": "09999000403300321612071108",
      "buyDate": "2016-12-07",
      "buyHour": "11:08",
      "items": [
        {
          "id": "fa2cb",
          "rawLabel": "x5506 OATS QUAKER               1,64",
          "quantity": 1,
          "unitPrice": 1.64,
          "packageUnity": "Kg",
          "mass": 1,
          "price": 1.64,
          "bundle": 1,
          "product": {
            "category": "breakfast_cereals",
            "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
            "brand": "QUAKER"
          }
        },
        {
          "id": "47267",
          "rawLabel": "PEPSI  REGULAR                           2,26",
          "shortLabel": "PEPSI  REGULAR",
          "quantity": 1,
          "unitPrice": 2.26,
          "bundle": 1,
          "price": 2.26,
          "product": {
            "category": "soda",
            "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
            "brand": "PEPSI"
          }
        },
        {
          "id": "9d7fb",
          "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
          "shortLabel": "BTE 6X33CL COCA CO",
          "quantity": 1,
          "unitPrice": 2.61,
          "packageUnity": "CL",
          "mass": 33,
          "bundle": 6,
          "price": 2.61,
          "product": {
            "category": "soda",
            "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
            "brand": "COCA COLA"
          }
        }
      ]
    },
    "processedRules": {
      "uid": "1234",
      "name": "Quaker",
      "dateRule": {
        "min": "2019-01-01",
        "max": "2019-11-01",
        "isMatched": false
      },
      "signRule": {
        "signList": [
          "Carrefour"
        ],
        "isMatched": true
      },
      "itemRule": {
        "term": "Quaker",
        "quantityRequired": 1,
        "isMatched": true,
        "itemsMatched": [
          "fa2cb"
        ],
        "quantityMatched": 1
      },
      "allRulesMatched": false,
      "totalPriceOfMatchedItems": 1.64
    }
  }

HTTP status code 400

Filter malformed or invalid filter key

HTTP status code 403

You cannot access this resources with this token

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

Secured by OAuth2.0 - Hydra

HTTP status code 200

Body

Media type: application/json

Type: object

• uid: required(string)

  Aboutgoods generated unique ID

• createdAt: required(datetime)

  When this object has been registered in AG system

• updatedAt: required(datetime)

  The last time this entity had been updated in AG system

• dominantLanguage: required(string)

  A locale format with the following pattern {iso 639-1}-{ISO 3166-1}

  • Usage : specifiy on which language the Receipt Analyzer should treat receipts

  Example:

  fr-FR

• appId: (string)

  If this document has been received from AGKit (our mobile application SDK), this field allow to identify the application which have been used to send the document

• processedRules: (object)
  • name: required(string)

    Name of the whole rule, must be unique for a given campaign

  • uid: required(string)

    unique uid of the rule

  • priceRule: (object)

    rule that defines rule on prices

    • eligibleOnly: required(number)

      minimum price of all matched items

    • totalAmount: (number)

      minimum total amount of receipt

    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    Example:

    {
      "eligibleOnly": 20.25,
      "totalAmount": 40,
      "isMatched": false
    }

  • itemRule: required(object)

    rule that defines terms to search and various conditions of search (or, and)

    • term: (string)

      Just a simple rule to look for this term in the receipt. Mutually exclusive with AND and TERM.

    • quantityRequired: (integer)

      minimum required quantity of term or clause (AND/OR) to find. Is added by Rulio by default = 1.

    • or: (array of object)

      The result of running OR Rule with itemsMatched and isMatched.

      Items:
    • and: (array of object)

      The result of running AND Rule with itemsMatched and isMatched.

      Items:
    • not: (array of object)

      The result of running NOT Rule with itemsMatched and isMatched.

      Items:
    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    • itemsMatched: (array of string)

      List of IDs of items that were matched by term. Even if the rule is false (quantityRequired is not met), can have some IDs.

    • quantityMatched: (integer)

      quantity of term or terms in clause (AND/OR) found (even if the quantityRequired is not met). Can be different from the number of items in itemsMatched (one product line - but bought twice)

    Example:

    {
      "quantityRequired": 2,
      "or": [
        {
          "term": "Labeyrie",
          "quantityRequired": 1,
          "itemsMatched": [
            "3"
          ],
          "isMatched": true,
          "quantityMatched": 1
        },
        {
          "term": "Blini",
          "quantityRequired": 1,
          "itemsMatched": [
            "1",
            "2"
          ],
          "quantityMatched": 2,
          "isMatched": true
        }
      ],
      "not": [
        {
          "isMatched": true,
          "term": "Auchan",
          "itemsMatched": [
            "2"
          ],
          "quantityMatched": 1
        },
        {
          "isMatched": false,
          "term": "Cora",
          "itemsMatched": [],
          "quantityMatched": 0
        },
        {
          "isMatched": false,
          "term": "Carrefour",
          "itemsMatched": [],
          "quantityMatched": 0
        }
      ],
      "itemsMatched": [
        "3",
        "1"
      ],
      "quantityMatched": 2,
      "isMatched": true
    }

  • signRule: (object)

    rule that defines the list of signs for a given promotion

    • signList: required(array of string)

      List of sign eligible for the promotion.

    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    Example:

    {
      "signList": [
        "Auchan",
        "Cora"
      ],
      "isMatched": true
    }

  • dateRule: required(object)

    rule that defines range of dates for a given promotion

    • min: required(string)

      start date of the promotion/campaign

    • max: required(string)

      last date of the promotion/campaign

    • isMatched: required(boolean)

      tells if the rule is matched in receipt

    Example:

    {
      "min": "2019-01-01",
      "max": "2019-11-01",
      "isMatched": true
    }

  • allRulesMatched: required(boolean)

    summarizes all rules matching, true if all rules are matched

  • totalPriceOfMatchedItems: required(number)

    total price of items that matched ItemRule

  Example:

  {
    "name": "Labeyrie",
    "uid": "123",
    "itemRule": {
      "quantityRequired": 2,
      "or": [
        {
          "term": "Labeyrie",
          "quantityRequired": 1,
          "itemsMatched": [
            "3"
          ],
          "isMatched": true,
          "quantityMatched": 1
        },
        {
          "term": "Blini",
          "quantityRequired": 1,
          "itemsMatched": [
            "1",
            "2"
          ],
          "quantityMatched": 2,
          "isMatched": true
        }
      ],
      "not": [
        {
          "isMatched": true,
          "term": "Auchan",
          "itemsMatched": [
            "2"
          ],
          "quantityMatched": 1
        },
        {
          "isMatched": false,
          "term": "Cora",
          "itemsMatched": [],
          "quantityMatched": 0
        }
      ],
      "itemsMatched": [
        "3",
        "1"
      ],
      "quantityMatched": 2,
      "isMatched": true
    },
    "dateRule": {
      "min": "2019-01-01",
      "max": "2019-11-01",
      "isMatched": true
    },
    "priceRule": {
      "eligibleOnly": 15,
      "isMatched": false
    },
    "signRule": {
      "signList": [
        "Cora",
        "Auchan",
        "Carrefour"
      ],
      "isMatched": true
    },
    "allRulesMatched": false,
    "totalPriceOfMatchedItems": 9.74
  }

• name: required(string)

  Id of this document that client (aka you) had set when sending the image of document in the first place.

  • Helps you to retrieve a document by it's name
• endpointUid: (string)

  Endpoint id that had served this document

• campaignUid: (string)

  If this document is a part of promotion campaign, id of campaign is displayed here

• companyUid: (string)

  ID of the company which owns this Document (automatically set with Auth0 connection)

• status: required(one of WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS, PROCESSING, PROCESSED, NOT_EXPLOITABLE)

  As of today we have 5 status for differents states of an image in our systems, when everything is fine PROCESSED

• processReport: required(one of NO_ERROR, BAD_QUALITY_IMAGE, NOT_ENOUGH_TEXT, MULTIPLE_RECEIPT, UNREADABLE, BAD_LOCALE, NOT_RECEIPT, ERROR_JPG, BAD_URL, NOT_ANALYZED)

  Process Report represent a more detailled reason about why a receipt has not been analyzed correctly A key to let the client knows what happened during analysis, helps you understand the status

  • NO_ERROR => Everything is fine, this come with the PROCESSED status by default
  • BAD_QUALITY_IMAGE => We detected a too blurry image or too dark, it can also be the resolution of the image
  • NOT_ENOUGH_TEXT => Self explicit, we have a threshold for the text recognition in image, if our OCR did not found enough text to generate a satisfiable amount of data, we abandon the Process
  • MULTIPLE_RECEIPT => We do not handle multiple receipt in one image, when we detect this case, we stop the process
  • UNREADABLE => Our OCR could not determine any Text in the image
  • BAD_LOCALE => We could not find any language for the detection to operate. This means that the Language or country is currently not supported by our system
  • NOT_RECEIPT => We didn't find any receipt in the image
  • ERROR_IMAGE_FORMAT => The image format is not valid (not one of jpg, pdf, png)
  • BAD_URL => No image has been found at the given URL (internal error)
  • NOT_ANALYZED => The document has not been analyzed for the moment, this comes with the WAITING_FOR_DOCUMENT, WAITING_FOR_PROCESS or PROCESSING statuses
• imageUrl: required(string)

  URL for getting image from a cdn repository

• metaData: (object)

  Exif metadata extracted from IMAGE_TREAT process
• imageQuality: (object)

  Set of key-value describing quality of image, generated from IMAGE_TREAT process
• userPseudoId: (string)

  This ID correspond to a custom and client managed id specified by the developer of the application that had setup AGKit SDK (aka you in general).

  • This can also come from an userId that you sent over this very API when sending a receipt
• data: (object)

  Actual data that has been extracted from the receipt content
  Note: This field will be empty on the first document post response, as the process is running asynchronously, expect this field to be filled with data when the Status is set to PROCESSED

  • payment: (string)

    Buying mode or paiment method(s) in one string separated by | (pipe), out of following CARD, CASH, CHEQUE, OTHER

  • buyHour: (string)

    The hour displayed on the receipt (ISO 8601 Time 'hh:mm:ss')

  • buyDate: (string)

    Date of buy for the receipt (ISO 8601 Date 2018-10-22)

  • articleCount: (number)

    Number of items in cart for this receipt

  • total: (number)

    Total amount paid by the customer (can be negative !)

  • currency: (string)

    The currency used for paiement (ISO 4217 EUR)

  • locale: (string)

    Locale found for this receipt

  • shop: (object)

    informations about the shop

    • city: (string)

      City where the store of this buy is located

    • sign: (string)

      Store name or sign name / Brand of the shop

    • phone: (string)

      Phone number of the store

    • address: (string)

      Exact address of the store

    • postalCode: (string)

      Postal code for the city where we found this store

    • geoLocation: (string)

      Latitude and longitude for the shop, following https://tools.ietf.org/html/rfc5870 standard (example 13.4125,103.8667)

  • items: (array of object)

    Items with products detected

    Items: items

    • id: required(string)

      An ID unique to this list of item. Mainly used to identify this particular item in this receipt for our rule processor to indicate which item has matched a given rule.

    • rawLabel: (string)

      Raw line read on the receipt by OCR

    • shortLabel: (string)

      Detected short label from rawLabel, we remove price and other non label data from rawLabel

    • quantity: (number)

      Quantity of item detected in receipt

    • unitPrice: (number)

      A price detected for one piece of this item

    • packageUnity: (string)

      Package unity for item, for example Kg

    • mass: (number)

      The mass detected for the package, example 5 (Kg from PackageUnity)

    • flags: (array of string)

      Some notable characteristics detected on the product, BIO for example, or gluten free or anything special

    • price: (number)

      Total price for this item, (if found quantity > 1, we multiply to get this data, or we read it from receipt)

    • product: (object)

      What we understood from the item, we link item data to a clean and well organized product from our database and we put informations about it here.

      • name: (string)

        Full name unshortened if possible.

      • category: (string)

        A category for this product infered by our AI algorithm

      • categoryUid: (string)

        Reference UID from Aboutgoods taxonomy

      • brand: (string)

        Brand of product if displayed in label infered by our AI algorithm

      • brandLine: (string)

        Brand line (sub brand) infered by our AI algorithm

      • averagePrice: (number)

        Global average price for this product

      Example:

      {
        "name": "pt nav.thon filet",
        "brand": "PETIT NAVIRE",
        "brandLine": "FILETS DE THON",
        "category" : "tinned_fish",
        "categoryUid" : "4e54e68c-637f-a7d9-d509-f7e32b849f60"
      }
      

    • bundle: (number)

      Number of products in a pack. 16 x 125g, 16 is the bundle, 125g is the mass.

    Example:

    {
      "id": "fa2cb",
      "rawLabel": "x5506 OATS QUAKER BIO",
      "quantity": 1,
      "unitPrice": 1.64,
      "packageUnity": "Kg",
      "mass": 1,
      "flags": [
        "bio"
      ],
      "price": 1.64,
      "bundle": 1,
      "product": {
        "category": "breakfast_cereals",
        "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
        "brand": "QUAKER"
      }
    }

  Example:

  {
    "shop": {
      "city": "Toulon",
      "sign": "Carrefour",
      "phone": "0494419879",
      "address": "CENTRE CIAL MAYOL",
      "postalCode": "83000"
    },
    "articleCount": 2,
    "total": 4.25,
    "payment": "CARD | CASH",
    "buyDate": "2016-12-07",
    "buyHour": "11:08",
    "items": [
      {
        "id": "fa2cb",
        "rawLabel": "x5506 OATS QUAKER",
        "quantity": 1,
        "unitPrice": 1.64,
        "packageUnity": "Kg",
        "mass": 1,
        "price": 1.64,
        "bundle": 1,
        "product": {
          "name": "Quaker Oats",
          "averagePrice": 2.02,
          "category": "breakfast_cereals",
          "brand": "QUAKER"
        }
      },
      {
        "id": "9d7fb",
        "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
        "shortLabel": "BTE 6X33CL COCA CO",
        "quantity": 1,
        "unitPrice": 2.61,
        "packageUnity": "CL",
        "mass": 33,
        "bundle": 6,
        "price": 2.61,
        "product": {
          "category": "soda",
          "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
          "brand": "COCA COLA"
        }
      }
    ]
  }

Example:

{
  "uid": "89cd32b8-15e9-4e63-af5e-9e85da188fa1",
  "createdAt": "2019-09-20T08:19:57Z",
  "updatedAt": "2019-09-20T08:20:09Z",
  "dominantLanguage": "fr-FR",
  "name": "receiptTest",
  "companyUid": "test-company-uid",
  "campaignUid": "fc928982-3acc-4aea-bca3-e50d22e0b6ca",
  "userPseudoId": "8335c8d1-5ae7-440c-90d1-50543c86d9b4",
  "status": "PROCESSED",
  "processReport": "NO_ERROR",
  "imageUrl": "https://receipt.agkit.io/v2/documents/89cd32b8-15e9-4e63-af5e-9e85da188fa1/show",
  "metaData": {
    "undefined": null
  },
  "imageQuality": {},
  "data": {
    "shop": {
      "city": "Toulon",
      "sign": "Carrefour",
      "phone": "0494419879",
      "address": "CENTRE CIAL MAYOL",
      "postalCode": "83000"
    },
    "articleCount": 3,
    "total": 6.51,
    "payment": "CARD | CASH",
    "barcode": "09999000403300321612071108",
    "buyDate": "2016-12-07",
    "buyHour": "11:08",
    "items": [
      {
        "id": "fa2cb",
        "rawLabel": "x5506 OATS QUAKER               1,64",
        "quantity": 1,
        "unitPrice": 1.64,
        "packageUnity": "Kg",
        "mass": 1,
        "price": 1.64,
        "bundle": 1,
        "product": {
          "category": "breakfast_cereals",
          "categoryUid": "33f92698-284b-fd44-575a-f1e9cea9973e",
          "brand": "QUAKER"
        }
      },
      {
        "id": "47267",
        "rawLabel": "PEPSI  REGULAR                           2,26",
        "shortLabel": "PEPSI  REGULAR",
        "quantity": 1,
        "unitPrice": 2.26,
        "bundle": 1,
        "price": 2.26,
        "product": {
          "category": "soda",
          "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
          "brand": "PEPSI"
        }
      },
      {
        "id": "9d7fb",
        "rawLabel": "4 BTE 6X33CL COCA CO                     2,61",
        "shortLabel": "BTE 6X33CL COCA CO",
        "quantity": 1,
        "unitPrice": 2.61,
        "packageUnity": "CL",
        "mass": 33,
        "bundle": 6,
        "price": 2.61,
        "product": {
          "category": "soda",
          "categoryUid": "efb24280-2dd9-423d-91d3-263fc780b6df",
          "brand": "COCA COLA"
        }
      }
    ]
  },
  "processedRules": {
    "uid": "1234",
    "name": "Quaker",
    "dateRule": {
      "min": "2019-01-01",
      "max": "2019-11-01",
      "isMatched": false
    },
    "signRule": {
      "signList": [
        "Carrefour"
      ],
      "isMatched": true
    },
    "itemRule": {
      "term": "Quaker",
      "quantityRequired": 1,
      "isMatched": true,
      "itemsMatched": [
        "fa2cb"
      ],
      "quantityMatched": 1
    },
    "allRulesMatched": false,
    "totalPriceOfMatchedItems": 1.64
  }
}

HTTP status code 400

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "badRequest" : "You are missing some field or they are malformed" }
  

HTTP status code 401

Authentication with Auth0 failed

HTTP status code 402

Your quota has been exceeded

HTTP status code 404

Body

Media type: application/json

Type: object

• error: required(string)

  Example:

  { "notFound" : "resource has not been found on this system" }
  

HTTP status code 409

Document or name already exists for your company

Secured by OAuth2.0 - Hydra