Skip to content

getByIdDeliveryNote_1

Request

Path
idinteger, (int32)required
GET
/api/v1/deliveryNote/{id}
curl -i -X GET \
  'https://api.prana.software/api/v1/deliveryNote/{id}'

Responses

OK

Bodyapplication/json
idinteger, (int32)required

Unique identifier of the object

Default:""
numberintegerrequired
documentDatestring, (date)required
quantityTotalnumber
observationsstring
linesArray of objects(ApiDeliveryNoteLineReadDto)
changenumber
discount1number
discount2number
discountAmountTotalnumber
discountAmountTotalCompanyCurrencynumber
discountPpnumber
discountPpAmountTotalnumber
discountPpAmountTotalCompanyCurrencynumber
grossAmountTotalnumber
grossAmountTotalCompanyCurrencynumber
netAmountTotalnumber
netAmountTotalCompanyCurrencynumber
vatAmountTotalnumber
vatAmountTotalCompanyCurrencynumber
surchargeAmountTotalnumber
surchargeAmountTotalCompanyCurrencynumber
withholdingnumber
withholdingAmountTotalnumber
withholdingAmountTotalCompanyCurrencynumber
totalnumber
totalCompanyCurrencynumber
disbursementAmountTotalnumber
disbursementAmountTotalCompanyCurrencynumber
billingSeriesobject(ApiBillingSeriesListReadDto)required

Associated billing series.

Default:""
valueDatestring, (date)

Value date.

Default:""
Example:"2024-01-15"
customerAddressobject(ApiCustomerAddressViewReadDto)

Associated customer address.

Default:""
warehouseobject(ApiWarehouseListReadDto)required

Associated warehouse.

Default:""
referencestring

Reference code.

Default:""
rateCodeobject(ApiRateCodeListReadDto)

Associated rate code.

Default:""
agencyobject(ApiAgencyListReadDto)

Associated agency.

Default:""
lockedboolean

Indicates if delivery note is locked.

Default:false
Example:false
paymentMethodobject(ApiPaymentMethodListReadDto)required

Associated payment method.

Default:""
firstTerminteger, (int32)

First payment term in days.

Default:""
Example:30
daysTerminteger, (int32)

Days per term.

Default:""
Example:30
termsinteger, (int32)

Number of payment terms.

Default:""
Example:1
proximityTypestring(ApiProximityTypeEnum)

Proximity type.

Default:""
Enum:"NEARBY""PREVIOUS""LATER"
irpfTypestring(ApiIRPFTypeEnum)

IRPF withholding type.

Default:""
Enum:"LEASES""PROFESIONAL_ACTIVITIES""AGRO""AGRO_REAGP"
Example:"AGRO"
discount3number

Third discount percentage.

Default:""
Example:1
discount4number

Fourth discount percentage.

Default:""
Example:0.5
currencyobject(ApiCurrencyListReadDto)required

Associated currency.

Default:""
ibanstring

IBAN bank account number.

Default:""
customerVatTypeobject(ApiCustomerVatTypeListReadDto)required

Associated customer VAT type.

Default:""
phytosanitaryAuthorizedPersonobject(ApiPhytosanitaryAuthorizedPersonListReadDto)

Associated phytosanitary authorized person.

Default:""
representative1object(ApiRepresentativeListReadDto)

First representative.

Default:""
commissionType1string(ApiCommissionTypeEnum)

First representative commission type.

Default:""
Enum:"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
commission1number

First representative commission.

Default:""
Example:5
representative2object(ApiRepresentativeListReadDto)

Second representative.

Default:""
commissionType2string(ApiCommissionTypeEnum)

Second representative commission type.

Default:""
Enum:"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
commission2number

Second representative commission.

Default:""
Example:3
representative3object(ApiRepresentativeListReadDto)

Third representative.

Default:""
commissionType3string(ApiCommissionTypeEnum)

Third representative commission type.

Default:""
Enum:"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
commission3number

Third representative commission.

Default:""
Example:2
noAccumulateRiskboolean

Indicates if no accumulate risk.

Default:false
Example:false
packagesinteger, (int32)

Number of packages.

Default:""
Example:5
grossWeightnumber

Gross weight.

Default:""
Example:100
netWeightnumber

Net weight.

Default:""
Example:95
volumenumber

Total volume.

Default:""
Example:50
billingObservationsstring

Billing observations.

Default:""
shippingTermobject(ApiShippingTermListReadDto)

Associated shipping term/Incoterm.

Default:""
shippingAmountnumber

Shipping amount.

Default:""
Example:25
shippingVatTypestring

Shipping VAT type.

Default:""
shippingVatPercentagenumber

Shipping VAT percentage.

Default:""
Example:21
shippingSurchargePercentagenumber

Shipping surcharge percentage.

Default:""
Example:5.2
tagsArray of strings

Associated tags.

Default:""
invoicedboolean

Indicates if delivery note is invoiced.

Default:false
Example:false
invoiceEditObservationsstring

Invoice edit observations.

Default:""
collectedAmountnumber

Collected amount.

Default:""
Example:1000
collectedAmountCompanyCurrencynumber

Collected amount in company currency.

Default:""
Example:1000
valuedboolean

Indicates if delivery note is valued.

Default:false
Example:true
receiptCollectionsArray of objects(ApiDeliveryNoteReceiptCollectionListReadDto)

Associated receipt collections.

Default:""
discount1AmountTotalnumber

Total discount 1 amount.

Default:""
Example:50
discount1AmountTotalCompanyCurrencynumber

Total discount 1 amount in company currency.

Default:""
Example:50
discount2AmountTotalnumber

Total discount 2 amount.

Default:""
Example:30
discount2AmountTotalCompanyCurrencynumber

Total discount 2 amount in company currency.

Default:""
Example:30
discount3AmountTotalnumber

Total discount 3 amount.

Default:""
Example:20
discount3AmountTotalCompanyCurrencynumber

Total discount 3 amount in company currency.

Default:""
Example:20
discount4AmountTotalnumber

Total discount 4 amount.

Default:""
Example:10
discount4AmountTotalCompanyCurrencynumber

Total discount 4 amount in company currency.

Default:""
Example:10
reportTokenstring

Report authentication token.

Default:""
reportUrlstring

Report URL.

Default:""
reportNamestring

Report file name.

Default:""
emailSentboolean

Indicates if report email was sent.

Default:false
Example:false
usersCompany1object(ApiUsersCompanyListReadDto)

First assigned users company.

Default:""
usersCompany2object(ApiUsersCompanyListReadDto)

Second assigned users company.

Default:""
usersCompany3object(ApiUsersCompanyListReadDto)

Third assigned users company.

Default:""
documentTemplateobject(ApiDocumentTemplateListReadDto)

Document template selected for PDF generation.

Default:""
projectobject(ApiProjectListReadDto)

Associated project.

Default:""
Response
// No response example