HAhalaxy
Invoice

Get Invoice

Changed on

Retrieves an individual invoice

get/main/Invoice/{id}

Request

  • Base URL
    https://au-api.halaxy.com
  • URL
    https://au-api.halaxy.com/main/Invoice/{id}
  • Auth
    OAuth 2
    Client credentials
    Token URL: /main/oauth/token

Path parameters

idstring required

Invoice identifier

Response

Invoice resource

status'active' | 'deleted' | 'issued' | 'write-off' | 'pending-confirmation' | 'null' nullable

Status of the invoice

datestring date-time nullable

Date of the invoice

dueDatestring date-time nullable

Due date of the invoice

payorType'organisation' | 'patient' | 'null' nullable

Type of payor billed on the invoice

titlestring nullable

The patient's name as the invoice title

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Changes

  • 1a14a579daecRevision changes
    • warning

      removed the optional property // from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      added the new ValueSet enum value to the /////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the /////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the ////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the ////////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the ///// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the ///// response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the ///// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the ///// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the /////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the /////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the ////////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the ////////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the ///// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the ///// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the ///// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the ///// response property for the response status (media type: application/json)