POST api/Submission/AddInvoice

Add an invoice record to an in-progress submission. This information will not get processed until CompleteSubmission is called.

Request Information

URI Parameters

None.

Body Parameters

The invoice object to add to the consumer record.

InvoiceViewModel

Name	Type	Additional information
InvoiceID	integer	None.
SubmissionID	globally unique identifier	None.
Retailer	string	None.
InvoiceDate	date	None.
InvoiceNumber	string	None.
Files	Collection of InvoiceFileViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "InvoiceID": 1,
  "SubmissionID": "02eab93c-714b-44c3-a996-da8b6133fa4e",
  "Retailer": "sample string 3",
  "InvoiceDate": "2025-01-09T19:48:26.6697373-06:00",
  "InvoiceNumber": "sample string 5",
  "Files": [
    {
      "FileName": "sample string 1",
      "DataURL": "sample string 2",
      "SubmissionID": "b473ed66-bd09-4b2b-bc40-1c27b25f30f9"
    },
    {
      "FileName": "sample string 1",
      "DataURL": "sample string 2",
      "SubmissionID": "b473ed66-bd09-4b2b-bc40-1c27b25f30f9"
    }
  ]
}

application/xml, text/xml

Sample:

<InvoiceViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SubmissionAPI.Models">
  <Files>
    <InvoiceFileViewModel>
      <DataURL>sample string 2</DataURL>
      <FileName>sample string 1</FileName>
      <SubmissionID>b473ed66-bd09-4b2b-bc40-1c27b25f30f9</SubmissionID>
    </InvoiceFileViewModel>
    <InvoiceFileViewModel>
      <DataURL>sample string 2</DataURL>
      <FileName>sample string 1</FileName>
      <SubmissionID>b473ed66-bd09-4b2b-bc40-1c27b25f30f9</SubmissionID>
    </InvoiceFileViewModel>
  </Files>
  <InvoiceDate>2025-01-09T19:48:26.6697373-06:00</InvoiceDate>
  <InvoiceID>1</InvoiceID>
  <InvoiceNumber>sample string 5</InvoiceNumber>
  <Retailer>sample string 3</Retailer>
  <SubmissionID>02eab93c-714b-44c3-a996-da8b6133fa4e</SubmissionID>
</InvoiceViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A response model indicating success or failure and a list of errors as applicable.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.