Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleInsertReceptionDocument

Permite ingresar un documento de recepción

Ambientes

Tip

Verbo HTTP: POST

Headers

Tipo

Valor

Requerido

Content-Type

“application/json”

Authorization

Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”

Parámetros

Campo

Descripción

Requerido

providerId

Identificador del proveedor

purchaseOrderNumber

Número de la orden de compra

series

SErie de la orden de compra

No

storageCode

Código de barra

No

line

Número de la línea de detalle

productId

Identificador del producto

quantity

Cantidad

total

Total de la línea

isService

Si es servicio (S o N)

No

Respuesta

De retorno, en caso de haber ingresado el JSON de forma correcta, nos retornara una respuesta de la siguiente manera

Code Block
languagejson
{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "number": "string"
}
Expand
titleGetProviders

Obtiene la información de los proveedores asociados a la empresa

Ambientes

Tip

Verbo HTTP: GET

Headers

Tipo

Valor

Requerido

Content-Type

“application/json”

Authorization

Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”

Parámetros

Campo

Descripción

Requerido

legalCode

Código legal

No

description

Descripción

No

status

Estado

  • 0 = Todos

  • 1 = Activos

  • 2 = Inactivos

itemsPerPage

Registros por página

PageNumber

Número de página

Respuesta

De retorno, en caso de haber ingresado los parámetros de forma correcta, nos retornara una respuesta de la siguiente manera

Code Block
languagejson
{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "providersList": [
    {
      "active": "string",
      "isProvider": "string",
      "lastName1": "string",
      "lastName2": "string",
      "city": "string",
      "client": "string",
      "legalCode": "string",
      "agreedDiscount": 0,
      "address": "string",
      "district": "string",
      "email": "string",
      "sendEmailDTE": "string",
      "state": "string",
      "fax": "string",
      "business": "string",
      "companyID": "string",
      "fileID": "string",
      "localID": "string",
      "coinID": "string",
      "paymentID": "string",
      "productID": "string",
      "rubroId": "string",
      "docTypeID": "string",
      "sellerID": "string",
      "priceList": "string",
      "name": "string",
      "country": "string",
      "poBox": "string",
      "provider": "string",
      "phone": "string",
      "productType": "string",
      "tipRcgoDctoDocVta": "string",
      "usaRcgoDctoDocVta": "string",
      "webSite": "string",
      "zipCode": "string",
      "paymentElectronic": {
        "electronicPayment": "string",
        "homeBank": "string",
        "paymentMethod": "string",
        "destinationBank": 0,
        "savingsAccount": "string"
      }
    }
  ]
}
Expand
titleUpdateState

Permite modificar el estado de una orden de compra

Ambientes

Tip

Verbo HTTP: POST

Headers

Tipo

Valor

Requerido

Content-Type

“application/json”

Authorization

Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”

Parámetros

Campo

Descripción

Requerido

Series

Serie de la OC

No

Number

Número de la OC

Status

Estado

  • 2 = APROBADO

  • 3 = PARCIALMENTE RECEPCIONADO

  • 4 = COMPLETAMENTE RECEPCIONADO

  • 5 = CERRADO

  • 6 = ANULADO

...

Expand
titleInsertLegacyReceptionDocument

Permite ingresar un documento de recepción (solo para servicios LEGACY)

Ambientes

Tip

Verbo HTTP: GETPOST

Headers

Tipo

Valor

Requerido

Content-Type

“application/json”

Authorization

Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”

Parámetros

Campo

Descripción

Requerido

ProviderID

Se define el ID del proveedor

Si

PurchaseOrderNumber

Se define el numero de orden de compra a recepcionar

Si

Serie

Se define la serie, si manejara enviarlo de lo contrario enviarlo en vacio

No

Comment

Se define una glosa del documento general

No

StorageCode

Se define la bodega de origen

Si

ReceptionDate

Se define la fecha de recepcion del documento

Si

Line (Detail)

Se define la linea de detalle

Si

ProductId (Detail)

Se define el codigo de articulo o servicio

Si

Quantity (Detail)

Se define la cantidad de articulos o servicios

Si

Total (Detail)

Se define el total de la linea de detalle

Si

ConceptType (Detail)

Se define el tipo de concepto

Si

IsService (Detail)

Se define si es un servicio

Si

BusinessCenter (Detail)

Se define el centro de negocio configurado para la linea de detalle

Si

Classifier01 (Detail)

Se define el clasificador 1 previamente configurador

No

classifier02 (Detail)

Se define el clasificador 1 previamente configurador

No

Comment (Detail)

Se define la glosa del documento

No

Respuesta

De retorno, en caso de haber ingresado el JSON de forma correcta, nos retornara una respuesta de la siguiente manera

Code Block
languagejson
{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "number": "string"
}
Expand
titleUpdateLegacyReceptionDocument

Permite actualizar un documento de recepción (solo para servicios LEGACY)

Ambientes

Tip

Verbo HTTP: GETPOST

Headers

Tipo

Valor

Requerido

Content-Type

“application/json”

Authorization

Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”

Parámetros

Campo

Descripción

Requerido

ProviderID

Se define el ID del proveedor

Si

PurchaseOrderNumber

Se define el numero de orden de compra a recepcionar

Si

Serie

Se define la serie, si manejara enviarlo de lo contrario enviarlo en vacio

No

Comment

Se define una glosa del documento general

No

StorageCode

Se define la bodega de origen

Si

ReceptionDate

Se define la fecha de recepcion del documento

Si

Line (Detail)

Se define la linea de detalle

Si

ProductId (Detail)

Se define el codigo de articulo o servicio

Si

Quantity (Detail)

Se define la cantidad de articulos o servicios

Si

Total (Detail)

Se define el total de la linea de detalle

Si

ConceptType (Detail)

Se define el tipo de concepto

Si

IsService (Detail)

Se define si es un servicio

Si

BusinessCenter (Detail)

Se define el centro de negocio configurado para la linea de detalle

Si

Classifier01 (Detail)

Se define el clasificador 1 previamente configurador

No

classifier02 (Detail)

Se define el clasificador 1 previamente configurador

No

Comment (Detail)

Se define la glosa del documento

No

Respuesta

De retorno, en caso de haber ingresado el JSON de forma correcta, nos retornara una respuesta de la siguiente manera

Code Block
languagejson
{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "number": "string"
}

...

Expand
titleGetConceptTypeItems

Permite obtener los tipos de conceptos de productos

Ambientes

Tip

Verbo HTTP: GET

Headers

Tipo

Valor

Requerido

Content-Type

“application/json”

Authorization

Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”

Parámetros

Campo

Descripción

Requerido

Concept

Concepto

No

ItemsPerPage

Numero de Items por pagina

Si

PageNumber

Numero de pagina (siempre empezar en 0)

Si

Respuesta

De retorno, en caso de haber ingresado los parámetros de forma correcta, nos retornara una respuesta de la siguiente manera

Code Block
languagejson
{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "totalItems": 0,
  "pageNumber": 0,
  "itemsPerPage": 0,
  "conceptList": [
    {
      "idTipoConcepto": "string",
      "idCuenta": [
    {
      "idTipoConcepto": "string",
      "idCuenta": "string",
      "description": "string"
    }
  ]
}
Expand
titleRelatePurchaseDocument

Permite relacionar un documento de compras con una orden de compra

Ambientes

Tip

Verbo HTTP: POST

Headers

Tipo

Valor

Requerido

Content-Type

“application/json”

Authorization

Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”

Parámetros

Campo

Descripción

Requerido

ProviderId

Se define el ID de proveedor

SI

OcNumber

Se define el numero de orden de compra

Si

OcSerie

Se define la serie

Si

DocumentTypeId (RelateDocuments)

Se define el código del tipo de documento a relacionar

Si

DocumentNumber (RelateDocuments)

Se define el numero de documento a relacionar

Si

Respuesta

De retorno, en caso de haber ingresado el JSON de forma correcta, nos retornara una respuesta de la siguiente manera

Code Block
languagejson
{
  "success": true,
  "message": "string",
   
  "descriptionexceptionMessage": "string"
    }
 
]
}
Expand
titleRelatePurchaseDocumentGetProduct

Permite relacionar un documento de compras con una orden de compraobtener la informacion especifica de un articulo

Ambientes

Tip

Verbo HTTP: POSTGET

Headers

Tipo

Valor

Requerido

Content-Type

“application/json”

Authorization

Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”

Parámetros

Campo

Descripción

Requerido

ProviderId

Se define el ID de proveedor

SI

OcNumber

Se define el numero de orden de compra

Si

OcSerie

Se define la serie

Si

DocumentTypeId (RelateDocuments)

Se define el código del tipo de documento a relacionar

Si

DocumentNumber (RelateDocuments)

Se define el numero de documento a relacionar

Si

Code

Código de articulo o servicio

Si

IsService

Se define si es un servicio o articulo

Si

Respuesta

De retorno, en caso de haber ingresado el JSON de forma correcta, nos retornara una respuesta de la siguiente manera

Code Block
languagejson
{
  "success": true,
  "message": "string",
  "exceptionMessage": "string",
  "product": {
    "usesLotes": true,
    "usesSerial": true,
    "isArticle": true,
    "isService": true,
    "code": "string",
    "name": "string",
    "purchaseCurrencyId": "string",
    "inventoryMeasureUnitId": "string",
    "isActive": true,
    "price": 0
  }
}

INVENTORY

Expand
titleInsertDocument

Permite ingresar un documento de inventario

Ambientes

Tip

Verbo HTTP: POST

Headers

Tipo

Valor

Requerido

Content-Type

“application-json“

Authorization

Token de autenticación del usuario de Integración. Debe ingresarse con el siguiente formato “bearer TOKEN”

Parámetros

Campo

Descripción

Requerido

total

Total del movimiento

gloss

Glosa del movimiento

No

dispatchAddress

Dirección de despacho

correlative

Correlativo del movimiento

order

Orden del movimiento

isNew

Corresponde a un producto nuevo, S o N

counterExistence

Contador de existencia

intType

Tipo de entero

from

Desde

integrate

Integrado

isCentralizable

Corresponde centralizar, S o N

isProgressDisabled

El progreso del movimiento está deshabilitado, S o N

isAutoCentralizable

Si corresponde su centralización automática, S o N

isFromEdit

Si el movimiento es editable, S o N

accountingDefinitionCode

El código de la cuenta contable correspondiente a la definición de centralización

analysis

businessCenter, clasifier1, clasifier2

referenceDocumentFolio

Folio del documento de referencia

No

serial

Serie del documento de referencia

No

userId

Identificador del usuario

No

clientId

Identificador del cliente

companyId

Identificador de la empresa

sessionId

Identificador la sesión

serviceId

Identificador del servicio

fiscalYear

Año fiscal del movimiento

referenceDocumentType

Código del tipo de documento de referencia

documentTypeId

Identificador del tipo de documento

providerId

identificador del proveedor

customerId

Identificador del cliente

originStowageId

Identificador del almacenamiento de origen

destinationStowageId

Identificador del almacenamiento de destino

reasonId

Identificador del motivo

date

Fecha del movimiento

folio

Folio del movimiento

details

lote, loteExpirationDate,

lotes: batchNumber, amount, expirationDate

tasa

Tasa de la moneda del movimiento

coinId

Identificador del código

headerFileId

fileId

comment

attribute1

attribute2

attribute3

attribute4

attribute5

serialPrefix

serialSufix

serialStart

infAnCtaCtble

serials

analysis

{
"businessCenter": "string",
"clasifier1": "string",
"clasifier2": "string",
"file": "string",
"fileFieldName": "string"
}

decimals

factor

count

height

articleId

receivedCount

dispatchedCount

unitaryCount

currentCost

balance

tasaDate

serviceProjectId

summary

analysisInfo

{
"businessCenter": "string",
"clasifier1": "string",
"clasifier2": "string",
"file": "string",
"fileFieldName": "string"
}

workOrderNumber

serieOC

description

price

accountingDefinitionCode

tipoCentDet

destinationLocalization

originLocalization

length

width

orderNumber

properties

Respuesta

Code Block
languagejson
{
  "number": 0,
  "documentType": "string",
  "success": true,
  "message": "string",
  "exceptionMessage": "string"
}

...