Guías de remisión

Registrar la anulación de guía de remisión

POST
/v1/ec/delivery-notes/{id}/annul

Solo registra una anulación que ya hiciste en SRI en línea; no la pide al SRI. El comprobante pasa a annulled, conserva sus archivos, sale del portal de tu cliente y se envía <object>.annulled a tus webhooks. Solo para uno authorized, y nunca para uno emitido a consumidor final, que el SRI no anula.

Autorización

AutorizaciónBearer <tu clave API>

Tu clave API: fb_sandbox_… emite en Sandbox, fb_test_… en test, el servicio de pruebas de la autoridad tributaria, y fb_live_… en live, su producción.

En: header

Parámetros de ruta

id*string
Formatouuid

Cuerpo de la solicitud

application/json

Tipos de TypeScript

Usa el tipo request body en TypeScript.

annulled_on*string

La fecha en que el SRI lo anuló, como aparece en SRI en línea. No antes de la emisión ni en el futuro.

Formatodate
reason?string

Por qué se anuló, para tu registro.

Longitud1 <= length <= 300

Cuerpo de la respuesta

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/ec/delivery-notes/497f6eca-6276-4993-bfeb-53cbbbba6f08/annul" \  -H "Content-Type: application/json" \  -d '{    "annulled_on": "2019-08-24"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "country": "ec",  "currency": "string",  "environment": "sandbox",  "status": "pending",  "status_transitions": {    "pending": "2019-08-24T14:15:22Z",    "submitted": "2019-08-24T14:15:22Z",    "authorized": "2019-08-24T14:15:22Z",    "returned": "2019-08-24T14:15:22Z",    "not_authorized": "2019-08-24T14:15:22Z",    "annulled": "2019-08-24T14:15:22Z"  },  "entity_id": "8161163a-f227-466f-bc01-090a01e80165",  "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"    }  ],  "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": "delivery_note",  "issue_date": "string",  "origin_address": "string",  "carrier": {    "identification_type": "ruc",    "identification": "string",    "name": "string"  },  "plate": "string",  "transport_start": "string",  "transport_end": "string",  "recipients": [    {      "identification": "string",      "name": "string",      "address": "string",      "email": "string",      "reason": "string",      "route": "string",      "customs_document": "string",      "destination_establishment": "string",      "support_document": {        "document_type": "factura",        "number": "string",        "issue_date": "string",        "authorization_number": "string"      },      "items": [        {          "code": "string",          "auxiliary_code": "string",          "description": "string",          "quantity": "string",          "additional_info": [            {              "name": "string",              "value": "string"            }          ]        }      ]    }  ],  "fiscal_machine": {    "brand": "string",    "model": "string",    "serial": "string"  },  "additional_info": [    {      "name": "string",      "value": "string"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}