Detalle de la retención

GET

/v1/withholdings/{id}

curl --request GET \
  --url https://api.chaski.ec/v1/withholdings/example \
  --header 'Authorization: Bearer <token>'

Authorizations

• apiKey

Parameters

Path Parameters

id

required

string

Responses

200

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])))$/

fiscal_period

required

string

subject

required

object

id

required

string

name

required

string

email

required

string | null

documents

required

Array<object>

object

type

required

string

number

required

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])))$/

total

required

string

withholdings

required

Array<object>

object

tax

required

string

Allowed values: income iva isd

code

required

string

base

required

string

rate

required

string

amount

required

string

total_withheld

required

string

total_withheld

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": "wht_01jbx3k9q2f8m4tn6vwz0yh5ce",
  "status": "pending",
  "environment": "test",
  "emission_point": "001-003",
  "number": "001-003-000000009",
  "fiscal_period": "2026-11",
  "documents": [
    {
      "type": "01",
      "number": "001-001-000000123",
      "withholdings": [
        {
          "tax": "income",
          "code": "312",
          "rate": "1.75"
        }
      ]
    }
  ]
}

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"
  }
}

404

No existe

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"
  }
}