iCure. eHealth Solutions
  • Developer Documentation
  • iCure Software Modules
  • Get Started
    • Create your own Database
      • Receive an invitation
      • Create new User
      • Create a new Healthcare Party
    • Structure your Database
    • Access your database
    • Use the Console
  • Data Stack Module
    • The Data Stack
      • Install iCure
      • Get Started with a Database
    • iCure Data Model
      • Overview
      • User
        • Permission
      • Healthcare Party
      • Patient
        • Insurability
        • Relationship
        • Patient Hcp care period
          • Referral period
      • Contact
        • Service
          • Content
            • Medication
              • Regimen item
            • Measure
        • SubContact
      • Healthcare Element
        • Care team member
        • Healthcare approach
      • Form
      • Additional Classes
        • AccessLog
        • Address
          • Telecom
        • Message
        • Document
        • FilterChain
          • Filter
          • Predicate
        • Group
        • Insurance
        • Invoice
          • Invoicing code
        • Tarification
          • Valorisation
    • Hybrid Cloud Storage
    • Mobile/Web SDKs
      • JavaScript/Typescript
        • Setting up your environment
        • Logging in
        • Managing patients
        • iCure for MedTech: Getting Started
          • Exchange data using FHIR model
          • Exchange data using iCure SDK
      • Java/Kotlin
      • Swift/Objective C
    • REST API calls
      • User
      • Patient
      • HealthcareParty
      • Contact
      • HealthcareElement
      • Form
      • Document
      • Message
      • Invoice
      • Additional endpoints
        • AccessLog
        • Authentication
        • Codification
        • Document template
        • Entity reference
        • Entity template
        • Insurance
        • Receipt
        • Tarification
    • Access Rights management
    • End-to-End-Encryption
    • ATNA Audit Records
  • Interoperability Module
    • IHE XDS calls
      • The XDS Concept
      • ITI-18 get associations api call
      • ITI-41 provide and register document set api call
      • Iti-42 register document set api call
    • IHE IPS call
      • The IPS Concept
    • FHIR API Data Exchange
      • The FHIR Concept
    • Freehealth Connector 🇧🇪
    • Encrypted Data Exchange
      • Internal
      • External
  • Customizable Features Module
    • Input Forms
    • Medical Records
    • Data Dashboards
    • Custom Connectors
    • Secure Log-in App
  • Support
    • Download
    • Contact Us
  • Advanced topics
    • Healthcare Data
      • Business intelligence
      • Anonymized Data
    • Encryption Key Creation and Storage
    • Multi-Master database replication
    • Cross Databases Sharing
    • Complex queries
Powered by GitBook
On this page
  • Gets all invoices for author at date
  • Creates an invoice
  • Create a batch of invoices
  • Deletes an invoice
  • Filter invoices for the current user (HcParty)
  • Gets all invoices for author at date
  • Gets an invoice
  • Gets an invoice
  • Get the list of all used tarifications frequencies in invoices
  • Gets all invoices per status
  • Gets all invoices for author at date
  • List invoices found By Healthcare Party and secret foreign patient keys.
  • List invoices by groupId
  • List invoices by type, sent or unsent
  • Get all invoices by author, by sending mode, by status and by date
  • Gets all invoices for author at date
  • Gets all invoices for author at date
  • Gets all invoices for author at date
  • List helement stubs found By Healthcare Party and secret foreign keys.
  • Gets all invoices for author at date
  • Gets all invoices for author at date
  • Gets all invoices for author at date
  • Gets all invoices for author at date
  • Gets all invoices for author at date
  • Modifies an invoice
  • Modify a batch of invoices
  • Adds a delegation to a invoice
  • Modifies an invoice
  • Remove an invoice of an user
  • Update delegations in healthElements.
  • Gets all invoices for author at date

Was this helpful?

  1. Data Stack Module
  2. REST API calls

Invoice

Gets all invoices for author at date

POST https://demo.icure.cloud/rest/v2/invoice/byauthor/{userId}/append/{type}/{sentMediumType}

Path Parameters

Name
Type
Description

userId*

String

type*

String

sentMediumType*

String

Query Parameters

Name
Type
Description

secretFKeys*

String

insuranceId

String

invoiceId

String

gracePeriod

Integer

Request Body

Name
Type
Description

body*

List

Creates an invoice

POST https://demo.icure.cloud/rest/v2/invoice

Request Body

Name
Type
Description

body*

Invoice

Create a batch of invoices

POST https://demo.icure.cloud/rest/v2/invoice/batch

Returns the created invoices.

Request Body

Name
Type
Description

body*

List

Deletes an invoice

DELETE https://demo.icure.cloud/rest/v2/invoice/{invoiceId}

Path Parameters

Name
Type
Description

invoiceId*

String

Filter invoices for the current user (HcParty)

POST https://demo.icure.cloud/rest/v2/invoice/filter

Returns a list of invoices along with next start keys and Document ID. If the nextStartKey is Null it means that this is the last page.

Request Body

Name
Type
Description

body*

FilterChainInvoice

Gets all invoices for author at date

GET https://demo.icure.cloud/rest/v2/invoice/byauthor/{hcPartyId}

Path Parameters

Name
Type
Description

hcPartyId*

String

Query Parameters

Name
Type
Description

fromDate

Long

toDate

Long

startKey

String

The start key for pagination: a JSON representation of an array containing all the necessary components to form the Complex Key's startKey

startDocumentId

String

A patient document ID

limit

Integer

Number of rows

Gets an invoice

GET https://demo.icure.cloud/rest/v2/invoice/{invoiceId}

Path Parameters

Name
Type
Description

invoiceId*

String

Gets an invoice

POST https://demo.icure.cloud/rest/v2/invoice/byIds

Request Body

Name
Type
Description

body*

ListOfIds

Get the list of all used tarifications frequencies in invoices

GET https://demo.icure.cloud/rest/v2/invoice/codes/{minOccurences}

Path Parameters

Name
Type
Description

minOccurences*

Long

Gets all invoices per status

POST https://demo.icure.cloud/rest/v2/invoice/allHcpsByStatus/{status}

Path Parameters

Name
Type
Description

status*

String

Query Parameters

Name
Type
Description

from

Long

to

Long

Request Body

Name
Type
Description

body*

ListOfIds

Gets all invoices for author at date

POST https://demo.icure.cloud/rest/v2/invoice/byContacts

Request Body

Name
Type
Description

body*

ListOfIds

List invoices found By Healthcare Party and secret foreign patient keys.

GET https://demo.icure.cloud/rest/v2/invoice/byHcPartySecretForeignKeys

Keys have to delimited by coma

Query Parameters

Name
Type
Description

hcPartyId*

String

secretFKeys*

String

List invoices by groupId

GET https://demo.icure.cloud/rest/v2/invoice/byHcPartyGroupId/{hcPartyId}/{groupId}

Keys have to delimited by coma

Path Parameters

Name
Type
Description

hcPartyId*

String

groupId*

String

List invoices by type, sent or unsent

GET https://demo.icure.cloud/rest/v2/invoice/byHcParty/{hcPartyId}/mediumType/{sentMediumType}/invoiceType/{invoiceType}/sent/{sent}

Keys have to delimited by coma

Path Parameters

Name
Type
Description

hcPartyId*

String

sentMediumType*

String

invoiceType*

String

sent*

Boolean

Query Parameters

Name
Type
Description

from

Long

to

Long

Get all invoices by author, by sending mode, by status and by date

GET https://demo.icure.cloud/rest/v2/invoice/byHcpartySendingModeStatusDate/{hcPartyId}

Path Parameters

Name
Type
Description

hcPartyId*

String

Query Parameters

Name
Type
Description

sendingMode

String

status

String

from

Long

to

Long

Gets all invoices for author at date

GET https://demo.icure.cloud/rest/v2/invoice/byIds/{invoiceIds}

Path Parameters

Name
Type
Description

invoiceIds*

String

Gets all invoices for author at date

GET https://demo.icure.cloud/rest/v2/invoice/to/{recipientIds}

Path Parameters

Name
Type
Description

recipientIds*

String

Gets all invoices for author at date

GET https://demo.icure.cloud/rest/v2/invoice/byServiceIds/{serviceIds}

Path Parameters

Name
Type
Description

serviceIds*

String

List helement stubs found By Healthcare Party and secret foreign keys.

GET https://demo.icure.cloud/rest/v2/invoice/byHcPartySecretForeignKeys/delegations

Keys must be delimited by coma

Query Parameters

Name
Type
Description

hcPartyId*

String

secretFKeys*

String

Gets all invoices for author at date

GET https://demo.icure.cloud/rest/v2/invoice/toInsurances

Query Parameters

Name
Type
Description

userIds

String

Gets all invoices for author at date

GET https://demo.icure.cloud/rest/v2/invoice/toInsurances/unsent

Query Parameters

Name
Type
Description

userIds

String

Gets all invoices for author at date

GET https://demo.icure.cloud/rest/v2/invoice/toPatients

Query Parameters

Name
Type
Description

hcPartyId

String

Gets all invoices for author at date

GET https://demo.icure.cloud/rest/v2/invoice/toPatients/unsent

Query Parameters

Name
Type
Description

hcPartyId

String

Gets all invoices for author at date

POST https://demo.icure.cloud/rest/v2/invoice/mergeTo/{invoiceId}

Path Parameters

Name
Type
Description

invoiceId*

String

Request Body

Name
Type
Description

body*

ListOfIds

Modifies an invoice

PUT https://demo.icure.cloud/rest/v2/invoice

Request Body

Name
Type
Description

body*

Invoice

Modify a batch of invoices

PUT https://demo.icure.cloud/rest/v2/invoice/batch

Returns the modified invoices.

Request Body

Name
Type
Description

body*

List

Adds a delegation to a invoice

PUT https://demo.icure.cloud/rest/v2/invoice/{invoiceId}/delegate

Path Parameters

Name
Type
Description

invoiceId*

String

Request Body

Name
Type
Description

body*

List

Modifies an invoice

POST https://demo.icure.cloud/rest/v2/invoice/reassign

Request Body

Name
Type
Description

body*

Invoice

Remove an invoice of an user

POST https://demo.icure.cloud/rest/v2/invoice/byauthor/{userId}/service/{serviceId}

Path Parameters

Name
Type
Description

userId*

String

serviceId*

String

Query Parameters

Name
Type
Description

secretFKeys*

String

Request Body

Name
Type
Description

body*

List

Update delegations in healthElements.

POST https://demo.icure.cloud/rest/v2/invoice/delegations

Keys must be delimited by coma

Request Body

Name
Type
Description

body*

List

Gets all invoices for author at date

POST https://demo.icure.cloud/rest/v2/invoice/validate/{invoiceId}

Path Parameters

Name
Type
Description

invoiceId*

String

Query Parameters

Name
Type
Description

scheme*

String

forcedValue*

String

PreviousMessageNextAdditional endpoints

Last updated 3 years ago

Was this helpful?