POST api/invoices/clientmessage

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
TotalRecords	integer	None.
RowNumber	integer	None.
Id	string	None.
InvoiceBatchId	string	None.
DatetimePosted	date	None.
DatetimePickup	date	None.
DatetimeDelivery	date	None.
AccountIdDebtor	string	None.
DebtorName	string	None.
DriverId	string	None.
DriverName	string	None.
InvoiceNumber	string	None.
LoadNumber	string	None.
LinehaulAmount	decimal number	None.
Amount	decimal number	None.
PickupLat	decimal number	None.
PickupLng	decimal number	None.
DeliveryLat	decimal number	None.
DeliveryLng	decimal number	None.
PickupFormattedAddress	string	None.
DeliveryFormattedAddress	string	None.
PickupZip	string	None.
DeliveryZip	string	None.
PickupState	string	None.
DeliveryState	string	None.
DistanceFormatted	string	None.
DurationFormatted	string	None.
Status	string	None.
TimeSpan	string	None.
StatusColor	string	None.
EquipmentType	string	None.
PickupAddress	string	None.
PickupCity	string	None.
PickupCounty	string	None.
PickupCountry	string	None.
DeliveryAddress	string	None.
DeliveryCity	string	None.
DeliveryCounty	string	None.
DeliveryCountry	string	None.
Distance	integer	None.
Duration	integer	None.
LessAdvancesAmount	decimal number	None.
DetentionAmount	decimal number	None.
LumperPaidAmount	decimal number	None.
PaidByEntity	string	None.
SecurityUserIdDriver	globally unique identifier	None.
charge_flag	boolean	None.
IsSelected	boolean	None.
Msg	string	None.
unapplied_payment_flag	boolean	None.
in_dispute	boolean	None.
in_dispute_reason	string	None.
balance	decimal number	None.
non_funded_flag	boolean	None.
asset_id	globally unique identifier	None.
asset_name	string	None.
InvoiceCharges	Collection of InvoiceTransactionDTO	None.
InvoiceDeductions	Collection of InvoiceTransactionDTO	None.
InvoiceDocuments	Collection of InvoiceDocumentDTO	None.

Request Formats

application/json, text/json

Sample:

{
  "TotalRecords": 1,
  "RowNumber": 1,
  "Id": "sample string 1",
  "InvoiceBatchId": "sample string 2",
  "DatetimePosted": "2025-12-11T19:48:55.313525-06:00",
  "DatetimePickup": "2025-12-11T19:48:55.313525-06:00",
  "DatetimeDelivery": "2025-12-11T19:48:55.313525-06:00",
  "AccountIdDebtor": "sample string 3",
  "DebtorName": "sample string 4",
  "DriverId": "sample string 5",
  "DriverName": "sample string 6",
  "InvoiceNumber": "sample string 7",
  "LoadNumber": "sample string 8",
  "LinehaulAmount": 1.0,
  "Amount": 1.0,
  "PickupLat": 1.0,
  "PickupLng": 1.0,
  "DeliveryLat": 1.0,
  "DeliveryLng": 1.0,
  "PickupFormattedAddress": "sample string 9",
  "DeliveryFormattedAddress": "sample string 10",
  "PickupZip": "sample string 11",
  "DeliveryZip": "sample string 12",
  "PickupState": "sample string 13",
  "DeliveryState": "sample string 14",
  "DistanceFormatted": "sample string 15",
  "DurationFormatted": "sample string 16",
  "Status": "sample string 17",
  "TimeSpan": "sample string 18",
  "StatusColor": "sample string 19",
  "EquipmentType": "sample string 20",
  "PickupAddress": "sample string 21",
  "PickupCity": "sample string 22",
  "PickupCounty": "sample string 23",
  "PickupCountry": "sample string 24",
  "DeliveryAddress": "sample string 25",
  "DeliveryCity": "sample string 26",
  "DeliveryCounty": "sample string 27",
  "DeliveryCountry": "sample string 28",
  "Distance": 1,
  "Duration": 1,
  "LessAdvancesAmount": 1.0,
  "DetentionAmount": 1.0,
  "LumperPaidAmount": 1.0,
  "PaidByEntity": "sample string 29",
  "SecurityUserIdDriver": "552e055b-b7b9-4d91-aa55-84e1df286cc8",
  "charge_flag": true,
  "IsSelected": true,
  "Msg": "sample string 31",
  "unapplied_payment_flag": true,
  "in_dispute": true,
  "in_dispute_reason": "sample string 32",
  "balance": 1.0,
  "non_funded_flag": true,
  "asset_id": "fa1f413e-9d5e-41c5-9972-6e4b9f905162",
  "asset_name": "sample string 33",
  "InvoiceCharges": [
    {
      "InvoiceTransactionId": "46ad65fd-e065-499b-b89f-4ba24c6385ae",
      "InvoiceId": "339ed7c2-1814-47c7-b0fe-9e51e8c5bcb5",
      "TransactionType": "sample string 3",
      "Name": "sample string 4",
      "Amount": 5.0
    },
    {
      "InvoiceTransactionId": "46ad65fd-e065-499b-b89f-4ba24c6385ae",
      "InvoiceId": "339ed7c2-1814-47c7-b0fe-9e51e8c5bcb5",
      "TransactionType": "sample string 3",
      "Name": "sample string 4",
      "Amount": 5.0
    }
  ],
  "InvoiceDeductions": [
    {
      "InvoiceTransactionId": "46ad65fd-e065-499b-b89f-4ba24c6385ae",
      "InvoiceId": "339ed7c2-1814-47c7-b0fe-9e51e8c5bcb5",
      "TransactionType": "sample string 3",
      "Name": "sample string 4",
      "Amount": 5.0
    },
    {
      "InvoiceTransactionId": "46ad65fd-e065-499b-b89f-4ba24c6385ae",
      "InvoiceId": "339ed7c2-1814-47c7-b0fe-9e51e8c5bcb5",
      "TransactionType": "sample string 3",
      "Name": "sample string 4",
      "Amount": 5.0
    }
  ],
  "InvoiceDocuments": [
    {
      "InvoiceDocumentId": "097e3e8a-8896-4056-b038-98b03871a803",
      "InvoiceId": "44917b7d-b1a9-4ca9-95b3-26c291c6a133",
      "DocumentType": "sample string 3",
      "ItemSort": 1,
      "DecompressDocument": true,
      "InvoiceAttachments": [
        {
          "InvoiceAttachmentId": "0aa8e603-cf91-4d09-9129-c5eb4f2fb8e7",
          "InvoiceDocumentId": "5f8c8308-0987-4505-abab-c933c9357a77",
          "FileName": "sample string 3",
          "Extension": "sample string 4",
          "Size": 1,
          "DatetimeCreated": "2025-12-11T19:48:55.313525-06:00",
          "Attachment": "QEA=",
          "TifFilePath": "sample string 6",
          "SecurityUserId": "d68c3e29-f83c-46dd-8b77-620339460ce5"
        },
        {
          "InvoiceAttachmentId": "0aa8e603-cf91-4d09-9129-c5eb4f2fb8e7",
          "InvoiceDocumentId": "5f8c8308-0987-4505-abab-c933c9357a77",
          "FileName": "sample string 3",
          "Extension": "sample string 4",
          "Size": 1,
          "DatetimeCreated": "2025-12-11T19:48:55.313525-06:00",
          "Attachment": "QEA=",
          "TifFilePath": "sample string 6",
          "SecurityUserId": "d68c3e29-f83c-46dd-8b77-620339460ce5"
        }
      ]
    },
    {
      "InvoiceDocumentId": "097e3e8a-8896-4056-b038-98b03871a803",
      "InvoiceId": "44917b7d-b1a9-4ca9-95b3-26c291c6a133",
      "DocumentType": "sample string 3",
      "ItemSort": 1,
      "DecompressDocument": true,
      "InvoiceAttachments": [
        {
          "InvoiceAttachmentId": "0aa8e603-cf91-4d09-9129-c5eb4f2fb8e7",
          "InvoiceDocumentId": "5f8c8308-0987-4505-abab-c933c9357a77",
          "FileName": "sample string 3",
          "Extension": "sample string 4",
          "Size": 1,
          "DatetimeCreated": "2025-12-11T19:48:55.313525-06:00",
          "Attachment": "QEA=",
          "TifFilePath": "sample string 6",
          "SecurityUserId": "d68c3e29-f83c-46dd-8b77-620339460ce5"
        },
        {
          "InvoiceAttachmentId": "0aa8e603-cf91-4d09-9129-c5eb4f2fb8e7",
          "InvoiceDocumentId": "5f8c8308-0987-4505-abab-c933c9357a77",
          "FileName": "sample string 3",
          "Extension": "sample string 4",
          "Size": 1,
          "DatetimeCreated": "2025-12-11T19:48:55.313525-06:00",
          "Attachment": "QEA=",
          "TifFilePath": "sample string 6",
          "SecurityUserId": "d68c3e29-f83c-46dd-8b77-620339460ce5"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<PSInvoiceListDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.DTO.Net">
  <AccountIdDebtor>sample string 3</AccountIdDebtor>
  <Amount>1</Amount>
  <DatetimeDelivery>2025-12-11T19:48:55.313525-06:00</DatetimeDelivery>
  <DatetimePickup>2025-12-11T19:48:55.313525-06:00</DatetimePickup>
  <DatetimePosted>2025-12-11T19:48:55.313525-06:00</DatetimePosted>
  <DebtorName>sample string 4</DebtorName>
  <DeliveryAddress>sample string 25</DeliveryAddress>
  <DeliveryCity>sample string 26</DeliveryCity>
  <DeliveryCountry>sample string 28</DeliveryCountry>
  <DeliveryCounty>sample string 27</DeliveryCounty>
  <DeliveryFormattedAddress>sample string 10</DeliveryFormattedAddress>
  <DeliveryLat>1</DeliveryLat>
  <DeliveryLng>1</DeliveryLng>
  <DeliveryState>sample string 14</DeliveryState>
  <DeliveryZip>sample string 12</DeliveryZip>
  <DetentionAmount>1</DetentionAmount>
  <Distance>1</Distance>
  <DistanceFormatted>sample string 15</DistanceFormatted>
  <DriverId>sample string 5</DriverId>
  <DriverName>sample string 6</DriverName>
  <Duration>1</Duration>
  <DurationFormatted>sample string 16</DurationFormatted>
  <EquipmentType>sample string 20</EquipmentType>
  <Id>sample string 1</Id>
  <InvoiceBatchId>sample string 2</InvoiceBatchId>
  <InvoiceCharges>
    <InvoiceTransactionDTO>
      <Amount>5</Amount>
      <InvoiceId>339ed7c2-1814-47c7-b0fe-9e51e8c5bcb5</InvoiceId>
      <InvoiceTransactionId>46ad65fd-e065-499b-b89f-4ba24c6385ae</InvoiceTransactionId>
      <Name>sample string 4</Name>
      <TransactionType>sample string 3</TransactionType>
    </InvoiceTransactionDTO>
    <InvoiceTransactionDTO>
      <Amount>5</Amount>
      <InvoiceId>339ed7c2-1814-47c7-b0fe-9e51e8c5bcb5</InvoiceId>
      <InvoiceTransactionId>46ad65fd-e065-499b-b89f-4ba24c6385ae</InvoiceTransactionId>
      <Name>sample string 4</Name>
      <TransactionType>sample string 3</TransactionType>
    </InvoiceTransactionDTO>
  </InvoiceCharges>
  <InvoiceDeductions>
    <InvoiceTransactionDTO>
      <Amount>5</Amount>
      <InvoiceId>339ed7c2-1814-47c7-b0fe-9e51e8c5bcb5</InvoiceId>
      <InvoiceTransactionId>46ad65fd-e065-499b-b89f-4ba24c6385ae</InvoiceTransactionId>
      <Name>sample string 4</Name>
      <TransactionType>sample string 3</TransactionType>
    </InvoiceTransactionDTO>
    <InvoiceTransactionDTO>
      <Amount>5</Amount>
      <InvoiceId>339ed7c2-1814-47c7-b0fe-9e51e8c5bcb5</InvoiceId>
      <InvoiceTransactionId>46ad65fd-e065-499b-b89f-4ba24c6385ae</InvoiceTransactionId>
      <Name>sample string 4</Name>
      <TransactionType>sample string 3</TransactionType>
    </InvoiceTransactionDTO>
  </InvoiceDeductions>
  <InvoiceDocuments>
    <InvoiceDocumentDTO>
      <DecompressDocument>true</DecompressDocument>
      <DocumentType>sample string 3</DocumentType>
      <InvoiceAttachments>
        <InvoiceAttachmentDTO>
          <Attachment>QEA=</Attachment>
          <DatetimeCreated>2025-12-11T19:48:55.313525-06:00</DatetimeCreated>
          <Extension>sample string 4</Extension>
          <FileName>sample string 3</FileName>
          <InvoiceAttachmentId>0aa8e603-cf91-4d09-9129-c5eb4f2fb8e7</InvoiceAttachmentId>
          <InvoiceDocumentId>5f8c8308-0987-4505-abab-c933c9357a77</InvoiceDocumentId>
          <SecurityUserId>d68c3e29-f83c-46dd-8b77-620339460ce5</SecurityUserId>
          <Size>1</Size>
          <TifFilePath>sample string 6</TifFilePath>
        </InvoiceAttachmentDTO>
        <InvoiceAttachmentDTO>
          <Attachment>QEA=</Attachment>
          <DatetimeCreated>2025-12-11T19:48:55.313525-06:00</DatetimeCreated>
          <Extension>sample string 4</Extension>
          <FileName>sample string 3</FileName>
          <InvoiceAttachmentId>0aa8e603-cf91-4d09-9129-c5eb4f2fb8e7</InvoiceAttachmentId>
          <InvoiceDocumentId>5f8c8308-0987-4505-abab-c933c9357a77</InvoiceDocumentId>
          <SecurityUserId>d68c3e29-f83c-46dd-8b77-620339460ce5</SecurityUserId>
          <Size>1</Size>
          <TifFilePath>sample string 6</TifFilePath>
        </InvoiceAttachmentDTO>
      </InvoiceAttachments>
      <InvoiceDocumentId>097e3e8a-8896-4056-b038-98b03871a803</InvoiceDocumentId>
      <InvoiceId>44917b7d-b1a9-4ca9-95b3-26c291c6a133</InvoiceId>
      <ItemSort>1</ItemSort>
    </InvoiceDocumentDTO>
    <InvoiceDocumentDTO>
      <DecompressDocument>true</DecompressDocument>
      <DocumentType>sample string 3</DocumentType>
      <InvoiceAttachments>
        <InvoiceAttachmentDTO>
          <Attachment>QEA=</Attachment>
          <DatetimeCreated>2025-12-11T19:48:55.313525-06:00</DatetimeCreated>
          <Extension>sample string 4</Extension>
          <FileName>sample string 3</FileName>
          <InvoiceAttachmentId>0aa8e603-cf91-4d09-9129-c5eb4f2fb8e7</InvoiceAttachmentId>
          <InvoiceDocumentId>5f8c8308-0987-4505-abab-c933c9357a77</InvoiceDocumentId>
          <SecurityUserId>d68c3e29-f83c-46dd-8b77-620339460ce5</SecurityUserId>
          <Size>1</Size>
          <TifFilePath>sample string 6</TifFilePath>
        </InvoiceAttachmentDTO>
        <InvoiceAttachmentDTO>
          <Attachment>QEA=</Attachment>
          <DatetimeCreated>2025-12-11T19:48:55.313525-06:00</DatetimeCreated>
          <Extension>sample string 4</Extension>
          <FileName>sample string 3</FileName>
          <InvoiceAttachmentId>0aa8e603-cf91-4d09-9129-c5eb4f2fb8e7</InvoiceAttachmentId>
          <InvoiceDocumentId>5f8c8308-0987-4505-abab-c933c9357a77</InvoiceDocumentId>
          <SecurityUserId>d68c3e29-f83c-46dd-8b77-620339460ce5</SecurityUserId>
          <Size>1</Size>
          <TifFilePath>sample string 6</TifFilePath>
        </InvoiceAttachmentDTO>
      </InvoiceAttachments>
      <InvoiceDocumentId>097e3e8a-8896-4056-b038-98b03871a803</InvoiceDocumentId>
      <InvoiceId>44917b7d-b1a9-4ca9-95b3-26c291c6a133</InvoiceId>
      <ItemSort>1</ItemSort>
    </InvoiceDocumentDTO>
  </InvoiceDocuments>
  <InvoiceNumber>sample string 7</InvoiceNumber>
  <IsSelected>true</IsSelected>
  <LessAdvancesAmount>1</LessAdvancesAmount>
  <LinehaulAmount>1</LinehaulAmount>
  <LoadNumber>sample string 8</LoadNumber>
  <LumperPaidAmount>1</LumperPaidAmount>
  <Msg>sample string 31</Msg>
  <PaidByEntity>sample string 29</PaidByEntity>
  <PickupAddress>sample string 21</PickupAddress>
  <PickupCity>sample string 22</PickupCity>
  <PickupCountry>sample string 24</PickupCountry>
  <PickupCounty>sample string 23</PickupCounty>
  <PickupFormattedAddress>sample string 9</PickupFormattedAddress>
  <PickupLat>1</PickupLat>
  <PickupLng>1</PickupLng>
  <PickupState>sample string 13</PickupState>
  <PickupZip>sample string 11</PickupZip>
  <RowNumber>1</RowNumber>
  <SecurityUserIdDriver>552e055b-b7b9-4d91-aa55-84e1df286cc8</SecurityUserIdDriver>
  <Status>sample string 17</Status>
  <StatusColor>sample string 19</StatusColor>
  <TimeSpan>sample string 18</TimeSpan>
  <TotalRecords>1</TotalRecords>
  <asset_id>fa1f413e-9d5e-41c5-9972-6e4b9f905162</asset_id>
  <asset_name>sample string 33</asset_name>
  <balance>1</balance>
  <charge_flag>true</charge_flag>
  <in_dispute>true</in_dispute>
  <in_dispute_reason>sample string 32</in_dispute_reason>
  <non_funded_flag>true</non_funded_flag>
  <unapplied_payment_flag>true</unapplied_payment_flag>
</PSInvoiceListDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

JsonResultOfAPIResponse

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

Response Formats

application/json, text/json

Sample:

Sample not available.