POST v1/Generic/InvoiceCheck

Checks draft Invoice for any new changes from previously saved Invoice Record

Request Information

URI Parameters

None.

Body Parameters

InvoiceCheckRequestModel
NameDescriptionTypeAdditional information
OrderID

integer

None.
Guid

globally unique identifier

None.

Request Formats

application/json, text/json

Sample: 
{
  "OrderID": 1,
  "Guid": "799d058e-1a8a-4801-adfe-2993c37c8f79"
}

application/xml, text/xml

Sample: 
<InvoiceCheckRequestModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Guid>799d058e-1a8a-4801-adfe-2993c37c8f79</Guid>
  <OrderID>1</OrderID>
</InvoiceCheckRequestModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'InvoiceCheckRequestModel'.

Response Information

Resource Description

InvoiceCheckModel
NameDescriptionTypeAdditional information
HeaderSection

InvoiceCheckHeaderSectionModel

None.
OrderSection

InvoiceCheckServiceSectionModel

None.
GroupBillingSection

InvoiceCheckGroupBillingSectionModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "HeaderSection": {
    "PurchaseOrderNumber": {
      "Data": "sample string 1",
      "Match": true
    },
    "InvoiceTitle": {
      "Data": "sample string 1",
      "Match": true
    },
    "TermsCode": {
      "Data": "sample string 1",
      "Match": true
    },
    "Contact": {
      "Data": "sample string 1",
      "Match": true
    },
    "AddressLine1": {
      "Data": "sample string 1",
      "Match": true
    },
    "AddressLine2": {
      "Data": "sample string 1",
      "Match": true
    },
    "AddressLine3": {
      "Data": "sample string 1",
      "Match": true
    },
    "City": {
      "Data": "sample string 1",
      "Match": true
    },
    "StateCode": {
      "Data": "sample string 1",
      "Match": true
    },
    "ZipCode": {
      "Data": "sample string 1",
      "Match": true
    },
    "CountryCode": {
      "Data": "sample string 1",
      "Match": true
    },
    "Match": true
  },
  "OrderSection": {
    "Orders": {
      "Service": [
        {
          "VersionDetailID": "sample string 1",
          "UnitMeasureCode": "sample string 2",
          "UnitName": "sample string 3",
          "GroupQuantity": 1.0,
          "OrderID": "sample string 4",
          "OrderNumber": "sample string 5",
          "VersionID": "sample string 6",
          "Value": "sample string 7",
          "Match": true,
          "Quantity": 9.0,
          "Rate": 10.0,
          "Amount": 11.0,
          "Tax": 12.0,
          "DateCreated": "sample string 13",
          "ModifiedOn": "sample string 14"
        },
        {
          "VersionDetailID": "sample string 1",
          "UnitMeasureCode": "sample string 2",
          "UnitName": "sample string 3",
          "GroupQuantity": 1.0,
          "OrderID": "sample string 4",
          "OrderNumber": "sample string 5",
          "VersionID": "sample string 6",
          "Value": "sample string 7",
          "Match": true,
          "Quantity": 9.0,
          "Rate": 10.0,
          "Amount": 11.0,
          "Tax": 12.0,
          "DateCreated": "sample string 13",
          "ModifiedOn": "sample string 14"
        }
      ],
      "Postage": [
        {
          "VersionPostageID": "sample string 1",
          "OrderID": "sample string 2",
          "OrderNumber": "sample string 3",
          "VersionID": "sample string 4",
          "Value": "sample string 5",
          "Match": true,
          "Quantity": 7.0,
          "Rate": 8.0,
          "Amount": 9.0,
          "Tax": 10.0,
          "DateCreated": "sample string 11",
          "ModifiedOn": "sample string 12"
        },
        {
          "VersionPostageID": "sample string 1",
          "OrderID": "sample string 2",
          "OrderNumber": "sample string 3",
          "VersionID": "sample string 4",
          "Value": "sample string 5",
          "Match": true,
          "Quantity": 7.0,
          "Rate": 8.0,
          "Amount": 9.0,
          "Tax": 10.0,
          "DateCreated": "sample string 11",
          "ModifiedOn": "sample string 12"
        }
      ]
    }
  },
  "GroupBillingSection": {
    "ChangesDetected": true
  }
}

application/xml, text/xml

Sample: 
<InvoiceCheckModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <HeaderSection>
    <PurchaseOrderNumber>
      <Data>sample string 1</Data>
      <Match>true</Match>
    </PurchaseOrderNumber>
    <InvoiceTitle>
      <Data>sample string 1</Data>
      <Match>true</Match>
    </InvoiceTitle>
    <TermsCode>
      <Data>sample string 1</Data>
      <Match>true</Match>
    </TermsCode>
    <Contact>
      <Data>sample string 1</Data>
      <Match>true</Match>
    </Contact>
    <AddressLine1>
      <Data>sample string 1</Data>
      <Match>true</Match>
    </AddressLine1>
    <AddressLine2>
      <Data>sample string 1</Data>
      <Match>true</Match>
    </AddressLine2>
    <AddressLine3>
      <Data>sample string 1</Data>
      <Match>true</Match>
    </AddressLine3>
    <City>
      <Data>sample string 1</Data>
      <Match>true</Match>
    </City>
    <StateCode>
      <Data>sample string 1</Data>
      <Match>true</Match>
    </StateCode>
    <ZipCode>
      <Data>sample string 1</Data>
      <Match>true</Match>
    </ZipCode>
    <CountryCode>
      <Data>sample string 1</Data>
      <Match>true</Match>
    </CountryCode>
    <Match>true</Match>
  </HeaderSection>
  <OrderSection>
    <Orders>
      <Service>
        <InvoiceCheckServiceItemModel>
          <OrderID>sample string 4</OrderID>
          <OrderNumber>sample string 5</OrderNumber>
          <VersionID>sample string 6</VersionID>
          <Value>sample string 7</Value>
          <Match>true</Match>
          <Quantity>9</Quantity>
          <Rate>10</Rate>
          <Amount>11</Amount>
          <Tax>12</Tax>
          <DateCreated>sample string 13</DateCreated>
          <ModifiedOn>sample string 14</ModifiedOn>
          <VersionDetailID>sample string 1</VersionDetailID>
          <UnitMeasureCode>sample string 2</UnitMeasureCode>
          <UnitName>sample string 3</UnitName>
          <GroupQuantity>1</GroupQuantity>
        </InvoiceCheckServiceItemModel>
        <InvoiceCheckServiceItemModel>
          <OrderID>sample string 4</OrderID>
          <OrderNumber>sample string 5</OrderNumber>
          <VersionID>sample string 6</VersionID>
          <Value>sample string 7</Value>
          <Match>true</Match>
          <Quantity>9</Quantity>
          <Rate>10</Rate>
          <Amount>11</Amount>
          <Tax>12</Tax>
          <DateCreated>sample string 13</DateCreated>
          <ModifiedOn>sample string 14</ModifiedOn>
          <VersionDetailID>sample string 1</VersionDetailID>
          <UnitMeasureCode>sample string 2</UnitMeasureCode>
          <UnitName>sample string 3</UnitName>
          <GroupQuantity>1</GroupQuantity>
        </InvoiceCheckServiceItemModel>
      </Service>
      <Postage>
        <InvoiceCheckPostageItemModel>
          <OrderID>sample string 2</OrderID>
          <OrderNumber>sample string 3</OrderNumber>
          <VersionID>sample string 4</VersionID>
          <Value>sample string 5</Value>
          <Match>true</Match>
          <Quantity>7</Quantity>
          <Rate>8</Rate>
          <Amount>9</Amount>
          <Tax>10</Tax>
          <DateCreated>sample string 11</DateCreated>
          <ModifiedOn>sample string 12</ModifiedOn>
          <VersionPostageID>sample string 1</VersionPostageID>
        </InvoiceCheckPostageItemModel>
        <InvoiceCheckPostageItemModel>
          <OrderID>sample string 2</OrderID>
          <OrderNumber>sample string 3</OrderNumber>
          <VersionID>sample string 4</VersionID>
          <Value>sample string 5</Value>
          <Match>true</Match>
          <Quantity>7</Quantity>
          <Rate>8</Rate>
          <Amount>9</Amount>
          <Tax>10</Tax>
          <DateCreated>sample string 11</DateCreated>
          <ModifiedOn>sample string 12</ModifiedOn>
          <VersionPostageID>sample string 1</VersionPostageID>
        </InvoiceCheckPostageItemModel>
      </Postage>
    </Orders>
  </OrderSection>
  <GroupBillingSection>
    <ChangesDetected>true</ChangesDetected>
  </GroupBillingSection>
</InvoiceCheckModel>