Find here the list of actions to apply on the objects, and the data reference for this object.

What is a cash deposit ?

A cash deposit reflects a movement of money IN or OUT of your bank account. It's related to a sale via a bill sheet, or a purchase via an emitted payment.

Getting the cash deposits list

GET /cash deposits.xml

Returns all cash deposits, page by page
Add a page parameter to navigate

Getting a single cash deposit

GET /cash deposits/#{id}.xml

Returns a single cash deposit, identified by its id

Creating a new cash deposit

POST /cash deposits.xml

Creates a new cash deposit, and returns the cash deposit data

Updating an existing cash deposit

PUT /cash deposits/#{id}.xml

Updates some fields of an existing cash deposit

Deleting an existing cash deposit

DELETE /cash deposits/#{id}.xml

Deletes the cash deposit identified by its id

Object data

<cash_deposit>
 <id>the id of this object</id>
 <kind>'deposit' for an actual movement, 'plan' for an expected movement</kind>
 <amount_ttc>999999.9999</amount_ttc>
 <deposit_date>date of payment</deposit_date>
 <sheet_name>'bill_sheets' or 'emitted_payements' depending on the objet it belongs</sheet_name>
 <sheet_id>id of the bill_sheet or emitted_payment it belongs to</sheet_id>
 <payment_type_id>id of payment types (see below)</payment_type_id>
 <payment_type_info>free info on payment (check number for example)</payment_type_info>
 <payer_staff_id>staff id of payer</payer_staff_id>
 <bank_account_id>id of bank account related to the movement</bank_account_id>
 <bank_reconciled>0 if not seen on bank account, 1 if seen</bank_reconciled>
 <comments>some comments</comments>
</cash_deposit>

Possible values of payment type

• 55 for check

• 56 for credit or debit card

• 57 for cash

• 265 for wire

• 370 for coupon

• 532 for tip

• 574 for prélèvement

• 621 for traite

• 622 for change letter

• 624 for PayPal

• 625 for service check