API Reference

for object "Purchase bills"

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




What is a purchase bill ?

An purchase bill (we call it an emitted payment) represents the document your company records when purchasing a past or future product or service from a vendor.




Getting the purchase bills list

GET /emitted_payments.xml

Returns all purchase bills, page by page
Add a page parameter to navigate




Getting a single purchase bill

GET /emitted_payments/#{id}.xml

Returns a single purchase bill, identified by its id




Creating a new purchase bill

POST /emitted_payments.xml

Creates a new purchase bill, and returns the purchase bill data




Updating an existing purchase bill

PUT /emitted_payments/#{id}.xml

Updates some fields of an existing purchase bill




Deleting an existing purchase bill

DELETE /emitted_payments/#{id}.xml

Deletes the purchase bill identified by its id




Object data

<emitted_payment>
 <id>id of purchase</id>
 <title>purchase details</title>
 <supplier_id>id of attached contact (0 if not attached to contact)</supplier_id>
 <supplier_firm_id>id of attached firm (0 if not attached to firm)</supplier_firm_id>
 <supplier_name>name of supplier if not attached</supplier_name>
 <payment_date>date of purchase commitment</payment_date>
 <bill_reference>reference of vendor bill</bill_reference>
 <amount>amount of purchase with VAT</amount>
 <vat_value_id>vat id (see below)</vat_value_id>
 <vat_value>vat value</vat_value>
 <payed_amount>paid amount today</payed_amount>
 <project_id>id of related project</project_id>
 <lead_id>id of related lead</lead_id>
</emitted_payment>



Possible values of vat_id

  • 222 for 2.1%

  • 223 for 5.5%

  • 224 for 19.6%

  • 225 for no VAT

  • 529 for 19%

  • 543 for 8.5%

  • 544 for 21%

  • 545 for 7.6%

  • 546 for 16%

  • 551 for 15%

  • 552 for 10%

  • 553 for 3%

  • 567 for 18%

  • 569 for 8.5% NPR

  • 607 for 20%

  • 615 for 6%