updateReceiptCollection

Request

Path

idinteger, (int32)required

Bodyapplication/jsonrequired

currencyinteger, (int32)

Currency identifier

Default:""

Example:1

periodIdinteger, (int32)

Accounting period identifier

Default:""

Example:1

accountinteger, (int32)

Account identifier

Default:""

Example:470000

conceptinteger, (int32)

Concept identifier

Default:""

Example:100

collectionDatestring, (date)

Collection date

Default:""

Example:"2024-08-07"

countrystring

Country

Default:""

Example:"Spain"

accountCodestring

Account code

Default:""

Example:"572000003"

observationsstring

Observations or notes

Default:""

Example:"Advance payment by bank transfer."

amountnumber

Total amount

Default:""

Example:1500.75

accountedboolean

Accounted flag

Default:false

Example:false

bankNamestring

Bank name

Default:""

Example:"Bank of Spain"

documentNumberstring

Document number

Default:""

Example:"RCPT-20240001"

ibanstring

IBAN

Default:""

Example:"ES9121000418450200051332"

bicSwiftstring

BIC/SWIFT code

Default:""

Example:"CAIXESBBXXX"

accountingDatestring, (date)

Accounting date

Default:""

Example:"2024-03-16"

changenumber

Exchange rate

Default:""

Example:1.05

companyCurrencyinteger, (int32)

Company currency identifier

Default:""

Example:2

companyAmountnumber

Amount in company currency

Default:""

Example:1575.79

invoiceReferenceinteger

Invoice reference

Default:""

Example:10001

orderNumberinteger

Order number

Default:""

Example:1001

extensionstring

Extension code

Default:""

Example:"EXT-001"

bankinteger, (int32)

Bank identifier

Default:""

Example:1

invoiceinteger, (int32)

Invoice identifier

Default:""

Example:100

collectedAmountTotalnumber

Total collected amount

Default:""

Example:1500

accountingEntryModestring(ApiReceiptCollectionAccountingEntryModeEnum)

Accounting entry mode. If null, uses company default setting

Default:""

Enum:"GROUPED""DETAILED"

Example:"DETAILED"

linesArray of objects(ApiReceiptCollectionLineWriteDto)

customerinteger, (int32)

deliveryNoteinteger, (int32)

quoteinteger, (int32)

orderinteger, (int32)

countedboolean

paymentTypestring(ApiPosPaymentTypeEnum)

Enum:"CASH""CARD""OTHER"

PUT

/api/v1/collection/{id}

curl -i -X PUT \
  'https://api.prana.software/api/v1/collection/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "currency": 1,
    "periodId": 1,
    "account": 470000,
    "concept": 100,
    "collectionDate": "2024-08-07",
    "country": "Spain",
    "accountCode": "572000003",
    "observations": "Advance payment by bank transfer.",
    "amount": 1500.75,
    "accounted": false,
    "bankName": "Bank of Spain",
    "documentNumber": "RCPT-20240001",
    "iban": "ES9121000418450200051332",
    "bicSwift": "CAIXESBBXXX",
    "accountingDate": "2024-03-16",
    "change": 1.05,
    "companyCurrency": 2,
    "companyAmount": 1575.79,
    "invoiceReference": 10001,
    "orderNumber": 1001,
    "extension": "EXT-001",
    "bank": 1,
    "invoice": 100,
    "collectedAmountTotal": 1500,
    "accountingEntryMode": "GROUPED",
    "lines": [
      {
        "id": "",
        "header": 1,
        "receipt": 100,
        "ignorePending": false,
        "collectionAmount": 500
      }
    ],
    "customer": 0,
    "deliveryNote": 0,
    "quote": 0,
    "order": 0,
    "counted": true,
    "paymentType": "CASH"
  }'

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"
}