POST api/CompanyBorrower/v1/GetSalesInvoiceFundingOffer

Request Information

URI Parameters

None.

Body Parameters

GetSalesInvoiceFundingOfferRequest
NameDescriptionTypeAdditional information
bic

string

None.

contractId

globally unique identifier

None.

invoiceGrossAmount

decimal number

None.

dueDate

date

None.

invoiceWriterBic

string

None.

OrganizationCode

string

None.

UserName

string

None.

Password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "bic": "sample string 1",
  "contractId": "9c76e387-bf05-4262-9b8f-d56cc94b2d2e",
  "invoiceGrossAmount": 2.0,
  "dueDate": "2025-05-01T17:44:31.3833685+00:00",
  "invoiceWriterBic": "sample string 4",
  "OrganizationCode": "sample string 5",
  "UserName": "sample string 6",
  "Password": "sample string 7"
}

application/xml, text/xml

Sample:
<GetSalesInvoiceFundingOfferRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">
  <OrganizationCode>sample string 5</OrganizationCode>
  <Password>sample string 7</Password>
  <UserName>sample string 6</UserName>
  <bic>sample string 1</bic>
  <contractId>9c76e387-bf05-4262-9b8f-d56cc94b2d2e</contractId>
  <dueDate>2025-05-01T17:44:31.3833685+00:00</dueDate>
  <invoiceGrossAmount>2</invoiceGrossAmount>
  <invoiceWriterBic>sample string 4</invoiceWriterBic>
</GetSalesInvoiceFundingOfferRequest>

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

Response Information

Resource Description

GetSalesInvoiceFundingOfferReply
NameDescriptionTypeAdditional information
Reply

SalesInvoiceFundingOffer

None.

Ok

boolean

None.

ErrorMessage

string

None.

ErrorCode

string

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Reply": {
    "InvoiceDueDate": "2025-05-01T17:44:31.3989948+00:00",
    "InvoiceGrossAmount": 2.0,
    "FundingProvisionRate": 3.0,
    "FundingProvisionAmount": 4.0,
    "PaidAmount": 5.0
  },
  "Ok": true,
  "ErrorMessage": "sample string 2",
  "ErrorCode": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:
<GetSalesInvoiceFundingOfferReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">
  <ErrorCode>sample string 3</ErrorCode>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Message>sample string 4</Message>
  <Ok>true</Ok>
  <Reply>
    <FundingProvisionAmount>4</FundingProvisionAmount>
    <FundingProvisionRate>3</FundingProvisionRate>
    <InvoiceDueDate>2025-05-01T17:44:31.3989948+00:00</InvoiceDueDate>
    <InvoiceGrossAmount>2</InvoiceGrossAmount>
    <PaidAmount>5</PaidAmount>
  </Reply>
</GetSalesInvoiceFundingOfferReply>