DocCloud API

<back to all web services

CostInvoiceUpdateCommand

Requires Authentication
The following routes are available for this service:
PUT/costinvoiceUpdate Cost Invoice
CostInvoiceUpdateCommand Parameters:
NameParameterData TypeRequiredDescription
IdbodyulongNo
TypeIdbodyuintNo
TypeNamebodystringNo
InvSrcIdbodyuintNo
InvSrcNumberbodystringNo
NumberbodystringNo
OrderNumberbodystringNo
TownbodystringNo
CreationDatebodyDateTimeNo
SellDatebodyDateTimeNo
PaymentDatebodyDateTimeNo
PaymentDueDatebodyDateTimeNo
ExecutionDatebodyDateTimeNo
PaymentTypeIdbodyuintNo
PaymentTypebodystringNo
PaymentTermsbodyushortNo
JpkItemCodeIdbodyintNo
JpkItemCodeCodebodystringNo
JpkItemCodeNamebodystringNo
ListJpkProcedurebodyList<InvoiceJpkProcedureDto>No
JpkDocTypeIdbodyintNo
JpkDocTypeCodebodystringNo
JpkDocTypeNamebodystringNo
CategoryIdbodyuintNo
CategoryNamebodystringNo
SellbodyShortRecipientDtoNo
IsReceiverDiffrentbodyboolNo
ReceiverbodyShortRecipientDtoNo
RecBankIdbodyuintNo
RecBankNamebodystringNo
RecBankAccountNbbodystringNo
SwiftbodystringNo
InvoicePositionbodyList<CostInvoicePositionDto>No
BasePricebodydecimalNo
DiscountbodydecimalNo
CurrencyIdbodyuintNo
CurrencybodystringNo
NettobodydecimalNo
Vat5bodydecimalNo
Vat8bodydecimalNo
Vat23bodydecimalNo
VatBasebodydecimalNo
RateDatebodyDateTimeNo
RatebodydecimalNo
GrossbodydecimalNo
PaidbodydecimalNo
ToPaidbodydecimalNo
IsMarkedClearbodyboolNo
IsPaymentDividedbodyboolNo
IsReverseChargedbodyboolNo
IsImpbodyboolNo
IsMppbodyboolNo
SupplierNamebodystringNo
RecipientNamebodystringNo
MarginReasonIdbodyuintNo
MarginReasonbodystringNo
PrivateNotebodystringNo
RemarksbodystringNo
AdditionalRemarksbodystringNo
CodebodystringNo
CodeAvailabilitybodystringNo
InvoicesDependentbodyList<CostInvoiceDependDto>No
FilesbodyList<ulong>No
AttachmentsbodyList<FileDocumentDto>No
InvoiceJpkProcedureDto Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
BaseKeyDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformuintNo
ShortRecipientDto Parameters:
NameParameterData TypeRequiredDescription
IdformuintNo
CatIdformuintNo
NameformstringNo
VatIdformstringNo
StreetNameformstringNo
StreetNumberformstringNo
FlatNumberformstringNo
PostalCodeformstringNo
TownformstringNo
CountryIdformintNo
IsoCountryformstringNo
CountryformstringNo
EmailformstringNo
PhoneformstringNo
BankNameformstringNo
BankAccountNbformstringNo
IsActualformboolNo
DefaultCurrencyIdformuintNo
DefaultCurrencyformstringNo
CategoryIdformuintNo
CategoryNameformstringNo
CostInvoicePositionDto Parameters:
NameParameterData TypeRequiredDescription
ProductIdformuintNo
CodeformstringNo
NameformstringNo
UnitPriceformdecimalNo
UnitIdformuintNo
UnitformstringNo
QuantityformdecimalNo
CurrencyIdformuintNo
CurrencyformstringNo
NettoformdecimalNo
VatTypeIdformintNo
Vat5formdecimalNo
Vat8formdecimalNo
Vat23formdecimalNo
RecalculateVatformboolNo
GrossformdecimalNo
CategoryIdformuintNo
CategoryNameformstringNo
TaxableKindIdformuintNo
TaxableKindNameformstringNo
TaxableTypeIdformuintNo
TaxableTypeNameformstringNo
IsTaxableIdformintNo
IsTaxableNameformstringNo
InvoiceIdformulongNo
IsDeletedformboolNo
PosCorrIdformulongNo
IsBeforeformboolNo
IsUpdatedformboolNo
CostInvoiceDependDto Parameters:
NameParameterData TypeRequiredDescription
CostInvoiceIdformulongNo
CostInvoiceSrcIdformulongNo
CostInvoiceSrcNumberformstringNo
CostInvoiceSrcSellDateformDateTimeNo
CostInvoiceSrcNettoformdecimalNo
CostInvoiceSrcVat5formdecimalNo
CostInvoiceSrcVat8formdecimalNo
CostInvoiceSrcVat23formdecimalNo
CostInvoiceSrcGrossformdecimalNo
BaseKeyLongDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformulongNo
FileDocumentDto Parameters:
NameParameterData TypeRequiredDescription
ObjectTypeIdformintNo
ObjectTypeNameformstringNo
ObjectIdformulongNo
FileNameformstringNo
FileGuidformstringNo
FileSizeformlongNo
FileTypeformstringNo
ParentFolderIdformulong?No
StatusIdformuintNo
StatusNameformstringNo
OcrStatusformFileOcrStatusNo
OcrResponseformOcrRecognisedDocumentNo
ProcessIdformstringNo
CostInvoiceIdformulongNo
InvoiceIdformulongNo
FileOcrStatus Enum:
NameValue
None0
SubmittedForProcessing1
SentForProcessing2
ProcessingInProgress3
Completed4
Error5
NotAvailableYet100
NotAvailableYetFirstRetry101
NotAvailableYetSecondRetry102
NotAvailableYetThirdRetry103
NotAvailableYetFourthRetry104
NotAvailableYetFifthRetry105
OcrRecognisedDocument Parameters:
NameParameterData TypeRequiredDescription
NrInvoiceformstringNo
BankAccountformstringNo
BankNameformstringNo
DateOfIssueformstringNo
SaleDateformstringNo
DateOfPaymentformstringNo
SellerNipformstringNo
SellerNameformstringNo
SellerStreetNameformstringNo
SellerStreetNrformstringNo
SellerLocalNrformstringNo
SellerPlaceformstringNo
SellerZipCodeformstringNo
BuyerNipformstringNo
BuyerNameformstringNo
BuyerStreetNameformstringNo
BuyerStreetNrformstringNo
BuyerLocalNrformstringNo
BuyerPlaceformstringNo
BuyerZipCodeformstringNo
SummaryNettoformstringNo
SummaryVatformstringNo
SummaryGrossformstringNo
PositionsformICollection<OcrRecognisedPosition>No
OcrRecognisedPosition Parameters:
NameParameterData TypeRequiredDescription
LpformstringNo
NameformstringNo
UnitformstringNo
GrossformstringNo
NettoformstringNo
VatformstringNo
VatValueformstringNo
QuantityformstringNo
NettoPriceformstringNo
GrossPriceformstringNo
PostOperationResult<T> Parameters:
NameParameterData TypeRequiredDescription
IdformTNo
OperationResult Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
ResponseStatusformResponseStatusNo
ResultformObjectNo
IsSuccessformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /costinvoice HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"id":0,"typeId":0,"typeName":"String","invSrcId":0,"invSrcNumber":"String","number":"String","orderNumber":"String","town":"String","creationDate":"0001-01-01T00:00:00.0000000Z","sellDate":"0001-01-01T00:00:00.0000000Z","paymentDate":"0001-01-01T00:00:00.0000000Z","paymentDueDate":"0001-01-01T00:00:00.0000000Z","executionDate":"0001-01-01T00:00:00.0000000Z","paymentTypeId":0,"paymentType":"String","paymentTerms":0,"jpkItemCodeId":0,"jpkItemCodeCode":"String","jpkItemCodeName":"String","listJpkProcedure":[{"code":"String","name":"String","createdById":0,"modifiedById":0,"createdDate":"0001-01-01T00:00:00.0000000Z","modifiedDate":"0001-01-01T00:00:00.0000000Z","id":0}],"jpkDocTypeId":0,"jpkDocTypeCode":"String","jpkDocTypeName":"String","categoryId":0,"categoryName":"String","sell":{"id":0,"catId":0,"name":"String","vatId":"String","streetName":"String","streetNumber":"String","flatNumber":"String","postalCode":"String","town":"String","countryId":0,"isoCountry":"String","country":"String","email":"String","phone":"String","bankName":"String","bankAccountNb":"String","isActual":false,"defaultCurrencyId":0,"defaultCurrency":"String","categoryId":0,"categoryName":"String"},"isReceiverDiffrent":false,"receiver":{"id":0,"catId":0,"name":"String","vatId":"String","streetName":"String","streetNumber":"String","flatNumber":"String","postalCode":"String","town":"String","countryId":0,"isoCountry":"String","country":"String","email":"String","phone":"String","bankName":"String","bankAccountNb":"String","isActual":false,"defaultCurrencyId":0,"defaultCurrency":"String","categoryId":0,"categoryName":"String"},"recBankId":0,"recBankName":"String","recBankAccountNb":"String","swift":"String","invoicePosition":[{"productId":0,"code":"String","name":"String","unitPrice":0,"unitId":0,"unit":"String","quantity":0,"currencyId":0,"currency":"String","netto":0,"vatTypeId":0,"vat5":0,"vat8":0,"vat23":0,"recalculateVat":false,"gross":0,"categoryId":0,"categoryName":"String","taxableKindId":0,"taxableKindName":"String","taxableTypeId":0,"taxableTypeName":"String","isTaxableId":0,"isTaxableName":"String","invoiceId":0,"isDeleted":false,"posCorrId":0,"isBefore":false,"isUpdated":false,"createdById":0,"modifiedById":0,"createdDate":"0001-01-01T00:00:00.0000000Z","modifiedDate":"0001-01-01T00:00:00.0000000Z","id":0}],"basePrice":0,"discount":0,"currencyId":0,"currency":"String","netto":0,"vat5":0,"vat8":0,"vat23":0,"vatBase":0,"rateDate":"0001-01-01T00:00:00.0000000Z","rate":0,"gross":0,"paid":0,"toPaid":0,"isMarkedClear":false,"isPaymentDivided":false,"isReverseCharged":false,"isImp":false,"isMpp":false,"supplierName":"String","recipientName":"String","marginReasonId":0,"marginReason":"String","privateNote":"String","remarks":"String","additionalRemarks":"String","code":"String","codeAvailability":"String","invoicesDependent":[{"costInvoiceId":0,"costInvoiceSrcId":0,"costInvoiceSrcNumber":"String","costInvoiceSrcSellDate":"0001-01-01T00:00:00.0000000Z","costInvoiceSrcNetto":0,"costInvoiceSrcVat5":0,"costInvoiceSrcVat8":0,"costInvoiceSrcVat23":0,"costInvoiceSrcGross":0,"createdById":0,"modifiedById":0,"createdDate":"0001-01-01T00:00:00.0000000Z","modifiedDate":"0001-01-01T00:00:00.0000000Z","id":0}],"files":[0],"attachments":[{"objectTypeId":0,"objectTypeName":"String","objectId":0,"fileName":"String","fileGuid":"String","fileSize":0,"fileType":"String","parentFolderId":0,"statusId":0,"statusName":"String","ocrStatus":0,"ocrResponse":{"nrInvoice":"String","bankAccount":"String","bankName":"String","dateOfIssue":"String","saleDate":"String","dateOfPayment":"String","sellerNip":"String","sellerName":"String","sellerStreetName":"String","sellerStreetNr":"String","sellerLocalNr":"String","sellerPlace":"String","sellerZipCode":"String","buyerNip":"String","buyerName":"String","buyerStreetName":"String","buyerStreetNr":"String","buyerLocalNr":"String","buyerPlace":"String","buyerZipCode":"String","summaryNetto":"String","summaryVat":"String","summaryGross":"String"},"processId":"String","costInvoiceId":0,"invoiceId":0,"createdById":0,"modifiedById":0,"createdDate":"0001-01-01T00:00:00.0000000Z","modifiedDate":"0001-01-01T00:00:00.0000000Z","id":0}]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":0,"code":"FAIL","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"result":{},"isSuccess":false}