Versiones comparadas

Clave

  • Se ha añadido esta línea.
  • Se ha eliminado esta línea.
  • El formato se ha cambiado.

Los terceros, son los exportadores/proveedores/compradores que se deben agregan al encabezado del formulario como dato obligatorio para crear un documento. Se puede consultar todos los terceros creados hasta el momento mediante el método getThirdParties

Parámetro

Valor

Nombre servicio

createThirdParty

getThirdParties

Tipo método

POST

URL

https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/

thirdParty/createThirdParty

getThirdParties

Content type

application/json

POST/createThirdPartyParámetro de búsqueda

Parámetro

Tipo

Longitud

Obligatorio

Descripción

nit

string

20

Si

Código asignado para la identificación del contribuyente.

internal_code

string

80

Si

Código interno con que se identifica el tercero

business_name

string

80

Si

Razón social del tercero

type

String

15

Si

Indica si el proveedor es Nacional o extranjero

qualifiedUser_id

integer

Si

Identificación interna del usuario calificado

address

string

150

No

Dirección del tercero

phone

string

80

No

Teléfono del tercero

acronym

string

80

No

Siglas con que se identifica el tercero

alias

string

80

No

Seudónimo con que identifica el tercero

Importante: El servicio está requiriendo la identificación interna del usuario, el cual en el caso de portozual sería el 214.

Ejemplo:

Cuerpo de la petición

{
"nit": "800149695",
"internal_code": "1234",
"business_name": "DROG Y FARMACIAS CRUZ VERDE",
"type": "Nacional",
"qualifiedUser_id": 214

}

Respuesta:

{
"status": {
"code": 200,
"message": "Procesado con éxito",
"data": {
"id": 299,
"qualifiedUser_id": 214,
"nit": "800149695",
"type": "Nacional",
"internal_code": "1234",
"business_name": "DROG Y FARMACIAS CRUZ VERDE",
"address": null,
"phone": null,
"acronym": null,
"alias": null
}
}
}

5.1 Actualizar terceros

...

Parámetro

...

Valor

...

Nombre servicio

...

updateThirdParty

...

Tipo método

...

POST

...

URL

...

https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/thirdParty/updateThirdParty

...

Content type

...

application/json

POST/updateThirdParty

...

Parámetro

...

Tipo

...

Longitud

...

Obligatorio

...

Descripción

...

id

...

integer

...

Si

...

id interno del tercero

...

nit

...

string

...

20

...

No

...

Código asignado para la identificación del contribuyente.

...

internal_code

...

string

...

80

...

No

...

Código interno con que se identifica el tercero

...

business_name

...

string

...

80

...

No

...

Razón social del tercero

...

type

...

String

...

15

...

No

...

Indica si el proveedor es Nacional o extranjero

...

qualifiedUser_id

...

integer

...

No

...

Identificación interna del usuario calificado

...

address

...

string

...

150

...

No

...

Dirección del tercero

...

phone

...

string

...

80

...

No

...

Teléfono del tercero

...

acronym

...

string

...

80

...

No

...

Siglas con que se identifica el tercero

...

alias

...

string

...

80

...

No

...

Seudónimo con que identifica el tercero

Para consultar el id interno del tercero, se debe consultar el servicio de getThirdParties

Ejemplo:

Cuerpo de la petición

{
"id": 299,
"alias": "CRUZ VERDE"
}

Respuesta:

{
"status": {
"code": 200,
"message": "Procesado con éxito",
"data": {
"id": 299,
"qualifiedUser_id": 214,
"nit": "800149695",
"type": "Nacional",
"internal_code": "1234",
"business_name": "DROG Y FARMACIAS CRUZ VERDE",
"address": null,
"phone": null,
"acronym": null,
"alias": "CRUZ VERDE"
}
}
}

5.2. Consultar terceros

Se puede consultar todos los productos creados hasta el momento mediante el método getThirdParties

...

Parámetro

...

Valor

...

Nombre servicio

...

getThirdParties

...

Tipo método

...

GET

...

URL

...

https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/getThirdParties

...

Content type

...

application/json

GET/getThirdParties

search

Parámetro de búsqueda, se puede buscar por numero de identificación, nombre de tercero, código interno, alias, acrónimo, teléfono.

POST/getThirdParties

Respuesta:

{
"status": {
"code": 200,
"message": "Procesado con éxito",
"data": {
"current_page": 1,
"data": [
{
"id": 299,
"qualifiedUser_id": 214,
"nitidentification_num": "800149695",
"identificationType_id": 37,
"type": "Nacional",
"internal_code": "1234",
"business_name": "DROG Y FARMACIAS CRUZ VERDE",
"address": null,
"phone": null,
"acronym": null,
"alias": "CRUZ VERDE"
}
],
"first_page_url": "https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/thirdParty/getThirdParties?page=1%22,
"from": 1,
"last_page": 1,
"last_page_url": "https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/thirdParty/getThirdParties?page=1%22,
"links": [
{
"url": null,
"label": "« Anterior",
"active": false
},
{
"url": "https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/thirdParty/getThirdParties?page=1%22,
"label": "1",
"active": true
},
{
"url": null,
"label": "Siguiente »",
"active": false
}
],
"next_page_url": null,
"path": "https://gorgeous-dust-0seusmuxapkp.vapor-farm-b1.com/api/auth/thirdParty/getThirdParties%22,
"per_page": 10,
"prev_page_url": null,
"to": 1,
"total": 1
}
}

}