Schema: CreditNote

All schemas · API reference · Data mapping guide

Fields

Field	Required	Type / allowed values
id	Yes	string
invoiceId	Yes	string
originalInvoiceNumber	Yes	string or null
clientId	Yes	string
clientName	Yes	string
totalAmount	Yes	number
status	Yes	HealthDocumentStatus
statusMessage	Yes	string or null
assignedCreditNoteNumber	Yes	string or null
cude	Yes	string or null
discrepancyResponseCode	Yes	integer
discrepancyResponseDescription	Yes	string
ripsPackageKind	Yes	nc_total, nc_parcial
isActive	Yes	boolean
createdAt	Yes	string
updatedAt	Yes	string
originalInvoiceCufe	Yes	string or null
dianStatusCode	Yes	string or null
dianStatusDescription	Yes	string or null
submittedByUserId	Yes	string or null
creditNotePayloadJson	Yes	string or null
workingRipsJson	Yes	string or null
dispatchHistory	Yes	array
ripsPackages	Yes	array
documentAvailability	Yes	array

JSON definition

The JSON retains the source contract descriptions. Do not translate property names or enum values.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "invoiceId": {
      "type": "string"
    },
    "originalInvoiceNumber": {
      "type": [
        "string",
        "null"
      ]
    },
    "clientId": {
      "type": "string"
    },
    "clientName": {
      "type": "string"
    },
    "totalAmount": {
      "type": "number"
    },
    "status": {
      "$ref": "#/components/schemas/HealthDocumentStatus"
    },
    "statusMessage": {
      "type": [
        "string",
        "null"
      ]
    },
    "assignedCreditNoteNumber": {
      "type": [
        "string",
        "null"
      ]
    },
    "cude": {
      "type": [
        "string",
        "null"
      ]
    },
    "discrepancyResponseCode": {
      "type": "integer"
    },
    "discrepancyResponseDescription": {
      "type": "string"
    },
    "ripsPackageKind": {
      "type": "string",
      "enum": [
        "nc_total",
        "nc_parcial"
      ]
    },
    "isActive": {
      "type": "boolean"
    },
    "createdAt": {
      "type": "string",
      "description": "Fecha y hora ISO 8601 (UTC).",
      "example": "2026-10-15T12:00:00.000Z"
    },
    "updatedAt": {
      "type": "string",
      "description": "Fecha y hora ISO 8601 (UTC).",
      "example": "2026-10-15T12:00:00.000Z"
    },
    "originalInvoiceCufe": {
      "type": [
        "string",
        "null"
      ]
    },
    "dianStatusCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "dianStatusDescription": {
      "type": [
        "string",
        "null"
      ]
    },
    "submittedByUserId": {
      "type": [
        "string",
        "null"
      ]
    },
    "creditNotePayloadJson": {
      "type": [
        "string",
        "null"
      ]
    },
    "workingRipsJson": {
      "type": [
        "string",
        "null"
      ]
    },
    "dispatchHistory": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/DocumentAttempt"
      }
    },
    "ripsPackages": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LinkedRipsPackage"
      }
    },
    "documentAvailability": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ArtifactAvailability"
      }
    }
  },
  "required": [
    "id",
    "invoiceId",
    "originalInvoiceNumber",
    "clientId",
    "clientName",
    "totalAmount",
    "status",
    "statusMessage",
    "assignedCreditNoteNumber",
    "cude",
    "discrepancyResponseCode",
    "discrepancyResponseDescription",
    "ripsPackageKind",
    "isActive",
    "createdAt",
    "updatedAt",
    "originalInvoiceCufe",
    "dianStatusCode",
    "dianStatusDescription",
    "submittedByUserId",
    "creditNotePayloadJson",
    "workingRipsJson",
    "dispatchHistory",
    "ripsPackages",
    "documentAvailability"
  ],
  "description": "Nota crédito de salud emitida por PahFacturar."
}