¿Cómo autenticarse para consumir estos servicios?
Autenticación con llave secreta
Actualizar estatus de facturación de un documento
| Descripción | Este servicio recibe el estatus de facturación de un documento |
|---|
| Método | PUT |
|---|
| URL | https://homol.uno-internacional.com/sif/v3/empresas/ |
|---|
00000000-0000-1000-0000-000000000001{empresaRefId}/documents/billing/status | Status |
|---|
| subtle | true |
|---|
| colour | Blue |
|---|
| title | Ejemplo |
|---|
|
| Status |
|---|
| subtle | true |
|---|
| colour | Yellow |
|---|
| title | Inactivo |
|---|
|
|
| Parametros en URL | empresaRefId: Es el identificador de la sociedad/empresa en BDC ejemplo: 00000000-0000-1000-0000-000000000001 |
|---|
| Ejemplo |
| Code Block |
|---|
| language | php |
|---|
| title | Ejemplo cURL |
|---|
| collapse | true |
|---|
| curl --location --request PUT 'https://homol.uno-internacional.com/sif/v3/empresas/00000000-0000-1000-0000-000000000001/documents/billing/status' \
--header 'secret: 646fdfd8b1d93' \
--header 'generatorId: SIF_SAP_PRE' \
--header 'Content-Type: application/json' \
--data '{
"reference": "0016921514",
"error": [],
"status": "OK",
"folio": "524826",
"type": "S"
}' |
|
|---|
| Payload |
| Code Block |
|---|
| language | php |
|---|
| title | JSON Schema |
|---|
| collapse | true |
|---|
| {
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"reference": {
"type": "string"
},
"error": {
"type": "object"
},
"status": {
"type": "string"
},
"folio": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"reference",
"status",
"folio",
"type"
]
} |
| Code Block |
|---|
| language | php |
|---|
| title | Ejemplo de Payload - Status OK |
|---|
| collapse | true |
|---|
| {
"reference": "0016921514",
"status": "OK",
"folio": "524826",
"type": "S"
} |
| Code Block |
|---|
| title | Ejemplo Payload - Estatus NOK |
|---|
| collapse | true |
|---|
| {
"reference": "0016921514",
"error": [
"Informar aquí el error que ha impedido generar la factura",
"si son varios errores",
"agregar un ítem adicional en este objeto",
"por cada error",
"siempre respetando el formato JSON"
]
"status": "NOK",
"folio": "524826",
"type": "F"
} |
|
|---|
| Respuestas |
| Code Block |
|---|
| language | php |
|---|
| title | Código - 204 No content |
|---|
| collapse | true |
|---|
| Respuesta correcta, no se devuelve nada más, solo el código 204 |
| Code Block |
|---|
| language | php |
|---|
| title | Código - 401 Unauthorized |
|---|
| collapse | true |
|---|
| {
"error": {
"code": 401,
"message": "Token de autorización inválido."
}
} |
| Code Block |
|---|
| language | php |
|---|
| title | Código - 404 Not found |
|---|
| collapse | true |
|---|
| {
"error": {
"code": 404,
"message": "No se encontro el documento"
}
} |
| Code Block |
|---|
| title | Código - 409 Conflict |
|---|
| collapse | true |
|---|
| {
"error": {
"code": 409,
"message": "El documento ya cuenta con un estatus de facturación correcta"
}
} |
|
|---|