A3ERP API
English
English
  • Quick Start
    • Initial configuration
    • Installation
  • Versions
  • Documentation
    • API Reference
      • Api
      • Validation
      • Email
      • Master
        • Parameters
      • Document
        • Parameters
      • Various
      • Stock movements
      • Stock Reserves
      • Expeditions
      • Links
      • Stock
      • Portfolio
      • Prices
      • Stored Procedures
      • View
      • Listing
      • FastReport
      • Download Files
      • List Linked Folders
Con tecnología de GitBook
En esta página

¿Te fue útil?

  1. Documentation
  2. API Reference

Master

Access to a3ERP master table data

AnteriorEmailSiguienteParameters

Última actualización hace 2 años

¿Te fue útil?

Parameters

You can consult all the teachers in the link below.

GET calls

Filtering

In the following link you can consult how to filter this call.

POST Call

Discharge Body

Register an item with code 8403

https://servidor:5555/api/maestro/articulos

{
    "codart": "8403",
    "descart": "PORTATIL LENOVO THINKPAD T480",
    "prccompra": "1100",
    "prcventa": "1500"
}

PUT Call

Body of Maintain a master

Modify an item with code 8403

https://servidor:5555/api/maestro/articulos/8403

{
    "prccompra": "1100",
    "prcventa": "1500"
}

DELETE calls

Parameters

Recover all master data

get

It returns the data of the indicated master (Consult parameters to see the available masters).

Example:

https://server:5555/api/maestro/almacenes

Parámetros de ruta
maestrostring · enumRequerido

Teacher to recover

Valores posibles:
Parámetros de encabezado
AuthorizationstringRequerido

Bearer + JWT_token

Respuestas
200
Returns an Array Objects with all data from the master
application/json
get
GET /api/maestro/{maestro} HTTP/1.1
Host: server:<port>
Authorization: text
Accept: */*
200

Returns an Array Objects with all data from the master

{
  "codart": "              1",
  "descart": "ARTICULO REVISAR CONTABILIZACION",
  "afestock": "[F,T]",
  "artpro": "",
  "bloqueado": "[F,T]",
  "cantmin": 0,
  "codalm": "text",
  "descalm": "text",
  "codpro": "text",
  "nompro": "text",
  "esacabado": "[F,T]",
  "escomponente": "[F,T]",
  "escompra": "[F,T]",
  "esventa": "[F,T]",
  "codalt": "text"
}

Retrieve a row from the master

get

Returns the row of the indicated master (Consult parameters to see the available masters).

Example:

https://server:5555/api/maestro/almacenes/50

Parámetros de ruta
maestrostringRequerido

Master to recover

codigostringRequerido

The master code to be retrieved

Parámetros de encabezado
AuthorizationstringRequerido

Bearer + JWT_token

Respuestas
200
Returns the row of the master selected by the identifier
application/json
get
GET /api/maestro/{maestro}/{codigo} HTTP/1.1
Host: server:<port>
Authorization: text
Accept: */*
200

Returns the row of the master selected by the identifier

{
  "codart": "              1",
  "descart": "ARTICULO REVISAR CONTABILIZACION",
  "afestock": "[F,T]",
  "artpro": "",
  "bloqueado": "[F,T]",
  "cantmin": 0,
  "codalm": "text",
  "descalm": "text",
  "codpro": "text",
  "nompro": "text",
  "esacabado": "[F,T]",
  "escomponente": "[F,T]",
  "escompra": "[F,T]",
  "esventa": "[F,T]",
  "codalt": "text"
}

Change the code of a master

get
Parámetros de ruta
maestrostringRequerido

Master to change

actualstringRequerido

The current code

nuevostringRequerido

The new code

Parámetros de encabezado
AuthorizationstringRequerido

Bearer + JWT_token

Respuestas
200
Ok
get
GET /api/maestro/{maestro}/cambiarcodigo/{actual}/{nuevo} HTTP/1.1
Host: server:<port>
Authorization: text
Accept: */*
200

Ok

Sin contenido

Checks if the field exists in the master

get
Parámetros de ruta
maestrostringRequerido

The teacher to check

campostringRequerido

The field to be checked

Parámetros de encabezado
AuthorizationstringRequerido

Bearer + JWT_token

Respuestas
200
Returns exists or does not exist
get
GET /api/maestro/{maestro}/existecampo/{campo} HTTP/1.1
Host: server:<port>
Authorization: text
Accept: */*
200

Returns exists or does not exist

Sin contenido

Duplicate master

get
Parámetros de ruta
maestrostringRequerido

The teacher to duplicate

actualstringRequerido

The master code to be duplicated

nuevostringRequerido

The new duplicate teacher code

paramsstringRequerido

Special options to be duplicated (Stock, Vinculos, Referencias, Idiomas, Escandallo, TarifasV, PreciosEspV, AlarmasV, ComisionesV, DescuentosV, TarifasC, PreciosEspC, AlarmasC, DescuentosC) p.e Stock=True,Idiomas=False,DescuentosC=False

Parámetros de encabezado
AuthorizationstringRequerido

Bearer + JWT_token

Respuestas
200
Duplicate article
get
GET /api/maestro/{maestro}/duplicar/{actual}/{nuevo}/{params} HTTP/1.1
Host: server:<port>
Authorization: text
Accept: */*
200

Duplicate article

Sin contenido

Delete a row from a master

delete

Example:

https://server:5555/api/maestro/almacenes/50

Parámetros de ruta
maestrostringRequerido

Master with the row to be deleted

codigostringRequerido

Code of the master row to be deleted

Parámetros de encabezado
AuthorizationstringRequerido

Bearer + JWT_token

Respuestas
200
Master successfully removed: {master number}
delete
DELETE /api/maestro/{maestro}/{codigo} HTTP/1.1
Host: server:<port>
Authorization: text
Accept: */*
200

Master successfully removed: {master number}

Sin contenido

  • Parameters
  • GET calls
  • Filtering
  • GETRecover all master data
  • GETRetrieve a row from the master
  • GETChange the code of a master
  • GETChecks if the field exists in the master
  • GETDuplicate master
  • POST Call
  • POSTDischarge
  • PUT Call
  • PUTUpdating a master
  • DELETE calls
  • DELETEDelete a row from a master

Discharge

post

This call allows you to register more data for the selected master.

Parámetros de ruta
maestrostringRequerido

Teacher to be added

Parámetros de encabezado
AuthorizationstringRequerido

Bearer + JWT_token

Cuerpo
Respuestas
200
Master correctly inserted: {master number}
application/json
post
POST /api/maestro/{maestro} HTTP/1.1
Host: server:<port>
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 99

{
  "json": {
    "codart": 8403,
    "descart": "PORTATIL LENOVO THINKPAD T480",
    "prccompra": 1100,
    "prcventa": 1500
  }
}
200

Master correctly inserted: {master number}

{
  "Codigo": "{numero de maestro}"
}

Updating a master

put

This call updates the row of the selected master.

Parámetros de ruta
maestrostringRequerido

Master to update

codigostringRequerido

Code of the master to update, In multiple key masters, the code is left blank and the key values are set in the JSON.

Parámetros de encabezado
AuthorizationstringRequerido

Bearer + JWT_token

Cuerpo
Respuestas
200
Master successfully modified: {master number}
put
PUT /api/maestro/{maestro}/{codigo} HTTP/1.1
Host: server:<port>
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "json": {
    "prccompra": "text",
    "prcventa": "text"
  }
}
200

Master successfully modified: {master number}

Sin contenido