POST api/Subcontracts/{subcontractId}/Claim
Create subcontract claim.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| subcontractId |
Subcontract identifier |
integer |
Required |
Body Parameters
New claim params.
ClaimDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| SubcontractId | integer |
None. |
|
| Code | string |
None. |
|
| Description | string |
None. |
|
| TypeId | integer |
None. |
|
| TypeDescription | string |
None. |
|
| StatusDescription | string |
None. |
|
| Origin | Collection of ClaimLetterRefFewoDto |
None. |
|
| OriginDesc | string |
None. |
|
| ClaimedAmount | decimal number |
None. |
|
| SettledAmount | decimal number |
None. |
|
| PendingAmount | decimal number |
None. |
|
| ReplyLetterRef | Collection of ClaimLetterRefFewoDto |
None. |
|
| ReplyLetterRefDesc | string |
None. |
|
| CovidRelatedId | integer |
None. |
|
| CovidRelatedDescription | string |
None. |
|
| StatusId | integer |
None. |
|
| FinalSettRef | string |
None. |
|
| Notes | string |
None. |
|
| RejectNotes | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"id": 1,
"subcontractId": 1,
"code": "sample string 2",
"description": "sample string 3",
"typeId": 4,
"typeDescription": "sample string 5",
"statusDescription": "sample string 6",
"origin": [
{
"id": 1,
"entityCode": "sample string 2",
"entityTypeId": 1,
"entityTypeDescription": "Sfr",
"issueDate": "2026-05-09T14:07:06.5141418+02:00",
"description": "sample string 4",
"claimLetterRefFewoTypeId": 1
},
{
"id": 1,
"entityCode": "sample string 2",
"entityTypeId": 1,
"entityTypeDescription": "Sfr",
"issueDate": "2026-05-09T14:07:06.5141418+02:00",
"description": "sample string 4",
"claimLetterRefFewoTypeId": 1
}
],
"originDesc": "sample string 7",
"claimedAmount": 1.0,
"settledAmount": 1.0,
"pendingAmount": 1.0,
"replyLetterRef": [
{
"id": 1,
"entityCode": "sample string 2",
"entityTypeId": 1,
"entityTypeDescription": "Sfr",
"issueDate": "2026-05-09T14:07:06.5141418+02:00",
"description": "sample string 4",
"claimLetterRefFewoTypeId": 1
},
{
"id": 1,
"entityCode": "sample string 2",
"entityTypeId": 1,
"entityTypeDescription": "Sfr",
"issueDate": "2026-05-09T14:07:06.5141418+02:00",
"description": "sample string 4",
"claimLetterRefFewoTypeId": 1
}
],
"replyLetterRefDesc": "sample string 8",
"covidRelatedId": 1,
"covidRelatedDescription": "sample string 9",
"statusId": 10,
"finalSettRef": "sample string 11",
"notes": "sample string 12",
"rejectNotes": "sample string 13"
}
text/html
Sample:
{"id":1,"subcontractId":1,"code":"sample string 2","description":"sample string 3","typeId":4,"typeDescription":"sample string 5","statusDescription":"sample string 6","origin":[{"id":1,"entityCode":"sample string 2","entityTypeId":1,"entityTypeDescription":"Sfr","issueDate":"2026-05-09T14:07:06.5141418+02:00","description":"sample string 4","claimLetterRefFewoTypeId":1},{"id":1,"entityCode":"sample string 2","entityTypeId":1,"entityTypeDescription":"Sfr","issueDate":"2026-05-09T14:07:06.5141418+02:00","description":"sample string 4","claimLetterRefFewoTypeId":1}],"originDesc":"sample string 7","claimedAmount":1.0,"settledAmount":1.0,"pendingAmount":1.0,"replyLetterRef":[{"id":1,"entityCode":"sample string 2","entityTypeId":1,"entityTypeDescription":"Sfr","issueDate":"2026-05-09T14:07:06.5141418+02:00","description":"sample string 4","claimLetterRefFewoTypeId":1},{"id":1,"entityCode":"sample string 2","entityTypeId":1,"entityTypeDescription":"Sfr","issueDate":"2026-05-09T14:07:06.5141418+02:00","description":"sample string 4","claimLetterRefFewoTypeId":1}],"replyLetterRefDesc":"sample string 8","covidRelatedId":1,"covidRelatedDescription":"sample string 9","statusId":10,"finalSettRef":"sample string 11","notes":"sample string 12","rejectNotes":"sample string 13"}
application/xml, text/xml
Sample:
<ClaimDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.ClaimAgg">
<ClaimedAmount>1</ClaimedAmount>
<Code>sample string 2</Code>
<CovidRelatedDescription>sample string 9</CovidRelatedDescription>
<CovidRelatedId>1</CovidRelatedId>
<Description>sample string 3</Description>
<FinalSettRef>sample string 11</FinalSettRef>
<Id>1</Id>
<Notes>sample string 12</Notes>
<Origin>
<ClaimLetterRefFewoDto>
<ClaimLetterRefFewoTypeId>Origin</ClaimLetterRefFewoTypeId>
<Description>sample string 4</Description>
<EntityCode>sample string 2</EntityCode>
<EntityTypeId>Sfr</EntityTypeId>
<Id>1</Id>
<IssueDate>2026-05-09T14:07:06.5141418+02:00</IssueDate>
</ClaimLetterRefFewoDto>
<ClaimLetterRefFewoDto>
<ClaimLetterRefFewoTypeId>Origin</ClaimLetterRefFewoTypeId>
<Description>sample string 4</Description>
<EntityCode>sample string 2</EntityCode>
<EntityTypeId>Sfr</EntityTypeId>
<Id>1</Id>
<IssueDate>2026-05-09T14:07:06.5141418+02:00</IssueDate>
</ClaimLetterRefFewoDto>
</Origin>
<OriginDesc>sample string 7</OriginDesc>
<PendingAmount>1</PendingAmount>
<RejectNotes>sample string 13</RejectNotes>
<ReplyLetterRef>
<ClaimLetterRefFewoDto>
<ClaimLetterRefFewoTypeId>Origin</ClaimLetterRefFewoTypeId>
<Description>sample string 4</Description>
<EntityCode>sample string 2</EntityCode>
<EntityTypeId>Sfr</EntityTypeId>
<Id>1</Id>
<IssueDate>2026-05-09T14:07:06.5141418+02:00</IssueDate>
</ClaimLetterRefFewoDto>
<ClaimLetterRefFewoDto>
<ClaimLetterRefFewoTypeId>Origin</ClaimLetterRefFewoTypeId>
<Description>sample string 4</Description>
<EntityCode>sample string 2</EntityCode>
<EntityTypeId>Sfr</EntityTypeId>
<Id>1</Id>
<IssueDate>2026-05-09T14:07:06.5141418+02:00</IssueDate>
</ClaimLetterRefFewoDto>
</ReplyLetterRef>
<ReplyLetterRefDesc>sample string 8</ReplyLetterRefDesc>
<SettledAmount>1</SettledAmount>
<StatusDescription>sample string 6</StatusDescription>
<StatusId>10</StatusId>
<SubcontractId>1</SubcontractId>
<TypeDescription>sample string 5</TypeDescription>
<TypeId>4</TypeId>
</ClaimDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiDataResultOfClaimDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | ClaimDto |
None. |
|
| Success | boolean |
None. |
|
| Message | string |
None. |
|
| Errors | Collection of CustomError |
None. |
|
| Warnings | Collection of string |
None. |
Response Formats
application/json, text/json, text/html
Sample:
Sample not available.