POST api/actions/GenerateInvoice/{orderID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderID

integer

Required

Body Parameters

InvoiceGen
NameDescriptionTypeAdditional information
invoiceType

character

None.

invoiceComment

string

None.

Request Formats

application/json, text/json

Sample:
{
  "invoiceType": "A",
  "invoiceComment": "sample string 2"
}

application/xml, text/xml

Sample:
<InvoiceGen xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility">
  <invoiceComment>sample string 2</invoiceComment>
  <invoiceType>65</invoiceType>
</InvoiceGen>

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

Response Information

Resource Description

UpsertRetBillingOfchgInvoiceDb
NameDescriptionTypeAdditional information
BillInvoiceUpdate

BillInvoiceUpdate

None.

StatusUpdate

StatusUpdate

None.

returnID

integer

None.

results

Collection of ValidationResult

None.

returnItem

chgInvoiceDb

None.

displayMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "BillInvoiceUpdate": {
    "BilledStatusChanged": true,
    "BilledStatus": 510,
    "InvoiceStatusChanged": true,
    "InvoiceStatus": 710
  },
  "StatusUpdate": {
    "LegsUpdated": 1,
    "AlertsUpdated": 2,
    "ForwardingStatusChanged": true,
    "ForwardingStatus": 310
  },
  "returnID": 1,
  "results": null,
  "returnItem": {
    "results": null,
    "InvoiceID": 1,
    "InvoiceNumber": "sample string 2",
    "InvoiceType": "A",
    "ClientID": 4,
    "WarehouseID": 64,
    "OrderID": 1,
    "DocumentID": 1,
    "FreightCalculatorID": 1,
    "InvoiceDate": "2025-12-06T23:37:05.1877439+00:00",
    "InvoiceAmount": 7.0,
    "InvoicePostingDate": "2025-12-06T23:37:05.1877439+00:00",
    "PostedByUserID": 9,
    "CreatedByUserID": 10,
    "InvoiceVoidedDate": "2025-12-06T23:37:05.1877439+00:00",
    "VoidedByUserID": 1,
    "IsActive": true,
    "Voided": true,
    "QBXfer": true,
    "QBXferDate": "2025-12-06T23:37:05.1877439+00:00",
    "SummaryFilePath": "sample string 11",
    "DetailFilePath": "sample string 12",
    "CreatedBy": 13,
    "CreatedDate": "2025-12-06T23:37:05.1877439+00:00",
    "UpdatedBy": 15,
    "UpdatedDate": "2025-12-06T23:37:05.1877439+00:00",
    "FBInvoiceID": 1
  },
  "displayMessage": "sample string 1"
}

application/xml, text/xml

Sample:
<UpsertRetBillingOfchgInvoiceDb66KPc_SrH xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
  <displayMessage xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility">sample string 1</displayMessage>
  <results xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility" />
  <returnID xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility">1</returnID>
  <returnItem xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Data.Tables" xmlns="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility">
    <results xmlns:d3p1="http://schemas.datacontract.org/2004/07/System.ComponentModel.DataAnnotations" i:nil="true" />
    <d2p1:ClientID>4</d2p1:ClientID>
    <d2p1:CreatedBy>13</d2p1:CreatedBy>
    <d2p1:CreatedByUserID>10</d2p1:CreatedByUserID>
    <d2p1:CreatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:37:05.1877439Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:CreatedDate>
    <d2p1:DetailFilePath>sample string 12</d2p1:DetailFilePath>
    <d2p1:DocumentID>1</d2p1:DocumentID>
    <d2p1:FBInvoiceID>1</d2p1:FBInvoiceID>
    <d2p1:FreightCalculatorID>1</d2p1:FreightCalculatorID>
    <d2p1:InvoiceAmount>7</d2p1:InvoiceAmount>
    <d2p1:InvoiceDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:37:05.1877439Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:InvoiceDate>
    <d2p1:InvoiceID>1</d2p1:InvoiceID>
    <d2p1:InvoiceNumber>sample string 2</d2p1:InvoiceNumber>
    <d2p1:InvoicePostingDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:37:05.1877439Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:InvoicePostingDate>
    <d2p1:InvoiceType>65</d2p1:InvoiceType>
    <d2p1:InvoiceVoidedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:37:05.1877439Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:InvoiceVoidedDate>
    <d2p1:IsActive>true</d2p1:IsActive>
    <d2p1:OrderID>1</d2p1:OrderID>
    <d2p1:PostedByUserID>9</d2p1:PostedByUserID>
    <d2p1:QBXfer>true</d2p1:QBXfer>
    <d2p1:QBXferDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:37:05.1877439Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:QBXferDate>
    <d2p1:SummaryFilePath>sample string 11</d2p1:SummaryFilePath>
    <d2p1:UpdatedBy>15</d2p1:UpdatedBy>
    <d2p1:UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2025-12-06T23:37:05.1877439Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:UpdatedDate>
    <d2p1:Voided>true</d2p1:Voided>
    <d2p1:VoidedByUserID>1</d2p1:VoidedByUserID>
    <d2p1:WarehouseID>64</d2p1:WarehouseID>
  </returnItem>
  <BillInvoiceUpdate xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility">
    <d2p1:BilledStatus>PendingEntry</d2p1:BilledStatus>
    <d2p1:BilledStatusChanged>true</d2p1:BilledStatusChanged>
    <d2p1:InvoiceStatus>PendingApproval</d2p1:InvoiceStatus>
    <d2p1:InvoiceStatusChanged>true</d2p1:InvoiceStatusChanged>
  </BillInvoiceUpdate>
  <StatusUpdate xmlns:d2p1="http://schemas.datacontract.org/2004/07/WebAPI.Data.Utility">
    <d2p1:AlertsUpdated>2</d2p1:AlertsUpdated>
    <d2p1:ForwardingStatus>Building</d2p1:ForwardingStatus>
    <d2p1:ForwardingStatusChanged>true</d2p1:ForwardingStatusChanged>
    <d2p1:LegsUpdated>1</d2p1:LegsUpdated>
  </StatusUpdate>
</UpsertRetBillingOfchgInvoiceDb66KPc_SrH>