Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

¿Cómo autenticarse para consumir estos servicios?

Autenticación con llave secreta

Actualizar estatus de facturación de un documento

DescripciónEste servicio recibe el estatus de facturación de un documento
MétodoPUT
URL

Ambiente QA/PRE 

Status
subtletrue
colourGreen
titleACTIVO

https://

homol

sif-pre.uno-internacional.com/mcs/sif

/v3

/empresas/

00000000-0000-1000-0000-000000000001

{empresaRefId}/documents/billing/status


Ambiente PRODUCCIÓN 

Status
subtletrue
colour

Blue

Green
title

Ejemplo  StatussubtletruecolourYellowtitleInactivo

ACTIVO

https://sif.uno-internacional.com/mcs/sif/empresas/{empresaRefId}/documents/billing/status

Parametros en URL

empresaRefId: Es el identificador de la sociedad/empresa en BDC

ejemplo: 00000000-0000-1000-0000-000000000001

Ejemplo


Code Block
languagephp
titleEjemplo cURL
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": [],
	"errorDatosFiscales: false,
	"status": "OK",
	"folio": "524826",
	"type": "S",
	"pedidoga": "23117640210000056300",
	"pdf": "",
	"xml": "",
	"datosFiscales": {
    	"rfc": "",
    	"usoCfdi": "",
    	"regimenFiscal": "",
    	"codigoPostal": ""
  }
}'


Payload


Code Block
languagephp
titleJSON Schema
collapsetrue
{
  
"$schema": "http://json-schema.org/draft-
04
07/schema#",
  
"type": "object",
  "description": "",
  
"properties": {
    
"reference": {
      "type": "string",
	  "description": "Identificador del pago en BDC"
    },
    "error": {
      "type": "array"
	  "description": "Contiene el o los errores ocurridos durante el intento de timbrado por parte de Rupture, cada error debe ser un elemento dentro del array"
    },
	"errorDatosFiscales": {
      "type": "number"
	  "description": "Indica si ha existido un error relacionado a los datos fiscales, solo puede aceptar el valor 1 cuando hubo un error relacionado a datos fiscales y el valor 0 cuando ha ocurrido un error no relacionado a datos fiscales o cuando no ha habido errores"
    },
    "status": {
      "type": "string",
	  "description": "Indica si el timbrado fue correcto o no, solo acepta 2 valores: OK y NOK"
    },
    "folio": {
      "type": "string",
	  "description": "Identificador en formato UUID de la Factura"
    },
    "type": {
      "type": "string",
	  "description": "Se acordó que siempre debe venir informado con el valor: S"
    },
    "pedidoga": {
      "type": 
"object" }, "status": { "
"string",
	  "description": "Folio de la factura del lado de Rupture"
    },
	"pdf": {
      "type": "string",
	  "description": "Se debe informar solo en caso de un timbrado correcto, es la Factura en formato PDF codificado en base64"
    },
	"xml": {
      "type": "string",
	  "description": "Se debe informar solo en caso de un timbrado correcto, es la Factura en formato XML codificado en base64"
    },
    "datosFiscales": {
      "type": "object",
 	  "description": "Contiene los datos del pagador utilizados en una Factura que fue timbrada correctamente",
      "properties": {
        "rfc": {
          "type": "string",
     	  "description": "RFC de la Factura"
        },
        "usoCfdi": {
          "type": "string",
	      "description": "Clave correspondiente al Uso de CFDI utilizado en la Factura"
        },
        "regimenFiscal": {
          "type": "string",
		  "description": "Clave correspondiente al Régimen Fiscal utilizado en la Factura"
        },
        "codigoPostal": {
          "type": "string",
		  "description": "Codigo Postal utilizado en la Factura"
        }
      },
      "required": [
        "rfc",
        "usoCfdi",
        "regimenFiscal",
        "codigoPostal"
      ]
    }
  },
  "required": [
    "reference",
    "status",
    "folio
": { "
",
    "type"
  ]
}


Code Block
languagephp
titleEjemplo de Payload - Status OK
{
	"reference": "0016921514",
	"status": "OK",
	"folio": "1044D724-23CB-43A2-9AA7-C08B73FF4381",
	"type": "
string
S",
	
}, "type
"pedidoga": "123435",
	"pdf": "Factura en formato PDF codificado en base64",
	"xml": "Factura en formato XML codificado en base64",
	"datosFiscales": {
    	"rfc": "RARA760229C54",
    	"usoCfdi": "G03",
    	"
type
regimenFiscal": "
string
612",
    	"codigoPostal": "21200"
  	}
}
}


Code Block
titleEjemplo Payload - Estatus NOK
{
	"reference": "0016921514",
	"
required
error": [
		"
reference
Informar aquí el error que ha impedido generar la factura",
		"si son varios errores",
		"
status
agregar un ítem adicional en este objeto",
		"
folio
por cada error",
		"
type
siempre respetando el formato JSON"
	],
	"errorDatosFiscales": 1,
	"status": "NOK", 
	"folio": "1044D724-23CB-43A2-9AA7-C08B73FF4381", 
	"type": "F"
}


Respuestas


Code Block
languagephp
title
Ejemplo de Payloadcollapsetrue
Código - 204 No content
Respuesta correcta, no se devuelve nada más, solo el código 204


Code Block
languagephp
titleCódigo - 401 Unauthorized
{
	"
reference
error": {
		"
0016921514
code": 401,
		"message": "Token de autorización inválido."
	}
}


Code Block
languagephp
titleCódigo - 404 Not found
{
	"error": {
}

		"code": 404,
		"
status
message": "
OK",
No se encontro el documento"
	}
}


Code Block
titleCódigo - 409 Conflict
{
	"
folio
error": {
		"
524826
code": 409,
		"
type
message": "El documento ya cuenta con un estatus de facturación correcta"
	}
Respuesta

}