POST api/AgencyMatching/Complete

Request Information

URI Parameters

None.

Body Parameters

AgencyMatchRequest
NameDescriptionTypeAdditional information
AgencyVendorID

string

None.

CdcDocumentNo

string

None.

VendorInvoiceNmbr

string

None.

InvoiceAmount

decimal number

None.

OverrideAmount

decimal number

None.

OverrideReason

string

None.

UserName

string

None.

LineIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "AgencyVendorID": "sample string 1",
  "CdcDocumentNo": "sample string 2",
  "VendorInvoiceNmbr": "sample string 3",
  "InvoiceAmount": 4.0,
  "OverrideAmount": 1.0,
  "OverrideReason": "sample string 5",
  "UserName": "sample string 6",
  "LineIds": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<AgencyMatchingModels.AgencyMatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
  <AgencyVendorID>sample string 1</AgencyVendorID>
  <CdcDocumentNo>sample string 2</CdcDocumentNo>
  <InvoiceAmount>4</InvoiceAmount>
  <LineIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </LineIds>
  <OverrideAmount>1</OverrideAmount>
  <OverrideReason>sample string 5</OverrideReason>
  <UserName>sample string 6</UserName>
  <VendorInvoiceNmbr>sample string 3</VendorInvoiceNmbr>
</AgencyMatchingModels.AgencyMatchRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AgencyMatchResult
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

AgencyMatchID

integer

None.

VoucherNmbr

string

None.

LinesTotal

decimal number

None.

YourReferenceWritten

boolean

None.

Warning

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "AgencyMatchID": 3,
  "VoucherNmbr": "sample string 4",
  "LinesTotal": 5.0,
  "YourReferenceWritten": true,
  "Warning": "sample string 7"
}

application/xml, text/xml

Sample:
<AgencyMatchingModels.AgencyMatchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
  <AgencyMatchID>3</AgencyMatchID>
  <LinesTotal>5</LinesTotal>
  <Message>sample string 2</Message>
  <Success>true</Success>
  <VoucherNmbr>sample string 4</VoucherNmbr>
  <Warning>sample string 7</Warning>
  <YourReferenceWritten>true</YourReferenceWritten>
</AgencyMatchingModels.AgencyMatchResult>