POST api/Vendor/ImportInvoice

Request Information

URI Parameters

None.

Body Parameters

VendorInvoiceImportParm
NameDescriptionTypeAdditional information
UserGUID

string

None.

VendorKey

string

None.

InvoiceNumber

string

None.

InvoiceDate

date

None.

InvoiceDue

date

None.

CurrencyID

string

None.

Items

Collection of VendorInvoiceImportItem

None.

Request Formats

application/json, text/json

Sample:
{
  "UserGUID": "sample string 1",
  "VendorKey": "sample string 2",
  "InvoiceNumber": "sample string 3",
  "InvoiceDate": "2024-09-19T09:13:53.9958571+00:00",
  "InvoiceDue": "2024-09-19T09:13:53.9958571+00:00",
  "CurrencyID": "sample string 6",
  "Items": [
    {
      "ItemKeyValue": "sample string 1",
      "ItemKeyType": "sample string 2",
      "InvoiceAmount": 3.0,
      "InvoiceAmountTax": 4.0
    },
    {
      "ItemKeyValue": "sample string 1",
      "ItemKeyType": "sample string 2",
      "InvoiceAmount": 3.0,
      "InvoiceAmountTax": 4.0
    }
  ]
}

application/xml, text/xml

Sample:
<VendorInvoiceImportParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <CurrencyID>sample string 6</CurrencyID>
  <InvoiceDate>2024-09-19T09:13:53.9958571+00:00</InvoiceDate>
  <InvoiceDue>2024-09-19T09:13:53.9958571+00:00</InvoiceDue>
  <InvoiceNumber>sample string 3</InvoiceNumber>
  <Items>
    <VendorInvoiceImportItem>
      <InvoiceAmount>3</InvoiceAmount>
      <InvoiceAmountTax>4</InvoiceAmountTax>
      <ItemKeyType>sample string 2</ItemKeyType>
      <ItemKeyValue>sample string 1</ItemKeyValue>
    </VendorInvoiceImportItem>
    <VendorInvoiceImportItem>
      <InvoiceAmount>3</InvoiceAmount>
      <InvoiceAmountTax>4</InvoiceAmountTax>
      <ItemKeyType>sample string 2</ItemKeyType>
      <ItemKeyValue>sample string 1</ItemKeyValue>
    </VendorInvoiceImportItem>
  </Items>
  <UserGUID>sample string 1</UserGUID>
  <VendorKey>sample string 2</VendorKey>
</VendorInvoiceImportParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VendorInvoiceImportResp
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.

ErrorMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:
<VendorInvoiceImportResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</VendorInvoiceImportResp>