POST api/account/{id}/invoiceoverview

Get summary of an account based on invoice amounts allocated Processes this account API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The unique identifier of the requested resource.

integer

Required

Body Parameters

The get account invoice overview data contract supplied with the request.

GetAccountInvoiceOverviewDataContract
NameDescriptionTypeAdditional information
NumberOfMonths

The number of months value.

integer

None.

ExcludeThisMonth

Indicates whether exclude this month is true.

boolean

None.

ExcludeResultOfAllTypes

Indicates whether exclude result of all types is true.

boolean

None.

Types

The collection of types.

Collection of InvoiceType

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "NumberOfMonths": 1,
  "ExcludeThisMonth": true,
  "ExcludeResultOfAllTypes": true,
  "Types": [
    0,
    0
  ]
}

Response Information

Resource Description

The response returned after the operation completes.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.