API Astral Rendiciones

Email

POST /email[/:email_id]

Fields

Field	Description	Required
para	Correo electrónico al que se enviará el email.	YES
con_copia	Lista de correos electrónicos a los que se copiará el email	YES
asunto	Asunto del email	YES
cuerpo	Cuerpo del email	YES

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Content-Type	application/vnd.apirendicion.v1+json application/json

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Fondo

Recuperar y manipular fondos registrados para su empresa

GET /fondo

Permite recuperar una lista paginada de todos los fondos registrados para su empresa

Son opcionales los parámetros:

page (identifica el número de página)
page_size (identifica la cantidad de registros por página, en caso no se agregue la cantidad por default es de 50)
id_usuario (identifica el id del usuario que se quiere consultar)

Ejemplo:

?page=5&page_size=10&id_usuario=180

Fields

Field	Type	Description	Required
id_fondo	integer	Identificador unico del fondo en la plataforma astral.	YES
descripcion	string(150)	Nombre referencial que identifica al fondo.	YES
abono_original	decimal(12,2)	Importe original del fondo asignado.	YES
abonos	decimal(12,2)	Importe de abono final.	YES
cargos	decimal(12,2)	Importe de los cargos de los gastos asignados.	YES
reparar	decimal(12,2)	Importe del exceso de los cargos de los gastos asignados.	YES
saldos	decimal(12,2)	Importe del saldo del fondo.	YES
moneda	string(3)	Moneda del fondo asignado. ISO 4217	YES
id_usuario	integer	Identificador del usuario al que se le asigna el fondo	YES
fecha_registro	string(19)	Fecha de registro de la planilla de movilidad. Formato "dd/mm/yyyy hh24:mi:ss"	YES
fondo_flexible	boolean	Identificador para tener un fondo flexible, permite que el monto de los gastos sobrepase el monto del fondo.	YES
abono_automatico	boolean	Identificador para tener un abono automatico, permite generar un fondo similar en cuando este haya sido liquidado.	YES
vencimiento	boolean	Identificador para colocar una fecha de vencimiento al fondo, despues de esta fecha no se prodrá utilizar el fondo.	YES
fecha_vencimiento	string(10)	Fecha de vencimiento del fondo. Formato "dd/mm/yyyy"	YES
origen_gasto	string(45)	Origen del Gasto	YES
sub_partida	string(45)	Sub Partida. Quiebre del Origen del Gasto	YES
codigo_interno	string(20)	Código interno registrado para la Sub Partida.	YES
dias	integer	Dias registrados para los viáticos.	YES
medio_desembolso	string(45)	Medio de desembolso del fondo.	YES
banco	string(150)	Banco de la cuenta donde se hara el desembolso.	YES
nro_cuenta	string(45)	Número de cuenta donde se hara el desembolso.	YES
motivo	string(150)	Motivo de la solicitud del fondo.	YES
ot_referencia	string(100)	Orden de Trabajo de referencia.	YES
id_usuario_autoriza	integer	Identificador del usuario que autoriza el fondo.	YES
estado_solicitud	string(45)	Estado de la solicitud del fondo.	YES
estado_fondo	string(45)	Estado del fondo.	YES
estado_integracion	integer	Estado de la integración del registro. 1 success - 2 error	YES
codigo_integracion	string(50)	Código Interno (SAP u otro que identifique al registro en su ERP)	YES
mensaje_integracion	string(255)	Mensaje descriptivo en caso exista un error en la integración del mismo	YES
fecha_integracion	string(19)	Fecha de integracion del gasto. Formato "dd/mm/yyyy hh24:mi:ss"	YES

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/fondo"
       },
       "first": {
           "href": "/fondo?page={page}"
       },
       "prev": {
           "href": "/fondo?page={page}"
       },
       "next": {
           "href": "/fondo?page={page}"
       },
       "last": {
           "href": "/fondo?page={page}"
       }
   }
   "_embedded": {
       "fondo": [
           {
               "_links": {
                   "self": {
                       "href": "/fondo[/:fondo_id]"
                   }
               }
              "id_fondo": "Identificador unico del fondo en la plataforma astral.",
              "descripcion": "Nombre referencial que identifica al fondo.",
              "abono_original": "Importe original del fondo asignado.",
              "abonos": "Importe de abono final.",
              "cargos": "Importe de los cargos de los gastos asignados.",
              "reparar": "Importe del exceso de los cargos de los gastos asignados.",
              "saldos": "Importe del saldo del fondo.",
              "moneda": "Moneda del fondo asignado. ISO 4217",
              "id_usuario": "Identificador del usuario al que se le asigna el fondo",
              "fecha_registro": "Fecha de registro de la planilla de movilidad. Formato "dd/mm/yyyy hh24:mi:ss"",
              "fondo_flexible": "Identificador para tener un fondo flexible, permite que el monto de los gastos sobrepase el monto del fondo.",
              "abono_automatico": "Identificador para tener un abono automatico, permite generar un fondo similar en cuando este haya sido liquidado.",
              "vencimiento": "Identificador para colocar una fecha de vencimiento al fondo, despues de esta fecha no se prodrá utilizar el fondo.",
              "fecha_vencimiento": "Fecha de vencimiento del fondo. Formato "dd/mm/yyyy"",
              "origen_gasto": "Origen del Gasto",
              "sub_partida": "Sub Partida. Quiebre del Origen del Gasto",
              "codigo_interno": "Código interno registrado para la Sub Partida.",
              "dias": "Dias registrados para los viáticos.",
              "medio_desembolso": "Medio de desembolso del fondo.",
              "banco": "Banco de la cuenta donde se hara el desembolso.",
              "nro_cuenta": "Número de cuenta donde se hara el desembolso.",
              "motivo": "Motivo de la solicitud del fondo.",
              "ot_referencia": "Orden de Trabajo de referencia.",
              "id_usuario_autoriza": "Identificador del usuario que autoriza el fondo.",
              "estado_solicitud": "Estado de la solicitud del fondo.",
              "estado_fondo": "Estado del fondo."
           }
       ]
   }
}

GET /fondo[/:fondo_id]

Permite recuperar los datos de un fondo especifico que pertenezca a su empresa

Fields

Field	Type	Description	Required
id_fondo	integer	Identificador unico del fondo en la plataforma astral.	YES
descripcion	string(150)	Nombre referencial que identifica al fondo.	YES
abono_original	decimal(12,2)	Importe original del fondo asignado.	YES
abonos	decimal(12,2)	Importe de abono final.	YES
cargos	decimal(12,2)	Importe de los cargos de los gastos asignados.	YES
reparar	decimal(12,2)	Importe del exceso de los cargos de los gastos asignados.	YES
saldos	decimal(12,2)	Importe del saldo del fondo.	YES
moneda	string(3)	Moneda del fondo asignado. ISO 4217	YES
id_usuario	integer	Identificador del usuario al que se le asigna el fondo	YES
fecha_registro	string(19)	Fecha de registro de la planilla de movilidad. Formato "dd/mm/yyyy hh24:mi:ss"	YES
fondo_flexible	boolean	Identificador para tener un fondo flexible, permite que el monto de los gastos sobrepase el monto del fondo.	YES
abono_automatico	boolean	Identificador para tener un abono automatico, permite generar un fondo similar en cuando este haya sido liquidado.	YES
vencimiento	boolean	Identificador para colocar una fecha de vencimiento al fondo, despues de esta fecha no se prodrá utilizar el fondo.	YES
fecha_vencimiento	string(10)	Fecha de vencimiento del fondo. Formato "dd/mm/yyyy"	YES
origen_gasto	string(45)	Origen del Gasto	YES
sub_partida	string(45)	Sub Partida. Quiebre del Origen del Gasto	YES
codigo_interno	string(20)	Código interno registrado para la Sub Partida.	YES
dias	integer	Dias registrados para los viáticos.	YES
medio_desembolso	string(45)	Medio de desembolso del fondo.	YES
banco	string(150)	Banco de la cuenta donde se hara el desembolso.	YES
nro_cuenta	string(45)	Número de cuenta donde se hara el desembolso.	YES
motivo	string(150)	Motivo de la solicitud del fondo.	YES
ot_referencia	string(100)	Orden de Trabajo de referencia.	YES
id_usuario_autoriza	integer	Identificador del usuario que autoriza el fondo.	YES
estado_solicitud	string(45)	Estado de la solicitud del fondo.	YES
estado_fondo	string(45)	Estado del fondo.	YES
estado_integracion	integer	Estado de la integración del registro. 1 success - 2 error	YES
codigo_integracion	string(50)	Código Interno (SAP u otro que identifique al registro en su ERP)	YES
mensaje_integracion	string(255)	Mensaje descriptivo en caso exista un error en la integración del mismo	YES
fecha_integracion	string(19)	Fecha de integracion del gasto. Formato "dd/mm/yyyy hh24:mi:ss"	YES

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/fondo[/:fondo_id]"
       }
   }
   "id_fondo": "Identificador unico del fondo en la plataforma astral.",
   "descripcion": "Nombre referencial que identifica al fondo.",
   "abono_original": "Importe original del fondo asignado.",
   "abonos": "Importe de abono final.",
   "cargos": "Importe de los cargos de los gastos asignados.",
   "reparar": "Importe del exceso de los cargos de los gastos asignados.",
   "saldos": "Importe del saldo del fondo.",
   "moneda": "Moneda del fondo asignado. ISO 4217",
   "id_usuario": "Identificador del usuario al que se le asigna el fondo",
   "fecha_registro": "Fecha de registro de la planilla de movilidad. Formato "dd/mm/yyyy hh24:mi:ss"",
   "fondo_flexible": "Identificador para tener un fondo flexible, permite que el monto de los gastos sobrepase el monto del fondo.",
   "abono_automatico": "Identificador para tener un abono automatico, permite generar un fondo similar en cuando este haya sido liquidado.",
   "vencimiento": "Identificador para colocar una fecha de vencimiento al fondo, despues de esta fecha no se prodrá utilizar el fondo.",
   "fecha_vencimiento": "Fecha de vencimiento del fondo. Formato "dd/mm/yyyy"",
   "origen_gasto": "Origen del Gasto",
   "sub_partida": "Sub Partida. Quiebre del Origen del Gasto",
   "codigo_interno": "Código interno registrado para la Sub Partida.",
   "dias": "Dias registrados para los viáticos.",
   "medio_desembolso": "Medio de desembolso del fondo.",
   "banco": "Banco de la cuenta donde se hara el desembolso.",
   "nro_cuenta": "Número de cuenta donde se hara el desembolso.",
   "motivo": "Motivo de la solicitud del fondo.",
   "ot_referencia": "Orden de Trabajo de referencia.",
   "id_usuario_autoriza": "Identificador del usuario que autoriza el fondo.",
   "estado_solicitud": "Estado de la solicitud del fondo.",
   "estado_fondo": "Estado del fondo."
}

PATCH /fondo[/:fondo_id]

Actualizar datos de un fondo que se encuentre registrado para su empresa.

Solo esta permito actualizar los datos de estado_integracion , codigo_integracion y mensaje_integracion, cualquier otro campo que se quiera enviar no se permitira la actualización.

Fields

Field	Type	Description	Required
id_fondo	integer	Identificador unico del fondo en la plataforma astral.	YES
descripcion	string(150)	Nombre referencial que identifica al fondo.	YES
abono_original	decimal(12,2)	Importe original del fondo asignado.	YES
abonos	decimal(12,2)	Importe de abono final.	YES
cargos	decimal(12,2)	Importe de los cargos de los gastos asignados.	YES
reparar	decimal(12,2)	Importe del exceso de los cargos de los gastos asignados.	YES
saldos	decimal(12,2)	Importe del saldo del fondo.	YES
moneda	string(3)	Moneda del fondo asignado. ISO 4217	YES
id_usuario	integer	Identificador del usuario al que se le asigna el fondo	YES
fecha_registro	string(19)	Fecha de registro de la planilla de movilidad. Formato "dd/mm/yyyy hh24:mi:ss"	YES
fondo_flexible	boolean	Identificador para tener un fondo flexible, permite que el monto de los gastos sobrepase el monto del fondo.	YES
abono_automatico	boolean	Identificador para tener un abono automatico, permite generar un fondo similar en cuando este haya sido liquidado.	YES
vencimiento	boolean	Identificador para colocar una fecha de vencimiento al fondo, despues de esta fecha no se prodrá utilizar el fondo.	YES
fecha_vencimiento	string(10)	Fecha de vencimiento del fondo. Formato "dd/mm/yyyy"	YES
origen_gasto	string(45)	Origen del Gasto	YES
sub_partida	string(45)	Sub Partida. Quiebre del Origen del Gasto	YES
codigo_interno	string(20)	Código interno registrado para la Sub Partida.	YES
dias	integer	Dias registrados para los viáticos.	YES
medio_desembolso	string(45)	Medio de desembolso del fondo.	YES
banco	string(150)	Banco de la cuenta donde se hara el desembolso.	YES
nro_cuenta	string(45)	Número de cuenta donde se hara el desembolso.	YES
motivo	string(150)	Motivo de la solicitud del fondo.	YES
ot_referencia	string(100)	Orden de Trabajo de referencia.	YES
id_usuario_autoriza	integer	Identificador del usuario que autoriza el fondo.	YES
estado_solicitud	string(45)	Estado de la solicitud del fondo.	YES
estado_fondo	string(45)	Estado del fondo.	YES
estado_integracion	integer	Estado de la integración del registro. 1 success - 2 error	YES
codigo_integracion	string(50)	Código Interno (SAP u otro que identifique al registro en su ERP)	YES
mensaje_integracion	string(255)	Mensaje descriptivo en caso exista un error en la integración del mismo	YES
fecha_integracion	string(19)	Fecha de integracion del gasto. Formato "dd/mm/yyyy hh24:mi:ss"	YES

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Content-Type	application/vnd.apirendicion.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{ "estado_integracion": "Estado de la integración del registro",
  "codigo_integracion": "Código Interno (SAP u otro que identifique al registro en su ERP)" ,
  "mensaje_integracion": "Mensaje descriptivo en caso exista un error en la integración del mismo" }

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/fondo[/:fondo_id]"
       }
   }
   "estado_integracion": "Estado de la integración del registro",
   "codigo_integracion": "Código Interno (SAP u otro que identifique al registro en su ERP)" ,
   "mensaje_integracion": "Mensaje descriptivo en caso exista un error en la integración del mismo"
}

Gasto

Recuperar y manipular gastos registrados para su empresa

GET /gasto

Permite recuperar una lista paginada de todos los gastos registrados para su empresa

Son opcionales los parámetros:

page (identifica el número de página)
page_size (identifica la cantidad de registros por página, en caso no se agregue la cantidad por default es de 50)
id_usuario (identifica el id del usuario que se quiere consultar)

Ejemplo:

?page=5&page_size=10&id_usuario=180

Fields

Field

Type

Description

Required

id_gasto

integer

Identificacor del gasto en la plataforma de astral

YES

descripcion

string(200)

Descripción referencial del gasto

YES

registro_unico

string(20)

Número de registro único del proveedor emisor del documento de gasto

YES

razon_social

string(150)

Nombre del proveedor emisor del documento de gasto

YES

tipo_documento

string(45)

Tipo de documento del gasto

YES

numero_documento

string(30)

Número de documento del gasto

YES

fecha_documento

string(10)

Fecha de emisión del documento de gasto. Formato "dd/mm/yyyy"

YES

impuesto

decimal(12,2)

importe del impuesto en la moneda nacional

YES

total

decimal(12,2)

importe total del documento en la moneda nacional

YES

moneda

string(3)

Moneda del documento. ISO 4217

YES

tipo_cambio

decimal(12,2)

Tipo de cambio del documento. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo

YES

total_original

decimal(12,2)

Importe total del documento en la moneda original. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo

YES

moneda_original

string(3)

Moneda original del documento. ISO 4217. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo

YES

partida

string(45)

Partida del gasto

YES

forma_pago

string(45)

Forma de pago del gasto. Se toma en cuenta siempre y cuando el gasto no haya sido distribuido

YES

fecha_registro

string(19)

Fecha de registro del gasto. Formato "dd/mm/yyyy hh24:mi:ss"

YES

estado

string(45)

Estado del gasto en la plataforma astral

YES

url_image

string(350)

Url de referencia de la imagen cargada del gasto

YES

id_usuario

integer

Identificador del usuario que registra el gasto

YES

id_politica

integer

Identificador de la politica de gasto a la que hace referencia el gasto

YES

estado_integracion

integer

Estado de la integración del registro. 1 success - 2 error

YES

codigo_integracion

string(50)

Código Interno (SAP u otro que identifique al registro en su ERP)

YES

mensaje_integracion

string(255)

Mensaje descriptivo en caso exista un error en la integración del mismo

YES

fecha_integracion

string(19)

Fecha de integracion del gasto. Formato "dd/mm/yyyy hh24:mi:ss"

YES

detalle

array [objectDetalle]

Contiene el detalle del documento

La estructura de objectDetalle es:

Field	Type	Description
descripcion	string(100)	Descripción del item del documento
cantidad	integer	Cantidad de items
precio_unitario	decimal(12,2)	Precio unitario del item
precio_total	decimal(12,2)	Pecio total del item

campo_custom

array [objectCustom]

Contiene los campos personalizados solicitados en el registro del documento

La estructura de objectCustom es:

Field	Type	Description
campo	string(100)	Título del campo
valor	string(100)	Valor del campo

distribucion

array [objectDistribucion]

Contiene la distribución en cuanto a forma de pago del documento

La estructura de objectDistribucion es:

Field	Type	Description
forma_pago	string(100)	Forma de pago de la distribución
importe	decimal(12,2)	Importe de la distribución

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/gasto"
       },
       "first": {
           "href": "/gasto?page={page}"
       },
       "prev": {
           "href": "/gasto?page={page}"
       },
       "next": {
           "href": "/gasto?page={page}"
       },
       "last": {
           "href": "/gasto?page={page}"
       }
   }
   "_embedded": {
       "gasto": [
           {
               "_links": {
                   "self": {
                       "href": "/gasto[/:gasto_id]"
                   }
               }
              "id_gasto": "Identificacor del gasto en la plataforma de astral",
              "descripcion": "Descripción referencial del gasto",
              "registro_unico": "Número de registro único del proveedor emisor del documento de gasto",
              "razon_social": "Nombre del proveedor emisor del documento de gasto",
              "tipo_documento": "Tipo de documento del gasto",
              "numero_documento": "Número de documento del gasto",
              "fecha_documento": "Fecha de emisión del documento de gasto. dd/mm/yyyy",
              "total": "importe total del documento en la moneda nacional",
              "moneda": "Moneda del documento. ISO 4217",
              "tipo_cambio": "Tipo de cambio del documento. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo",
              "total_original": "Importe total del documento en la moneda original. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo",
              "moneda_original": "Moneda original del documento. ISO 4217. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo",
              "partida": "Partida del gasto",
              "forma_pago": "Forma de pago del gasto. Se toma en cuenta siempre y cuando el gasto no haya sido distribuido",
              "fecha_registro": "Fecha de registro del gasto. dd/mm/yyyy hh24:mi:ss",
              "estado": "Estado del gasto en la plataforma astral",
              "url_image": "Url de referencia de la imagen cargada del gasto",
              "id_usuario": "Identificador del usuario que registra el gasto",
              "id_politica": "Identificador de la politica de gasto a la que hace referencia el gasto",
              "detalle": [
                               { "descripcion": "Descripción del item del documento",
                                 "cantidad"; "Cantidad de items",
                                 "precio_unitario"; "Precio unitario del item",
                                 "precio_total"; "Pecio total del item" }
                             ],
              "campo_custom": [
                               { "campo": "Título del campo",
                                 "valor"; "Valor del campo" }
                             ],
              "distribucion": [
                               { "forma_pago": "Forma de pago de la distribución",
                                 "importe"; "Importe de la distribución" }
                             ]
           }
       ]
   }
}

GET /gasto[/:gasto_id]

Permite recuperar los datos de un gasto especifico que pertenezca a su empresa

Fields

Field

Type

Description

Required

id_gasto

integer

Identificacor del gasto en la plataforma de astral

YES

descripcion

string(200)

Descripción referencial del gasto

YES

registro_unico

string(20)

Número de registro único del proveedor emisor del documento de gasto

YES

razon_social

string(150)

Nombre del proveedor emisor del documento de gasto

YES

tipo_documento

string(45)

Tipo de documento del gasto

YES

numero_documento

string(30)

Número de documento del gasto

YES

fecha_documento

string(10)

Fecha de emisión del documento de gasto. Formato "dd/mm/yyyy"

YES

impuesto

decimal(12,2)

importe del impuesto en la moneda nacional

YES

total

decimal(12,2)

importe total del documento en la moneda nacional

YES

moneda

string(3)

Moneda del documento. ISO 4217

YES

tipo_cambio

decimal(12,2)

Tipo de cambio del documento. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo

YES

total_original

decimal(12,2)

Importe total del documento en la moneda original. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo

YES

moneda_original

string(3)

Moneda original del documento. ISO 4217. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo

YES

partida

string(45)

Partida del gasto

YES

forma_pago

string(45)

Forma de pago del gasto. Se toma en cuenta siempre y cuando el gasto no haya sido distribuido

YES

fecha_registro

string(19)

Fecha de registro del gasto. Formato "dd/mm/yyyy hh24:mi:ss"

YES

estado

string(45)

Estado del gasto en la plataforma astral

YES

url_image

string(350)

Url de referencia de la imagen cargada del gasto

YES

id_usuario

integer

Identificador del usuario que registra el gasto

YES

id_politica

integer

Identificador de la politica de gasto a la que hace referencia el gasto

YES

estado_integracion

integer

Estado de la integración del registro. 1 success - 2 error

YES

codigo_integracion

string(50)

Código Interno (SAP u otro que identifique al registro en su ERP)

YES

mensaje_integracion

string(255)

Mensaje descriptivo en caso exista un error en la integración del mismo

YES

fecha_integracion

string(19)

Fecha de integracion del gasto. Formato "dd/mm/yyyy hh24:mi:ss"

YES

detalle

array [objectDetalle]

Contiene el detalle del documento

La estructura de objectDetalle es:

Field	Type	Description
descripcion	string(100)	Descripción del item del documento
cantidad	integer	Cantidad de items
precio_unitario	decimal(12,2)	Precio unitario del item
precio_total	decimal(12,2)	Pecio total del item

campo_custom

array [objectCustom]

Contiene los campos personalizados solicitados en el registro del documento

La estructura de objectCustom es:

Field	Type	Description
campo	string(100)	Título del campo
valor	string(100)	Valor del campo

distribucion

array [objectDistribucion]

Contiene la distribución en cuanto a forma de pago del documento

La estructura de objectDistribucion es:

Field	Type	Description
forma_pago	string(100)	Forma de pago de la distribución
importe	decimal(12,2)	Importe de la distribución

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/gasto[/:gasto_id]"
       }
   }
   "id_gasto": "Identificacor del gasto en la plataforma de astral",
   "descripcion": "Descripción referencial del gasto",
   "registro_unico": "Número de registro único del proveedor emisor del documento de gasto",
   "razon_social": "Nombre del proveedor emisor del documento de gasto",
   "tipo_documento": "Tipo de documento del gasto",
   "tipo_documento_fiscal": "Código Tipo de documento fiscal del gasto (Depende del País)",
   "numero_documento": "Número de documento del gasto",
   "fecha_documento": "Fecha de emisión del documento de gasto. dd/mm/yyyy",
   "gravado": "importe total gravado",
   "no_gravado": "importe total no gravado",
   "impuesto": "importe total del impuesto",
   "total": "importe total del documento en la moneda nacional",
   "moneda": "Moneda del documento. ISO 4217",
   "tipo_cambio": "Tipo de cambio del documento. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo",
   "total_original": "Importe total del documento en la moneda original. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo",
   "moneda_original": "Moneda original del documento. ISO 4217. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo",
   "niff": "niff registrado para la categoría de gasto",
   "centro_costo": "centro de costo registrado para la categoría de gasto",
   "cuenta_contable": "cuenta contable registrado para la categoría de gasto",
   "partida": "Partida del gasto",
   "forma_pago": "Forma de pago del gasto. Se toma en cuenta siempre y cuando el gasto no haya sido distribuido",
   "codigo_proyecto": "código del proyecto al que se refiere el gasto",
   "nombre_proyecto": "nombre del proyecto al que se refiere el gasto",
   "fecha_registro": "Fecha de registro del gasto. dd/mm/yyyy hh24:mi:ss",
   "estado": "Estado del gasto en la plataforma astral",
   "url_image": "Url de referencia de la imagen cargada del gasto",
   "id_usuario": "Identificador del usuario que registra el gasto",
   "id_politica": "Identificador de la politica de gasto a la que hace referencia el gasto",
   "detalle": [
                    { "descripcion": "Descripción del item del documento",
                      "cantidad"; "Cantidad de items",
                      "precio_unitario"; "Precio unitario del item",
                      "precio_total"; "Pecio total del item" }
                   ],
   "campo_custom": [
                    { "campo": "Título del campo",
                      "valor"; "Valor del campo" }
                   ],
   "distribucion": [
                    { "forma_pago": "Forma de pago de la distribución",
                      "importe"; "Importe de la distribución" }
                   ]
}

PATCH /gasto[/:gasto_id]

Actualizar datos de un gasto que se encuentre registrado para su empresa.

Solo esta permito actualizar los datos de estado_integracion , codigo_integracion y mensaje_integracion, cualquier otro campo que se quiera enviar no se permitira la actualización.

Fields

Field

Type

Description

Required

id_gasto

integer

Identificacor del gasto en la plataforma de astral

YES

descripcion

string(200)

Descripción referencial del gasto

YES

registro_unico

string(20)

Número de registro único del proveedor emisor del documento de gasto

YES

razon_social

string(150)

Nombre del proveedor emisor del documento de gasto

YES

tipo_documento

string(45)

Tipo de documento del gasto

YES

numero_documento

string(30)

Número de documento del gasto

YES

fecha_documento

string(10)

Fecha de emisión del documento de gasto. Formato "dd/mm/yyyy"

YES

impuesto

decimal(12,2)

importe del impuesto en la moneda nacional

YES

total

decimal(12,2)

importe total del documento en la moneda nacional

YES

moneda

string(3)

Moneda del documento. ISO 4217

YES

tipo_cambio

decimal(12,2)

Tipo de cambio del documento. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo

YES

total_original

decimal(12,2)

Importe total del documento en la moneda original. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo

YES

moneda_original

string(3)

Moneda original del documento. ISO 4217. Sólo en caso que la moneda original del documento difiera de la moneda del país de emisión del mismo

YES

partida

string(45)

Partida del gasto

YES

forma_pago

string(45)

Forma de pago del gasto. Se toma en cuenta siempre y cuando el gasto no haya sido distribuido

YES

fecha_registro

string(19)

Fecha de registro del gasto. Formato "dd/mm/yyyy hh24:mi:ss"

YES

estado

string(45)

Estado del gasto en la plataforma astral

YES

url_image

string(350)

Url de referencia de la imagen cargada del gasto

YES

id_usuario

integer

Identificador del usuario que registra el gasto

YES

id_politica

integer

Identificador de la politica de gasto a la que hace referencia el gasto

YES

estado_integracion

integer

Estado de la integración del registro. 1 success - 2 error

YES

codigo_integracion

string(50)

Código Interno (SAP u otro que identifique al registro en su ERP)

YES

mensaje_integracion

string(255)

Mensaje descriptivo en caso exista un error en la integración del mismo

YES

fecha_integracion

string(19)

Fecha de integracion del gasto. Formato "dd/mm/yyyy hh24:mi:ss"

YES

detalle

array [objectDetalle]

Contiene el detalle del documento

La estructura de objectDetalle es:

Field	Type	Description
descripcion	string(100)	Descripción del item del documento
cantidad	integer	Cantidad de items
precio_unitario	decimal(12,2)	Precio unitario del item
precio_total	decimal(12,2)	Pecio total del item

campo_custom

array [objectCustom]

Contiene los campos personalizados solicitados en el registro del documento

La estructura de objectCustom es:

Field	Type	Description
campo	string(100)	Título del campo
valor	string(100)	Valor del campo

distribucion

array [objectDistribucion]

Contiene la distribución en cuanto a forma de pago del documento

La estructura de objectDistribucion es:

Field	Type	Description
forma_pago	string(100)	Forma de pago de la distribución
importe	decimal(12,2)	Importe de la distribución

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Content-Type	application/vnd.apirendicion.v1+json application/json

Body

{ "estado_integracion": "Estado de la integración del registro",
  "codigo_integracion": "Código Interno (SAP u otro que identifique al registro en su ERP)" ,
  "mensaje_integracion": "Mensaje descriptivo en caso exista un error en la integración del mismo" }

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/gasto[/:gasto_id]"
       }
   }
   "estado_integracion": "Estado de la integración del registro",
   "codigo_integracion": "Código Interno (SAP u otro que identifique al registro en su ERP)" ,
   "mensaje_integracion": "Mensaje descriptivo en caso exista un error en la integración del mismo"
}

InformeGasto

Recuperar y manipular informes de gastos registrados para su empresa

GET /informe-gasto

Permite recuperar una lista paginada de todos los informes de gastos registrados para su empresa

Son opcionales los parámetros:

page (identifica el número de página)
page_size (identifica la cantidad de registros por página, en caso no se agregue la cantidad por default es de 50)
id_usuario (identifica el id del usuario que se quiere consultar)

Ejemplo:

?page=5&page_size=10&id_usuario=180

Fields

Field

Type

Description

Required

id_infgasto

integer

Identificador del informe de gastos

YES

titulo

string(100)

Descripción referencial del informe de gastos

YES

observacion

string(200)

Observación registrada por el usuario

YES

total

decimal(12,2)

Importe total del informe de gastos

YES

moneda

string(3)

Moneda del informe de gastos. ISO 4217

YES

fecha_registro

string(19)

Fecha de registro del informe de gastos. Formato "dd/mm/yyyy hh24:mi:ss"

YES

id_politica

integer

Identificador de la política de gasto referencial

YES

id_fondo

integer

Identificador del fondo referencial del informe de gastos

YES

id_usuario

integer

Identificador del usuario que registra el informe de gastos

YES

estado

string(45)

Estado del informe de gastos en la plataforma astral

YES

estado_integracion

integer

Estado de la integración del registro. 1 success - 2 error

YES

codigo_integracion

string(50)

Código Interno (SAP u otro que identifique al registro en su ERP)

YES

mensaje_integracion

string(255)

Mensaje descriptivo en caso exista un error en la integración del mismo

YES

fecha_integracion

string(19)

Fecha de integracion del gasto. Formato "dd/mm/yyyy hh24:mi:ss"

YES

documentos

array [objectDocumento]

Contiene los documentos que conforman el informe de gastos

La estructura de objectDocumento es:

Field	Type	Description
id_gasto	integer	Identificador del gasto de movilidad
descripcion	string(100)	Descripción referencial del gasto
id_planillamov	integer	Identificador de la planilla de movilidad
documentos	integer	Cantidad de documentos de la planilla de movilidad
total	decimal(12,2)	Importe total del gasto o planilla de movilidad
moneda	string(3)	Moneda del gasto o planilla de movilidad. ISO 4217

YES

campo_custom

array [objectCustom]

Contiene los campos personalizados solicitados en el registro de informes de gastos

La estructura de objectCustom es:

Field	Type	Description
campo	string(100)	Título del campo
valor	string(100)	Valor del campo

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/informe-gasto"
       },
       "first": {
           "href": "/informe-gasto?page={page}"
       },
       "prev": {
           "href": "/informe-gasto?page={page}"
       },
       "next": {
           "href": "/informe-gasto?page={page}"
       },
       "last": {
           "href": "/informe-gasto?page={page}"
       }
   }
   "_embedded": {
       "informe_gasto": [
           {
               "_links": {
                   "self": {
                       "href": "/informe-gasto[/:informe_gasto_id]"
                   }
               }
              "id_infgasto": "Identificador del informe de gastos",
              "titulo": "Descripción referencial del informe de gastos",
              "observacion": "Observación registrada por el usuario",
              "total": "Importe total del informe de gastos",
              "moneda": "Moneda del informe de gastos. ISO 4217",
              "fecha_registro": "Fecha de registro del informe de gastos. Formato "dd/mm/yyyy hh24:mi:ss"",
              "id_politica": "Identificador de la política de gasto referencial",
              "id_fondo": "Identificador del fondo referencial del informe de gastos",
              "id_usuario": "Identificador del usuario que registra el informe de gastos",
              "estado": "Estado del informe de gastos en la plataforma astral",
              "documentos": [
               {
                 "id_gasto": "Identificador del gasto de movilidad",
                 "descripcion": "Descripción referencial del gasto",
                 "id_planillamov": "Identificador de la planilla de movilidad",
                 "documentos": "Cantidad de documentos de la planilla de movilidad",
                 "total": "Importe total del gasto",
                 "moneda": "Moneda del gasto. ISO 4217"
                }
               ],
              "campo_custom": [
               {
                 "campo": "Título del campo",
                 "valor": "Valor del campo"
                }
               ]
           }
       ]
   }
}

GET /informe-gasto[/:informe_gasto_id]

Permite recuperar los datos de un informe de gastos especifico que pertenezca a su empresa

Fields

Field

Type

Description

Required

id_infgasto

integer

Identificador del informe de gastos

YES

titulo

string(100)

Descripción referencial del informe de gastos

YES

observacion

string(200)

Observación registrada por el usuario

YES

total

decimal(12,2)

Importe total del informe de gastos

YES

moneda

string(3)

Moneda del informe de gastos. ISO 4217

YES

fecha_registro

string(19)

Fecha de registro del informe de gastos. Formato "dd/mm/yyyy hh24:mi:ss"

YES

id_politica

integer

Identificador de la política de gasto referencial

YES

id_fondo

integer

Identificador del fondo referencial del informe de gastos

YES

id_usuario

integer

Identificador del usuario que registra el informe de gastos

YES

estado

string(45)

Estado del informe de gastos en la plataforma astral

YES

estado_integracion

integer

Estado de la integración del registro. 1 success - 2 error

YES

codigo_integracion

string(50)

Código Interno (SAP u otro que identifique al registro en su ERP)

YES

mensaje_integracion

string(255)

Mensaje descriptivo en caso exista un error en la integración del mismo

YES

fecha_integracion

string(19)

Fecha de integracion del gasto. Formato "dd/mm/yyyy hh24:mi:ss"

YES

documentos

array [objectDocumento]

Contiene los documentos que conforman el informe de gastos

La estructura de objectDocumento es:

Field	Type	Description
id_gasto	integer	Identificador del gasto de movilidad
descripcion	string(100)	Descripción referencial del gasto
id_planillamov	integer	Identificador de la planilla de movilidad
documentos	integer	Cantidad de documentos de la planilla de movilidad
total	decimal(12,2)	Importe total del gasto o planilla de movilidad
moneda	string(3)	Moneda del gasto o planilla de movilidad. ISO 4217

YES

campo_custom

array [objectCustom]

Contiene los campos personalizados solicitados en el registro de informes de gastos

La estructura de objectCustom es:

Field	Type	Description
campo	string(100)	Título del campo
valor	string(100)	Valor del campo

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/informe-gasto[/:informe_gasto_id]"
       }
   }
   "id_infgasto": "Identificador del informe de gastos",
   "titulo": "Descripción referencial del informe de gastos",
   "observacion": "Observación registrada por el usuario",
   "total": "Importe total del informe de gastos",
   "moneda": "Moneda del informe de gastos. ISO 4217",
   "fecha_registro": "Fecha de registro del informe de gastos. Formato "dd/mm/yyyy hh24:mi:ss"",
   "id_politica": "Identificador de la política de gasto referencial",
   "id_fondo": "Identificador del fondo referencial del informe de gastos",
   "id_usuario": "Identificador del usuario que registra el informe de gastos",
   "estado": "Estado del informe de gastos en la plataforma astral",
   "documentos": [
      {
       "id_gasto": "Identificador del gasto de movilidad",
       "descripcion": "Descripción referencial del gasto",
       "id_planillamov": "Identificador de la planilla de movilidad",
       "documentos": "Cantidad de documentos de la planilla de movilidad",
       "total": "Importe total del gasto",
       "moneda": "Moneda del gasto. ISO 4217"
      }
     ],
     "campo_custom": [
      {
       "campo": "Título del campo",
       "valor": "Valor del campo"
       }
      ]
}

PATCH /informe-gasto[/:informe_gasto_id]

Fields

Field

Type

Description

Required

id_infgasto

integer

Identificador del informe de gastos

YES

titulo

string(100)

Descripción referencial del informe de gastos

YES

observacion

string(200)

Observación registrada por el usuario

YES

total

decimal(12,2)

Importe total del informe de gastos

YES

moneda

string(3)

Moneda del informe de gastos. ISO 4217

YES

fecha_registro

string(19)

Fecha de registro del informe de gastos. Formato "dd/mm/yyyy hh24:mi:ss"

YES

id_politica

integer

Identificador de la política de gasto referencial

YES

id_fondo

integer

Identificador del fondo referencial del informe de gastos

YES

id_usuario

integer

Identificador del usuario que registra el informe de gastos

YES

estado

string(45)

Estado del informe de gastos en la plataforma astral

YES

estado_integracion

integer

Estado de la integración del registro. 1 success - 2 error

YES

codigo_integracion

string(50)

Código Interno (SAP u otro que identifique al registro en su ERP)

YES

mensaje_integracion

string(255)

Mensaje descriptivo en caso exista un error en la integración del mismo

YES

fecha_integracion

string(19)

Fecha de integracion del gasto. Formato "dd/mm/yyyy hh24:mi:ss"

YES

documentos

array [objectDocumento]

Contiene los documentos que conforman el informe de gastos

La estructura de objectDocumento es:

Field	Type	Description
id_gasto	integer	Identificador del gasto de movilidad
descripcion	string(100)	Descripción referencial del gasto
id_planillamov	integer	Identificador de la planilla de movilidad
documentos	integer	Cantidad de documentos de la planilla de movilidad
total	decimal(12,2)	Importe total del gasto o planilla de movilidad
moneda	string(3)	Moneda del gasto o planilla de movilidad. ISO 4217

YES

campo_custom

array [objectCustom]

Contiene los campos personalizados solicitados en el registro de informes de gastos

La estructura de objectCustom es:

Field	Type	Description
campo	string(100)	Título del campo
valor	string(100)	Valor del campo

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Content-Type	application/vnd.apirendicion.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Login

Recuperar datos de usuario registrado para su emmpresa. Sólo disponible para integraciones internas.

POST /login[/:login_id]

Permite verificar las credenciales de un usuario registrado en astral

Fields

Field	Type	Description	Required
email		Email del usuario registrado en astral	YES
password		Contraseña del usuario a loguearse.	YES

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Content-Type	application/vnd.apirendicion.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{
   "email": "Email del usuario registrado en astral",
   "password": "Contraseña del usuario a loguearse."
}

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
201: Created
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/login[/:login_id]"
       }
   }
   "id_usuario": "Identificador del usuarion en la plataforma astral",
   "email": "Correo electrónico del usuario",
   "tipo_identidad": "Tipo de documento de identidad del usuario",
   "numero_identidad": "Número de documento identidad del usuario",
   "nombres": "Nombres del usuario",
   "apellidos": "Apellidos del usuario",
   "descripcion_cargo": "Cargo del usuario",
   "fecha_registro": "Fecha y hora de registro del usuario",
   "centro_costo": "Centro de costo del usuario",
   "ot_default": "Orden de Trabajo por defecto",
   "rol_usuario": "Roles del usuario asignados al usuario en la plataforma astral"
}

PlanillaMovilidad

Recuperar y manipular planillas de movilidad registrados para su empresa

GET /planilla-movilidad

Permite recuperar una lista paginada de todos las planillas de movilidad registrados para su empresa

Son opcionales los parámetros:

page (identifica el número de página)
page_size (identifica la cantidad de registros por página, en caso no se agregue la cantidad por default es de 50)
id_usuario (identifica el id del usuario que se quiere consultar)

Ejemplo:

?page=5&page_size=10&id_usuario=180

Fields

Field

Type

Description

Required

id_planillamov

integer

Identificador de la planilla de movilidad

YES

titulo

string(100)

Descripción referencial de la planilla de movilidad

YES

observacion

string(200)

Observación registrada por el usuario

YES

total

decimal(12,2)

Importe total de la planilla de movilidad

YES

moneda

string(3)

Moneda de la planilla de movilidad. ISO 4217

YES

fecha_registro

string(19)

Fecha de registro de la planilla de movilidad. Formato "dd/mm/yyyy hh24:mi:ss"

YES

id_politica

integer

Identificador de la política de gasto referencial

YES

id_fondo

integer

Identificador del fondo referencial de la planilla de movilidad

YES

id_usuario

integer

Identificador del usuario que registra la planilla de movilidad

YES

estado

string(45)

Estado de la planilla de movilidad en la plataforma astral

YES

documentos

array [objectDocumento]

Contiene los documentos que conforman la planilla de movilidad

La estructura de objectDocumento es:

Field	Type	Description
id_gasto	integer	Identificador del gasto de movilidad
descripcion	string(100)	Descripción referencial del gasto
total	decimal(12,2)	Importe total del gasto
moneda	string(3)	Moneda del gasto. ISO 4217
motivo	string(100)	Motivo del gasto de movilidad
destino	string(100)	Destino referencial del gasto de movilidad

YES

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/planilla-movilidad"
       },
       "first": {
           "href": "/planilla-movilidad?page={page}"
       },
       "prev": {
           "href": "/planilla-movilidad?page={page}"
       },
       "next": {
           "href": "/planilla-movilidad?page={page}"
       },
       "last": {
           "href": "/planilla-movilidad?page={page}"
       }
   }
   "_embedded": {
       "planilla_movilidad": [
           {
               "_links": {
                   "self": {
                       "href": "/planilla-movilidad[/:planilla_movilidad_id]"
                   }
               }
              "id_planillamov": "Identificador de la planilla de movilidad",
              "titulo": "Descripción referencial de la planilla de movilidad",
              "observacion": "Observación registrada por el usuario",
              "total": "Importe total de la planilla de movilidad",
              "moneda": "Moneda de la planilla de movilidad. ISO 4217",
              "fecha_registro": "Fecha de registro de la planilla de movilidad. Formato "dd/mm/yyyy hh24:mi:ss"",
              "id_politica": "Identificador de la política de gasto referencial",
              "id_fondo": "Identificador del fondo referencial de la planilla de movilidad",
              "id_usuario": "Identificador del usuario que registra la planilla de movilidad",
              "estado": "Estado de la planilla de movilidad en la plataforma astral",
              "documentos": [
               {
                 "id_gasto": "Identificador del gasto de movilidad",
                 "descripcion": "Descripción referencial del gasto",
                 "total": "Importe total del gasto",
                 "moneda": "Moneda del gasto. ISO 4217",
                 "motivo": "Motivo del gasto de movilidad",
                 "destino": "Destino referencial del gasto de movilidad"
                }
               ]
           }
       ]
   }
}

GET /planilla-movilidad[/:planilla_movilidad_id]

Permite recuperar los datos de una planilla de movilidad especifica que pertenezca a su empresa

Fields

Field

Type

Description

Required

id_planillamov

integer

Identificador de la planilla de movilidad

YES

titulo

string(100)

Descripción referencial de la planilla de movilidad

YES

observacion

string(200)

Observación registrada por el usuario

YES

total

decimal(12,2)

Importe total de la planilla de movilidad

YES

moneda

string(3)

Moneda de la planilla de movilidad. ISO 4217

YES

fecha_registro

string(19)

Fecha de registro de la planilla de movilidad. Formato "dd/mm/yyyy hh24:mi:ss"

YES

id_politica

integer

Identificador de la política de gasto referencial

YES

id_fondo

integer

Identificador del fondo referencial de la planilla de movilidad

YES

id_usuario

integer

Identificador del usuario que registra la planilla de movilidad

YES

estado

string(45)

Estado de la planilla de movilidad en la plataforma astral

YES

documentos

array [objectDocumento]

Contiene los documentos que conforman la planilla de movilidad

La estructura de objectDocumento es:

Field	Type	Description
id_gasto	integer	Identificador del gasto de movilidad
descripcion	string(100)	Descripción referencial del gasto
total	decimal(12,2)	Importe total del gasto
moneda	string(3)	Moneda del gasto. ISO 4217
motivo	string(100)	Motivo del gasto de movilidad
destino	string(100)	Destino referencial del gasto de movilidad

YES

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/planilla-movilidad[/:planilla_movilidad_id]"
       }
   }
   "id_planillamov": "Identificador de la planilla de movilidad",
   "titulo": "Descripción referencial de la planilla de movilidad",
   "observacion": "Observación registrada por el usuario",
   "total": "Importe total de la planilla de movilidad",
   "moneda": "Moneda de la planilla de movilidad. ISO 4217",
   "fecha_registro": "Fecha de registro de la planilla de movilidad. Formato "dd/mm/yyyy hh24:mi:ss"",
   "id_politica": "Identificador de la política de gasto referencial",
   "id_fondo": "Identificador del fondo referencial de la planilla de movilidad",
   "id_usuario": "Identificador del usuario que registra la planilla de movilidad",
   "estado": "Estado de la planilla de movilidad en la plataforma astral",
   "documentos": [
     {
      "id_gasto": "Identificador del gasto de movilidad",
      "descripcion": "Descripción referencial del gasto",
      "total": "Importe total del gasto",
      "moneda": "Moneda del gasto. ISO 4217",
      "motivo": "Motivo del gasto de movilidad",
      "destino": "Destino referencial del gasto de movilidad"
     }
   ]
}

PATCH /planilla-movilidad[/:planilla_movilidad_id]

Fields

Field

Type

Description

Required

id_planillamov

integer

Identificador de la planilla de movilidad

YES

titulo

string(100)

Descripción referencial de la planilla de movilidad

YES

observacion

string(200)

Observación registrada por el usuario

YES

total

decimal(12,2)

Importe total de la planilla de movilidad

YES

moneda

string(3)

Moneda de la planilla de movilidad. ISO 4217

YES

fecha_registro

string(19)

Fecha de registro de la planilla de movilidad. Formato "dd/mm/yyyy hh24:mi:ss"

YES

id_politica

integer

Identificador de la política de gasto referencial

YES

id_fondo

integer

Identificador del fondo referencial de la planilla de movilidad

YES

id_usuario

integer

Identificador del usuario que registra la planilla de movilidad

YES

estado

string(45)

Estado de la planilla de movilidad en la plataforma astral

YES

documentos

array [objectDocumento]

Contiene los documentos que conforman la planilla de movilidad

La estructura de objectDocumento es:

Field	Type	Description
id_gasto	integer	Identificador del gasto de movilidad
descripcion	string(100)	Descripción referencial del gasto
total	decimal(12,2)	Importe total del gasto
moneda	string(3)	Moneda del gasto. ISO 4217
motivo	string(100)	Motivo del gasto de movilidad
destino	string(100)	Destino referencial del gasto de movilidad

YES

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Content-Type	application/vnd.apirendicion.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

Usuario

Recuperar y manipular usuarios registrados para su empresa

GET /usuario

Permite recuperar una lista paginada de todos los usuarios registrados para su empresa

Son opcionales los parámetros:

page (identifica el número de página)
page_size (identifica la cantidad de registros por página, en caso no se agregue la cantidad por default es de 50)

Ejemplo:

?page=5&page_size=10

Fields

Field	Type	Description	Required
id_usuario	integer	Identificador del usuarion en la plataforma astral	YES
email	string(200)	Correo electrónico del usuario	YES
tipo_identidad	string(50)	Tipo de documento de identidad del usuario	YES
numero_identidad	string(20)	Número de documento identidad del usuario	YES
nombres	string(100)	Nombres del usuario	YES
apellidos	string(100)	Apellidos del usuario	YES
descripcion_cargo	string(100)	Cargo del usuario	YES
fecha_registro		Fecha y hora de registro del usuario	YES
centro_costo	string(100)	Centro de costo del usuario	YES
ot_default	string(100)	Orden de Trabajo por defecto	YES
rol_usuario		Roles del usuario asignados al usuario en la plataforma astral	YES

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/usuario"
       },
       "first": {
           "href": "/usuario?page={page}"
       },
       "prev": {
           "href": "/usuario?page={page}"
       },
       "next": {
           "href": "/usuario?page={page}"
       },
       "last": {
           "href": "/usuario?page={page}"
       }
   }
   "_embedded": {
       "usuario": [
           {
               "_links": {
                   "self": {
                       "href": "/usuario[/:usuario_id]"
                   }
               }
              "id_usuario": "Identificador del usuarion en la plataforma astral",
              "email": "Correo electrónico del usuario",
              "tipo_identidad": "Tipo de documento de identidad del usuario",
              "numero_identidad": "Número de documento identidad del usuario",
              "nombres": "Nombres del usuario",
              "apellidos": "Apellidos del usuario",
              "descripcion_cargo": "Cargo del usuario",
              "fecha_registro": "Fecha y hora de registro del usuario",
              "centro_costo": "Centro de costo del usuario",
              "ot_default": "Orden de Trabajo por defecto",
              "rol_usuario": "Roles del usuario asignados al usuario en la plataforma astral"
           }
       ]
   }
}

GET /usuario[/:usuario_id]

Permite recuperar los datos de un usuario especifico que pertenezca a su empresa

Fields

Field	Type	Description	Required
id_usuario	integer	Identificador del usuarion en la plataforma astral	YES
email	string(200)	Correo electrónico del usuario	YES
tipo_identidad	string(50)	Tipo de documento de identidad del usuario	YES
numero_identidad	string(20)	Número de documento identidad del usuario	YES
nombres	string(100)	Nombres del usuario	YES
apellidos	string(100)	Apellidos del usuario	YES
descripcion_cargo	string(100)	Cargo del usuario	YES
fecha_registro		Fecha y hora de registro del usuario	YES
centro_costo	string(100)	Centro de costo del usuario	YES
ot_default	string(100)	Orden de Trabajo por defecto	YES
rol_usuario		Roles del usuario asignados al usuario en la plataforma astral	YES

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/usuario[/:usuario_id]"
       }
   }
   "id_usuario": "Identificador del usuarion en la plataforma astral",
   "email": "Correo electrónico del usuario",
   "tipo_identidad": "Tipo de documento de identidad del usuario",
   "numero_identidad": "Número de documento identidad del usuario",
   "nombres": "Nombres del usuario",
   "apellidos": "Apellidos del usuario",
   "descripcion_cargo": "Cargo del usuario",
   "fecha_registro": "Fecha y hora de registro del usuario",
   "centro_costo": "Centro de costo del usuario",
   "ot_default": "Orden de Trabajo por defecto",
   "rol_usuario": "Roles del usuario asignados al usuario en la plataforma astral"
}

PATCH /usuario[/:usuario_id]

Actualizar datos de un usuario que se encuentre registrado para su empresa.

Solo esta permito actualizar los datos de centro de costo y ot_default, cualquier otro campo que se quiera enviar no se permitira la actualización.

Fields

Field	Type	Description	Required
id_usuario	integer	Identificador del usuarion en la plataforma astral	YES
email	string(200)	Correo electrónico del usuario	YES
tipo_identidad	string(50)	Tipo de documento de identidad del usuario	YES
numero_identidad	string(20)	Número de documento identidad del usuario	YES
nombres	string(100)	Nombres del usuario	YES
apellidos	string(100)	Apellidos del usuario	YES
descripcion_cargo	string(100)	Cargo del usuario	YES
fecha_registro		Fecha y hora de registro del usuario	YES
centro_costo	string(100)	Centro de costo del usuario	YES
ot_default	string(100)	Orden de Trabajo por defecto	YES
rol_usuario		Roles del usuario asignados al usuario en la plataforma astral	YES

Request

Headers

Header	Value
Accept	application/vnd.apirendicion.v1+json application/hal+json application/json
Content-Type	application/vnd.apirendicion.v1+json application/json
Authorization	HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details)

Body

{ "centro_costo": "Centro de costo del usuario",
  "ot_default": "Orden de Trabajo por defecto" }

Response

Status Codes

406: Not Acceptable
415: Unsupported Media Type
200: OK
404: Not Found
400: Client Error
422: Unprocessable Entity
401: Unauthorized
403: Forbidden

Headers

Header	Value
Content-Type	application/vnd.apirendicion.v1+json application/hal+json application/json
Allow	Comma-separated list of all HTTP methods allowed

Body

{
   "_links": {
       "self": {
           "href": "/usuario[/:usuario_id]"
       }
   }
   "centro_costo": "Centro de costo del usuario",
   "ot_default": "Orden de Trabajo por defecto"
}

Documentation

Apirendicion (v1)

Email

POST /email[/:email_id]

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

Fondo

GET /fondo

Fields

Request

Headers

Response

Status Codes

Headers

Body

GET /fondo[/:fondo_id]

Fields

Request

Headers

Response

Status Codes

Headers

Body

PATCH /fondo[/:fondo_id]

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

Gasto

GET /gasto

Fields

Request

Headers

Response

Status Codes

Headers

Body

GET /gasto[/:gasto_id]

Fields

Request

Headers

Response

Status Codes

Headers

Body

PATCH /gasto[/:gasto_id]

Fields

Request

Headers

Body

Response

Status Codes

Headers

Body

InformeGasto

GET /informe-gasto

Fields

Request

Headers

Response

Status Codes

Headers

Body

GET /informe-gasto[/:informe_gasto_id]

Fields

Request

Headers

Response

Status Codes

Headers