- Apipagos Extras
- Apipagos Core
- Contracts
- Documents
- Create
- Get
- Update
- Refunds
- Subscriptions
- Transactions
- Publications
- Users
- Location
- Tenant infoGET
- AFIPGET
Update Single Document
Developing
Testing Env
https://api.test.apipagos.com/api/v2/apipagos
Testing Env
https://api.test.apipagos.com/api/v2/apipagos
PATCH
/documents/{code}
Request
Authorization
Add parameter in header
Company-Token
Example:
Company-Token: ********************Path Params
code
string
required
Example:
8f96a6e2a4ce64e4b0ccfa681d098444
Body Params application/json
document_parent_code
string
optional
currency_code
string
optional
amount
integer
optional
title
string
optional
type_code
string
optional
field_1
string
optional
field_2
string
optional
field_3
string
optional
status_code
integer
optional
date
string
optional
details
object
optional
client_code
string
optional
source_type
string
optional
source
string
optional
field_4
string
optional
field_5
string
optional
field_6
string
optional
field_7
string
optional
field_8
string
optional
field_9
string
optional
field_10
string
optional
json_1
object
optional
json_2
object
optional
json_3
object
optional
payment_instances
array [object {1}]
optional
amount
integer
optional
Example
{
"document_parent_code": "valor_a_verificar",
"currency_code": "USD",
"amount": 100,
"title": "Título del documento",
"type_code": "valor_a_verificar",
"field_1": "campo_1_a_verificar",
"field_2": "campo_2_a_verificar",
"field_3": "campo_3_a_verificar",
"status_code": 1,
"date": "2024-12-27",
"details": {
"client_code": "cliente_123",
"source_type": "url",
"source": "http://ejemplo.com",
"field_4": "valor_del_campo_4",
"field_5": "valor_del_campo_5",
"field_6": "valor_del_campo_6",
"field_7": "valor_del_campo_7",
"field_8": "valor_del_campo_8",
"field_9": "valor_del_campo_9",
"field_10": "valor_del_campo_10",
"json_1": {
"key": "value"
},
"json_2": {
"key": "value"
},
"json_3": {
"key": "value"
}
},
"payment_instances": [
{
"amount": 50
},
{
"amount": 50
}
]
}Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.test.apipagos.com/api/v2/apipagos/documents/8f96a6e2a4ce64e4b0ccfa681d098444' \
--header 'Content-Type: application/json' \
--header 'Company-Token;' \
--data-raw '{
"document_parent_code": "valor_a_verificar",
"currency_code": "USD",
"amount": 100.00,
"title": "Título del documento",
"type_code": "valor_a_verificar",
"field_1": "campo_1_a_verificar",
"field_2": "campo_2_a_verificar",
"field_3": "campo_3_a_verificar",
"status_code": 1,
"date": "2024-12-27",
"details": {
"client_code": "cliente_123",
"source_type": "url",
"source": "http://ejemplo.com",
"field_4": "valor_del_campo_4",
"field_5": "valor_del_campo_5",
"field_6": "valor_del_campo_6",
"field_7": "valor_del_campo_7",
"field_8": "valor_del_campo_8",
"field_9": "valor_del_campo_9",
"field_10": "valor_del_campo_10",
"json_1": {"key": "value"},
"json_2": {"key": "value"},
"json_3": {"key": "value"}
},
"payment_instances": [
{
"amount": 50.00
},
{
"amount": 50.00
}
]
}'Responses
🟢200Success
application/json
Body
id
integer
required
code
string
required
company_id
integer
required
user_id
integer
required
process_id
integer
required
document_parent_id
integer
required
currency_code
string
required
title
string
required
type_code
string
required
field_1
string
required
field_2
string
required
field_3
string
required
amount
string
required
status_code
integer
required
integrity_code
string
required
auditor
string
required
date
string
required
expired_at
string
required
created_at
string
required
updated_at
string
required
deleted_at
string
required
status
object
required
id
integer
required
model_type
string
required
action
string
required
label
string
required
description
string
required
help_id
null
required
code
integer
required
deleted_at
null
required
created_at
string
required
updated_at
string
required
parent_document
string
required
user
object
required
id
integer
required
code
string
required
correlation_id
null
required
company_id
integer
required
process_id
integer
required
type
string
required
email
string
required
first_name
string
required
last_name
string
required
company_name
null
required
field_1
string
required
field_2
string
required
field_3
string
required
profile_photo_url
null
required
birthdate
null
required
birth_country
null
required
birth_country_id
null
required
nationality
null
required
nationality_id
null
required
gender
null
required
marital_status
null
required
status_code
integer
required
integrity_code
string
required
auditor
string
required
deleted_at
null
required
updated_at
string
required
created_at
string
required
email_verified_at
null
required
config_document_type
object
required
id
integer
required
company_id
integer
required
transactions_table_id
integer
required
documents_table_id
integer
required
type_code
string
required
form_id
null
required
title
string
required
description
string
required
documents_source
string
required
transactions_source
string
required
help_id
integer
required
status_code
integer
required
template_id
integer
required
program_type
string
required
auditor
string
required
created_at
string
required
updated_at
string
required
deleted_at
null
required
payment_instances
array[string]
required
life_cycle
array[string]
required
details
array [object {18}]
required
id
integer
optional
client_code
string
optional
document_id
integer
optional
source_type
string
optional
source
string
optional
field_4
string
optional
field_5
string
optional
field_6
string
optional
field_7
string
optional
field_8
string
optional
field_9
string
optional
field_10
string
optional
json_1
object
optional
json_2
string
optional
json_3
string
optional
created_at
string
optional
updated_at
string
optional
deleted_at
string
optional
Example
{
"id": 1835276,
"code": "8f96a6e2a4ce64e4b0ccfa681d098444",
"company_id": 3,
"user_id": 537721,
"process_id": 173038,
"document_parent_id": null,
"currency_code": "ARS",
"title": "Derecho de Adjudicación",
"type_code": "derecho_adjudicacion_licitacion",
"field_1": "006862",
"field_2": "0145",
"field_3": "20163036801",
"amount": "174416.06",
"status_code": 5,
"integrity_code": null,
"auditor": "file_parser",
"date": null,
"expired_at": "2024-01-22 00:00:00",
"created_at": "2024-01-17T20:41:17.000000Z",
"updated_at": "2024-12-27T19:20:30.000000Z",
"deleted_at": null,
"status": {
"id": 75,
"model_type": "documents",
"action": "none",
"label": "No Disponible",
"description": "Documento no disponible",
"help_id": null,
"code": 5,
"deleted_at": null,
"created_at": "2023-10-17T20:40:26.000000Z",
"updated_at": "2023-10-17T20:40:26.000000Z"
},
"parent_document": null,
"user": {
"id": 537721,
"code": "e9aa627bf99261f6911431b77770d804",
"correlation_id": null,
"company_id": 111,
"process_id": 173035,
"type": "f",
"email": "[email protected] ",
"first_name": "GUILLERMO JOSE PRINCIPE ",
"last_name": "",
"company_name": null,
"field_1": "006862",
"field_2": "0145",
"field_3": "20163036801",
"profile_photo_url": null,
"birthdate": null,
"birth_country": null,
"birth_country_id": null,
"nationality": null,
"nationality_id": null,
"gender": null,
"marital_status": null,
"status_code": 1,
"integrity_code": "6f270a2b3d1d295e4ebcec15b2c0cddb",
"auditor": "file_parser",
"deleted_at": null,
"updated_at": "2024-01-17T20:21:25.000000Z",
"created_at": "2024-01-17T20:21:25.000000Z",
"email_verified_at": null
},
"config_document_type": {
"id": 29,
"company_id": 3,
"transactions_table_id": 23,
"documents_table_id": 17,
"type_code": "derecho_adjudicacion_licitacion",
"form_id": null,
"title": "Derecho de Adjudicación / Licitación",
"description": "Adjudicaciones VW",
"documents_source": "database",
"transactions_source": "database",
"help_id": 3,
"status_code": 1,
"template_id": 42,
"program_type": "database",
"auditor": "system",
"created_at": "2023-12-26T14:36:58.000000Z",
"updated_at": "2024-06-27T12:30:02.000000Z",
"deleted_at": null
},
"payment_instances": [],
"life_cycle": [],
"details": [
{
"id": 1441869,
"client_code": "3",
"document_id": 1835276,
"source_type": "url",
"source": " ",
"field_4": "0000000000000000005937278",
"field_5": "0000703317",
"field_6": "000",
"field_7": null,
"field_8": "GUILLERMO JOSE PRINCIPE ",
"field_9": "[email protected] ",
"field_10": "8f96a6e2a4ce64e4b0ccfa681d098444",
"json_1": {
"IVA": " 0,00",
"IDCB": " 0,00",
"OTROS": " 0,00",
"AGENTE": " ",
"TITULAR": "GUILLERMO JOSE PRINCIPE ",
"ADHESION": " 0,00",
"SELLADOS": " 0,00",
"CARGA_ADM": " 0,00",
"DIF_CUOTA": " 0,00",
"INTERESES": " 0,00",
"LOCALIDAD": "RAFAELA ",
"NRO_CUOTA": "000",
"NRO_CUPON": "0000000000000000005937278",
"PROVINCIA": "SANTA CRUZ ",
"SOLICITUD": "0000703317",
"CUOTA_PURA": " 0,00",
"DEBITO_AUT": " ",
"FECHA_ADJU": " ",
"LUGAR_ACTO": " ",
"MESES_PLAN": "084",
"CODIGO_PLAN": "POTV8B",
"DERECHO_ADJ": " 174416,06",
"VALOR_MOVIL": " 14414550,00",
"PERCEPCIONES": "CANCELADO(A) ",
"CODIGO_POSTAL": "F002 ",
"DIA_ACTO_ADJU": " ",
"FECHA_EMISION": "20240111",
"FECHA_ENTREGA": " ",
"FECHA_VALIDEZ": "20240122",
"NRO_ACTO_ADJU": "10",
"CORREO_CLIENTE": "[email protected] ",
"DOMICILIO_PISO": " ",
"IDENT_REGISTRO": "D",
"SEGURO_DE_VIDA": " 0,00",
"TIPO_COBERTURA": " ",
"DOMICILIO_CALLE": "Las Acacias ",
"ESTUDIO_GESTION": " ",
"SEGURO_VEHICULO": " 0,00",
"SITUACION_COBRO": "N",
"CODIGO_BIEN_TIPO": "POLTK ",
"COEFICIENTE_PLAN": "80/20",
"DOMICILIO_BARRIO": " ",
"DOMICILIO_NUMERO": "1480 ",
"VALOR_AMORTIZADO": " 100,0000",
"CANCELACION_TOTAL": " 0,00",
"CANT_CUOTAS_PAGAS": "004",
"DESCRIPCION_MODELO": " ",
"NOMBRE_ASEGURADORA": " ",
"CANT_CUOTAS_IMPAGAS": "000",
"FECHA_LISTA_PRECIOS": "20231219",
"CANT_CUOTAS_A_VENCER": "000",
"CANT_CUOTAS_EMITIDAS": "004",
"DESCUENTO_CUOTA_FIJA": " 0,00",
"SALDO_TOTAL_A_VENCER": " 0,00",
"CANT_CUOTAS_LICITADAS": "000",
"DESCRIPCION_BIEN_TIPO": "POLO TRACK MSI MT ",
"HORA_LIMITE_RECEPCION": "000",
"DOMICILIO_DEPARTAMENTO": " ",
"FECHA_LIMITE_RECEPCION": " ",
"LICITACION_DERECHO_ADJ": " 0,00",
"ALICUOTA_COMPLEMENTARIA": " 0,00",
"CANT_CUOTAS_ANTICIPADAS": "080",
"IMPORTE_CANC_ANTICIPADA": " 0,00",
"PORCENTAJE_AMORTIZACION": " 0,0000",
"CANT_CUOTAS_CANC_ANTICIPADA": "000",
"CODIGO_CONCESIONARIO_ENTREGA": "001407",
"DESCUENTO_RECUPERO_CARGA_ADM": " 0,00",
"DESCUENTO_RECUPERO_CUOTA_RED": " 0,00",
"NOMBRE_CONCESIONARIO_ENTREGA": "MAIPU ",
"CODIGO_CONCESIONARIO_ATENCION": "001407",
"DESCUENTO_RECUPERO_CUOTA_PURA": " 0,00",
"NOMBRE_CONCESIONARIO_ATENCION": "MAIPU ",
"DESCUENTO_RECUPERO_ADH_CAUTELAR": " 0,00",
"DESCUENTO_CARGA_ADM_DIF_IGJ_14/2020": " 0,00",
"DESCUENTO_CUOTA_PURA_DIF_IGJ_14/2020": " 0,00",
"DESCUENTO_RECUPERO_CARGA_ADM_CAUTELAR": " 0,00",
"DESCUENTO_RECUPERO_CUOTA_PURA_CAUTELAR": " 0,00"
},
"json_2": null,
"json_3": null,
"created_at": "2024-01-17T20:41:22.000000Z",
"updated_at": null,
"deleted_at": null
}
]
}🔴500Server Error Response