Table of Contents

ServiceOrders

Endpoints relacionados con las órdenes de mano de obra (órdenes de servicio).

Endpoint Método Descripción
/serviceOrders POST Recibe una orden de mano de obra
/serviceOrders/{serviceOrderId}/cancel POST Cancela una orden de mano de obra

POST /ServiceOrders

Recibe una orden de mano de obra y la registra en el sistema de la aseguradora. Se recibe un objeto en el body del mensaje con los datos de la orden de mano de obra.

Mensaje recibido

classDiagram
 direction LR

    class ServiceOrderDetails {
        +ServiceOrderId: int
        +ServiceOrderGuid: guid
        +RequestId: int
        +ClaimId: int
        +InsuranceClaimNumber: string
        +DeliveryDays: int
        +CreatedOnUtcDate: DateTime
        +CreatedByEmailAddress: string
        +CreatedByDisplayName:string
        +WorkshopPersonTaxId: string
        +WorkshopPersonName: string
        +SubTotalAmount: decimal
        +DifferenceAmount: decimal
        +DeductibleAmount: decimal
        +TaxTotalAmount: decimal
        +Comments: string
        +Items: List<ServiceOrderItem>
    }

    class ServiceOrderItem {
        int? ItemId
        string ItemCode
        string ItemName
        decimal ItemQuantity
        short? ItemActionId
        string ItemActionName
        int? WorkshopServiceId
        string WorkshopServiceCode
        string WorkshopServiceName
        decimal? WorkshopServicePrice
        decimal? OtherCosts
    }

      ServiceOrderDetails --|> "n" ServiceOrderItem

ServiceOrderDetails

Atributo Tipo de datos Descripción
ServiceOrderId int Id de la orden de mano de obra en infopiezas
ServiceOrderGuid string Guid único para esta orden de mano de obra
RequestId int Id de la licitación
ClaimId int Id del reclamo en infopiezas (Si hay registrado)
InsuranceClaimNumber string Número de reclamación en la aseguradora
DeliveryDays int Dias de entrega
CreatedOnUtcDate DateTime Fecha de creación de la orden de mano de obra, en UTC
CreatedByEmailAddress string Correo electrónico del usuario que crea la orden de mano de obra
CreatedByDisplayName string Nombre del usuario que crea la orden de mano de obra
WorkshopPersonTaxId string RNC del taller a quien se emite la orden de mano de obra
WorkshopPersonName string Nombre del taller a quien se emite la orden de mano de obra
SubTotalAmount decimal Subtotal orden de mano de obra en función de precios previamente acordados por el tipo de servicio
DifferenceAmount decimal Monto ajuste orden de mano de obra
DeductibleAmount decimal Monto deducible
TaxTotalAmount decimal Monto de impuestos
Comments string Comentarios
Items List<ServiceOrderItem> Piezas

ServiceOrderItem

Atributo Tipo de datos Descripción
ItemId int? Id de la pieza
ItemCode string Código de la pieza. Este campo puede estar en blanco. Para el identificador único de la pieza refierase al ItemId.
ItemName string Nombre de la pieza
ItemQuantity decimal Cantidad
ItemActionId short? Id acción a tomar
ItemActionName string Nombre acción a tomar
WorkshopServiceId int? Id del servicio de taller
WorkshopServiceCode string Código del servicio de taller
WorkshopServiceName string Nombre del servicio de taller
WorkshopServicePrice decimal? Precio acordado con el taller (por unidad).
OtherCosts decimal? Otros costos

Modelo de mensaje que se recibe con los datos de la orden de mano de obra


{
  "serviceOrderId": 0,
  "serviceOrderGuid": "string",
  "requestId": 0,
  "claimId": 0,
  "insuranceClaimNumber": "string",
  "deliveryDays": 0,
  "createdOnUtcDate": "2023-08-10T14:37:26.903Z",
  "createdByEmailAddress": "string",
  "createdByDisplayName": "string",
  "workshopPersonTaxId": "string",
  "workshopPersonName": "string",
  "subTotalAmount": 0,
  "differenceAmount": 0,
  "deductibleAmount": 0,
  "taxTotalAmount": 0,
  "comments": "string",
  "items": [
{
      "itemId": 0,
      "itemCode": "string",
      "itemName": "string",
      "itemQuantity": 0,
      "itemActionId": 0,
      "itemActionName": "string",
      "workshopServiceId": 0,
      "workshopServiceCode": "string",
      "workshopServiceName": "string",
      "workshopServicePrice": 0,
      "otherCosts": 0
    }
  ]
}
Note

Los documentos JSON que aparecen aquí son solamente para fines ilustrativos y no necesariamente representa la última versión del objeto en el API. Se debe utilizar como referencia de desarrollo siempre el JSON que aparece en la documentación dinámica del endpoint correspondiente en Swagger.



Respuesta

Se devuelve un objeto que incluye el número de la orden de mano de obra en el sistema de la aseguradora.

classDiagram
    class CreatedServiceOrderResponse {
        +ServiceOrderId: int
        +ServiceOrderNumber: string
    }

Atributo Tipo de datos Descripción
ServiceOrderId int Id de la orden de mano de obra en infopiezas
ServiceOrderNumber string Número de la orden de mano de obra en la aseguradora

Modelo de los datos que se devuelven al momento de recibir la orden de mano de obra

{
  "serviceOrderId": 0,
  "serviceOrderNumber": "string"
}



POST /ServiceOrders/{serviceOrderId}/cancel

Recibe información sobre una orden de mano de obra a cancelar en infopiezas. Recibe un objeto en el body del mensaje con la siguiente estructura:

Note

La cancelación de la orden de mano de obra es enviada a la aseguradora antes de cancelar la orden en infopiezas. De esta manera la aseguradora puede tomar en cuenta cualquier regla de negocio antes de permirtir la cancelación en infopiezas. Si en la espuesta de la aseguradora el campo IsCancelled viene en falso, la orden no puede cancelarse en infopiezas.

Mensaje recibido

classDiagram
    class ServiceOrderCancellationDetails {
        +ServiceOrderId: int
        +RequestId: int
        +ServiceOrderNumber: string
        +InsuranceClaimNumber: string
        +Comments: string
        +CancelledByEmailAddress: string
        +CancelledByDisplayName: string
    }

Atributo Tipo de datos Descripción
ServiceOrderId int Id de la orden de mano de obra en infopiezas.net
RequestId int Id de la licitación en infopiezas a que corresponde la orden (si tiene licitación)
ServiceOrderNumber string Número de la orden de mano de obra en la aseguradora (recibido de la aseguradora al momento de enviar la orden de mano de obra)
InsuranceClaimNumber string El número de reclamación en la aseguradora
Comments string Comentarios
CancelledByEmailAddress string Correo electrónico del usuario que cancela la orden de mano de obra
CancelledByDisplayName string Nombre del usuario que cancela la orden de mano de obra

Modelo del mensaje recibido

{
  "serviceOrderId": 0,
  "requestId": 0,
  "purchaseOrderNumber": "string",
  "insuranceClaimNumber": "string",
  "comments": "string",
  "cancelledByEmailAddress": "string",
  "cancelledByDisplayName": "string"
}
Note

Los documentos JSON que aparecen aquí son solamente para fines ilustrativos y no necesariamente representa la última versión del objeto en el API. Se debe utilizar como referencia de desarrollo siempre el JSON que aparece en la documentación dinámica del endpoint correspondiente en Swagger.



Respuesta

Se devuelve un objeto con la siguiente información:

classDiagram
    class CancelledServiceOrderResponse {
        +IsCancelled: bool
        +ShowResponseText: bool
        +ResponseText: string
    }

Atributo Tipo de datos Descripción
IsCancelled bool Devuelve verdadero o falso indicando si la orden fue cancelada o no en el sistema de la aseguradora. Si se envía falso, no se realiza la cancelación de la orden en infopiezas
ShowResponseText bool Indica si se debe presentar el mensaje de respuesta al usuario
ResponseText string Texto de respuesta en caso que la orden no haya podido ser cancelada para presentar más información al usuario

Modelo de mensaje de respuesta

{
  "isCancelled": true,
  "showResponseText": true,
  "responseText": "string"
}