Page Comparison

...

Expand

title	Login

Obtiene un nuevo token de acceso (crea una nueva sesión de usuario)

Ambientes
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Auth/Login
Productivo	https://api-v2.defontana.com/api/Auth/Login

Tip
Verbo HTTP: GET

Parámetros
Campo	Descripción	Requerido
Client	Identificador del cliente	Si
Company	Identificador de la empresa	Si
User	Identificador del usuario	Si
Password	Contraseña del usuario	Si

De retorno, en caso de haber ingresado los datos de acceso en forma correcta, nos aparecerá un mensaje similar al siguiente. El token de acceso vendrá en el campo “access_token”

Respuesta

Code Block

language	json

{
  "access_token": "eyJ0eXAiOiJLCJh1NiJ9.ey...iZiDAwMzAX0.TR39EE6gtrk",
  "expires_in": 378604799,
  "token_type": "bearer",
  "success": true,
  "message": null
}

De retorno en caso de haber ingresado los datos de acceso en forma incorrecta, nos aparecerá un mensaje similar al siguiente. El mensaje de error vendrá en el campo “message“ como “Login failed“

Respuesta

Code Block

language	json

{
  "access_token": null,
  "expires_in": 0,
  "token_type": null,
  "success": false,
  "message": "Login failed"
}

...

Expand

title	Get

Permite obtener los detalles de un comprobante contable

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Voucher/Get
Productivo	https://api-v2.defontana.com/api/Voucher/Get

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
VoucherType	Código de tipo de comprobante	Si
Number	Numero de comprobante	Si
FiscalYear	Año fiscal del comprobante	Si
Isopening	Se define si es un comprobante contable o de Apertura	No

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "header": {
    "fiscalYear": 0,
    "voucherType": "string",
    "voucherTypeName": "string",
    "isOpening": true,
    "companyId": "string",
    "companyName": "string",
    "number": 0,
    "date": "2023-02-05T20:46:25.396Z",
    "comment": "string",
    "state": "string",
    "entryUser": "string",
    "entryDate": "2023-02-05T20:46:25.396Z",
    "affectedPlan": 0
  },
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "detail": [
    {
      "accountCode": "string",
      "debit": 0,
      "credit": 0,
      "secondaryDebit": 0,
      "secondaryCredit": 0,
      "exchangeRate": 0,
      "comment": "string",
      "fileId": "string",
      "documentType": "string",
      "documentSeries": "string",
      "documentNumber": 0,
      "documentExpirationDate": "2023-02-05T20:46:25.396Z",
      "originDocumentData": "string",
      "bussinessCenterId": "string",
      "classifier1Id": "string",
      "classifier2Id": "string",
      "movementTypeId": "string",
      "movementSeries": "string",
      "movementNumber": "string"
    }
  ]
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	Delete

Permite Eliminar un comprobante contable

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Voucher/Delete
Productivo	https://api-v2.defontana.com/api/Voucher/Delete

Tip
Verbo HTTP: GET

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
VoucherType	Código de tipo de comprobante	Si
Number	Numero de comprobante	Si
FiscalYear	Año fiscal del comprobante	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

Expand

title	Insert

Permite ingresar un comprobante contable

AMBIENTES
Ámbito	URL
Pruebas	https://certapireplapi-v2.defontana.com/api/Voucher/Insert
Productivo	https://api-v2.defontana.com/api/Voucher/Insert

Tip
Verbo HTTP: POST

HEADERS
Tipo	Valor	Requerido
Content-Type	“application / JSON“	Si
Autorización	Token de autorización del usuario de integración, y se debe ingresar con el siguiente formato “Bearer TOKEN“	Si

PARAMETROS
Campo	Descripción	Requerido
(header) fiscalYear	Año fiscal del comprobante	Si
(header) number	Número a asignar al comprobante. Si el campo automaticFoliation se envía como true, será reemplazado automáticamente por el siguiente número a utilizar para el tipo de comprobante ingresado	Si
(header) voucherType	Código del tipo de comprobante a utilizar	Si
(header) date	Fecha de emisión del comprobante	Si
(header) comment	Comentario / glosa del documento	Si
(detail) accountCode	El numero de cuenta contable	Si
(detail) debit	Valor debe en la linea de detalle	Si
(detail) credit	Valor haber en la linea de detalle	Si
(detail) secondaryDebit	Valor debe secundario en caso de ocupar una moneda secundaria	No
(detail) secondaryCredit	Valor haber secundario en caso de ocupar una moneda secundaria	No
(detail) exchangeRate	Tasa de cambio entre los valores principales y de moneda secundaria	No
(detail) comment	Comentario / glosa de la linea de detalle	Si
(detail) fileId	Codigo del cliente “id de ficha” (análisis de ficha)	Depende de análisis
(detail) documentType	El tipo de documento en caso de hacer referencia a una factura o boleta (análisis de documento)	Depende de análisis
(detail) documentSeries	La serie del documento a referenciar (análisis de documento)	Depende de análisis
(detail) documentNumber	El numero de documento a referenciar (análisis de documento)	Depende de análisis
(detail) documentExpirationDate	La fecha de vencimiento del documento a referenciar (análisis de documento)	Depende de análisis
(detail) bussinessCenterId	El centro de negocio (si la cuenta contable esta configurada para usar centros de negocios/costos)	Depende de análisis
(detail) classifier1Id	El tipo de clasificador 1 (Si la cuenta contable esta configurada para usar clasificadores)	Depende de análisis
(detail) classifier2Id	El tipo de clasificador 2 (Si la cuenta contable esta configurada para usar clasificadores)	Depende de análisis
(detail) referenceCurrencyId	El código de moneda de referencia (si corresponde)	No
(detail) referenceExchangeRate	El cambio de moneda de referencia (si corresponde)	No
(detail) movementTypeId	El tipo de movimiento (análisis de banco)	Depende de análisis
(detail) movementSeries	El numero de Serie del movimiento (análisis de banco)	Depende de análisis
(detail) movementNumber	El numero del movimiento (análisis de banco)	Depende de análisis
(detail) accountAmountRate	El monto de movimiento (análisis de banco)	Depende de análisis
(detail) ctaCreditOrDebitAmount	Monto asignado a valor debe o haber de cuenta de banco asociada a cuenta, si corresponde	No
automaticFoliation	Número a asignar al comprobante. Si el campo automaticFoliation se envía como true, será reemplazado automáticamente por el siguiente número a utilizar para el tipo de comprobante ingresado	Si

De retorno, en caso de haber ingresado los datos de forma correcta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "voucherType": "string",
  "number": 0,
  "fiscalYear": 0
}

De retorno en caso de haber ingresado los datos de forma incorrecta, nos aparecerá un mensaje similar al siguiente.

Respuesta

Code Block

language	json

...

Versions Compared

Old Version 13

New Version 14

Key