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

200

Creates an invoice

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

Request Body

Name	Type	Description
body*	Invoice

200

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

200

Deletes an invoice

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

Path Parameters

Name	Type	Description
invoiceId*	String

200

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

200

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

200

Gets an invoice

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

Path Parameters

Name	Type	Description
invoiceId*	String

200

Gets an invoice

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

Request Body

Name	Type	Description
body*	ListOfIds

200

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

200

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

200

Gets all invoices for author at date

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

Request Body

Name	Type	Description
body*	ListOfIds

200

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

200

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

200

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

200

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

200

Gets all invoices for author at date

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

Path Parameters

Name	Type	Description
invoiceIds*	String

200

Gets all invoices for author at date

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

Path Parameters

Name	Type	Description
recipientIds*	String

200

Gets all invoices for author at date

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

Path Parameters

Name	Type	Description
serviceIds*	String

200

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

200

Gets all invoices for author at date

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

Query Parameters

Name	Type	Description
userIds	String

200

Gets all invoices for author at date

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

Query Parameters

Name	Type	Description
userIds	String

200

Gets all invoices for author at date

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

Query Parameters

Name	Type	Description
hcPartyId	String

200

Gets all invoices for author at date

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

Query Parameters

Name	Type	Description
hcPartyId	String

200

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

200

Modifies an invoice

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

Request Body

Name	Type	Description
body*	Invoice

200

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

200

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

200

Modifies an invoice

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

Request Body

Name	Type	Description
body*	Invoice

200

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

200

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

200

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

200