POST api/v1/PreAuthorizedDebits?token={token}&inCaseOfErrorReturnHttpCode={inCaseOfErrorReturnHttpCode}
יצירת הוראת קבע חדשה
Request Information
URI Parameters
Name | Description | Type/Additional information |
---|---|---|
token |
string
Required |
|
inCaseOfErrorReturnHttpCode |
קוד ה-HTTP שיוחזר במקרה של שגיאה. ברירת המחדל היא 400 אבל אתה יכול לשלוח קוד אחר אם יש לך צורך כזה. |
Default value is BadRequest |
Body Parameters
פרטי הוראת הקבע החדשה
הוראת קבע לחיוב כרטיסי אשראי
Request Formats
application/json, text/json
Sample:
{ "PreAuthorizedDebitId": "sample string 1", "ContactId": "sample string 3", "DocumentId": "sample string 4", "Document": { "DocumentId": "sample string 1", "DocumentNumberBranch": 1, "TrxTypeId": 1, "Number": "sample string 2", "Date": "2024-11-21T14:54:13.7556442+02:00", "CustomerId": "sample string 5", "CustomerBusinessName": "sample string 6", "CustomerOsekMorshe": "sample string 7", "CustomerContactName": "sample string 8", "CustomerAddress1": "sample string 9", "CustomerAddress2": "sample string 10", "CustomerCity": "sample string 11", "CustomerPostalCode": "sample string 12", "CustomerCountry": "sample string 13", "CustomerEmail": "sample string 14", "MobilePhone": "sample string 15", "Details": "sample string 16", "Comments": "sample string 17", "TotalLinesChargeVAT": 18.0, "Rebate": 1.0, "RebatePercent": 1.0, "RountTotal": true, "RebateRounding": 1.0, "TotalBeforeVAT": 1.0, "TotalBeforeVATChargeVAT": 1.0, "TotalNoChargeVat": 1.0, "Vat": 19.0, "Total": 1.0, "EffectiveTotal": 1.0, "VatRate": 1.0, "Payment": 1.0, "TaxDeduction": 1.0, "TotalPayment": 2.0, "ReceiptCurrencySymbol": "sample string 20", "ReceiptRate": 1.0, "TaxDeductionNIS": 1.0, "PaymentNIS": 1.0, "TotalPaymentNIS": 2.0, "DocumentLines": [ { "Number": 1, "ProductId": "sample string 2", "ProductCatalogNumber": "sample string 3", "ProductName": "sample string 4", "Details": "sample string 5", "UnitPrice": 6.0, "Qty": 7.0, "CurrencySymbol": "sample string 8", "Rate": 1.0, "Rebate": 9.0, "ExtendedPrice": 33.0, "ChargeVAT": true, "VATRate": 1.0, "VAT": 1.0 }, { "Number": 1, "ProductId": "sample string 2", "ProductCatalogNumber": "sample string 3", "ProductName": "sample string 4", "Details": "sample string 5", "UnitPrice": 6.0, "Qty": 7.0, "CurrencySymbol": "sample string 8", "Rate": 1.0, "Rebate": 9.0, "ExtendedPrice": 33.0, "ChargeVAT": true, "VATRate": 1.0, "VAT": 1.0 } ], "ReceiptLines": [ { "Number": 1, "PaymentTypeId": 2, "AccountNumber": "sample string 3", "BranchOrValidTo": "sample string 4", "BankId": 1, "CheckNumber": "sample string 5", "PaymentDate": "2024-11-21T14:54:13.7556442+02:00", "Payment": 1.0, "Rate": 1.0, "CanBeChanged": true, "DateCreated": "2024-11-21T14:54:13.7556442+02:00", "UserCreated": "sample string 6", "DateUpdated": "2024-11-21T14:54:13.7556442+02:00", "UserUpdated": "sample string 7" }, { "Number": 1, "PaymentTypeId": 2, "AccountNumber": "sample string 3", "BranchOrValidTo": "sample string 4", "BankId": 1, "CheckNumber": "sample string 5", "PaymentDate": "2024-11-21T14:54:13.7556442+02:00", "Payment": 1.0, "Rate": 1.0, "CanBeChanged": true, "DateCreated": "2024-11-21T14:54:13.7556442+02:00", "UserCreated": "sample string 6", "DateUpdated": "2024-11-21T14:54:13.7556442+02:00", "UserUpdated": "sample string 7" } ], "TrxCode": "sample string 21", "TrxCodeNumber": 1, "Status": 1, "DueDate": "2024-11-21T14:54:13.7556442+02:00", "RowVersion": "QEA=", "LinkToPdf": "sample string 22", "ViewUrl": "sample string 23", "PaymentUrl": "sample string 24", "RelatedDocuments": [ { "DocumentId": "sample string 1", "TrxTypeId": 2, "Date": "2024-11-21T14:54:13.7566416+02:00", "DocumentNumber": "sample string 4", "DocumentSum": 5.0, "DocumentRelation": 6 }, { "DocumentId": "sample string 1", "TrxTypeId": 2, "Date": "2024-11-21T14:54:13.7566416+02:00", "DocumentNumber": "sample string 4", "DocumentSum": 5.0, "DocumentRelation": 6 } ], "AllocationNumber": "sample string 25", "DateCreated": "2024-11-21T14:54:13.7566416+02:00", "UserCreated": "sample string 26", "DateUpdated": "2024-11-21T14:54:13.7566416+02:00", "UserUpdated": "sample string 27" }, "Status": 5, "ChargePeriod": 6, "DateStart": "2024-11-21T14:54:13.7576416+02:00", "DateEnd": "2024-11-21T14:54:13.7576416+02:00", "DateOfLastCharge": "2024-11-21T14:54:13.7576416+02:00", "NumOfCharges": 9, "NumOfChargesAlreadyCharged": 10, "Description": "sample string 11", "Comments": "sample string 12", "NextDocument": 13, "NextDocumentTrxCodeId": 1, "ChargeAmount": 14.0, "ApprovalNumber": "sample string 15", "IsActive": false, "DebitCahrages": [ { "PreAuthorizedDebitChargeId": "sample string 1", "PreAuthorizedDebitId": "sample string 2", "Date": "2024-11-21T14:54:13.7596437+02:00", "ActualChargeDate": "2024-11-21T14:54:13.7596437+02:00", "Amount": 5.0, "DocumentId": "sample string 6", "DocumentNumber": "sample string 7", "Details": "sample string 8", "Status": 9, "DateCreated": "2024-11-21T14:54:13.7606428+02:00", "UserCreated": "sample string 10", "DateUpdated": "2024-11-21T14:54:13.7606428+02:00", "UserUpdated": "sample string 11" }, { "PreAuthorizedDebitChargeId": "sample string 1", "PreAuthorizedDebitId": "sample string 2", "Date": "2024-11-21T14:54:13.7596437+02:00", "ActualChargeDate": "2024-11-21T14:54:13.7596437+02:00", "Amount": 5.0, "DocumentId": "sample string 6", "DocumentNumber": "sample string 7", "Details": "sample string 8", "Status": 9, "DateCreated": "2024-11-21T14:54:13.7606428+02:00", "UserCreated": "sample string 10", "DateUpdated": "2024-11-21T14:54:13.7606428+02:00", "UserUpdated": "sample string 11" } ], "DateCreated": "2024-11-21T14:54:13.7616432+02:00", "UserCreated": "sample string 17", "DateUpdated": "2024-11-21T14:54:13.7616432+02:00", "UserUpdated": "sample string 18" }
application/xml, text/xml
Sample:
<CaspitPreAuthorizedDebit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.caspit.biz/2013/03"> <DateCreated>2024-11-21T14:54:13.7616432+02:00</DateCreated> <DateUpdated>2024-11-21T14:54:13.7616432+02:00</DateUpdated> <UserCreated>sample string 17</UserCreated> <UserUpdated>sample string 18</UserUpdated> <ApprovalNumber>sample string 15</ApprovalNumber> <ChargeAmount>14</ChargeAmount> <ChargePeriod>6</ChargePeriod> <Comments>sample string 12</Comments> <ContactId>sample string 3</ContactId> <DateEnd>2024-11-21T14:54:13.7576416+02:00</DateEnd> <DateOfLastCharge>2024-11-21T14:54:13.7576416+02:00</DateOfLastCharge> <DateStart>2024-11-21T14:54:13.7576416+02:00</DateStart> <DebitCahrages xmlns:d2p1="http://schemas.datacontract.org/2004/07/CaspitWebTiles.Api.Models"> <d2p1:CaspitPreAuthorizedDebitCharge> <DateCreated>2024-11-21T14:54:13.7606428+02:00</DateCreated> <DateUpdated>2024-11-21T14:54:13.7606428+02:00</DateUpdated> <UserCreated>sample string 10</UserCreated> <UserUpdated>sample string 11</UserUpdated> <d2p1:ActualChargeDate>2024-11-21T14:54:13.7596437+02:00</d2p1:ActualChargeDate> <d2p1:Amount>5</d2p1:Amount> <d2p1:Date>2024-11-21T14:54:13.7596437+02:00</d2p1:Date> <d2p1:Details>sample string 8</d2p1:Details> <d2p1:DocumentId>sample string 6</d2p1:DocumentId> <d2p1:DocumentNumber>sample string 7</d2p1:DocumentNumber> <d2p1:PreAuthorizedDebitChargeId>sample string 1</d2p1:PreAuthorizedDebitChargeId> <d2p1:PreAuthorizedDebitId>sample string 2</d2p1:PreAuthorizedDebitId> <d2p1:Status>9</d2p1:Status> </d2p1:CaspitPreAuthorizedDebitCharge> <d2p1:CaspitPreAuthorizedDebitCharge> <DateCreated>2024-11-21T14:54:13.7606428+02:00</DateCreated> <DateUpdated>2024-11-21T14:54:13.7606428+02:00</DateUpdated> <UserCreated>sample string 10</UserCreated> <UserUpdated>sample string 11</UserUpdated> <d2p1:ActualChargeDate>2024-11-21T14:54:13.7596437+02:00</d2p1:ActualChargeDate> <d2p1:Amount>5</d2p1:Amount> <d2p1:Date>2024-11-21T14:54:13.7596437+02:00</d2p1:Date> <d2p1:Details>sample string 8</d2p1:Details> <d2p1:DocumentId>sample string 6</d2p1:DocumentId> <d2p1:DocumentNumber>sample string 7</d2p1:DocumentNumber> <d2p1:PreAuthorizedDebitChargeId>sample string 1</d2p1:PreAuthorizedDebitChargeId> <d2p1:PreAuthorizedDebitId>sample string 2</d2p1:PreAuthorizedDebitId> <d2p1:Status>9</d2p1:Status> </d2p1:CaspitPreAuthorizedDebitCharge> </DebitCahrages> <Description>sample string 11</Description> <Document> <DateCreated>2024-11-21T14:54:13.7566416+02:00</DateCreated> <DateUpdated>2024-11-21T14:54:13.7566416+02:00</DateUpdated> <UserCreated>sample string 26</UserCreated> <UserUpdated>sample string 27</UserUpdated> <AllocationNumber>sample string 25</AllocationNumber> <Comments>sample string 17</Comments> <CustomerAddress1>sample string 9</CustomerAddress1> <CustomerAddress2>sample string 10</CustomerAddress2> <CustomerBusinessName>sample string 6</CustomerBusinessName> <CustomerCity>sample string 11</CustomerCity> <CustomerContactName>sample string 8</CustomerContactName> <CustomerCountry>sample string 13</CustomerCountry> <CustomerEmail>sample string 14</CustomerEmail> <CustomerId>sample string 5</CustomerId> <CustomerOsekMorshe>sample string 7</CustomerOsekMorshe> <CustomerPostalCode>sample string 12</CustomerPostalCode> <Date>2024-11-21T14:54:13.7556442+02:00</Date> <Details>sample string 16</Details> <DocumentId>sample string 1</DocumentId> <DocumentLines> <CaspitDocumentLine> <ChargeVAT>true</ChargeVAT> <CurrencySymbol>sample string 8</CurrencySymbol> <Details>sample string 5</Details> <ExtendedPrice>33</ExtendedPrice> <Number>1</Number> <ProductCatalogNumber>sample string 3</ProductCatalogNumber> <ProductId>sample string 2</ProductId> <ProductName>sample string 4</ProductName> <Qty>7</Qty> <Rate>1</Rate> <Rebate>9</Rebate> <UnitPrice>6</UnitPrice> <VAT>1</VAT> <VATRate>1</VATRate> </CaspitDocumentLine> <CaspitDocumentLine> <ChargeVAT>true</ChargeVAT> <CurrencySymbol>sample string 8</CurrencySymbol> <Details>sample string 5</Details> <ExtendedPrice>33</ExtendedPrice> <Number>1</Number> <ProductCatalogNumber>sample string 3</ProductCatalogNumber> <ProductId>sample string 2</ProductId> <ProductName>sample string 4</ProductName> <Qty>7</Qty> <Rate>1</Rate> <Rebate>9</Rebate> <UnitPrice>6</UnitPrice> <VAT>1</VAT> <VATRate>1</VATRate> </CaspitDocumentLine> </DocumentLines> <DocumentNumberBranch>1</DocumentNumberBranch> <DueDate>2024-11-21T14:54:13.7556442+02:00</DueDate> <EffectiveTotal>1</EffectiveTotal> <LinkToPdf>sample string 22</LinkToPdf> <MobilePhone>sample string 15</MobilePhone> <Number>sample string 2</Number> <Payment>1</Payment> <PaymentNIS>1</PaymentNIS> <PaymentUrl>sample string 24</PaymentUrl> <Rebate>1</Rebate> <RebatePercent>1</RebatePercent> <RebateRounding>1</RebateRounding> <ReceiptCurrencySymbol>sample string 20</ReceiptCurrencySymbol> <ReceiptLines> <CaspitReceiptLine> <DateCreated>2024-11-21T14:54:13.7556442+02:00</DateCreated> <DateUpdated>2024-11-21T14:54:13.7556442+02:00</DateUpdated> <UserCreated>sample string 6</UserCreated> <UserUpdated>sample string 7</UserUpdated> <AccountNumber>sample string 3</AccountNumber> <BankId>1</BankId> <BranchOrValidTo>sample string 4</BranchOrValidTo> <CanBeChanged>true</CanBeChanged> <CheckNumber>sample string 5</CheckNumber> <Number>1</Number> <Payment>1</Payment> <PaymentDate>2024-11-21T14:54:13.7556442+02:00</PaymentDate> <PaymentTypeId>2</PaymentTypeId> <Rate>1</Rate> </CaspitReceiptLine> <CaspitReceiptLine> <DateCreated>2024-11-21T14:54:13.7556442+02:00</DateCreated> <DateUpdated>2024-11-21T14:54:13.7556442+02:00</DateUpdated> <UserCreated>sample string 6</UserCreated> <UserUpdated>sample string 7</UserUpdated> <AccountNumber>sample string 3</AccountNumber> <BankId>1</BankId> <BranchOrValidTo>sample string 4</BranchOrValidTo> <CanBeChanged>true</CanBeChanged> <CheckNumber>sample string 5</CheckNumber> <Number>1</Number> <Payment>1</Payment> <PaymentDate>2024-11-21T14:54:13.7556442+02:00</PaymentDate> <PaymentTypeId>2</PaymentTypeId> <Rate>1</Rate> </CaspitReceiptLine> </ReceiptLines> <ReceiptRate>1</ReceiptRate> <RelatedDocuments> <RelatedDocument> <Date>2024-11-21T14:54:13.7566416+02:00</Date> <DocumentId>sample string 1</DocumentId> <DocumentNumber>sample string 4</DocumentNumber> <DocumentRelation>6</DocumentRelation> <DocumentSum>5</DocumentSum> <TrxTypeId>2</TrxTypeId> </RelatedDocument> <RelatedDocument> <Date>2024-11-21T14:54:13.7566416+02:00</Date> <DocumentId>sample string 1</DocumentId> <DocumentNumber>sample string 4</DocumentNumber> <DocumentRelation>6</DocumentRelation> <DocumentSum>5</DocumentSum> <TrxTypeId>2</TrxTypeId> </RelatedDocument> </RelatedDocuments> <RountTotal>true</RountTotal> <RowVersion>QEA=</RowVersion> <Status>1</Status> <TaxDeduction>1</TaxDeduction> <TaxDeductionNIS>1</TaxDeductionNIS> <Total>1</Total> <TotalBeforeVAT>1</TotalBeforeVAT> <TotalBeforeVATChargeVAT>1</TotalBeforeVATChargeVAT> <TotalLinesChargeVAT>18</TotalLinesChargeVAT> <TotalNoChargeVat>1</TotalNoChargeVat> <TotalPayment>2</TotalPayment> <TotalPaymentNIS>2</TotalPaymentNIS> <TrxCode>sample string 21</TrxCode> <TrxCodeNumber>1</TrxCodeNumber> <TrxTypeId>1</TrxTypeId> <Vat>19</Vat> <VatRate>1</VatRate> <ViewUrl>sample string 23</ViewUrl> </Document> <DocumentId>sample string 4</DocumentId> <IsActive>false</IsActive> <NextDocument>13</NextDocument> <NextDocumentTrxCodeId>1</NextDocumentTrxCodeId> <NumOfCharges>9</NumOfCharges> <NumOfChargesAlreadyCharged>10</NumOfChargesAlreadyCharged> <PreAuthorizedDebitId>sample string 1</PreAuthorizedDebitId> <Status>5</Status> </CaspitPreAuthorizedDebit>
application/x-www-form-urlencoded
Sample:
Sample not available.