Facturación

Emitir una nota de crédito

Emite una nota de crédito en borrador con la versión leída, controla otra vez que no acredite más de lo que le queda a la factura y pide a ARCA su CAE.

POST/api/v1/documents/issue-credit-note

Permiso: documents.issue-credit-note
Empresa: Opera sobre la empresa activa
Tipo: Escritura: pide Idempotency-Key
Respuesta: JSON

Encabezados

Cookietextorequerido
La cookie de sesión del usuario de la integración (__Secure-erp.session_token). Cuando esté la clave API, va en Authorization: Bearer. Ver Autenticación.
X-Expected-Companyuuidrequerido
La empresa sobre la que operás. Si no coincide con la de la credencial, responde 409. Ver Empresa activa.
Idempotency-Keytextorequerido
Una clave única por intento, de hasta 255 caracteres. Reintentar con la misma clave y los mismos datos devuelve el mismo resultado sin repetir la operación. Ver Idempotencia.

Cuerpo

JSON con Content-Type: application/json.

documentIduuidrequerido
versionenterorequerido
mínimo 1

Respuesta

200 con este JSON.

iduuidrequerido
kindopciónrequerido
Valores: invoice credit-note
statusopciónrequerido
Valores: draft pending-authorization authorized discarded
numbertextorequerido
internalNumberenterorequerido
legalNumberenterorequeridoadmite null
letteropciónrequerido
Valores: A B X
documentDatefecharequerido
customerobjetorequerido
Campos (6)
- iduuidrequerido
- legalNametextorequerido
- documentTypetextorequerido
- documentNumbertextorequerido
- vatConditiontextorequerido
- addresstextorequerido
totaltextorequerido
lastSubmissionobjetorequeridoadmite null
Campos (3)
- resultopciónrequerido
  Valores: authorized rejected unavailable indeterminate
- messagecualquierarequerido
- recordedAtfecha y horarequerido
versionenterorequerido
mínimo 1
pointOfSaleobjetorequerido
Campos (3)
- iduuidrequerido
- numberenterorequerido
- texttextorequerido
conceptopciónrequerido
Valores: products services products-and-services
servicePeriodobjetorequeridoadmite null
Campos (2)
- fromfecharequerido
- tofecharequerido
paymentDueDatefecharequeridoadmite null
paymentTermobjetorequeridoadmite null
Campos (2)
- iduuidrequerido
- nametextorequerido
paymentPlanTexttextorequerido
installmentslista de objetorequerido
Campos de cada elemento (4)
- numberenterorequerido
- percentnúmerorequerido
- dueDatefecharequerido
- amounttextorequerido
lineslista de objetorequerido
Campos de cada elemento (17)
- iduuidrequerido
- salesOrderobjetorequeridoadmite null
  Campos (2)
  - iduuidrequerido
  - numbertextorequerido
- salesOrderLineIduuidrequeridoadmite null
- invoiceLineIduuidrequeridoadmite null
- itemobjetorequerido
  Campos (3)
  - iduuidrequerido
  - codetextorequerido
  - nametextorequerido
- unitCodetextorequerido
- descriptiontextorequerido
- quantitynúmerorequerido
- unitPricetextorequerido
- discountPercentnúmerorequerido
- headerDiscountPercentnúmerorequerido
- lineKindopciónrequerido
  Valores: sale free
- vatPercentagenúmerorequerido
- netAmounttextorequerido
- creditedQuantitycualquierarequerido
- creditableQuantitycualquierarequerido
- deliveryNoteLineobjetorequeridoadmite null
  Campos (2)
  - iduuidrequerido
  - deliveryNoteobjetorequerido
    Campos (2)
    iduuidrequerido
    numbertextorequerido
totalsobjetorequerido
Campos (3)
- nettextorequerido
- vatlista de objetorequerido
  Campos de cada elemento (3)
  - ratenúmerorequerido
  - basetextorequerido
  - amounttextorequerido
- totaltextorequerido
orderDiscountslista de objetorequerido
Campos de cada elemento (3)
- percentnúmerorequerido
- amounttextorequerido
- texttextorequerido
perceptionobjetorequeridoadmite null
Campos (4)
- rateHundredthsenterorequerido
- basetextorequerido
- amounttextorequerido
- sourceopciónrequerido
  Valores: arba arba-previous adjustment
perceptionSkipopciónrequeridoadmite null
Valores: excluded not-listed no-cuit zero-rate below-minimum x-circuit
perceptionEstimateuno derequeridoadmite null
Una de 3 formas
Forma 1
- kindconstanterequerido
  Valores: estimated
- rateHundredthsenterorequerido
- amounttextorequerido
- totaltextorequerido
Forma 2
- kindconstanterequerido
  Valores: at-issue
Forma 3
- kindconstanterequerido
  Valores: none
- skipopciónrequerido
  Valores: excluded not-listed no-cuit zero-rate below-minimum x-circuit
caecualquierarequerido
caeExpiryfecharequeridoadmite null
authorizedAtfecha y horarequeridoadmite null
arcaObservationscualquierarequerido
submissionslista de objetorequerido
Campos de cada elemento (5)
- attemptenterorequerido
- kindopciónrequerido
  Valores: send recover
- resultopciónrequerido
  Valores: authorized rejected unavailable indeterminate
- messagecualquierarequerido
- recordedAtfecha y horarequerido
correctsobjetorequeridoadmite null
Campos (3)
- iduuidrequerido
- numbertextorequerido
- internalNumberenterorequerido
reasoncualquierarequerido
creditNoteslista de objetorequerido
Campos de cada elemento (4)
- iduuidrequerido
- numbertextorequerido
- statusopciónrequerido
  Valores: draft pending-authorization authorized discarded
- totaltextorequerido
notescualquierarequerido
createdAtfecha y horarequerido
createdByobjetorequeridoadmite null
Campos (2)
- idtextorequerido
- namecualquierarequerido
collectionobjetorequeridoadmite null
Campos (3)
- stateopciónrequerido
  Valores: pending partial complete
- balancetextorequerido
- dueDatefecharequerido
applicationobjetorequeridoadmite null
Campos (4)
- stateopciónrequerido
  Valores: pending partial complete
- balancetextorequerido
- invoiceBalancecualquierarequerido
- invoiceDueDatefecharequeridoadmite null
outcomeopciónrequerido
Valores: authorized rejected pending
messagetextorequerido

Errores

Un rechazo responde application/problem+json con un code estable. Los más comunes en esta operación:

`401`	Falta la credencial o venció.
`403`	La credencial no tiene el permiso `documents.issue-credit-note`.
`409`	La empresa activa no es la de `X-Expected-Company`.
`409`	Otra persona cambió el registro desde que lo leíste (`record.stale`).
`422`	Datos inválidos o una regla de negocio rota, con el detalle por campo.
`503`	Sistema ocupado: reintentá después de `Retry-After` segundos.

La lista completa está en Errores.

curl
TypeScript

curl -X POST "$ERP_URL/api/v1/documents/issue-credit-note" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "documentId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
  "version": 1
}'

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/documents/issue-credit-note`, {
  method: "POST",
  headers: {
    Cookie: process.env.ERP_SESION!,
    "X-Expected-Company": process.env.ERP_EMPRESA!,
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "documentId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "version": 1
  }),
});
if (!respuesta.ok) throw new Error((await respuesta.json()).title);
const datos = await respuesta.json();

{
  "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
  "kind": "invoice",
  "status": "draft",
  "number": "texto",
  "internalNumber": 1,
  "legalNumber": 1,
  "letter": "A",
  "documentDate": "2026-10-23",
  "customer": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "legalName": "texto",
    "documentType": "texto",
    "documentNumber": "texto",
    "vatCondition": "texto",
    "address": "texto"
  },
  "total": "texto",
  "lastSubmission": {
    "result": "authorized",
    "message": null,
    "recordedAt": "2026-10-23T14:30:00.000Z"
  },
  "version": 1,
  "pointOfSale": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "number": 1,
    "text": "texto"
  },
  "concept": "products",
  "servicePeriod": {
    "from": "2026-10-23",
    "to": "2026-10-23"
  },
  "paymentDueDate": "2026-10-23",
  "paymentTerm": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "name": "texto"
  },
  "paymentPlanText": "texto",
  "installments": [
    {
      "number": 1,
      "percent": 100,
      "dueDate": "2026-10-23",
      "amount": "texto"
    }
  ],
  "lines": [
    {
      "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "salesOrder": {
        "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "number": "texto"
      },
      "salesOrderLineId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "invoiceLineId": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "item": {
        "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "code": "texto",
        "name": "texto"
      },
      "unitCode": "texto",
      "description": "texto",
      "quantity": 100,
      "unitPrice": "texto",
      "discountPercent": 100,
      "headerDiscountPercent": 100,
      "lineKind": "sale",
      "vatPercentage": 100,
      "netAmount": "texto",
      "creditedQuantity": null,
      "creditableQuantity": null,
      "deliveryNoteLine": {
        "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
        "deliveryNote": {
          "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
          "number": "texto"
        }
      }
    }
  ],
  "totals": {
    "net": "texto",
    "vat": [
      {
        "rate": 100,
        "base": "texto",
        "amount": "texto"
      }
    ],
    "total": "texto"
  },
  "orderDiscounts": [
    {
      "percent": 100,
      "amount": "texto",
      "text": "texto"
    }
  ],
  "perception": {
    "rateHundredths": 1,
    "base": "texto",
    "amount": "texto",
    "source": "arba"
  },
  "perceptionSkip": "excluded",
  "perceptionEstimate": {
    "kind": "estimated",
    "rateHundredths": 1,
    "amount": "texto",
    "total": "texto"
  },
  "cae": null,
  "caeExpiry": "2026-10-23",
  "authorizedAt": "2026-10-23T14:30:00.000Z",
  "arcaObservations": null,
  "submissions": [
    {
      "attempt": 1,
      "kind": "send",
      "result": "authorized",
      "message": null,
      "recordedAt": "2026-10-23T14:30:00.000Z"
    }
  ],
  "corrects": {
    "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
    "number": "texto",
    "internalNumber": 1
  },
  "reason": null,
  "creditNotes": [
    {
      "id": "3f2a9c1e-5b7d-4e8a-9c21-7d4e5f6a8b90",
      "number": "texto",
      "status": "draft",
      "total": "texto"
    }
  ],
  "notes": null,
  "createdAt": "2026-10-23T14:30:00.000Z",
  "createdBy": {
    "id": "texto",
    "name": null
  },
  "collection": {
    "state": "pending",
    "balance": "texto",
    "dueDate": "2026-10-23"
  },
  "application": {
    "state": "pending",
    "balance": "texto",
    "invoiceBalance": null,
    "invoiceDueDate": "2026-10-23"
  },
  "outcome": "authorized",
  "message": "texto"
}