Correlativos

La API de Facturación permite crear, actualizar, eliminar y obtener información correspondiente sobre los correlativos que una compañía registra.

Creación

Para la creación de un correlativo, realiza una petición POST a la siguiente url:

POST /api/company/correlative/{ruc-registrada-en-api}
Host: invoice.tandia.io
Content-Type: application/json
Authorization: Bearer <token-de-api>

Solicitud

Debes proporcionar un cuerpo de solicitud en formato JSON con la información del correlativo que deseas crear. Aquí tienes un ejemplo de un cuerpo de solicitud:

{
  "document_type": "receipt",
  "serie": "B002",
  "correlative": 28,
  "description": "Tienda 2"
}

Respuesta

Cuando creas un correlativo a través de la API, recibirás una respuesta que contiene la información de creación. A continuación, se detalla la estructura de la respuesta:

{
  "document_type": "receipt",
  "serie": "B002",
  "correlative": 28,
  "description": "Tienda 2"
}

Actualización

Para la actualización de un correlativo, realiza una petición PUT a la siguiente url:

PUT /api/company/correlative/{ruc-registrada-en-api}/{tipo-de-documento}/{tu-serie}
Host: invoice.tandia.io
Content-Type: application/json
Authorization: Bearer <token-de-api>

Solicitud

Debes proporcionar un cuerpo de solicitud en formato JSON con la información del correlativo que deseas actualizar. Puedes actualizar solamente dos campos: correlative y/o description. Aquí tienes un ejemplo de un cuerpo de solicitud:

{
  "correlative": 14,
  "description": "Tienda del Centro"
}

Respuesta

Cuando actualizas un correlativo a través de la API, recibirás una respuesta que contiene la información de todo el correlativo. A continuación, se detalla la estructura de la respuesta:

{
  "document_type": "receipt",
  "serie": "B002",
  "correlative": 14,
  "description": "Tienda del Centro"
}

Eliminación

Para la eliminación de un correlativo, realiza una petición DELETE a la siguiente url:

DELETE /api/company/correlative/{ruc-registrada-en-api}/{tipo-de-documento}/{tu-serie}
Host: invoice.tandia.io
Authorization: Bearer <token-de-api>

Respuesta

Cuando eliminas un correlativo a través de la API, recibirás una respuesta booleana de confirmación.

Listados

Para los diferentes listados de correlativos que se encuentren registrados en la compañía con del usuario que haya iniciado sesión, realiza una petición GET a la siguiente url:

GET /api/company/correlative/{ruc-registrada-en-api}
Host: invoice.tandia.io
Authorization: Bearer <token-de-api>

Query params

• limit: indica el límite de cuántos registros de correlativos se quiere obtener por solicitud.
• next_token: token requerido para acceder a la siguiente página de registros. Este es enviado tras la primera solicitud si es que hubiera más registros en la siguiente página, considerando el límite previamente establecido.

Ejemplo de solicitud

GET https://invoice.tandia.io/api/company/correlative/{ruc-registrada-en-api}?limit=30&next_token={next_token}

Respuesta

Al realizar la solicitud GET, la API responderá con un estado 200 si la solicitud fue exitosa y devolverá la respuesta en formato JSON. A continuación, la estructura de la respuesta:

{
  "data": [
    {
      "document_type": "credit-note",
      "serie": "BBC1",
      "correlative": 4,
      "description": null
    },
    {
      "document_type": "invoice",
      "serie": "FF02",
      "correlative": null,
      "description": "Tienda 02"
    },
    {
      "document_type": "invoice",
      "serie": "FF01",
      "correlative": null,
      "description": "Tienda 01"
    },
    {
      "document_type": "receipt",
      "serie": "B002",
      "correlative": 14,
      "description": "Tienda del Centro"
    },
    {
      "document_type": "receipt",
      "serie": "B001",
      "correlative": null,
      "description": null
    }
  ],
  "meta": {
    "next_token": "{next-token-aqui}"
  }
}

Por tipo de comprobante

El servicio realiza un filtro en los correlativos por medio del tipo de documento.

Query param extra

• document_type: indica el tipo de documento registrado en los correlativos.

Ejemplo de solicitud

GET https://invoice.tandia.io/api/company/correlative/{ruc-registrada-en-api}?document_type=receipt&limit=30&next_token={next-token}

Respuesta

Al realizar la solicitud GET, la API responderá con un estado 200 si la solicitud fue exitosa y devolverá la respuesta en formato JSON. A continuación, la estructura de la respuesta:

{
  "data": [
    {
      "document_type": "receipt",
      "serie": "B002",
      "correlative": 14,
      "description": "Tienda del Centro"
    },
    {
      "document_type": "receipt",
      "serie": "B001",
      "correlative": null,
      "description": null
    }
  ],
  "meta": {
    "next_token": null
  }
}