getByIdReceiptCollection

Request

Path

idinteger, (int32)required

GET

/api/v1/collection/{id}

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

Responses

Bodyapplication/json

idinteger, (int32)required

Unique identifier of the object

Default:""

accountobject(ApiChartAccountListReadDto)

conceptobject(ApiConceptListReadDto)

orderNumberinteger

collectionDatestring, (date)

accountedboolean

observationsstring

extensionstring

collectedAmountTotalnumber

collectedAmountTotalCompanyCurrencynumber

pendingAmountTotalnumber

pendingAmountTotalCompanyCurrencynumber

receiptAmountTotalnumber

receiptAmountTotalCompanyCurrencynumber

receiptsNumberinteger, (int32)

currencyobject(ApiCurrencyListReadDto)

Currency list entry with exchange rate

Default:null

bankobject(ApiBankListReadDto)

Bank list entry with summary information

Default:null

amountReconciliationnumber

amountReconciliationCompanyCurrencynumber

accountingEntryModestring(ApiReceiptCollectionAccountingEntryModeEnum)

Accounting entry mode

Default:""

Enum:"GROUPED""DETAILED"

Example:"DETAILED"

linesArray of objects(ApiReceiptCollectionLineReadDto)

customerobject(ApiCustomerAutocompleteDto)

quoteNumberinteger

quoteIdinteger, (int32)

ordersNumberinteger

orderIdinteger, (int32)

deliveryNoteNumberinteger

deliveryNoteIdinteger, (int32)

paymentTypestring(ApiPosPaymentTypeEnum)

Enum:"CASH""CARD""OTHER"

Response

{
  "id": "",
  "account": {
    "id": "",
    "code": "1000",
    "description": "Cash account",
    "cif": "B12345678",
    "active": true,
    "color": "#FF5733",
    "parentCode": "100",
    "parentDescription": "Assets"
  },
  "concept": {
    "id": "",
    "code": "CON001",
    "description": "Sales revenue"
  },
  "orderNumber": 0,
  "collectionDate": "2019-08-24",
  "accounted": true,
  "observations": "string",
  "extension": "string",
  "collectedAmountTotal": 0,
  "collectedAmountTotalCompanyCurrency": 0,
  "pendingAmountTotal": 0,
  "pendingAmountTotalCompanyCurrency": 0,
  "receiptAmountTotal": 0,
  "receiptAmountTotalCompanyCurrency": 0,
  "receiptsNumber": 0,
  "currency": null,
  "bank": null,
  "amountReconciliation": 0,
  "amountReconciliationCompanyCurrency": 0,
  "accountingEntryMode": "GROUPED",
  "lines": [
    { … }
  ],
  "customer": {
    "id": "",
    "code": 10001,
    "name": "Acme S.A.",
    "commercialName": "Acme España",
    "isActive": true,
    "inactiveDate": "2024-08-07",
    "currencyIdDelegationZero": 1
  },
  "quoteNumber": 0,
  "quoteId": 0,
  "ordersNumber": 0,
  "orderId": 0,
  "deliveryNoteNumber": 0,
  "deliveryNoteId": 0,
  "paymentType": "CASH"
}