API Documentation
Payments ¶
Payments ¶
Supported filter params
-
invoice_id (array)
-
company_id (array)
-
project_id (array)
-
paid_after
-
paid_before
-
subsidiary_id (array)
Supported sort params
-
amount
-
paid_on
-
written_off_on
-
note
-
invoice.number
-
date
Supported aggregates params
- total_amount
Filter operations are supported on this endpoint.
GET /api/v2/payments
Requests
GET /api/v2/payments
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": [
{
"id": "2",
"type": "payments",
"attributes": {
"paid_on": "2021-01-24",
"written_off_on": null,
"note": null,
"external_id": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 462
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "52"
}
}
}
}
],
"included": [
{
"id": "52",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-01-24",
"sent_on": null,
"pay_on": "2021-02-03",
"delivery_on": null,
"paid_on": "2021-01-24",
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "e1c56d875fceb5423fb3fb4f0799fcfd",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-01-24T00:04:43.325+01:00",
"exchange_rate": "1.25",
"exchange_date": "2021-01-24",
"custom_fields": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 10000,
"amount_paid_default": 12500,
"amount_paid_normalized": 10000,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": -10000,
"amount_unpaid_default": -12500,
"amount_unpaid_normalized": -10000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 462
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1626"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "1172"
}
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "1626",
"type": "companies",
"attributes": {
"name": "Client1165",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:04:43.320+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 462
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1172",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1157@email.com",
"title": null,
"joined_at": "2021-01-24T00:04:43.000+01:00",
"last_seen_at": "2021-01-24T00:04:43.352+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:04:43.300+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 462
}
},
"company": {
"data": {
"type": "companies",
"id": "1625"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1625",
"type": "companies",
"attributes": {
"name": "Organization462",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:04:43.298+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 462
}
},
"bill_to": {
"data": null
}
}
}
],
"links": {
"first": "http://www.example.com/api/v2/payments?page%5Bnumber%5D=1&page%5Bsize%5D=30",
"last": "http://www.example.com/api/v2/payments?page%5Bnumber%5D=1&page%5Bsize%5D=30"
},
"meta": {
"current_page": 1,
"total_pages": 1,
"total_count": 1,
"page_size": 30,
"max_page_size": 200,
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
Get paymentsGET/api/v2/payments
GET /api/v2/payments/1
Requests
GET /api/v2/payments/3
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "3",
"type": "payments",
"attributes": {
"paid_on": "2021-01-24",
"written_off_on": null,
"note": null,
"external_id": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 463
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "53"
}
}
}
},
"included": [
{
"id": "53",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-01-24",
"sent_on": null,
"pay_on": "2021-02-03",
"delivery_on": null,
"paid_on": "2021-01-24",
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "31f87caaefe38f9b60d54d5ddd916467",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-01-24T00:04:43.440+01:00",
"exchange_rate": "1.25",
"exchange_date": "2021-01-24",
"custom_fields": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 10000,
"amount_paid_default": 12500,
"amount_paid_normalized": 10000,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": -10000,
"amount_unpaid_default": -12500,
"amount_unpaid_normalized": -10000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 463
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1628"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "1173"
}
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "1628",
"type": "companies",
"attributes": {
"name": "Client1166",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:04:43.436+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 463
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1173",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1158@email.com",
"title": null,
"joined_at": "2021-01-24T00:04:43.000+01:00",
"last_seen_at": "2021-01-24T00:04:43.466+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:04:43.415+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 463
}
},
"company": {
"data": {
"type": "companies",
"id": "1627"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1627",
"type": "companies",
"attributes": {
"name": "Organization463",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:04:43.414+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 463
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/payments
Requests
POST /api/v2/payments
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "payments",
"attributes": {
"amount": 10000,
"paid_on": "2021-01-24"
},
"relationships": {
"invoice": {
"data": {
"type": "invoices",
"id": "54"
}
}
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "5",
"type": "payments",
"attributes": {
"paid_on": "2021-01-24",
"written_off_on": null,
"note": null,
"external_id": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 10000,
"amount_default": 12500,
"amount_normalized": 10000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 464
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "54"
}
}
}
},
"included": [
{
"id": "54",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-01-24",
"sent_on": null,
"pay_on": "2021-02-03",
"delivery_on": null,
"paid_on": "2021-01-24",
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "5b9d8cd9ebabd6f3a7e4b6b3388e1432",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-01-24T00:04:43.561+01:00",
"exchange_rate": "1.25",
"exchange_date": "2021-01-24",
"custom_fields": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 20000,
"amount_paid_default": 25000,
"amount_paid_normalized": 20000,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": -20000,
"amount_unpaid_default": -25000,
"amount_unpaid_normalized": -20000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 464
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1630"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "1174"
}
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "1630",
"type": "companies",
"attributes": {
"name": "Client1167",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:04:43.556+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 464
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1174",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1159@email.com",
"title": null,
"joined_at": "2021-01-24T00:04:43.000+01:00",
"last_seen_at": "2021-01-24T00:04:43.588+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:04:43.533+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 464
}
},
"company": {
"data": {
"type": "companies",
"id": "1629"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1629",
"type": "companies",
"attributes": {
"name": "Organization464",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:04:43.531+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 464
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
POST /api/v2/payments
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "payments",
"attributes": {
"amount": ""
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/invoice"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/amount"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/paid_on"
}
},
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "is not a date",
"source": {
"pointer": "data/attributes/paid_on"
}
}
]
}
Create a paymentPOST/api/v2/payments
URI Parameters
- invoice_id
number
(required) Example: 1invoice id
- amount
number
(required) Example: 100ammount
- paid_on
date
(required) Example: 2018-01-01paid on
PATCH /api/v2/payments/1
Requests
PATCH /api/v2/payments/8
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "payments",
"attributes": {
"amount": 2000
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "8",
"type": "payments",
"attributes": {
"paid_on": "2021-01-24",
"written_off_on": null,
"note": null,
"external_id": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 2000,
"amount_default": 2500,
"amount_normalized": 2000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 467
}
},
"invoice": {
"data": {
"type": "invoices",
"id": "57"
}
}
}
},
"included": [
{
"id": "57",
"type": "invoices",
"attributes": {
"number": "2016/01",
"subject": null,
"invoiced_on": "2021-01-24",
"sent_on": null,
"pay_on": "2021-02-03",
"delivery_on": null,
"paid_on": "2021-01-24",
"discount": null,
"tax1_name": null,
"tax1_value": null,
"tax2_name": null,
"tax2_value": null,
"deleted_at": null,
"tag_list": [],
"note": null,
"exported_at": null,
"export_integration_type_id": null,
"note_interpolated": null,
"email_key": "b49491d4c7628f2468b9566623930057",
"purchase_order_number": null,
"export_invoice_url": null,
"company_reference_id": null,
"created_at": "2021-01-24T00:04:43.902+01:00",
"exchange_rate": "1.25",
"exchange_date": "2021-01-24",
"custom_fields": null,
"currency": "EUR",
"currency_default": "USD",
"currency_normalized": "EUR",
"amount": 0,
"amount_default": 0,
"amount_normalized": 0,
"amount_tax": 0,
"amount_tax_default": 0,
"amount_tax_normalized": 0,
"amount_with_tax": 0,
"amount_with_tax_default": 0,
"amount_with_tax_normalized": 0,
"amount_paid": 2000,
"amount_paid_default": 2500,
"amount_paid_normalized": 2000,
"amount_written_off": 0,
"amount_written_off_default": 0,
"amount_written_off_normalized": 0,
"amount_unpaid": -2000,
"amount_unpaid_default": -2500,
"amount_unpaid_normalized": -2000
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 467
}
},
"bill_to": {
"data": null
},
"bill_from": {
"data": null
},
"company": {
"data": {
"type": "companies",
"id": "1636"
}
},
"document_type": {
"data": null
},
"creator": {
"data": {
"type": "people",
"id": "1177"
}
},
"invoice_attributions": {
"data": []
},
"attachment": {
"data": null
}
}
},
{
"id": "1636",
"type": "companies",
"attributes": {
"name": "Client1170",
"billing_name": null,
"vat": null,
"default_currency": null,
"created_at": "2021-01-24T00:04:43.898+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 467
}
},
"bill_to": {
"data": null
}
}
},
{
"id": "1177",
"type": "people",
"attributes": {
"first_name": "test first name",
"last_name": "test last name",
"email": "user1162@email.com",
"title": null,
"joined_at": "2021-01-24T00:04:43.000+01:00",
"last_seen_at": "2021-01-24T00:04:43.927+01:00",
"deactivated_at": null,
"archived_at": null,
"role_id": 1,
"invited_at": null,
"is_user": true,
"tag_list": [],
"avatar_url": null,
"virtual": false,
"custom_fields": null,
"autotracking": false,
"created_at": "2021-01-24T00:04:43.877+01:00",
"placeholder": false,
"color_id": null,
"private_custom_reports_used": 0,
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 467
}
},
"company": {
"data": {
"type": "companies",
"id": "1635"
}
},
"subsidiary": {
"data": null
}
}
},
{
"id": "1635",
"type": "companies",
"attributes": {
"name": "Organization467",
"billing_name": null,
"vat": null,
"default_currency": "USD",
"created_at": "2021-01-24T00:04:43.876+01:00",
"archived_at": null,
"avatar_url": null,
"invoice_email_recipients": {},
"custom_fields": null,
"description": null,
"due_days": null,
"tag_list": [],
"contact": {}
},
"relationships": {
"organization": {
"data": {
"type": "organizations",
"id": 467
}
},
"bill_to": {
"data": null
}
}
}
],
"meta": {
"organization_features": {
"custom_fields": {
"type": "metered",
"limit": 15,
"used": 0
},
"custom_fields_per_project": {
"type": "metered",
"limit": 10,
"used": 0
},
"public_custom_reports": {
"type": "metered",
"limit": 100,
"used": 0
},
"private_custom_reports": {
"type": "metered",
"limit": 30,
"used": 0
},
"scheduling_placeholders": {
"type": "metered",
"limit": 5,
"used": 0
},
"multigrouping": {
"type": "switch",
"available": true
},
"client_access_to_budgets": {
"type": "switch",
"available": true
},
"subsidiaries": {
"type": "switch",
"available": true
},
"time_approvals": {
"type": "switch",
"available": true
},
"expenses_approvals": {
"type": "switch",
"available": true
},
"timeoff_approvals": {
"type": "switch",
"available": true
},
"autotracking": {
"type": "switch",
"available": true
},
"forecasting": {
"type": "switch",
"available": true
},
"webhooks": {
"type": "switch",
"available": true
},
"table_pivoting": {
"type": "switch",
"available": true
},
"formula_fields": {
"type": "switch",
"available": true
},
"single_sign_on": {
"type": "switch",
"available": true
},
"duplicate_tasks": {
"type": "switch",
"available": true
},
"billable_time_rounding": {
"type": "switch",
"available": true
},
"payment_sync": {
"type": "switch",
"available": true
},
"booking_methods": {
"type": "switch",
"available": true
},
"import_tasks_csv": {
"type": "switch",
"available": true
},
"reactions": {
"type": "switch",
"available": true
},
"time_week_view": {
"type": "switch",
"available": true
},
"subtasks": {
"type": "switch",
"available": true
},
"time_calendar_layout": {
"type": "switch",
"available": true
},
"theming": {
"type": "switch",
"available": true
},
"remove_branding": {
"type": "switch",
"available": true
},
"custom_invoicing_email": {
"type": "switch",
"available": true
},
"google_calendar_layout": {
"type": "switch",
"available": true
}
},
"settings": {}
}
}
PATCH /api/v2/payments/9
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
"data": {
"type": "payments",
"attributes": {
"amount": ""
}
}
}
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"errors": [
{
"status": "422",
"code": "invalid_attribute",
"title": "Invalid Attribute",
"detail": "can't be blank",
"source": {
"pointer": "data/attributes/amount"
}
}
]
}
DELETE /api/v2/payments/1
Requests
DELETE /api/v2/payments/11
Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses
This response has no content.
Generated by aglio on 23 Jan 2021