POST api/invoices/document

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
InvoiceDocumentId	globally unique identifier	None.
InvoiceId	globally unique identifier	None.
DocumentType	string	None.
ItemSort	integer	None.
DecompressDocument	boolean	None.
InvoiceAttachments	Collection of InvoiceAttachmentDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "InvoiceDocumentId": "593c6be5-61bf-4535-b1ae-349590727a02",
  "InvoiceId": "5581e86e-1999-4101-8bcf-87f119534974",
  "DocumentType": "sample string 3",
  "ItemSort": 1,
  "DecompressDocument": true,
  "InvoiceAttachments": [
    {
      "InvoiceAttachmentId": "a419dccd-c613-44bf-bccd-91794201371c",
      "InvoiceDocumentId": "9e594748-98c8-4d3f-97ff-dddde5c76caf",
      "FileName": "sample string 3",
      "Extension": "sample string 4",
      "Size": 1,
      "DatetimeCreated": "2024-09-19T10:17:04.3509525-05:00",
      "Attachment": "QEA=",
      "TifFilePath": "sample string 6",
      "SecurityUserId": "35704ef0-0742-4ab7-8fcd-197c42cb5201"
    },
    {
      "InvoiceAttachmentId": "a419dccd-c613-44bf-bccd-91794201371c",
      "InvoiceDocumentId": "9e594748-98c8-4d3f-97ff-dddde5c76caf",
      "FileName": "sample string 3",
      "Extension": "sample string 4",
      "Size": 1,
      "DatetimeCreated": "2024-09-19T10:17:04.3509525-05:00",
      "Attachment": "QEA=",
      "TifFilePath": "sample string 6",
      "SecurityUserId": "35704ef0-0742-4ab7-8fcd-197c42cb5201"
    }
  ]
}

application/xml, text/xml

Sample:

<InvoiceDocumentDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.DTO">
  <DecompressDocument>true</DecompressDocument>
  <DocumentType>sample string 3</DocumentType>
  <InvoiceAttachments>
    <InvoiceAttachmentDTO>
      <Attachment>QEA=</Attachment>
      <DatetimeCreated>2024-09-19T10:17:04.3509525-05:00</DatetimeCreated>
      <Extension>sample string 4</Extension>
      <FileName>sample string 3</FileName>
      <InvoiceAttachmentId>a419dccd-c613-44bf-bccd-91794201371c</InvoiceAttachmentId>
      <InvoiceDocumentId>9e594748-98c8-4d3f-97ff-dddde5c76caf</InvoiceDocumentId>
      <SecurityUserId>35704ef0-0742-4ab7-8fcd-197c42cb5201</SecurityUserId>
      <Size>1</Size>
      <TifFilePath>sample string 6</TifFilePath>
    </InvoiceAttachmentDTO>
    <InvoiceAttachmentDTO>
      <Attachment>QEA=</Attachment>
      <DatetimeCreated>2024-09-19T10:17:04.3509525-05:00</DatetimeCreated>
      <Extension>sample string 4</Extension>
      <FileName>sample string 3</FileName>
      <InvoiceAttachmentId>a419dccd-c613-44bf-bccd-91794201371c</InvoiceAttachmentId>
      <InvoiceDocumentId>9e594748-98c8-4d3f-97ff-dddde5c76caf</InvoiceDocumentId>
      <SecurityUserId>35704ef0-0742-4ab7-8fcd-197c42cb5201</SecurityUserId>
      <Size>1</Size>
      <TifFilePath>sample string 6</TifFilePath>
    </InvoiceAttachmentDTO>
  </InvoiceAttachments>
  <InvoiceDocumentId>593c6be5-61bf-4535-b1ae-349590727a02</InvoiceDocumentId>
  <InvoiceId>5581e86e-1999-4101-8bcf-87f119534974</InvoiceId>
  <ItemSort>1</ItemSort>
</InvoiceDocumentDTO>

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 'InvoiceDocumentDTO'.

Response Information

Resource Description

JsonResultOfBoolean

Name	Type	Additional information
Content	boolean	None.
SerializerSettings	JsonSerializerSettings	None.
Encoding	Encoding	None.
Request	HttpRequestMessage	None.

Response Formats

application/json, text/json

Sample:

Sample not available.