POST api/retention/send

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
dto	RetentionHeaderDTO	None.
Id	RetentionHeaderIdentity	None.
SendToPROWner	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "dto": {
    "retentionId": "sample string 1",
    "invoiceId": 1.0,
    "orgId": 1.0,
    "invoiceNum": "sample string 2",
    "invoiceTypeLookupCode": "sample string 3",
    "invoiceDate": "2025-12-15T04:59:37.933531+07:00",
    "glDate": "2025-12-15T04:59:37.933531+07:00",
    "description": "sample string 4",
    "source": "sample string 5",
    "vendorId": 1.0,
    "vendorNumber": "sample string 6",
    "vendorName": "sample string 7",
    "vendorSiteId": 1.0,
    "vendorSiteCode": "sample string 8",
    "partyId": 1.0,
    "partySiteId": 1.0,
    "retentionAmount": 1.0,
    "baseAmount": 1.0,
    "amountPaid": 1.0,
    "termsId": 1.0,
    "termName": "sample string 9",
    "termsDate": "2025-12-15T04:59:37.933531+07:00",
    "payGroupLookupCode": "sample string 10",
    "invoiceCurrencyCode": "sample string 11",
    "paymentCurrencyCode": "sample string 12",
    "paymentMethodCode": "sample string 13",
    "batchId": 1.0,
    "batchName": "sample string 14",
    "docSequenceId": 1.0,
    "docSequenceValue": 1.0,
    "docCategoryCode": "sample string 15",
    "wfapprovalStatus": "sample string 16",
    "setOfBooksId": 1.0,
    "legalEntityId": 1.0,
    "attribute1": "sample string 17",
    "attribute2": "sample string 18",
    "attribute3": "sample string 19",
    "attribute4": "sample string 20",
    "creationDate": "2025-12-15T04:59:37.9345324+07:00",
    "createdBy": 1.0,
    "lastUpdateDate": "2025-12-15T04:59:37.9345324+07:00",
    "lastUpdatedBy": 1.0,
    "lastUpdateLogin": 1.0,
    "status": "sample string 21",
    "retentionLineDTOs": [
      {
        "retentionId": "sample string 1",
        "lineNum": 2,
        "invoiceId": 1.0,
        "orgId": 1.0,
        "invoiceNum": "sample string 3",
        "invoiceTypeLookupCode": "sample string 4",
        "invoiceDate": "2025-12-15T04:59:37.9345324+07:00",
        "glDate": "2025-12-15T04:59:37.9345324+07:00",
        "description": "sample string 5",
        "source": "sample string 6",
        "vendorId": 1.0,
        "vendorNumber": "sample string 7",
        "vendorName": "sample string 8",
        "vendorSiteId": 1.0,
        "vendorSiteCode": "sample string 9",
        "partyId": 1.0,
        "partySiteId": 1.0,
        "invoiceAmount": 1.0,
        "amountPaid": 1.0,
        "termsId": 1.0,
        "termName": "sample string 10",
        "termsDate": "2025-12-15T04:59:37.9345324+07:00",
        "payGroupLookupCode": "sample string 11",
        "invoiceCurrencyCode": "sample string 12",
        "paymentCurrencyCode": "sample string 13",
        "paymentMethodCode": "sample string 14",
        "batchId": 1.0,
        "batchName": "sample string 15",
        "docSequenceId": 1.0,
        "docSequenceValue": 1.0,
        "docCategoryCode": "sample string 16",
        "wfapprovalStatus": "sample string 17",
        "setOfBooksId": 1.0,
        "legalEntityId": 1.0,
        "attribute1": "sample string 18",
        "attribute2": "sample string 19",
        "attribute3": "sample string 20",
        "attribute4": "sample string 21",
        "lineNumber": 1.0,
        "lineTypeLookupCode": "sample string 22",
        "lineDescription": "sample string 23",
        "lineAmount": 1.0,
        "taxClassificationCode": "sample string 24",
        "lineSource": "sample string 25",
        "accountingDate": "2025-12-15T04:59:37.9345324+07:00",
        "periodName": "sample string 26",
        "payAwtGroupId": 1.0,
        "lineWfapprovalStatus": "sample string 27",
        "matchType": "sample string 28",
        "discardedFlag": "sample string 29",
        "cancelledFlag": "sample string 30",
        "amountPaidKeyIn": 1.0
      },
      {
        "retentionId": "sample string 1",
        "lineNum": 2,
        "invoiceId": 1.0,
        "orgId": 1.0,
        "invoiceNum": "sample string 3",
        "invoiceTypeLookupCode": "sample string 4",
        "invoiceDate": "2025-12-15T04:59:37.9345324+07:00",
        "glDate": "2025-12-15T04:59:37.9345324+07:00",
        "description": "sample string 5",
        "source": "sample string 6",
        "vendorId": 1.0,
        "vendorNumber": "sample string 7",
        "vendorName": "sample string 8",
        "vendorSiteId": 1.0,
        "vendorSiteCode": "sample string 9",
        "partyId": 1.0,
        "partySiteId": 1.0,
        "invoiceAmount": 1.0,
        "amountPaid": 1.0,
        "termsId": 1.0,
        "termName": "sample string 10",
        "termsDate": "2025-12-15T04:59:37.9345324+07:00",
        "payGroupLookupCode": "sample string 11",
        "invoiceCurrencyCode": "sample string 12",
        "paymentCurrencyCode": "sample string 13",
        "paymentMethodCode": "sample string 14",
        "batchId": 1.0,
        "batchName": "sample string 15",
        "docSequenceId": 1.0,
        "docSequenceValue": 1.0,
        "docCategoryCode": "sample string 16",
        "wfapprovalStatus": "sample string 17",
        "setOfBooksId": 1.0,
        "legalEntityId": 1.0,
        "attribute1": "sample string 18",
        "attribute2": "sample string 19",
        "attribute3": "sample string 20",
        "attribute4": "sample string 21",
        "lineNumber": 1.0,
        "lineTypeLookupCode": "sample string 22",
        "lineDescription": "sample string 23",
        "lineAmount": 1.0,
        "taxClassificationCode": "sample string 24",
        "lineSource": "sample string 25",
        "accountingDate": "2025-12-15T04:59:37.9345324+07:00",
        "periodName": "sample string 26",
        "payAwtGroupId": 1.0,
        "lineWfapprovalStatus": "sample string 27",
        "matchType": "sample string 28",
        "discardedFlag": "sample string 29",
        "cancelledFlag": "sample string 30",
        "amountPaidKeyIn": 1.0
      }
    ],
    "rejectedReason": "sample string 22",
    "allowApprove": false,
    "allowEdit": false,
    "retentionDateTime": "2025-12-15T04:59:37.9345324+07:00",
    "prCreatedByEmployeeNumber": "sample string 23",
    "poNumber": "sample string 24",
    "supervisorApproveNumber": "sample string 25",
    "supervisorApproveDateTime": "2025-12-15T04:59:37.9345324+07:00",
    "accountApproveNumber": "sample string 26",
    "accountApproveDateTime": "2025-12-15T04:59:37.9345324+07:00",
    "prCreatedBy": "sample string 27"
  },
  "id": {
    "retentionId": "sample string 1",
    "deductionId": "sample string 2"
  },
  "sendToPROWner": true
}

application/xml, text/xml

Sample:

<CreateOrUpdateRetentionHeaderCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FashionIsland.Ebidding.Application">
  <Id xmlns:d2p1="http://schemas.datacontract.org/2004/07/FashionIsland.Ebidding.ViewModel">
    <d2p1:DeductionId>sample string 2</d2p1:DeductionId>
    <d2p1:RetentionId>sample string 1</d2p1:RetentionId>
  </Id>
  <SendToPROWner>true</SendToPROWner>
  <dto xmlns:d2p1="http://schemas.datacontract.org/2004/07/FashionIsland.Ebidding.ViewModel">
    <d2p1:AccountApproveDateTime>2025-12-15T04:59:37.9345324+07:00</d2p1:AccountApproveDateTime>
    <d2p1:AccountApproveNumber>sample string 26</d2p1:AccountApproveNumber>
    <d2p1:AmountPaid>1</d2p1:AmountPaid>
    <d2p1:Attribute1>sample string 17</d2p1:Attribute1>
    <d2p1:Attribute2>sample string 18</d2p1:Attribute2>
    <d2p1:Attribute3>sample string 19</d2p1:Attribute3>
    <d2p1:Attribute4>sample string 20</d2p1:Attribute4>
    <d2p1:BaseAmount>1</d2p1:BaseAmount>
    <d2p1:BatchId>1</d2p1:BatchId>
    <d2p1:BatchName>sample string 14</d2p1:BatchName>
    <d2p1:CreatedBy>1</d2p1:CreatedBy>
    <d2p1:CreationDate>2025-12-15T04:59:37.9345324+07:00</d2p1:CreationDate>
    <d2p1:Description>sample string 4</d2p1:Description>
    <d2p1:DocCategoryCode>sample string 15</d2p1:DocCategoryCode>
    <d2p1:DocSequenceId>1</d2p1:DocSequenceId>
    <d2p1:DocSequenceValue>1</d2p1:DocSequenceValue>
    <d2p1:GlDate>2025-12-15T04:59:37.933531+07:00</d2p1:GlDate>
    <d2p1:InvoiceCurrencyCode>sample string 11</d2p1:InvoiceCurrencyCode>
    <d2p1:InvoiceDate>2025-12-15T04:59:37.933531+07:00</d2p1:InvoiceDate>
    <d2p1:InvoiceId>1</d2p1:InvoiceId>
    <d2p1:InvoiceNum>sample string 2</d2p1:InvoiceNum>
    <d2p1:InvoiceTypeLookupCode>sample string 3</d2p1:InvoiceTypeLookupCode>
    <d2p1:LastUpdateDate>2025-12-15T04:59:37.9345324+07:00</d2p1:LastUpdateDate>
    <d2p1:LastUpdateLogin>1</d2p1:LastUpdateLogin>
    <d2p1:LastUpdatedBy>1</d2p1:LastUpdatedBy>
    <d2p1:LegalEntityId>1</d2p1:LegalEntityId>
    <d2p1:OrgId>1</d2p1:OrgId>
    <d2p1:PONumber>sample string 24</d2p1:PONumber>
    <d2p1:PRCreatedBy>sample string 27</d2p1:PRCreatedBy>
    <d2p1:PRCreatedByEmployeeNumber>sample string 23</d2p1:PRCreatedByEmployeeNumber>
    <d2p1:PartyId>1</d2p1:PartyId>
    <d2p1:PartySiteId>1</d2p1:PartySiteId>
    <d2p1:PayGroupLookupCode>sample string 10</d2p1:PayGroupLookupCode>
    <d2p1:PaymentCurrencyCode>sample string 12</d2p1:PaymentCurrencyCode>
    <d2p1:PaymentMethodCode>sample string 13</d2p1:PaymentMethodCode>
    <d2p1:RejectedReason>sample string 22</d2p1:RejectedReason>
    <d2p1:RetentionAmount>1</d2p1:RetentionAmount>
    <d2p1:RetentionDateTime>2025-12-15T04:59:37.9345324+07:00</d2p1:RetentionDateTime>
    <d2p1:RetentionId>sample string 1</d2p1:RetentionId>
    <d2p1:RetentionLineDTOs>
      <d2p1:RetentionLineDTO>
        <d2p1:AccountingDate>2025-12-15T04:59:37.9345324+07:00</d2p1:AccountingDate>
        <d2p1:AmountPaid>1</d2p1:AmountPaid>
        <d2p1:Attribute1>sample string 18</d2p1:Attribute1>
        <d2p1:Attribute2>sample string 19</d2p1:Attribute2>
        <d2p1:Attribute3>sample string 20</d2p1:Attribute3>
        <d2p1:Attribute4>sample string 21</d2p1:Attribute4>
        <d2p1:BatchId>1</d2p1:BatchId>
        <d2p1:BatchName>sample string 15</d2p1:BatchName>
        <d2p1:CancelledFlag>sample string 30</d2p1:CancelledFlag>
        <d2p1:Description>sample string 5</d2p1:Description>
        <d2p1:DiscardedFlag>sample string 29</d2p1:DiscardedFlag>
        <d2p1:DocCategoryCode>sample string 16</d2p1:DocCategoryCode>
        <d2p1:DocSequenceId>1</d2p1:DocSequenceId>
        <d2p1:DocSequenceValue>1</d2p1:DocSequenceValue>
        <d2p1:GlDate>2025-12-15T04:59:37.9345324+07:00</d2p1:GlDate>
        <d2p1:InvoiceAmount>1</d2p1:InvoiceAmount>
        <d2p1:InvoiceCurrencyCode>sample string 12</d2p1:InvoiceCurrencyCode>
        <d2p1:InvoiceDate>2025-12-15T04:59:37.9345324+07:00</d2p1:InvoiceDate>
        <d2p1:InvoiceId>1</d2p1:InvoiceId>
        <d2p1:InvoiceNum>sample string 3</d2p1:InvoiceNum>
        <d2p1:InvoiceTypeLookupCode>sample string 4</d2p1:InvoiceTypeLookupCode>
        <d2p1:LegalEntityId>1</d2p1:LegalEntityId>
        <d2p1:LineAmount>1</d2p1:LineAmount>
        <d2p1:LineDescription>sample string 23</d2p1:LineDescription>
        <d2p1:LineNum>2</d2p1:LineNum>
        <d2p1:LineNumber>1</d2p1:LineNumber>
        <d2p1:LineSource>sample string 25</d2p1:LineSource>
        <d2p1:LineTypeLookupCode>sample string 22</d2p1:LineTypeLookupCode>
        <d2p1:LineWfapprovalStatus>sample string 27</d2p1:LineWfapprovalStatus>
        <d2p1:MatchType>sample string 28</d2p1:MatchType>
        <d2p1:OrgId>1</d2p1:OrgId>
        <d2p1:PartyId>1</d2p1:PartyId>
        <d2p1:PartySiteId>1</d2p1:PartySiteId>
        <d2p1:PayAwtGroupId>1</d2p1:PayAwtGroupId>
        <d2p1:PayGroupLookupCode>sample string 11</d2p1:PayGroupLookupCode>
        <d2p1:PaymentCurrencyCode>sample string 13</d2p1:PaymentCurrencyCode>
        <d2p1:PaymentMethodCode>sample string 14</d2p1:PaymentMethodCode>
        <d2p1:PeriodName>sample string 26</d2p1:PeriodName>
        <d2p1:RetentionId>sample string 1</d2p1:RetentionId>
        <d2p1:SetOfBooksId>1</d2p1:SetOfBooksId>
        <d2p1:Source>sample string 6</d2p1:Source>
        <d2p1:TaxClassificationCode>sample string 24</d2p1:TaxClassificationCode>
        <d2p1:TermName>sample string 10</d2p1:TermName>
        <d2p1:TermsDate>2025-12-15T04:59:37.9345324+07:00</d2p1:TermsDate>
        <d2p1:TermsId>1</d2p1:TermsId>
        <d2p1:VendorId>1</d2p1:VendorId>
        <d2p1:VendorName>sample string 8</d2p1:VendorName>
        <d2p1:VendorNumber>sample string 7</d2p1:VendorNumber>
        <d2p1:VendorSiteCode>sample string 9</d2p1:VendorSiteCode>
        <d2p1:VendorSiteId>1</d2p1:VendorSiteId>
        <d2p1:WfapprovalStatus>sample string 17</d2p1:WfapprovalStatus>
      </d2p1:RetentionLineDTO>
      <d2p1:RetentionLineDTO>
        <d2p1:AccountingDate>2025-12-15T04:59:37.9345324+07:00</d2p1:AccountingDate>
        <d2p1:AmountPaid>1</d2p1:AmountPaid>
        <d2p1:Attribute1>sample string 18</d2p1:Attribute1>
        <d2p1:Attribute2>sample string 19</d2p1:Attribute2>
        <d2p1:Attribute3>sample string 20</d2p1:Attribute3>
        <d2p1:Attribute4>sample string 21</d2p1:Attribute4>
        <d2p1:BatchId>1</d2p1:BatchId>
        <d2p1:BatchName>sample string 15</d2p1:BatchName>
        <d2p1:CancelledFlag>sample string 30</d2p1:CancelledFlag>
        <d2p1:Description>sample string 5</d2p1:Description>
        <d2p1:DiscardedFlag>sample string 29</d2p1:DiscardedFlag>
        <d2p1:DocCategoryCode>sample string 16</d2p1:DocCategoryCode>
        <d2p1:DocSequenceId>1</d2p1:DocSequenceId>
        <d2p1:DocSequenceValue>1</d2p1:DocSequenceValue>
        <d2p1:GlDate>2025-12-15T04:59:37.9345324+07:00</d2p1:GlDate>
        <d2p1:InvoiceAmount>1</d2p1:InvoiceAmount>
        <d2p1:InvoiceCurrencyCode>sample string 12</d2p1:InvoiceCurrencyCode>
        <d2p1:InvoiceDate>2025-12-15T04:59:37.9345324+07:00</d2p1:InvoiceDate>
        <d2p1:InvoiceId>1</d2p1:InvoiceId>
        <d2p1:InvoiceNum>sample string 3</d2p1:InvoiceNum>
        <d2p1:InvoiceTypeLookupCode>sample string 4</d2p1:InvoiceTypeLookupCode>
        <d2p1:LegalEntityId>1</d2p1:LegalEntityId>
        <d2p1:LineAmount>1</d2p1:LineAmount>
        <d2p1:LineDescription>sample string 23</d2p1:LineDescription>
        <d2p1:LineNum>2</d2p1:LineNum>
        <d2p1:LineNumber>1</d2p1:LineNumber>
        <d2p1:LineSource>sample string 25</d2p1:LineSource>
        <d2p1:LineTypeLookupCode>sample string 22</d2p1:LineTypeLookupCode>
        <d2p1:LineWfapprovalStatus>sample string 27</d2p1:LineWfapprovalStatus>
        <d2p1:MatchType>sample string 28</d2p1:MatchType>
        <d2p1:OrgId>1</d2p1:OrgId>
        <d2p1:PartyId>1</d2p1:PartyId>
        <d2p1:PartySiteId>1</d2p1:PartySiteId>
        <d2p1:PayAwtGroupId>1</d2p1:PayAwtGroupId>
        <d2p1:PayGroupLookupCode>sample string 11</d2p1:PayGroupLookupCode>
        <d2p1:PaymentCurrencyCode>sample string 13</d2p1:PaymentCurrencyCode>
        <d2p1:PaymentMethodCode>sample string 14</d2p1:PaymentMethodCode>
        <d2p1:PeriodName>sample string 26</d2p1:PeriodName>
        <d2p1:RetentionId>sample string 1</d2p1:RetentionId>
        <d2p1:SetOfBooksId>1</d2p1:SetOfBooksId>
        <d2p1:Source>sample string 6</d2p1:Source>
        <d2p1:TaxClassificationCode>sample string 24</d2p1:TaxClassificationCode>
        <d2p1:TermName>sample string 10</d2p1:TermName>
        <d2p1:TermsDate>2025-12-15T04:59:37.9345324+07:00</d2p1:TermsDate>
        <d2p1:TermsId>1</d2p1:TermsId>
        <d2p1:VendorId>1</d2p1:VendorId>
        <d2p1:VendorName>sample string 8</d2p1:VendorName>
        <d2p1:VendorNumber>sample string 7</d2p1:VendorNumber>
        <d2p1:VendorSiteCode>sample string 9</d2p1:VendorSiteCode>
        <d2p1:VendorSiteId>1</d2p1:VendorSiteId>
        <d2p1:WfapprovalStatus>sample string 17</d2p1:WfapprovalStatus>
      </d2p1:RetentionLineDTO>
    </d2p1:RetentionLineDTOs>
    <d2p1:SetOfBooksId>1</d2p1:SetOfBooksId>
    <d2p1:Source>sample string 5</d2p1:Source>
    <d2p1:Status>sample string 21</d2p1:Status>
    <d2p1:SupervisorApproveDateTime>2025-12-15T04:59:37.9345324+07:00</d2p1:SupervisorApproveDateTime>
    <d2p1:SupervisorApproveNumber>sample string 25</d2p1:SupervisorApproveNumber>
    <d2p1:TermName>sample string 9</d2p1:TermName>
    <d2p1:TermsDate>2025-12-15T04:59:37.933531+07:00</d2p1:TermsDate>
    <d2p1:TermsId>1</d2p1:TermsId>
    <d2p1:VendorId>1</d2p1:VendorId>
    <d2p1:VendorName>sample string 7</d2p1:VendorName>
    <d2p1:VendorNumber>sample string 6</d2p1:VendorNumber>
    <d2p1:VendorSiteCode>sample string 8</d2p1:VendorSiteCode>
    <d2p1:VendorSiteId>1</d2p1:VendorSiteId>
    <d2p1:WfapprovalStatus>sample string 16</d2p1:WfapprovalStatus>
  </dto>
</CreateOrUpdateRetentionHeaderCommand>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

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.