API: POST /invoices

Envía los datos de facturación relacionados a una Orden de Reparación.

POST

/invoices

Al llamado de este recurso se deben agregar los datos de facturación relacionados a una Orden de Reparación al sistema de facturación externo.

Parámetros

organizationId

REQUERIDO

(header)

Identificador único de la agencia, taller o inventario de la cual se quiere obtener la información.

Cuerpo de solicitud

Formato del cuerpo que se debe enviar para agregar los datos de facturación relacionados a una Orden de Reparación.

Ejemplo
Esquema

				
					{
  "orderNumber": "123",
  "date": "2021-10-18",
  "comments": "Cliente pagó de contado.",
  "email": "pedro.modo@gmail.com",
  "phoneNumber": "3364971852",
  "vin": "QWERTY123456ABCDE",
  "invoiceParameters": {
    "metodo_de_pago": "PUE",
    "forma_de_pago": "01",
    "uso_cfdi": "G03"
  },
  "items": [
    {
      "quantity": 2,
      "unitPrice": 14.59,
      "itemId": "XYZ987",
      "warehouseId": "DBR1",
      "satus": "Approved"
    },
    {
      "quantity": "5:00",
      "unitPrice": 24.5,
      "itemId": "ABC123",
      "warehouseId": "DBR1",
      "status": "Approved"
    }
  ]
}

{

success*

boolean

Valor que indica que el llamado al recurso fue exitoso. / Field that tells if a request was successful.

message*

string
nullable: true

Proporciona una pequeña descripción cuando ocurre un error al llamado del recurso, por lo regular el valor de este parametro es nulo si no ocurre algún error. / Error message description, can be null if it was a successful request.

data*

{

description:

Representa los datos relacionados a la facturación de una Orden de Reparación./ Repair Order’s invoice information.

orderNumber*

string

Identificador único de la Orden de Reparación. / Repair Order unique identifier.

date*

string($Date)
pattern: YYYY-MM-DD

Fecha de expedición. / Expedition date.

email*

string

Correo electrónico del cliente final. / Final customer’s email.

phoneNumber*

string

Número de teléfono del cliente final. / Final customer’s phone number.

comments

string

Comentarios de la Orden de Reparación. / Repair Order’s comments.

vin

string

Número de identificación vehicular. / Vehicle identification number.

invoiceParameters*

{

description:	JSON con los parámetros y valores relacionados a la factura. Estos varían dependiendo del sistema y/o país en donde se genera la factura. / JSON with the fields and values related to the invoice. These may vary depending on the system and/or country in which the invoice is made.

}
example: OrderedMap { “metodo_de_pago”: “PUE”, “forma_de_pago”: “03”, “uso_cfdi”: “G03” }

items*

[

Descripción específica o genérica de los artículos vendidos o servicios prestados. / General or specific descriptions of the items sold or services provided.

{

quantity*	number Cantidad de unidades que se compraron. / Quantity bought.
unitPrice*	number Precio por unidad del artículo. / Price per unit of the item.
itemId*	string Identificador único del artículo en el sistema de facturación. / Item unique identifier in the invoice system.
warehouseId*	string Identificador único del almacen asociado al negocio. / Unique identifier of the business warehouse.
status*	string example: Approved Rejected Pending Estatus del artículo. / Item status

}]

}

Respuestas

Code 201

Solicitud completada de forma satisfactoria. La respuesta debe devolver la factura que se creo en el sistema de facturación.

Ejemplo
Esquema

				
					{
  "success": true,
  "message": null,
  "data": {
    "result": 0,
    "contentFile": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZ...",
    "fileName": "aaa1f361-cc7f-4145-b3d3-a0e678063801.xml",
    "folio": "1921",
    "serie": "A",
    "uuid": "XXXXXXXX-49F3-4316-824B-A1D9FBF7AF66",
    "id": "F123456"
  }
}

{

success*

boolean

Valor que indica que el llamado al recurso fue exitoso. / Field that tells if a request was successful.

message*

string
nullable: true

data*

{

description:	Representa los datos relacionados a la cotización de una Orden de Reparación./ Repair Order's estimate information.
resultado	integer Código generado al intentar crear el documento. 0 representa un proceso exitoso. Un valor diferente de 0 representa el código de error que se generó. / Code generated when trying to create the document. 0 means a successful process. Any value other than 0 is the error code that was generated.
contentFile*	string String codificado en Base64 que contiene el archivo en formato XML. / String coded in Base64 that contains the file in XML format.
fileName*	string Nombre del archivo XML. / XML file's name.
folio	integer Número de folio asignado al documento. / Folio number assigned to the document.
serie*	string Serie del documento. / Document's serie.
uuid*	string Identificador fiscal de la factura electrónica. / Electronic invoice fiscal identifier
id*	string Identificador único del documento en el sistema de facturación. / Document's unique identifier in the invoice system.

}

Code 400

Error de solicitud incorrecta, se recomienda proporcionar más detalle a través del atributo “mensaje”, indicando si faltan parámetros para realizar la búsqueda.

Ejemplo
Esquema

				
					{
  "success": false,
  "message": "El servidor no puede entender la solicitud debido a un error de sintaxis del lado del cliente, faltan los parámetros: xxxxx, yyyyy, zzzzz. / There is a client side syntax error. The following paramters are missing: xxxxx, yyyyy, zzzzz.",
  "data": []
}

{

success*	boolean Valor que indica que el llamado al recurso no fue exitoso. / Field that tells if the request was successful.
message*	string Proporciona una pequeña descripción del error que hubo al momento de la ejecución del recurso. / Provides an error description.
data*	[ minItems: 0 maxItems: 0 Arreglo que no contiene datos debido a que hubo un error al momento de la ejecución del recurso. / Empty array due to a failed request. string]

}

Code 500

Error de servidor interno, se recomienda proporcionar más detalle a través del atributo “mensaje”.

Ejemplo
Esquema

				
					{
  "success": false,
  "message": "El servidor se ha encontrado con una situación que no sabe cómo manejar, intentelo más tarde. / The server can't handle your request at the moment, please try again later.",
  "data": []
}

{

success*	boolean Valor que indica que el llamado al recurso no fue exitoso. / Field that tells if the request was successful.
message*	string Proporciona una pequeña descripción del error que hubo al momento de la ejecución del recurso. / Provides an error description.
data*	[ minItems: 0 maxItems: 0 Arreglo que no contiene datos debido a que hubo un error al momento de la ejecución del recurso. / Empty array due to a failed request. string]

}

Recepción de vehículos

Cotizaciones

Facturación

API: POST /invoices

Envía los datos de facturación relacionados a una Orden de Reparación.

POST

/invoices

(header)

Identificador único de la agencia, taller o inventario de la cual se quiere obtener la información.

Formato del cuerpo que se debe enviar para agregar los datos de facturación relacionados a una Orden de Reparación.

Solicitud completada de forma satisfactoria. La respuesta debe devolver la factura que se creo en el sistema de facturación.

Error de solicitud incorrecta, se recomienda proporcionar más detalle a través del atributo “mensaje”, indicando si faltan parámetros para realizar la búsqueda.

Error de servidor interno, se recomienda proporcionar más detalle a través del atributo “mensaje”.

Compañía

Productos

Uso de información