POST api/Subcontracts/{subcontractId}/SapInvoices
Get certification retentions
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| subcontractId | integer |
Required |
Body Parameters
SapInvoicesFilter| Name | Description | Type | Additional information |
|---|---|---|---|
| SubcontractCode | string |
None. |
|
| FiscalYear | string |
None. |
|
| InvoiceNumber | string |
None. |
|
| Reference | string |
None. |
|
| InvoiceDate | Collection of date |
None. |
|
| RegisterDate | Collection of date |
None. |
|
| AccountingDate | Collection of date |
None. |
|
| EstimatedPaymentDate | Collection of date |
None. |
|
| GrossAmount | Collection of decimal number |
None. |
|
| TaxAmount | Collection of decimal number |
None. |
|
| NetAmount | Collection of decimal number |
None. |
|
| RetentionAmount | Collection of decimal number |
None. |
|
| AdvanceAmount | Collection of decimal number |
None. |
|
| PaymentAmount | Collection of decimal number |
None. |
|
| PaidAmount | Collection of decimal number |
None. |
|
| BloquedPayment | string |
None. |
|
| LastPaymentDate | Collection of date |
None. |
|
| Currency | string |
None. |
|
| Status | string |
None. |
|
| Page | Page |
None. |
|
| Orders | Collection of Order |
None. |
Request Formats
application/json, text/json
Sample:
{
"subcontractCode": "sample string 1",
"fiscalYear": "sample string 2",
"invoiceNumber": "sample string 3",
"reference": "sample string 4",
"invoiceDate": [
"2026-05-09T14:07:55.8170839+02:00",
"2026-05-09T14:07:55.8170839+02:00"
],
"registerDate": [
"2026-05-09T14:07:55.8170839+02:00",
"2026-05-09T14:07:55.8170839+02:00"
],
"accountingDate": [
"2026-05-09T14:07:55.8170839+02:00",
"2026-05-09T14:07:55.8170839+02:00"
],
"estimatedPaymentDate": [
"2026-05-09T14:07:55.8170839+02:00",
"2026-05-09T14:07:55.8170839+02:00"
],
"grossAmount": [
1.0,
1.0
],
"taxAmount": [
1.0,
1.0
],
"netAmount": [
1.0,
1.0
],
"retentionAmount": [
1.0,
1.0
],
"advanceAmount": [
1.0,
1.0
],
"paymentAmount": [
1.0,
1.0
],
"paidAmount": [
1.0,
1.0
],
"bloquedPayment": "sample string 5",
"lastPaymentDate": [
"2026-05-09T14:07:55.8170839+02:00",
"2026-05-09T14:07:55.8170839+02:00"
],
"currency": "sample string 6",
"status": "sample string 7",
"page": {
"number": 1,
"size": 2,
"skip": 0
},
"orders": [
{
"name": "sample string 1",
"descending": true
},
{
"name": "sample string 1",
"descending": true
}
]
}
text/html
Sample:
{"subcontractCode":"sample string 1","fiscalYear":"sample string 2","invoiceNumber":"sample string 3","reference":"sample string 4","invoiceDate":["2026-05-09T14:07:55.8170839+02:00","2026-05-09T14:07:55.8170839+02:00"],"registerDate":["2026-05-09T14:07:55.8170839+02:00","2026-05-09T14:07:55.8170839+02:00"],"accountingDate":["2026-05-09T14:07:55.8170839+02:00","2026-05-09T14:07:55.8170839+02:00"],"estimatedPaymentDate":["2026-05-09T14:07:55.8170839+02:00","2026-05-09T14:07:55.8170839+02:00"],"grossAmount":[1.0,1.0],"taxAmount":[1.0,1.0],"netAmount":[1.0,1.0],"retentionAmount":[1.0,1.0],"advanceAmount":[1.0,1.0],"paymentAmount":[1.0,1.0],"paidAmount":[1.0,1.0],"bloquedPayment":"sample string 5","lastPaymentDate":["2026-05-09T14:07:55.8170839+02:00","2026-05-09T14:07:55.8170839+02:00"],"currency":"sample string 6","status":"sample string 7","page":{"number":1,"size":2,"skip":0},"orders":[{"name":"sample string 1","descending":true},{"name":"sample string 1","descending":true}]}
application/xml, text/xml
Sample:
<SapInvoicesFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.SubcontractModule.Application.Dtos.Dtos.SubcontractAgg">
<Orders xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.Application.Base.SortAndPage.Entities">
<Order>
<Descending>true</Descending>
<Name>sample string 1</Name>
</Order>
<Order>
<Descending>true</Descending>
<Name>sample string 1</Name>
</Order>
</Orders>
<Page xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.Application.Base.SortAndPage.Entities">
<Number>1</Number>
<Size>2</Size>
</Page>
<AccountingDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>2026-05-09T14:07:55.8170839+02:00</d2p1:dateTime>
<d2p1:dateTime>2026-05-09T14:07:55.8170839+02:00</d2p1:dateTime>
</AccountingDate>
<AdvanceAmount xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>1</d2p1:decimal>
</AdvanceAmount>
<BloquedPayment>sample string 5</BloquedPayment>
<Currency>sample string 6</Currency>
<EstimatedPaymentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>2026-05-09T14:07:55.8170839+02:00</d2p1:dateTime>
<d2p1:dateTime>2026-05-09T14:07:55.8170839+02:00</d2p1:dateTime>
</EstimatedPaymentDate>
<FiscalYear>sample string 2</FiscalYear>
<GrossAmount xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>1</d2p1:decimal>
</GrossAmount>
<InvoiceDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>2026-05-09T14:07:55.8170839+02:00</d2p1:dateTime>
<d2p1:dateTime>2026-05-09T14:07:55.8170839+02:00</d2p1:dateTime>
</InvoiceDate>
<InvoiceNumber>sample string 3</InvoiceNumber>
<LastPaymentDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>2026-05-09T14:07:55.8170839+02:00</d2p1:dateTime>
<d2p1:dateTime>2026-05-09T14:07:55.8170839+02:00</d2p1:dateTime>
</LastPaymentDate>
<NetAmount xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>1</d2p1:decimal>
</NetAmount>
<PaidAmount xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>1</d2p1:decimal>
</PaidAmount>
<PaymentAmount xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>1</d2p1:decimal>
</PaymentAmount>
<Reference>sample string 4</Reference>
<RegisterDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:dateTime>2026-05-09T14:07:55.8170839+02:00</d2p1:dateTime>
<d2p1:dateTime>2026-05-09T14:07:55.8170839+02:00</d2p1:dateTime>
</RegisterDate>
<RetentionAmount xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>1</d2p1:decimal>
</RetentionAmount>
<Status>sample string 7</Status>
<SubcontractCode>sample string 1</SubcontractCode>
<TaxAmount xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:decimal>1</d2p1:decimal>
<d2p1:decimal>1</d2p1:decimal>
</TaxAmount>
</SapInvoicesFilter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiDataResultOfSapInvoicesResponseDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | SapInvoicesResponseDto |
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.