Solicitar acceso

Pasa la cuenta a habilitación o a producción

PATCH/api/v1/account/environment

La cuenta (o la casa de software sobre su cliente, con Facturoa-Account) cambia de ambiente si cumple los requisitos de GET /account/readiness (si no, 400 error.account.not_ready con lo que falta en errors[]). Una cuenta en producción no vuelve a habilitación (409 error.account.environment_back). Al cambiar se envía el webhook account.environment_changed con account_id, nit, environment, previous_environment y changed_at.

Cuerpo de la petición application/json

  • environmentstringobligatorio

    Valores: habilitacion · production

Respuestas

200Cuenta con el ambiente nuevo
  • idstring · uuid
  • parent_account_idstring · uuid

    Casa de software dueña; igual a id si no tiene padre

  • kindstring

    Valores: independent · software_house

  • emailstring
  • document_typestring

    13 cédula o 31 NIT

    Valores: 13 · 31

  • nitstring
  • dvstring
  • namestring
  • environmentstring

    Valores: staging · habilitacion · production

  • created_atstring · date-time
400Datos inválidos (details trae los campos)
  • codestring

    Ejemplo: error.document.invalid

  • messagestring
  • errorsarray<object>

    Solo en 400: cada campo inválido con su explicación (en español, o en inglés con Accept-Language: en)

    + Ver 2 campos− Ocultar 2 campos
    • fieldstring

      Ruta del campo en el JSON enviado

      Ejemplo: lines[0].quantity

    • messagestring

      Ejemplo: Cantidad inválida: debe ser mayor que cero.

  • detailsarray<string>

    Rutas de los campos inválidos (compatibilidad; usa errors)

  • request_idstring
401Falta la key o es inválida, está deshabilitada, vencida o revocada (error.missing_api_key, error.invalid_api_key, error.api_key.disabled, error.api_key.expired, error.api_key.revoked)
  • codestring

    Ejemplo: error.document.invalid

  • messagestring
  • errorsarray<object>

    Solo en 400: cada campo inválido con su explicación (en español, o en inglés con Accept-Language: en)

    + Ver 2 campos− Ocultar 2 campos
    • fieldstring

      Ruta del campo en el JSON enviado

      Ejemplo: lines[0].quantity

    • messagestring

      Ejemplo: Cantidad inválida: debe ser mayor que cero.

  • detailsarray<string>

    Rutas de los campos inválidos (compatibilidad; usa errors)

  • request_idstring
409Conflicto con el estado actual (p. ej. documento referenciado no aceptado, rango agotado)
  • codestring

    Ejemplo: error.document.invalid

  • messagestring
  • errorsarray<object>

    Solo en 400: cada campo inválido con su explicación (en español, o en inglés con Accept-Language: en)

    + Ver 2 campos− Ocultar 2 campos
    • fieldstring

      Ruta del campo en el JSON enviado

      Ejemplo: lines[0].quantity

    • messagestring

      Ejemplo: Cantidad inválida: debe ser mayor que cero.

  • detailsarray<string>

    Rutas de los campos inválidos (compatibilidad; usa errors)

  • request_idstring