Recent Posts

Recent Comments

Archives

Categories

PaymentMethods/Periods

Publicado
Updated
ByJavier Jaure

 


POST https://customerapi.geovictoria.com/api/v1/PaymentMethods/Periods

 

Descripción

Obtener la lista de períodos de pago de una empresa, filtrable por estado, mes y año. Devuelve los períodos
visibles para el perfil con su descripción, estado y rango de fechas. La empresa se indica en el body mediante
CompanyId.

Request

Request Body

 

Campos Tipo de dato Descripción
CompanyId Integer Identificador de la empresa cuyos períodos se desean obtener. Requerido.
PeriodState Integer Estado por el cual filtrar los períodos. 0 = Todos (sin filtro), 1 = Pendiente, 2 = Enviado, 3 = Aprobado, 4 =
Enviando, 5 = EnviadoConError, 6 = Cerrando, 7 = Cerrado, 8 = CerradoConError. Opcional, por defecto 0.
Month Integer Mes por el cual filtrar (1-12). Opcional; 0 = sin filtro por mes.
Year Integer Año por el cual filtrar (ej. 2026). Opcional; 0 = sin filtro por año.

Ejemplo request

{
          "CompanyId": 12345,
          "PeriodState": 0,
          "Month": 5,
          "Year": 2026
      }

 

Importante

  • El campo CompanyId es obligatorio; sin él la consulta no devuelve períodos.
  • Los campos PeriodState, Month y Year se combinan: sólo se
    aplican como filtro cuando son distintos de 0.

Response

Response Body

La respuesta es un arreglo de períodos con los siguientes campos:

Campos Tipo de dato Descripción
PeriodId Integer Identificador único del período
Description String Descripción del período
State String Descripción del estado del período (ej. Pendiente, Aprobado, Cerrado)
From DateTime Fecha de inicio del período (formato ISO 8601)
To DateTime Fecha de fin del período (formato ISO 8601)

 

Códigos

 

Código Descripción
200 Éxito
400 Error en el request

Ejemplo response

[
          {
              "PeriodId": 6789,
              "Description": "Mayo 2026",
              "State": "Cerrado",
              "From": "2026-05-01T00:00:00",
              "To": "2026-05-31T23:59:59"
          }
      ]
Tabla de contenidos