Listar agencias para una empresa
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| offset |
|
||||||
| limit |
|
| Status Code | Description |
|---|---|
| 200 |
|
Crear nueva agencia para una empresa. Se creará también para todas las empresas del grupo.
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| codigo_cliente | string | true | ||
| descripcion | string | true | ||
| codigo_agencia | string | true |
| Status Code | Description |
|---|---|
| 201 |
|
| 400 |
|
Obtener la representación de un cliente particular
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] | |
| codigo_agencia |
| Parameter | Type | Versions | Description |
|---|---|---|---|
| codigo_agencia | * | ||
| codigo_cliente | * | ||
| descripcion | * | ||
| codigo_grupo | * | ||
| codigo_empresa | * |
| Status Code | Description |
|---|---|
| 200 |
|
Genera aplicaciones entre dos o mas documentos
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| codigo_directorio_aplicacion | string | true | ||
| codigo_clasificacion_aplicacion | string | true | ||
| codigo_tipo_documento_aplicacion | string | true | ||
| serie_aplicacion | string | true | ||
| numero_aplicacion | string | true | ||
| valor_total_aplicacion | string | true | ||
| detalle_aplicacion[] | array of objects (AplicacionDocumentoDetalle) | true | ||
| detalle_aplicacion[][codigo_tipo_documento] | string | true | ||
| detalle_aplicacion[][serie] | string | true | ||
| detalle_aplicacion[][numero] | integer | true | ||
| detalle_aplicacion[][valor_aplicado] | string | true |
| Status Code | Description |
|---|---|
| 201 |
|
| 400 |
|
Recibe un JSON con las siguientes llaves: [ { "afecta_cuenta_corriente": "0", "fecha_documento": "", "tipo_documento": "DP", "serie": "AB1", "numero": "18000000001234", "descripcion": "Depósito de prueba", "codigo_clasificacion_directorio": "PROV. LOCALES", "codigo_directorio": "5292585-4", "nombre_directorio": "Aeromexico", "cuenta_caja_bancos": "11020101", "cuenta_abono": "21010101", "monto_total": "777.88" }, { ... } ]
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Status Code | Description |
|---|---|
| 201 |
|
| 400 |
|
Elimina un depósito a partir de su llave de transacción
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | string | ID de la empresa | |
| llave_transaccion | string | Llave de la transacción |
| Parameter | Type | Versions | Description |
|---|---|---|---|
| codigo_grupo | * | ||
| codigo_empresa | * | ||
| codigo_sistema | * | ||
| codigo_tipo_documento | * | ||
| codigo_tipo_documento_base | * | ||
| cuenta_contable_banco | * | ||
| fecha | * | ||
| codigo_clasificacion | * | ||
| codigo_directorio | * | ||
| moneda | * | ||
| detalle | * |
| Status Code | Description |
|---|---|
| 200 |
|
| 404 |
|
Obtiene un depósito a partir de su llave de transacción
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | string | ID de la empresa | |
| llave_transaccion | string | Llave de la transacción |
| Parameter | Type | Versions | Description |
|---|---|---|---|
| codigo_grupo | * | ||
| codigo_empresa | * | ||
| codigo_sistema | * | ||
| codigo_tipo_documento | * | ||
| codigo_tipo_documento_base | * | ||
| cuenta_contable_banco | * | ||
| fecha | * | ||
| codigo_clasificacion | * | ||
| codigo_directorio | * | ||
| moneda | * | ||
| detalle | * |
| Status Code | Description |
|---|---|
| 200 |
|
| 404 |
|
Obtiene un depósito a partir de su llave de transacción
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | string | ID de la empresa | |
| llave_transaccion | string | Llave de la transacción |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| llave_transaccion | string | false |
| Status Code | Description |
|---|---|
| 200 |
|
| 404 |
|
Listar los clientes registrados para la empresa.
Los clientes son los mismos para todas las empresas de un grupo empresarial.
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Name | Information | ||||
|---|---|---|---|---|---|
| offset |
|
||||
| limit |
|
||||
| es_inactivo |
|
||||
| fechaBaja |
|
| Parameter | Type | Versions | Description |
|---|---|---|---|
| codigo_clasificacion | * | ||
| codigo | string | * | Código del cliente (directorio) |
| codigo_grupo | string | * | Código del grupo al que pertenece el cliente |
| razon_social | string | * | Razón social |
| nombre | string | * | Nombre |
| nit | string | * | Número de identificación tributaria |
| codigo_pais | string | * | Código del país en el que está registrado el cliente |
| direccion | string | * | Dirección |
| codigo_postal | string | * | Código postal |
| telefono | string | * | Telefono |
| Status Code | Description |
|---|---|
| 200 |
|
Obtener la representación de un cliente particular.
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] | |
| codigo_cliente | [description] |
| Parameter | Type | Versions | Description |
|---|---|---|---|
| codigo | string | * | |
| codigo_grupo | string | * | |
| razon_social | string | * | |
| nombre | string | * | |
| nit | string | * | |
| codigo_pais | string | * | |
| direccion | string | * | |
| codigo_postal | string | * | |
| telefono | string | * |
| Status Code | Description |
|---|---|
| 200 |
|
Crear o actualizar cliente para una empresa. Se creará también para todas las empresas del grupo.
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] | |
| codigo_cliente |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| razon_social | string | false | ||
| nombre | string | false | ||
| nit | string | false | ||
| codigo_pais | choice | false | {"Afghanistan":"AF","\u00c5land Islands":"AX","Albania":"AL","Algeria":"DZ","American Samoa":"AS","Andorra":"AD","Angola":"AO","Anguilla":"AI","Antarctica":"AQ","Antigua & Barbuda":"AG","Argentina":"AR","Armenia":"AM","Aruba":"AW","Ascension Island":"AC","Australia":"AU","Austria":"AT","Azerbaijan":"AZ","Bahamas":"BS","Bahrain":"BH","Bangladesh":"BD","Barbados":"BB","Belarus":"BY","Belgium":"BE","Belize":"BZ","Benin":"BJ","Bermuda":"BM","Bhutan":"BT","Bolivia":"BO","Bosnia & Herzegovina":"BA","Botswana":"BW","Brazil":"BR","British Indian Ocean Territory":"IO","British Virgin Islands":"VG","Brunei":"BN","Bulgaria":"BG","Burkina Faso":"BF","Burundi":"BI","Cambodia":"KH","Cameroon":"CM","Canada":"CA","Canary Islands":"IC","Cape Verde":"CV","Caribbean Netherlands":"BQ","Cayman Islands":"KY","Central African Republic":"CF","Ceuta & Melilla":"EA","Chad":"TD","Chile":"CL","China":"CN","Christmas Island":"CX","Cocos (Keeling) Islands":"CC","Colombia":"CO","Comoros":"KM","Congo - Brazzaville":"CG","Congo - Kinshasa":"CD","Cook Islands":"CK","Costa Rica":"CR","C\u00f4te d\u2019Ivoire":"CI","Croatia":"HR","Cuba":"CU","Cura\u00e7ao":"CW","Cyprus":"CY","Czech Republic":"CZ","Denmark":"DK","Diego Garcia":"DG","Djibouti":"DJ","Dominica":"DM","Dominican Republic":"DO","Ecuador":"EC","Egypt":"EG","El Salvador":"SV","Equatorial Guinea":"GQ","Eritrea":"ER","Estonia":"EE","Ethiopia":"ET","Falkland Islands":"FK","Faroe Islands":"FO","Fiji":"FJ","Finland":"FI","France":"FR","French Guiana":"GF","French Polynesia":"PF","French Southern Territories":"TF","Gabon":"GA","Gambia":"GM","Georgia":"GE","Germany":"DE","Ghana":"GH","Gibraltar":"GI","Greece":"GR","Greenland":"GL","Grenada":"GD","Guadeloupe":"GP","Guam":"GU","Guatemala":"GT","Guernsey":"GG","Guinea":"GN","Guinea-Bissau":"GW","Guyana":"GY","Haiti":"HT","Honduras":"HN","Hong Kong SAR China":"HK","Hungary":"HU","Iceland":"IS","India":"IN","Indonesia":"ID","Iran":"IR","Iraq":"IQ","Ireland":"IE","Isle of Man":"IM","Israel":"IL","Italy":"IT","Jamaica":"JM","Japan":"JP","Jersey":"JE","Jordan":"JO","Kazakhstan":"KZ","Kenya":"KE","Kiribati":"KI","Kosovo":"XK","Kuwait":"KW","Kyrgyzstan":"KG","Laos":"LA","Latvia":"LV","Lebanon":"LB","Lesotho":"LS","Liberia":"LR","Libya":"LY","Liechtenstein":"LI","Lithuania":"LT","Luxembourg":"LU","Macau SAR China":"MO","Macedonia":"MK","Madagascar":"MG","Malawi":"MW","Malaysia":"MY","Maldives":"MV","Mali":"ML","Malta":"MT","Marshall Islands":"MH","Martinique":"MQ","Mauritania":"MR","Mauritius":"MU","Mayotte":"YT","Mexico":"MX","Micronesia":"FM","Moldova":"MD","Monaco":"MC","Mongolia":"MN","Montenegro":"ME","Montserrat":"MS","Morocco":"MA","Mozambique":"MZ","Myanmar (Burma)":"MM","Namibia":"NA","Nauru":"NR","Nepal":"NP","Netherlands":"NL","New Caledonia":"NC","New Zealand":"NZ","Nicaragua":"NI","Niger":"NE","Nigeria":"NG","Niue":"NU","Norfolk Island":"NF","North Korea":"KP","Northern Mariana Islands":"MP","Norway":"NO","Oman":"OM","Pakistan":"PK","Palau":"PW","Palestinian Territories":"PS","Panama":"PA","Papua New Guinea":"PG","Paraguay":"PY","Peru":"PE","Philippines":"PH","Pitcairn Islands":"PN","Poland":"PL","Portugal":"PT","Puerto Rico":"PR","Qatar":"QA","R\u00e9union":"RE","Romania":"RO","Russia":"RU","Rwanda":"RW","Samoa":"WS","San Marino":"SM","S\u00e3o Tom\u00e9 & Pr\u00edncipe":"ST","Saudi Arabia":"SA","Senegal":"SN","Serbia":"RS","Seychelles":"SC","Sierra Leone":"SL","Singapore":"SG","Sint Maarten":"SX","Slovakia":"SK","Slovenia":"SI","Solomon Islands":"SB","Somalia":"SO","South Africa":"ZA","South Georgia & South Sandwich Islands":"GS","South Korea":"KR","South Sudan":"SS","Spain":"ES","Sri Lanka":"LK","St. Barth\u00e9lemy":"BL","St. Helena":"SH","St. Kitts & Nevis":"KN","St. Lucia":"LC","St. Martin":"MF","St. Pierre & Miquelon":"PM","St. Vincent & Grenadines":"VC","Sudan":"SD","Suriname":"SR","Svalbard & Jan Mayen":"SJ","Swaziland":"SZ","Sweden":"SE","Switzerland":"CH","Syria":"SY","Taiwan":"TW","Tajikistan":"TJ","Tanzania":"TZ","Thailand":"TH","Timor-Leste":"TL","Togo":"TG","Tokelau":"TK","Tonga":"TO","Trinidad & Tobago":"TT","Tristan da Cunha":"TA","Tunisia":"TN","Turkey":"TR","Turkmenistan":"TM","Turks & Caicos Islands":"TC","Tuvalu":"TV","U.S. Outlying Islands":"UM","U.S. Virgin Islands":"VI","Uganda":"UG","Ukraine":"UA","United Arab Emirates":"AE","United Kingdom":"GB","United States":"US","Uruguay":"UY","Uzbekistan":"UZ","Vanuatu":"VU","Vatican City":"VA","Venezuela":"VE","Vietnam":"VN","Wallis & Futuna":"WF","Western Sahara":"EH","Yemen":"YE","Zambia":"ZM","Zimbabwe":"ZW"} | |
| direccion | string | false | ||
| codigo_postal | string | false | ||
| telefono | string | false | ||
| codigo | string | false | ||
| codigo_clasificacion | string | false |
| Status Code | Description |
|---|---|
| 201 |
|
| 400 |
|
Listar los clientes que que afectan a medios y tráfico para una empresa (son los mismos para todo el grupo)
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| offset |
|
||||||
| limit |
|
| Status Code | Description |
|---|---|
| 200 |
|
Crear nuevo cliente para una empresa. Se creará también para todas las empresas del grupo.
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| razon_social | string | true | ||
| nombre | string | true | ||
| nit | string | true | ||
| codigo_pais | choice | true | {"Afghanistan":"AF","\u00c5land Islands":"AX","Albania":"AL","Algeria":"DZ","American Samoa":"AS","Andorra":"AD","Angola":"AO","Anguilla":"AI","Antarctica":"AQ","Antigua & Barbuda":"AG","Argentina":"AR","Armenia":"AM","Aruba":"AW","Ascension Island":"AC","Australia":"AU","Austria":"AT","Azerbaijan":"AZ","Bahamas":"BS","Bahrain":"BH","Bangladesh":"BD","Barbados":"BB","Belarus":"BY","Belgium":"BE","Belize":"BZ","Benin":"BJ","Bermuda":"BM","Bhutan":"BT","Bolivia":"BO","Bosnia & Herzegovina":"BA","Botswana":"BW","Brazil":"BR","British Indian Ocean Territory":"IO","British Virgin Islands":"VG","Brunei":"BN","Bulgaria":"BG","Burkina Faso":"BF","Burundi":"BI","Cambodia":"KH","Cameroon":"CM","Canada":"CA","Canary Islands":"IC","Cape Verde":"CV","Caribbean Netherlands":"BQ","Cayman Islands":"KY","Central African Republic":"CF","Ceuta & Melilla":"EA","Chad":"TD","Chile":"CL","China":"CN","Christmas Island":"CX","Cocos (Keeling) Islands":"CC","Colombia":"CO","Comoros":"KM","Congo - Brazzaville":"CG","Congo - Kinshasa":"CD","Cook Islands":"CK","Costa Rica":"CR","C\u00f4te d\u2019Ivoire":"CI","Croatia":"HR","Cuba":"CU","Cura\u00e7ao":"CW","Cyprus":"CY","Czech Republic":"CZ","Denmark":"DK","Diego Garcia":"DG","Djibouti":"DJ","Dominica":"DM","Dominican Republic":"DO","Ecuador":"EC","Egypt":"EG","El Salvador":"SV","Equatorial Guinea":"GQ","Eritrea":"ER","Estonia":"EE","Ethiopia":"ET","Falkland Islands":"FK","Faroe Islands":"FO","Fiji":"FJ","Finland":"FI","France":"FR","French Guiana":"GF","French Polynesia":"PF","French Southern Territories":"TF","Gabon":"GA","Gambia":"GM","Georgia":"GE","Germany":"DE","Ghana":"GH","Gibraltar":"GI","Greece":"GR","Greenland":"GL","Grenada":"GD","Guadeloupe":"GP","Guam":"GU","Guatemala":"GT","Guernsey":"GG","Guinea":"GN","Guinea-Bissau":"GW","Guyana":"GY","Haiti":"HT","Honduras":"HN","Hong Kong SAR China":"HK","Hungary":"HU","Iceland":"IS","India":"IN","Indonesia":"ID","Iran":"IR","Iraq":"IQ","Ireland":"IE","Isle of Man":"IM","Israel":"IL","Italy":"IT","Jamaica":"JM","Japan":"JP","Jersey":"JE","Jordan":"JO","Kazakhstan":"KZ","Kenya":"KE","Kiribati":"KI","Kosovo":"XK","Kuwait":"KW","Kyrgyzstan":"KG","Laos":"LA","Latvia":"LV","Lebanon":"LB","Lesotho":"LS","Liberia":"LR","Libya":"LY","Liechtenstein":"LI","Lithuania":"LT","Luxembourg":"LU","Macau SAR China":"MO","Macedonia":"MK","Madagascar":"MG","Malawi":"MW","Malaysia":"MY","Maldives":"MV","Mali":"ML","Malta":"MT","Marshall Islands":"MH","Martinique":"MQ","Mauritania":"MR","Mauritius":"MU","Mayotte":"YT","Mexico":"MX","Micronesia":"FM","Moldova":"MD","Monaco":"MC","Mongolia":"MN","Montenegro":"ME","Montserrat":"MS","Morocco":"MA","Mozambique":"MZ","Myanmar (Burma)":"MM","Namibia":"NA","Nauru":"NR","Nepal":"NP","Netherlands":"NL","New Caledonia":"NC","New Zealand":"NZ","Nicaragua":"NI","Niger":"NE","Nigeria":"NG","Niue":"NU","Norfolk Island":"NF","North Korea":"KP","Northern Mariana Islands":"MP","Norway":"NO","Oman":"OM","Pakistan":"PK","Palau":"PW","Palestinian Territories":"PS","Panama":"PA","Papua New Guinea":"PG","Paraguay":"PY","Peru":"PE","Philippines":"PH","Pitcairn Islands":"PN","Poland":"PL","Portugal":"PT","Puerto Rico":"PR","Qatar":"QA","R\u00e9union":"RE","Romania":"RO","Russia":"RU","Rwanda":"RW","Samoa":"WS","San Marino":"SM","S\u00e3o Tom\u00e9 & Pr\u00edncipe":"ST","Saudi Arabia":"SA","Senegal":"SN","Serbia":"RS","Seychelles":"SC","Sierra Leone":"SL","Singapore":"SG","Sint Maarten":"SX","Slovakia":"SK","Slovenia":"SI","Solomon Islands":"SB","Somalia":"SO","South Africa":"ZA","South Georgia & South Sandwich Islands":"GS","South Korea":"KR","South Sudan":"SS","Spain":"ES","Sri Lanka":"LK","St. Barth\u00e9lemy":"BL","St. Helena":"SH","St. Kitts & Nevis":"KN","St. Lucia":"LC","St. Martin":"MF","St. Pierre & Miquelon":"PM","St. Vincent & Grenadines":"VC","Sudan":"SD","Suriname":"SR","Svalbard & Jan Mayen":"SJ","Swaziland":"SZ","Sweden":"SE","Switzerland":"CH","Syria":"SY","Taiwan":"TW","Tajikistan":"TJ","Tanzania":"TZ","Thailand":"TH","Timor-Leste":"TL","Togo":"TG","Tokelau":"TK","Tonga":"TO","Trinidad & Tobago":"TT","Tristan da Cunha":"TA","Tunisia":"TN","Turkey":"TR","Turkmenistan":"TM","Turks & Caicos Islands":"TC","Tuvalu":"TV","U.S. Outlying Islands":"UM","U.S. Virgin Islands":"VI","Uganda":"UG","Ukraine":"UA","United Arab Emirates":"AE","United Kingdom":"GB","United States":"US","Uruguay":"UY","Uzbekistan":"UZ","Vanuatu":"VU","Vatican City":"VA","Venezuela":"VE","Vietnam":"VN","Wallis & Futuna":"WF","Western Sahara":"EH","Yemen":"YE","Zambia":"ZM","Zimbabwe":"ZW"} | |
| direccion | string | false | ||
| codigo_postal | string | false | ||
| telefono | string | false | ||
| codigo | string | true |
| Status Code | Description |
|---|---|
| 201 |
|
| 400 |
|
Obtener la representación de un cliente particular
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] | |
| codigo_cliente | [description] |
| Parameter | Type | Versions | Description |
|---|---|---|---|
| codigo | string | * | |
| codigo_grupo | string | * | |
| razon_social | string | * | |
| nombre | string | * | |
| nit | string | * | |
| codigo_pais | string | * | |
| direccion | string | * | |
| codigo_postal | string | * | |
| telefono | string | * |
| Status Code | Description |
|---|---|
| 200 |
|
Actualizar los datos de un cliente a partir de su representación completa.
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] | |
| codigo_cliente | [description] |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| razon_social | string | false | ||
| nombre | string | false | ||
| nit | string | false | ||
| codigo_pais | choice | false | {"Afghanistan":"AF","\u00c5land Islands":"AX","Albania":"AL","Algeria":"DZ","American Samoa":"AS","Andorra":"AD","Angola":"AO","Anguilla":"AI","Antarctica":"AQ","Antigua & Barbuda":"AG","Argentina":"AR","Armenia":"AM","Aruba":"AW","Ascension Island":"AC","Australia":"AU","Austria":"AT","Azerbaijan":"AZ","Bahamas":"BS","Bahrain":"BH","Bangladesh":"BD","Barbados":"BB","Belarus":"BY","Belgium":"BE","Belize":"BZ","Benin":"BJ","Bermuda":"BM","Bhutan":"BT","Bolivia":"BO","Bosnia & Herzegovina":"BA","Botswana":"BW","Brazil":"BR","British Indian Ocean Territory":"IO","British Virgin Islands":"VG","Brunei":"BN","Bulgaria":"BG","Burkina Faso":"BF","Burundi":"BI","Cambodia":"KH","Cameroon":"CM","Canada":"CA","Canary Islands":"IC","Cape Verde":"CV","Caribbean Netherlands":"BQ","Cayman Islands":"KY","Central African Republic":"CF","Ceuta & Melilla":"EA","Chad":"TD","Chile":"CL","China":"CN","Christmas Island":"CX","Cocos (Keeling) Islands":"CC","Colombia":"CO","Comoros":"KM","Congo - Brazzaville":"CG","Congo - Kinshasa":"CD","Cook Islands":"CK","Costa Rica":"CR","C\u00f4te d\u2019Ivoire":"CI","Croatia":"HR","Cuba":"CU","Cura\u00e7ao":"CW","Cyprus":"CY","Czech Republic":"CZ","Denmark":"DK","Diego Garcia":"DG","Djibouti":"DJ","Dominica":"DM","Dominican Republic":"DO","Ecuador":"EC","Egypt":"EG","El Salvador":"SV","Equatorial Guinea":"GQ","Eritrea":"ER","Estonia":"EE","Ethiopia":"ET","Falkland Islands":"FK","Faroe Islands":"FO","Fiji":"FJ","Finland":"FI","France":"FR","French Guiana":"GF","French Polynesia":"PF","French Southern Territories":"TF","Gabon":"GA","Gambia":"GM","Georgia":"GE","Germany":"DE","Ghana":"GH","Gibraltar":"GI","Greece":"GR","Greenland":"GL","Grenada":"GD","Guadeloupe":"GP","Guam":"GU","Guatemala":"GT","Guernsey":"GG","Guinea":"GN","Guinea-Bissau":"GW","Guyana":"GY","Haiti":"HT","Honduras":"HN","Hong Kong SAR China":"HK","Hungary":"HU","Iceland":"IS","India":"IN","Indonesia":"ID","Iran":"IR","Iraq":"IQ","Ireland":"IE","Isle of Man":"IM","Israel":"IL","Italy":"IT","Jamaica":"JM","Japan":"JP","Jersey":"JE","Jordan":"JO","Kazakhstan":"KZ","Kenya":"KE","Kiribati":"KI","Kosovo":"XK","Kuwait":"KW","Kyrgyzstan":"KG","Laos":"LA","Latvia":"LV","Lebanon":"LB","Lesotho":"LS","Liberia":"LR","Libya":"LY","Liechtenstein":"LI","Lithuania":"LT","Luxembourg":"LU","Macau SAR China":"MO","Macedonia":"MK","Madagascar":"MG","Malawi":"MW","Malaysia":"MY","Maldives":"MV","Mali":"ML","Malta":"MT","Marshall Islands":"MH","Martinique":"MQ","Mauritania":"MR","Mauritius":"MU","Mayotte":"YT","Mexico":"MX","Micronesia":"FM","Moldova":"MD","Monaco":"MC","Mongolia":"MN","Montenegro":"ME","Montserrat":"MS","Morocco":"MA","Mozambique":"MZ","Myanmar (Burma)":"MM","Namibia":"NA","Nauru":"NR","Nepal":"NP","Netherlands":"NL","New Caledonia":"NC","New Zealand":"NZ","Nicaragua":"NI","Niger":"NE","Nigeria":"NG","Niue":"NU","Norfolk Island":"NF","North Korea":"KP","Northern Mariana Islands":"MP","Norway":"NO","Oman":"OM","Pakistan":"PK","Palau":"PW","Palestinian Territories":"PS","Panama":"PA","Papua New Guinea":"PG","Paraguay":"PY","Peru":"PE","Philippines":"PH","Pitcairn Islands":"PN","Poland":"PL","Portugal":"PT","Puerto Rico":"PR","Qatar":"QA","R\u00e9union":"RE","Romania":"RO","Russia":"RU","Rwanda":"RW","Samoa":"WS","San Marino":"SM","S\u00e3o Tom\u00e9 & Pr\u00edncipe":"ST","Saudi Arabia":"SA","Senegal":"SN","Serbia":"RS","Seychelles":"SC","Sierra Leone":"SL","Singapore":"SG","Sint Maarten":"SX","Slovakia":"SK","Slovenia":"SI","Solomon Islands":"SB","Somalia":"SO","South Africa":"ZA","South Georgia & South Sandwich Islands":"GS","South Korea":"KR","South Sudan":"SS","Spain":"ES","Sri Lanka":"LK","St. Barth\u00e9lemy":"BL","St. Helena":"SH","St. Kitts & Nevis":"KN","St. Lucia":"LC","St. Martin":"MF","St. Pierre & Miquelon":"PM","St. Vincent & Grenadines":"VC","Sudan":"SD","Suriname":"SR","Svalbard & Jan Mayen":"SJ","Swaziland":"SZ","Sweden":"SE","Switzerland":"CH","Syria":"SY","Taiwan":"TW","Tajikistan":"TJ","Tanzania":"TZ","Thailand":"TH","Timor-Leste":"TL","Togo":"TG","Tokelau":"TK","Tonga":"TO","Trinidad & Tobago":"TT","Tristan da Cunha":"TA","Tunisia":"TN","Turkey":"TR","Turkmenistan":"TM","Turks & Caicos Islands":"TC","Tuvalu":"TV","U.S. Outlying Islands":"UM","U.S. Virgin Islands":"VI","Uganda":"UG","Ukraine":"UA","United Arab Emirates":"AE","United Kingdom":"GB","United States":"US","Uruguay":"UY","Uzbekistan":"UZ","Vanuatu":"VU","Vatican City":"VA","Venezuela":"VE","Vietnam":"VN","Wallis & Futuna":"WF","Western Sahara":"EH","Yemen":"YE","Zambia":"ZM","Zimbabwe":"ZW"} | |
| direccion | string | false | ||
| codigo_postal | string | false | ||
| telefono | string | false |
| Status Code | Description |
|---|---|
| 204 |
|
| 404 |
|
| 400 |
|
Listar las empresas definidas en el sistema
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| offset |
|
||||||
| limit |
|
| Parameter | Type | Versions | Description |
|---|---|---|---|
| codigo | string | * | Código de la empresa |
| nombre | string | * | Nombre de la empresa |
| razon_social | string | * | Razón social de la empresa |
| codigo_grupo | string | * | Código del grupo empresarial al que pertenece la empresa |
| codigo_pais | string | * | Código del país en donde está registrada la empresa |
| Status Code | Description |
|---|---|
| 200 |
|
Una clasificación representa un tipo de relación entre la empresa y un directorio (por ejemplo cliente nacional, proveedor local, proveedor extranjero, etc.)
Todas las empresas del mismo grupo mostrarán el mismo listado de clasificaciones.
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| offset |
|
||||||
| limit |
|
||||||
| tipo |
|
| Parameter | Type | Versions | Description |
|---|---|---|---|
| codigo | string | * | Código de la clasificación |
| descripcion | string | * | Descripción de la clasificación |
| tipo | string | * | Tipo base de la clasificación |
| Status Code | Description |
|---|---|
| 200 |
|
Listar los paises registrados en el sistema
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| offset |
|
||||||
| limit |
|
| Parameter | Type | Versions | Description |
|---|---|---|---|
| codigo | string | * | Código del país |
| nombre | string | * | Nombre del país |
| codigoIso | string | * | Código ISO del país a dos caracteres |
| Status Code | Description |
|---|---|
| 200 |
|
Listar las peticiones recibidas por el web service.
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| datetime_inicio |
|
||||||
| datetime_fin |
|
||||||
| limit |
|
||||||
| offset |
|
||||||
| endpoint |
|
| Parameter | Type | Versions | Description |
|---|---|---|---|
| id | integer | * | |
| priority | string | * | Constantes de PHP: LOG_ERR, LOG_DEBUG, LOG_INFO |
| type | string | * | Tipo de la petición: self::TIPO_ENTRADA, self::TIPO_SALIDA |
| source_ip | string | * | |
| request_path | string | * | |
| response_code | string | * | |
| created_by | string | * | |
| created_at | DateTime | * | |
| request_content | string | * | |
| response_content | string | * | |
| content_type | string | * |
| Status Code | Description |
|---|---|
| 200 |
|
Lista todos los directorios disponibles para una empresa. Todas las empresas del mismo grupo mostrarán el mismo listado de directorios.
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | string | Código de la empresa |
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| offset |
|
||||||
| limit |
|
| Status Code | Description |
|---|---|
| 200 |
|
Obtiene un directorio a partir del código
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | string | ID de la empresa | |
| codigo | string | Codigo del directorio |
| Parameter | Type | Versions | Description |
|---|---|---|---|
| codigo | string | * | URL safe string |
| codigo_grupo | * | ||
| razon_social | string | * | |
| nombre | * | ||
| nit | string | * | Nit valido o CF |
| codigo_pais | string | * | |
| direccion | string | * | |
| codigo_postal | string | * | |
| telefono | string | * |
| Status Code | Description |
|---|---|
| 200 |
|
| 404 |
|
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| codigo_empresa | string | true | ||
| id_planilla | integer | true | ||
| trasladar_poliza_planilla | string | true | ||
| trasladar_poliza_prestaciones | string | true | ||
| generar_cheques | string | true | ||
| generar_transferencias | string | true | ||
| centros_costo | string | true | ||
| centros_ubicacion | string | true | ||
| departamentos | string | true | ||
| tipo_documento_cheques | string | true | ||
| codigo_clasificacion_directorio_cheques | string | true | ||
| tipo_documento_transferencias | string | true | ||
| codigo_directorio_transferencias | string | true | ||
| codigo_clasificacion_directorio_transferencias | string | true | ||
| fecha_transaccion | datetime | true | yyyy-MM-dd'T'HH:mm:ssZZZZZ |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
| Name | Information | ||||
|---|---|---|---|---|---|
| codigo_empresa |
|
||||
| tipoPlanillaId |
|
||||
| fechaInicio |
|
||||
| fechaFin |
|
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
Crear una nueva factura para una empresa
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| fecha | date | true | yyyy-MM-dd | |
| codigo_tipo_documento | string | true | ||
| serie | string | true | ||
| numero | float | true | ||
| codigo_clasificacion | string | true | ||
| codigo_directorio | string | true | ||
| nombre | string | false | ||
| direccion | string | false | ||
| nit | string | false | ||
| moneda | string | true | ||
| tipo_cambio | string | true | ||
| valor_total_documento | string | true | ||
| valor_total_iva | string | true | ||
| descripcion | string | true | ||
| tipo_iva | string | true | ||
| firma_electronica | string | true | ||
| fecha_hora_firma_electronica | string | false | ||
| numero_documento_exportacion | string | false | ||
| serie_factura | string | false | ||
| numero_factura | string | false | ||
| detalle[] | array of objects (FacturaDetalleCreate) | true | ||
| detalle[][descripcion] | string | true | ||
| detalle[][cantidad] | string | true | ||
| detalle[][valor_iva_linea] | string | true | ||
| detalle[][valor_total_linea] | string | true | ||
| detalle[][codigo_concepto_facturable] | string | true | ||
| detalle[][tipo_operacion] | string | true | ||
| detalle[][centro_costo] | string | true | ||
| detalle[][centro_integracion] | string | true |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
Obtiene la representación de una factura particular
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | |||
| id_factura |
| Parameter | Type | Versions | Description |
|---|---|---|---|
| codigo_empresa | * | ||
| fecha | * | ||
| codigo_tipo_documento | * | ||
| serie | * | ||
| numero | * | ||
| codigo_clasificacion | * | ||
| codigo_directorio | * | ||
| moneda | * | ||
| tipo_cambio | * | ||
| valor_total_documento | * | ||
| descripcion | * | ||
| valor_total_iva | * | ||
| tipo_iva | * | ||
| firma_electronica | * | ||
| id | integer | * | ID interno (transacciones.idtransac) |
| llave_transaccion | string | * | Llave principal |
| Status Code | Description |
|---|---|
| 200 |
|
Crear un documento Invoice
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| fecha | date | true | yyyy-MM-dd | |
| codigo_tipo_documento | string | true | ||
| serie | string | true | ||
| numero | integer | true | ||
| cliente_codigo_clasificacion | string | true | ||
| cliente_codigo_directorio | string | true | ||
| cliente_nombre | string | true | ||
| moneda | string | true | ||
| tipo_cambio | string | true | ||
| valor_total_documento | string | true | ||
| descripcion | string | true | ||
| anulado | string | false | ||
| poliza[] | array of objects (InvoiceBLDetalle) | true | ||
| poliza[][codigo_cuenta] | string | true | ||
| poliza[][proveedor_codigo_clasificacion] | string | true | ||
| poliza[][proveedor_codigo_directorio] | string | true | ||
| poliza[][valor_total_linea] | string | true |
| Status Code | Description |
|---|---|
| 201 |
|
| 400 |
|
Crear una nueva factura para una empresa
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| fecha | date | true | yyyy-MM-dd | |
| codigo_tipo_documento | string | true | ||
| serie | string | true | ||
| numero | float | true | ||
| codigo_clasificacion | string | true | ||
| codigo_directorio | string | true | ||
| nombre | string | false | ||
| direccion | string | false | ||
| nit | string | false | ||
| moneda | string | true | ||
| tipo_cambio | string | true | ||
| valor_total_documento | string | true | ||
| valor_total_iva | string | true | ||
| descripcion | string | true | ||
| tipo_iva | string | true | ||
| firma_electronica | string | true | ||
| fecha_hora_firma_electronica | string | false | ||
| numero_documento_exportacion | string | false | ||
| serie_factura | string | false | ||
| numero_factura | string | false | ||
| detalle[] | array of objects (FacturaDetalleCreate) | true | ||
| detalle[][descripcion] | string | true | ||
| detalle[][cantidad] | string | true | ||
| detalle[][valor_iva_linea] | string | true | ||
| detalle[][valor_total_linea] | string | true | ||
| detalle[][codigo_concepto_facturable] | string | true | ||
| detalle[][tipo_operacion] | string | true | ||
| detalle[][centro_costo] | string | true | ||
| detalle[][centro_integracion] | string | true |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
Obtiene la representación de una nota de crédito
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | |||
| id_nota_credito |
| Parameter | Type | Versions | Description |
|---|---|---|---|
| codigo_empresa | * | ||
| fecha | * | ||
| codigo_tipo_documento | * | ||
| serie | * | ||
| numero | * | ||
| codigo_clasificacion | * | ||
| codigo_directorio | * | ||
| moneda | * | ||
| tipo_cambio | * | ||
| valor_total_documento | * | ||
| descripcion | * | ||
| valor_total_iva | * | ||
| tipo_iva | * | ||
| firma_electronica | * | ||
| id | integer | * | ID interno (transacciones.idtransac) |
| llave_transaccion | string | * | Llave principal |
| Status Code | Description |
|---|---|
| 200 |
|
Obtiene del Web service de Odet un listado de entidades (clientes/proveedores) y crea (o actualiza) la representación respectiva dentro de Sirvo BackOffice.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| debug | \d+ | false | Enable debug mode response |
| Status Code | Description |
|---|---|
| 200 |
|
| 204 |
|
| 400 |
|
Obtiene del Web service de Odet un listado de ordenes para procesarlos y crear la representación respectiva dentro de Sirvo BackOffice.
Opcionalmente recibe el campo
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| debug | \d+ | false | Enable debug mode response |
| Status Code | Description |
|---|---|
| 200 |
|
| 204 |
|
| 400 |
|
Recibe en el cuerpo de la peticion la llave del documento asociado a una orden, y lo envia a Odet para procesamiento. Este documento puede ser una factura o una nota de crédito.
| Status Code | Description |
|---|---|
| 200 |
|
| 204 |
|
| 400 |
|
Recibe en el cuerpo de la peticion la llave de una liquidación asociado a una o varias órdenes, y lo envia a Odet para procesamiento
| Status Code | Description |
|---|---|
| 200 |
|
| 204 |
|
| 400 |
|
Recibe en el cuerpo de la peticion la llave de un pago asociado a una o varias órdenes.
Opcionalmente recibe una bandera de anulación que se utiliza para notificar a Odet de la anulación de uno o varios documentos.
| Status Code | Description |
|---|---|
| 200 |
|
| 204 |
|
| 400 |
|
Obtiene del web service de Odet un listado de presupuestos para procesarlos y crear la representación respectiva dentro de Sirvo BackOffice.
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| debug | \d+ | false | Enable debug mode response |
| Status Code | Description |
|---|---|
| 200 |
|
| 204 |
|
| 400 |
|
Recibe en el cuerpo de la peticion la llave del documento asociado a un presupuesto, y lo envia a Odet para procesamiento. Este documento puede ser una factura o una nota de crédito.
| Status Code | Description |
|---|---|
| 200 |
|
| 204 |
|
| 400 |
|
Recibe en el cuerpo de la peticion la llave de un pago asociado a una o varias facturas de presupuestos de tráfico para envío a Odet.
| Status Code | Description |
|---|---|
| 200 |
|
| 204 |
|
| 400 |
|
Realiza una petición de prueba al WS de errores de Mediamart de acuerdo con la configuración
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| id | true | id | ||
| tipo_proceso | true | Tipo de proceso (MediaMartOrdenCompra) | ||
| descripcion | true | Descripcion |
| Status Code | Description |
|---|---|
| 200 |
|
| 204 |
|
| 400 |
|
Realiza una petición de prueba al WS de errores de Mediamart de acuerdo con la configuración
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| id | true | id | ||
| tipo_proceso | true | Tipo de proceso (Entidades, OrdenCompra, OrdenGastoAgencia, Presupuesto) | ||
| descripcion | true | Descripcion |
| Status Code | Description |
|---|---|
| 200 |
|
| 204 |
|
| 400 |
|
Listar ordenes para una empresa
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| offset |
|
||||||
| limit |
|
| Status Code | Description |
|---|---|
| 200 |
|
Crear una orden
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| id | string | true | ||
| codigo_agencia | string | true | ||
| codigo_presupuesto | string | false | ||
| numero_revision_presupuesto | float | false | ||
| numero_orden | integer | true | ||
| numero_revision_orden | integer | true | ||
| codigo_cliente | string | false | ||
| descripcion | string | false | ||
| observaciones | string | false | ||
| codigo_moneda | string | false | ||
| fecha_elaboracion_orden | datetime | false | yyyy-MM-dd'T'HH:mm:ssZZZZZ | |
| anio_facturacion | integer | true | ||
| mes_facturacion | integer | true | ||
| codigo_marca | string | false | ||
| nombre_marca | string | false | ||
| codigo_producto | string | false | ||
| nombre_producto | string | false | ||
| codigo_proveedor | string | true | ||
| codigo_medio | string | false | ||
| nombre_medio | string | false | ||
| tipo_orden | string | false | ||
| codigo_tipo_presupuesto | string | false | ||
| descripcion_tipo_presupuesto | string | false | ||
| codigo_tipo_medio | string | false | ||
| descripcion_tipo_medio | string | false | ||
| codigo_tipo_submedio | string | false | ||
| descripcion_tipo_submedio | string | false | ||
| tasa_cambio | string | false | ||
| porcentaje_iva | string | false | ||
| porcentaje_timbre_prensa | string | false | ||
| valor_exento | string | false | ||
| valor_comision | string | false | ||
| valor_orden | string | false |
| Status Code | Description |
|---|---|
| 201 |
|
| 400 |
|
Obtener la representación de una orden particular
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] | |
| id_orden | [description] |
| Parameter | Type | Versions | Description |
|---|---|---|---|
| id | * | ||
| codigo_pais | * | ||
| codigo_grupo | * | ||
| codigo_empresa | * | ||
| codigo_agencia | * | ||
| codigo_proveedor | * | ||
| numero_orden | * | ||
| numero_revision_orden | * | ||
| numero_revision_presupuesto | * | ||
| fecha_elaboracion_orden | * | ||
| mes_facturacion | * | ||
| anio_facturacion | * |
| Status Code | Description |
|---|---|
| 200 |
|
Crear la anulacion de una orden
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] | |
| id_orden |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| observaciones | string | true | ||
| fecha_anulacion | datetime | false | yyyy-MM-dd'T'HH:mm:ssZZZZZ |
| Status Code | Description |
|---|---|
| 201 |
|
| 400 |
|
Genera un archivo pdf a partir de varios archivos pdf
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| archivos[] | array of objects (Pdf) | true | ||
| archivos[][archivo] | string | true | ||
| string | false | |||
| subject | string | false | ||
| body | string | false | ||
| nameOfFile | string | false |
| Status Code | Description |
|---|---|
| 200 |
|
| 400 |
|
Listar presupuestos para una empresa
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| offset |
|
||||||
| limit |
|
| Status Code | Description |
|---|---|
| 200 |
|
Crear un presupuesto a partir de su cabecera y detalle
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| id | string | true | ||
| codigo_agencia | string | true | ||
| codigo_cliente | string | true | ||
| codigo_presupuesto | string | true | ||
| numero_revision_presupuesto | integer | true | ||
| codigo_moneda | string | true | ||
| descripcion_presupuesto | string | true | ||
| codigo_marca | string | true | ||
| nombre_marca | string | true | ||
| codigo_producto | string | true | ||
| nombre_producto | string | true | ||
| fecha_traslado_contabilidad | date | false | yyyy-MM-dd | |
| fecha_elaboracion_presupuesto | date | false | yyyy-MM-dd | |
| codigo_tipo_presupuesto | string | true | ||
| descripcion_tipo_presupuesto | string | true | ||
| codigo_tipo_orden | string | false | ||
| descripcion_tipo_orden | string | false | ||
| codigo_tipo_medio | string | false | ||
| descripcion_tipo_medio | string | false | ||
| codigo_tipo_submedio | string | false | ||
| descripcion_tipo_submedio | string | false | ||
| tasa_cambio | float | false | ||
| tipo_prioridad | string | false | ||
| observaciones_presupuesto | string | false | ||
| observaciones_agencia | string | false | ||
| detalle[] | array of objects (PresupuestoDetalle) | true | ||
| detalle[][tipo_registro] | string | true | ||
| detalle[][codigo_detalle] | string | false | ||
| detalle[][codigo_concepto_facturable] | string | true | ||
| detalle[][descripcion_concepto_facturable] | string | true | ||
| detalle[][descripcion] | string | true | ||
| detalle[][tipo_aplicacion_iva] | string | true | ||
| detalle[][tipo_aplicacion_timbre_prensa] | string | true | ||
| detalle[][porcentaje_iva] | float | true | ||
| detalle[][porcentaje_timbre_prensa] | float | true | ||
| detalle[][cantidad] | integer | false | ||
| detalle[][valor_unitario] | float | true | ||
| detalle[][valor_linea] | string | false | ||
| detalle[][valor_comision] | float | true |
| Status Code | Description |
|---|---|
| 201 |
|
| 400 |
|
Obtener la representación de un presupuesto particular
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] | |
| id_presupuesto | [description] |
| Parameter | Type | Versions | Description |
|---|---|---|---|
| id | * | ||
| codigo_pais | * | ||
| codigo_grupo | * | ||
| codigo_empresa | * | ||
| codigo_agencia | * | ||
| codigo_cliente | * | ||
| codigo_presupuesto | * | ||
| numero_revision_presupuesto | * | ||
| codigo_moneda | * | ||
| descripcion_presupuesto | * | ||
| codigo_marca | * | ||
| nombre_marca | * | ||
| codigo_producto | * | ||
| nombre_producto | * | ||
| fecha_traslado_contabilidad | * | ||
| fecha_elaboracion_presupuesto | * | ||
| codigo_tipo_medio | * | ||
| codigo_tipo_submedio | * | ||
| codigo_tipo_presupuesto | * | ||
| descripcion_tipo_presupuesto | * | ||
| tasa_cambio | * |
| Status Code | Description |
|---|---|
| 200 |
|
Elimina un presupuesto (cabecera y detalle) si no tiene documentos asociados.
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] | |
| id_presupuesto |
| Parameter | Type | Versions | Description |
|---|---|---|---|
| id | * | ||
| codigo_pais | * | ||
| codigo_grupo | * | ||
| codigo_empresa | * | ||
| codigo_agencia | * | ||
| codigo_cliente | * | ||
| codigo_presupuesto | * | ||
| numero_revision_presupuesto | * | ||
| codigo_moneda | * | ||
| descripcion_presupuesto | * | ||
| codigo_marca | * | ||
| nombre_marca | * | ||
| codigo_producto | * | ||
| nombre_producto | * | ||
| fecha_traslado_contabilidad | * | ||
| fecha_elaboracion_presupuesto | * | ||
| codigo_tipo_medio | * | ||
| codigo_tipo_submedio | * | ||
| codigo_tipo_presupuesto | * | ||
| descripcion_tipo_presupuesto | * | ||
| tasa_cambio | * |
| Status Code | Description |
|---|---|
| 200 |
|
| 409 |
|
Listar los productos definidas en el sistema para la empresa denotada por $codigo_empresa
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| offset |
|
||||||
| limit |
|
| Status Code | Description |
|---|---|
| 200 |
|
Crear un producto para una empresa
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| codigo_articulo | string | true | ||
| codigo_medida_base | string | true | ||
| existencia_minima | integer | true | ||
| existencia_maxima | integer | true | ||
| descripcion | string | true | ||
| codigo_tipo_articulo | string | true | ||
| punto_reorden | integer | true | ||
| usa_fecha_vencimiento | integer | true |
| Status Code | Description |
|---|---|
| 201 |
|
| 400 |
|
Modificar un producto para una empresa
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | |||
| codigo_producto |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| codigo_articulo | string | false | ||
| codigo_medida_base | string | false | ||
| existencia_minima | integer | false | ||
| existencia_maxima | integer | false | ||
| descripcion | string | false | ||
| codigo_tipo_articulo | string | false | ||
| punto_reorden | integer | false | ||
| usa_fecha_vencimiento | integer | false |
| Status Code | Description |
|---|---|
| 204 |
|
| 400 |
|
Listar los proveedores que que afectan a medios y tráfico para una empresa (son los mismos para todo el grupo)
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Name | Information | ||||||
|---|---|---|---|---|---|---|---|
| offset |
|
||||||
| limit |
|
| Status Code | Description |
|---|---|
| 200 |
|
Crear nuevo proveedor para una empresa. Se creará también para todas las empresas del grupo.
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| razon_social | string | true | ||
| nombre | string | true | ||
| nit | string | true | ||
| codigo_pais | choice | true | {"Afghanistan":"AF","\u00c5land Islands":"AX","Albania":"AL","Algeria":"DZ","American Samoa":"AS","Andorra":"AD","Angola":"AO","Anguilla":"AI","Antarctica":"AQ","Antigua & Barbuda":"AG","Argentina":"AR","Armenia":"AM","Aruba":"AW","Ascension Island":"AC","Australia":"AU","Austria":"AT","Azerbaijan":"AZ","Bahamas":"BS","Bahrain":"BH","Bangladesh":"BD","Barbados":"BB","Belarus":"BY","Belgium":"BE","Belize":"BZ","Benin":"BJ","Bermuda":"BM","Bhutan":"BT","Bolivia":"BO","Bosnia & Herzegovina":"BA","Botswana":"BW","Brazil":"BR","British Indian Ocean Territory":"IO","British Virgin Islands":"VG","Brunei":"BN","Bulgaria":"BG","Burkina Faso":"BF","Burundi":"BI","Cambodia":"KH","Cameroon":"CM","Canada":"CA","Canary Islands":"IC","Cape Verde":"CV","Caribbean Netherlands":"BQ","Cayman Islands":"KY","Central African Republic":"CF","Ceuta & Melilla":"EA","Chad":"TD","Chile":"CL","China":"CN","Christmas Island":"CX","Cocos (Keeling) Islands":"CC","Colombia":"CO","Comoros":"KM","Congo - Brazzaville":"CG","Congo - Kinshasa":"CD","Cook Islands":"CK","Costa Rica":"CR","C\u00f4te d\u2019Ivoire":"CI","Croatia":"HR","Cuba":"CU","Cura\u00e7ao":"CW","Cyprus":"CY","Czech Republic":"CZ","Denmark":"DK","Diego Garcia":"DG","Djibouti":"DJ","Dominica":"DM","Dominican Republic":"DO","Ecuador":"EC","Egypt":"EG","El Salvador":"SV","Equatorial Guinea":"GQ","Eritrea":"ER","Estonia":"EE","Ethiopia":"ET","Falkland Islands":"FK","Faroe Islands":"FO","Fiji":"FJ","Finland":"FI","France":"FR","French Guiana":"GF","French Polynesia":"PF","French Southern Territories":"TF","Gabon":"GA","Gambia":"GM","Georgia":"GE","Germany":"DE","Ghana":"GH","Gibraltar":"GI","Greece":"GR","Greenland":"GL","Grenada":"GD","Guadeloupe":"GP","Guam":"GU","Guatemala":"GT","Guernsey":"GG","Guinea":"GN","Guinea-Bissau":"GW","Guyana":"GY","Haiti":"HT","Honduras":"HN","Hong Kong SAR China":"HK","Hungary":"HU","Iceland":"IS","India":"IN","Indonesia":"ID","Iran":"IR","Iraq":"IQ","Ireland":"IE","Isle of Man":"IM","Israel":"IL","Italy":"IT","Jamaica":"JM","Japan":"JP","Jersey":"JE","Jordan":"JO","Kazakhstan":"KZ","Kenya":"KE","Kiribati":"KI","Kosovo":"XK","Kuwait":"KW","Kyrgyzstan":"KG","Laos":"LA","Latvia":"LV","Lebanon":"LB","Lesotho":"LS","Liberia":"LR","Libya":"LY","Liechtenstein":"LI","Lithuania":"LT","Luxembourg":"LU","Macau SAR China":"MO","Macedonia":"MK","Madagascar":"MG","Malawi":"MW","Malaysia":"MY","Maldives":"MV","Mali":"ML","Malta":"MT","Marshall Islands":"MH","Martinique":"MQ","Mauritania":"MR","Mauritius":"MU","Mayotte":"YT","Mexico":"MX","Micronesia":"FM","Moldova":"MD","Monaco":"MC","Mongolia":"MN","Montenegro":"ME","Montserrat":"MS","Morocco":"MA","Mozambique":"MZ","Myanmar (Burma)":"MM","Namibia":"NA","Nauru":"NR","Nepal":"NP","Netherlands":"NL","New Caledonia":"NC","New Zealand":"NZ","Nicaragua":"NI","Niger":"NE","Nigeria":"NG","Niue":"NU","Norfolk Island":"NF","North Korea":"KP","Northern Mariana Islands":"MP","Norway":"NO","Oman":"OM","Pakistan":"PK","Palau":"PW","Palestinian Territories":"PS","Panama":"PA","Papua New Guinea":"PG","Paraguay":"PY","Peru":"PE","Philippines":"PH","Pitcairn Islands":"PN","Poland":"PL","Portugal":"PT","Puerto Rico":"PR","Qatar":"QA","R\u00e9union":"RE","Romania":"RO","Russia":"RU","Rwanda":"RW","Samoa":"WS","San Marino":"SM","S\u00e3o Tom\u00e9 & Pr\u00edncipe":"ST","Saudi Arabia":"SA","Senegal":"SN","Serbia":"RS","Seychelles":"SC","Sierra Leone":"SL","Singapore":"SG","Sint Maarten":"SX","Slovakia":"SK","Slovenia":"SI","Solomon Islands":"SB","Somalia":"SO","South Africa":"ZA","South Georgia & South Sandwich Islands":"GS","South Korea":"KR","South Sudan":"SS","Spain":"ES","Sri Lanka":"LK","St. Barth\u00e9lemy":"BL","St. Helena":"SH","St. Kitts & Nevis":"KN","St. Lucia":"LC","St. Martin":"MF","St. Pierre & Miquelon":"PM","St. Vincent & Grenadines":"VC","Sudan":"SD","Suriname":"SR","Svalbard & Jan Mayen":"SJ","Swaziland":"SZ","Sweden":"SE","Switzerland":"CH","Syria":"SY","Taiwan":"TW","Tajikistan":"TJ","Tanzania":"TZ","Thailand":"TH","Timor-Leste":"TL","Togo":"TG","Tokelau":"TK","Tonga":"TO","Trinidad & Tobago":"TT","Tristan da Cunha":"TA","Tunisia":"TN","Turkey":"TR","Turkmenistan":"TM","Turks & Caicos Islands":"TC","Tuvalu":"TV","U.S. Outlying Islands":"UM","U.S. Virgin Islands":"VI","Uganda":"UG","Ukraine":"UA","United Arab Emirates":"AE","United Kingdom":"GB","United States":"US","Uruguay":"UY","Uzbekistan":"UZ","Vanuatu":"VU","Vatican City":"VA","Venezuela":"VE","Vietnam":"VN","Wallis & Futuna":"WF","Western Sahara":"EH","Yemen":"YE","Zambia":"ZM","Zimbabwe":"ZW"} | |
| direccion | string | false | ||
| codigo_postal | string | false | ||
| telefono | string | false | ||
| codigo | string | true |
| Status Code | Description |
|---|---|
| 201 |
|
| 400 |
|
Obtener la representación de un proveedor particular
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] | |
| codigo_proveedor | [description] |
| Parameter | Type | Versions | Description |
|---|---|---|---|
| codigo | string | * | |
| codigo_grupo | string | * | |
| razon_social | string | * | |
| nombre | string | * | |
| nit | string | * | |
| codigo_pais | string | * | |
| direccion | string | * | |
| codigo_postal | string | * | |
| telefono | string | * |
| Status Code | Description |
|---|---|
| 200 |
|
Actualizar los datos de un proveedor a partir de su representación completa.
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa | Empresa | [description] | |
| codigo_proveedor | [description] |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| razon_social | string | false | ||
| nombre | string | false | ||
| nit | string | false | ||
| codigo_pais | choice | false | {"Afghanistan":"AF","\u00c5land Islands":"AX","Albania":"AL","Algeria":"DZ","American Samoa":"AS","Andorra":"AD","Angola":"AO","Anguilla":"AI","Antarctica":"AQ","Antigua & Barbuda":"AG","Argentina":"AR","Armenia":"AM","Aruba":"AW","Ascension Island":"AC","Australia":"AU","Austria":"AT","Azerbaijan":"AZ","Bahamas":"BS","Bahrain":"BH","Bangladesh":"BD","Barbados":"BB","Belarus":"BY","Belgium":"BE","Belize":"BZ","Benin":"BJ","Bermuda":"BM","Bhutan":"BT","Bolivia":"BO","Bosnia & Herzegovina":"BA","Botswana":"BW","Brazil":"BR","British Indian Ocean Territory":"IO","British Virgin Islands":"VG","Brunei":"BN","Bulgaria":"BG","Burkina Faso":"BF","Burundi":"BI","Cambodia":"KH","Cameroon":"CM","Canada":"CA","Canary Islands":"IC","Cape Verde":"CV","Caribbean Netherlands":"BQ","Cayman Islands":"KY","Central African Republic":"CF","Ceuta & Melilla":"EA","Chad":"TD","Chile":"CL","China":"CN","Christmas Island":"CX","Cocos (Keeling) Islands":"CC","Colombia":"CO","Comoros":"KM","Congo - Brazzaville":"CG","Congo - Kinshasa":"CD","Cook Islands":"CK","Costa Rica":"CR","C\u00f4te d\u2019Ivoire":"CI","Croatia":"HR","Cuba":"CU","Cura\u00e7ao":"CW","Cyprus":"CY","Czech Republic":"CZ","Denmark":"DK","Diego Garcia":"DG","Djibouti":"DJ","Dominica":"DM","Dominican Republic":"DO","Ecuador":"EC","Egypt":"EG","El Salvador":"SV","Equatorial Guinea":"GQ","Eritrea":"ER","Estonia":"EE","Ethiopia":"ET","Falkland Islands":"FK","Faroe Islands":"FO","Fiji":"FJ","Finland":"FI","France":"FR","French Guiana":"GF","French Polynesia":"PF","French Southern Territories":"TF","Gabon":"GA","Gambia":"GM","Georgia":"GE","Germany":"DE","Ghana":"GH","Gibraltar":"GI","Greece":"GR","Greenland":"GL","Grenada":"GD","Guadeloupe":"GP","Guam":"GU","Guatemala":"GT","Guernsey":"GG","Guinea":"GN","Guinea-Bissau":"GW","Guyana":"GY","Haiti":"HT","Honduras":"HN","Hong Kong SAR China":"HK","Hungary":"HU","Iceland":"IS","India":"IN","Indonesia":"ID","Iran":"IR","Iraq":"IQ","Ireland":"IE","Isle of Man":"IM","Israel":"IL","Italy":"IT","Jamaica":"JM","Japan":"JP","Jersey":"JE","Jordan":"JO","Kazakhstan":"KZ","Kenya":"KE","Kiribati":"KI","Kosovo":"XK","Kuwait":"KW","Kyrgyzstan":"KG","Laos":"LA","Latvia":"LV","Lebanon":"LB","Lesotho":"LS","Liberia":"LR","Libya":"LY","Liechtenstein":"LI","Lithuania":"LT","Luxembourg":"LU","Macau SAR China":"MO","Macedonia":"MK","Madagascar":"MG","Malawi":"MW","Malaysia":"MY","Maldives":"MV","Mali":"ML","Malta":"MT","Marshall Islands":"MH","Martinique":"MQ","Mauritania":"MR","Mauritius":"MU","Mayotte":"YT","Mexico":"MX","Micronesia":"FM","Moldova":"MD","Monaco":"MC","Mongolia":"MN","Montenegro":"ME","Montserrat":"MS","Morocco":"MA","Mozambique":"MZ","Myanmar (Burma)":"MM","Namibia":"NA","Nauru":"NR","Nepal":"NP","Netherlands":"NL","New Caledonia":"NC","New Zealand":"NZ","Nicaragua":"NI","Niger":"NE","Nigeria":"NG","Niue":"NU","Norfolk Island":"NF","North Korea":"KP","Northern Mariana Islands":"MP","Norway":"NO","Oman":"OM","Pakistan":"PK","Palau":"PW","Palestinian Territories":"PS","Panama":"PA","Papua New Guinea":"PG","Paraguay":"PY","Peru":"PE","Philippines":"PH","Pitcairn Islands":"PN","Poland":"PL","Portugal":"PT","Puerto Rico":"PR","Qatar":"QA","R\u00e9union":"RE","Romania":"RO","Russia":"RU","Rwanda":"RW","Samoa":"WS","San Marino":"SM","S\u00e3o Tom\u00e9 & Pr\u00edncipe":"ST","Saudi Arabia":"SA","Senegal":"SN","Serbia":"RS","Seychelles":"SC","Sierra Leone":"SL","Singapore":"SG","Sint Maarten":"SX","Slovakia":"SK","Slovenia":"SI","Solomon Islands":"SB","Somalia":"SO","South Africa":"ZA","South Georgia & South Sandwich Islands":"GS","South Korea":"KR","South Sudan":"SS","Spain":"ES","Sri Lanka":"LK","St. Barth\u00e9lemy":"BL","St. Helena":"SH","St. Kitts & Nevis":"KN","St. Lucia":"LC","St. Martin":"MF","St. Pierre & Miquelon":"PM","St. Vincent & Grenadines":"VC","Sudan":"SD","Suriname":"SR","Svalbard & Jan Mayen":"SJ","Swaziland":"SZ","Sweden":"SE","Switzerland":"CH","Syria":"SY","Taiwan":"TW","Tajikistan":"TJ","Tanzania":"TZ","Thailand":"TH","Timor-Leste":"TL","Togo":"TG","Tokelau":"TK","Tonga":"TO","Trinidad & Tobago":"TT","Tristan da Cunha":"TA","Tunisia":"TN","Turkey":"TR","Turkmenistan":"TM","Turks & Caicos Islands":"TC","Tuvalu":"TV","U.S. Outlying Islands":"UM","U.S. Virgin Islands":"VI","Uganda":"UG","Ukraine":"UA","United Arab Emirates":"AE","United Kingdom":"GB","United States":"US","Uruguay":"UY","Uzbekistan":"UZ","Vanuatu":"VU","Vatican City":"VA","Venezuela":"VE","Vietnam":"VN","Wallis & Futuna":"WF","Western Sahara":"EH","Yemen":"YE","Zambia":"ZM","Zimbabwe":"ZW"} | |
| direccion | string | false | ||
| codigo_postal | string | false | ||
| telefono | string | false |
| Status Code | Description |
|---|---|
| 204 |
|
| 404 |
|
| 400 |
|
Elimina un recibo para una empresa.
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| numero_cuenta_banco | string | true | ||
| codigo_tipo_documento | string | true | ||
| serie | string | true | ||
| numero | float | true |
| Status Code | Description |
|---|---|
| 204 |
|
Crear un documento Invoice
| Name | Requirement | Type | Description |
|---|---|---|---|
| codigo_empresa |
| Parameter | Type | Required? | Format | Description |
|---|---|---|---|---|
| fecha | date | true | yyyy-MM-dd | |
| codigo_tipo_documento | string | true | ||
| serie | string | true | ||
| numero | integer | true | ||
| cliente_codigo_clasificacion | string | true | ||
| cliente_codigo_directorio | string | true | ||
| cliente_nombre | string | true | ||
| moneda | string | true | ||
| tipo_cambio | string | true | ||
| valor_total_documento | string | true | ||
| descripcion | string | true | ||
| anulado | string | false | ||
| poliza[] | array of objects (InvoiceBLDetalle) | true | ||
| poliza[][codigo_cuenta] | string | true | ||
| poliza[][proveedor_codigo_clasificacion] | string | true | ||
| poliza[][proveedor_codigo_directorio] | string | true | ||
| poliza[][valor_total_linea] | string | true |
| Status Code | Description |
|---|---|
| 201 |
|
| 400 |
|
Documentation auto-generated on Sun, 06 Oct 24 05:08:00 -0600