POST api/Advisors/Invoices

Request Information

URI Parameters

None.

Body Parameters

AdvisorBatchRequest
NameDescriptionTypeAdditional information
InvoiceIDs

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "InvoiceIDs": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<AdvisorBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FraxionSM.API">
  <InvoiceIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </InvoiceIDs>
</AdvisorBatchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of AdvisorBatchItem
NameDescriptionTypeAdditional information
InvoiceID

integer

None.

HasGrade

boolean

None.

IsIncomplete

boolean

None.

Score

integer

None.

Grade

string

None.

Label

string

None.

AgingDays

integer

None.

IsDirty

boolean

None.

IsStaleVersion

boolean

None.

TotalReasonsCount

integer

None.

TopReasons

Collection of ReasonSummary

None.

MatchStatus

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "InvoiceID": 1,
    "HasGrade": true,
    "IsIncomplete": true,
    "Score": 4,
    "Grade": "sample string 5",
    "Label": "sample string 6",
    "AgingDays": 7,
    "IsDirty": true,
    "IsStaleVersion": true,
    "TotalReasonsCount": 10,
    "TopReasons": [
      {
        "Priority": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "Priority": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "MatchStatus": 11
  },
  {
    "InvoiceID": 1,
    "HasGrade": true,
    "IsIncomplete": true,
    "Score": 4,
    "Grade": "sample string 5",
    "Label": "sample string 6",
    "AgingDays": 7,
    "IsDirty": true,
    "IsStaleVersion": true,
    "TotalReasonsCount": 10,
    "TopReasons": [
      {
        "Priority": "sample string 1",
        "Message": "sample string 2"
      },
      {
        "Priority": "sample string 1",
        "Message": "sample string 2"
      }
    ],
    "MatchStatus": 11
  }
]

application/xml, text/xml

Sample:
<ArrayOfAdvisorBatchItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FraxionSM.BLL.Advisor.Models">
  <AdvisorBatchItem>
    <AgingDays>7</AgingDays>
    <Grade>sample string 5</Grade>
    <HasGrade>true</HasGrade>
    <InvoiceID>1</InvoiceID>
    <IsDirty>true</IsDirty>
    <IsIncomplete>true</IsIncomplete>
    <IsStaleVersion>true</IsStaleVersion>
    <Label>sample string 6</Label>
    <MatchStatus>11</MatchStatus>
    <Score>4</Score>
    <TopReasons>
      <ReasonSummary>
        <Message>sample string 2</Message>
        <Priority>sample string 1</Priority>
      </ReasonSummary>
      <ReasonSummary>
        <Message>sample string 2</Message>
        <Priority>sample string 1</Priority>
      </ReasonSummary>
    </TopReasons>
    <TotalReasonsCount>10</TotalReasonsCount>
  </AdvisorBatchItem>
  <AdvisorBatchItem>
    <AgingDays>7</AgingDays>
    <Grade>sample string 5</Grade>
    <HasGrade>true</HasGrade>
    <InvoiceID>1</InvoiceID>
    <IsDirty>true</IsDirty>
    <IsIncomplete>true</IsIncomplete>
    <IsStaleVersion>true</IsStaleVersion>
    <Label>sample string 6</Label>
    <MatchStatus>11</MatchStatus>
    <Score>4</Score>
    <TopReasons>
      <ReasonSummary>
        <Message>sample string 2</Message>
        <Priority>sample string 1</Priority>
      </ReasonSummary>
      <ReasonSummary>
        <Message>sample string 2</Message>
        <Priority>sample string 1</Priority>
      </ReasonSummary>
    </TopReasons>
    <TotalReasonsCount>10</TotalReasonsCount>
  </AdvisorBatchItem>
</ArrayOfAdvisorBatchItem>