Skip to Content

A invoice became `returned`

Request Body

application/json
  1. body
id*string

The event's id, also its webhook-id header: deduplicate by it.

Formatuuid
type*"invoice.returned"
Value in"invoice.returned"
timestamp*string
Formatdate-time
backfill?true

Present, and true, only on a delivery a backfill replayed (POST /v1/webhook-endpoints/{id}/backfill).

Value intrue
data*

Response Body

Any 2xx within 15 seconds acknowledges it; anything else is retried.

Example Requests
POST/invoice.returned
Request Body
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "invoice.returned",
  "timestamp": "2019-08-24T14:15:22Z",
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "country": "ec",
    "currency": "string",
    "environment": "sandbox",
    "status": "pending",
    "status_transitions": {},
    "business_id": "f59fcbb7-848d-4242-af07-a8bb7e3ab37c",
    "number": "string",
    "access_key": "stringstringstringstringstringstringstringstrings",
    "authorization": {
      "number": "string",
      "authorized_at": "2019-08-24T14:15:22Z"
    },
    "sri_messages": [
      {
        "code": "string",
        "message": "string",
        "detail": "string",
        "type": "error",
        "cause": "string",
        "remedy": "string"
      }
    ],
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "issued_at": "2019-08-24T14:15:22Z",
    "delivery_status": "sent",
    "emails": [
      {
        "to": "string",
        "status": "sent",
        "sent_at": "2019-08-24T14:15:22Z",
        "delivered_at": "2019-08-24T14:15:22Z",
        "opened_at": "2019-08-24T14:15:22Z",
        "bounced_at": "2019-08-24T14:15:22Z",
        "complained_at": "2019-08-24T14:15:22Z",
        "bounce_type": "permanent"
      }
    ],
    "portal_views": 0,
    "portal_last_viewed_at": "2019-08-24T14:15:22Z",
    "channel": "api",
    "import_id": "13230382-dadc-41f2-963d-e123bd5c0585",
    "verification": "sri",
    "listing": {
      "import_id": "13230382-dadc-41f2-963d-e123bd5c0585",
      "file": "string",
      "entry": "string",
      "sha256": "stringstringstringstringstringstringstringstringstringstringstri",
      "line": 1,
      "authorized_at": "2019-08-24T14:15:22Z"
    },
    "object": "document",
    "type": "invoice",
    "lines": [
      {
        "code": "string",
        "auxiliary_code": "string",
        "description": "string",
        "unit": "string",
        "quantity": "string",
        "unit_price": "string",
        "discount": "string",
        "net": "string",
        "taxes": [
          {
            "type": "iva",
            "rate": "iva_15",
            "base": "string",
            "value": "string"
          }
        ],
        "additional_info": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "unsubsidized_price": "string"
      }
    ],
    "taxes": [
      {
        "type": "iva",
        "rate": "iva_15",
        "base": "string",
        "value": "string",
        "additional_discount": "string",
        "refund": "string"
      }
    ],
    "subtotal": "string",
    "discount": "string",
    "iva": "string",
    "ice": "string",
    "irbpnr": "string",
    "total": "string",
    "subsidy": "string",
    "tip": "string",
    "issue_date": "2019-08-24",
    "buyer": {
      "identification_type": "ruc",
      "identification": "string",
      "name": "string",
      "address": "string",
      "email": "string"
    },
    "payments": [
      {
        "method": "sin_sistema_financiero",
        "amount": "string",
        "term": {
          "length": 0,
          "unit": "days"
        }
      }
    ],
    "plate": "string",
    "delivery_note_number": "string",
    "export": {
      "incoterm": "string",
      "incoterm_place": "string",
      "origin_country": "string",
      "loading_port": "string",
      "destination_port": "string",
      "destination_country": "string",
      "acquisition_country": "string",
      "subtotal_incoterm": "string",
      "international_freight": "string",
      "international_insurance": "string",
      "customs_costs": "string",
      "other_transport_costs": "string"
    },
    "reimbursement": {
      "document_type": "factura",
      "total": "string",
      "base": "string",
      "tax": "string",
      "documents": [
        {
          "supplier": {
            "identification_type": "ruc",
            "identification": "string"
          },
          "supplier_type": "persona_natural",
          "payment_country": "string",
          "document_type": "factura",
          "number": "string",
          "issue_date": "2019-08-24",
          "authorization_number": "string",
          "taxes": [
            {
              "type": "iva",
              "rate": "iva_15",
              "base": "string",
              "value": "string"
            }
          ],
          "compensations": [
            {
              "code": "string",
              "rate": "string",
              "value": "string"
            }
          ]
        }
      ]
    },
    "withholdings": [
      {
        "type": "iva_100",
        "value": "string"
      }
    ],
    "withheld_iva": "string",
    "withheld_renta": "string",
    "substitute_delivery_note": {
      "origin_address": "string",
      "destination_address": "string",
      "transport_start": "string",
      "transport_end": "string",
      "carrier": {
        "identification_type": "ruc",
        "identification": "string",
        "name": "string"
      },
      "plate": "string",
      "destinations": [
        {
          "reason": "string",
          "customs_document": "string",
          "destination_establishment": "string",
          "route": "string"
        }
      ]
    },
    "third_party_charges": [
      {
        "concept": "string",
        "amount": "string"
      }
    ],
    "negotiable": {
      "notification_email": "string"
    },
    "compensations": [
      {
        "code": "string",
        "rate": "string",
        "value": "string"
      }
    ],
    "fiscal_machine": {
      "brand": "string",
      "model": "string",
      "serial": "string"
    },
    "additional_info": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "credit_balance": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}