Skip to content
campaiDeveloper
campai.com

Sales ยท Statistics

GET/{organizationId}/{mandateId}/sales/statistics/offersReads only

Get offers

Returns the offers issued in a period that are still valid with their value in cents, and up to ten offers that need attention. Offers need attention when they were accepted in the period without an invoice, or are open and expired or expire within seven days, whenever they were issued

Permissions

Send an API key of the organization in the path, using the X-API-Key header.

Permission checks in detail
Required permissions
  • mandate.read
  • receipt.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired

Query parameters

  • fromDatestringrequired
  • toDatestringrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
  --request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/sales/statistics/offers' \
  --header 'X-API-Key: YOUR_API_KEY'

Response

200 Successful response

Content-Type: application/json

  • validOfferCountinteger

    at least 0

  • validOfferValuenumber

    at least 0

  • attentionOffersobject[]
    6 properties
    • _idid
    • receiptNumberstring
    • accountNamestring
    • totalGrossAmountnumber

      at least 0

    • dueDatestring
    • reasonstring
      acceptedWithoutInvoice expired expiring
Response200
{
  "validOfferCount": 0,
  "validOfferValue": 0,
  "attentionOffers": [
    {
      "_id": "000000000000000000000001",
      "receiptNumber": "string",
      "accountName": "string",
      "totalGrossAmount": 0,
      "dueDate": "string",
      "reason": "acceptedWithoutInvoice"
    }
  ]
}

Errors

No errors of its own are known for this endpoint.

Errors nearly every request can meet are listed under Errors.