POST api/CompanyBorrower/v1/InsertSalesInvoice

Request Information

URI Parameters

None.

Body Parameters

InsertSalesInvoiceRequest
NameDescriptionTypeAdditional information
invoice

SalesInvoiceFundingInvoice

None.

OrganizationCode

string

None.

UserName

string

None.

Password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "invoice": {
    "BrandCode": "sample string 1",
    "ChannelCode": "sample string 2",
    "ExternalInvoiceNumber": "sample string 3",
    "ContractId": "1cbc243f-fba0-4669-9079-7ec01a31e120",
    "Bic": "sample string 4",
    "InvoiceGrossAmount": 5.0,
    "InvoiceTaxAmount": 6.0,
    "InvoiceNetAmount": 7.0,
    "InvoiceDeliveryMethod": 0,
    "InvoiceSenderInvoiceNumber": "sample string 8",
    "InvoiceReceiverName": "sample string 9",
    "InvoiceReceiverBic": "sample string 10",
    "InvoiceReceiverAddressStreet": "sample string 11",
    "InvoiceReceiverAddressCO": "sample string 12",
    "InvoiceReceiverAddressZip": "sample string 13",
    "InvoiceReceiverAddressCity": "sample string 14",
    "InvoiceReceiverAddressCountryCode": "sample string 15",
    "InvoiceReceiverPhone": "sample string 16",
    "InvoiceReceiverEmail": "sample string 17",
    "InvoiceReceiverContactPersonName": "sample string 18",
    "InvoiceReceiverContactPersonPhone": "sample string 19",
    "InvoiceReceiverContactPersonEmail": "sample string 20",
    "InvoiceDelayInterestRate": "sample string 21",
    "DoNotSendReminderLetter": true,
    "InvoicePaymentReference": "sample string 23",
    "InvoicePaymentBankAccountNumber": "sample string 24",
    "InvoiceSenderReference": "sample string 25",
    "InvoiceReceiverReference": "sample string 26",
    "InvoiceAttachmentFiles": []
  },
  "OrganizationCode": "sample string 1",
  "UserName": "sample string 2",
  "Password": "sample string 3"
}

application/xml, text/xml

Sample:
<InsertSalesInvoiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">
  <OrganizationCode>sample string 1</OrganizationCode>
  <Password>sample string 3</Password>
  <UserName>sample string 2</UserName>
  <invoice>
    <Bic>sample string 4</Bic>
    <BrandCode>sample string 1</BrandCode>
    <ChannelCode>sample string 2</ChannelCode>
    <ContractId>1cbc243f-fba0-4669-9079-7ec01a31e120</ContractId>
    <DoNotSendReminderLetter>true</DoNotSendReminderLetter>
    <ExternalInvoiceNumber>sample string 3</ExternalInvoiceNumber>
    <InvoiceAttachmentFiles />
    <InvoiceDelayInterestRate>sample string 21</InvoiceDelayInterestRate>
    <InvoiceDeliveryMethod>EInvoice</InvoiceDeliveryMethod>
    <InvoiceGrossAmount>5</InvoiceGrossAmount>
    <InvoiceNetAmount>7</InvoiceNetAmount>
    <InvoicePaymentBankAccountNumber>sample string 24</InvoicePaymentBankAccountNumber>
    <InvoicePaymentReference>sample string 23</InvoicePaymentReference>
    <InvoiceReceiverAddressCO>sample string 12</InvoiceReceiverAddressCO>
    <InvoiceReceiverAddressCity>sample string 14</InvoiceReceiverAddressCity>
    <InvoiceReceiverAddressCountryCode>sample string 15</InvoiceReceiverAddressCountryCode>
    <InvoiceReceiverAddressStreet>sample string 11</InvoiceReceiverAddressStreet>
    <InvoiceReceiverAddressZip>sample string 13</InvoiceReceiverAddressZip>
    <InvoiceReceiverBic>sample string 10</InvoiceReceiverBic>
    <InvoiceReceiverContactPersonEmail>sample string 20</InvoiceReceiverContactPersonEmail>
    <InvoiceReceiverContactPersonName>sample string 18</InvoiceReceiverContactPersonName>
    <InvoiceReceiverContactPersonPhone>sample string 19</InvoiceReceiverContactPersonPhone>
    <InvoiceReceiverEmail>sample string 17</InvoiceReceiverEmail>
    <InvoiceReceiverName>sample string 9</InvoiceReceiverName>
    <InvoiceReceiverPhone>sample string 16</InvoiceReceiverPhone>
    <InvoiceReceiverReference>sample string 26</InvoiceReceiverReference>
    <InvoiceSenderInvoiceNumber>sample string 8</InvoiceSenderInvoiceNumber>
    <InvoiceSenderReference>sample string 25</InvoiceSenderReference>
    <InvoiceTaxAmount>6</InvoiceTaxAmount>
  </invoice>
</InsertSalesInvoiceRequest>

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

Response Information

Resource Description

InsertSalesInvoiceReply
NameDescriptionTypeAdditional information
Reply

SalesInvoiceFundingInvoiceReply

None.

Ok

boolean

None.

ErrorMessage

string

None.

ErrorCode

string

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Reply": {
    "IsValid": true,
    "ValidationMessage": "sample string 2",
    "IsApproved": true,
    "RejectionReasonMessage": "sample string 4",
    "RejectionReasonCode": "sample string 5",
    "InvoiceId": "26ec504d-23cc-4389-aff1-1adc8fa6d60d",
    "LoanAmount": 7.0,
    "InterestRate": 8.0,
    "TotalRepaymentAmount": 9.0,
    "OpeningFee": 10.0,
    "InstallmentFee": 11.0
  },
  "Ok": true,
  "ErrorMessage": "sample string 2",
  "ErrorCode": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:
<InsertSalesInvoiceReply 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>
    <InstallmentFee>11</InstallmentFee>
    <InterestRate>8</InterestRate>
    <InvoiceId>26ec504d-23cc-4389-aff1-1adc8fa6d60d</InvoiceId>
    <IsApproved>true</IsApproved>
    <IsValid>true</IsValid>
    <LoanAmount>7</LoanAmount>
    <OpeningFee>10</OpeningFee>
    <RejectionReasonCode>sample string 5</RejectionReasonCode>
    <RejectionReasonMessage>sample string 4</RejectionReasonMessage>
    <TotalRepaymentAmount>9</TotalRepaymentAmount>
    <ValidationMessage>sample string 2</ValidationMessage>
  </Reply>
</InsertSalesInvoiceReply>