Emitir nota de crédito

POST

/v1/credit-notes

curl --request POST \
  --url https://api.chaski.ec/v1/credit-notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "invoice": "example", "reason": "example", "external_ref": "example", "items": [ { "code": "example", "auxiliary_code": "example", "description": "example", "quantity": "example", "unit_price": "example", "discount": "example", "taxes": [ { "type": "iva", "rate": "0", "percent": "example" } ], "details": { "additionalProperty": "example" } } ], "additional_info": { "additionalProperty": "example" }, "metadata": { "additionalProperty": "example" }, "send_email": true }'

Modifica una factura authorized: sale del mismo emisor y punto de emisión, con el mismo comprador. La suma de las notas de crédito activas (pending, received, authorized) de una factura no puede pasar de su total: si pasa, responde 422 credit_exceeds_invoice con el saldo en available. Una factura voided responde 409 invoice_voided. Responde 202 con status: "pending" y se notifica con credit_note.authorized o credit_note.rejected. En producción valida la cuota del plan y los paquetes: si no queda, 402 quota_exceeded (con limit, current, period_end y addon_offer). Los comprobantes de pruebas no consumen cuota.

Authorizations

• apiKey

Parameters

Header Parameters

Idempotency-Key

required

string

<= 255 characters

Una clave única por petición (por ejemplo un UUID). Vale 24 h: reintentar con la misma clave y el mismo body devuelve la misma respuesta.

Request Body^required

Media typeapplication/json

object

invoice

required

string

reason

required

string

>= 1 characters <= 300 characters

external_ref

string

>= 1 characters <= 255 characters

items

required

Array<object>

>= 1 items <= 500 items

object

code

string

>= 1 characters <= 25 characters

auxiliary_code

string

>= 1 characters <= 25 characters

description

required

string

>= 1 characters <= 300 characters

quantity

required

string

/^\d+(\.\d+)?$/

unit_price

required

string

/^\d+(\.\d+)?$/

discount

string

/^\d+(\.\d+)?$/

taxes

required

Array

>= 1 items <= 3 items

One of:

object

object

type

required

string

Allowed value: iva

rate

required

string

Allowed values: 0 5 15 exempt not_subject differentiated

percent

string

/^\d+(\.\d+)?$/

object

object

type

required

string

Allowed value: ice

code

required

string

/^3\d{3}$/

rate

required

string

/^\d+(\.\d+)?$/

base

string

/^\d+(\.\d+)?$/

amount

string

/^\d+(\.\d+)?$/

object

object

type

required

string

Allowed value: irbpnr

bottles

string

/^\d+$/

details

object

key

additional properties

string

<= 300 characters

additional_info

object

key

additional properties

string

<= 300 characters

metadata

object

key

additional properties

string

<= 500 characters

send_email

boolean

Responses

202

OK

Media typeapplication/json

object

id

required

string

status

required

string

Allowed values: pending received authorized rejected failed

environment

required

string

Allowed values: test live

issuer

required

string

emission_point

required

string

number

required

string

access_key

required

Clave de acceso de 49 dígitos

string

issue_date

required

string format: date

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$/

invoice

required

string

invoice_number

required

string

reason

required

string

buyer

required

object

id

required

string

name

required

string

email

required

string | null

totals

required

object

subtotal

required

string

discount

required

string

taxes

required

Array<object>

object

type

required

string

Allowed values: iva ice irbpnr

rate

required

string

base

required

string

amount

required

string

total

required

string

external_ref

required

string | null

metadata

required

object

key

additional properties

string

sri_messages

required

Array<object>

object

code

required

string

type

required

string

message

required

string

additional_info

string

authorized_at

required

Any of:

string

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

null

null

created_at

required

string format: date-time

/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/

Example

{
  "id": "cn_01jbx3k9q2f8m4tn6vwz0yh5ce",
  "status": "pending",
  "environment": "test",
  "emission_point": "001-001",
  "number": "001-001-000000007",
  "invoice": "inv_01jbx3k9q2f8m4tn6vwz0yh5ce",
  "invoice_number": "001-001-000000123",
  "totals": {
    "taxes": [
      {
        "type": "iva"
      }
    ]
  }
}

400

Petición inválida

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}

401

Falta la API key o no es válida

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}

402

Cuota de comprobantes agotada (quota_exceeded)

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}

403

Sin permiso (cuenta suspendida, emisor no habilitado en producción, límite del plan…)

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}

409

Conflicto (recurso repetido, Idempotency-Key en curso…)

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}

422

No se puede procesar (certificado vencido, Idempotency-Key reutilizada…)

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}

429

Demasiadas peticiones

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

field

string

key

additional properties

Example

{
  "error": {
    "code": "invalid_request"
  }
}