Schema: HealthInvoiceContext

All schemas · API reference · Data mapping guide

Fields

Field	Required	Type / allowed values
provider	Yes	object
workspace	Yes	object
clients	Yes	array
locations	Yes	array
resolutions	Yes	array

JSON definition

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

{
  "type": "object",
  "properties": {
    "provider": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "enum": [
            "pahfacturar"
          ]
        },
        "hasToken": {
          "type": "boolean"
        },
        "configured": {
          "type": "boolean"
        }
      },
      "required": [
        "name",
        "hasToken",
        "configured"
      ]
    },
    "workspace": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "companyName": {
          "type": "string"
        },
        "nit": {
          "type": "string"
        },
        "verificationDigit": {
          "type": "string"
        },
        "environment": {
          "anyOf": [
            {
              "type": "number",
              "enum": [
                1
              ]
            },
            {
              "type": "number",
              "enum": [
                2
              ]
            }
          ]
        },
        "serviceCode": {
          "type": [
            "string",
            "null"
          ]
        },
        "providerCodes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "id",
        "companyName",
        "nit",
        "verificationDigit",
        "environment",
        "serviceCode",
        "providerCodes"
      ]
    },
    "clients": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Client"
      }
    },
    "locations": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Location"
      }
    },
    "resolutions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Resolution"
      }
    }
  },
  "required": [
    "provider",
    "workspace",
    "clients",
    "locations",
    "resolutions"
  ]
}