Skip to content

getByIdTemplateSaleInvoice

Request

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

Responses

OK

Bodyapplication/json
idinteger, (int32)required

Unique identifier of the object

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

Shipping term list entry

Default:null
shippingVatTypestring
shippingVatPercentagenumber
shippingSurchargePercentagenumber
shippingAmountnumber
currencyobject(ApiCurrencyListReadDto)

Currency list entry with exchange rate

Default:null
rateCodeobject(ApiRateCodeListReadDto)

Rate code list entry

Default:null
customerAddressobject(ApiCustomerAddressViewReadDto)required
statusstring(ApiTemplateSaleInvoiceStatusEnum)
Default:null
Enum:"PENDING""CURRENT"
irpfTypestring(ApiIRPFTypeEnum)

IRPF withholding type.

Default:""
Enum:"LEASES""PROFESIONAL_ACTIVITIES""AGRO""AGRO_REAGP"
Example:"AGRO"
validityDatestring, (date)
serviceDatestring, (date)
manufacturingDatestring, (date)
valueDatestring, (date)
seasonobject(ApiSeasonListReadDto)

Season list entry

Default:null
warehouseobject(ApiWarehouseListReadDto)
representative1object(ApiRepresentativeListReadDto)

Representative list entry

Default:null
commissionType1string(ApiCommissionTypeEnum)
Default:null
Enum:"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
commission1number
representative2object(ApiRepresentativeListReadDto)

Representative list entry

Default:null
commissionType2string(ApiCommissionTypeEnum)
Default:null
Enum:"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
commission2number
representative3object(ApiRepresentativeListReadDto)

Representative list entry

Default:null
commissionType3string(ApiCommissionTypeEnum)
Default:null
Enum:"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
commission3number
referencestring
paymentMethodobject(ApiPaymentMethodListReadDto)

DTO para listar los métodos de pago disponibles

Default:null
firstTerminteger, (int32)
daysTerminteger, (int32)
termsinteger, (int32)
proximityTypestring(ApiProximityTypeEnum)
Default:null
Enum:"NEARBY""PREVIOUS""LATER"
ibanstring
discount3number
discount4number
billingCompanyobject(ApiCompanyInfoListReadDto)
packagesinteger, (int32)
grossWeightnumber
netWeightnumber
volumenumber
invoiceEditObservationsstring
collectedAmountnumber
collectedAmountCompanyCurrencynumber
tagsArray of strings
discount1AmountTotalnumber
discount1AmountTotalCompanyCurrencynumber
discount2AmountTotalnumber
discount2AmountTotalCompanyCurrencynumber
discount3AmountTotalnumber
discount3AmountTotalCompanyCurrencynumber
discount4AmountTotalnumber
discount4AmountTotalCompanyCurrencynumber
activeboolean
automaticGenerationboolean
automaticSendingboolean
startDatestring, (date)
endDatestring, (date)
nextInvoicestring, (date)
periodicInvoicestring(ApiPeriodicInvoiceEnum)
Enum:"DAILY""WEEKLY""BIWEEKLY""MONTHLY""BIMONTHLY""QUARTERLY""SEMIANNUAL""ANNUAL"
vatOperationTypeobject(ApiVatOperationTypeListReadDto)
model347boolean
usersCompany1object(ApiUsersCompanyListReadDto)
usersCompany2object(ApiUsersCompanyListReadDto)
usersCompany3object(ApiUsersCompanyListReadDto)
documentTemplateobject(ApiDocumentTemplateListReadDto)

Document template summary for listings

Default:null
Response
// No response example