POST api/Retention/Create

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RetentionId	string	None.
InvoiceId	decimal number	None.
OrgId	decimal number	None.
InvoiceNum	string	None.
InvoiceTypeLookupCode	string	None.
InvoiceDate	date	None.
GlDate	date	None.
Description	string	None.
Source	string	None.
VendorId	decimal number	None.
VendorNumber	string	None.
VendorName	string	None.
VendorSiteId	decimal number	None.
VendorSiteCode	string	None.
PartyId	decimal number	None.
PartySiteId	decimal number	None.
RetentionAmount	decimal number	None.
BaseAmount	decimal number	None.
AmountPaid	decimal number	None.
TermsId	decimal number	None.
TermName	string	None.
TermsDate	date	None.
PayGroupLookupCode	string	None.
InvoiceCurrencyCode	string	None.
PaymentCurrencyCode	string	None.
PaymentMethodCode	string	None.
BatchId	decimal number	None.
BatchName	string	None.
DocSequenceId	decimal number	None.
DocSequenceValue	decimal number	None.
DocCategoryCode	string	None.
WfapprovalStatus	string	None.
SetOfBooksId	decimal number	None.
LegalEntityId	decimal number	None.
Attribute1	string	None.
Attribute2	string	None.
Attribute3	string	None.
Attribute4	string	None.
CreationDate	date	None.
CreatedBy	decimal number	None.
LastUpdateDate	date	None.
LastUpdatedBy	decimal number	None.
LastUpdateLogin	decimal number	None.
Status	string	None.
RetentionLineDTOs	Collection of RetentionLineDTO	None.
RejectedReason	string	None.
AllowApprove	boolean	None.
AllowEdit	boolean	None.
RetentionDateTime	date	None.
PRCreatedByEmployeeNumber	string	None.
PONumber	string	None.
SupervisorApproveNumber	string	None.
SupervisorApproveDateTime	date	None.
AccountApproveNumber	string	None.
AccountApproveDateTime	date	None.
PRCreatedBy	string	None.

Request Formats

application/json, text/json

Sample:

{
  "retentionId": "sample string 1",
  "invoiceId": 1.0,
  "orgId": 1.0,
  "invoiceNum": "sample string 2",
  "invoiceTypeLookupCode": "sample string 3",
  "invoiceDate": "2025-12-15T04:57:06.7337702+07:00",
  "glDate": "2025-12-15T04:57:06.7337702+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:57:06.7347672+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:57:06.736756+07:00",
  "createdBy": 1.0,
  "lastUpdateDate": "2025-12-15T04:57:06.736756+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:57:06.7397534+07:00",
      "glDate": "2025-12-15T04:57:06.7397534+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:57:06.7427563+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:57:06.7447643+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:57:06.7397534+07:00",
      "glDate": "2025-12-15T04:57:06.7397534+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:57:06.7427563+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:57:06.7447643+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:57:06.7457555+07:00",
  "prCreatedByEmployeeNumber": "sample string 23",
  "poNumber": "sample string 24",
  "supervisorApproveNumber": "sample string 25",
  "supervisorApproveDateTime": "2025-12-15T04:57:06.7457555+07:00",
  "accountApproveNumber": "sample string 26",
  "accountApproveDateTime": "2025-12-15T04:57:06.7457555+07:00",
  "prCreatedBy": "sample string 27"
}

application/xml, text/xml

Sample:

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

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.