Invoice

Gets all invoices for author at date

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

Path Parameters

NameTypeDescription

userId*

String

type*

String

sentMediumType*

String

Query Parameters

NameTypeDescription

secretFKeys*

String

insuranceId

String

invoiceId

String

gracePeriod

Integer

Request Body

NameTypeDescription

body*

List

Creates an invoice

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

Request Body

NameTypeDescription

body*

Invoice

Create a batch of invoices

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

Returns the created invoices.

Request Body

NameTypeDescription

body*

List

Deletes an invoice

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

Path Parameters

NameTypeDescription

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

NameTypeDescription

body*

FilterChainInvoice

Gets all invoices for author at date

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

Path Parameters

NameTypeDescription

hcPartyId*

String

Query Parameters

NameTypeDescription

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

NameTypeDescription

invoiceId*

String

Gets an invoice

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

Request Body

NameTypeDescription

body*

ListOfIds

Get the list of all used tarifications frequencies in invoices

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

Path Parameters

NameTypeDescription

minOccurences*

Long

Gets all invoices per status

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

Path Parameters

NameTypeDescription

status*

String

Query Parameters

NameTypeDescription

from

Long

to

Long

Request Body

NameTypeDescription

body*

ListOfIds

Gets all invoices for author at date

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

Request Body

NameTypeDescription

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

NameTypeDescription

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

NameTypeDescription

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

NameTypeDescription

hcPartyId*

String

sentMediumType*

String

invoiceType*

String

sent*

Boolean

Query Parameters

NameTypeDescription

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

NameTypeDescription

hcPartyId*

String

Query Parameters

NameTypeDescription

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

NameTypeDescription

invoiceIds*

String

Gets all invoices for author at date

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

Path Parameters

NameTypeDescription

recipientIds*

String

Gets all invoices for author at date

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

Path Parameters

NameTypeDescription

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

NameTypeDescription

hcPartyId*

String

secretFKeys*

String

Gets all invoices for author at date

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

Query Parameters

NameTypeDescription

userIds

String

Gets all invoices for author at date

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

Query Parameters

NameTypeDescription

userIds

String

Gets all invoices for author at date

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

Query Parameters

NameTypeDescription

hcPartyId

String

Gets all invoices for author at date

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

Query Parameters

NameTypeDescription

hcPartyId

String

Gets all invoices for author at date

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

Path Parameters

NameTypeDescription

invoiceId*

String

Request Body

NameTypeDescription

body*

ListOfIds

Modifies an invoice

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

Request Body

NameTypeDescription

body*

Invoice

Modify a batch of invoices

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

Returns the modified invoices.

Request Body

NameTypeDescription

body*

List

Adds a delegation to a invoice

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

Path Parameters

NameTypeDescription

invoiceId*

String

Request Body

NameTypeDescription

body*

List

Modifies an invoice

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

Request Body

NameTypeDescription

body*

Invoice

Remove an invoice of an user

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

Path Parameters

NameTypeDescription

userId*

String

serviceId*

String

Query Parameters

NameTypeDescription

secretFKeys*

String

Request Body

NameTypeDescription

body*

List

Update delegations in healthElements.

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

Keys must be delimited by coma

Request Body

NameTypeDescription

body*

List

Gets all invoices for author at date

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

Path Parameters

NameTypeDescription

invoiceId*

String

Query Parameters

NameTypeDescription

scheme*

String

forcedValue*

String

Last updated