MosendDeveloper

Notas crédito (admin)

Referencia de 6 endpoints generados desde mosend-wb-backend/src/modules/credit-notes/credit-notes.controller.ts.

Base path: /admin/credit-notes·6 endpoints·Source: mosend-wb-backend/src/modules/credit-notes/credit-notes.controller.ts
POST/admin/credit-notes
bearer

Emite una nota crédito a favor de una organización. Solo se debería emitir cuando hubo un error nuestro.

Body

CreateCreditNoteDtoparámetro: dto

Respuestas

  • 201
curl -X POST 'https://api.mosend.dev/admin/credit-notes' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>' \
  -H 'Content-Type: application/json' \
  -d '{"name": "string","description": "string"}'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "name": "string",
    "description": "string"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
GET/admin/credit-notes
bearer

Lista notas crédito (filtro opcional por organización).

Query params

  • orgIdstring
  • limitstring

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/admin/credit-notes' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "createdAt": "2026-05-01T03:42:18.123Z"
    }
  ],
  "timestamp": "2026-05-01T03:42:18.123Z"
}
GET/admin/credit-notes/:id
bearer

Detalle de una nota crédito.

Path params

  • idstringrequerido

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/admin/credit-notes/00000000-0000-0000-0000-000000000000' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2026-05-01T03:42:18.123Z"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
POST/admin/credit-notes/:id/void
bearer

Anula una nota crédito (revierte el crédito al wallet si fue aplicada).

Path params

  • idstringrequerido

Respuestas

  • 201
curl -X POST 'https://api.mosend.dev/admin/credit-notes/00000000-0000-0000-0000-000000000000/void' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2026-05-01T03:42:18.123Z"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
GET/admin/credit-notes/:id/pdf
bearer

Genera (si falta) el PDF de la nota crédito y devuelve URL firmada para descarga.

Path params

  • idstringrequerido

Respuestas

  • 200
curl -X GET 'https://api.mosend.dev/admin/credit-notes/00000000-0000-0000-0000-000000000000/pdf' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2026-05-01T03:42:18.123Z"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}
POST/admin/credit-notes/:id/regenerate-pdf
bearer

Regenera el PDF de una nota crédito (tras tweaks de layout).

Path params

  • idstringrequerido

Respuestas

  • 201
curl -X POST 'https://api.mosend.dev/admin/credit-notes/00000000-0000-0000-0000-000000000000/regenerate-pdf' \
  -H 'X-Api-Key: mk_live_<prefix>.<secret>'
Response · 200
{
  "data": {
    "id": "00000000-0000-0000-0000-000000000000",
    "createdAt": "2026-05-01T03:42:18.123Z"
  },
  "timestamp": "2026-05-01T03:42:18.123Z"
}