receipt-controller

Operations

getByIdReceipt

Request

Path

idinteger, (int32)required

GET

/api/v1/receipt/{id}

curl -i -X GET \
  'https://api.prana.software/api/v1/receipt/{id}'

Responses

Bodyapplication/json

idinteger, (int32)required

Unique identifier of the object

Default:""

receiptMovementsArray of objects(ApiReceiptMovementListReadDto)

List of receipt movements

Default:""

invoiceobject(ApiInvoiceListReadDto)

Associated invoice information

Default:""

billingSeriesobject(ApiBillingSeriesListReadDto)required

Billing series information

Default:""

paymentMethodobject(ApiPaymentMethodListReadDto)

Payment method information

Default:""

customerAddressobject(ApiCustomerAddressListReadDto)required

Customer address information

Default:""

representativeobject(ApiRepresentativeListReadDto)

Representative information

Default:""

currencyobject(ApiCurrencyListReadDto)

Currency information

Default:""

invoiceNumberintegerrequired

Invoice number

Default:""

Example:1001

receiptNumberinteger, (int32)required

Receipt number

Default:""

Example:3

situationstring(ApiSituationEnum)

Receipt situation

Default:""

Enum:"CO""IM""CP""IN""PR""RE""PE"

Example:"PENDING"

invoiceDatestring, (date)

Invoice date (yyyy-MM-dd)

Default:""

Example:"2024-08-01"

receiptDatestring, (date)

Receipt date (yyyy-MM-dd)

Default:""

Example:"2024-08-05"

expirationDatestring, (date)

Expiration date (yyyy-MM-dd)

Default:""

Example:"2024-09-01"

actualDatestring, (date)

Actual payment date (yyyy-MM-dd)

Default:""

Example:"2024-08-15"

printedboolean

Indicates if receipt is printed

Default:false

Example:false

accountedboolean

Indicates if receipt is accounted

Default:false

Example:true

reclaimedboolean

Indicates if receipt is reclaimed

Default:false

Example:false

reclaimedDatestring, (date)

Reclaim date (yyyy-MM-dd)

Default:""

Example:"2024-08-10"

currencyChangeValuenumber

Currency exchange rate value

Default:""

Example:1.05

remittanceobject(ApiRemittanceListReadDto)

Remittance information

Default:""

daysUntilExpirationDateinteger, (int32)

Days until expiration date

Default:""

Example:25

ibanstring, [ 0 .. 50 ] characters

IBAN bank account number

Default:""

Example:"ES7501234567890123456789"

totalnumber

Total receipt amount

Default:""

Example:1500

totalCompanyCurrencynumber

Total amount in company currency

Default:""

Example:1500

collectedAmountnumber

Collected amount

Default:""

Example:1000

collectedAmountCompanyCurrencynumber

Collected amount in company currency

Default:""

Example:1000

pendingAmountnumber

Pending payment amount

Default:""

Example:500

pendingAmountCompanyCurrencynumber

Pending amount in company currency

Default:""

Example:500

paymentsinteger, (int32)

Number of payments

Default:""

Example:1

remittableboolean

Indicates if receipt is remittable

Default:false

Example:true

ignorePendingboolean

Indicates if pending should be ignored

Default:false

Example:false

uncollectableboolean

Indicates if receipt is uncollectable

Default:false

Example:false

promissoryNoteBankstring, [ 0 .. 50 ] characters

Promissory note bank name

Default:""

Example:"Santander"

promissoryNoteNumberstring, [ 0 .. 50 ] characters

Promissory note number

Default:""

Example:"1"

promissoryNoteExpirationDatestring, (date)

Promissory note expiration date (yyyy-MM-dd)

Default:""

Example:"2024-10-01"

observationsstring, [ 0 .. 250 ] characters

Observations or notes

Default:""

Example:"Payment received via bank transfer"

unpaidDatestring, (date)

Unpaid date (yyyy-MM-dd)

Default:""

Example:"2024-09-15"

unpaidReasonobject(ApiUnpaidReasonListReadDto)

Unpaid reason information

Default:""

receiptExpensesCategory1object(ApiReceiptExpensesListReadDto)

Receipt expenses category 1

Default:""

receiptExpensesCategory2object(ApiReceiptExpensesListReadDto)

Receipt expenses category 2

Default:""

receiptExpensesCategory3object(ApiReceiptExpensesListReadDto)

Receipt expenses category 3

Default:""

receiptExpensesCategory4object(ApiReceiptExpensesListReadDto)

Receipt expenses category 4

Default:""

receiptExpensesCategory5object(ApiReceiptExpensesListReadDto)

Receipt expenses category 5

Default:""

addExpensesboolean

Indicates if expenses should be added

Default:false

Example:false

totalExpensesAmountnumber

Total expenses amount

Default:""

Example:50

totalExpensesAmountCompanyCurrencynumber

Total expenses amount in company currency

Default:""

Example:50

totalWithoutExpensesnumber

Total receipt amount without expenses

Default:""

Example:1500

totalWithoutExpensesCompanyCurrencynumber

Total without expenses in company currency

Default:""

Example:1500

remittedAmountnumber

Remitted amount

Default:""

Example:0

remittedAmountCompanyCurrencynumber

Remitted amount in company currency

Default:""

Example:0

vatRecordobject(ApiVatRecordListReadDto)

VAT record information

Default:""

reportTokenstring

Report token

Default:""

Example:"TOKEN-2024-001"

reportNamestring

Report name

Default:""

Example:"Receipt_2024_001"

reportUrlstring

Report URL

Default:""

Example:"https://example.com/report"

receiptCollectionLinesArray of objects(ApiInvoiceReceiptCollectionLineReadDto)

List of receipt collection lines

Default:""

manualboolean

Indicates if receipt is manual

Default:false

Example:false

Response

// No response example