GET api/invoice/documents?groupId={groupId}&tenancyRoleId={tenancyRoleId}

Gets the documents attached to the invoices in one scope: those a group is Issued By or Issued To, or those regarding a tenancy. Exactly one scope is required. Processes this invoice API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupId

The group whose invoices to include

integer

None.

tenancyRoleId

The tenant role whose invoices to include

integer

None.

Body Parameters

None.

Response Information

Resource Description

Each document with the id of the invoice it is attached to

Collection of InvoiceAttachedDocumentDataContract
NameDescriptionTypeAdditional information
InvoiceId

The unique identifier of the related invoice resource.

integer

None.

Document

The document value.

DocumentDataContract

None.

Response Formats

application/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path '[0].Document.Attachments'.

text/json

Sample:

An exception has occurred while using the formatter 'SanitizingJsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'Dezrez.Core.DataContracts.External.Api.Media.DocumentDataContract'. Path '[0].Document.Attachments'.